RESTful サービス アクティビティの構成

RESTful サービス アクティビティを使用して、プロセス内のドキュメント セットに関連するアクティビティを構成します。

RESTful サービス アクティビティを使用するには、最初に RESTful サービス参照を設定する必要があります。Web サービス レファレンスの作成を参照してください。

  1. マップにアクティビティの追加します。

    デフォルトでは、アクティビティの [プロパティ] パネルで [構成] タブが開きます。

  2. アクティビティのデフォルトの [名前] を意味のある名前に変更します。
  3. [タイプ] リストで、[その他] > [RESTful サービス] を選択します。
  4. 必要に応じて、[Web サービス] リストで事前構成済みの RESTful Web サービス リファレンスを選択します。

    選択した RESTful サービスに応じて、[ベース URL] が表示されます。また、RESTful サービスで定義されたカスタム ヘッダーが [カスタム ヘッダー] の下に表示されます。

    Web サービス レファレンスをホワイトリストに登録できます。システム設定ですべて許可が選択されていない場合は、ホワイトリストに登録された Web サービス レファレンスのみを使用できます。サーバー URL とデータベース接続文字列の構成を参照してください。
  5. 必要に応じて、次のいずれかを実行して、URL パラメータ (返される結果に影響する文字列タイプのオプション パラメータ) を指定します。
    • 固定パラメータを指定するには、[URL パラメータ] ボックスに必要なテキストを入力します。

    • 実行時の関連情報を動的に取得し、実行時にユーザーに対して表示するには、URL パラメータ ルール エディターを右クリックし、[URL パラメータ] ボックスでプロセス変数またはサーバー変数を選択します。

    • [URL パラメータ] ボックスで固定テキストと動的な値の組み合わせを使用します。

    ベース URL パラメータをコピーして別の RESTful サービスのベース URL パラメータに貼り付けると、ベース URL パラメータを再利用できます。
  6. [メソッド] リストで、実行するアクションを選択します。(デフォルト: GET)

    [GET] または [DELETE]

    データを取得するには GET、データを削除するには DELETE を選択し、次の手順を実行します。

    • [タイプ] として [XML] または [JSON] を選択します。(デフォルト: XML)

    • Web サービス レファレンスの作成時に定義されたカスタム ヘッダーとそのデフォルト値は、[カスタム ヘッダー] の下に表示されます。カスタム ヘッダーのデフォルト値を編集するには、次の手順を実行します。

      1. 行をダブル クリックするか、行を選択して、 をクリックします。

      2. [値] で動的変数を選択するか、 をクリックして静的な値を入力します。

      3. OK をクリックします。

        プロセスでジョブが作成されると、定義されたカスタム値がサード パーティの Web サービスに渡されます。このアクティビティでマッピングされた値またはインライン値が指定されなかった場合、RESTful サービス定義で定義されたデフォルト値が使用されます。

    • [応答タイプ] リストで次のいずれかを選択します。

      • [変数] (デフォルト) を選択し、[値] リストでプロセス変数またはサーバー変数を選択して、出力全体を文字列タイプまたは XML タイプの単一の変数にマップします。

      • [式] を選択して次の手順を実行します。

        1. をクリックします。

        2. 式から抽出する要素を定義するには、正しい [パス] を指定します。
        3. [値] リストで、プロセス変数またはサーバー変数を選択します。

        4. [追加] をクリックします。

    [POST] または [PUT]

    データを挿入するには POST、データを更新するには PUT を選択し、次の手順を実行します。

    • [タイプ] として [XML] または [JSON] を選択します。(デフォルト: XML)

    • [リクエスト] ルール エディタを右クリックして、プロセス変数またはサーバー変数を選択します。

    • Web サービス レファレンスの作成時に定義されたカスタム ヘッダーとそのデフォルト値は、[カスタム ヘッダー] の下に表示されます。カスタム ヘッダーのデフォルト値を編集するには、次の手順を実行します。

      1. 行をダブル クリックするか、行を選択して、 をクリックします。

      2. [値] で動的変数を選択するか、 をクリックして静的な値を入力します。

      3. OK をクリックします。

        プロセスでジョブが作成されると、定義されたカスタム値がサード パーティの Web サービスに渡されます。このアクティビティでマッピングされた値またはインライン値が指定されなかった場合、RESTful サービス定義で定義されたデフォルト値が使用されます。

    • [応答タイプ] リストで次のいずれかを選択します。

      • [変数] (デフォルト) を選択し、[値] リストでプロセス変数またはサーバー変数を選択して、出力全体を文字列タイプまたは XML タイプの単一の変数にマップします。

      • [式] を選択して次の手順を実行します。

        1. をクリックします。

        2. 式から抽出する要素を定義するには、正しい [パス] を指定します。
        3. [値] リストで、プロセス変数またはサーバー変数を選択します。

        4. [追加] をクリックします。

      別の RESTful サービスの PUT および POST メソッドにリクエストをコピーして貼り付けることで、リクエストを再利用できます。

  7. 返されたステータス コードの処理方法を指定するには、[エラー時にジョブを一時停止] に対して次のいずれかを実行します。(デフォルト: クリア)
    • [エラー時にジョブを一時停止] チェック ボックスをクリアして、[エラー コード] リストでプロセス変数またはサーバー変数を選択します。

      エラーが検出され、選択されたエラー コードが実行時に表示される場合でも、ジョブは完了します。これは、ユーザーがエラーを手動で処理するのに役立ちます。

    • [エラー時にジョブを一時停止] を選択します。

      エラーが見つかった場合、ジョブは一時停止されます。

  8. プロセス マップを [保存] します。