Integration von DocuSign

Mit der DocuSign-Integration können Sie mit Citrix Workspace von jedem Gerät aus Umschläge für digitale Signaturen senden und zu empfangen. Benutzer können eine neue Signaturvorlage initiieren, über zu signierende Dokumente benachrichtigt werden und im DocuSign-Posteingang eine Liste zuvor gesendeter oder empfangener Umschläge anzeigen.

Hinweis:

Senden Sie uns Ihr Feedback! Bitte geben Sie Feedback zu dieser Integrationsvorlage. Unser Team überprüft unser zugehöriges Forum täglich auf gemeldete Probleme.

Ausführliche Details zu vorkonfigurierten Mikroapps für DocuSign finden Sie unter Verwenden von DocuSign-Mikroapps.

Prüfung der Voraussetzungen

Es wird hier davon ausgegangen, dass der Administrator zur DocuSign-Integration gehört, die von der Organisation eingerichtet wurde. Dieses DocuSign-Administratorkonto muss volle Leserechte für Benutzerinformationen besitzen.

Nachdem Sie diese Integration mit DocuSign eingerichtet haben, benötigen Sie diese Artefakte, um die Integration in Citrix Workspace-Mikroapps hinzuzufügen. Dies gilt insbesondere für die folgende Liste von Parametern zum Einrichten der OAuth-Integration:

• Basis-URL: Die Basis-URL, an die die Endpunkt-Pfade angehängt werden. Sie finden die Basis-URL im Dienstkonto unter Apps and Keys. Basis-URL-Format: {baseURL fetched from sevice account}/restapi/2.1/. Informationen zum Erfassen der Basis-URL finden Sie unter Konfigurieren des OAuth-Servers.
• DocuSign-Konto-ID: Ihre Docusign-Administratorkonto-ID. Siehe Konfigurieren des OAuth-Servers.
• Umgebungs-URL: Zum Beispiel von der Basis-URL https://{yourEnvironmentalURL}.docusign.net/restapi/v2.1/.
• Autorisierungs-URL: https://account-d.docusign.com/oauth/auth
• Token-URL: https://account-d.docusign.com/oauth/token
• Client-ID: Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Darüber hinaus müssen alle Anwendungsschlüssel für DocuSign den “DocuSign go Live”-Prozess bestehen. Dies gilt für den Integrationsschlüssel (ClientID). Dies kann bis zu einer Woche dauern. Weitere Informationen zum “DocuSign go Live”-Prozess finden Sie unter https://developers.docusign.com/docs/esign-rest-api/go-live/.
• Geheimer Clientschlüssel: Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird.

Hinweis:

Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.

Konfigurieren Sie in Citrix Gateway die Unterstützung für Single Sign-On für DocuSign, damit Benutzer sich nur einmal anmelden und ihre Anmeldeinformationen nicht erneut eingeben müssen. Weitere Hinweise zum Konfigurieren von SSO finden Sie unter Citrix Gateway Service.

Sie können nur eine begrenzte Anzahl an API-Anforderungen an bestimmte Ressourcen stellen. Daher empfehlen wir Folgendes:

Link zu DocuSign-API-Ratenlimit: https://developers.docusign.com/docs/esign-soap-api/esign101/security/call-limits/

Erstellen eines neuen Dienstkontos

Registrieren Sie sich hier: https://admin.docusign.com. Hier können Sie Benutzerberechtigungsprofile einsehen: https://support.docusign.com/en/guides/ndse-admin-guide-permission-sets. Um auf die Demoversion von eSignature Admin zuzugreifen, verwenden Sie diese URL: https://admindemo.docusign.com. Weitere Informationen zu neuen Dienstkonten finden Sie unter: https://support.docusign.com/en/guides/org-admin-guide-getting-started.

Konfigurieren des OAuth-Servers

Konfigurieren Sie den OAuth-Server so, dass Daten über die DocuSign-Integration gelesen werden.

1. Melden Sie sich mit Ihrem Dienstkonto bei eSignature Admin an: https://admin.docusign.com. Eine Demoversion von eSignature Admin erhalten Sie hier: https://admindemo.docusign.com. Weitere Informationen finden Sie unter https://support.docusign.com/en/guides/ndse-admin-guide-access und https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration.
2. Gehen Sie in der Navigationsleiste auf Settings.
3. Wählen Sie auf der Einstellungsseite Apps and Keys dann Add App & Integration Key.
4. Geben Sie einen App-Namen ein und wählen Sie Add.
5. Wählen Sie +Add Secret Key, um einen geheimen Schlüssel zu generieren.
6. Geben Sie die Umleitungs-URI ein: https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
7. Kopieren und speichern Sie die unter Integration Key und Secret Key (ClientID und Secret) angezeigten Schlüssel. Verwenden Sie diese Details für die Dienstauthentifizierung, während Sie die Integration konfigurieren.
8. Kopieren und speichern Sie die URI unter Account’s Base URI.
9. Kopieren und speichern Sie die DocuSign-Konto-ID.

Darüber hinaus müssen alle Anwendungsschlüssel für DocuSign den “DocuSign go Live”-Prozess bestehen. Dies gilt für den Integrationsschlüssel (ClientID). Dies kann bis zu einer Woche dauern. Weitere Informationen zum “DocuSign go Live”-Prozess finden Sie unter https://developers.docusign.com/docs/esign-rest-api/go-live/.

Konfigurieren des OAuth-Client

Konfigurieren Sie den OAuth-Client so, dass Daten über die DocuSign-Integration zurückgeschrieben werden.

1. Melden Sie sich mit Ihrem Dienstkonto bei eSignature Admin an: https://admin.docusign.com. Eine Demoversion von eSignature Admin erhalten Sie hier: https://admindemo.docusign.com. Weitere Informationen finden Sie unter https://support.docusign.com/en/guides/ndse-admin-guide-access und https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration.
2. Gehen Sie in der Navigationsleiste auf Settings.
3. Wählen Sie auf der Einstellungsseite Apps and Keys dann Add App & Integration Key.
4. Geben Sie einen App-Namen ein und wählen Sie Add.
5. Wählen Sie +Add Secret Key, um einen geheimen Schlüssel zu generieren.
6. Geben Sie die Umleitungs-URI ein: https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
7. Kopieren und speichern Sie die unter Integration Key und Secret Key (ClientID und Secret) angezeigten Schlüssel. Verwenden Sie diese Details für die Dienstaktionsauthentifizierung, während Sie die Integration konfigurieren.

Darüber hinaus müssen alle Anwendungsschlüssel für DocuSign den “DocuSign go Live”-Prozess bestehen. Dies gilt für den Integrationsschlüssel (ClientID). Dies kann bis zu einer Woche dauern. Weitere Informationen zum “DocuSign go Live”-Prozess finden Sie unter https://developers.docusign.com/docs/esign-rest-api/go-live/.

Konfigurieren der Organisation

Verknüpfen Sie Konten mit Ihrem Unternehmen. Das Konto, mit dem Sie die Organisation erstellt haben, wird automatisch verknüpft.

1. Wählen Sie auf der Startseite von eSignature Admin die Option Get Started. Wenn Sie diese Option nicht in Ihrem DocuSign-Konto sehen, ist DocuSign Admin für das Konto nicht aktiviert. Wenden Sie sich an Ihren DocuSign-Kontomanager, um Hilfe zu erhalten.
2. Füllen Sie die Felder Organization Name und optional Description aus und wählen Sie Next.
3. Wählen Sie Create, um die Erstellung Ihrer Organisation abzuschließen. Weitere Informationen finden Sie unter https://support.docusign.com/en/guides/org-admin-guide-create-org.
4. Gehen Sie zum Dashboard von Organization Admin. Wählen Sie Connected Apps und dann Authorize Application.
5. Wählen Sie den App-Namen aus, den Sie beim Konfigurieren von OAuth-Server und -Client eingegeben und erstellt haben. Wählen Sie Add, um Berechtigungen bereitzustellen.
6. Geben Sie diese Bereiche ein. Weitere Informationen finden Sie unter https://developers.docusign.com/platform/auth/reference/scopes.
   • Wählen Sie für die Dienstauthentifizierung den App-Namen aus, den Sie in Konfigurieren des OAuth-Servers erstellt haben, geben Sie die Berechtigung user_read ein und wählen Sie Hinzufügen.
   • Wählen Sie für die Dienstaktionsauthentifizierung den App-Namen aus, den Sie in Konfigurieren des OAuth-Client erstellt haben, geben Sie die Berechtigung user_write ein und wählen Sie Hinzufügen.

Hinzufügen der Integration zu Citrix Workspace-Mikroapps

Fügen Sie die DocuSign-Integration zu Citrix Workspace-Mikroapps hinzu, um eine Verbindung zu Ihrer Anwendung herzustellen. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Dadurch werden vorkonfigurierte Mikroapps mit Benachrichtigungen und Aktionen bereitgestellt, die in Ihrem Workspace sofort einsatzbereit sind.

Führen Sie folgende Schritte aus:

1. Wählen Sie auf der Seite Mikroappintegrationen die Optionen Neue Integration hinzufügen und Neue Integration aus Citrix-Vorlagen hinzufügen.
2. Wählen Sie die DocuSign-Kachel.
3. Geben Sie einen Integrationsnamen ein.
4. Geben Sie Connectorparameter ein.
   • Geben Sie die Basis-URL der Instanz ein:
   • Wählen Sie ein Symbol für die Integration aus der Symbolbibliothek aus, oder belassen Sie das Standardsymbol.

   

5. Geben Sie Ihre DocuSign-Konto-ID ein. Siehe Konfigurieren des OAuth-Servers.

6. Wählen Sie unter Dienstauthentifizierung im Menü Authentifizierungsmethode die Option OAuth 2.0 und geben Sie die Authentifizierungsdetails ein. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Generieren Sie über das Sicherheitsprotokoll OAuth 2.0 einen Anforderungs-/Autorisierungstoken zum delegierten Zugriff. Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.

   1. Wählen Sie im Menü Gewährungstyp die Option Autorisierungscode. Dadurch wird ein temporärer Code gewährt, den der Client gegen einen Zugriffstoken tauscht. Der Code wird vom Autorisierungsserver abgerufen, wo Sie die vom Client angeforderten Informationen sehen. Nur dieser Gewährungstyp ermöglicht einen sicheren Benutzeridentitätswechsel. Dadurch wird die Rückruf-URL angezeigt, die Sie bei der Registrierung Ihrer Anwendung verwenden.
   2. Wählen Sie im Menü Tokenautorisierung die Option Anforderungstext.
   3. Die Autorisierungs-URL ist vorausgefüllt.
   4. Die Token-URL ist vorausgefüllt.
   5. Stellen Sie sicher, dass Folgendes als Bereich eingegeben ist: user_read
   6. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies und den geheimen Clientschlüssel beim Konfigurieren des OAuth-Servers. Sie müssen die Rückruf-URL hinzufügen, die Sie auf der Konfigurationsseite der Integration sehen.
   7. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird.

   

7. Aktivieren Sie unter Dienstaktionsauthentifizierung die Umschaltfläche Separate Benutzerauthentifizierung in Aktionen verwenden. Mit der Dienstaktionsauthentifizierung authentifizieren Sie sich auf der Dienstaktionsebene. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen.

   1. Wählen Sie im Menü Authentifizierungsmethode die Option OAuth 2.0 und geben Sie die Authentifizierungsdetails ein.
   2. Wählen Sie im Menü Gewährungstyp die Option Autorisierungscode. Dadurch wird ein temporärer Code gewährt, den der Client gegen einen Zugriffstoken tauscht. Der Code wird vom Autorisierungsserver abgerufen, wo Sie die vom Client angeforderten Informationen sehen. Nur dieser Gewährungstyp ermöglicht einen sicheren Benutzeridentitätswechsel. Dadurch wird die Rückruf-URL angezeigt, die Sie bei der Registrierung Ihrer Anwendung verwenden.
   3. Wählen Sie im Menü Tokenautorisierung die Option Anforderungstext.
   4. Die Autorisierungs-URL ist vorausgefüllt.
   5. Die Token-URL ist vorausgefüllt.
   6. Stellen Sie sicher, dass Folgendes als Bereich eingegeben ist: user_write
   7. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen diese Angaben und den geheimen Clientschlüssel beim Konfigurieren des OAuth-Client. Sie müssen die Rückruf-URL hinzufügen, die Sie auf der Konfigurationsseite der Integration sehen.
   8. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird.

   

8. Die Umschaltfläche Anforderungsratenlimit aktivieren ist aktiviert. Belassen Sie für Anzahl der Anforderungen den Wert 400 und für Zeitintervall den Wert 1 Minute. 1. Das Anforderungstimeout ist auf 120 voreingestellt.

9. (Optional) Aktivieren Sie die Umschaltfläche Protokollierung, um 24-Stunden-Protokolle für Supportzwecke zu erstellen.

   

10. Wählen Sie dann Speichern.
11. Wählen Sie unter OAuth-Autorisierung die Option Autorisieren, um sich mit Ihrem Dienstkonto anzumelden. Ein Popupfenster mit dem Google-Anmeldebildschirm wird angezeigt.
    1. Geben Sie Benutzernamen und Kennwort Ihres Dienstkontos ein und wählen Sie Anmelden.
    2. Wählen Sie Akzeptieren.

    

Hinzufügen von Aktionen zu Schaltflächen

Konfigurieren Sie Gehe zu URL-Aktionen für die folgenden Schaltflächen, um die Schaltflächenfunktionen Umschlag signieren und Umschlag anzeigen zu aktivieren. Diese Gehe zu URL-Konfiguration leitet die Benutzeraktion auf die spezifische Umschlagdetailseite in DocuSign.

1. Navigieren Sie zu den folgenden Schaltflächen im Seitengenerator und wählen Sie sie aus. Führen Sie dieses Verfahren für jede der folgenden Schaltflächen aus:

   • Mikroapp Meine empfangenen Umschläge:: Seite Details zu ausstehendem Umschlag: Schaltfläche Umschlag signieren
   • Mikroapp Meine gesendeten Umschläge: Seite Empfängeransicht von Umschlag: Schaltfläche Umschlag signieren
   • Mikroapp Meine gesendeten Umschläge: Seite Absenderansicht von Umschlag: Schaltfläche Umschlag anzeigen
2. Wählen Sie rechts die Registerkarte Aktionen.
3. Wählen Sie unter Aktionen die Option Gehe zu URL.

4. Ersetzen Sie im Feld URL-Vorlage den Teil {yourEnvironmentName} der URL durch Ihre Umgebungs-URL. Sie finden die Umgebungs-URL in Ihrer Basis-URL: https://{yourEnvironmentName}.docusign.net/restapi/v2.1/. Beispiel: https://appdemo.docusign.com/documents/details/\{\{nested_table_envelopes_recipients_sign.envelope_id\}\}.

   

5. Wiederholen Sie diesen Vorgang nun für die anderen Schaltflächen.

Sie können nun die erste Datensynchronisierung festlegen und ausführen. Vollständige Informationen zu Synchronisierungsregeln, zeitlich fehlgeschlagenen Synchronisierungen und zu Vetoregeln finden Sie unter Synchronisieren von Daten.

Weitere Informationen zu API-Endpunkten und Tabellenentitäten finden Sie unter DocuSign-Connectorspezifikationen.

Verwenden von DocuSign-Mikroapps

Vorhandene Anwendungsintegrationen werden mit vorkonfigurierten Mikroapps geliefert. Beginnen Sie mit diesen Mikroapps und passen Sie sie an Ihre Erfordernisse an.

Hinweis:

Um die Funktionen Umschlag signieren und Umschlag anzeigen zu aktivieren, müssen Sie die Schaltfläche Aktion für die Seiten “Details zu ausstehendem Umschlag”, “Empfängeransicht von Umschlag” und “Absenderansicht von Umschlag” durch Ihre Umgebungs-URL ersetzen. Siehe Hinzufügen von Aktionen zu Schaltflächen.

Meine empfangenen Umschläge: Zeigen Sie zu signierende Umschläge an, die ein Benutzer empfangen hat. Der Benutzer kann sich selbst authentifizieren und den Umschlag in DocuSign anzeigen.

Vorlage senden: Senden einer zu signierenden vorhandenen Vorlage.

Meine gesendeten Umschläge: Liste der vom Benutzer gesendeten Umschläge. Benutzer können auch Details zum Umschlag anzeigen und Empfänger hinzufügen, bearbeiten und löschen.

Hinweis:

Benachrichtigungen laufen zwei Tage nach ihrer Erstellung ab.