Boxの連携方法|データ連携ならiPaaS「JENKA」

Box

ファイルIDとフォルダIDについて



Boxで連携を行うためには、ファイルIDとフォルダIDについての理解が必要になります。

ファイルID

ファイルIDは、ファイルのユニークなIDです。ファイルを開いた際に表示されるURLの一部が、ファイルIDとなります。
このURLは、ファイルを開いた際のURLに記載されています。

フォルダID

フォルダIDは、フォルダのユニークなIDです。ファイルを開いた際に表示されるURLの一部が、フォルダIDとなります。



アプリ設定



コラボレーションや共有設定などの権限のついたフォルダやファイルをJENKAから操作する際に必要となります。

本設定を行わずに、JENKAで権限のついたフォルダやファイルを操作するとエラーが発生します。
1.管理者アカウントでログインし、[管理コンソール]をクリック


2.管理者設定の画面に遷移したらメニューから、①[アプリ]をクリック、②[カスタムマネージャ]をクリック、③[アプリの追加」をクリック


3.以下のアプリの追加IDが表示されるので以下のクライアントIDを入力して⑤[次へ]をクリック
クライアントID: apudvi8cteo85du8luedheosnqdcnl21


4.JENKA_CLIENTに関する情報が表示されるので、⑥[承認]をクリック


5.以下のように表示されていれば設定完了です。



認証方法



  1. コネクタを開いてボタンをクリックしてください。 
    ※グローバルメニューのサービス認証からもおこなえます。

  2. 認証画面が表示(ログインしていない場合はログイン画面)>[Boxへのアクセスを許可]クリック
     

    成功の画面が表示されます。「✖」で閉じください。

トリガー


BoxではWebhookが用意されています。以下のページをご参照ください。

アクション-ファイルの操作



ファイル-共通

各アクションの共通項目について、以下の項目を設定してください。
項目名 必須 内容 備考
コネクタ名
対象のコネクタ名を記載
認証
対象のサービス認証を指定 サービス認証した認証名が表示
操作対象の選択
選択肢によって操作が分岐 選択肢:ファイル/フォルダ
操作
以下操作対象によって項目が異なる



ファイル-アップロード

指定したフォルダにファイルをアップします。以下の項目を設定して、[保存]をしてください。
項目名 必須 内容 備考
フォルダのIDを指定 アップロード先のフォルダのIDを入力 認証されたアカウントのフォルダが表示
ファイルを指定 ファイル変数を指定する
ファイル名を変更してアップロード アップロードしたファイル名から変更する場合は有効化 有効化した場合、ファイル名を入力する欄が表示




ファイル-ダウンロード

JENKA上にファイルをダウンロードして、後続のワークフローで利用できます。以下の項目を設定して、[保存]をしてください。
項目名 必須 内容 備考
ファイルID指定 ファイルIDを記述




ファイル-削除

指定したファイルを削除します。以下の項目を設定して、[保存]をしてください。
項目名 必須 内容 備考
ファイルID ファイルIDを記述





ファイル-一覧の取得

指定したフォルダのファイルの一覧を取得します。ファイル名にある特定のキーワードで絞り込みも行えます。以下の項目を設定して、[保存]をしてください。
項目名 必須 内容 備考
操作を実行するフォルダ 対象のフォルダを指定 認証されたアカウントのフォルダが表示
絞り込み検索を利用する コピー元のファイル名から変更する場合は有効化 有効化した場合、絞り込みが表示
最大のリスト情報の取得数
取得可能なリスト数
最大100個まで



ファイル-リンクを取得

ファイルのリンクを取得します。下記の項目を設定して[保存]をします。
項目名 必須 内容 備考
ファイルID ファイルIDを記述



アクション-フォルダの操作



フォルダ-リスト情報の取得

フォルダの中にあるのフォルダのリスト情報を取得します
項目名 必須 内容 備考
操作を実行するフォルダ 操作対象のフォルダを選択 認証されたアカウントのフォルダが表示
絞り込み検索を利用する - ONにすると、検索したい文字を指定する欄と最大で取得するリストの数を指定する
最大のリスト情報の取得数
取得可能なリスト数
最大100個まで


フォルダ-作成

項目名 必須 内容 備考
フォルダIDを指定 フォルダ作成先のフォルダのIDを入力 認証されたアカウントのフォルダが表示
フォルダ名
フォルダ名を記述



フォルダ-コピー

指定したフォルダ内のフォルダの一覧を取得します。以下の項目を設定して[保存]をしてください。
項目名 必須 内容 備考
コピー元のフォルダのIDを指定 指定したフォルダの配下にあるファイルやフォルダもコピーする。 認証されたアカウントのフォルダが表示
コピー先のフォルダのIDを指定 指定したフォルダにコピー元のフォルダが作成される
コピー元のフォルダ権限、コラボレーション設定を引き継ぐ - コピー元で設定されている権限やコラボレーション設定を引き継ぐ。
フォルダ名を変更する

チェックを入れるとフォルダ名を指定できる入力項目が表示される


[コピー元のフォルダ権限、コラボレーション設定を引き継ぐ] を設定した際の親フォルダの共有設定とコラボレーションの違いについては、
以下をご参照ださい。
[コピー元のフォルダ権限、コラボレーション設定を引き継ぐ] のチェック チェックOFF チェックON
コピー元のフォルダ/ファイルに直接付与されたコラボーレション
コピー元のフォルダ/ファイルに直接付与された共有設定
コピー先の上位階層のコラボレーション設定が適用される
コピー先の上位階層の共有設定が適用される
〇=引き継がれる ×=引き継がれない


コピー元のフォルダが大きい場合、数時間程度お待ちいただく場合があります。
Boxでは、コピーや移動、権限設定の際、ファイル保全のためフォルダやファイルが編集されないようにロックが掛かります。


コピー元フォルダ内に大量のフォルダやファイルがある場合かつ、コピー元のフォルダ権限、コラボレーション設定を
引き継ぐを引き継ぐ場合には注意が必要です。



コピー元のフォルダ大きい場合、コピー元、コピー先でロックが掛かります。


JENKAでは以下のように処理を行います。
フォルダのコピー処理
コピー元のフォルダ権限、コラボレーション設定を引き継ぐ処理
①1つ目のフォルダのコピーを実施し、コピー元にロック掛かる。
 コピーが完了するまで、コピー先のロックも発生します。
③2つ目のフォルダのコピーは、1つ目のコピー元のロックが外れるのをを待ち、コピー元のロックがはずれたらコピーを開始します。
ただし、コピー先にロックが掛かっている場合、コピー先のロックがはずれてからコピーを開始します。
②1つ目のコピー先のフォルダが作成されロックが外れるまで待機し、
 ロックが外れたらコレボレーション設定等の権限設定を開始します。
④2つ目のコピー先のフォルダが、1つ目と同じ親フォルダ内の場合、
 そのフォルダ配下全体にロックが掛かります。
 1つ目の権限設定が完了し、2つ目のフォルダがコピーされた後に権限設定を開始します。

ex.連続でコピーした際のかかる時間のシミューション
フォルダ数200個のコピーの場合で、コピーから権限付与まで1.5H程度かかった実績があり、下記の例だと2つ目のコラボ設定開始まで、最大2.5時間程度発生します。
フォルダの処理 コピー元のフォルダ権限、コラボレーション設定を引き継ぐ処理 発生時間
処理1 1つ目のフォルダコピー 0.5H
処理2 1つ目のコラボ設定 1.5H
処理3 2つ目のフォルダコピー開始
※2つ目のコピー先が1つ目のフォルダと同じ場合、コピー元とコピー先のロックが掛かり、
 2つのロックが外れるまで待った場合の最大の想定
0.5H
処理4 2つ目のコラボ設定
※全体の負荷状況などにより大きく異なる場合がございます。













フォルダ-削除

フォルダIDを指定してフォルダを削除します。
項目名 必須 内容 備考
フォルダID フォルダIDを記述




フォルダ-移動

移動元と、移動先のフォルダを指定します。
項目名 必須 内容 備考
移動元のフォルダのIDを指定 指定したフォルダの配下にあるファイルやフォルダも移動する
移動先のフォルダのIDを指定
指定したフォルダに移動

親フォルダーの権限およびコラボレーションの設定を継承する
移動先の親フォルダに従って、権限やコラボレーションに関する設定を行う

フォルダ名を変更する
チェックを入れるとフォルダ名を指定できる入力項目が表示される



[親フォルダーの権限およびコラボレーションの設定を継承する]を設定した際の親フォルダの共有設定とコラボレーションの違いについては、
以下をご参照ださい。
フォルダの権限およびコラボレーション設定を引き継ぐ]のチェック チェックOFF チェックON
移動元のフォルダ/ファイルに直接付与されたコラボーレション
移動元のフォルダ/ファイルに直接付与された共有設定
移動先の上位階層のコラボレーション設定が適用される
移動先の上位階層の共有設定が適用される 
〇=引き継がれる ×=引き継がれない








    • Related Articles

    • HTTPコネクタ用 OAuth認証Box

      概要 HTTPコネクタ用 OAuth認証の利用方法を記載します。 ご利用方法 本設定内容は、Boxでの設定例について記載します。 サービス認証メニューから+ボタンをクリックして、HTTPリクエストを選択します。ポップアップ画面では、任意の[認証名]を記載して、[サービス]で[Box OAuth2]を選択します。     HTTPリクエストの認証画面がひらくので、必要情報を記載していきます。 項目 内容 グループ 認証を利用するグループを選択します。 認証名 任意の認証名を記載してください。 ...
    • Webhook(受信)の設定例 Box

      Boxの設定例 BoxではWebhookが用意されています。Webhookを作成するには、以下の手順に従います。 開発者コンソールで、カスタムアプリを選択します。 カスタムアプリに関する必要事項を記載して、2ページ分の情報を記載して作成します。オプションについては「自動化」してください。    WebhookV2を利用するのが一般的なので、アプリの承認を管理者が行う必要があります。 [構成]タブをクリックして、開発者操作の[Webhook]にチェックを入れて[変更を保存]します ...
    • HTTPコネクタ用 boxの利用方法例 フォルダーへのアクセス権限付与

      概要 BoxのAPIの利用方法の例として、フォルダに対して特定のユーザーに編集権限を与える方法について記載します。 参照API:https://ja.developer.box.com/reference/post-collaborations/ ご利用方法 サービス認証 サービス認証を行ってください。設定方法については、以下を参照してください。 https://help.jenka.jp/portal/ja/kb/articles/oauth-box ...