Verwalten von Verbindungen

Der Inhalt dieser Seite bezieht sich auf ein Produkt oder eine Funktion in kontrollierter Freigabe (CR). Wenn Sie nicht Teil der CR-Gruppe sind und weitere Informationen wünschen, wenden Sie sich an Ihren CXone Account Representative.

Mithilfe von Integration Hub-Verbindungen können Sie Integrationen mit Webdiensten von Drittanbietern einrichten, die dann in CXone verwendet werden können.

Erstellen einer Verbindungsvorlage

Eine Verbindungsvorlage definiert die grundlegenden Informationen über eine Integration. Vorlagen werden zum Erstellen von Verbindungen verwendet. Dabei können Sie bestimmte Anforderungen und andere Informationen konfigurieren.

Verbindungsvorlagen können nach der Erstellung nicht mehr geändert werden. Wenn Sie bestimmte Details ändern müssen, einschließlich der Kopfzeilen, müssen Sie eine neue Vorlage erstellen.

Screenshot der Seite "Vorlage hinzufügen" in Integration Hub.
  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.
  2. Klicken Sie auf Vorlage hinzufügen.
  3. Geben Sie auf der Registerkarte "Details" einen Namen für die Vorlage ein.
  4. Geben Sie den Namen der Anwendung ein, mit der Sie eine Verbindung herstellen. Dabei kann es sich um eine Anwendung, eine Plattform oder einen Webdienst handeln.
  5. Wählen Sie REST als Integrationsmethode aus. Derzeit ist REST die einzige unterstützte Methode.

  6. Wählen Sie einen Authentifizierungstyp aus.

    Optionen Details
    OAuth 2.0 Wählen Sie diese Option aus, wenn die Vorlage die OAuth 2.0-Authentifizierung enthalten soll. Derzeit ist dies der einzige unterstützte Authentifizierungstyp.
    Keine Authentifizierung Wählen Sie diese Option aus, wenn die Vorlage keine Authentifizierung enthalten soll.
  7. Geben Sie eine Beschreibung für die Vorlage ein. Andere Benutzer können die Beschreibung sehen, wenn sie diese Vorlage in der Verbindungsbibliothek auswählen.
  8. Fügen Sie ein Symbol an, indem Sie ein Bild ziehen und ablegen oder indem Sie auf Dateien durchsuchen klicken. Dieses Symbol wird für diese Vorlage in der Verbindungsbibliothek für alle Verbindungen angezeigt, die auf Basis dieser Vorlage erstellt werden.
  9. Wählen Sie auf der Registerkarte "Konfiguration" die Methoden (Verben) aus, die für diese Vorlage verfügbar sein sollen. Nicht alle Webdienste unterstützen alle REST-Verben.
  10. Wenn Sie benutzerdefinierte Authentifizierungs-Header für diese Vorlage definieren möchten, klicken Sie auf Eigenen Header hinzufügen. Diese Option ist nur verfügbar, wenn Sie die Authentifizierung für die Vorlage aktiviert haben. So definieren Sie einen Header: 
    1. Geben Sie den Header-Namen in das angezeigte Feld ein.
    2. Klicken Sie auf Eigenen Header hinzufügen, um weitere benutzerdefinierte Header hinzuzufügen.
    3. Wählen Sie die Option Erforderlich? für die Header aus, die in Verbindungen verwendet werden müssen, die auf Basis dieser Vorlage erstellt werden.
    4. Klicken Sie auf das X, um einen Header zu löschen.
  11. Überprüfen Sie alle Einstellungen. Nachdem Sie eine Vorlage gespeichert haben, können Sie sie nicht mehr bearbeiten.
  12. Führen Sie einen der folgenden Schritte aus:
    • Klicken Sie auf Speichern, um die Vorlage zur Verbindungsbibliothek hinzuzufügen.
    • Klicken Sie auf Speichern + Meine Verbindungen, um die Vorlage zur Verbindungsbibliothek hinzuzufügen und eine Verbindung auf Basis der Vorlage zu erstellen. Nach der Erstellung der Verbindung können Sie sie konfigurieren, indem Sie Authentifizierungsdetails, Variablen oder Anforderungen hinzufügen. Ihre Anforderung kann einige oder alle dieser Konfigurationen enthalten.

Erstellen einer Verbindung auf Basis einer Vorlage

Mithilfe von Verbindungen können Sie Anforderungen erstellen und Authentifizierungsdetails hinzufügen. Verbindungen werden in Integration Hub unter "Meine Verbindungen" angezeigt.

Sie können Verbindungen auf Basis von Verbindungsvorlagen erstellen. Die Verbindungsbibliothek zeigt alle Verbindungsvorlagen in Ihrem CXone System. Wenn keine passende Vorlage für Ihre Anforderungen vorhanden ist, können Sie eine Vorlage erstellen.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Suchen einer Vorlage in der Verbindungsbibliothek Die Bibliothek befindet sich rechts auf der Seite. Wenn Sie eine Verbindung oder eine Vorlage anzeigen, klicken Sie oben rechts auf der Seite auf das X. Dadurch wird die aktuelle Anzeige geschlossen, sodass die Verbindungsbibliothek sichtbar wird.

  3. Klicken Sie auf der Seite mit den Vorlageneigenschaften auf Meine Verbindung, um eine Verbindung auf Basis der Vorlage zu erstellen.

  4. Wenn Sie ein selbstsigniertes mTLS-Zertifikat verwenden, füllen Sie die folgenden Felder aus:

    • Clientzertifikat
    • Privater Clientschlüssel
    • Schlüssel-Passphrase

    Diese Felder werden nur angezeigt, wenn Sie OAuth 2.0 als Authentifizierungstyp verwenden. Geben Sie das Clientzertifikat und den privaten Clientschlüssel zusammen ein. Wenn der private Clientschlüssel verschlüsselt ist, müssen Sie eine Schlüssel-Passphrase eingeben. mTLS-Zertifikate können nur verwendet werden, wenn die URL für die Authentifizierung das HTTPS-Format hat. Diese Felder werden nach dem Speichern der Verbindung überprüft Sie können diese Felder auf der Registerkarte Geheimnisse referenzieren.

  5. Geben Sie einen Namen für die Verbindung ein und klicken Sie auf Speichern.

  6. Klicken Sie in der Liste links auf der Seite auf die neue Verbindung.

  7. Konfigurieren Sie auf der Registerkarte "Konfiguration" eine Zeitüberschreitung in Millisekunden. Die Zeitüberschreitung gilt für alle Anforderungen, die in der Verbindung konfiguriert sind, einschließlich der Authentifizierung.

  8. Konfigurieren Sie die Authentifizierung und die Anforderungen nach Bedarf. Ihre Verbindung kann eine oder beide dieser Komponenten enthalten.

  9. Konfigurieren Sie Variablen, wenn bestimmte Informationen in der Verbindung verschlüsselt sein sollen.

Konfigurieren von Authentifizierungsdetails

Sie können Authentifizierungsdetails auf der Registerkarte "Authentifizierung" Ihrer Verbindung konfigurieren. Diese Registerkarte wird nur angezeigt, wenn die Authentifizierung in der Vorlage dieser Verbindung aktiviert ist.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Klicken Sie im linken Seitenbereich unter "Meine Verbindungen" auf die Verbindung, mit der Sie arbeiten möchten.

  3. Geben Sie auf der Registerkarte "Authentifizierung" die URL ein, die für die Authentifizierungsanforderung verwendet wird. Die URL darf nicht dynamisch sein, aber Sie können darin auf Geheimnisse verweisen.

  4. Wählen Sie die REST-Methode (Verb) für die Authentifizierungsanforderung aus. Die verfügbaren Verben werden von der Vorlage definiert, die für diese Verbindung verwendet wird.

  5. Geben Sie unter "Kopfzeilen" die entsprechenden Werte in jedes Feld ein. Mit einem Sternchen (*) markierte Felder sind erforderlich. Diese Felder sind in der Vorlage definiert, die für diese Verbindung verwendet wird.

  6. So fügen Sie dieser Verbindung einen benutzerdefinierten Header hinzu:

    1. Klicken Sie auf Eigenen Header hinzufügen.

    2. Geben Sie einen Header-Namen und einen Header-Wert ein.

  7. So fügen Sie der Authentifizierungsanforderung einen Abfrageparameter hinzu:
    1. Klicken Sie auf Abfrageparameter hinzufügen.
    2. Geben Sie für jeden hinzugefügten Abfrageparameter einen Namen und einen Wert ein.

  8. Wählen Sie einen Medientyp aus und geben Sie den Inhalt für den Haupttext ein. Der Medientyp wirkt sich auf das Format des Inhalts im Haupttext aus. Dies sollte mit dem Typ übereinstimmen, der von dem von Ihnen verwendeten Autorisierungsserver gefordert wird.

    Optionen Details

    ApplicationJson

    Der Haupttext muss das JSON-Format haben.
    ApplicationJsonPatch Der Haupttext muss das JSON Patch-Format haben.
    FormURLEncoded

    Der Haupttext muss aus Schlüssel-Wert-Paaren bestehen. Diese Medienart sendet Anfragen mithilfe gängiger URL-Notationen.

    Klicken Sie auf +Formularparameter hinzufügen und geben Sie dann den Namen des Formularparameters und den Wert des Formularparameters ein.
    TextHtml Der Haupttext muss das HTML-Format haben.
    TextPlain Der Haupttext muss das Nur-Text-Format haben.
    TextXml Der Haupttext muss das XML-Format haben.

  9. Klicken Sie auf Speichern.

Variablen zu einer Verbindung hinzufügen

Integration Hub-Variablen ermöglichen es Ihnen, bestimmte Informationen in einer Verbindung zu teilen. Sie können bestimmen, ob diese Informationen verschlüsselt werden oder nicht. Eine verschlüsselte Variable oder ein Geheimnis bietet zusätzlichen Schutz, wenn vertrauliche Informationen wie Kennwörter in Studio-Skripten verwendet werden.

Wenn Sie eine Variable erstellen, können Sie sie jederzeit in ein Geheimnis umwandeln. Sobald eine Variable in ein Geheimnis umgewandelt und der Konnektor gespeichert wurde, können Sie das Geheimnis nicht mehr in eine Variable umwandeln.

Geheimnisse können nicht rückgängig gemacht werden. Wenn Sie auf eine Stelle außerhalb des Feldes Geheimniswert klicken, wird der Inhalt verschlüsselt und mit Sternchen (*) maskiert. Nach der Maskierung kann der in das Feld eingegebene Wert nicht mehr abgerufen werden.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Klicken Sie im linken Seitenbereich unter "Meine Verbindungen" auf die Verbindung, mit der Sie arbeiten möchten.

  3. Klicken Sie auf der Registerkarte "Variablen" auf + Variable hinzufügen.

  4. Geben Sie einen Variablennamen ein, der den Inhalt der Variablen identifiziert. Namen können Leerzeichen oder Sonderzeichen enthalten.

  5. Geben Sie den Variablenwert ein. Dies ist der Wert der Variablen und die Informationen, die verschlüsselt werden, wenn Sie die Variable in ein Geheimnis umwandeln. Überprüfen Sie vor der Umwandlung in ein Geheimnis, ob die Informationen korrekt sind.

  6. Um die Variable zu verschlüsseln, aktivieren Sie den Schalter Geheimnis.

  7. Um eine Variable von der Verbindung zu entfernen, klicken Sie auf das X rechts davon

  8. Klicken Sie auf Speichern.

Variablen in einer Verbindung verwenden

Variablen können in manuellen oder Studio-Skriptanforderungen verwendet werden. Sie können in Kopfzeilen (Headern), Abfrageparametern und im Haupttext verwendet werden.

Variable in den Authentifizierungsdetails oder in einer manuellen Anforderung verwenden

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Klicken Sie im linken Seitenbereich unter "Meine Verbindungen" auf die Verbindung, mit der Sie arbeiten möchten.

  3. Klicken Sie auf die Registerkarte, in der Sie eine Variable verwenden möchten. Variablen können auf den Registerkarten Authentifizierung und Anforderungen verwendet werden.

  4. Geben Sie die Variable dort ein, wo sich der Variablenwert befinden soll. Beachten Sie dabei diese Richtlinien:

    • Schließen Sie den Namen in doppelte eckige Klammern ein. Beispiel: [[ variableName ]].
    • Geben Sie den Namen genau so ein wie im Feld Variablenname auf der Registerkarte "Variablen".
    • Variablen können nur mit der Verbindung verwendet werden, in der sie erstellt wurden.

Variable in einer Studio-Anforderung verwenden

Damit Sie Variablen in einem Studio-Skript verwenden können, muss das Skript eine CONNECTAuth- oder CONNECTREQUEST-Aktion enthalten. Die Aktion muss das Skript mit der Verbindung verknüpfen, die die Variable enthält.

  1. Öffnen Sie in Studio das Skript, in dem Sie die Variable verwenden möchten.

  2. Doppelklicken Sie auf die Snippet-Aktion, der Sie die Variable hinzufügen möchten.

  3. Fügen Sie im Snippet-Editor-Fenster die Variable an der Stelle hinzu, an der der Variablenwert verwendet werden soll. Beachten Sie dabei die folgenden Richtlinien:

    • Schließen Sie den Namen in doppelte eckige Klammern ein. Beispiel: [[ variableName ]].
    • Geben Sie den Namen genau so ein wie im Feld Variablenname auf der Registerkarte "Variablen".
    • Schließen Sie die eckigen Klammern und den Variablennamen in doppelte Anführungszeichen ein ("). Beispiel "[[ variableName ]]". Wenn die Variable zu einem String gehört, wie beispielsweise zu einer URL, muss nicht nur die Variable, sondern der gesamte String in die doppelten Anführungszeichen eingeschlossen werden. Beispiel: "[[ variableName ]]/location/anotherlocation/".
    • Variablen können nur mit der Verbindung verwendet werden, in der sie erstellt wurden. Die Verbindung muss im Skript mit einer CONNECTAuth- oder CONNECTREQUEST-Aktion angegeben werden.

    Beispiele:

    • ASSIGN requestPayload.body = "[[client_id]]"

    • ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS"

Erstellen einer manuellen Anforderung

Mithilfe von Anforderungen rufen Sie die erforderlichen Informationen von dem Webdienst ab, mit dem Ihre Integration verbunden ist. Sie können manuelle Anforderungen in Studio-Skripten verwenden oder sie über Integration Hub ausführen.

Wenn Ihre Anforderung Pfadparameter oder die Variablenersetzung in der URL, in Headern oder Parametern erfordert, müssen Sie eine Studio-Anforderung erstellen. In manuellen Anforderungen werden diese Optionen nicht unterstützt.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Klicken Sie im linken Seitenbereich unter "Meine Verbindungen" auf die Verbindung, mit der Sie arbeiten möchten.

  3. Klicken Sie auf der Registerkarte "Anträge" auf Anforderung hinzufügen.

  4. Geben Sie einen Anforderungsnamen ein.

  5. Wählen Sie Manuell als Auslöser aus.

  6. Geben Sie die URL für diese Anforderung ein.

  7. Klicken Sie auf die Methode (das Verb) für diese Anforderung.

  8. Fügen Sie unter "Kopfzeilen" die erforderlichen Kopfzeilen (Header) für Ihre Anforderung hinzu:

    1. Klicken Sie auf Header hinzufügen.

    2. Geben Sie einen Header-Namen und einen Header-Wert ein.

  9. Fügen Sie unter "Abfrageparameter" die erforderlichen Abfrageparameter für Ihre Anforderung hinzu: 
    1. Klicken Sie auf Abfrageparameter hinzufügen.
    2. Geben Sie einen Namen und einen Wert für den Abfrageparameter ein.

  10. Wählen Sie einen Medientyp aus und geben Sie den Inhalt für den Haupttext ein. Der Medientyp wirkt sich auf das Format des Inhalts im Haupttext aus. Dies sollte mit dem Typ übereinstimmen, der von dem Webdienst gefordert wird, mit dem Sie sich verbinden.

    Optionen Details

    ApplicationJson

    Der Haupttext muss im JSON-Format vorliegen und application/json als Inhaltskopfzeile enthalten.
    ApplicationJsonPatch Der Haupttext muss im JSON Patch-Format vorliegen und application/json-patch+json als Inhaltskopfzeile enthalten.
    FormURLEncoded

    Der Haupttext muss als Schlüssel/Wert-Paar vorliegen und application/x-www-form-urlencoded als Inhaltskopfzeile enthalten. Diese Medienart sendet Anfragen mithilfe gängiger URL-Notationen.

    Klicken Sie auf +Formularparameter hinzufügen und geben Sie dann den Namen des Formularparameters und den Wert des Formularparameters ein.
    TextHtml Der Haupttext muss im HTML-Format vorliegen und text/html als Inhaltskopfzeile enthalten.
    TextPlain Der Haupttext muss im reinen Textformat vorliegen und text/html als Inhaltskopfzeile enthalten.
    TextXml Der Haupttext muss im XML-Format vorliegen und text/xml als Inhaltskopfzeile enthalten.
  11. Wenn Sie den aktiven Status dieser Anforderung ändern möchten, klicken Sie oben auf der Seite auf Aktiv. Der Text ändert sich in Inaktiv.
  12. Klicken Sie auf Bestätigen.
  13. Klicken Sie auf der Registerkarte "Anträge" neben der gerade hinzugefügten Anforderung auf Test. Integration Hub versucht, die Anforderung auszuführen. Ein Fenster mit den Testergebnissen wird eingeblendet.
  14. Klicken Sie auf Bearbeiten und nehmen Sie Änderungen an der Anforderung vor oder klicken Sie auf Speichern.

Erstellen einer Studio-Anforderung

Eine  Studio-Anforderung ist hilfreich, wenn Sie API-Anforderungen haben, die nicht in Integration Hub erstellt werden können, aber wenn Sie Integration Hub für die Authentifizierung und für Geheimnisse verwenden möchten.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Klicken Sie im linken Seitenbereich unter "Meine Verbindungen" auf die Verbindung, mit der Sie arbeiten möchten.

  3. Klicken Sie auf der Registerkarte "Anträge" auf Anforderung hinzufügen.

  4. Geben Sie einen Anforderungsnamen ein.

  5. Wählen Sie Studio als Auslöser aus.

  6. Wenn Sie das Beispiel zum Erstellen von JSON in Ihrem Skript verwenden möchten, wählen Sie die Payload der Beispielanforderung auf der Seite "Anforderung hinzufügen" aus und kopieren Sie sie.

  7. Klicken Sie auf Bestätigen.

    Studio-Anforderungen können nicht in Integration Hub getestet werden. Sie müssen sie in Studio testen, indem Sie das Skript mit einem Trace ausführen.

  8. Klicken Sie auf Speichern.
  9. Starten Sie Studio und melden Sie sich an.
  10. Öffnen Sie ein vorhandenes Skript oder erstellen Sie ein neues.
  11. Fügen Sie Ihrem Skript eine Snippet-Aktion hinzu und doppelklicken Sie darauf, um das Snippet-Editor-Fenster zu öffnen.

  12. Erstellen Sie ein dynamisches Objekt im Snippet-Editor-Fenster und konvertieren Sie es in JSON. Das erstellte Objekt muss Mitglieder für die Header (Kopfzeilen), Abfrageparameter und den Hauptinhalt der Anforderung enthalten.

    Verwenden Sie die Beispiel-Payload, die Sie bereits aus Integration Hub kopiert haben, als Anleitung zum Erstellen des Objekts. Die Beispiel-Payload ist:

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456",
	"ACCOUNTNAME": "TESTACCOUNT"
	}
}

    Ein dynamisches Objekt, das mithilfe der Beispiel-Payload erstellt wurde, ist:

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS"
ASSIGN requestPayload.HTTPMETHOD = "POST"
ASSIGN requestPayload.HEADERS.CONTENTHYPHENPLACEHOLDERTYPE = "APPLICATION/JSON"
ASSIGN requestPayload.HEADERS.AUTHORIZATION = "BEARER[[BEARERTOKEN]]"
ASSIGN requestPayload.QUERYPARAMETERS.ANI = "[[ANI]]"
ASSIGN requestPayload.QUERYPARAMETERS.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "TESTACCOUNT"
ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"
ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    In der letzten Zeile des vorherigen Beispiels wird die replace()-Funktion verwendet, um den Bindestrich (-) in den CONTENT-TYPE-Schlüsselnamen einzufügen. Da Variablennamen in Studio keine Sonderzeichen wie Bindestriche enthalten können, wird diese Lösung verwendet.

  13. Konfigurieren Sie das Skript zur Verwendung der Anforderung.

Ändern des Anforderungsstatus

Jede Integration Hub-Verbindung kann bis zu 50 Anfragen haben. Es gibt keine Einschränkung für die Anzahl der gleichzeitig aktiven Anforderungen. Anforderungen sind standardmäßig aktiv.

  1. Klicken Sie unter CXone auf die App-Auswahl und wählen SieAutomatisierung und KI > Integration Hub.

  2. Klicken Sie im linken Seitenbereich unter "Meine Verbindungen" auf die Verbindung, mit der Sie arbeiten möchten.

  3. Klicken Sie auf der Registerkarte "Anträge" auf die Anforderung, mit der Sie arbeiten möchten.

  4. Klicken Sie oben auf der Seite auf Inaktiv oder Aktiv, um den Status zu ändern.