前回の記事では、BoxのWebhook v1を利用してファイル監視を実現しました。しかし欠点として、個別のフォルダの指定など出来ず自分の可視範囲全てのフォルダが監視対象となってしまうので、情報量が大きくなりPower Automateのリミット超えたり、データとしてノイズが大きくなる点がありました。

そこで今回、Box APIを利用してWebhook v2を使い、特定のフォルダに対してだけファイル監視を行い、またv1では取得できなかった情報Excel Onlineに書き込むようにしてみようと思います。但し、Webhook v2はGUIではなく、Box APIからでないと設置出来ないので、別途設置管理するアプリを用意する必要があります。

難易度:

今回使用するサービス

事前準備

設置は別プログラムから

Webhook v2は別途他のプログラムからAPIを叩いて設置する事が必要です。よって、ここでは今回事前準備についてはスルーします。列挙すると

  1. Box Developer ConsoleにてClient IDとClient Secretを作成
  2. OAuth2.0認証を実行し、Access Tokenを取得
  3. Webhook v2をAPIで設置・管理する仕組みの用意

となります。ちなみに、Webhook v2は対象のフォルダを削除すると自動的にWebhookも削除されます。

図:自作ツールでWebhook v2設置中の様子

Webhook V2の制限事項

Box Webhook v2には、いくつかの制限事項があります。実際に設置や運用するに当たってはよく把握しておく必要があります。

  • 1個のフォルダ・ファイルに付けられるWebhookは1個のみ(トリガーは複数指定は可能)
  • 1ユーザ、1アプリあたり最大1000個までWebhookは設置可能
  • 通知先URLは、httpsで始まるもののみ。ポートもまた443番のみ(httpsはオレオレ証明書はNGです)
  • ルート直下のフォルダ(IDが0のフォルダ)には、Webhookは設置出来ません

この中で問題になりそうなのは、通知先URLかと。2つ目の最大1000個は細かなファイル単位で設置を行うとリミットに達する可能性はありますが、通常はフォルダに対してWebhookを設置するので、そこまで大きな問題になることはないかと。

Webhook v1との違い

Webhook v2はv1とは異なり、細かな情報を取得できるため、Power Automateで出来ることも広がっています。

  1. Boxイベントで送信できるトリガーがv1よりも多くなっています。
  2. Boxイベントの中身がv1よりも様々な情報が入っています
  3. 主にv2で新たに活用出来るのが、親フォルダのIDと名前の取得、実行者のメールアドレスの取得などなど。詳細は次項を参照。

メアドが取れるので、メールアドレスからドメインを切り出して、条件分岐にて指定のドメインの人間の場合にだけ、Excelに書き込みなどのフローを作れるようになります(v1だとメアドが取得できない)。また、親フォルダの名前が取得出来るので、IDではなく名前でファイルが今どこに存在してるのかを追跡できるようになります。

受信するWebhookの返り値

Boxから飛んでくるWebhookの内容は以下のようなものです。但し、トリガーによって内容が異なりますので注意が必要です。実際にはここから必要なものだけに絞ってスキーマを作って取り出します。

Power Automateでフロー作成

前回のフローと見た目は同じですが、JSONの解析と表に行を追加の中身が変わっています。特に、JSONの解析については、Webhook v2はv1とは全く内容がことなり、取れる内容量も異なるので、解析する為のJSONスキーマが重要になります。

図:見た目は前回と同じようなフロー

インスタントフローの作成

HTTP要求の受信時

ログイン後、以下の手順でまずは受け口を作ります。これがIncoming Webhookとなります。前回と異なり、POSTで受信させる必要があります。

  1. マイフローに入り、新規作成にて「インスタントフロー」を選択します。
  2. フロー名を適当に入れて、トリガーはHTTP要求の受信時を選択します。
  3. 要求本文の JSON スキーマには、以下のようなコードを入れます。今回POSTで受信させるのでこのJSONスキーマは必須です。
  4. 詳細オプションを表示するをクリック
  5. methodはPOSTを選択します。

ちなみに、Box側から飛んできた返り値は、フローの実行ログから成功したものをクリックし、HTTP要求の受信時の中にある「出力」⇒「未加工出力の表示」で知ることが可能です。

※このコネクタで生成されるHTTP POSTのURLが、Webhook v2での送信先URLになります。

図:POSTで受信されます

図:成功時にBox側からの返り値を見られます

JSONの解析

次のステップとしてJSONの解析を追加します。設定は以下の通りです。

  1. スキーマには、取り出したいキーと値を指定します。。但し、返り値のすべてをスキーマで指定すると、取り出すキー名が同じ物が沢山あるので、ある程度絞っておくのが肝要です。
  2. コンテンツをクリックして、動的コンテンツの式をクリック
  3. 数式として、以下のような数式を入力し、OKをクリックします

今回は、返り値のうち、body以下の項目を取りたいので、数式のキー名はbodyにしています。問題点は、1.のスキーマですが、手動で作ると大変なので、以下の手順で簡単に作れます。

  1. サンプルから生成をクリック
  2. サンプルJSONペイロードの挿入ダイアログに、必要な項目に絞った以下のような返り値のJSONを貼り付ける
  3. 完了をクリックすると、自動て解析してスキーマを作ってくれます。

但し、Webhookのトリガーによっては、存在しないキー名などもあるので、その場合フローの実行に失敗します。必要最低限のスキーマ定義にしましょう。

図:複雑なJSONのスキーマが簡単に作れる

図:キーがなくエラーになったフロー

現在時刻の取得とタイムゾーン変換

BoxのWebhook v2には日付が含まれていますが、今回は前回同様にタイムスタンプとしてPower Automate側で作ってあげます。しかし、そのまま構築すると見慣れた日付の形式ではない上に、時間帯がUTCとなっている為、日本時間ではありません。ここは、2つのコネクタを利用し、タイムゾーンの変更と日付の形式を整えてあげます。このデータをExcelに追記時に合わせて利用します。2つのコネクタは「日付」で検索すると出てくると思います。

  1. コネクタとして「現在の時刻」を追加します。(時刻で検索すると出てくる)
  2. 次にコネクタとして「タイムゾーンの変換」を追加します。(日時で検索すると出てくる)
  3. タイムゾーンの変換では、基準時間に1.のコネクタを指定します。
  4. 書式設定文字列は「yyyy/MM/dd HH:mm」を入力してカスタム形式として登録します。MMとHHが大文字の理由は、MMでないと分になってしまうという理由と、hhだと12時間表記になってしまうのでHHで24時間表記にする為です。
  5. 変換元のタイムゾーンはUTC(協定世界時)を指定します。
  6. 変換先のタイムゾーンはUTC+9:00 大阪、札幌、東京を指定します。

図:タイムゾーン変換が必要です

Excelに追記

TeamsのチャンネルにファイルとしてExcelを一個追加し、ID, ファイル名, アクション, 日時, 編集者としてタイトルを決めて、範囲をテーブル化しておきます。テーブルでないとPAからは書き込みが出来ないので、注意が必要です。

  1. Power Automateに最後のステップとして、Excel Onlineの表に行を追加を追加
  2. 場所として、アップしたTeamsのチームを選びます。
  3. アップ先指定としてはドキュメントライブラリになるので、ドキュメントを選びます。
  4. ファイルをクリックすると、アップしたファイルが出てくるので、それを選択します。
  5. テーブルでは、そのエクセル内のテーブル名が出てくるので、それを選択します。
  6. 自動的にテーブルのタイトル列を判定してくれるので、ID~編集者までの項目を埋めていきます。
  7. それぞれクリックしたら、動的コンテンツとして、JSONの解析で取得した内容が出てくるので当てはめる
  8. 日時だけは、前項のタイムゾーンの変換を利用するので、変換後の時間を割り当てます。

前回と異なり、同じ名前のキー名がいくつか存在する。例えばnameというキーは今回3つあり、どれがどのJSONスキーマのnameにあたるのか?順番をよく把握して、当て込む必要があります。

※また注意点として、trigger名にはWebhookのトリガー名が入ってるのですが、トリガーによっては存在しないキーなどもあったりするので、

  • トリガー名だけ取得するJSONの解析を一個つくっておく
  • トリガー名で条件分岐して、それぞれに別途JSONの解析とJSONスキーマを用意する
  • 書き込み先は同じファイルでOK

図:同じ名前のキーがあるので注意が必要

図:成功するとレコードが書き込まれる

Webhook v2のデメリット

実際に使ってみてわかった事ですが、Box Webhook v2は確かにv1よりも多くの情報がWebhookで飛ばされてるのと、フォルダ単位で監視できるという大きなメリットがあるのですが、一方で「削除・ゴミ箱行き」に関しては、ファイルのIDおよび作成者のID・名前くらいしかデータが入っておらず、ファイル名といった情報がトレースできません。

ファイルのIDは分かってるので、追跡自体は可能ですが、Excelファイルにログとして記録に残るのが削除した事実とID、日付のみなので、ちょっと残念な仕様です。以下はDelete、Trash時のWebhookで送られてきてるJSON情報です。なお、削除の実行者はcreated_byの情報がそれになりますので、コピーやアップロードなどもModifyではなくCreatedを使うと良いでしょう。

関連リンク

共有してみる: