5.4. API プロバイダーインテグレーションのオペレーションフローの定義

手順

1. Operations リストページで、定義するフローのオペレーションに対して Create flow をクリックします。

2. このフローに追加する各コネクションに対して以下を行います。

   1. フロービジュアライゼーションで、プラス記号をクリックしてその場所にコネクションを追加します。
   2. 使用するコネクションをクリックします。
   3. コネクションが実行するアクションを選択します。
   4. ラベルが付いたフィールドにデータを入力して、アクションを設定します。
   5. Next をクリックします。

   フローに必要なコネクションをすべて追加してから、続行します。

3. このオペレーションフローでコネクション間のデータを処理するには、以下を行います。

   1. フロービジュアライゼーションで、ステップを追加する場所にあるプラス記号をクリックします。
   2. 追加するステップをクリックします。
   3. ラベル付が付いたフィールドにデータを入力して、ステップを設定します。

   4. Next をクリックします。

      ヘルプが必要な場合は コネクション間のステップの追加 を参照してください。

   コネクションの間のデータを処理する別のステップを追加する場合は、この手順のサブセットを繰り返します。

4. データを次のコネクションのフィールドにマップします。

   1. フロービジュアライゼーションで、コネクションが受信データを処理できないことを示す、データタイプ不一致の アイコンを確認します。ここでは、データマッパーステップを追加する必要があります。

   2. フロービジュアライゼーションの各データ不一致アイコンに対して以下を行います。

      1. そのステップの直前にあるプラスマークをクリックします。
      2. Data Mapper をクリックします。
      3. 必要なマッピングを定義します。ヘルプが必要な場合は インテグレーションデータを次のコネクションのフィールドにマッピング を参照してください。
      4. Done をクリックして、データマッパーステップをフローに追加します。

5. フロービジュアライゼーションの、Provided API Return Path ステップで Configure をクリックします。

   すべての API プロバイダーインテグレーションは、オペレーションフローの実行をトリガーした REST API の呼び出し元に応答を送信することで、各オペレーションフローを終了します。応答には、オペレーションのフローを終了する Provided API Return Path ステップのに設定した戻りコードの 1 つが含まれます。以下のように、Return Path ステップを設定します。

   1. Return Code フィールドの Default Response で、Fuse Online に表示されるデフォルトの応答を指定するか、下向きのキャレットをクリックしてスクロールし、希望のデフォルト応答を選択します。オペレーションフローを実行しても設定されたエラー応答がどれも返されなかった場合、フローはこの応答を送信します。通常、デフォルト応答の戻りコードはオペレーションに成功したことを意味します。

   2. 返されたメッセージのボディー部にエラーメッセージが含まれるようにするかどうかを Error Handling に指定します。

      通常、開発中はエラーメッセージを返すようにします。しかし、実稼働では機密情報が含まれる場合にエラーメッセージを非表示にする場合があります。エラーメッセージは、responseCode、category、message、および error 要素が含まれる JSON 形式の文字列です。例を以下に示します。

         {
            responseCode: 404,
            category:  "ENTITY_NOT_FOUND_ERROR",
            message: "SQL SELECT did not SELECT any records"
            error: SYNDESIS_CONNECTION_ERROR
          }

      開発中、最も確実にエラーの発生を確認する方法は、呼び出し元への応答の HTTP_RESPONSE STATUS ヘッダーをチェックすることです。インテグレーション Pod のログで INFO メッセージを確認することもできます。インテグレーションの Activity ログには成功した交換が記録され、エラーは Activity ログに常に記録されるとは限りません。

   3. Error Response Codes には、フローのコネクションが返す可能性がある各エラーのエントリーが表示されます。エラーごとに、デフォルトの戻りコードである 200 All is good を指定するか、クリックして別の HTTP ステータスの戻りコードを選択します。

      選択可能な戻りコードは、このフローで実行されるオペレーションのために OpenAPI ドキュメントで定義される戻りコードです。必要な戻りコードが Fuse Online に表示されない場合、OpenAPI ドキュメントを編集して追加できます。

      これを行うには、右上の View/Edit API Definition をクリックします。必要に応じて OpenAPI ドキュメントを編集します。編集し終わったら、OpenAPI ドキュメントを保存します。Fuse Online が Provided API Return Path の編集に戻り、保存した変更が反映されます。

   4. Next をクリックし、リターンパスの設定を完了します。

6. このフローに、必要なコネクションとステップがすべてあり、データの不一致アイコンがない場合や、現時点でフローを編集しない場合は、以下の 1 つを行います。

   • Publish: インテグレーションの実行を開始するには、右上の Publish をクリックします。これにより、インテグレーションがビルドされ、REST API サービスが OpenShift にデプロイされます。さらにインテグレーションが実行できるようになります。オペレーションフローの作成を完了するときやオペレーションフローを編集するときに、インテグレーションをパブリッシュできます。
   • Save: オペレーションのリストを表示するには、右上の Save をクリックします。