Erstellen Sie eine Konfigurationsvorlage
Erstellen Sie eine Vorlage, die die Eingaben definiert, die zum Einrichten einer Spoke erforderlich sind. Legen Sie statische Schlüssel-Wert-Paare fest, um Datensätze zu erstellen, und legen Sie Werte fest, die für jede Integration gelten. Legen Sie dynamische Schlüssel-Wert-Paare fest, um Benutzereingaben zu sammeln und Feldwerte festzulegen, die variieren können. Mit dieser Vorlage können Administratoren und Flow-Designer die -Spoke über ein einziges Formular einrichten.
Vorbereitungen
Prozedur
- Navigieren zu Alle > IntegrationHub > Verbindungen und Anmeldeinformationen > Konfigurationsvorlagenan.
- Wählen Sie Neu.
-
Wählen Sie den Typ der Konfigurationsvorlage aus, die Sie erstellen möchten.
Konfigurationstyp Beschreibung HTTP-Verbindung mit Gewährungstyp „OAuth-Autorisierungscode“ Erstellt eine Vorlage, um das Drittparteisystem mit einem Autorisierungscode als OAuth-Anbieter zu registrieren. HTTP-Verbindung mit Gewährungstyp „OAuth JWT Bearer“ Erstellt eine Vorlage, um das Drittparteisystem als OAuth-Anbieter mit einem JSON-Web-Token zu registrieren. HTTP-OAuth mit Gewährungstyp „Client-Anmeldeinformationen“. Erstellt eine Vorlage für die Integration mit einer Drittanbieteranwendung über die OAuth 2.0-Authentifizierung, die den Gewährungstyp für Client-Anmeldeinformationen verwendet.
HTTP-Verbindung mit Gewährungstyp für OAuth-Client-Anmeldeinformationen (externer Speicher) Erstellt eine Vorlage, die das Senden einer OAuth-Token-Anforderung, die von einem externen Speicher gespeicherte Client-Anmeldeinformationen enthält, über den MID-Server an einen OAuth-Server ermöglicht.
HTTP-Verbindung mit Anmeldeinformationsformular für Standardauthentifizierung Erstellt eine Vorlage zur Integration in das Drittparteisystem mithilfe der Standardauthentifizierung. HTTP-Verbindung mit Anmeldeinformationen für API-Schlüssel Erstellt eine Vorlage zur Integration in das Drittparteisystem mithilfe eines API-Schlüssels. Andere Konfiguration Erstellt eine leere Vorlage, sodass Sie eine Vorlage für die anwenderdefinierte Authentifizierung einrichten können. - Fügen Sie im Feld Name einen Namen hinzu, um die Vorlage zu identifizieren.
-
Nehmen Sie im Feld Standarddatenvorlage die erforderlichen Änderungen vor.
Dieses Feld legt statische Informationen fest, die für jede Integration gelten. Beispielsweise können Sie die API und die Token-URL festlegen, wenn der Wert für jede Integration gilt.
Diese Objekte in der Standarddatenvorlage sind erforderlich:
Anmeldeinformationen: Erstellt einen Anmeldeinformationsdatensatz mit den erforderlichen Feldern.connection: Erstellt einen Verbindungsdatensatz mit den erforderlichen Feldern. Greifen Sie mit dem untergeordneten Objekt „extended_attributes“ auf Verbindungsattribute zu. Beispiel:"connection": { "extended_attributes": { "api_version": "v1" }, "connection_url": "https://<provider-domain-name>.com", "name": "Spoke Connection", "table": "http_connection" }
Sie können das
zusätzlicheObjekt verwenden, um Daten für eine anwenderdefinierte Tabelle einzurichten, und das Nachverarbeitungsskript verwenden, um die Daten in die Tabelle einzufügen.Hinweis:In der Standarddatenvorlage für den Erteilungstyp „OAuth-Autorisierungscode“ müssen die Werte für die Schlüssel „oauth_entity_profile_scope“und„oauth_entity_scope“übereinstimmen. Im folgenden Beispiel haben beide Schlüssel den WertE-Mail des Benutzers mit Lesezugriff."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" } ], -
Nehmen Sie im Feld Dynamisches Datenschema die erforderlichen Änderungen vor.
Dieses Feld Damit werden Informationen festgelegt, die der Benutzer zum Einrichten der Integration eingeben muss. Beispielsweise können Sie Schlüssel-Wert-Paare aus Benutzername und Passwort hinzufügen, um benutzerdefinierte Werte zu erfassen.
Felder im dynamischen Datenschema enthalten diese Eigenschaften:
Name: Das Feld, dem die Eingabe des Anwenders zugeordnet ist. Um beispielsweise die Benutzereingabe dem Feld Verbindungs-URL im Verbindungsdatensatz zuzuordnen, geben Sieconnection.connection_urlein.Bezeichnung: Die Feldbezeichnung, die dem Anwender beim Ausfüllen der Vorlage angezeigt wird.Typ: Der Feldtyp. Stellen Sie sicher, dass dieser Datentyp mit dem Datentyp des Felds übereinstimmt, dem Sie den Wert zuordnen.defaultValue: Optional. Standardwert des Felds Wenn kein Standard angegeben ist, wird der Hinweis angezeigt.Tipp: Optional. Hinweistext, der angezeigt werden soll, wenn kein Standardwert vorhanden ist.
Hinweis:Wenn Sie eine Vorlage für die OAuth-JWT-Bearer-Gewährungstypauthentifizierung einrichten, möchten Sie möglicherweise eine Anwendereingabe für ein einzelnes Schlüssel-Wert-Paar im Array„jwt_claim_validation“. Sie können auf ein einzelnes Schlüssel-Wert-Paar im dynamischen Datenschema verweisen, indem Sie auf dessen Index im Array verweisen. Ihre Standarddatenvorlage könnte beispielsweise dieses Fragment enthalten."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" } ],Verweisen Sie auf das Schlüssel-Wert-Paar von
iss, indem Sie den nullbasierten Index des Elements verwenden:createtial.jwt_provider.jwt_claim_validation[0].value. - Wahlweise:
Fügen Sie im Feld „Nachverarbeitungsskript“ ein Skript hinzu, das Damit werden zusätzliche Datensätze erstellt, die für die Integration erforderlich sind. Wenn Ihre Spoke beispielsweise benutzerdefinierte Tabellen enthält, können Sie Datensätze in diesen Tabellen auf der Grundlage von Benutzereingaben in der Konfigurationsvorlage erstellen. Dieses Skript wird ausgeführt, nachdem die Verbindungs- und Anmeldeinformationsdatensätze erstellt wurden.lautet.
Das Nachverarbeitungsskript hat Zugriff auf diese globalen Objekte.
Globales Objekt Beschreibung aliasId Sys_id des Aliasdatensatzes aus der Tabelle „Alias für Verbindungen und Anmeldeinformationen“ [sys_alias]. connectionSysId Sys_id des von der Vorlage erstellten Verbindungsdatensatzes. jsonDefaultData JSON-Inhalt aus dem Feld „Standarddatenvorlage“ im Zeichenfolgenformat. jsonDynamicData JSON-Inhalt aus dem Feld „Dynamische Datenvorlage“ im Zeichenfolgenformat. -
Fügen Sie im Feld Vorbearbeitungsskript ein Skript hinzu, um die zusätzlichen Felder beim Bearbeiten einer Verbindung vorab auszufüllen.
Dieses Skript gibt ein Array von Objekten zurück. Jedes Objekt verfügt über ein Name-Wert-Paar zum Ausfüllen der zusätzlichen Felder. Wenn beispielsweise die Verbindung Felder erfordert, die sich in einer benutzerdefinierten Tabelle befinden, können Sie diese Felder der benutzerdefinierten Tabelle zuordnen.
Das Vorbearbeitungsskript hat Zugriff auf die folgenden globalen Objekte:Globales Objekt Beschreibung aliasId Sys_id des Aliasdatensatzes aus der Tabelle „Alias für Verbindungen und Anmeldeinformationen“ [sys_alias]. connectionSysId Sys_id des von der Vorlage erstellten Verbindungsdatensatzes. jsonDefaultData JSON-Inhalt aus dem Feld „Standarddatenvorlage“ im Zeichenfolgenformat. jsonDynamicData JSON-Inhalt aus dem Feld „Dynamische Datenvorlage“ im Zeichenfolgenformat. Jedes Objekt im Skript hat die folgenden Eigenschaften:name: Name des anwenderdefinierten Felds, um den Wert in der Verbindung anzugeben.Wert: Wert, den Sie zuordnen möchten, um das anwenderdefinierte Feld auszufüllen. Sie können das Feld entweder mithilfe einer Funktion, einer Variable oder durch Hartcodieren zuordnen.
Die folgenden Datentypen werden für die -Felder unterstützt:
Tabelle : 1. Unterstützte Datentypen für die -Felder Typ Beschreibung Text Zeichenfolgenwert. Boolean Auswahlfeld. Die Auswahl zeigt den Wert „wahr“ an, und die Abwahl der Auswahl zeigt den Wert „falsch“ an. Nummer Numerischer Wert. Datum Datumswert im Format JJJJ-MM-TT. Sie können auch das GlideDate-Objekt verwenden. Auswahl Liste der gültigen Auswahlmöglichkeiten, die im Feld „Dynamisches Datenschema“ definiertsind. Referenz Gültiger GlideRecord Auswahlgruppe Gruppen, die einen anderen Satz von Feldern enthalten. Diese Gruppen stehen in einer Dropdown-Liste zur Auswahl, wenn Sie eine Verbindung bearbeiten. Die Felder in jeder Gruppe werden angezeigt, wenn Sie die gewünschte Gruppe aus der Dropdown-Liste auswählen. Betrachten Sie beispielsweise die folgende Struktur der Auswahlgruppe, die im Feld Dynamisches Datenschema definiert ist:{ "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 }In diesem Beispiel können Sie das folgende Code-Fragment verwenden, um zu verstehen, wie Auswahlgruppen im Skript mithilfe von Dot-Walking verwendet werden:
{ 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’) }Weitere Informationen zur Verwendung von Dot-Walking finden Sie unter Dot-Walking.
Tipp:Wenn die vorab ausgefüllten Werte beim Bearbeiten einer Verbindung nicht in den Feldern angezeigt werden, navigieren Sie zu Systemdiagnostik > Sitzung debuggen > Protokoll debuggen um das Problem zu diagnostizieren. -
Fügen Sie die Vorlage einem Alias für Verbindungen und Anmeldeinformationen hinzu.
- Navigieren zu IntegrationHub > Verbindungen und Anmeldeinformationen > Aliasse für Verbindungen und Anmeldeinformationenan.
- Öffnen Sie den Aliasdatensatz für die Spoke.
- Klicken Sie im Feld Konfigurationsvorlage auf das Suchsymbol.
- Wählen Sie die von Ihnen erstellte Vorlage aus der Liste aus.
- Klicken Sie auf Aktualisieren.