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 1, um einen bidirektionalen Zugriff auf Zuora zu ermöglichen.

Hinweis

Führen Sie vor der Verwendung des Zuora-Connectors die folgenden Aufgaben aus:

• In Ihrem Google Cloud-Projekt:
  • Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
  • 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

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. 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:

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

   Zur Seite „Verbindungen“

2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
   1. 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.

   2. Klicken Sie auf Weiter.
4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
   1. Connector: Wählen Sie aus der Drop-down-Liste der verfügbaren Connectors Zuora aus.
   2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
   3. 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.
   4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
   5. Aktivieren Sie optional Cloud Logging. und wählen Sie dann eine Logebene aus. Die Logebene ist standardmäßig auf Error festgelegt.
   6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   7. Optional: Konfigurieren Sie 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.

   Hinweis: Sie können die Verbindungsknotenwerte nur anpassen, wenn Sie ein „Pay as you go”-Kunde sind.
   8. Tenant: Legen Sie hier Ihren Zuora-Mandanten fest. Standardmäßig verwenden wir die Instanz „USProduction“.
   9. URL: Diese Angabe ist nur erforderlich, wenn Sie eine US-amerikanische Produktionskopie verwenden. Wenn diese Property angegeben ist, hat der Wert der Property „Tenant“ keine Auswirkungen auf den Authentifizierungsprozess.
   10. ZuoraService: Gibt an, welcher Ausführungsdienst oder welches Schema verwendet werden soll.
   11. Clientseitiges Auslagern verwenden: Gibt an, ob der CData ADO.NET-Anbieter für SAP Cloud for Customer clientseitiges Auslagern verwenden soll.
   12. Benutzerdefinierten Dienst verwenden: Gibt an, ob der benutzerdefinierte OData-Dienst von SAP Cloud for Customer verwendet werden soll.
   13. Benutzerdefinierte Ansichten: Ein Dateipfad, der auf die JSON-Konfigurationsdatei mit Ihren benutzerdefinierten Ansichten verweist.
   14. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   15. Klicken Sie auf Weiter.
5. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
   1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden von der Zuora-Verbindung unterstützt:

      • OAuth 2.0-Clientanmeldedaten

   Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

   2. Klicken Sie auf Next (Weiter).
6. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
7. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

• OAuth 2.0-Clientanmeldedaten
  • Client-ID: Die Client-ID, die vom Connector für die von Ihnen erstellte Anwendung bereitgestellt wird.
  • Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die verbundene Anwendung, die Sie erstellt haben.

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.

Hinweis: Sie können die Entitäten, Vorgänge und Aktionen eines Connectors in der Connectors-Aufgabe aufrufen.

• 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:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  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 keinen der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Liste Operations 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.

Hinweis: Allen Entitäten und Aktionen ist ein Schema zugewiesen. Ein Aktionsschema hat beispielsweise folgende Parameterdetails: den Parameter und den zugehörigen Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Backend abgerufen. Wenn es Aktualisierungen am Schema gibt, werden diese nicht automatisch in Ihren vorhandenen Verbindungen berücksichtigt. Sie müssen das Schema manuell aktualisieren. Wenn Sie das Schema für eine Verbindung aktualisieren möchten, öffnen Sie die Seite Verbindungsdetails der Verbindung und klicken Sie dann auf Verbindungsschema aktualisieren.

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Beispiel: Alle Einträge in „Erstattungen“ auflisten

In diesem Beispiel werden alle Einträge in der Entität Refunds aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Refunds aus.
3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
4. Optional können Sie im Abschnitt Task Input der Aufgabe Connectors Sie können die Ergebnisse filtern, indem Sie eine Filterklausel festlegen.

Beispiel: Datensatz für einen Debit-Memo abrufen

In diesem Beispiel wird von der Entität Debit_Memo ein Datensatz mit der ID 45 abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Debit_Memo aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 45 in das Feld Standardwert ein.

   Hier ist 45 ein Primärschlüsselwert in der Entität Debit_Memo.

Beispiel: Ticket erstellen

In diesem Beispiel wird ein Ticket in der Entität Ticket erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Tickets aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

   {
   "Name": "Test735362767",
   "Label": "Test735362767",
   "Type": "String",
   "FieldType": "Insert ticket1",
   "GroupName": "ticketinformation",
   "Description": "Test ticket"
   }

   Ist die Integration erfolgreich, enthält das Feld connectorOutputPayload der Connector-Aufgabe , der in etwa so aussieht:

   {
   "Name": "Test1695971640609"
   }

Beispiel: Dealeintrag aktualisieren

In diesem Beispiel wird der Datensatz mit der ID 97 in der Entität Deals aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Deals aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

   {
   "Description": "New description"
   }

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Forms aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 78 in das Feld Standardwert ein.

Verbindungen mit Terraform erstellen

Mit dem Terraform-Code Ressource, um eine neue Verbindung zu erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispiel-Terraform-Vorlage für die Verbindungserstellung finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie in der Terraform-Konfigurationsdatei die folgenden Variablen festlegen:

Parametername	Datentyp	Erforderlich	Beschreibung
Mandant	ENUM	Falsch	Legen Sie hier Ihren Zuora-Mandanten fest. Standardmäßig verwenden wir „USProduction“ Mandant. Unterstützte Werte: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url	STRING	Falsch	Dies ist nur erforderlich, wenn Sie eine Produktionskopie-Umgebung in den USA haben. Wenn diese Eigenschaft angegeben wird, hat der Wert der Eigenschaft "Mandant" keine Auswirkungen auf den Authentifizierungsprozess.
zuora_service	ENUM	Falsch	Gibt an, welcher Ausführungsdienst oder welches Schema verwendet werden soll. Unterstützte Werte sind: DataQuery, AQuADataExport
use_client_side_paging	BOOLEAN	Falsch	Gibt an, ob der CData ADO.NET-Anbieter für SAP Cloud für Kunden clientseitiges Paging 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 über die Connectors-Aufgabe in einer Integration 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 Tasks für Connectors.

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

• Informationen zum Anhalten und Fortsetzen einer Verbindung
• Informationen zum Überwachen der Connector-Nutzung
• Weitere Informationen zum Ansehen von Connector-Logs