Zuora
Mit dem Zuora-Connector können Sie eine Verbindung zu einer Zuora-Instanz herstellen und auf die Zuora-Daten als herkömmliche Datenbank zugreifen.
Unterstützte Versionen
Dieser Connector nutzt die Zuora API-Version v1, um bidirektionalen Zugriff auf Zuora zu ermöglichen.
Hinweise
Führen Sie vor der Verwendung des Zuora-Connectors die folgenden Aufgaben aus:
- In Ihrem Google Cloud-Projekt:
- Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
- Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
- Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.
- Aktivieren Sie die folgenden Dienste:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.
Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.
Connector konfigurieren
Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:
- Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.
- Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
- Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
Unterstützte Regionen für Connectors:
Eine Liste aller unterstützten Regionen finden Sie unter Standorte.
- Klicken Sie auf Weiter.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
- Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
- Connector: Wählen Sie Zuora aus der Drop-down-Liste der verfügbaren Connectors aus.
- Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
- Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.
Verbindungsnamen müssen die folgenden Kriterien erfüllen:
- Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
- Buchstaben müssen Kleinbuchstaben sein.
- Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
- Verbindungsnamen dürfen maximal 49 Zeichen haben.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf
Error
festgelegt. - Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- Konfigurieren Sie optional die Verbindungsknoteneinstellungen:
- Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
- Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.
Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.
- Mandant: Legen Sie hier Ihren Zuora-Mandanten fest. Standardmäßig verwenden wir den Mandanten „USProduction“.
- URL: Dies ist nur erforderlich, wenn Sie eine US-Produktionskopie haben. Wenn dieses Attribut angegeben wird, hat der Wert des Attributs „Tenant“ keine Auswirkungen auf den Authentifizierungsprozess.
- ZuoraService: Gibt an, welcher Ausführungsdienst oder welches Schema verwendet werden soll.
- Clientseitiges Paging verwenden: Gibt an, ob der CData ADO.NET-Provider für SAP Cloud for Customer clientseitiges Paging verwenden soll.
- Benutzerdefinierten Dienst verwenden: Gibt an, ob der benutzerdefinierte SAP Cloud for Customer-OData-Dienst verwendet werden soll.
- Benutzerdefinierte Ansichten: Ein Dateipfad, der auf die JSON-Konfigurationsdatei mit Ihren benutzerdefinierten Ansichten verweist.
- Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Klicken Sie auf Weiter.
-
Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
Die folgenden Authentifizierungstypen werden von der Zuora-Verbindung unterstützt:
- Anmeldedaten des OAuth 2.0-Clients
- Klicken Sie auf Next (Weiter).
Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- Klicken Sie auf Erstellen.
Authentifizierung konfigurieren
So aktivieren Sie die OAuth 2.0-Authentifizierung mit Clientanmeldedaten:
- Erstellen Sie Clientanmeldedaten in Zuora und rufen Sie die Client-ID und den Clientschlüssel ab.
- Geben Sie die Anmeldedaten in Google Cloudan.
Clientanmeldedaten in Zuora erstellen
- Klicken Sie im OneID-Portal auf Ihren Avatar und dann auf Einstellungen.
- Klicken Sie auf OAuth 2.0-Clients verwalten.
- Klicken Sie auf der Seite OAuth 2.0-Clients verwalten auf Neu.
- Geben Sie im Fenster Neuer OAuth 2.0-Client die folgenden Felder an:
- Name: Geben Sie einen Namen für den Client ein.
- Typ: Wählen Sie aus der Liste Clientanmeldedaten aus.
- Klicken Sie auf Speichern. Nachdem der Client erfolgreich erstellt wurde, wird ein Fenster mit der Client-ID und dem Clientschlüssel angezeigt.
Speichern Sie die Client-ID und den Clientschlüssel für die spätere Verwendung. Weitere Informationen finden Sie unter OAuth 2.0-Clients verwalten .
Anmeldedaten in Google Cloudangeben
Wenn Sie die Verbindung in Integration Connectors erstellen , müssen Sie die folgenden Details angeben:Geben Sie im Abschnitt Authentifizierung die folgenden Details ein:
- Client-ID: Die Client-ID für die von Ihnen erstellte App.
- Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die verbundene Anwendung, die Sie erstellt haben.
Webverbindungstyp
In der folgenden Tabelle sind die Beispielkonfigurationswerte für den Zuora-Webverbindungstyp aufgeführt:
Feldname | Details |
Standort | us-central1 |
Connector | Zuora |
Connector-Version | 1 |
Verbindungsname | zuora-con |
Dienstkonto | account@my-project.iam.gserviceaccount.com |
Mandant | TENANT |
Mindestanzahl von Knoten | 2 |
Maximale Anzahl von Knoten | 4 |
Client-ID | CLIENT_ID |
Clientschlüssel | CLIENT_SECRET |
Secret-Version | 1 |
Entitäten, Vorgänge und Aktionen
Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.
- Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.
Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste
Entities
leer. - Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keine der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der
Operations
-Liste aufgeführt. - Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die
Actions
-Liste leer.
Beispiele für Entitätsvorgänge
In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.
Beispiel: Alle Datensätze in „Erstattungen“ auflisten
In diesem Beispiel werden alle Datensätze in der Entität Refunds
aufgelistet.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Refunds
aus der ListeEntity
aus. - Wählen Sie den Vorgang
List
aus und klicken Sie auf Fertig. - Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors das Ergebnisset filtern, indem Sie eine Filterklausel angeben.
Beispiel: Belastungsanzeige abrufen
In diesem Beispiel wird ein Datensatz mit der ID 45
aus der Debit_Memo
-Entität abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Debit_Memo
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Get
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann
45
in das Feld Standardwert ein.Dabei ist
45
ein Primärschlüsselwert in der EntitätDebit_Memo
.
Beispiel: Ticket erstellen
In diesem Beispiel wird ein Ticket in der Ticket
-Einheit erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Tickets
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "Name": "Test735362767", "Label": "Test735362767", "Type": "String", "FieldType": "Insert ticket1", "GroupName": "ticketinformation", "Description": "Test ticket" }
Wenn die Integration erfolgreich ist, hat das Feld
connectorOutputPayload
der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:{ "Name": "Test1695971640609" }
Beispiel: Dealeintrag aktualisieren
In diesem Beispiel wird der Datensatz mit der ID 97 in der Entität Deals
aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Deals
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in FeldDefault Value
ein:{ "Description": "New description" }
- Klicken Sie auf entityId und geben Sie dann
97
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
97
festlegen.
Beispiel: Formular löschen
In diesem Beispiel wird der Datensatz mit der ID 78 in der Entität Forms
gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Forms
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Delete
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann
78
in das Feld Standardwert ein.
Verbindungen mit Terraform erstellen
Sie können die Terraform-Ressource verwenden, um eine neue Verbindung zu erstellen.
Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.
Ein Beispiel für eine Terraform-Vorlage zum Erstellen einer Verbindung finden Sie hier.
Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
Mandant | ENUM | Falsch | Legen Sie hier Ihren Zuora-Mandanten fest. Standardmäßig verwenden wir den Mandanten „USProduction“. Unterstützte Werte: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox |
URL | STRING | Falsch | Dies ist nur erforderlich, wenn Sie eine US-Produktionskopie haben. Wenn dieses Attribut angegeben wird, hat der Wert des Attributs „Tenant“ keine Auswirkungen auf den Authentifizierungsprozess. |
zuora_service | ENUM | Falsch | Gibt an, welcher Ausführungsservice oder welches Schema verwendet werden soll. Unterstützte Werte: DataQuery, AQuADataExport |
use_client_side_paging | BOOLEAN | Falsch | Gibt an, ob der CData ADO.NET Provider für SAP Cloud for Customer die clientseitige Paginierung verwenden soll. |
use_custom_service | BOOLEAN | Falsch | Gibt an, ob der benutzerdefinierte SAP Cloud for Customer-OData-Dienst verwendet werden soll. |
user_defined_views | STRING | Falsch | Ein Dateipfad, der auf die JSON-Konfigurationsdatei mit Ihren benutzerdefinierten Ansichten verweist. |
Zuora-Verbindung in einer Integration verwenden
Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung in einer Integration über die Aufgabe „Connectors“ verwenden.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.
Hilfe von der Google Cloud-Community erhalten
Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.Nächste Schritte
- Verbindung anhalten und fortsetzen
- Informationen zum Überwachen der Connector-Nutzung
- Connector-Logs ansehen