Damit eine Person ein Dokument in einem Workflow mit dem Remote-Verfahren von Validated ID signieren kann, müssen der Name, die E-Mail-Adresse und eine SMS-fähige Telefonnummer der unterzeichnenden Person bekannt sein.
Diese Informationen werden vom Workflow automatisch bei der Signaturanforderung an Validated ID übergeben. Die unterzeichnende Person erhält eine E-Mail mit dem Link zum Dokument sowie eine SMS mit einer TAN, die sie zum Auslösen der Signatur verwendet.
Dieses Signaturverfahren von Validated ID hat den Sicherheitslevel fortgeschritten.
Für die unterzeichnende Person ist bei diesem Verfahren keine Registrierung bei Validated ID erforderlich.
Lesen Sie allgemeine Informationen zu den Service-Methoden und Parameter mit Validated ID.
Folgende Methoden stehen bei der Remote-Signatur 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.
AddNewDocumentMultiRemote
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.
AddNewClippedDocumentRemote
Mit dieser Methode werden mehrere Dateien eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.
Zur Übersicht finden Sie hier die gleichen Methoden und Informationen in Tabellenform:
Methode | Beschreibung | Dateien | Unter-zeichner | Signatur- |
|---|---|---|---|---|
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 |
AddNewDocumentMultiRemote | Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch mehrere Personen geschickt. Die Signaturen werden an mehreren Positionen angebracht. | 1 | mehrere | mehrere |
AddNewDocumentPositionsRemote | Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht. | 1 | 1 | mehrere |
AddNewClippedDocumentRemote | 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.
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 im Indexfeld, wenn die Signatur für ein Dokument abgelehnt wird (siehe SuccessStatusValue). | ||
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. | ||
ReminderFrequencyHours (int) | Prozeß | Integer | Sendet eine Erinnerung an den Unterzeichner. Der Wert legt fest, in welchem Intervall die Erinnerung gesendet wird. Ein üblicher Wert sind z.B. 24 Stunden. | ||
ReminderMaxRetries (int) | Prozeß | Integer | Legt fest, wie viele Erinnerungen im Abstand von "ReminderFrequencyHours" insgesamt gesendet werden. | ||
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. |
| |
AllowSignatureDelegation (Boolean) | Prozeß | Text | Legt fest, ob der ursprünglich im Workflow definierte Unterzeichner das Dokument zur Signatur an eine weitere Person weiterleiten kann. Die Signatur wird damit an den neuen Unterzeichner delegiert. |
| |
SendSignedDocument (Boolean) | Prozeß | Text | Legt fest, ob das signierte Dokument per Mail an den Unterzeichner gesendet wird. |
| |
IncludeReport (Boolean) optional | Prozeß | Text | 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. |
| |
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. |
| |
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. |
| |
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. | ||
SizeX (int) | Position | Integer | Legt die Breite des Signaturbildes in Millimeter fest. | ||
SizeY (int) | Position | Integer | Legt die Höhe des Signaturbildes in Millimeter fest. | ||
SignerName (string) | Unterzeichner | Text | Legt den Namen des unterzeichnenden Benutzers fest. Nicht notwendig, wenn "SignerNameEditable" aktiviert ist. | ||
SignerNameEditable (Boolean) | Unterzeichner | Text | Legt fest, ob der Unterzeichner den Namen während der Signatur ändern kann. | ||
SignerEmail (string) | Unterzeichner | Text | Legt die E-Mail-Adresse des unterzeichnenden Benutzers fest. | ||
SignerPhoneNumber (string) | Unterzeichner | 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) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann. | ||
SignerID (string) | Unterzeichner | Text | Legt eine ID-Nummer (z.B. Ausweisnummer) des Unterzeichners fest. Notwendig bei der zentralisierten Signatur und dem Firmenstempel, optional bei Remote-Signatur und biometrischer Signatur. | ||
NumberIdRequired (string) | Unterzeichner | Text | Legt fest, ob die "SignerId" zur Signatur notwendig, optional oder nicht notwendig ist. |
| |
NumberIdEditable (boolean) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die "SignerID" ändern kann. | ||
TypeOfIdsAllowed (string) | Unterzeichner | Text | Legt fest, welche Ausweistypen erlaubt sind. Die Ausweistypen werden in einem Komma-separierten Format angegegeben. Die Ausweistypen werden dann in einer Auswahlliste angezeigt, wenn "TypeOfIDRequired" auf "mandatory" oder "optional" gesetzt ist. | ||
TypeOfIdRequired (string) | Unterzeichner | Text | Legt fest, ob eine Auswahl des Ausweistyps notwendig, optional oder nicht notwendig ist um das Dokument zu signieren. |
| |
TypeOfIdEditable (boolean) | Unterzeichner | Text | Legt fest, ob der Unterzeichner den Ausweistyp ändern kann. | ||
IssuerName (string) | Unterzeichner | Text | Legt den Anzeigenamen für den Absender der Benachrichtigungsmail fest. Ist dieser Wert leer, wird standardmäßig der Namen der DocuWare-Organisation verwendet. | ||
EmailLanguage (string) | Unterzeichner | Text | Legt die Sprache der Benachrichtigungsmail und der Signaturwebseite fest. Ist dieser Wert leer, wird standardmäßig Englisch verwendet. | br, ca, de, en, es, fr, gl, hu, it, nl, no, pl, pt, ro, zh | |
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. | ||
AddNewDocumentMultiRemote
Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch mehrere Personen geschickt. Die Signaturen 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.
Das Archiv wird aktualisiert, nachdem alle Personen das Dokument bearbeitet haben.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | Kategorie | Variablentyp im Workflow | 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. | |
ReminderFrequencyHours (int) | Prozeß | Integer | Sendet eine Erinnerung an den Unterzeichner. Der Wert legt fest, in welchem Intervall die Erinnerung gesendet wird. Ein üblicher Wert sind z.B. 24 Stunden. | |
ReminderMaxRetries (int) | Prozeß | Integer | Legt fest, wie viele Erinnerungen im Abstand von "ReminderFrequencyHours" insgesamt gesendet werden. | |
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. |
|
AllowSignatureDelegation (Boolean) | Prozeß | Text | Legt fest, ob der ursprünglich im Workflow definierte Unterzeichner das Dokument zur Signatur an eine weitere Person weiterleiten kann. Die Signatur wird damit an den neuen Unterzeichner delegiert. |
|
SendSignedDocument (Boolean) | Prozeß | Text | Legt fest, ob das signierte Dokument per Mail an den Unterzeichner gesendet wird. |
|
IncludeReport (Boolean) optional | Prozeß | Text | 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. |
|
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 (boolean) | 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. |
|
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 | Ankertertexte für mehrere Stellen, an denen unterschrieben werden soll. Siehe Methode “AddNewDocumentRemote”. | |
MultiPositionX (string) | Position | Text | Liste von mehreren "PositionX" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiPositionY (string) | Position | Text | Liste von mehreren "PositionY" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSizeX (string) | Position | Text | Liste von mehreren "SizeX" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSizeY (string) | Position | Text | Liste von mehreren "SizeY" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSignerName (string) | Unterzeichner | Text | Liste von mehreren "SignerName" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSignerNameEditable (string) | Unterzeichner | Text | Liste von mehreren "SignerNameEditable" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSignerEmail (string) | Unterzeichner | Text | Liste von mehreren "SignerEmail" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSignerPhoneNumber (string) | Unterzeichner | Text | Liste von mehreren "SignerPhoneNumber" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
RecipientMayProvideNumber (Boolean) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann. | |
MultiSignerID (string) optional | Unterzeichner | Text | Liste von mehreren "SignerId" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiNumberIdRequired (string) | Unterzeichner | Text | Liste von mehreren "NumberIdRequired" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiNumberIdEditable (string) | Unterzeichner | Text | Liste von mehreren "NumberIdEditable" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiTypeOfIdsAllowed (string) | Unterzeichner | Text | Liste von mehreren "TypeOfIdsAllowed" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiTypeOfIdRequired (string) | Unterzeichner | Text | Liste von mehreren "TypeOfIdRequired" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiTypeOfIdEditable (string) | Unterzeichner | Text | Liste von mehreren "TypeOfIdEditable" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
IssuerName (string) | Unterzeichner | Text | Legt den Anzeigenamen für den Absender der Benachrichtigungsmail fest. Ist dieser Wert leer, wird standardmäßig der Namen der DocuWare-Organisation verwendet. | |
EmailLanguage (string) | Unterzeichner | Text | Legt die Sprache der Benachrichtigungsmail und der Signaturwebseite fest. Ist dieser Wert leer, wird standardmäßig Englisch verwendet. | br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh |
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. |
AddNewDocumentMultiPositionsRemote
Mit dieser Methode wird eine Datei eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.
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).
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.
Parametername | Kategorie | Variablentyp im Workflow | 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. | |
ReminderFrequencyHours (int) | Prozeß | Integer | Sendet eine Erinnerung an den Unterzeichner. Der Wert legt fest, in welchem Intervall die Erinnerung gesendet wird. Ein üblicher Wert sind z.B. 24 Stunden. | |
ReminderMaxRetries (int) | Prozeß | Integer | Legt fest, wie viele Erinnerungen im Abstand von "ReminderFrequencyHours" insgesamt gesendet werden. | |
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. |
|
AllowSignatureDelegation (Boolean) | Prozeß | Text | Legt fest, ob der ursprünglich im Workflow definierte Unterzeichner das Dokument zur Signatur an eine weitere Person weiterleiten kann. Die Signatur wird damit an den neuen Unterzeichner delegiert. |
|
SendSignedDocument (Boolean) | Prozeß | Text | Legt fest, ob das signierte Dokument per Mail an den Unterzeichner gesendet wird. |
|
IncludeReport (Boolean) optional | Prozeß | Text | 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. |
|
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ß | Anzahl der Signaturpositionen | ||
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. |
|
MultiPageNumber (string) | Position | Text | Liste von mehreren "PageNumber" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiAnchorText (string) | Position | Text | Liste von mehreren "AnchorText" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiAnchorTextOccurrence (string) | Position | Text | Liste von mehreren "AnchorTextOccurence" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiPositionX (string) | Position | Text | Liste von mehreren "PositionX" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiPositionY (string) | Position | Text | Liste von mehreren "PositionY" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSizeX (string) | Position | Text | Liste von mehreren "SizeX" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSizeY (string) | Position | Text | Liste von mehreren "SizeY" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
SignerName (string) | Unterzeichner | Text | Legt den Namen des unterzeichnenden Benutzers fest. Nicht notwendig, wenn "SignerNameEditable" aktiviert ist. | |
SignerNameEditable (string) | Unterzeichner | Text | Legt fest, ob der Unterzeichner den Namen während der Signatur ändern kann. | |
SignerEmail (string) | Unterzeichner | Text | Legt die E-Mail-Adresse des unterzeichnenden Benutzers fest. | |
SignerPhoneNumber (string) | Unterzeichner | 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) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann. | |
SignerID (string) | Unterzeichner | Text | Legt eine ID-Nummer (z.B. Ausweisnummer) des Unterzeichners fest. Notwendig bei der zentralisierten Signatur und dem Firmenstempel, optional bei Remote-Signatur und biometrischer Signatur. | |
NumberIdRequired (string) | Unterzeichner | Text | Legt fest, ob die "SignerId" zur Signatur notwendig, optional oder nicht notwendig ist. | |
NumberIdEditable (string) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die "SignerID" ändern kann. | |
TypeOfIdsAllowed | Unterzeichner | Text | Legt fest, welche Ausweistypen erlaubt sind. Die Ausweistypen werden in einem Komma-separierten Format angegegeben. Die Ausweistypen werden dann in einer Auswahlliste angezeigt, wenn "TypeOfIDRequired" auf "mandatory" oder "optional" gesetzt ist. | |
TypeOfIdRequired | Unterzeichner | Text | Legt fest, ob eine Auswahl des Ausweistyps notwendig, optional oder nicht notwendig ist um das Dokument zu signieren. | |
TypeOfIdEditable | Unterzeichner | Text | Legt fest, ob der Unterzeichner den Ausweistyp ändern kann. | |
IssuerName (string) | Unterzeichner | Text | Legt den Anzeigenamen für den Absender der Benachrichtigungsmail fest. Ist dieser Wert leer, wird standardmäßig der Namen der DocuWare-Organisation verwendet. | |
EmailLanguage (string) | Unterzeichner | Text | Legt die Sprache der Benachrichtigungsmail und der Signaturwebseite fest. Ist dieser Wert leer, wird standardmäßig Englisch verwendet. | br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh |
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. |
AddNewClippedDocumentRemote
Mit dieser Methode werden mehrere Dateien eines Dokuments zur Signatur durch eine Person geschickt. Die Signatur wird an mehreren Positionen angebracht.
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).
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.
Der Unterzeichner signiert alle Dateien gleichzeitig mit einer Signatur.
Parametername | Kategorie | Variablentyp im Workflow | 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. | |
ReminderFrequencyHours (int) | Prozeß | Integer | Sendet eine Erinnerung an den Unterzeichner. Der Wert legt fest, in welchem Intervall die Erinnerung gesendet wird. Ein üblicher Wert sind z.B. 24 Stunden. | |
ReminderMaxRetries (int) | Prozeß | Integer | Legt fest, wie viele Erinnerungen im Abstand von "ReminderFrequencyHours" insgesamt gesendet werden. | |
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. |
|
SendSignedDocument (Boolean) | Prozeß | Text | Legt fest, ob das signierte Dokument per Mail an den Unterzeichner gesendet wird. |
|
IncludeReport (Boolean) optional | Prozeß | Text | 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. |
|
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 | | |
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. | |
MultiSectionCount (int) | Prozeß | Integer | Anzahl der zu unterzeichnenden Dateien eines DocuWare Dokuments | |
MultiSectionNumber (string) | Position | Text | Liste von mehreren "SectionNumber" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiPageNumber (string) | Position | Text | Liste von mehreren "PageNumber" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiAnchorText (string) | Position | Text | Liste von mehreren "AnchorText" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiAnchorTextOccurrence (string) | Position | Text | Liste von mehreren "AnchorTextOccurence" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiPositionX (string) | Position | Text | Liste von mehreren "PositionX" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiPositionY (string) | Position | Text | Liste von mehreren "PositionY" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSizeX (string) | Position | Text | Liste von mehreren "SizeX" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
MultiSizeY (string) | Position | Text | Liste von mehreren "SizeY" getrennt mit "MultiValueSeparator". Siehe Methode “AddNewDocumentRemote”. | |
SignerName (string) | Unterzeichner | Text | Legt den Namen des unterzeichnenden Benutzers fest. Nicht notwendig, wenn "SignerNameEditable" aktiviert ist. | |
SignerNameEditable (string) | Unterzeichner | Text | Legt fest, ob der Unterzeichner den Namen während der Signatur ändern kann. | |
SignerEmail (string) | Unterzeichner | Text | Legt die E-Mail-Adresse des unterzeichnenden Benutzers fest. | |
SignerPhoneNumber (string) | Unterzeichner | 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) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die Telefonnummer für die Zwei-Faktor-Authentifizierung selbst eingeben kann. | |
SignerID (string) | Unterzeichner | Text | Legt eine ID-Nummer (z.B. Ausweisnummer) des Unterzeichners fest. Notwendig bei der zentralisierten Signatur und dem Firmenstempel, optional bei Remote-Signatur und biometrischer Signatur. | |
NumberIdRequired (string) | Unterzeichner | Text | Legt fest, ob die "SignerId" zur Signatur notwendig, optional oder nicht notwendig ist. | |
NumberIdEditable (string) | Unterzeichner | Text | Legt fest, ob der Unterzeichner die "SignerID" ändern kann. | |
TypeOfIdsAllowed | Unterzeichner | Text | Legt fest, welche Ausweistypen erlaubt sind. Die Ausweistypen werden in einem Komma-separierten Format angegegeben. Die Ausweistypen werden dann in einer Auswahlliste angezeigt, wenn "TypeOfIDRequired" auf "mandatory" oder "optional" gesetzt ist. | |
TypeOfIdRequired | Unterzeichner | Text | Legt fest, ob eine Auswahl des Ausweistyps notwendig, optional oder nicht notwendig ist um das Dokument zu signieren. | |
TypeOfIdEditable | Unterzeichner | Text | Legt fest, ob der Unterzeichner den Ausweistyp ändern kann. | |
IssuerName (string) | Unterzeichner | Text | Legt den Anzeigenamen für den Absender der Benachrichtigungsmail fest. Ist dieser Wert leer, wird standardmäßig der Namen der DocuWare-Organisation verwendet. | |
EmailLanguage (string) | Unterzeichner | Text | Legt die Sprache der Benachrichtigungsmail und der Signaturwebseite fest. Ist dieser Wert leer, wird standardmäßig Englisch verwendet. | br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh |
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. |