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

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

Verfahren: Damit eine Person ein Dokument signieren kann, muss der Name, die E-Mail-Adresse und eine SMS-fähige Telefonnummer bekannt sein. Diese Informationen werden vom Workflow an DocuSign übergeben um eine Signatur anzufordern. Die unterzeichnende Person erhält eine E-Mail mit dem Link zum Dokument. Je nach Authentifizierungsverfahren kann die unterzeichnende Person dann die Signatur auslösen.

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.

Folgende Methoden stehen bei der Remote-Signatur mit DocuSign zur Verfügung:

  • AddNewDocumentRemote

    Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an einer Position angebracht.

  • AddNewDocumentMultiSigners

    Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch mehrere Personen geschickt. Die Signaturen werden an mehreren Positionen angebracht.

  • AddNewDocumentMultiPositionsRemote

    Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.

  • AddNewClippedDocument
    Mit dieser Methode werden mehrere Dateien eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.

Methode

Beschreibung

Dateien

Unterzeichner

Signaturpositionen

AddNewDocumentRemote

Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an einer Position angebracht.

1

1

1

AddNewDocumentMultiSigners

Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch mehrere Personen geschickt. Die Signaturen werden an mehreren Positionen angebracht.

1

mehrere

mehrere

AddNewDocumentMultiPositionsRemote

Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.

1

1

mehrere

AddNewClippedDocument

Mit dieser Methode werden mehrere Dateien eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.

mehrere

1

mehrere

AddNewDocumentRemote

Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an einer Position angebracht.

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

Parametername

Kategorie

Workflow-Variablen-Typ

Beschreibung

Werte

Token (string)

Allgemein

Text

Mit dem Token identifiziert sich der Workflow am Signature Service. Das Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt.

DateSignedFieldName (string)

Felder

Text

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

Ist das Feld ein Textfeld, wird das Datum in UTC eingetragen und in DocuWare angezeigt.

Wir empfehlen ein Feld vom Type Datum  oder Datum/Uhrzeit zu verwenden, damit das Datum und die Uhrzeit in der lokalen Zeitzone und lokalen Format angezeigt wird.

StatusFieldName (string)

Felder

Text

Legt ein Indexfeld fest, in das der Status einer Signatur  eingetragen wird. Es wird dabei mit "SuccessStatusValue" oder "FailureStatusValue" gefüllt. Dieses Feld eignet sich hervorragend um den Workflownach der Signatur weiterlaufen zu lassen.

SuccessStatusValue (string)

Felder

Text

Wert, der nach einer erfolgreichen Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

FailureStatusValue (string)

Felder

Text

Wert, der nach einer fehlerhaften Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

RejectionReasonFieldName (string)

Optional

Felder

Text

Legt ein Indexfeld fest in das der Ablehnungsgrund eingetragen wird, wenn ein Unterzeichner die Signatur abgelehnt hat.

DaysBeforeExpiration (int)

Prozeß

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 steht nicht mehr zur Signatur zur Verfügung.

PostSigningAction (string)

Prozeß

Text

Legt fest, wie das signierte Dokument in DocuWare gespeichert wird, dabei kann entweder das Orginialdokument überschrieben werden, oder das signierte Dokument vorne oder hinten an das Originaldokument geclippt werden.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Prozeß

String

Legt fest, ob zusätzlich zum signierten Dokument ein Bericht mit Informationen zum Unterzeichner und zum Signaturprozess an das Dokument angehängt wird. Dieser Bericht ist eine separate PDF-Datei.

  • True

  • False

ReportLanguage (string)

Obligatorisch für IncludeReport = True

Prozeß

Text

Legt bei “IncludeReport = True" fest, in welcher Sprache der Report erzeugt und angehängt wird.

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

IncludeDateSigned (boolean)

optional

Prozeß

String

Legt fest, ob das Unterschriftsdatum in das Dokument aufgenommen wird. Die Parameter zur Position des Unterschriftsdatums sind dann obligatorisch.

  • True

  • false

RecipientAuthenticationType (string)

Prozeß

Text

Legt fest, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

FileCabinetId (string)

Dokument

Text

Legt das Archiv anhand der GUID fest, in dem das zu signierende Dokument gespeichert ist. Die GUID wird in der Archivverwaltung angezeigt.

DocId (int)

Dokument

Integer

Legt das zu unterzeichnende Dokument anhand der DocID fest.

SectionNumber (int)

Position

Integer

Legt die Datei (Section) eines geklammerten Dokuments fest die signiert werden soll.

  • 0 oder 1 = erste Datei im Dokument

  • -1 = letzte Datei

  • Andere Zahl = weitere Dateien

PageNumber (int)

Position

Integer

Legt die Seitennummer im Dokument fest, auf der die Signatur platziert wird.

Falls ein Ankertext verwendet wird, legt der Parameter die Seite fest, ab der der Ankertext gesucht wird.

AnchorText (string)

Position

Text

Legt einen Text fest, der als Bezugspunkt für die Signaturposition verwendet wird.

Wird keine Angabe gemacht, ist der Bezugspunkt die linke obere Ecke der Seite.

AnchorTextOccurrence (int)

Position

Integer

Wenn der Ankertext mehrfach im Dokument auftritt, legt dieser Parameter fest, welche Stelle zur Positionsberechnung verwendet wird.

  • 0 oder 1 = erste Stelle mit dem Ankertext

  • -1 = letzte Stelle

  • Andere Zahl = weitere Stellen

PositionX (int)

Position

Integer

Legt die horizontale Position der Signatur fest. Bezugslinie ist der linke Seitenrand oder (bei Verwendung eines Ankertextes) der linke Rand des gefundenen Textes.

Positive Zahlen stehen rechts, negative Zahlen links der Bezugslinie. Die Angaben sind in Millimeter.

PositionY (int)

Position

Integer

Legt die vertikale Position der Signatur fest. Bezugslinie ist der obere Seitenrand oder (bei Verwendung eines Ankertextes) der obere Rand des gefundenen Textes.

Positive Zahlen stehen unterhalb, negative Zahlen oberhalb der Bezugslinie. Die Angaben sind in Millimeter.

DateSignedPageNumber (int)

optional

Position

Integer

Legt die Seitennummer im Dokument fest, auf der das Datum platziert wird.

Falls ein Ankertext verwendet wird, legt der Parameter die Seite fest, ab der der Ankertext gesucht wird.

  • 0 oder 1 = erste Seite der Datei

  • -1 = letzte Seite

  • Andere Zahl = weitere Seiten

DateSignedAnchorText (string)

optional

Position

String

Legt einen Text fest, der als Bezugspunkt für die Datumsposition verwendet wird.

Wird keine Angabe gemacht, ist der Bezugspunkt die linke obere Ecke der Seite.

DateSignedAnchorTextOccurrence (int)

optional

Position

Integer

Wenn der Ankertext mehrfach im Dokument auftritt, legt dieser Parameter fest, welche Stelle zur Positionsberechnung verwendet wird.

  • 0 oder 1 = erste Stelle mit dem Ankertext

  • -1 = letzte Stelle

  • Andere Zahl = weitere Stellen

DateSignedPositionX (int)

Position

Integer

Legt die horizontale Position des Datums fest. Bezugslinie ist der linke Seitenrand oder (bei Verwendung eines Ankertextes) der linke Rand des gefundenen Textes.

Positive Zahlen stehen rechts, negative Zahlen links der Bezugslinie. Die Angaben sind in Millimeter.

DateSignedPositionY (int)

Position

Integer

Legt die vertikale Position des Datums fest. Bezugslinie ist der obere Seitenrand oder (bei Verwendung eines Ankertextes) der obere Rand des gefundenen Textes.

Positive Zahlen stehen unterhalb, negative Zahlen oberhalb der Bezugslinie. Die Angaben sind in Millimeter.

SignerName (string)

Unterzeichner

Text

Legt den Namen des unterzeichnenden Benutzers fest.

SignerEmail (string)

Unterzeichner

Text

Legt die E-Mail-Adresse des unterzeichnenden Benutzers fest.

PhoneNumber (string)

Unterzeichner

String

Legt die Telefonnummer des Unterzeichners für die Zwei-Faktor-Authentifizierung fest. Die Telefonnummer muss SMS-Nachrichten empfangen können und im internationalen Rufnummernformat (z.B. +18455639045) angegeben sein.

RecipientMayProvideNumber (Boolean)

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Unterzeichner

Text

Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann.

  • True

  • False

AccessCode (string)

Obligatorisch für RecipientAuthenticationType = Access Code

Unterzeichner

Text

Legt einen Zugangscode für die Unterzeichnung des Dokuments fest. Der Zugangscode muss dem Unterzeichner in einem separaten Kommunikationskanal  mitgeteilt werden.

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist.

EmailSubject (string)

Unterzeichner

Text

Legt den Betreff der Benachrichtigungsmail fest.

EmailMessage (string)

Unterzeichner

Text

Legt einen Text fest, der im Inhalt der Benachrichtigungsmail angezeigt wird.


AddNewDocumentMultiSigners

Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch mehrere Personen geschickt. Die Signaturen werden an mehreren Positionen angebracht.

  • Die Informationen zu den Unterzeichnern 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).

  • In den Listenparametern muss die Reihenfolge und die Anzahl der Werte, die durch “MultiValueSeparator” getrennt sind, identisch sein.

  • Das Archiv wird aktualisiert, nachdem alle Personen das Dokument bearbeitet haben.

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

Parametername

Kategorie

Workflow-Variablen-Typ

Beschreibung

Werte

Token (string)

Allgemein

Text

Mit dem Token identifiziert sich der Workflow am Signature Service. Das Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt.

DateSignedFieldName (string)

Felder

Text

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

Ist das Feld ein Textfeld, wird das Datum in UTC eingetragen und in DocuWare angezeigt.

Wir empfehlen ein Feld vom Type Datum  oder Datum/Uhrzeit zu verwenden, damit das Datum und die Uhrzeit in der lokalen Zeitzone und lokalen Format angezeigt wird.

StatusFieldName (string)

Felder

Text

Legt ein Indexfeld fest, in das der Status einer Signatur  eingetragen wird. Es wird dabei mit "SuccessStatusValue" oder "FailureStatusValue" gefüllt. Dieses Feld eignet sich hervorragend um den Workflownach der Signatur weiterlaufen zu lassen.

SuccessStatusValue (string)

Felder

Text

Wert, der nach einer erfolgreichen Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

FailureStatusValue (string)

Felder

Text

Wert, der nach einer fehlerhaften Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

RejectionReasonFieldName (string)

Optional

Felder

Text

Legt ein Indexfeld fest in das der Ablehnungsgrund eingetragen wird, wenn ein Unterzeichner die Signatur abgelehnt hat.

DaysBeforeExpiration (int)

Prozeß

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 steht nicht mehr zur Signatur zur Verfügung.

PostSigningAction (string)

Prozeß

Text

Legt fest, wie das signierte Dokument in DocuWare gespeichert wird, dabei kann entweder das Orginialdokument überschrieben werden, oder das signierte Dokument vorne oder hinten an das Originaldokument geclippt werden.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Prozeß

String

Legt fest, ob zusätzlich zum signierten Dokument ein Bericht mit Informationen zum Unterzeichner und zum Signaturprozess an das Dokument angehängt wird. Dieser Bericht ist eine separate PDF-Datei.

  • True

  • False

ReportLanguage (string)

Obligatorisch für IncludeReport = True

Prozeß

Text

Legt bei “IncludeReport = True" fest, in welcher Sprache der Report erzeugt und angehängt wird.

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

IncludeDateSigned (boolean)

optional

Prozeß

String

Legt fest, ob das Unterschriftsdatum in das Dokument aufgenommen wird. Die Parameter zur Position des Unterschriftsdatums sind dann obligatorisch.

  • True

  • false

RecipientAuthenticationType (string)

Prozeß

Text

Legt fest, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

MultiValueSeparator (string))

Prozeß

Text

Legt fest, wie mehrere Werte in einem Parameter voneinander getrennt werden.

Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |

MultiSignerCount (int)

Prozeß

Text

Anzahl der Unterzeichner

OrderedSignature (bool)

Prozeß

Text

Legt fest, ob die Unterzeichner in einer festgelegten Reihenfolge oder gleichzeitig informiert werden.

Das Dokument im DocuWare Archiv wird erst aktualisiert, wenn alle Unterzeichner das Dokument signiert haben.

FileCabinetId (string)

Dokument

Text

Legt das Archiv anhand der GUID fest, in dem das zu signierende Dokument gespeichert ist. Die GUID wird in der Archivverwaltung angezeigt.

DocId (int)

Dokument

Integer

Legt das zu unterzeichnende Dokument anhand der DocID fest.

SectionNumber (int)

Position

Integer

Legt die Datei (Section) eines geklammerten Dokuments fest die signiert werden soll.

  • 0 oder 1 = erste Datei im Dokument

  • -1 = letzte Datei

  • Andere Zahl = weitere Dateien

MultiPageNumber (string)

Position

Text

Liste von mehreren "PageNumber" getrennt mit "MultiValueSeparator".

MultiAnchorText (string)

Position

Text

Liste von mehreren "AnchorText" getrennt mit "MultiValueSeparator".

MultiAnchorTextOccurrence (string)

Position

Text

Liste von mehreren "AnchorTextOccurence" getrennt mit "MultiValueSeparator".

MultiPositionX (string)

Text

Liste von mehreren "PositionX" getrennt mit "MultiValueSeparator".

MultiPositionY (string)

Text

Liste von mehreren "PositionY" getrennt mit "MultiValueSeparator".

MultiDateSignedPageNumber (string)

Text

Liste von mehreren "DateSignedPageNumber" getrennt mit "MultiValueSeparator".

MultiDateSignedAnchorText (string)

Text

Liste von mehreren "DateSignedAnchorText" getrennt mit "MultiValueSeparator".

MultiDateSignedAnchorTextOccurrence (string)

Text

Liste von mehreren "DateSignedAnchorTextOccurence" getrennt mit "MultiValueSeparator".

MultiDateSignedPositionX (string)

Text

Liste von mehreren "DateSignedPositionX" getrennt mit "MultiValueSeparator".

MultiDateSignedPositionY (string)

Text

Liste von mehreren "DateSignedPositionY" getrennt mit "MultiValueSeparator".

MultiSignerName (string)

Text

Liste von mehreren "SignerName" getrennt mit "MultiValueSeparator".

MultiSignerEmail (string)

Text

Liste von mehreren "SignerEmail" getrennt mit "MultiValueSeparator".

MultiSignerPhoneNumber (string)

Text

Liste von mehreren "PhoneNumber" getrennt mit "MultiValueSeparator".

RecipientMayProvideNumber (Boolean)

Obligatorisch für RecipientAuthenticationType = Phone or SMS

String

Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann.

  • True

  • False

AccessCode (string)
Obligatorisch für RecipientAuthenticationType = Access Code

Unterzeichner

Text

Legt einen Zugangscode für die Unterzeichnung des Dokuments fest. Der Zugangscode muss dem Unterzeichner in einem separaten Kommunikationskanal  mitgeteilt werden.

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist.

EmailSubject (string)

Text

Legt den Betreff der Benachrichtigungsmail fest.

EmailMessage (string)

Text

Legt einen Text fest, der im Inhalt der Benachrichtigungsmail angezeigt wird.

AddNewDocumentMultiPositionsRemote

Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signaturen werden an mehreren Positionen angebracht.

  • Die Informationen zu den Unterzeichnern 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).

  • In den Listenparametern muss die Reihenfolge und die Anzahl der Werte, die durch “MultiValueSeparator” getrennt sind, identisch sein.

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

Parameter

Kategorie

Workflow-Variablen-Typ

Beschreibung

Werte

Token (string)

Allgemein

Text

Mit dem Token identifiziert sich der Workflow am Signature Service. Das Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt.

DateSignedFieldName (string)

Felder

Text

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

Ist das Feld ein Textfeld, wird das Datum in UTC eingetragen und in DocuWare angezeigt.

Wir empfehlen ein Feld vom Type Datum  oder Datum/Uhrzeit zu verwenden, damit das Datum und die Uhrzeit in der lokalen Zeitzone und lokalen Format angezeigt wird.

StatusFieldName (string)

Felder

Text

Legt ein Indexfeld fest, in das der Status einer Signatur  eingetragen wird. Es wird dabei mit "SuccessStatusValue" oder "FailureStatusValue" gefüllt. Dieses Feld eignet sich hervorragend um den Workflownach der Signatur weiterlaufen zu lassen.

SuccessStatusValue (string)

Felder

Text

Wert, der nach einer erfolgreichen Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

FailureStatusValue (string)

Felder

Text

Wert, der nach einer fehlerhaften Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

RejectionReasonFieldName (string)

Optional

Felder

Text

Legt ein Indexfeld fest in das der Ablehnungsgrund eingetragen wird, wenn ein Unterzeichner die Signatur abgelehnt hat.

DaysBeforeExpiration (int)

Prozeß

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 steht nicht mehr zur Signatur zur Verfügung.

PostSigningAction (string)

Prozeß

Text

Legt fest, wie das signierte Dokument in DocuWare gespeichert wird, dabei kann entweder das Orginialdokument überschrieben werden, oder das signierte Dokument vorne oder hinten an das Originaldokument geclippt werden.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Prozeß

String

Legt fest, ob zusätzlich zum signierten Dokument ein Bericht mit Informationen zum Unterzeichner und zum Signaturprozess an das Dokument angehängt wird. Dieser Bericht ist eine separate PDF-Datei.

  • True

  • False

ReportLanguage (string)

Obligatorisch für IncludeReport = True

Prozeß

Text

Legt bei “IncludeReport = True" fest, in welcher Sprache der Report erzeugt und angehängt wird.

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

RecipientAuthenticationType (string)

Prozeß

Text

Legt fest, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

MultiValueSeparator (string))

Prozeß

Text

Legt fest, wie mehrere Werte in einem Parameter voneinander getrennt werden.

Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |

MultiSignatureCount (int)

Prozeß

Integer

Anzahl der Signaturpositionen

MultiDateSignedCount (int)

Prozeß

Integer

Anzahl der Datumspositionen

MultiInitialCount (int)

Prozeß

Integer

Anzahl der Initialienpositionen

FileCabinetId (string)

Dokument

Text

Legt das Archiv anhand der GUID fest, in dem das zu signierende Dokument gespeichert ist. Die GUID wird in der Archivverwaltung angezeigt.

DocId (int)

Dokument

Integer

Legt das zu unterzeichnende Dokument anhand der DocID fest.

SectionNumber (int)

Position

Integer

Legt die Datei (Section) eines geklammerten Dokuments fest die signiert werden soll.

  • 0 oder 1 = erste Datei im Dokument

  • -1 = letzte Datei

  • Andere Zahl = weitere Dateien

MultiSignaturePageNumber (string)

Position

String

Liste von mehreren "PageNumber" getrennt mit "MultiValueSeparator".

MultiSignatureAnchorText (string)

Position

String

Liste von mehreren "AnchorText" getrennt mit "MultiValueSeparator".

MultiSignatureAnchorTextOccurence (string)

Position

String

Liste von mehreren "SignatureAnchorTextOccurence" getrennt mit "MultiValueSeparator".

MultiSignaturePositionX (string)

Position

String

Liste von mehreren "PositionX" getrennt mit "MultiValueSeparator".

MultiSignaturePositionY (string)

Position

String

Liste von mehreren "PositionY" getrennt mit "MultiValueSeparator".

MultiDateSignedPageNumber (string)

Position

String

Liste von mehreren "DateSignedPageNumber" getrennt mit "MultiValueSeparator".

MultiDateSignedAnchorText (string)

Position

String

Liste von mehreren "DateSignedAnchorText" getrennt mit "MultiValueSeparator".

MultiDateSignedAnchorTextOccurence (string)

Position

String

Liste von mehreren "DateSignedAnchorTextOccurence" getrennt mit "MultiValueSeparator".

MultiDateSignedPositionX (string)

Position

String

Liste von mehreren "DateSignedPositionX" getrennt mit "MultiValueSeparator".

MultiDateSignedPositionY (string)

Position

String

Liste von mehreren "DateSignedPositionY" getrennt mit "MultiValueSeparator".

MultiInitialPageNumber (string)

Position

String

Liste von mehreren Seitennummern, die die Initialen des Unterzeichners enthalten.

MultiInitialAnchorText (string)

Position

String

Legt einen Text fest, der als Bezugspunkt für die Initialenposition verwendet wird.

Wird keine Angabe gemacht, ist der Bezugspunkt die linke obere Ecke der Seite.

MultiInitialAnchorTextOccurence (string)

Position

String

Liste von mehreren "MultiInitialAnchorText" getrennt mit "MultiValueSeparator".

MultiInitialPositionX (string)

Position

String

Liste von mehreren horizontalen Positionen für die Intialen des Unterzeichners

MultiInitialPositionY (string)

Position

String

Liste von mehreren vertikalen Positionen für die Intialen des Unterzeichners

SignerName (string)

Text

Legt den Namen des unterzeichnenden Benutzers fest.

Nicht notwendig, wenn "SignerNameEditable" aktiviert ist.

SignerEmail (string)

Text

Legt die E-Mail-Adresse des unterzeichnenden Benutzers fest.

PhoneNumber (string)

Text

Legt die Telefonnummer des Unterzeichners für die Zwei-Faktor-Authentifizierung fest. Die Telefonnummer muss SMS-Nachrichten empfangen können und im internationalen Rufnummernformat (z.B. +18455639045) angegeben sein.

RecipientMayProvideNumber (Boolean)

Text

Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann.

AccessCode (string)

Obligatorisch für RecipientAuthenticationType = Access Code

Unterzeichner

Text

Legt einen Zugangscode für die Unterzeichnung des Dokuments fest. Der Zugangscode muss dem Unterzeichner in einem separaten Kommunikationskanal  mitgeteilt werden.

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist.

EmailSubject (string)

Unterzeichner

Text

Legt den Betreff der Benachrichtigungsmail fest.

EmailMessage (string)

Unterzeichner

Text

Legt einen Text fest, der im Inhalt der Benachrichtigungsmail angezeigt wird.

AddNewClippedDocument

Mit dieser Methode werden mehrere Dateien eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.

  • Die Informationen zu den Unterzeichnern 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).

  • In den Listenparametern muss die Reihenfolge und die Anzahl der Werte, die durch “MultiValueSeparator” getrennt sind, identisch sein.

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

Parameter

Kategorie

Workflow-Variablen-Typ

Beschreibung

Werte

Token (string)

Allgemein

Text

Mit dem Token identifiziert sich der Workflow am Signature Service. Das Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt.

DateSignedFieldName (string)

Felder

Text

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

Ist das Feld ein Textfeld, wird das Datum in UTC eingetragen und in DocuWare angezeigt.

Wir empfehlen ein Feld vom Type Datum  oder Datum/Uhrzeit zu verwenden, damit das Datum und die Uhrzeit in der lokalen Zeitzone und lokalen Format angezeigt wird.

StatusFieldName (string)

Felder

Text

Legt ein Indexfeld fest, in das der Status einer Signatur  eingetragen wird. Es wird dabei mit "SuccessStatusValue" oder "FailureStatusValue" gefüllt. Dieses Feld eignet sich hervorragend um den Workflownach der Signatur weiterlaufen zu lassen.

SuccessStatusValue (string)

Felder

Text

Wert, der nach einer erfolgreichen Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

FailureStatusValue (string)

Felder

Text

Wert, der nach einer fehlerhaften Signatur in das in "StatusFieldName" definierte Indexfeld gesetzt wird.

RejectionReasonFieldName (string)

Optional

Felder

Text

Legt ein Indexfeld fest in das der Ablehnungsgrund eingetragen wird, wenn ein Unterzeichner die Signatur abgelehnt hat.

DaysBeforeExpiration (int)

Prozeß

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 steht nicht mehr zur Signatur zur Verfügung.

PostSigningAction (string)

Prozeß

Text

Legt fest, wie das signierte Dokument in DocuWare gespeichert wird, dabei kann entweder das Orginialdokument überschrieben werden, oder das signierte Dokument vorne oder hinten an das Originaldokument geclippt werden.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Prozeß

String

Legt fest, ob zusätzlich zum signierten Dokument ein Bericht mit Informationen zum Unterzeichner und zum Signaturprozess an das Dokument angehängt wird. Dieser Bericht ist eine separate PDF-Datei.

  • True

  • False

ReportLanguage (string)

Obligatorisch für IncludeReport = True

Prozeß

Text

Legt bei “IncludeReport = True" fest, in welcher Sprache der Report erzeugt und angehängt wird.

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

IncludeDateSigned (boolean)

optional

Prozeß

String

Legt fest, ob das Unterschriftsdatum in das Dokument aufgenommen wird. Die Parameter zur Position des Unterschriftsdatums sind dann obligatorisch.

  • True

  • false

RecipientAuthenticationType (string)

Prozeß

Text

Legt fest, welche Authentifizierung in DocuSign erforderlich ist

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

MultiValueSeparator (string))

Prozeß

Text

Legt fest, wie mehrere Werte in einem Parameter voneinander getrennt werden.

Üblich sind Komma, eine Einfügemarke ^ oder ein senkrechter Strich |

MultiSectionCount (int)

Prozeß

Integer

Anzahl der zu unterzeichnenden Dateien eines DocuWare Dokuments

FileCabinetId (string)

Dokument

Text

Legt das Archiv anhand der GUID fest, in dem das zu signierende Dokument gespeichert ist. Die GUID wird in der Archivverwaltung angezeigt.

DocId (int)

Dokument

Integer

Legt das zu unterzeichnende Dokument anhand der DocID fest.

MultiSectionNumber (string)

Position

Text

Liste von mehreren "SectionNumber" getrennt mit "MultiValueSeparator".

MultiAnchorText (string)

Position

Text

Liste von mehreren "AnchorText" getrennt mit "MultiValueSeparator".

MultiAnchorTextOccurrence (string)

Position

Text

Liste von mehreren "AnchorTextOccurence" getrennt mit "MultiValueSeparator".

MultiPositionX (string)

Position

Text

Liste von mehreren "PositionX" getrennt mit "MultiValueSeparator".

MultiPositionY (string)

Position

Text

Liste von mehreren "PositionY" getrennt mit "MultiValueSeparator".

SignerName (string)

Unterzeichner

Text

Legt den Namen des unterzeichnenden Benutzers fest.

SignerEmail (string)

Unterzeichner

Text

Legt die E-Mail-Adresse des unterzeichnenden Benutzers fest.

PhoneNumber (string)

Unterzeichner

String

Legt die Telefonnummer des Unterzeichners für die Zwei-Faktor-Authentifizierung fest. Die Telefonnummer muss SMS-Nachrichten empfangen können und im internationalen Rufnummernformat (z.B. +18455639045) angegeben sein.

RecipientMayProvideNumber (Boolean)

Obligatorisch für RecipientAuthenticationType = Phone or SMS

Unterzeichner

Text

Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann.

  • True

  • False

AccessCode (string)

Obligatorisch für RecipientAuthenticationType = Access Code

Unterzeichner

Text

Legt einen Zugangscode für die Unterzeichnung des Dokuments fest. Der Zugangscode muss dem Unterzeichner in einem separaten Kommunikationskanal  mitgeteilt werden.

Erforderlich, wenn der Authentifizierungstyp "AccessCode" ist.

EmailSubject (string)

Unterzeichner

Text

Legt den Betreff der Benachrichtigungsmail fest.

EmailMessage (string)

Unterzeichner

Text

Legt einen Text fest, der im Inhalt der Benachrichtigungsmail angezeigt wird.

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

Token (string)

Text

Mit dem Token identifiziert sich der Workflow am Signature Service. Das Token wird bei der Registrierung des Signature Service erstellt und per Mail zugeschickt.

FileCabinetId (string)

Text

Legt das Archiv anhand der GUID fest, in dem das zu signierende Dokument gespeichert ist. Die GUID wird in der Archivverwaltung angezeigt.

DocId (int)

Integer

Legt das zu unterzeichnende Dokument anhand der DocID fest.

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.