Einrichtung
Bevor Sie E-Signaturen verwenden können, müssen Sie zunächst in Ihrem DocuSign-Konto eine App anlegen und diese über die DocuSign-Schnittstelle mit unserer ERP-Lösung verbinden. Anschließend müssen Sie in der E-Signatur-Einrichtung DocuSign als Anbieter auswählen und die erforderlichen E-Mail-Betreffzeilen hinterlegen. Nach erfolgreicher Einrichtung sind E-Signaturen für die folgenden Belege verfügbar:
| Bereich | Belege | Voraussetzung |
|---|---|---|
| Verkauf | Verkaufsangebot, Verkaufsauftrag | Status = Freigegeben |
| Service | Serviceauftrag, Serviceangebot, Arbeitskarte, Wartungsvertrag | keine |
| Vermietung | Mietangebot, Mietvertrag, Zusatzvertrag | Status = Freigegeben Nur mit Aptean Rental verfügbar. |
Dieses Kapitel ist in die folgenden Abschnitte gegliedert:
- DocuSign-App anlegen
- DocuSign-Schnittstelle einrichten
- E-Signatur einrichten
- E-Mail-Betreffzeilen einrichten
- Status einer E-Signatur
DocuSign-App anlegen
Für die Verbindung benötigen Sie in DocuSign eine App mit einem Integrationsschlüssel und einem RSA-Schlüsselpaar. Gehen Sie zum Anlegen der App wie folgt vor:
- Melden Sie sich in Ihrem DocuSign-Konto an.
- Navigieren Sie zu Admin > Integrationen > Apps und Schlüssel.
- Notieren Sie im Bereich Meine Kontoinformationen die Werte Benutzer-ID und API-Konto-ID.
- Klicken Sie auf App und Integrationsschlüssel hinzufügen.
- Geben Sie einen eindeutigen Namen für die App ein.
- Wählen Sie im Bereich Integrationstyp die Option Integrationsschlüssel eines Drittanbieters aus.
- Wählen Sie im Dialogfenster Ja aus.
- Kopieren Sie den Integrationsschlüssel, der unter dem Namen der App angezeigt wird. Sie benötigen ihn später für die Felder Aussteller (iss) und Einwilligungs-Client-ID.
- Klicken Sie im Bereich Service-Integration auf RSA generieren.
- Kopieren Sie den privaten Schlüssel vollständig, einschließlich der Zeilen
-----BEGIN RSA PRIVATE KEY-----und-----END RSA PRIVATE KEY-----. - Aktivieren Sie im Bereich Zusätzliche Einstellungen die Kontrollkästchen aller HTTP-Methoden, damit die Schnittstelle alle erforderlichen Aufrufe ausführen kann.
- Speichern Sie Ihre Angaben.
DocuSign-Schnittstelle einrichten
Die Verbindung zu DocuSign läuft über die Schnittstelle DocuSign. Die Authentifizierung erfolgt über ein JSON Web Token (JWT), das mit dem privaten RSA-Schlüssel aus Ihrer DocuSign-App signiert wird. Allgemeine Informationen zu Schnittstellen und JWT-Anwendungsendpunkten finden Sie im Kapitel Schnittstellen und Integrationen.
Schnittstelle und JWT-Anwendungsendpunkt einrichten
Wichtig
Private Schlüssel werden in einem isolierten Speicher abgelegt und beim Kopieren oder Wiederherstellen einer Umgebung nicht übertragen. Hinterlegen Sie den privaten Schlüssel nach jeder Umgebungsmigration erneut.
Solange die Schnittstelle aktiv ist, können ihre Verbindungseinstellungen nicht geändert werden. Zum Einrichten bereiten Sie die Schnittstelle vor und hinterlegen anschließend im JWT-Anwendungsendpunkt den privaten Schlüssel und die Angaben aus Ihrer DocuSign-App. Gehen Sie zum Einrichten der Schnittstelle wie folgt vor:
- Suchen Sie die Seite Schnittstellenliste über die Schnellsuche (ALT+Q) in unserer ERP-Lösung.
- Öffnen Sie die Schnittstelle DocuSign.
- Geben Sie im Inforegister Parameter in der Zeile account_id in das Feld Wert die API-Konto-ID aus DocuSign ein.
- Wählen Sie im Inforegister Autorisierung im Feld Autorisierungsart den Wert JWT aus.
- Klicken Sie im Feld Autorisierungscode auf das Auswahlfeld.
- Legen Sie einen neuen Eintrag an.
- Ein neuer JWT-Anwendungsendpunkt wird angezeigt.
- Geben Sie auf der JWT-Anwendungsendpunktkarte im Feld JWT-Endpunktcode einen Code für Ihre DocuSign-App ein.
- Geben Sie auf der JWT-Anwendungsendpunktkarte im Feld Beschreibung eine aussagekräftige Beschreibung für Ihre DocuSign-App ein.
- Wählen Sie im Feld Signaturalgorithmus den Wert RS256 (RSA-SHA256) aus.
- Wählen Sie im Inforegister RS256-Privatschlüssel im Feld Schlüsselformat den Wert PEM aus.
- Fügen Sie den privaten Schlüssel aus DocuSign in das Feld Privatschlüssel ein.
- Füllen Sie im Inforegister Standard-Claims die Felder gemäß der nachfolgenden Tabelle aus:
| Feld | Wert | Herkunft |
|---|---|---|
| Aussteller (iss) | Integrationsschlüssel | DocuSign-App |
| Subjekt (sub) | Benutzer-ID | DocuSign-Konto |
| Zieldomäne (aud) | account.docusign.com |
fester Wert für die Umgebung |
| Token-Ablauf (Sek.) | 3600 |
fester Wert (eine Stunde) |
- Aktivieren Sie im Inforegister Token-Austausch den Schieberegler Token-Austausch verwenden.
- Füllen Sie die angezeigten Felder gemäß der nachfolgenden Tabelle aus:
| Feld | Wert |
|---|---|
| Token-Endpunkt-URL | https://account.docusign.com/oauth/token |
| JSON-Antwortschlüssel | access_token |
| Einwilligungsautorisierungs-URL | https://account.docusign.com/oauth/auth |
| Einwilligungs-Client-ID | Integrationsschlüssel der DocuSign-App |
| Einwilligungsbereich | signature impersonation |
- Lassen Sie die Felder Einwilligung zuletzt erteilt am und Token gültig bis zunächst leer. Sie werden automatisch befüllt, sobald die Einwilligung erteilt und das erste Token abgerufen wurde.
- Klicken Sie im Inforegister Benutzerdefinierte Claims auf Neue Zeile.
- Geben Sie in das Feld Claim-Name den Wert scope und in das Feld Claim-Wert den Wert signature impersonation ein.
- Klicken Sie in der Menüleiste auf Schlüssel anwenden.
- Der Schieberegler Privatschlüssel vorhanden wird aktiviert.
Einwilligung erteilen und Schnittstelle aktivieren
Damit die Schnittstelle für den DocuSign-Benutzer Signaturanfragen senden darf, erteilen Sie einmalig die Einwilligung. Gehen Sie dazu wie folgt vor:
- Klicken Sie in der Menüleiste der JWT-Anwendungsendpunktkarte auf Weiterleitungs-URI anzeigen.
- Hinterlegen Sie die angezeigte URI in Ihrer DocuSign-App im Bereich Zusätzliche Einstellungen > Umleitungs-URIs.
- Klicken Sie in der Menüleiste auf Einwilligung anfordern.
- Die Anmeldeseite von DocuSign wird angezeigt.
- Melden Sie sich mit dem Benutzer an, dessen Benutzer-ID Sie im Feld Subjekt (sub) eingetragen haben.
- Erteilen Sie die angeforderte Einwilligung.
- Schließen Sie die JWT-Anwendungsendpunktkarte.
- Prüfen Sie auf der Schnittstellenkarte, ob im Feld Autorisierungsart der Wert JWT und im Feld Autorisierungscode der neue Endpunkt eingetragen ist.
- Klicken Sie in der Menüleiste auf Schnittstelle aktivieren.
E-Signatur einrichten
Auf der Seite E-Signatur-Einrichtung legen Sie fest, welcher Anbieter für E-Signaturen verwendet wird. Solange kein Anbieter ausgewählt ist, sind alle Funktionen für E-Signaturen ausgeblendet.
Hinweis
Richten Sie zuerst die DocuSign-Schnittstelle vollständig ein und aktivieren Sie diese. Ist die Schnittstelle nicht eingerichtet oder nicht aktiv, wird beim Auswählen des Anbieters eine Fehlermeldung angezeigt.
Gehen Sie zum Einrichten von E-Signaturen wie folgt vor:
- Suchen Sie die Seite E-Signatur-Einrichtung über die Schnellsuche (ALT+Q) in unserer ERP-Lösung.
- Wählen Sie im Feld E-Signatur-Anbieter den Wert DocuSign aus.
Die Funktionen für E-Signaturen werden in den unterstützten Belegen angezeigt.
E-Mail-Betreffzeilen einrichten
DocuSign sendet jedem Empfänger eine E-Mail mit einem Link zum Beleg. Den Betreff dieser E-Mail können Sie je Sprache auf der Seite E-Signatur-Einrichtung hinterlegen. Beim Erstellen einer E-Signatur wird der Betreff anhand des Sprachcodes des Belegs vorbelegt. Ist für diese Sprache kein Betreff hinterlegt, wird ein englischer Standardbetreff verwendet. Gehen Sie zum Einrichten wie folgt vor:
- Suchen Sie die Seite E-Signatur-Einrichtung über die Schnellsuche (ALT+Q) in unserer ERP-Lösung.
- Wählen Sie im Inforegister E-Mail-Betreffzeilen nach Sprache in einer neuen Zeile im Feld Sprach-ID die gewünschte Sprache aus.
- Geben Sie in das Feld Text den Betreff ein. Sie können dabei die folgenden Platzhalter verwenden:
| Platzhalter | Wird ersetzt durch |
|---|---|
%1 |
Belegname |
%2 |
aktuelles Datum |
%3 |
Name Ihres Unternehmens |
Tipp
Klicken Sie im Feld Text auf das Auswahlfeld, um eine Übersicht der verfügbaren Platzhalter anzuzeigen.
Status einer E-Signatur
Jede E-Signatur durchläuft verschiedene Status. Der Status wird aus dem Status der einzelnen Empfänger in DocuSign ermittelt:
| Status | Beschreibung |
|---|---|
| Entwurf | Die E-Signatur wurde erstellt, aber noch nicht an DocuSign gesendet. Pro Beleg kann jeweils nur ein Entwurf angelegt werden. |
| Gesendet | Die E-Signatur wurde an DocuSign gesendet und die Empfänger wurden per E-Mail benachrichtigt. Der Status bleibt bestehen, bis alle Empfänger unterschrieben haben. |
| Abgeschlossen | Alle Empfänger haben unterschrieben. |
| Abgelehnt | Mindestens ein Empfänger hat die Unterschrift abgelehnt. |
| Abgebrochen | Die E-Signatur wurde abgebrochen. Die Empfänger können den Beleg nicht mehr unterschreiben. |
| Abgelaufen | Die Frist für die Unterschrift ist in DocuSign abgelaufen. |
Tipp
Damit der Status gesendeter E-Signaturen ohne manuellen Eingriff aktuell bleibt, wird automatisch ein Aufgabenwarteschlangenposten eingerichtet. Er führt für alle E-Signaturen mit dem Status Gesendet die Aktion Status aktualisieren aus.