DocuSign

Mit dem DocuSign-Connector lassen sich Lesevorgänge in DocuSign ausführen.

Hinweise

Führen Sie vor der Verwendung des DocuSign-Connectors die folgenden Schritte 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.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

    2. Tippen Sie auf Weiter.
  4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie DocuSign aus der Drop-down-Liste der verfügbaren Connectors 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 63 Zeichen haben.
    4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
    5. Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Standardmäßig ist die Logebene auf Error festgelegt.
    6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    7. Wenn Sie ein DocuSign-Sandbox-Konto verwenden, können Sie optional UseSandbox auswählen.
    8. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:

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

    9. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    10. Tippen 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 DocuSign-Verbindung unterstützt:

      • OAUTH 2.0 – Autorisierungscode
      • OAuth 2.0 – JWT-Inhaber

      2. Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

    2. Tippen Sie auf 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 – Autorisierungscode
    • Client-ID: Die Client-ID, die zum Anfordern von Zugriffstokens verwendet wird.
    • Bereiche: Eine durch Kommas getrennte Liste der gewünschten Bereiche.
    • Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die verbundene Anwendung, die Sie erstellt haben.
  • OAuth 2.0 – JWT-Inhaber
    • Consumer Key für verbundene Apps:Der Consumer-Key, der für die von Ihnen erstellte verbundene App bereitgestellt wird.
    • Nutzername: Der Nutzername für die verbundene App, die Sie erstellt haben.
    • Privater Schlüssel: Secret Manager-Secret mit dem Inhalt der privaten Schlüsseldatei. Der private Schlüssel sollte mit dem Public-Key-Zertifikat übereinstimmen, das für Connector bereitgestellt wird.

Beispiele für Verbindungskonfiguration

In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder, die Sie beim Erstellen der Verbindung konfigurieren.

OAUTH 2.0 – Verbindungstyp des Autorisierungscodes

Feldname Details
Standort us-central1
Connector DocuSign
Connector-Version 1
Verbindungsname gcp-docusign-new-auth
Cloud Logging aktivieren Nein
UseSandbox Ja
Dienstkonto SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Bereiche Unterschrift
Clientschlüssel CLIENT_SECRET
Secret-Version 1

OAuth 2.0 – Verbindungstyp „JWT-Inhaber“

Feldname Details
Standort us-central1
Connector DocuSign
Connector-Version 1
Verbindungsname gcp-docusign-token
Cloud Logging aktivieren Nein
UseSandbox Ja
Dienstkonto SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Authentifizierung OAuth 2.0 – JWT-Inhaber
Consumer-Key für verbundene App 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nutzername USER_NAME
Privater Schlüssel PRIVATE_KEY
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. Unterstützt ein Connector jedoch keine Entitätsvorgänge, Vorgänge sind 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 eine Ausgabe . Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Systembeschränkungen

Der DocuSign-Connector kann 3 Transaktionen pro Sekunde verarbeiten, pro Knoten, und throttles Transaktionen über diesen Grenzwert hinaus. Standardmäßig weist Integration Connectors einer Verbindung 2 Knoten zu (für bessere Verfügbarkeit).

Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Beschränkungen.

Beispiele für Entitätsvorgänge

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

Der Wert für eine Entitäts-ID muss direkt übergeben werden, z. B. 16ab549b-95d7-47cb-b557-c2476ef62d9d. Die ID 16ab549b-95d7-47cb-b557-c2476ef62d9d ist der eindeutige Primärschlüsselwert, der übergeben werden muss.

Beispiel: LIST-Vorgang für Entität „Konten“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity Konten aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Task Input der Aufgabe Connectors haben, können Sie die filterClause ein.

Beispiel: LIST-Vorgang für Entität „Dokumente“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Dokumente“ in der Liste Entity aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.

Beispiel: LIST-Operation für Entität „Umschläge“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Umschläge“ aus der Liste Entity aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Task Input der Aufgabe Connectors haben, können Sie die filterClause ein.

Beispiel: LIST-Vorgang für Entität „Ordner“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Ordner“ aus der Liste Entity aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Task Input der Aufgabe Connectors haben, können Sie die filterClause ein.

Beispiel: LIST-Vorgang für Entität „Gruppen“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Gruppen“ aus der Liste Entity aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Task Input der Aufgabe Connectors haben, können Sie die filterClause ein.

Beispiel: LIST-Vorgang für die Entität „Users“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity die Option „Nutzer“ aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Task Input der Aufgabe Connectors haben, können Sie die filterClause ein.

Sie können LIST-Vorgänge auch für die folgenden Entitäten ausführen:

  • UserInfo
  • UserSignatures
  • Arbeitsbereiche
  • Empfänger
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • Sperren
  • GroupBrands
  • GroupUsers
  • PowerForms
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • Vorlagen

Beispiel: Einzelnen Eintrag GET für Entität „Konten“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity Konten aus.
  3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
  4. Um die Entitäts-ID festzulegen, Klicken Sie unter Datenzuordnung im Abschnitt Data Mapper auf Datenzuordnungseditor öffnen und Geben Sie dann 2.4578824E7 in das Feld Eingabewert ein und wählen Sie die Entitäts-ID als lokale Variable aus.

Beispiel – Einzelnen Eintrag GET für Entität „Dokumente“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Dokumente“ in der Liste Entity aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Um die Filterklausel festzulegen, Klicken Sie unter Datenzuordnung im Abschnitt Data Mapper auf Datenzuordnungseditor öffnen und Geben Sie dann Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' in das Feld Eingabewert ein und wählen Sie die Filterklausel als lokale Variable aus.

Beispiel: Einzelner GET-Eintrag für Entität „Umschlag“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity die Option „Umschläge“ aus.
  3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
  4. Um die Entitäts-ID festzulegen, Klicken Sie unter Datenzuordnung im Abschnitt Data Mapper auf Datenzuordnungseditor öffnen und Geben Sie dann 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 in das Feld Eingabewert ein und wählen Sie die Entitäts-ID als lokale Variable aus.

Beispiel: Einzelnen Eintrag GET für Entität „Folders“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Ordner“ aus der Liste Entity aus.
  3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
  4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Datenübersetzer der Aufgabe Datenabgleich auf Datenabgleichs-Editor öffnen und geben Sie dann 05f76d13-a513-492b-8c58-176702768db0 in das Feld Eingabewert ein. Wählen Sie dann „EntityId“ als lokale Variable aus.

Beispiel: EINZELNEN DATENSATZ für die Entität „Gruppen“ abrufen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Gruppen“ aus der Liste Entity aus.
  3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
  4. Klicken Sie zum Festlegen der Entitäts-ID im Bereich Datenübersetzer der Aufgabe Datenabgleich auf Datenabgleichs-Editor öffnen und geben Sie dann 1.4167231E7 in das Feld Eingabewert ein. Wählen Sie dann „EntityId“ als lokale Variable aus.

Beispiel: Einzelnen Eintrag GET für Entität „Users“

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie „Nutzer“ aus der Liste Entity aus.
  3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
  4. Um die Entitäts-ID festzulegen, Klicken Sie unter Datenzuordnung im Abschnitt Data Mapper auf Datenzuordnungseditor öffnen und Geben Sie dann 16ab549b-95d7-47cb-b557-c2476ef62d9d in das Feld Eingabewert ein und wählen Sie die Entitäts-ID als lokale Variable aus.

Sie können GET-Vorgänge auch für die folgenden Entitäten ausführen:

  • UserInfo
  • UserSignatures
  • Arbeitsbereiche
  • Empfänger
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • Sperren
  • GroupBrands
  • GroupUsers
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • Vorlagen

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 zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:

Parametername Datentyp Erforderlich Beschreibung
proxy_enabled BOOLEAN Falsch Wählen Sie dieses Kontrollkästchen aus, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme ENUM Falsch Der für die Authentifizierung beim ProxyServer-Proxy zu verwendende Authentifizierungstyp. Unterstützte Werte: BASIC, DIGEST, NONE
proxy_user STRING Falsch Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
proxy_password SECRET Falsch Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.

DocuSign-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in beiden Apigee-Integration und Anwendungsintegration Sie können die Verbindung über die Connectors-Aufgabe in einer Integration.

  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in der 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