GraphQL v2 Verbindung

Einführung

Eine GraphQL-Verbindung, die mit dem GraphQL v2 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 v2 Verbindung wird mit dem GraphQL v2 Connector aus einem dieser Standorte erstellt:

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

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

• Der Registerkarte Projektendpunkte und Connectoren in der Designkomponenten-Palette (siehe Designkomponenten-Palette).
• Der Registerkarte Komponenten im Projektbereich (siehe Komponentenaktionsmenü 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 v2 Verbindung wird im Folgenden beschrieben.

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

• URL: Geben Sie die URL ein.

• Authentifizierungsschema: Wählen Sie das Authentifizierungsschema aus, eines von:

  • Keine

  • Basis

    • Benutzer: Geben Sie den Benutzer ein.

    • Passwort: Geben Sie das Passwort ein.

  • OAuth

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

    • 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 initiieren: Wählen Sie die OAuth-Einstellung aus, eine von:

      • AUS

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

      • AKTUALISIEREN

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

      • GETANDREFRESH

    • OAuth-Version: Wählen Sie die OAuth-Version aus, eine von:

      • 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-Anforderungs-Token-URL: Geben Sie die OAuth-Anforderungs-Token-URL ein.

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

  • OAuthClient

    • OAuth-Version: Wählen Sie die OAuth-Version aus, eine von:

      • Deaktiviert

      • 1.0

      • 2.0

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

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

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

  • OAuthPassword

    • Benutzer: Geben Sie den Benutzer ein.

    • Passwort: Geben Sie das Passwort ein.

    • OAuth-Version: Wählen Sie die OAuth-Version aus, eine von:

      • Deaktiviert

      • 1.0

      • 2.0

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

  • OAuthPKCE

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

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

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

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

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

      • AUS

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

      • AKTUALISIEREN

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

      • HOLENUNDAKTUALISIEREN

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

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

  • AwsCognitoSrp

    • Benutzer: Geben Sie den Benutzer ein.

    • Passwort: Geben Sie das Passwort ein.

    • AWS Cognito-Region: Wählen Sie die AWS Cognito-Region aus.

    • 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.

  • AwsCognitoBasic

    • Benutzer: Geben Sie den Benutzer ein.

    • Passwort: Geben Sie das Passwort ein.

    • AWS Cognito-Region: Wählen Sie die AWS Cognito-Region aus.

    • 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.

• Proxy-Einstellungen verwenden: Wählen Sie aus, um die Einstellungen des privaten Agenten-Proxys 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 eine Zeile zur Tabelle hinzu. Geben Sie ein Schlüssel-Wert-Paar für jede Eigenschaft ein.

    Hinweis

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

    

  • Einreichen: Speichert das Schlüssel-Wert-Paar in der Tabelle. Sichtbar beim Überfahren einer Zeile im Bearbeitungsmodus.

  • Verwerfen: Verwirft eine neue Zeile oder alle Änderungen an einer bestehenden Zeile. Sichtbar beim Überfahren einer Zeile im Bearbeitungsmodus.
  • Bearbeiten: Ermöglicht das Bearbeiten eines bestehenden Schlüssel-Wert-Paares. Sichtbar beim Überfahren einer bestehenden Zeile.
  • Löschen: Löscht die Zeile aus der Tabelle. Sichtbar beim Überfahren einer bestehenden Zeile.
  • Alle löschen: Löscht alle Zeilen aus der Tabelle.

  Wichtig

  Felder in der Tabelle Erweiterte Konfigurationsparameter zeigen das Variablen-Icon 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 {"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 Organisation Richtlinie 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 fordert Sie auf, zu bestätigen, dass 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 fordert Sie auf, zu bestätigen, dass Sie die Verbindung löschen möchten.

OAuth-Verbindungen konfigurieren

Dieser Connector unterstützt eine Verbindung über OAuth, indem spezifische Konfigurationseigenschaften 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 Einzel-Agenten-Gruppen. 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	OFF
  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 es der jeweilige Endpunkt bestimmt. Sie würden den Connector so konfigurieren, dass er diese Tokens verwendet, indem Sie diese Eigenschaften festlegen:

  Konfigurationseigenschaft	Wert
  OAuth initiieren	REFRESH
  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. Weitere Informationen finden Sie in den Aktionsmenüs in den Connector-Grundlagen.

Diese Aktivitätstypen sind verfügbar:

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

• Ausführen: Führt eine Prozedur in GraphQL aus und ist als Ziel in einem Vorgang vorgesehen.