Erstellen Sie eine Konfigurationsvorlage

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 6 Minuten Lesedauer

    • Erstellen Sie eine Vorlage, die die zum Einrichten einer Spoke erforderlichen Eingaben definiert. 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 Benutzereingaben zu erfassen und Feldwerte festzulegen, die variieren können. Mit dieser Vorlage können Administratoren und Flow-Designer die Spoke über ein einziges Formular einrichten.

    Vorbereitungen

    Erforderliche Rolle: Aktionsdesigner oder Administrator

    Prozedur

    1. Navigieren zu Alle > IntegrationHub > Verbindungen und Anmeldeinformationen > Konfigurationsvorlagen.
    2. Klicken Sie auf Neu.
    3. Wählen Sie den Typ der Konfigurationsvorlage aus, die Sie erstellen möchten.
      Wenn Sie einen Typ auswählen, erhalten Sie Startdaten, die Sie beim Konfigurieren der Vorlage unterstützen.
      KonfigurationstypBeschreibung
      HTTP-Verbindung mit Gewährungstyp „OAuth-Autorisierungscode“ Erstellt eine Vorlage, um das Drittanbietersystem mithilfe eines Autorisierungscodes als OAuth-Provider zu registrieren.
      HTTP-Verbindung mit Gewährungstyp „OAuth JWT Bearer“ Erstellt eine Vorlage, um das Drittanbietersystem mithilfe eines JSON-Web-Tokens als OAuth-Provider zu registrieren.
      HTTP-Verbindung mit Anmeldeinformationsformular für Standardauthentifizierung Erstellt eine Vorlage zur Integration in das Drittanbietersystem mithilfe der Basic Authentication.
      HTTP-Verbindung mit Anmeldeinformationen für API-Schlüssel Erstellt eine Vorlage, die mithilfe eines API-Schlüssels in das Drittanbietersystem integriert werden soll.
      Andere Konfiguration Erstellt eine leere Vorlage, sodass Sie eine Vorlage für die benutzerdefinierte Authentifizierung einrichten können.
    4. Fügen Sie im Feld Name einen Namen hinzu, um die Vorlage zu identifizieren.
    5. Nehmen Sie im Feld Standarddatenvorlage die erforderlichen Änderungen vor.
      In diesem Feld werden statische Informationen festgelegt, 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:

      • credential: 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ätzliche Objekt verwenden, um Daten für eine benutzerdefinierte Tabelle einzurichten, und das Nachverarbeitungsskript verwenden, um die Daten in die Tabelle einzufügen.

      Hinweis:
      In der Standarddatenvorlage für den Gewährungstyp 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 Wert E-Mail des Benutzers lesen. 
      "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. 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 umfassen die folgenden Eigenschaften:

      • name: Das Feld, dem die Eingabe des Benutzers zugeordnet ist. Geben Sie beispielsweise connection.connection_url ein, um die Benutzereingabe dem Feld Verbindungs-URL im Verbindungsdatensatzzuzuordnen.
      • Bezeichnung: Die Feldbezeichnung, die dem Benutzer 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. Der Standardwert des Felds. Wenn kein Standard angegeben ist, wird der Hinweis angezeigt.
      • Hinweis: Optional. Hinweistext, der angezeigt werden soll, wenn kein Standardwert vorhanden ist.
      Hinweis:
      Wenn Sie eine Vorlage für die Authentifizierung des Gewährungstyps OAuth JWT Bearer einrichten, möchten Sie möglicherweise eine Benutzereingabe 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 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"
      } ],

      Verweisen Sie mit dem nullbasierten Index des Elements auf das iss -Schlüssel-Wert-Paar: credential.jwt_provider.jwt_claim_validation[0].value.

    7. 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.enthält.
      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 von der Vorlage erstellten Verbindungsdatensatzes.
      jsonDefaultData JSON-Inhalt aus dem Feld Standarddatenvorlage im Zeichenfolgenformat.
      jsonDynamicData JSON-Inhalt aus dem Feld „Dynamische Datenvorlage“ im Zeichenfolgenformat.
    8. Fügen Sie im Feld Vorbearbeitungsskript ein Skript hinzu, um die zusätzlichen Felder vorab auszufüllen, wenn Sie eine Verbindung bearbeiten.
      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 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 Alias-Datensatzes 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 benutzerdefinierten Felds zur Angabe des Werts in der Verbindung.
      • value: Wert, den Sie zuordnen möchten, um das benutzerdefinierte Feld auszufüllen. Sie können das Feld entweder mithilfe einer Funktion oder Variablen zuordnen oder es hartcodieren.

      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 gibt den Wert „Wahr“ an, die Aufhebung der Auswahl den Wert „Falsch“.
      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 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 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.
    9. 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 Anmeldeinformationen.
      2. Öffnen Sie den Aliasdatensatz für die Spoke.
      3. Klicken Sie im Feld Konfigurationsvorlage auf das Suchsymbol.
      4. Wählen Sie die von Ihnen erstellte Vorlage aus der Liste aus.
      5. Klicken Sie auf Aktualisieren.

    Ergebnisse

    Wenn der Benutzer zum zugeordneten Alias für Verbindungen und Anmeldeinformationen navigiert und Neue Verbindung und Anmeldeinformationen erstellenauswählt, 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 in diesem Dialogfeld auch ein OAuth-Token abrufen.

    Nächste Maßnahme

    Testen Sie die Vorlage, indem Sie zum zugehörigen Alias für Verbindungen und Anmeldeinformationen navigieren und Neue Verbindung und Anmeldeinformationen erstellenauswählen. Stellen Sie sicher, dass der Dialog die erwarteten Daten erfasst und die erforderlichen Datensätze im System erstellt.