IBM App Connect Enterprise での Box の利用
Box は、チームのコラボレーションを支援する、セキュアな Web ベースのファイル共有サービスです。 どこからでも、どのデバイスでも、同僚とともにリアルタイムで文書を作成および編集できます。
このタスクの概要
IBM® App Connect Enterprise Windows、 AIX、および Linux® x64 システムで利用可能な「 Box Request 」ノードを介して、 Box と同期的に通信します。
- ブックマーク
- 作成、取得、更新、削除、またはブックマーク
- ファイル
- ファイルの作成、更新、コピー、または削除、およびファイル・コンテンツまたはメタデータの取得
- フォルダー
- フォルダーの作成、取得、更新、削除、またはコピー
- フォルダー項目
- フォルダー項目の検索
- コメント
- コメントの作成、取得、更新、または削除
- コラボレーション
- コラボレーションの作成、取得、更新、または削除
- ブックマーク
- ブックマークの作成、取得、更新、または削除
- グループ・メンバーシップ
- グループ・メンバーシップの更新または削除
- 共有リンク
- 共有リンクの作成、取得、または更新
- タスク
- タスクの作成、取得、更新、または削除
- タスク割り当て
- タスク割り当ての作成、取得、更新、または削除
Box Request ノードの設定と使用方法については、 Box Requestノードを参照してください。
手順
- 「 IBM App Connect Enterprise 」ツールキットで、 Box Request ノードを含むフローを作成します。
- フロー内の 「Box Request」 ノードを選択して、エディターにノード・プロパティーを表示します。
- 「基本」 タブで、 「コネクター・ディスカバリーの起動」をクリックします。コネクターのディスカバリー中に使用するポリシー・プロジェクトの名前とボールトの詳細を指定するパネルが表示されます。
- コネクターのディスカバリー中に使用するポリシー・プロジェクトとボールトの詳細を指定します。
- 「ポリシー・プロジェクト」 フィールドに、コネクター・ディスカバリー中に作成されるポリシーを保管するために使用されるポリシー・プロジェクトを指定します。あるいは、「新規」をクリックし、新規ポリシー・プロジェクトの名前を指定して、新規ポリシー・プロジェクトを作成することもできます。 次に、「完了」をクリックします。
- コネクターのディスカバリー中に使用するボールトを指定します。 デフォルトでは、コネクターのディスカバリー中に使用される資格情報は、 外部ディレクトリー・ボールトに保管されます。これは、どの統合サーバーでも使用できる App Connect Enterprise ボールトです。 あるいは、資格情報を統合サーバー・ボールトに保管することもできます。統合サーバー・ボールトは、統合サーバーの作業ディレクトリーに作成され、その特定の統合サーバーでのみ使用できます。資格情報の保管に使用するボールトを指定するには、以下のいずれかのトピックの「 コネクター・ディスカバリー・ウィザードの使用 」セクションの手順を実行します。
- 「ボールト鍵 (Vault key)」 フィールドに、ボールトに保管されている資格情報にアクセスするために使用するボールト鍵を入力します。 ボールト鍵の長さは 8 文字以上でなければなりません。
- オプション: デフォルトでは、指定されたボールト・ロケーションとボールト・キーが Toolkit の設定として保存されるため、コネクター・ディスカバリーの起動時に値が事前設定されます。 設定を保存しない場合は、ボールト設定に保存 を選択解除します。
- 「ポリシー・プロジェクト」 フィールドに、コネクター・ディスカバリー中に作成されるポリシーを保管するために使用されるポリシー・プロジェクトを指定します。
- Box コネクターの「コネクター・ディスカバリー」ウィザードを開始するには、 「ディスカバリーの起動」 をクリックします。「コネクター・ディスカバリー」 ウィンドウが表示されます。 既存の Box 接続 (アカウント) が使用可能な場合は、それらの接続のリストが表示されます。
既存の接続がない場合、 Box コネクターの状況はNot connectedと表示されます。- 1 つ以上の Box 接続 (アカウント) が使用可能な場合は、以下の手順を実行します。
- 接続 (アカウント) をクリックして、使用する接続を選択します。
- 必要なオブジェクト・タイプをクリックし、オブジェクトに対して実行するアクションを選択します。 例えば、 Boxからフォルダーを取得するには、 「フォルダー」 をクリックしてから 「フォルダーの取得」をクリックします。
- 既存の接続 (アカウント) がない場合は、以下のステップを実行します。
- 必要なオブジェクト・タイプをクリックし、そのオブジェクトに対して実行するアクションを選択します。 例えば、 Boxからフォルダーを取得するには、 「フォルダー」 をクリックしてから 「フォルダーの取得」をクリックします。
- 「接続」 をクリックします。
- 必要なアプリケーション・タイプを選択します。
- 非管理者ユーザー
- 管理ユーザー
- 「接続」 をクリックします。Box アカウントの接続の詳細を入力するためのウィンドウが表示されます。 次の情報を入力します。
- アクセス・トークン: Box 開発者コンソールでクライアント ID とクライアント秘密鍵から生成されるアクセス・トークン。 Box Developer Console で、Standard OAuth 2.0 (ユーザー認証)メソッドを使用してカスタムアプリケーションを作成し、クライアント ID とクライアントシークレットを生成します。 アクセス・トークンは、クライアント ID、クライアント秘密鍵、およびリダイレクト URI から生成されます。 詳細については、 http://ibm.biz/acboxoauth2nosdk をご覧ください。
- リフレッシュ・トークン: アプリケーション・クライアント ID とクライアント・シークレットから生成されるリフレッシュ・トークン。 詳細については、を参照してください http://ibm.biz/acboxoauth2nosdk。
- クライアント ID: Box 開発者コンソールでアプリケーションを作成した後に生成される固有 ID。 この値は、アプリケーションの「構成」ページで確認できます。
- クライアント秘密鍵: Box 開発者コンソールでアプリケーションを作成した後に生成されるアプリケーション・クライアント秘密鍵。 この値は、アプリケーションの「構成」ページで確認できます。
これらの接続情報の確認方法の詳細については、『 IBM 』の「継続的デリバリー(CD)」ドキュメントにある「Boxでの IBM の使用方法( App Connect ) 」( App Connect in containers )を参照してください。
- 「接続」 をクリックします。
- 1 つ以上の Box 接続 (アカウント) が使用可能な場合は、以下の手順を実行します。
- ウィザードで必要なコネクター・プロパティーを設定します。 データを取得するための条件を追加するには、 「条件の追加」 をクリックしてから、フィルターに掛けるプロパティーを選択します。 取得するレコードの最大数と、その制限を超えた場合に実行するアクションを指定するプロパティーを設定することもできます。
- 「コネクター・ディスカバリー」ウィザードでプロパティーを指定し終えたら、 「保存」をクリックします。Box への接続に使用される資格情報はボールトに保管され、その他の接続の詳細は Box ポリシーに保存されます。 ウィザードで設定したプロパティの値は、 IBM App Connect Enterprise Toolkit の 「Box Request 」ノードに返されます。
- ディスカバリーを終了してプロパティー値を保存したら、ウィンドウの右上隅にある X をクリックするか、 Alt+F4を押して、「コネクター・ディスカバリー」ウィザードを終了します。
- 「 IBM App Connect Enterprise 」ツールキットで、 「Box Request 」ノードの編集画面に戻ります。「コネクター・ディスカバリー」ウィザード (ステップ 6) で設定したコネクター・プロパティーが、プロパティー・エディターの 「Box 要求」 ノードに表示されるようになりました。 「基本」 タブには、ウィザードで設定した 「アクション」 プロパティーと 「オブジェクト」 プロパティーの値が表示されます。 たとえば、ウィザードで 「フォルダー 」>「 フォルダーを取得」 を選択した場合、ノードの 「基本 」タブには以下のプロパティが表示されます:
- 処置 -
RETRIEVEALL - オブジェクト -
Folders
処置 プロパティーおよび オブジェクト プロパティーの値は、読み取り専用形式で表示されます。 これらの値を変更するには、「コネクター・ディスカバリーの起動」を再度クリックし、「コネクター・ディスカバリー」ウィザードで新しい値を設定します。
「スキーマ・ベース名」 プロパティーは、 Box コネクターとの間で送受信される要求メッセージと応答メッセージの形式を記述するスキーマ・ファイルのベース名を指定します。 スキーマ・ベース名は、ノードのディスカバリーを初めて実行するときに自動的に設定され、現在のフロー名とノード名に基づいています。 ディスカバリーを初めて実行する前にこのプロパティーを手動で設定した場合は、設定した値が使用されます。 ディスカバリー後にスキーマの名前を変更する場合は、プロジェクト内の名前変更されたスキーマによって使用されるスキーマ・ベース名と一致するように、このプロパティーを編集する必要があります。 ディスカバリー後にこのプロパティーを変更する場合は、一致するようにスキーマ名を変更するか、再度ディスカバリーを実行する必要があります。
「コネクター・ディスカバリー」ウィザードは、ディスカバリー中に選択されたアクションに応じて、要求スキーマと応答スキーマ、または応答スキーマのみのいずれかを生成します。 アクションが
RETRIEVEまたはDELETEであった場合は、応答スキーマのみがコネクターによって返されます。 生成されたスキーマ・ファイルはプロジェクトに追加され、入力データまたは出力データを変換するために Mapping ノードで使用できます。 スキーマの完全なファイル名は、スキーマのベース名 (gen/MyMessageFlow.Box_Requestなど) から派生し、 response.schema.json または request.schema.jsonのいずれかの接尾部が付きます。 「要求スキーマを開く」 または 「応答スキーマを開く」をクリックして、スキーマを開くことができます。 - 処置 -
- Box Request ノードのプロパティー設定が正しいことを確認してから、メッセージ・フローを保存します。
- 「Box 要求」 ノードの 「接続」 タブで、 「ポリシー」 プロパティーに、接続に使用されるセキュリティー ID の詳細を含むポリシーの名前が表示されます。 ポリシーのタイプは
Boxです。詳細については、 ボックスポリシーを参照してください。 - オプション: 「接続」 タブの 「タイムアウト」 プロパティーを設定して、ノードが Box による操作の処理を待機する時間 (秒単位) を指定します。
- Box Request ノードの 「フィルター」 タブには、メッセージ・フローがデータを選択する方法を制御するプロパティーが含まれています。 これらのプロパティーの初期値は、「コネクター・ディスカバリー」ウィザードで Box コネクターに対して設定されたプロパティー値から取得されます。これには、フィルター・オプション・プロパティーと、指定された条件 (ステップ 6で説明) が含まれます。 その後「コネクター・ディスカバリー」ウィザードに戻り、プロパティーの値を変更すると (例えば、新しい条件を追加することによって)、それらの更新はノード上のプロパティー・セットに反映されます。
「フィルター・オプション」 プロパティーは、 Box Request ノードの実行時に操作するオブジェクトを制御します。 「フィルター制限」 プロパティーは、取得する項目の最大数と、制限を超えた場合に実行するアクションを制御します。
値を変更するには、 「フィルター・オプション」 セクションで変更する値の横にある 「編集」 をクリックし、 「フィルター制限」 セクションで設定したプロパティー値を変更します。
プロパティー値は、テキスト値にすることも、実行時に Box Request ノードに渡されるメッセージの内容から解決される ESQL または XPATH 式にすることもできます。
- 「要求」 タブで、 「データの場所」 プロパティーを設定して、 Boxで作成するオブジェクト・データを含む着信メッセージ・ツリー内の場所を指定します。 このデータは、 ボックス要求 ノードから ボックス システムに送信される要求を形成します。
- 「結果」 タブで、 「出力データの場所」 プロパティーを設定して、 Boxで作成されるレコードのデータが含まれる出力メッセージ・ツリー内の場所を指定します。
- デフォルトでは、要求メッセージは、コネクター・ディスカバリー中に生成された要求スキーマに照らして検証されます。 Box Request ノードの 「妥当性検査」 プロパティーを使用して、要求の妥当性検査をオフにしたり、妥当性検査の設定を変更したりすることができます。
- メッセージ・フローを保存 します。