Mit der Connector Aufgabe können Sie über die vorkonfigurierten Connectors schnell und sicher eine Verbindung zu den verschiedenen Google Cloud-Diensten und anderen Geschäftsanwendungen aus Ihrer Integration herstellen, indem Sie die vorkonfigurierten Connectors verfügbar in Integration Connectors nutzen.
Eine Liste aller unterstützten Connectors für die Apigee-Integration finden Sie in der Connector-Referenz.Hinweise
- Sie müssen in Ihrem Google Cloud-Projekt die IAM-Rolle „Connectors-Administrator“ (
roles/connectors.admin
) haben. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten. - Weitere Informationen zu den allgemeinen Konzepten von Integration Connectors.
- Wenn Sie über einen Connector eine Verbindung zu Google Cloud-Diensten und anderen Geschäftsanwendungen herstellen möchten, muss ein nutzerverwaltetes Dienstkonto an Ihre Integration angehängt sein. Wenn für die Integration kein nutzerverwaltetes Dienstkonto konfiguriert ist, wird standardmäßig das Standarddienstkonto (
service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com
) zur Authentifizierung verwendet. - Prüfen Sie, ob Ihr Dienstkonto die erforderliche IAM-Rolle hat. Informationen zum Zuweisen von Rollen zu einem Dienstkonto finden Sie unter Zugriff auf Dienstkonten verwalten.
Connectors-Aufgabe hinzufügen
So fügen Sie die Connectors-Aufgabe in der Integration hinzu:
- Wählen Sie in der Apigee-Benutzeroberfläche Ihre Apigee-Organisation aus.
- Klicken Sie auf Entwickeln > Integrationen.
- Wählen Sie eine vorhandene Integration aus oder erstellen Sie eine neue Integration, indem Sie auf Integration erstellen klicken.
Wenn Sie eine neue Integration erstellen, gehen Sie so vor:
- Geben Sie im Dialogfeld Integration erstellen einen Namen und eine Beschreibung ein.
- Wählen Sie eine Region für die Integration aus der Liste der unterstützten Regionen aus.
- Klicken Sie auf Erstellen.
Dadurch wird die Integration auf der Seite Integrationsdesigner geöffnet.
- Klicken Sie in der Navigationsleiste Integrationsdesigner auf + Aufgabe/Trigger hinzufügen > Aufgaben, um die Liste der verfügbaren Aufgaben aufzurufen.
- Klicken Sie auf das Element Connectors und platzieren Sie es im Integrationseditor.
Connectors-Aufgabe konfigurieren
So konfigurieren Sie eine Connectors-Aufgabe:
- Klicken Sie auf das Connectors-Aufgabenelement im Designer, um den Konfigurationsbereich der Connectors-Aufgabe aufzurufen.
Klicken Sie optional auf
, um den Aufgabennamen zu ändern. - Klicken Sie auf Connector konfigurieren.
- Sie können entweder eine vorhandene Verbindung in der Region auswählen oder eine neue Verbindung erstellen. Führen Sie die folgenden Schritte auf der Seite Connectors-Aufgaben-Editor aus, um eine vorhandene Verbindung zu konfigurieren:
- Wählen Sie unter Connectors auswählen die Region der Verbindung aus.
- Wählen Sie eine vorhandene Verbindung aus der Liste der verfügbaren Verbindungen in der ausgewählten Region aus.
- Klicken Sie auf Next (Weiter).
- Wählen Sie in der Liste Typ die Option Entitäten oder Aktionen aus.
- Wenn Sie Entitäten auswählen, wird die Liste der unterstützten Entitäten für die Verbindung im Abschnitt Entitäten/Aktionen festlegen angezeigt. Wählen Sie eine Entität aus, gefolgt von dem Vorgang, den Sie für diese Entität ausführen möchten.
- Wenn Sie Aktionen auswählen, wird die Liste der unterstützten Aktionen für die Verbindung in der Spalte Entitäten/Aktionen festlegen angezeigt. Wählen Sie eine Aktion für die Verbindung aus. Die unterstützten Entitäten und Aktionen basieren auf dem Connector-Typ. Eine Liste aller unterstützten Connectors für die Apigee-Integration finden Sie in der Connector-Referenz. Die unterstützten Aktionen und Entitäten für einen Connector finden Sie in der jeweiligen Connector-Dokumentation.
Wenn der Connector eine benutzerdefinierte SQL-Abfrage unterstützt, können Sie aus der Liste Aktionen die Option Benutzerdefinierte Abfrage ausführen auswählen. Informationen zum Hinzufügen einer benutzerdefinierten SQL-Abfrage für Ihren Connector finden Sie unter Aktion: Benutzerdefinierte SQL-Abfrage ausführen.
- Klicken Sie auf Fertig, um die Verbindungskonfiguration abzuschließen und den Bereich zu schließen.
Die folgende Abbildung zeigt ein Beispiellayout für die Seite Connectors-Aufgabeneditor.
Eingabe- und Ausgabevariablen von Aufgaben konfigurieren
Im Konfigurationsbereich der Connectors-Aufgabe werden die Variablen Aufgabeneingabe und Aufgabenausgabe angezeigt, die automatisch generiert werden basierend auf der Entität und dem Vorgang oder der Aktion, die im Dialogfeld Connector-Aufgabe konfigurieren ausgewählt wurden. Diese Variablen sind als Eingaben für die aktuelle Aufgabe, als Ausgaben für nachfolgende Aufgaben oder als Bedingungen in der aktuellen Integration konfigurierbar und zugänglich.
Zum Konfigurieren der Variablen Aufgabeneingabe oder Aufgabenausgabe klicken Sie auf die entsprechende Variable, um den Bereich Variable konfigurieren zu öffnen, und führen Sie die folgenden Schritte aus:
- Geben Sie den Variablenwert in das Feld Standardwert ein.
- Optional: Wählen Sie Als Eingabe für die Integration verwenden oder Als Ausgabe für die Integration verwenden aus.
- Klicken Sie auf Speichern.
Weitere Informationen zu den Eingabe- und Ausgabeparametern der Connectors-Aufgabe finden Sie unter Entitätsvorgänge.
Entitätsvorgänge und -aktionen
Sie können CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren, Löschen) für Entitäten eines Connectors ausführen. Jeder Entitätsvorgang hat einen anderen Satz von Eingabe- und Ausgabeparametern. In der folgenden Tabelle werden die Eingabe- und Ausgabeparameter der verschiedenen Entitätsvorgänge aufgelistet.
Name des Vorgangs | Eingabeparameter | Ausgabeparameter |
---|---|---|
Liste |
|
|
Abrufen | entityId | connectorOutputPayload |
Erstellen | connectorInputPayload | connectorOutputPayload |
Aktualisieren |
|
connectorOutputPayload |
Löschen |
|
– |
Eingabeparameter
In der folgenden Tabelle werden die Eingabeparameter für die verschiedenen Entitätsvorgänge dargestellt.
Parametername | Datentyp | Beschreibung |
---|---|---|
entityId | String | Eine eindeutige Kennung der Zeile, auf die Sie zugreifen möchten. In der Regel ist Beispiel: Wenn Sie eine bestimmte Zeile aus einer MySQL-Tabelle abrufen möchten, ist |
connectorInputPayload | JSON | Die tatsächlichen Daten, die einer Entität hinzugefügt oder dafür aktualisiert werden sollen. Das folgende Beispiel zeigt das JSON-Snippet von Zeilendaten, die in eine Tabelle eingefügt werden:
{ "employee_first_name": "John", "employee_emailID": "test-05@test.com" } In diesem Beispiel sind |
filterClause | String | Schränkt das Ergebnis der Vorgänge auf Basis einer Bedingung ein. Weitere Informationen zum Hinzufügen einer Filterklausel finden Sie unter Filter für einen Vorgang hinzufügen. |
listEntitiesPageSize | Integer |
Gibt die Anzahl der Ergebnisse an, die auf einer Seite zurückgegeben werden sollen. Eine Seite ist eine logische Gruppierung der Datensätze einer Ergebnismenge. Die Nutzung von Seiten ist hilfreich, wenn Sie eine große Anzahl von Datensätzen in der Ergebnismenge erwarten. Wenn die Ergebnismenge groß ist, kann die Connectors-Aufgabe fehlschlagen, da mit der Connectors-Aufgabe nur eine begrenzte Menge an Daten verarbeitet werden kann. Wenn Sie die Ergebnismenge in kleinere Blöcke aufteilen, lässt sich dieses Problem vermeiden. Beispiel: Wenn Sie 1.000 Datensätze in Ihrer Ergebnismenge erwarten, können Sie die |
listEntitiesPageToken | String | Eine Seitenkennung (Token), mit der Sie auf eine bestimmte Seite zugreifen können. Sie haben die Möglichkeit, den Wert eines Seitentokens aus dem Ausgabeparameter |
listEntitiesSortByColumns | String-Array | Spaltenname, nach dem Sie die Ergebnismenge sortieren möchten.
|
Ausgabeparameter
In der folgenden Tabelle werden die Ausgabeparameter für die verschiedenen Entitätsvorgänge dargestellt.
Parametername | Datentyp | Beschreibung |
---|---|---|
connectorOutputPayload | JSON | Die Ausgabe eines Vorgangs im JSON-Format. |
listEntitiesNextPageToken | String |
Eine vom System generierte Kennung für eine Seite. Sie können sich das Token als einen Zeiger vorstellen, mit dem Sie auf eine bestimmte Seite der Ergebnismenge zugreifen können. Wenn Sie die Ergebnismenge mithilfe des Parameters Beispiel: Sie haben für den Parameter Wenn Ihr Ergebnisset viele Seiten enthält, können Sie die Für jede Schleife-Aufgabe zum wiederholten Aufrufen der Connector-Aufgabe verwenden und die Datenzuordnung-Aufgabe nutzen, um Tokenwerten nach jeder Ausführung automatisch dem |
Filterklausel für Entitätsvorgänge
Sie können die von der Aufgabe Connectors verarbeiteten Datensätze mithilfe der Variable Filterklausel einschränken, die als Aufgabeneingabe verfügbar ist. Im Fall eines Löschvorgangs können Sie beispielsweise eine Filterklausel hinzufügen, um Datensätze mit einer bestimmten orderId
zu löschen.
Die Filterklausel kann nur für die folgenden Entitätsvorgänge angewendet werden:
- Liste
- Löschen
- Aktualisieren
Wenn Sie einen dieser Vorgänge auswählen, wird im Bereich Aufgabeneingabe der Aufgabe Connectors das Feld Filterklausel automatisch angezeigt.
Filterklausel hinzufügen
Führen Sie die folgenden Schritte aus, um einen Fliterklausel hinzuzufügen:
- Klicken Sie auf das Connectors-Aufgabenelement im Designer, um den Konfigurationsbereich der Connectors-Aufgabe aufzurufen.
- Maximieren Sie den Bereich Aufgabeneingabe und klicken Sie auf die Stringvariable filterClause(Connectors).
Das Dialogfeld Variable konfigurieren wird angezeigt.
- Geben Sie die Filterklausel (nach der Klausel Syntax) im Feld Standardwert ein.
- Klicken Sie auf Speichern.
Syntax und Beispiele der Filterklausel
Eine Filterklausel hat das folgende Format:
FIELD_NAME CONDITION FILTER_VALUE
Beispiele
OwnerId = '0053t000007941XAAQ'
PoNumber < 2345
OrderNumber = 00110 AND StatusCode = 'Draft'
TotalAmount > 2500
ShippingPostalCode = 94043 OR ShippingPostalCode = 77002
Variablen in der Filterklausel verwenden
Sie können eine Integrationsvariable nicht direkt in einer Filterklausel verwenden. Wenn Sie eine Integrationsvariable verwenden möchten, müssen Sie zuerst eine Datenabgleichsaufgabe konfigurieren, um eine Zuordnung zwischen der Integrationsvariable und der Filterklausel zu erstellen.Die folgende Tabelle zeigt eine Beispielzuordnung zwischen einer Integrationsvariable und der Variable filterClause(Connectors)
:
Eingabe | Ausgabe |
---|---|
PRIMARY_KEY_ID = ' .CONCAT(INTEGRATION_VARIABLE) .CONCAT(') |
filterClause(Connectors) |
PRIMARY_KEY_ID = '
als Wert in die Eingabezeile eingegeben.
Aktion: Benutzerdefinierte SQL-Abfrage ausführen
So erstellen Sie eine benutzerdefinierte Abfrage:
- Folgen Sie der detaillierten Anleitung zum Hinzufügen einer Connectors-Aufgabe.
- Wählen Sie beim Konfigurieren der Connector-Aufgabe als Art der auszuführenden Aktion Aktionen aus.
- Wählen Sie in der Liste Aktion die Option Benutzerdefinierte Abfrage ausführen aus und klicken Sie dann auf Fertig.
- Maximieren Sie den Bereich Aufgabeneingabe und gehen Sie dann so vor:
- Geben Sie im Feld Zeitlimit nach ein, wie viele Sekunden auf die Ausführung der Abfrage gewartet werden soll.
Standardwert:
180
Sekunden. - Geben Sie im Feld Maximale Zeilenanzahl die maximale Anzahl von Zeilen ein, die von der Datenbank zurückgegeben werden sollen.
Standardwert:
25
. - Klicken Sie zum Aktualisieren der benutzerdefinierten Abfrage auf Benutzerdefiniertes Skript bearbeiten. Das Dialogfeld Skripteditor wird geöffnet.
- Geben Sie im Dialogfeld Skripteditor die SQL-Abfrage ein und klicken Sie auf Speichern.
Sie können in einer SQL-Anweisung ein Fragezeichen (?) verwenden, um einen einzelnen Parameter darzustellen, der in der Liste der Abfrageparameter angegeben werden muss. Mit der folgenden SQL-Abfrage werden beispielsweise alle Zeilen aus der Tabelle
Employees
ausgewählt, die mit den für die SpalteLastName
angegebenen Werten übereinstimmen:SELECT * FROM Employees where LastName=?
- Wenn Sie in Ihrer SQL-Abfrage Fragezeichen verwendet haben, müssen Sie den Parameter hinzufügen, indem Sie für jedes Fragezeichen auf + Parameternamen hinzufügen klicken. Während der Ausführung der Integration ersetzen diese Parameter die Fragezeichen (?) in der SQL-Abfrage nacheinander. Wenn Sie beispielsweise drei Fragezeichen (?) hinzugefügt haben, müssen Sie drei Parameter in der richtigen Reihenfolge hinzufügen.
So fügen Sie Abfrageparameter hinzu:
- Wählen Sie aus der Liste Typ den Datentyp des Parameters aus.
- Geben Sie im Feld Wert den Wert des Parameters ein.
- Wenn Sie mehrere Parameter hinzufügen möchten, klicken Sie auf + Abfrageparameter hinzufügen.
- Geben Sie im Feld Zeitlimit nach ein, wie viele Sekunden auf die Ausführung der Abfrage gewartet werden soll.
Schemaaktualisierung
Alle Entitäten und Aktionen sind mit einem Schema verknüpft. Ein Aktionsschema hat beispielsweise folgende Parameterdetails: Die Parameternamen und den entsprechenden Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Back-End abgerufen. Wenn das Schema Aktualisierungen vorgenommen hat, werden diese Aktualisierungen nicht automatisch in Ihre vorhandenen Verbindungen übernommen. Sie müssen das Schema manuell aktualisieren. So rufen Sie das aktualisierte Schema in Ihren vorhandenen Connector-Aufgaben auf:- Öffnen Sie in Integration Connectors die Seite Verbindungsdetails der Verbindung und klicken Sie dann auf Verbindungsschema aktualisieren.
- In Apigee Integration müssen Sie Ihre vorhandene Connector-Aufgabe für dieselbe Verbindung neu konfigurieren.
Inline-Verbindung erstellen
Mit der Connectors-Aufgabe können Sie eine neue Verbindung direkt in Integration Connectors erstellen.
Hinweise
Neue Verbindung erstellen
Führen Sie die folgenden Schritte aus, um eine neue Verbindung über Apigee Integration zu erstellen:
- Klicken Sie auf das Connectors-Aufgabenelement im Designer, um den Konfigurationsbereich der Connectors-Aufgabe aufzurufen.
- Klicken Sie auf Connector konfigurieren.
Die Seite Connectors-Aufgabeneditor wird angezeigt.
- Überspringen Sie das Feld Region.
- Klicken Sie auf Verbindung und wählen Sie im Drop-down-Menü die Option Verbindung erstellen aus.
- Führen Sie die folgenden Schritte im Bereich Verbindung erstellen aus:
- Wählen Sie im Schritt Standort den Standort für die Verbindung aus.
- Klicken Sie auf Region und wählen Sie einen Standort aus der Drop-down-Liste aus.
- Klicken Sie auf Next (Weiter).
- Geben Sie im Schritt Verbindungsdetails Details zur Verbindung ein:
- Connector: Wählen Sie aus der Drop-down-Liste den Connector-Typ aus, den Sie erstellen möchten. Informationen zur Liste der unterstützten Connectors finden Sie unter Alle Integrations-Connectors.
- Connector-Version: Wählen Sie eine verfügbare Version des ausgewählten Connector-Typs aus der Drop-down-Liste aus.
- Verbindungsname: Geben Sie einen Namen für die Verbindungsinstanz ein.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Optional: Aktivieren Sie Cloud Logging aktivieren, um die Logdaten der Verbindungsinstanz zu speichern.
- Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- Optional: Klicken Sie auf Erweiterte Einstellungen, um die Einstellungen für den Verbindungsknoten zu konfigurieren.
Weitere Informationen finden Sie in der jeweiligen Verbindungsdokumentation unter Integrations-Connectors.
- Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Klicken Sie auf Next (Weiter).
-
Geben Sie im Schritt Authentifizierung die Authentifizierungsdetails für die Verbindung an.
- Die in diesem Schritt ausgefüllten Authentifizierungsmethoden basieren auf dem Typ der erstellten Verbindung.
Unterschiedliche Verbindungstypen verwenden unterschiedliche Authentifizierungsmethoden. Weitere Informationen finden Sie im Abschnitt Authentifizierung konfigurieren der entsprechenden Verbindungsdokumentation in Integrations-Connectors.
- Klicken Sie auf Next (Weiter).
- Die in diesem Schritt ausgefüllten Authentifizierungsmethoden basieren auf dem Typ der erstellten Verbindung.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- Klicken Sie auf Erstellen.
- Wählen Sie im Schritt Standort den Standort für die Verbindung aus.
Best Practices
- Informationen zu den Nutzungslimits für die Connectors-Aufgabe finden Sie unter Nutzungslimits.
- Informationen zur Fehlerbehebung bei einer fehlgeschlagenen Connectors-Aufgabe finden Sie unter Logs zur Fehlerbehebung und zum Verfolgen von Connector-Fehlern verwenden.
Fehlerbehebungsstrategie
Eine Strategie zur Fehlerbehandlung für eine Aufgabe legt die Aktion fest, die ausgeführt werden soll, wenn die Aufgabe aufgrund eines temporären Fehlers fehlschlägt. Informationen zur Verwendung einer Fehlerbehandlungsstrategie und zu den verschiedenen Arten von Fehlerbehandlungsstrategien finden Sie unter Strategien zur Fehlerbehebung.