GraphQL-Verbindung

Einführung

Eine GraphQL-Verbindung, die mit dem GraphQL-Connector erstellt wurde, ermöglicht den Zugriff auf GraphQL. Diese Aktivitäten interagieren, sobald sie konfiguriert sind, über die Verbindung mit GraphQL.

Erstellen oder Bearbeiten einer GraphQL-Verbindung

Eine neue GraphQL-Verbindung wird mit dem GraphQL-Connector aus einem dieser Standorte erstellt:

• Der Registerkarte Projektendpunkte und -connectoren in der Designkomponentenpalette (siehe Designkomponentenpalette).
• Der Seite Globale Endpunkte (siehe Erstellen eines globalen Endpunkts in Globalen Endpunkten).

Eine vorhandene GraphQL-Verbindung kann von diesen Standorten aus bearbeitet werden:

• Der Registerkarte Projektendpunkte und -connectoren in der Designkomponentenpalette (siehe Designkomponentenpalette).
• Der Registerkarte Komponenten im Projektbereich (siehe Aktionenmenü für Komponenten in Projektbereich Komponenten-Registerkarte).
• Der Seite Globale Endpunkte (siehe Bearbeiten eines globalen Endpunkts in Globalen Endpunkten).

Konfigurieren einer GraphQL-Verbindung

Jedes Benutzeroberflächenelement des Konfigurationsbildschirms für die GraphQL-Verbindung wird im Folgenden beschrieben.

• Verbindungsname: Geben Sie einen Namen ein, um die Verbindung zu identifizieren. Der Name muss für jede GraphQL-Verbindung eindeutig sein und darf keine Schrägstriche (/) oder Doppelpunkte (:) enthalten. Dieser Name wird auch verwendet, um den GraphQL-Endpunkt zu identifizieren, der sich sowohl auf eine bestimmte Verbindung als auch auf deren Aktivitäten bezieht.

• Authentifizierung: Wenn ausgewählt (Standard), werden zusätzliche Einstellungen angezeigt. Für die Dokumentation siehe Eine Verbindung herstellen und Zusätzliche Konfigurationseigenschaften:

  • Auth-Schema: Wählen Sie das Autorisierungsschema, eines von:

    • Keine

    • Basis

    • OAuth

    • AwsCognitoSrp

    • AwsCognitoBasic

  • URL: Geben Sie die URL ein.

  • Benutzer: Geben Sie den Benutzer ein.

  • Passwort: Geben Sie das Passwort ein.

• AWS-Authentifizierung: Wenn ausgewählt, werden zusätzliche Einstellungen angezeigt. Für die Dokumentation siehe Eine Verbindung herstellen und Zusätzliche Konfigurationseigenschaften:

  • AWS Cognito Region: Wählen Sie die AWS Cognito-Region, eine von:

    • OHIO

    • NORTHERNVIRGINIA

    • NORTHERNCALIFORNIA

    • OREGON

    • CAPETOWN

    • HONGKONG

    • MUMBAI

    • OSAKA

    • SEOUL

    • SINGAPORE

    • SYDNEY

    • TOKYO

    • CENTRAL

    • BEIJING

    • NINGXIA

    • FRANKFURT

    • IRELAND

    • LONDON

    • MILAN

    • PARIS

    • STOCKHOLM

    • BAHRAIN

    • SAOPAULO

    • GOVCLOUDEAST

    • GOVCLOUDWEST

  • AWS Benutzerpool-ID: Geben Sie die AWS Benutzerpool-ID ein.

  • AWS Benutzerpool-Client-App-ID: Geben Sie die AWS Benutzerpool-Client-App-ID ein.

  • AWS Benutzerpool-Client-App-Geheimnis: Geben Sie das AWS Benutzerpool-Client-App-Geheimnis ein.

• OAuth: Wenn ausgewählt, werden zusätzliche Einstellungen angezeigt. Für die Dokumentation siehe Verbindung herstellen und Zusätzliche Konfigurationseigenschaften:

  • OAuth initiieren: Wählen Sie die OAuth-Einstellung, eine der folgenden:

    • AUS

    • GETANDREFRESH

    • REFRESH

  • OAuth-Version: Wählen Sie die OAuth-Version, eine der folgenden:

    • Deaktiviert

    • 1.0

    • 2.0

  • OAuth-Client-ID: Geben Sie die OAuth-Client-ID ein.

  • OAuth-Client-Geheimnis: Geben Sie das OAuth-Client-Geheimnis ein.

  • OAuth-Zugriffstoken: Geben Sie das OAuth-Zugriffstoken ein.

  • OAuth-Zugriffstoken-Geheimnis: Geben Sie das OAuth-Zugriffstoken-Geheimnis ein.

  • Callback-URL: Geben Sie die Callback-URL ein.

  • OAuth-Grant-Typ: Wählen Sie den OAuth-Grant-Typ, eine der folgenden:

    • CODE

    • CLIENT

    • PASSWORD

  • OAuth Callback-URL einbeziehen: Wenn ausgewählt (Standard), wird angegeben, dass die OAuth-Callback-URL einbezogen werden soll.

  • OAuth-Autorisierungs-URL: Geben Sie die OAuth-Autorisierungs-URL ein.

  • OAuth-Zugriffstoken-URL: Geben Sie die OAuth-Zugriffstoken-URL ein.

  • OAuth Refresh Token URL: Geben Sie die OAuth-Refresh-Token-URL ein.

  • OAuth Request Token URL: Geben Sie die OAuth-Request-Token-URL ein.

  • OAuth Verifier: Geben Sie den OAuth-Verifier ein.

  • Auth Token: Geben Sie das Auth-Token ein.

  • Auth Key: Geben Sie den Auth-Key ein.

  • OAuth Params: Geben Sie die OAuth-Parameter ein.

  • OAuth Refresh Token: Geben Sie das OAuth-Refresh-Token ein.

  • OAuth Expires In: Geben Sie die Zeit in Sekunden an, in der das OAuth-Token abläuft.

  • OAuth Token Timestamp: Geben Sie den Zeitstempel des OAuth-Tokens ein.

• JWT OAuth: Wenn ausgewählt, werden zusätzliche Einstellungen angezeigt. Für die Dokumentation siehe Establishing a connection und Additional configurations properties:

  • OAuth JWT Cert: Geben Sie das OAuth-JWT-Zertifikat ein.

  • OAuth JWT Cert Type: Wählen Sie den Typ des OAuth-JWT-Zertifikats aus, einer von:

    • USER

    • MACHINE

    • PFXFILE

    • PFXBLOB

    • JKSFILE

    • JKSBLOB

    • PEMKEY_FILE

    • PEMKEY_BLOB

    • PUBLIC_KEY_FILE

    • PUBLIC_KEY_BLOB

    • SSHPUBLIC_KEY_FILE

    • SSHPUBLIC_KEY_BLOB

    • P7BFILE

    • PPKFILE

    • XMLFILE

    • XMLBLOB

  • OAuth JWT Cert Password: Geben Sie das Passwort für das OAuth-JWT-Zertifikat ein.

  • OAuth JWT Cert Subject: Geben Sie das Subjekt des OAuth-JWT-Zertifikats ein.

  • OAuth JWT Issuer: Geben Sie den Aussteller des OAuth-JWT ein.

  • OAuth JWT Subject: Geben Sie das Subjekt des OAuth-JWT ein.

• SSL: Wenn ausgewählt, werden zusätzliche Einstellungen angezeigt. Für die Dokumentation siehe Establishing a connection und Additional configurations properties:

  • SSL-Clientzertifikat: Geben Sie das SSL-Clientzertifikat ein.

  • SSL-Clientzertifikatstyp: Wählen Sie den Typ des SSL-Clientzertifikats aus, einen der folgenden:

    • BENUTZER

    • MASCHINE

    • PFXDATEI

    • PFXBLOB

    • JKSDATEI

    • JKSBLOB

    • PEMKEY_DATEI

    • PEMKEY_BLOB

    • ÖFFENTLICHES_KEY_DATEI

    • ÖFFENTLICHES_KEY_BLOB

    • SSHPUBLIC_KEY_DATEI

    • SSHPUBLIC_KEY_BLOB

    • P7BDATEI

    • PPKDATEI

    • XMLDATEI

    • XMLBLOB

  • SSL-Clientzertifikat-Passwort: Geben Sie das Passwort für das SSL-Clientzertifikat ein.

  • SSL-Clientzertifikat-Betreff: Geben Sie den Betreff des SSL-Clientzertifikats ein.

  • SSL-Serverzertifikat: Geben Sie das SSL-Serverzertifikat ein.

• Proxy-Einstellungen verwenden: Wählen Sie aus, um die Proxy-Einstellungen des privaten Agenten zu verwenden.

• Erweiterte Konfigurationen: Wenn ausgewählt, wird die Tabelle Eigenschaften der erweiterten Konfigurationen angezeigt, die verwendet wird, um zusätzliche Konfigurationseigenschaften als Schlüssel-Wert-Paare hinzuzufügen.

  • Hinzufügen: Fügt der Tabelle eine Zeile hinzu. Geben Sie ein Schlüssel-Wert-Paar für jede Eigenschaft ein.

    Tipp

    Um Header zu einer GraphQL-Verbindung hinzuzufügen, geben Sie einen Namen von CustomHeaders und einen Wert im Format HeaderName:HeaderValue an. Zum Beispiel, indem Sie die GraphQL-API von Braintree verwenden, um den Braintree-Version-Header zu senden.

  • Übermitteln: Speichert das Schlüssel-Wert-Paar in der Tabelle. Sichtbar, wenn Sie mit der Maus über eine Zeile im Bearbeitungsmodus fahren.

  • Verwerfen: Verwirft eine neue Zeile oder alle Änderungen an einer vorhandenen Zeile. Sichtbar, wenn Sie mit der Maus über eine Zeile im Bearbeitungsmodus fahren.
  • Bearbeiten: Ermöglicht das Bearbeiten eines vorhandenen Schlüssel-Wert-Paares. Sichtbar, wenn Sie mit der Maus über eine vorhandene Zeile fahren.
  • Löschen: Löscht die Zeile aus der Tabelle. Sichtbar, wenn Sie mit der Maus über eine vorhandene Zeile fahren.
  • Alle löschen: Löscht alle Zeilen aus der Tabelle.

  Wichtig

  Felder in der Tabelle Erweiterte Konfigurationsparameter zeigen das Symbol für Variablen nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit befüllt werden, muss die Agenten-Version mindestens 10.75 / 11.13 sein.

  Felder in der Tabelle Erweiterte Konfigurationsparameter unterstützen nicht die Verwendung von Variablen, um rohes JSON zu übergeben. Wenn Ihr Anwendungsfall nicht unterstützt, rohes JSON direkt in den Feldern zu definieren, entkommen Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Zum Beispiel wird das Entkommen von {"success": "true"}; zu {\"success\": \"true\"};.

• Test: Klicken Sie, um die Verbindung mit der angegebenen Konfiguration zu überprüfen. Wenn die Verbindung getestet wird, wird die neueste Version des Connectors von den Agenten in der Agentengruppe heruntergeladen, die mit der aktuellen Umgebung verbunden ist. Dieser Connector unterstützt das Aussetzen des Downloads der neuesten Connector-Version durch die Verwendung der Organisationsrichtlinie Automatische Connector-Aktualisierung deaktivieren.

• Änderungen speichern: Klicken Sie, um die Konfiguration der Verbindung zu speichern und zu schließen.

• Änderungen verwerfen: Nachdem Sie Änderungen an einer neuen oder bestehenden Konfiguration vorgenommen haben, klicken Sie, um die Konfiguration ohne Speichern zu schließen. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

• Löschen: Nachdem Sie eine bestehende Verbindungs-Konfiguration geöffnet haben, klicken Sie, um die Verbindung dauerhaft aus dem Projekt zu löschen und die Konfiguration zu schließen (siehe Komponentenabhängigkeiten, Löschung und Entfernung). Eine Nachricht fragt Sie, ob Sie die Verbindung löschen möchten.

OAuth-Verbindungen konfigurieren

Dieser Connector unterstützt eine Verbindung über OAuth, indem spezifische Konfigurationsparameter verwendet werden. Nachdem Sie ein Authentifizierungsschema ausgewählt haben, das OAuth initiieren umfasst, können Sie die Konfiguration in den angezeigten Feldern angeben.

Für diesen Connector werden zwei Szenarien unterstützt. In beiden Szenarien müssen Sie ein Drittanbieter-Tool (wie Postman oder ein ähnliches Tool) verwenden, um das erforderliche Zugriffstoken oder die Tokens vom beteiligten Endpunkt zu erhalten. Beide Szenarien funktionieren nur für Einzelagentengruppen. Dies sind Agentengruppen, die aus einem einzelnen Agenten bestehen.

• Szenario 1: Verwendung eines OAuth-Zugriffstokens, das nach einer festgelegten Zeitspanne abläuft.

  Mit dieser Konfiguration geben Sie ein OAuth-Zugriffstoken an, das für einen festgelegten Zeitraum gültig ist, wie vom jeweiligen Endpunkt bestimmt. Der Connector verwendet das Token, um die Verbindung herzustellen. Die Verbindung funktioniert jedoch nicht mehr, sobald das Zugriffstoken abläuft. Sie würden den Connector so konfigurieren, dass er das Token verwendet, indem Sie diese Eigenschaften festlegen:

  Konfigurationseigenschaft	Wert
  OAuth initiieren	AUS
  OAuth-Zugriffstoken	Auf den Wert des vom Endpunkt erhaltenen OAuth-Zugriffstokens setzen

• Szenario 2: Verwendung eines OAuth-Zugriffstokens in Kombination mit einem OAuth-Refresh-Token, um eine automatische Aktualisierung des Zugriffs zu ermöglichen.

  Mit dieser Konfiguration verwendet der Connector ein Refresh-Token, um ein neues Zugriffstoken zu erhalten, sobald das aktuelle Zugriffstoken abgelaufen ist. Dies ist im Allgemeinen die beste Methode zur Konfiguration von OAuth.

  Sie geben ein OAuth-Zugriffstoken und ein OAuth-Refresh-Token an, wie vom jeweiligen Endpunkt bestimmt. Sie würden den Connector so konfigurieren, dass er diese Tokens verwendet, indem Sie diese Eigenschaften festlegen:

  Konfigurationseigenschaft	Wert
  OAuth initiieren	AKTUALISIEREN
  OAuth-Zugriffstoken	Auf den Wert des vom Endpunkt erhaltenen OAuth-Zugriffstokens setzen
  OAuth-Refresh-Token	Auf den Wert des vom Endpunkt erhaltenen OAuth-Refresh-Tokens setzen

Nächste Schritte

Nachdem eine GraphQL-Connectorverbindung erstellt wurde, platzieren Sie einen Aktivitätstyp auf der Entwurfskanvas, um Aktivitätsinstanzen zu erstellen, die entweder als Quellen (um Daten in einem Vorgang bereitzustellen) oder als Ziele (um Daten in einem Vorgang zu konsumieren) verwendet werden.

Menüaktionen für eine Verbindung und ihre Aktivitätstypen sind im Projektbereich und in der Palette der Entwurfskomponenten zugänglich. Für Details siehe Aktionsmenüs in Connector-Grundlagen.

Diese Aktivitätstypen sind verfügbar:

• Abfrage: Ruft Datensätze aus einer Tabelle bei GraphQL ab und ist als Quelle in einem Vorgang vorgesehen.

• Ausführen: Führt ein Verfahren bei GraphQL aus und ist als Ziel in einem Vorgang vorgesehen.