構成テンプレートの作成
スポークの設定に必要な入力を定義するテンプレートを作成します。静的なキーと値のペアを設定してレコードを作成し、すべてのデータ連携に適用される値を設定します。動的なキーと値のペアを設定してユーザー入力を収集し、さまざまなフィールド値を設定します。このテンプレートを使用すると、アドミンおよびフロー設計者は単一のフォームからスポークを設定できます。
始める前に
手順
- 移動先 すべて > 統合ハブ > 接続 & 認証情報 > 構成テンプレート.
- [New (新規)] を選択します。
-
作成する構成テンプレートのタイプを選択します。
構成タイプ 説明 OAuth 認証コード権限許可タイプを使用した HTTP 接続 認証コードを使用して、サードパーティシステムを OAuth プロバイダーとして登録するためのテンプレートを作成します。 OAuth JWT ベアラー権限許可タイプを使用した HTTP 接続 JSON Web トークンを使用して、サードパーティシステムを OAuth プロバイダーとして登録するためのテンプレートを作成します。 クライアント認証情報権限許可タイプを使用した HTTP OAuth クライアント認証情報権限許可タイプを使用する OAuth 2.0 認証を介してサードパーティアプリケーションと統合するためのテンプレートを作成します。
OAuth クライアント認証情報権限許可タイプを使用した HTTP 接続 (外部ストレージ) 外部ストレージに保存されているクライアント認証情報で構成される OAuth トークン要求を、MID サーバーを介して OAuth サーバーに送信できるようにするテンプレートを作成します。
基本認証情報を使用した HTTP 接続 ベーシック認証を使用して、サードパーティシステムとデータ連携するためのテンプレートを作成します。 API キー認証情報を使用した HTTP 接続 API キーを使用して、サードパーティシステムとデータ連携するためのテンプレートを作成します。 その他の構成 空のテンプレートを作成し、カスタム認証用のテンプレートを設定できるようにします。 - [名前] フィールドに、テンプレートを識別するための名前を追加します。
-
[デフォルトのデータテンプレート] フィールドで必要な変更を行います。
このフィールドで、すべてのデータ連携に適用される静的情報を設定します。たとえば、値がすべてのデータ連携に適用される場合は、API およびトークンの URL を設定できます。
デフォルトのデータテンプレートにある次のオブジェクトは必須です。
credential：必須フィールドを持つ認証情報レコードを作成します。connection：必須フィールドを持つ接続レコードを作成します。extended_attributes子オブジェクトを使用して接続属性にアクセスします。たとえば、"connection": { "extended_attributes": { "api_version": "v1" }, "connection_url": "https://<provider-domain-name>.com", "name": "Spoke Connection", "table": "http_connection" }
additionalオブジェクトを使用してカスタムテーブルのデータを設定し、後処理スクリプトを使用してデータをテーブルに挿入できます。注:OAuth 認証コード権限許可タイプのデフォルトのデータテンプレートでは、oauth_entity_profile_scopeキーとoauth_entity_scopeキーの値が一致する必要があります。次の例では、両方のキーが[Read user's email]値を持ちます。"oauth_entity_profile": [ { "grant_type": "authorization_code", "name": "<provider-name> Profile", "default": true, "oauth_entity_profile_scope": [ "Read user's email" ] } ], "code_challenge_method": "S256", "type": "consumer", "oauth_entity_scope": [ { "oauth_entity_scope": "Read user's email", "name": "email" } ], -
[動的なデータスキーマ] フィールドで必要な変更を行います。
このフィールドは、統合を設定するためにユーザーが完了する必要のある情報を定義します。たとえば、ユーザー名とパスワードのキーと値のペアを追加して、ユーザー定義の値を収集することができます。。
動的なデータスキーマのフィールドには、次のプロパティが含まれます。
name：ユーザーの入力がマッピングされるフィールドです。たとえば、ユーザー入力を接続レコードの [接続 URL] フィールドにマッピングするには、「connection.connection_url」と入力します。label：テンプレートの完成時にユーザーに表示されるフィールドラベルです。type：フィールドタイプです。このデータタイプが、値をマッピングするフィールドのデータタイプと一致することを確認してください。defaultValue：オプションです。このフィールドのデフォルト値です。デフォルトが指定されていない場合は、ヒントが表示されます。hint：オプションです。デフォルト値がない場合に表示されるヒントテキストです。
注:OAuth JWT ベアラー権限許可タイプ認証用のテンプレートを設定する場合は、jwt_claim_validationアレイ内の単一のキーと値のペアに対するユーザー入力が必要になる場合があります。アレイ内のインデックスを参照することで、動的なデータスキーマ内の単一のキーと値のペアを参照できます。たとえば、デフォルトのデータテンプレートにはこのスニペットが含まれている場合があります。"jwt_claim_validation" : [ { "name" : "iss", "is_standard" : true, "data_type" : "string", "value":"<docusign-iss-claim>" }, { "name" : "sub", "is_standard" : true, "data_type" : "string", "value":"<docusign-sub-claim>" }, { "name" : "aud", "is_standard" : true, "data_type" : "string", "value":"<docusign-aud-claim>" }, { "name" : "scope", "is_standard" : false, "data_type" : "string", "value" : "signature impersonation" } ],アイテムのゼロベースのインデックス (
credential.jwt_provider.jwt_claim_validation[0].value) を使用して、issキーと値のペアを参照します。 - オプション:
[後処理スクリプト] フィールドに、統合によって必要とされる追加のレコードを作成します。たとえば、スポークにカスタムテーブルが含まれている場合は、構成テンプレートのユーザー入力に基づいてそれらのテーブルにレコードを作成できます。このスクリプトは、接続と資格情報レコードが作成された後に実行されます。のスクリプトを追加します
後処理スクリプトは、次のグローバルオブジェクトにアクセスできます。
グローバルオブジェクト 説明 aliasId 接続および資格情報エイリアス [sys_alias] テーブルのエイリアスレコードの sys_id connectionSysId テンプレートによって作成された接続レコードの sys_id jsonDefaultData 文字列形式の [デフォルトのデータテンプレート] フィールドの JSON コンテンツ jsonDynamicData 文字列形式の [動的データテンプレート] フィールドの JSON コンテンツ -
[事前編集スクリプト (Pre-Edit Script)] フィールドで、接続を編集するときの追加のフィールドを事前入力するスクリプトを追加します。
このスクリプトではオブジェクトのアレイが返されます。オブジェクトごとに、追加フィールドを設定するための名前と値のペアがあります。たとえば、接続にカスタムテーブル内のフィールドが必要な場合は、そのフィールドをカスタムテーブルにマッピングできます。
事前編集スクリプトがアクセスできるグローバルオブジェクトは次のとおりです。グローバルオブジェクト 説明 aliasId 接続および資格情報エイリアス [sys_alias] テーブルのエイリアスレコードの sys_id connectionSysId テンプレートによって作成された接続レコードの sys_id jsonDefaultData 文字列形式の [デフォルトのデータテンプレート] フィールドの JSON コンテンツ jsonDynamicData 文字列形式の [動的データテンプレート] フィールドの JSON コンテンツ スクリプト内の各オブジェクトには、次のプロパティがあります。name：接続の値を指定するカスタムフィールドの名前。value：カスタムフィールドに入力するマッピング対象の値。関数または変数を使用するか、またはハードコーディングすることによって、フィールドをマッピングできます。
フィールドに対してサポートされているデータタイプは次のとおりです。
表 : 1. フィールドに対してサポートされるデータタイプ タイプ 説明 テキスト 文字列値。 ブーリアン 選択ボックス。選択されている場合は true、選択されていない場合は false の値を示します。 番号 数値。 日付 yyyy-mm-dd 形式の日付の値。GlideDate オブジェクトを使用することもできます。 選択肢 [動的なデータスキーマ] フィールドで定義されている有効な選択肢のリスト。 参照 有効な GlideRecord。 ラジオ グループ さまざまなフィールドのセットを含むグループ。これらのグループは、接続を編集するときのドロップダウンリストの選択肢として使用できます。ドロップダウンリストから必要なグループを選択すると、各グループのフィールドが表示されます。 たとえば、[動的なデータスキーマ] フィールドで定義された次の構造のラジオグループを考えてみましょう。{ "name": "radio_groups", "label": "Radio Groups", "type": "radio", "groups": [{ "name": "radio_group1", "label": "Radio Group 1", "fields": [{ "name": "radio_field1", "label": "Radio Field 1", "type": "text", "defaultValue": "efgh", "mandatory": true }] }, { "name": "radio_group2", "label": "Radio Group 2", "fields": [{ "name": "radio_field2", "label": "Radio Field 2", "type": "text", "defaultValue": "abcd", "mandatory": true }], "default_group": true }この例では、次のコードスニペットを使用して、ラジオグループがどのようにドット連結を使用してスクリプト内で使用されているかを理解できます。
{ name: "radio_field.first_radio_group.radio_field1", value: "radio field 1" }, { name: "radio_field.second_radio_group.radio_field2", value: "radio field 2" }, { name: “radio_groups”, value: gr.getValue(‘radio_groups’) }ドット連結の使用方法の詳細については、「ドット連結」を参照してください。
ヒント:接続の編集中に事前入力された値がフィールドに表示されない場合は、次に移動します: システム診断 > セッションのデバッグ > デバッグログ 問題を診断します。 - オプション:
[テストアクション] フィールドに、テストアクションの名前を入力します。 テストアクションを作成すると、 ワークフロースタジオ のフロービューで統合アクションから直接接続をテストできます。テストアクションでは、アクション定義を使用して、テンプレートが現在添付されているエイリアスをテストします。詳細については、「Create a test action to test a connection alias from a configuration template」を参照してください。
-
テンプレートを接続および資格情報エイリアスに追加します。
- 移動先 統合ハブ > 接続 & 認証情報 > 接続と認証情報エイリアス.
- スポークのエイリアスレコードを開きます。
- [構成テンプレート] フィールドで、ルックアップアイコンをクリックします。
- 作成したテンプレートをリストから選択します。
- [更新] をクリックします。