IBM® App Connect with Boxの使い方

Boxは安全なウェブベースのファイル共有サービスで、チームのコラボレーションを支援します。 どこからでも、どのデバイスからでも、同僚とリアルタイムで文書を作成・編集できます。

Boxを使えば、チーム全員が同じファイル群を見ることができ、どこからでも、どのデバイスからでも、リアルタイムでファイルを変更することができる。 そのため、電子メールの添付ファイルとしてファイルのコピーを送信する必要がなく、誰もが常に最新バージョンのファイルを手元に持ち、コラボレーションをシームレスに行うことができます。 より多くのアプリを Boxに接続するには、 App Connect。 例えば、 Salesforce で新しいキャンペーンが作成されるたびに、 Boxにフォルダが自動的に作成され、チームの共同作業がより円滑になり、他の作業に費やす時間を節約できます。

対応製品およびAPIバージョン

このコネクタがサポートする製品およびAPIバージョンを確認するには、 IBM サポートページの詳細システム要件を参照してください。

ボックスへの接続

App Connect、 Boxアカウントに接続するには、ユーザーの種類を選択します：
  • 管理ユーザー (Admin user)
  • 非管理ユーザー

次に、以下の接続の詳細を記入する：

認証方法 接続フィールド 説明 適用範囲
基本的なOAUTH アクセス・トークン Box開発者コンソールで、Standard OAuth 2.0 (User Authentication)メソッドを使用してクライアントIDとクライアントシークレットを生成し、カスタムアプリケーションを作成します。 アクセストークンは、クライアントID、クライアントシークレット、リダイレクトURIから生成される。 詳しくは http://ibm.biz/acboxoauth2nosdk. App Connect in containers そして App Connect
リフレッシュ・トークン アプリケーションのクライアントIDとクライアント・シークレットから生成されるリフレッシュ・トークン。 詳しくは http://ibm.biz/acboxoauth2nosdk.
クライアント ID Box開発者コンソールでアプリケーションを作成した後に生成される一意の識別子。 この値はアプリケーションのコンフィギュレーション・ページで確認できます。
クライアント・シークレット Box開発者コンソールでアプリケーションを作成した後に生成されるアプリケーションクライアントシークレット。 この値はアプリケーションのコンフィギュレーション・ページで確認できます。
oauth 2.0 認証コード
ヒントアカウントにサインインして Boxへの接続を許可する。
   App Connect

App Connect Designer Connect > Applications and APIs ページ（以前は Catalog ページ ）から初めて Box に接続するには、 Box の下にある Connect をクリックします。 プロンプトが表示されたら、 App Connect、 Boxに保存されているファイルとフォルダへの読み取りと書き込みのアクセス権を許可します。 以下の手順で、 App Connect にアカウントを作成する。 詳細については、 アカウントの管理を参照してください。

Boxの接続値を取得するには、 Boxの接続値の取得を参照してください。

ヒント：
  • と同じブラウザウィンドウですでに Boxにログインしている場合、。 App Connect と同じブラウザ・ウィンドウでBoxにログイン済みの場合、 App Connect、メールアドレスとパスワードの入力を求めることなく、その Box アカウントに接続します。 別の Box アカウントに接続するには、まず Boxからログアウトするか、新しいブラウザウィンドウで App Connect。
  • Boxのアカウントをお持ちでない方は、個人アカウントを作成して無料で Boxをお試しいただけます。

で作成したアカウントをフローで使用する前に App Connect で作成されたアカウントをフローで使用する前に、そのアカウントを識別できるような意味のある名前に変更してください。 アプリケーションとAPI] ページでアカウント名を変更するには、アカウントを選択し、オプションメニュー(Ȯ)を開き、[ アカウント名の変更 ]をクリックします。

最初に考慮すべきこと

Box で App Connect Designer を使用する前に、以下の点に注意してください。

  • (一般的な考察) App Connect Designerの Applications and APIs ページで利用可能なトリガーイベントとアクションのリストを見ることができます。

    アプリケーションによっては、イベントとアクションは環境と、コネクタが設定可能なイベントとアクションの動的検出をサポートしているかどうかに依存する。 アプリケーションが設定可能なイベントをサポートしている場合、イベント・リストの下に Show more configurable events リンクが表示されます。 アプリケーションがアクションのダイナミックディスカバリーをサポートしている場合、アクションリストの下に Show more リンクが表示されます。

  • (一般的な考慮事項）アプリケーションに複数のアカウントを使用している場合、そのアプリケーションのアクションを選択したときに表示されるフィールドのセットは、アカウントによって異なる可能性があります。 フローエディターでは、アプリケーションによっては、常にアクションのための静的フィールドのキュレーションセットを提供します。 他のアプリケーションは、接続先のインスタンスで設定されているフィールドのセットを取得するために、ダイナミック・ディスカバリーを使用します。 例えば、あるアプリケーションの2つのインスタンスに2つのアカウントがある場合、最初のアカウントはすぐに使える設定を使うかもしれません。 しかし、2つ目のアカウントには余分なカスタムフィールドが設定されている可能性があります。

ポスト接続に関する考慮事項

  • Create file アクションを使用して Box にファイルを追加する場合、以下の点が適用されます。
    • 作成するファイルの親フォルダを指定します。 このフォルダは Box 内に存在する必要があり、アカウント内の Box フォルダの事前入力リストから選択できます。
      フォルダを選択した状態でBoxのファイルフィールドを作成する
      ヒント： フォルダーに、入力されたリストからの静的な値ではなく、動的な値（以前のイベントまたはアクションが返す値）を指定するには、詳細モードに切り替えます。 リストはテキストボックスに変換され、それを使って前のノードのフォルダIDにマッピングすることができる。
      詳細モードを使用してフォルダに動的な値を指定する
    • ファイル名の拡張子を指定しない場合、デフォルトでテキストファイル（.txt）が作成されます。
    • ファイルの種類」 フィールドを使用して、ファイルの内容をプレーンテキスト （Text ）として扱うか、PDFやMicrosoft Wordなどのファイル形式に対して Base64 エンコーディング （Binary ）を適用するかを指定します。
  • Create folder アクションを使用して Box フォルダを作成すると、デフォルトでルート レベルにフォルダが作成されます。 フォルダがルートレベルで作成される場合、 親 ID フィールドに表示されるデフォルト値は 0（ゼロ）です。
    Box用フォルダフィールドの作成

    Box UIでは、このIDはルートフォルダの URL。

    Boxルートフォルダの親ID URL

    作成されるフォルダの親フォルダを別に指定するには、デフォルトの ID 0 をハードコードされた値またはマップされた値で上書きします。 親フォルダーは存在している必要があります。

    • 親フォルダのハードコードIDを取得するには、 Boxでフォルダを開きます。 フォルダのIDは、ブラウザのアドレスバーの URL、末尾に数字の羅列として表示される。 例えば、 URL https://app.box.com/folder/31234567893、フォルダIDは31234567893である。
    • フローにフォルダ ID を返す前のアクションが含まれている場合（たとえば、'Retrieve folders' アクション）、マップされたフィールドとして親 ID を指定することもできます。
      マッピングされた値を示す親IDフィールド
  • ファイルの内容を取得または転送する際、 JSONata関数を使用してファイルの内容を解析または変換する必要がある場合、ファイルの最大サイズは10MBです。 それ以外の場合、最大ファイルサイズは50MBです。

    Create file アクションでは、テキストを指定するか、フロー内の前のノードのコンテンツにマッピングすることで、ファイルのコンテンツを指定できます。 コンテンツにマップする場合は、マップされた値を1つだけ指定し、マップされた値に文字列の接頭辞を付加したり追加したりしない。 有効な例と無効な例を以下の表に示す。

    有効な例 無効な例
    テキストのみにマッピングされたファイル・コンテンツ・フィールドを示す有効な例
    ファイル・コンテンツ・フィールドがボックス・ファイル・コンテンツのみにマッピングされている有効な例
    ボックス・ファイル・コンテンツ・フィールドがプリペンド・テキストとボックス・ファイル・コンテンツにマッピングされている無効な例
    ファイル コンテンツ フィールドがボックスのファイル コンテンツと追加テキストの両方にマッピングされている無効な例
    ファイル コンテンツ フィールドが Box ファイル コンテンツの 2 つのインスタンスにマッピングされている無効な例
  • ファイル メタデータの取得 ］アクションを使用する場合は、フィルタ条件を指定する必要があります。 ボックスファイルのIDを指定するか （ID 条件）、ファイル名、説明、コメントから検索する文字列を指定する （検索文字列条件）。
  • タスクの作成」アクションを使用して Box ファイルにタスクを追加する場合、ファイルのID （アイテムID フィールド）を指定する必要があります。 ID 値は、以前のアクション（例： Retrieve file metadata ）から、または既知のファイル ID（例：Box ウェブブラウザインターフェースのファイルアドレス https://app.box.com/file/File_ID ）から指定することでマッピングできます。
  • Fields パラメータを含むRetrieveアクション（例えば、 Retrieve trashed file アクション）を使用すると、レスポンススキーマには、Box APIからデフォルトでは返されない多くのプロパティが含まれます。 これらのプロパティはマッピング・エディタに表示されますが、明示的に要求しない限り値は入力されません。

    Boxでゴミ箱に入れたファイルを取り出す

    これらのプロパティの値を取得するには、 Fields パラメータでそれらの名前をカンマ区切りのリストとして指定する必要があります。 Fields パラメータにプロパティ名を含めない場合、それらのプロパティをマッピングしても、レスポンスにはそれらのプロパティの値は含まれません。 例えば、名前、file_version、descriptionを取得したい場合、 Fields inputに name,file_version,description と入力する。 応答には、これらのプロパティの値が含まれる。

トラブルシューティングのヒント

Box アクションの中には、フローに追加されると、即座に Boxに APIコールを行い、アクションを実行できる既存のオブジェクトのセットを取得するものがあります。 たとえば、 Create file アクションは、ファイルを作成できる既存のフォルダーのリストを取得するために最初に呼び出しを行います。 もしNot connectedこのようなアクションを追加したときに検証エラーが発生するが、他のBoxアクション（通常、フローが実行されたときにのみ呼び出される）ではこのエラーが表示されない場合は、 App Connect と Boxの間の接続が壊れている可能性がある。

ボックス / ファイルを作成するアクションで「接続されていません」というメッセージが表示される

切断された接続を再確立するには、そのアカウントの接続詳細を更新して Box アカウントを再認証する必要があります。

出来事と行動

ボックスイベント

これらのイベントは、フロー内のアクションを完了するためにフローを開始するトリガーとなる、このアプリケーションの変更に対するものである。

注： このアプリケーションでは、イベントは変更できません。 スケジュールされた間隔や特定の日時など、他の方法でフローをトリガーすることもできる。

ボックスアクション

あなたのフローは、このアプリケーション上でこれらのアクションを完了します。

オブジェクト アクション 説明
ブックマーク ブックマークの作成 ボックスにブックマークを作成する
ブックマークの削除 BoxアカウントからWebリンクを削除する
ブックマークの取得 ウェブリンクに関する情報を取得する
ブックマークの更新 ウェブリンクの更新
コラボレーション コラボレーションを生み出す Boxでコラボレーションを作成
コラボレーションの削除 Boxアカウントからコラボレーションを削除する
コラボレーションを検索する コラボレーションに関する情報を取得
コラボレーションを更新 コラボレーションを更新
コメント コメント作成 ボックスにコメントを作成する
コメント削除 Boxアカウントからコメントを削除する
コメントの取得 コメントに関する情報を取得
コメント更新 コメントを更新
ファイル ファイルのコピー 別のフォルダにあるファイルのコピーを作成します。 ファイルのオリジナルバージョンは変更されない。
ファイル作成 Boxアカウントの指定したフォルダにファイルを作成します
ファイルの削除 Boxアカウントからファイルを削除する
ファイル内容の取得 Boxアカウントからファイルをダウンロードする
ファイルのメタデータを取得する Boxアカウント内のファイルに関する情報を取得
ファイルの更新 特定のファイルの内容を更新する
ファイルバージョンの取得 ファイルの過去のバージョンのリストを取得する
ゴミ箱に入れたファイルを取り出す ゴミ箱に移動されたファイルを取り出す
フォルダー項目 フォルダ項目の取得 すべてのフォルダ項目を取得
フォルダー コピーフォルダ フォルダのコピーを別のフォルダに作成する
フォルダーの作成 Boxに新しいフォルダを追加する
フォルダの削除 Boxアカウントからフォルダを削除する
フォルダの取得 フォルダに関する情報を取得する
フォルダの更新 特定のフォルダの設定を更新する
グループ・メンバーシップ グループメンバーの作成 グループにグループ・メンバーシップを作成する
グループメンバーの削除 Boxアカウントのグループからグループメンバーシップを削除する
グループメンバーシップの取得 グループメンバーに関する情報を取得する
グループメンバーの更新 グループメンバーを更新する
共有リンク 共有リンクの作成または更新 共有リンクの作成または更新
共有リンクの取得 共有リンクに関する情報を取得する
タスク割り当て タスク割り当ての作成 Box 内のタスクの割り当てを作成する
タスク割り当ての削除 Boxアカウントのタスクの割り当てを削除する
タスク割り当ての取得 Box 内のタスクの割り当てを取得する
タスク割り当ての更新 Boxアカウントのタスクの割り当てを更新する
タスク タスクの作成 ファイルにタスクを作成する
タスクの削除 Boxアカウントからタスクを削除する
タスクの取得 タスクに関する情報を取得する
更新タスク タスクを更新する

App Connect を Boxに接続すると、より多くのアイテムが利用可能になる。

例

Boxを使用するテンプレートのダッシュボード・タイル
Boxを使用するテンプレートのダッシュボード・タイル
Boxを使用するテンプレートのダッシュボード・タイル

テンプレートを使って Box 用のフローを素早く作成

App Connect テンプレートを使って、 Box 上でアクションを完了するフローをすばやく作成する方法をご紹介します。 例えば、 Discoverを開き、 Box を検索する。

さらに詳しく

Boxを使用するテンプレートのダッシュボード・タイル