Service-Methoden und Parameter mit DocuSign

Prev Next

DocuWare kooperiert mit DocuSign als Anbieter von Vertrauensdiensten, um Dokumente in einem Workflow zu signieren.

DocuSign bietet zur Konfiguration der Signatur eine Reihe von Service-Methoden mit jeweils spezifischen Parametern an. Für jede Signatur wird in der Workflow Konfiguration eine eigene Service-Methode hinterlegt.

Die Service-Methoden bieten unter anderem folgende Funktionen:

  • Unterzeichnen eines Dokuments an mehreren Stellen, zum Beispiel bei Verträgen

  • Signieren von mehreren, geklammerten Dateien in einem DocuWare Dokument. Das bietet sich zum Beispiel an, wenn mit einem Vertrag eine Standard-Vertraulichkeitsvereinbarung unterschrieben werden soll.

  • Frist für das Signieren setzen

  • Erinnerungsmails einrichten

  • Kopie des signierten Dokuments an den Unterzeichner senden

DocuWare Signature Service

Voraussetzung für die Signatur von Dokumenten in einem Workflow ist, dass der DocuWare Signature Service über eine Web Service Aktivität im Workflow hinterlegt ist.  

Remote signieren mit DocuSign

Die Service-Methoden von DocuSign, die in einem DocuWare Workflow verwendet werden können, ermöglichen eine Remote-Signatur.

Dabei teilt die unterzeichnende Person dem Mitarbeiter, der die Signatur anfordert, ihren Namen, ihre E-Mail-Adresse und Telefonnummer mit.

Der Mitarbeiter gibt die Daten in das Workflow-Formular ein und fordert die Signatur bei DocuSign an.

Die unterzeichnende Person meldet sich bei DocuSign an und unterzeichnet das Dokument mit der Authentifizierung, die in der Service-Methode konfiguriert ist.

Wenn keine Telefonnummer für SMS oder Sprachnachricht angegeben ist, reicht der Link in der Mail zur Unterzeichnung.

Die folgenden Service-Methoden sind alle Remote-Signaturen und haben den Sicherheitslevel “fortgeschritten” -  AES.  

Für die unterzeichnende Person ist bei diesen Verfahren keine Registrierung bei DocuSign erforderlich.

AddNewDocumentRemote

Ein Dokument kann von einer Person an einer Stelle im Dokument unterzeichnet werden. .

  • Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.

Parametername

Variable im Workflow

Beschreibung

Werte

AccessCode (string)

Obligatorisch für RecipientAuthenticationType = Access Code

Text

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden.


AnchorText (string)

Text

Nach diesem Text wird auf dem Dokument gesucht, um die Signatur zu platzieren. Wird der Ankertext nicht gefunden, erfolgt eine Fehlermeldung. Wenn hier kein Ankertext angegeben ist, werden die nachfolgenden Ortsangaben absolut und nicht relativ zum Finden eines Textes verwendet.


AnchorTextOccurrence (int)

Integer

Wenn der Ankertext mehrfach im Text vorkommt, legt dieser Parameter fest, bei welcher Textstelle die Signatur platziert wird.

  • 0 oder 1 = erste Stelle

  • -1 = letzte Stelle

  • andere Ziffern = weitere Stellen

DateSignedAnchorText (string)

optional

String

Text, nach dem der Dienst auf dem Dokument suchen kann. Wenn er angegeben und nicht gefunden wird, tritt ein Fehler auf. Wenn nicht angegeben, sind die nachfolgenden Positionsinformationen absolut und nicht relativ, um ein Textstück zu finden.


DateSignedAnchorTextOccurrence (int)

optional

Integer

Legt fest, welche Stelle mit dem Ankertext als Startpunkt für die Platzierung des Datums verwendet werden soll

  • 0 oder 1 = erste Stelle

  • -1 = letzte Stelle

  • andere Ziffern = weitere Stellen

DateSignedFieldName (string)

Text

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.


DateSignedPageNumber (int)

optional

Integer

Seitennummer innerhalb der Datei, um mit der Suche nach dem Ankertext zu beginnen. -1 bedeutet, dass auf der letzten Seite gesucht werden soll. Wenn kein Ankertext angegeben wird, ist die absolute Seitennummer gemeint.


DateSignedPositionX (int)

Integer

Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position, an der der mit einem Datum unterzeichnete Text auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach rechts gerichtet, negative Zahlen nach links.


DateSignedPositionY (int)

Integer

Bezogen auf den oberen Rand des Ankertextes ist dies die vertikale Position des mit einem Datum unterzeichneten Textes, der auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen nach oben.


DaysBeforeExpiration (int)

Integer

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.


DocId (int)

Integer

ID vom zu unterzeichnenden Dokument


EmailMessage (string)

Text

Text, der im Inhalt der E-Mail angezeigt wird


EmailSubject (string)

Text

Betreff der E-Mail


FailureStatusValue (string)

Text

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird


FileCabinetId (string)

Text

GUID vom Archiv mit dem zu signierenden Dokument


IncludeDateSigned (boolean)

optional

String

Optional, aber wenn der Parameter "true" ist, wird das Unterschriftsdatum in das Dokument aufgenommen und die unten aufgeführten Parameter zum Auffinden des Unterschriftsdatums werden benötigt.

  • True

  • false

IncludeReport (boolean)

optional

String

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

  • True

  • False

PageNumber (int)

Integer

Seitennummer im Dokument, ab der nach dem Ankertext gesucht werden soll. -1 zeigt an, dass auf der letzten Seite gesucht werden soll. Wenn kein Ankertext angegeben wird, ist dieser Parameter die absolute Seitenzahl.


PhoneNumber (string)

String

Telefonnummer für die Zwei-Faktor-Authentifizierung (internationales Nummernformat, z.B. +18455639045)


PositionX (int)

Integer

Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position der Signatur, die auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach rechts gerichtet. Negative Zahlen sind nach links gerichtet.


PositionY (int)

Integer

Bezogen auf den oberen Rand des Ankertextes ist dies die vertikale Position der Signatur, die auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind unten. Negative Zahlen sind oben.


PostSigningAction (string)

Text

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Text

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

  • True

  • False

RejectionReasonFieldName (string)

Optional

Text

Spezifiert ein Indexfeld des Typs "Text" vom zu unterzeichnenden Dokument. Wenn DocuSign so konfiguriert ist, dass eine Begründung für die Ablehnung erforderlich ist, wird diese hier eingetragen.


Report Language (string)

Obligatorisch für IncludeReport = True

Text

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

  • de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SectionNumber (int)

Integer

Der Parameter bezieht sich auf geklammerte Dokumente. Die Indexzahl gibt an, welches der geklammerten Dokumente im Stapel unterzeichnet werden soll.

  • 0 oder 1 = erstes Dokument im Stapel

  • -1 = letztes Dokument

  • Andere Ziffern wie 2,3 etc.geben die jeweiligen Dokumente im Stapel an.

SignerEmail (string)

Text

E-Mail-Adresse des unterzeichnenden Benutzers


SignerName (string)

Text

Name des unterzeichnenden Benutzers


StatusFieldName (string)

Text

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.


SuccessStatusValue (string)

Text

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird


Token (string)

Text

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.


AddNewDocumentMultiSigners

Ein Dokument kann von mehreren Personen an verschiedenen Stellen unterzeichnet werden.

  • Die Informationen zu den Unterzeichnern und die Unterschriftspositionen im Dokument werden in einer Liste mit Trennzeichen übermittelt.

  • Das Trennzeichen wird mit einem eigenen Parameter festgelegt.

  • In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet.

  • Die Sortierung der Liste muss bei allen Parametern einheitlich sein.

  • Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.

Parametername

Variable im Workflow

Obligatorisch

Beschreibung

Werte

AccessCode (string)

Text

Obligatorisch für RecipientAuthenticationType = Access Code

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden.

DateSignedFieldName (string)

Text

Obligatorisch

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

DaysBeforeExpiration (int)

Integer

Obligatorisch

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.

DocId (int)

Integer

Obligatorisch

ID vom zu unterzeichnenden Dokument

EmailMessage (string)

Text

Obligatorisch

Text, der im Inhalt der E-Mail angezeigt wird

EmailSubject (string)

Text

Obligatorisch

Betreff der E-Mail

FailureStatusValue (string)

Text

Obligatorisch

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird

FileCabinetId (string)

Text

Obligatorisch

GUID vom Archiv mit dem zu signierenden Dokument

IncludeDateSigned (boolean)

Text

Optional

Optional, aber wenn der Parameter "true" ist, wird das Unterschriftsdatum in das Dokument aufgenommen und die unten aufgeführten Parameter zum Auffinden des Unterschriftsdatums werden benötigt.

  • True

  • False

IncludeReport (boolean)

Text

Optional

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

  • True

  • False

MultiAnchorText (string)

Text

Obligatorisch

Bezogen auf den oberen Rand des Ankertextes ist dies die vertikale Position des mit einem Datum unterzeichneten Textes, der auf dem Dokument platziert werden soll (Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen nach oben.

MultiAnchorTextOccurrence (string)

Text

Obligatorisch

Wenn der Ankertext mehrfach im Text vorkommt, wird hier die Stelle für das Setzen der Signatur festgelegt.

MultiDateSignedAnchorText (string)

Text

Obligatorisch

Enthält die Angaben, wo die Ankertexte für die Unterschriften mit Datumsangaben sich im Dokument befinden

MultiDateSignedAnchorTextOccurrence (string)

Text

Obligatorisch

Enthält die Angaben, wo die Ankertexte für die Unterschriften mit Datumsangaben sich im Dokument befinden

MultiDateSignedPageNumber (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiDateSignedPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiDateSignedPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen von Signaturen mit Datumsangabe

MultiPageNumber (string)

Text

Obligatorisch

Abgrenzungsliste für die Seitenzahlen, auf denen die Signaturen platziert werden.

MultiPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen der Signaturen

MultiPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen der Signaturen

MultiSignerCount (int)

Text

Obligatorisch

Anzahl der Mehrfach-Signaturen

MultiSignerEmail (string)

Text

Obligatorisch

Enthält die E-Mail-Adressen der Unterzeichner, z.B. peter.sanders@peters-engineering.net,brian.florent@peters-engineering.net.

MultiSignerName (string)

Text

Obligatorisch

Enthält die Namen der Personen, die das Dokument unterzeichnen sollen, z.B."Peter Sanders,Brian Florent".

  • 0 oder 1 bezeichnet die first Stelle

  • -1 die letzte Stelle

  • andere Ziffern Stellen dazwischen

MultiSignerPhoneNumber (string)

Text

Obligatorisch

Trennzeichenliste für Telefonnummern, die für die Authentifizierung per SMS verwendet wird.

MultiValueSeparator (string))

Text

Obligatorisch

Vermittelt dem Service, wie die Liste der Unterzeichner und deren Informationen getrennt wird. Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |

OrderedSignature (bool)

Text

Obligatorisch

Mit true werden die Unterschriften in der Reihenfolge abgearbeitet wie in den Feldern darüber festgelegt. Der erste Unterzeichner erhält eine Mail, signiert das Dokument, dann wird an den zweiten Unterzeichner eine E-Mail gesendet, dieser signiert ebenfalls usw. Mit false werden alle Unterzeichner gleichzeitig benachrichtigt und können in einer beliebigen Reihenfolge signieren. In beiden Fällen wird das Archiv erst aktualisiert, wenn alle Signaturen vorhanden sind.

PostSigningAction (string)

Text

Obligatorisch

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

String

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

  • True

  • False

Report Language (string)

Text

Obligatorisch für IncludeReport = True

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

  • de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SectionNumber (int)

Integer

Obligatorisch

Der Parameter bezieht sich auf geklammerte Dokumente. Die Indexzahl gibt an, welches der geklammerten Dokumente im Stapel unterzeichnet werden soll.

  • 0 oder 1 = erstes Dokument im Stapel

  • -1 = letztes Dokument

  • Andere Ziffern wie 2,3 etc.geben die jeweiligen Dokumente im Stapel an.

StatusFieldName (string)

Text

Obligatorisch

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.

SuccessStatusValue (string)

Text

Obligatorisch

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird

Token (string)

Text

Obligatorisch

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

AddNewDocumentMultiPositionsRemote

Ein Dokument kann von einer Person mit mehreren Signaturen und/oder Initialen unterzeichnet werden.

  • Die Informationen zum Unterzeichner und die Unterschriftspositionen im Dokument sind in einer Liste mit Trennzeichen enthalten.

  • Das Trennzeichen wird mit einem eigenen Parameter festgelegt.

  • In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet (siehe Parameter MultiValueSeparator).

  • Die Sortierung der Liste muss bei allen Parametern einheitlich sein.

  • Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.

Parameter

Variablentyp im Workflow

Beschreibung

Werte

DateSignedFieldName (string)

Text

Legt ein Indexfeld vom Dokument fest, in das das Datum der Unterzeichnung eingetragen wird. Es kann ein Text-, Datums- oder Datum/Uhrzeit-Feld sein.

Das Datum wird in UTC angegeben, wenn es sich um ein Textfeld handelt, wird das Datum in UTC angezeigt, wenn es sich um ein Datums- oder Datum/Uhrzeit-Feld handelt, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

  • Textfeld

  • Datumsfeld

  • Datum/Uhrzeit

DaysBeforeExpiration (int)

Integer

Setzt mit einem Wert von >0 eine Frist von Tagen für die Unterzeichnung. Wenn die Frist überschritten wird, gilt das Dokument als abgelehnt und wird aus dem VIDsigner Service gelöscht.

DocId (int)

Integer

ID vom zu unterzeichnenden Dokument

EmailLanguage (string)

Text

Sprache der E-Mail, sowie der Seite, auf der signiert wird. Ist dieser Wert leer, wird er standardmäßig auf en (Englisch) gesetzt.

br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh

EmailMessage (string)

Text

Text im E-Mail-Inhalt

EmailSubject (string)

Text

Betreff der gesendeten E-Mail

FailureStatusValue (string)

Text

Wert im Indexfeld, wenn die Signatur für ein Dokument abgelehnt wird (siehe SuccessStatusValue).

FileCabinetId (string)

Text

GUID vom Archiv, in dem das signierende Dokument gespeichert ist

IncludeReport (Boolean)

optional

Text

Mit „True" wird ein zweites PDF nach dem unterzeichneten Dokument mit Informationen zum Unterzeichner und zum Zertifikat eingefügt.

  • True

  • False

IssuerName (string)

Text

Anzeigename, der für den Absender der E-Mail und im Inhalt der E-Mail-Nachricht verwendet wird. Ist dieser Wert leer, wird standardmäßig der Namen der Organisation verwendet.

MultiAnchorText (string)

Text

Ankertext für die Platzierung der Mehrfach-Signatur

MultiAnchorTextOccurrence (string)

Text

Ankertertexte für mehrere Stellen, an denen unterschrieben werden soll.

MultiPageNumber (string)

Text

Trennzeichenliste für die Seitenzahlen, auf denen die Signaturen platziert werden.

MultiPositionX (string)

Text

Liste der X-Positionen für das Aufbringen der Signaturen

MultiPositionY (string)

Text

Liste der Y-Positionen für das Aufbringen der Signaturen

MultiSignatureCount (int)

Anzahl der angeforderten Unterschriften

MultiSizeX (string)

Text

Liste von Breiten für das Aufbringen von Signaturen

MultiSizeY (string)

Text

Liste von Höhen für das Aufbringen von Signaturen

MultiValueSeparator (string)

Text

Teilt dem dem Service mit, wie die Liste der Unterzeichner und deren Informationen getrennt wird. Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |

PostSigningAction (string)

Text

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientMayProvideNumber (Boolean)

Text

Wenn "true", ist die Telefonnummer optional und der Benutzer kann beim Unterzeichnen die Telefonnummer für die SMS eingeben.

RejectionReasonFieldName (string)

optional

Text

Legt ein Textfeld als Indexfeld fest. Der Benutzer kann für die Ablehnung einen Grund angeben, der dort eingetragen wird.

ReminderFrequencyHours (int)

Numeric

Sendet eine Erinnerung an den Unterzeichner. Der Wert legt fest, wie oft die Erinnerung gesendet wird, also z.B. alle 24 Stunden.

ReminderMaxRetries (int)

Numeric

Legt fest, wie viele Erinnerungen insgesamt gesendet werden, also zum Beispiel fünf Mal.

SectionNumber (int)

Integer

Die SectionNumber bezieht sich auf ein geklammertes Dokument, das aus mehreren Dateien besteht.

Es bezeichnet die Datei mit dem zu unterzeichnenden Dokument.

  • 0 oder 1 = erstes Dokument im Stapel

  • -1 = letztes Dokument

  • Andere Ziffern = weitere Dokumente

SendSignedDocument (Boolean)

Text

Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments.

  • True

  • False

SignerEmail (string)

Text

E-Mail-Adresse des unterzeichnenden Benutzers

SignerID (string)

Text

Erforderlich für die zentralisierte Signatur. Meist eine Ausweisnummer.
 
Für die biometrische oder Remote-Signatur ist die SignerID optional

SignerName (string)

Text

Name des unterzeichnenden Benutzers

SignerPhoneNumber (string)

Text

Telefonnummer, die für die Zwei-Faktor-Authentifizierung während des Signierungsvorgangs verwendet wird (internationales Rufnummernformat verwenden, z.B. +18455639045).

Für ein Demo-Abonnement wird keine SMS gesendet. Der Code lautet dann 12345.

StatusFieldName (string)

Text

Bezeichnet ein Indexfeld vom Dokument, das aktualisiert wird, wenn der Unterzeichner das Dokument unterzeichnet oder ablehnt.

SuccessStatusValue (string)

Text

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird (siehe auch SuccessFailureValue).

Token (string)

Text

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Das Token identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

AddNewClippedDocument

Ein geklammertes DocuWare Dokument mit mehreren Dateien kann von einer Person an mehreren Stellen unterzeichnet werden.

  • Die Informationen zum Unterzeichner und die Unterschriftspositionen im Dokument sind in einer Liste mit Trennzeichen enthalten.

  • Das Trennzeichen wird mit einem eigenen Parameter festgelegt.

  • In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet (siehe Parameter MultiValueSeparator).

  • Die Sortierung der Liste muss bei allen Parametern einheitlich sein.

  • Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.

Parameter

Workflow-Variable

Obligatorisch

Beschreibung

Werte

AccessCode (string)

Text

Obligatorisch für RecipientAuthenticationType = Access Code

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist. Dabei handelt es sich um den Zugangscode (ähnlich einem Kennwort), der für die Unterzeichnung des Dokuments erforderlich ist. Der Zugriffscode muss dem Unterzeichner in einem separaten Kommunikationskanal (z. B. per Telefon oder E-Mail) mitgeteilt werden..

DateSignedFieldName (string)

Text

Obligatorisch

Name des Datumsfelds, in das das Datum der Signatur eingetragen wird. Es kann ein Text-, Datums- oder Datetime-Feld sein. Das Datum wird in UTC angegeben. Handelt es sich um ein Textfeld, wird das Datum in UTC angezeigt. Handelt es sich um ein Datums- oder Datum/Uhrzeit-Feld, zeigt DocuWare das Datum im lokalen Format und in der lokalen Zeitzone an.

DaysBeforeExpiration (int)

Integer

Obligatorisch

Wenn der angegebene Wert größer als 0 ist, gilt eine Frist von dieser Anzahl von Tagen, bevor das Dokument abläuft. Wird die Frist überschritten, wird das Dokument als abgelehnt betrachtet. Es wird aus dem DocuSign-Dienst gelöscht und der Unterzeichner kann es nicht mehr signieren.

DocId (int)

Integer

Obligatorisch

ID vom zu unterzeichnenden Dokument

EmailMessage (string)

Text

Obligatorisch

Text, der im Inhalt der E-Mail angezeigt wird

EmailSubject (string)

Text

Obligatorisch

Betreff der E-Mail

FailureStatusValue (string)

Text

Obligatorisch

Wert im Indexfeld, wenn die Signatur für ein Dokument in DocuSign abgelehnt wird.

FileCabinetId (string)

Text

Obligatorisch

GUID vom Archiv mit dem zu signierenden Dokument

IncludeReport (boolean)

Text

Optional

Wenn Sie den Wert auf „true" setzen, wird nach dem signierten Dokument ein zweites PDF an das Dokument angehängt. Dieses PDF enthält Informationen über den Unterzeichner und das digitale Zertifikat, das dem Dokument hinzugefügt wurde.

  • True

  • False

MultiAnchorText (string)

Text

Obligatorisch

Text, nach dem der Dienst auf dem Dokument suchen kann. Wenn er angegeben und nicht gefunden wird, tritt ein Fehler auf. Wenn nicht angegeben, sind die nachfolgenden Positionsinformationen absolut und nicht relativ, um ein Textstück zu finden.

MultiAnchorTextOccurrence (string)

Text

Obligatorisch

Enthält das Vorkommen des Ankertextes (d. h. das erste, zweite oder dritte Mal usw., dass der Text im Dokument vorkommt) für die verschiedenen Ausgangsorte..

MultiPageNumber (string)

Text

Obligatorisch

Trennzeichenliste für die Seitenzahlen, auf denen die Signaturen platziert werden

MultiPositionX (string)

Text

Obligatorisch

Liste der X-Positionen für das Aufbringen der Signaturen

MultiPositionY (string)

Text

Obligatorisch

Liste der Y-Positionen für das Aufbringen der Signaturen

MultiSectionCount (int)

Integer

Obligatorisch

Anzahl der Tabs mit Initialen. die auf dem Dokument aufgebracht werden sollen

MultiSectionNumber (string)

Text

Obligatorisch

Enthält eine abgegrenzte Liste von Bereichen, in denen sich die Signaturen befinden

MultiValueSeparator (string)

Text

Obligatorisch

Vermittelt dem Signature Service, wie die Liste der Unterzeichner und deren Informationen getrennt wird. Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |.

PhoneNumber (string)

String

Obligatorisch

Telefonnummer für die Zwei-Faktor-Authentifizierung (internationales Nummernformat, z.B. +18455639045)

PostSigningAction (string)

Text

Obligatorisch

Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Spezifiziert im Workflow, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

String

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Nur für die Authentifizerung per Telefon. Mit „true" werden alle vom Benutzer gesetzten Werte ignoriert. Erst beim Signieren kann der Unterzeichner eine Telefonnummer eingeben, unter der ihm der Zugangscode mitgeteilt wird.

  • True

  • False

Report Language (string)

String

Obligatorisch für IncludeReport = True

Optional, kann nur angegeben werden, wenn IncludeReport auf "true" gesetzt ist. Er stellt sicher, dass der generierte Bericht, der an die signierte Datei angehängt wird, in der gewünschten Sprache vorliegt.

  • de, en. es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH,zh_TW

SignerEmail (string)

Text

Obligatorisch

E-Mail-Adresse des unterzeichnenden Benutzers

SignerName (string)

Text

Obligatorisch

Name des unterzeichnenden Benutzers

StatusFieldName (string)

Text

Obligatorisch

Legt ein Indexfeld vom Dokument fest, dessen Wert verändert wird, wenn das Dokument unterzeichnet oder abgelehnt ist.

SuccessStatusValue (string)

Text

Obligatorisch

Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird

Token (string)

Text

Obligatorisch

Kunde erhält Token bei der Anmeldung bei DocuSign. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

Rücknahme der Signaturanforderung

Diese Methode stellt kein Signaturverfahren dar, sondern ermöglicht bei jedem Verfahren die Rücknahme einer Signaturanforderung, zum Beispiel, wenn aus Versehen das falsche Dokument übermittelt wurde.

DeleteUnsignedDocuments

Parametername

Variablentyp im Worflow

Beschreibung

DocId (int)

Integer

ID vom zu unterzeichnenden Dokument

FileCabinetId (string)

Text

GUID vom Archiv, in dem das signierende Dokument gespeichert ist

Token (string)

Text

Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt. Es identifiziert die Kundenorganisation und stellt die Logindaten des Benutzers bereit.

Nach der Signatur  

Nachdem die unterzeichnende Person das Dokument signiert oder abgelehnt hat, benachrichtigt DocuSign den DocuWare Signature Service, der das Dokument von DocuSign lädt. Der Parameter "PostSigningAction" bestimmt, wie das Dokument behandelt wird, zum Beispiel, ob es geklammert oder durch die neue Datei ersetzt wird.

  • Wenn das Dokument signiert wurde, schreibt der DocuWare Signature Service über den Parameter “SuccessStatusValue” eine entsprechenden Wert, wie zum Beispiel "Signed".

  • Wenn das Dokument abgelehnt wurde, verwendet der Signature Service den Parameter “FailedStatusValue”, um in das Feld "StatusField" zum Beispiel “Rejected” zu schreiben.

Danach kann der Workflow fortgesetzt werden. Der Signature Serivce entfernt das Dokument aus DocuSign.