Erstellen Sie eine Konfigurationsvorlage

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 6 Minuten Lesedauer

    • 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 Werte festzulegen, die für jede Integration gelten. Legen Sie dynamische Schlüssel-Wert-Paare fest, um Anwendereingaben zu erfassen und Feldwerte festzulegen, die variieren können. Mit dieser Vorlage können Administratoren und Flow-Designer die Spoke über ein einzelnes Formular einrichten.

    Vorbereitungen

    Erforderliche Rolle: Administrator

    Prozedur

    1. Navigieren zu Alle > IntegrationHub > Verbindungen und Anmeldeinformationen > Konfigurationsvorlagenan.
    2. Wählen Sie Neu.
    3. Wählen Sie den Typ der Konfigurationsvorlage aus, die Sie erstellen möchten.
      KonfigurationstypBeschreibung
      HTTP-Verbindung mit Gewährungstyp „OAuth-Autorisierungscode“ Erstellt eine Vorlage zum Registrieren des Drittparteisystems als OAuth-Anbieter mithilfe eines Autorisierungscodes.
      HTTP-Verbindung mit Gewährungstyp „OAuth JWT Bearer“ Erstellt eine Vorlage zum Registrieren des Drittparteisystems als OAuth-Anbieter mithilfe eines JSON-Webtoken.
      HTTP-OAuth mit Gewährungstyp „Client-Anmeldeinformationen“

      Erstellt eine Vorlage zur Integration mit einer Drittanbieteranwendung über die OAuth 2,0-Authentifizierung, die den Gewährungstyp „Client-Anmeldeinformationen“ verwendet.
      HTTP-Verbindung mit Gewährungstyp für OAuth-Client-Anmeldeinformationen (externer Speicher)

      Erstellt eine Vorlage, die das Senden einer OAuth-Tokenanforderung ermöglicht, die Client-Anmeldeinformationen enthält, die von einem externen Speicher an einen OAuth-Server über den MID-Server gespeichert werden.
      HTTP-Verbindung mit Anmeldeinformationsformular für Standardauthentifizierung Erstellt eine Vorlage zur Integration mit dem Drittparteisystem mithilfe der Standardauthentifizierung.
      HTTP-Verbindung mit Anmeldeinformationen für API-Schlüssel Erstellt eine Vorlage zur Integration mit dem Drittparteisystem mithilfe eines API-Schlüssels.
      Andere Konfiguration Erstellt eine leere Vorlage, mit der Sie eine Vorlage für die anwenderdefinierte Authentifizierung einrichten können.
    4. In Name Feld einen Namen hinzufügen, um die Vorlage zu identifizieren.
    5. In Standarddatenvorlage Nehmen Sie alle 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.
      • Verbindung : Erstellt einen Verbindungsdatensatz mit den erforderlichen Feldern. Greifen Sie mit auf Verbindungsattribute zu Extended_attributes Untergeordnetes Objekt. Zum Beispiel: 
        "connection": {
            "extended_attributes": {
                "api_version": "v1"
             
             },
        "connection_url": "https://<provider-domain-name>.com",
        "name": "Spoke Connection",
        "table": "http_connection"
    }

      Sie können verwenden Zusätzlich Objekt zum Einrichten von Daten für eine anwenderdefinierte Tabelle und Verwenden des Nachverarbeitungsskripts, um die Daten in die Tabelle einzufügen.

      Hinweis:
      In der Standarddatenvorlage für den Gewährungstyp „OAuth-Autorisierungscode“ die Werte für oauth_Entity_Profile_scope Und oauth_Entity_scope Schlüssel müssen übereinstimmen. Im folgenden Beispiel haben beide Schlüssel die E-Mail-Adresse des Anwenders lesen Wert. 
      "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"
        }
      ],
    6. In Dynamisches Datenschema Nehmen Sie alle 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 Anwendereingaben dem Feld Verbindungs-URL im Verbindungsdatensatz zuzuordnen, geben Sie ein Connection.connection_url .
      • Bezeichnung : Die Feldbezeichnung, die dem Anwender beim Abschließen 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. Der Standardwert des Felds. Wenn kein Standard angegeben ist, wird der Tipp angezeigt.
      • Tipp : Optional. Hinweistext, der angezeigt werden soll, wenn kein Standardwert vorhanden ist.
      Hinweis:
      Wenn Sie eine Vorlage für die Authentifizierung des OAuth-JWT-Bearer-Gewährungstyps einrichten, möchten Sie möglicherweise eine Anwendereingabe für ein einzelnes Schlüssel-Wert-Paar in eingeben jwt_claim_validation Array. Sie können auf ein einzelnes Schlüssel-Wert-Paar im dynamischen Datenschema verweisen, indem Sie auf seinen Index im Array verweisen. Beispielsweise kann Ihre Standarddatenvorlage 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"
      } ],

      Weitere Informationen finden Sie unter iss Schlüssel-Wert-Paar mit dem Null-basierten Index des Elements: Credential.jwt_Provider.jwt_claim_validation[0].value .

    7. Wahlweise: In Nachverarbeitungsskript Ein Skript hinzufügen, das c 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.
      Das Nachverarbeitungsskript hat Zugriff auf diese globalen Objekte.
      Globales Objekt Beschreibung
      aliasId SYS_ID des Alias-Datensatzes aus der Tabelle „Alias für Verbindungen und Anmeldeinformationen“ [sys_alias].
      connectionSysId SYS_ID des Verbindungsdatensatzes, der von der Vorlage erstellt wurde.
      JsonDefaultData JSON-Inhalt aus dem Standarddatenvorlage Feld im Zeichenfolgenformat.
      JsonDynamicData JSON-Inhalt aus dem Dynamische Datenvorlage Feld im Zeichenfolgenformat.
    8. In Skript Vorbearbeiten Ein Skript hinzufügen, 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 die Verbindung beispielsweise Felder erfordert, die sich in einer anwenderdefinierten Tabelle befinden, können Sie diese Felder der anwenderdefinierten Tabelle zuordnen.

      Die Skript Vorbearbeiten Hat Zugriff auf die folgenden globalen Objekte:
      Globales Objekt Beschreibung
      aliasId SYS_ID des Alias-Datensatzes aus der Tabelle „Alias für Verbindungen und Anmeldeinformationen“ [sys_alias].
      connectionSysId SYS_ID des Verbindungsdatensatzes, der von der Vorlage erstellt wurde.
      JsonDefaultData JSON-Inhalt aus dem Standarddatenvorlage Feld im Zeichenfolgenformat.
      JsonDynamicData JSON-Inhalt aus dem Dynamische Datenvorlage Feld im Zeichenfolgenformat.
      Jedes Objekt im Skript verfügt über die folgenden Eigenschaften:
      • Name : Name des anwenderdefinierten Felds zur Angabe des Werts in der Verbindung.
      • 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 hartes Codieren 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. Auswahl gibt den Wert „wahr“ an, und wenn die Auswahl aufgehoben wird, wird der Wert „falsch“ angezeigt
      Anzahl 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 in definiert sind Dynamisches Datenschema Feld.
      Referenz Gültiger GlideRecord.
      Auswahlgruppe Gruppen, die einen anderen Satz von Feldern enthalten. Diese Gruppen sind als Auswahl in einer Dropdown-Liste verfügbar, wenn Sie eine Verbindung bearbeiten. Die Felder in jeder Gruppe werden angezeigt, wenn Sie die erforderliche Gruppe aus der Dropdown-Liste auswählen.
      Betrachten Sie beispielsweise die folgende Struktur der Optionsgruppe, die in definiert ist Dynamisches Datenschema Feld:
                   {
		"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 Codeausschnitt verwenden, um zu verstehen, wie Optionsgruppen im Skript verwendet werden, indem Sie Dot-Walking verwenden:

                  {
            	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 Zur Diagnose des Problems.
    9. Wahlweise: In Testaktion Geben Sie den Namen der Testaktion ein.
      Durch das Erstellen einer Testaktion können Sie eine Verbindung direkt aus einer Integrationsaktion in der Flow-Ansicht von testen Workflow-Studio. Die Testaktion verwendet eine Aktionsdefinition, um den Alias zu testen, an den die Vorlage derzeit angehängt ist. Details finden Sie unter Create a test action to test a connection alias from a configuration template.
    10. Fügen Sie die Vorlage einem Alias für Verbindungen und Anmeldeinformationen hinzu.
      1. Navigieren zu IntegrationHub > Verbindungen und Anmeldeinformationen > Aliasse für Verbindungen und Anmeldeinformationenan.
      2. Öffnen Sie den Aliasdatensatz für die Spoke.
      3. In Konfigurationsvorlage Klicken Sie auf das Suchsymbol.
      4. Wählen Sie die von Ihnen erstellte Vorlage aus der Liste aus.
      5. Klicken Sie auf Aktualisieren.

    Ergebnisse

    Wenn der Anwender zum zugehörigen Alias für Verbindungen und Anmeldeinformationen navigiert und auswählt Neue Verbindung Und Anmeldeinformationen Erstellen , Wird ein Dialogfeld angezeigt, um die Eingabe zu erfassen. Wenn Sie eine Vorlage für den Gewährungstyp „OAuth-Autorisierungscode“ erstellt haben, können Sie auch ein OAuth-Token aus diesem Dialogfeld abrufen.

    Nächste Maßnahme

    Testen Sie die Vorlage, indem Sie zum zugehörigen Alias für Verbindungen und Anmeldeinformationen navigieren und auswählen Neue Verbindung Und Anmeldeinformationen Erstellen . Überprüfen Sie, ob das Dialogfeld die erwarteten Daten erfasst und die erforderlichen Datensätze im System erstellt.