› 統合 › Web サービス レファレンス › Web サービス参照の管理

Web サービス参照の管理

[Web サービス参照] ページでは、Web サービス参照の管理や、Web サービス参照 (Open API 定義と非 Open API REST サービスを含む) の関連付けの表示を実行できます。

[Web サービス参照] ページを開くには、[統合] > [Web サービス参照] に移動します。Open API 定義と非 Open API REST サービスを持つすべての Web サービス参照が一覧表示されます。

Web サービス参照を作成すると、Web サービス アクティビティの作成や、インターネット Web サービスと対話するための Web サービス イベントの追加ができます。パブリック クラスとパブリック メソッドを備えたすべての Web サービスは、Web サービス アクティビティから呼び出すことができます。各パブリック メソッドには、変数を割り当てる必要があるパラメータのリストがあります。

Web サービス参照を管理する方法については、次のリンクを参照してください。

Web サービス参照を作成する

  1. [Web サービス参照] ページで、[新規] をクリックします。

    [新しい Web サービス参照] ダイアログ ボックスが表示されます。

  2. 設定する Web サービスの [サービス タイプ] を選択します。利用可能なオプションは次のとおりです。

    サービス タイプ

    [説明]

    [SOAP] (デフォルト)

    Web サービスの Web サービス記述言語 (WSDL) ファイルを参照する [URL] を指定します。たとえば、http://localhost/PlatformManagerWs/PlatformManagerWs.asmx?WSDL と指定します。

    システム設定で「すべて許可」が有効になっていない場合は、ホワイトリストに登録された Web サービス URL とエンドポイント URL のみを入力できます。それ以外の URL を入力した場合は、ホワイトリストに URL 接続文字列が登録されていないために接続が拒否されたことを示すメッセージが表示されます。

    [SOAP WCF]:

    .svc 拡張子を持つ Web サービスの [URL] を指定します。

    システム設定で「すべて許可」が有効になっていない場合は、ホワイトリストに登録された Web サービス URL とエンドポイント URL のみを入力できます。それ以外の URL を入力した場合は、ホワイトリストに URL 接続文字列が登録されていないために接続が拒否されたことを示すメッセージが表示されます。

    [RESTful]

    次の HTTP メソッドをマッピングする [URL] を指定します。GET、PUT、POST、DELETE。「RESTful サービス アクティビティ」および「RESTful サービス アクティビティの構成」を参照してください。

    システム設定で「すべて許可」が有効になっていない場合は、ホワイトリストに登録された Web サービス URL のみを入力できます。それ以外の URL を入力した場合は、ホワイトリストに URL 接続文字列が登録されていないために接続が拒否されたことを示すメッセージが表示されます。

    [RESTful Open API]

    次の操作を実行します。

    1. API が記述された有効な [Open API URL] を指定します。

      システム設定で「すべて許可」が有効になっていない場合は、ホワイトリストに登録された Open API URL とエンドポイント URL のみを入力できます。それ以外の URL を入力した場合は、ホワイトリストに URL 接続文字列が登録されていないために接続が拒否されたことを示すメッセージが表示されます。

    2. 定義タイプとして [JSON] または [YAML] を選択します。(デフォルト: JSON)

    3. 使用する[メソッド名] として、[操作 ID を使用する] または [HTTP 動詞を使用する] を選択します。(デフォルト: 操作 ID を使用する)

    サポートされている Web サービスの詳細については、「TotalAgility でサポートされる Web サービス」を参照してください。

  3. Web サービスの [名前] を入力します。
  4. デフォルトでは、システムによって新しい Web サービス レファレンスが作業カテゴリに自動的に保存されます。Web サービス レファレンスを別のカテゴリに保存するには、[カテゴリ] リストでカテゴリを選択します。

    Web サービスを分類することは、Web サービスへのアクセスを特定のユーザーに制限する際に役立ちます。

    Web サービスを持つプロセス マップまたはフォームをエクスポート/インポートすると、TotalAgility はその Web サービスのカテゴリもエクスポート/インポートします。また、カテゴリがまだ存在しない場合、TotalAgility は Web サービスのカテゴリを作成します。

  5. Web サービスのプロキシ DLL を再生成することなく Web サービスの実行場所を変更するには、[エンドポイント URL] を使用します。たとえば、移行を容易にするために、[エンドポイント URL] を使用して実行場所をテスト サーバーから実稼働サーバーに動的に変更します。URL を指定するには、次の手順を実行します。
    1. [エンドポイント URL] で、[はい] をクリックします。(デフォルト: いいえ)
    2. エンドポイントの [URL] を入力します。

    エンドポイント URL は、WSDL リンクではなく、Web サービスの場所である必要があります。エンドポイント URL がサポートされるのは、SOAP と WCF のみです。RESTful Web サービスではサポートされません。

  6. 構成済みの TotalAgility Enterprise サービス アカウントへのアクセスを制限するだけでなく、Web サービスへのアクセスを制御するには、次のオプションのいずれかを [認証] に選択します。

    [ベーシック]

    エンドポイントに [ユーザー名] と [パスワード] を入力します。

    OAuth

    [OAuth サーバー] リストから OAuth サーバーを選択します。

    • このオプションは、RESTful サービス タイプでのみ使用できます。RESTful サービス タイプを持つプロセス マップまたはフォームをエクスポートおよびインポートする場合、関連する OAuth サーバーをエクスポートおよびインポートすることもできます。

    • 統合済みの OAuth サーバーを持つ RESTful Web サービスを (プロセス マップまたはフォームを使用して) 実行すると、期限切れのアクセス トークンが自動的に更新され、Web サービスが正常に実行されます。これは、アクセス トークンが生成されていない OAuth サーバーには適用されません。

    [証明書]

    [参照] をクリックして、Web サービスでの認証に使用する証明書をアップロードし、[証明書のパスワード] にパスワードを入力します。

    証明書が無効な場合、実行時にエラーが表示されます。

    [ベーシック (外部)]

    構成済みの外部ストレージに保存されているユーザー名とパスワードのシークレット名を入力します。

    [なし] (デフォルト)

    認証は必要ありません。

  7. Web サービスにカスタム ヘッダーを追加するには、次の手順を実行します。
    1. [カスタム ヘッダー] の をクリックします。
    2. [名前] を Host などと入力します。
    3. [値] を localhost などと入力します。
    4. [追加] をクリックします。
  8. [保存] をクリックします。
    サービスが有効な場合、TotalAgility Designer ではプロキシ スタブ DLL が生成されます。

Web サービス参照を変更する

Open API 定義を持つ Web サービス参照を変更し、変更を保存すると、プロキシ スタブ DLL が再生成されます。

  1. [Web サービス参照] ページで Web サービス参照をクリックして、変更のために開きます。
    [Web サービス参照の編集] ダイアログ ボックスが表示されます。
  2. 必要に応じて変更を加えます。
  3. [保存] をクリックします。

Web サービス参照を削除する

[Web サービス参照] ページで、削除する Web サービスのコンテキスト メニューから [削除] をクリックします。

確認後に、選択した Web サービスが削除されます。

すでに使用されている Web サービス参照は削除できません。Web サービスの関連付けを表示することで、その Web サービスが使用されている項目を確認できます。

Web サービス参照の関連付けを表示する

Web サービス参照で使用されているプロセスやフォームなど、Open API 定義および非 Open API サービスを持つ Web サービス参照に関連付けられた項目を表示できます。

[Web サービス参照] ページで、関連付けを表示する Web サービス参照のコンテキスト メニューから [関連付け] をクリックします。[統合の関連付け] - <Web サービス レファレンス名> ダイアログ ボックスが表示されます。

項目の名前はハイパーリンクとして表示されます。項目名のリンクをクリックして、新しいブラウザ タブで項目を開き、必要に応じて変更することができます。

方法: Web サービス参照の使用