Add a bridge action for connectors


Note: This article applies to the web services data dip connector.

After you add and start a web services data dip connector, you can create or update an interaction flow in Architect that uses a bridge action associated with the connector. For more information, see Add a data dip connector.

Bridge actions are associated with either a default connector action or a custom connector action. Use a default connector action to retrieve information about accounts, cases, or contacts. Use a custom connector action to interact with information by selecting CustomAction, configuring the endpoint, and adding request and response schemas.

  1. Add a bridge action to a connector group.
    1. PureCloudの 管理をクリック
    2. Under Integrations, click Bridge.

      The Manage Bridge Integrations page appears.

    3. Click the Actions tab.
    4. クリックします。 アクションを追加します。.

    The Add a New Bridge Action dialog box appears.

  2. Select a connector group and a connector action.

    In the Add a New Bridge Action dialog box, follow these steps:

    1. Under Select Connector Group, select the name of the web services data dip connector that you added.

      This list of connector groups matches the names of your connectors on the Connectors tab of the Manage Bridge Integrations page. Selecting a connector group in this list associates a connector action with your connector. 

    2. Under Select Connector Action, select a default or custom connector action that you want the connector group to use.

      デフォルトのコネクター アクションは Web サービスを使用して、アカウント、ケース、連絡先についての情報をサードパーティ システムから取得します。カスタムのコネクター アクションでは、Web サービスを使用して、サードパーティ システムの情報を扱うリクエスト・レスポンス スキーマを作成できます。

      The example uses the default connector action GetAccountByPhoneNumber.

    3. [次へ] をクリックします。
  3. Identify the bridge action.
    1. Enter the following information:
      • Name: A name for your action.

        名前はスペースや特殊文字があってはいけませんが、ハイフンやアンダースコアを含むことはできます。 

      • Description (optional): A description for the action. 
      • Category (optional): The category name for the action.

        A category is a name for a group of related bridge actions. When you are creating a call flow in Architect, categories can help you find a bridge action that is part of a particular group.

      • Help Link (optional): A link to internal support documentation about the bridge action.
      • Suggested Timeout (ms) (optional): Time after which action times out.

        Leave this box blank for the default timeout of 5 seconds (= 5000 ms).

    2. Select Flatten metadata.

      If you do not select Flatten metadata, Architect cannot use the bridge action.

    3. 保存をクリックします。

    The Action Details page for the bridge action that you saved appears.

  4. Modify the request and response schemas (custom connector action only).

    カスタム コネクター アクションを使用する Bridge アクションには、デフォルトのリクエスト・レスポンス スキーマを変更します。スキーマにより、Web サービスに要求し受信する情報を指定できます。 

    キー
    $schema 変更できません。デフォルト: “http://json-schema.org/draft-04/schema#”.
    title Schema title.
    description Schema description.
    type 変更できません。デフォルト: “object”.
    properties

    The names of the objects of the properties (Code in the example Request Schema) appear under Inputs in your call flow in Architect.

    Warning: Do not use nested objects; schemas with nested objects do not flatten correctly.

    {object} Property object.
    type Object type. Supports all JSON types, except object, null, and nested arrays.
    description Object description.
    additionalProperties 変更できません。デフォルト: true。
    メモ:コネクターは有効な JSON スキーマのみと動作し、スキーマに対してリクエスト・レスポンス ボディを検証しません。 

    以下の例は、コード (文字列) が懸賞に当たったかどうかをチェックするスキーマです。 

    リクエスト スキーマ

    {
       "$schema": "http://json-schema.org/draft-04/schema#",
       "title": "Code Request Schema",
       "description": "Schema to send a code for evaluation",
       "type": "object",
       "properties": {
          "Code": {
             "type": "string",
             "description": "Your entry code"
          }
       },
       "additionalProperties": true
    }
    

    レスポンス スキーマ

    {
       "$schema": "http://json-schema.org/draft-04/schema#",
       "title": "Code Status Response Schema",
       "description": "The schema for the results of the code evaluation",
       "type": "object",
       "properties": {
          "status": {
             "type": "string",
             "description": "The status of your code"
          },
          "prize": {
             "type": "string",
             "description": "The prize won, if any"
             }
          },
         "additionalProperties": true
    }
    

    デフォルトのリクエスト・レスポンス スキーマを変更したら、スキーマが正しくフラット化されるかどうかをチェックします。[メタデータのフラット化] の横にあるプレビュー ボタン (アイ アイコン) をクリックします。 

    Preview flattened metadata icon

  5. Add configuration properties (custom connector action only).
    1. [アクションの詳細] ページで [設定] タブをクリックします。
    2. Add a value for Endpoint.

      このエンドポイントの値はスキーマで使用する Web サイトのためのものです。

      • http:// または https:// で開始する絶対 URL を追加すると、コネクターではこの完全な URL がエンドポイントとして使用されます。
      • 相対パスを追加すると、コネクターではコネクター設定の EndpointAddress に Endpoint が追加されます。

      例えば、アクションの Endpoint に「/custom」と入力し、コネクター設定の EndpointAddress に「https://www.acme.com/」と入力すると、コネクターでは https://www.acme.com/custom がエンドポイントとして使用されます。

    3. 保存をクリックします。
  6. Publish the bridge action.

    To use the action in Architect, click Publish at the bottom of the Action Details page.

    Note: Once you click Publish, you can no longer modify the bridge action. Instead, you must delete the bridge action and add a bridge action by following the steps in this article. If you use the deleted bridge action in a call flow, you must update the call flow in Architect to use the new bridge action. For more information, see Use bridge actions.

    Click image to enlarge.

    Action Details page for the web services data dip connector

The bridge action is now associated with your connector and ready for use in Architect.

Next, use the bridge action in Architect.

For more information about the connector, see About the web services data dip connector.