DocuWare kooperiert mit Validated ID als Anbieter von Vertrauensdiensten, um Dokumente in einem Workflow zu signieren.
Validated bietet zur Konfiguration der Signatur eine Reihe von Service-Methoden mit jeweils spezifischen Parametern an. Diese sind in der Liste unten in diesem Artikel beschrieben.
Für jede Signatur wird in der Workflow Konfiguration eine eigene Service-Methode hinterlegt. Mit dieser Service-Methode wählen Sie zugleich das Verfahren zur Authentifizierung und Unterzeichnung - entweder biometrisch, remote oder zentralisiert.
Zum Beispiel ermöglicht die Methode AddNewDocument eine zentralisierte Authentifizierung, bei der ein Zertifikat für den Unterzeichner bereits beim Anbieter hinterlegt ist, die Methode AddNewDocumentRemote hingegen erfordert eine Zwei-Faktor-Authentifizierung.
Die Service-Methoden bieten unter anderem folgende, weitere Konfigurationsmöglichkeiten:
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
Elektronischer Firmenstempel: Versehen Sie ein Dokument mit einem Siegel, bevor Sie sie an den Unterzeichner versenden. So weisen Sie die Dokumente als authentisch und unverändert aus.
Die Methoden und ihre Parameter sind in den Tabelle unten jeweils nach den Authentifizierungs- und Unterzeichnungsverfahren sortiert.
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-Signatur
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 Validated ID übergeben um eine Signatur anzufordern. 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 den Unterzeichner ist bei diesem Verfahren keine Registrierung bei Validated ID 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.
Parameter | Workflow-Variable | Beschreibung | Werte | |
AnchorText (string) | Text | Dies ist die Textstelle, nach der Signature Service im Dokument suchen kann. Wenn er angegeben ist, aber nicht gefunden wird, tritt ein Fehler auf. Wird keine Angabe gemacht, sind die nachfolgenden Ortsangaben absolut und nicht relativ zur Suche nach einem Textstück. | ||
AnchorTextOccurrence (int) | Integer | Bezeichnet, bei welchem Ankertext die Signatur platziert werden soll |
| |
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. |
| |
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, 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. |
| |
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. | ||
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 | |
PositionX (int) | Integer | Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen stehen rechts. negative Zahlen links. | ||
PositionY (int) | Integer | Relativ zum oberen Rand des Ankertextes ist dies die vertikale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen oben. | ||
PostSigningAction (string) | Text | Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird. |
| |
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. |
| |
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
| |
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | ||
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | ||
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). HINWEIS: Für ein Demo-Abonnement wird keine SMS gesendet. Der Code lautet dann 12345. | ||
SizeX (int) | Integer | die Breite in Millimeter des Signaturbildes | ||
SizeY (int) | Integer | die Höhe in Millimeter des Signaturbildes | ||
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. |
AddNewDocumentMultiRemote
Ein Dokument kann von mehreren Personen an verschiedenen Stellen unterzeichnet werden.
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).
Verwenden Sie für alle Parameter die gleiche Liste: Anzahl und Reihenfolge der Werte sowie die Trennzeichen in der Liste müssen identisch sein. Das Archiv wird aktualisiert, nachdem alle Signaturen erhalten wurden.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | 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. |
|
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. |
|
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 Mehrfach-Signaturen | |
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 | |
MultiSignerCount (int) | Text | Anzahl der Mehrfach-Signaturen | |
MultiSignerEmail (string) | Text | Enthält die E-Mail-Adressen der Unterzeichner, z.B. peter.sanders@peters-engineering.net,brian.florent@peters-engineering.net | |
MultiSignerID (string) optional | Text | Dieser Parameter enthält die Unterzeichner-IDs für die Unterzeichner. | |
MultiSignerName (string) | Text | Enthält die Namen der Personen, die das Dokument unterzeichnen sollen, z.B.“Peter Sanders,Brian Florent” | |
MultiSignerPhoneNumber (string) | Text | Trennzeichenliste mit Telefonnummern für die Authentifizierung per SMS | |
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 | | |
OrderedSignature (boolean) | Text | 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 | Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird. |
|
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
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. |
AddNewDocumentMultiPositionsRemote
Ein Dokument 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).
Verwenden Sie für alle Parameter die gleiche Liste: Anzahl und Reihenfolge der Werte sowie die Trennzeichen in der Liste müssen identisch sein. Das Archiv wird aktualisiert, nachdem alle Signaturen erhalten wurden.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | 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. |
|
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. |
|
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. |
|
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur. Meist eine Ausweisnummer. | |
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. |
AddNewClippedDocumentRemote
Ein geklammertes DocuWare Dokument mit mehreren Dateien kann von einer Person an mehreren Stellen unterzeichnet werden.
Die Dateien werden zusammen unterzeichnet, so dass nur ein einziges Password (One Time Password, OTP) erforderlich ist. Sobald alle Dateien unterzeichnet sind, werden sie in DocuWare aktualisiert.
In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet (siehe Parameter MultiValueSeparator).
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | 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. |
|
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. |
|
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 | |
MultiSectionCount (int) | Integer | Anzahl der zu unterzeichnenden Dateien von einem DocuWare Dokument MultiSectionCount bezieht sich auf ein geklammertes DocuWare Dokument, das aus mehreren Dateien (Sektionen) besteht. | |
MultiSectionNumber (string) | Text | Liste der zu unterzeichnenden Dateien |
|
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. |
|
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. | |
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur. Meist eine Ausweisnummer. | |
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. |
Biometrische Signatur
Verfahren: Ein Mitarbeiter am Firmenempfang prüft die Identität des Unterzeichners per Augenschein, bestätigt die Identität , indem er dessen Namen im Formular einer Workflow-Aufgabe einträgt. Die Information wird an ein Tablet geschickt, auf dem der Unterzeichner das Dokument signiert. Dabei werden biometrische Daten wie der Schreibdruck für eine eventuelle spätere Überprüfung gespeichert.
Dieses Signaturverfahren von Validated ID hat den Sicherheitslevel “fortgeschritten”.
Für den Unterzeichner ist bei diesem Verfahren keine Registrierung bei Validated ID erforderlich.
AddNewDocumentBiometric
Ein Dokument kann von einer Person an einer Stelle zum Beispiel auf einem Tablet unterzeichnet werden.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parameter | Variablentyp im Workflow | Beschreibung | Werte |
AnchorText (string) | Text | Dies ist die Textstelle, nach der Signature Service im Dokument suchen kann. Wenn er angegeben ist, aber nicht gefunden wird, tritt ein Fehler auf. Wird keine Angabe gemacht, sind die nachfolgenden Ortsangaben absolut und nicht relativ zur Suche nach einem Textstück. | |
AnchorTextOccurrence (int) | Integer | Bezeichnet, bei welchem Ankertext die Signatur platziert werden soll |
|
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. |
|
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. | |
DeviceName (string) | Text | Name des zum Signieren verwendeten Geräts | |
DocId (int) | Integer | ID vom zu unterzeichnenden Dokument | |
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 | |
Language | Text | Sprache der App auf dem mobilen Gerät | ca, de, en, es, eu, fr, it, iw, nl, pl, pt |
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 |
PositionX (int) | Integer | Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen stehen rechts. negative Zahlen links. | |
PositionY (int) | Integer | Relativ zum oberen Rand des Ankertextes ist dies die vertikale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen oben. | |
PostSigningAction (string) | Text | Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird. |
|
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
SizeX (int) | Integer | die Breite in Millimeter des Signaturbildes | |
SizeY (int) | Integer | die Höhe in Millimeter des Signaturbildes | |
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. |
AddNewDocumentMultiPositionsBiometric
Ein Dokument kann von einer Person an mehreren Stellen auf einem Tablet unterzeichnet werden.
Die Reihenfolge der Liste muss für alle Parameter gleich sein. Außerdem müssen die Parameter alle die gleiche Anzahl von Werten haben, die durch das gleiche Trennzeichen getrennt sind.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | Variablentyp im Workflow | Beschreibung | Werte |
AnchorText (string) | Text | Dies ist die Textstelle, nach der Signature Service im Dokument suchen kann. Wenn er angegeben ist, aber nicht gefunden wird, tritt ein Fehler auf. Wird keine Angabe gemacht, sind die nachfolgenden Ortsangaben absolut und nicht relativ zur Suche nach einem Textstück. | |
AnchorTextOccurrence (int) | Integer | Bezeichnet, bei welchem Ankertext die Signatur platziert werden soll |
|
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. |
|
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. | |
DeviceName (string) | Text | Namen des für die Signaturen benutzten Tablets | |
DocId (int) | Integer | ID vom zu unterzeichnenden Dokument | |
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 | |
Language | Text | Sprache der App auf dem mobilen Gerät | ca, de, en, es, eu, fr, it, iw, nl, pl, pt |
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) | Integer | Anzahl der angeforderten Unterschriften | |
MultiSizeX (string) | Integer | Eine Liste mit Breitenangaben für zu platzierende Unterschriften | |
MultiSizeY (int) | Integer | Eine Liste mit Angaben für die Höhe der zu platzierenden Unterschriften | |
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. |
|
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
SizeX (int) | Integer | die Breite in Millimeter des Signaturbildes | |
SizeY (int) | Integer | die Höhe in Millimeter des Signaturbildes | |
StatusFieldName (string) | Text | Bezeichnet ein Indexfeld vom Dokument, das aktualisiert wird, wenn der Unterzeichner das Dokument signiert oder ablehnt. | |
SuccessStatusValue (string) | Text | Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird (siehe SuccessStatusValue). | |
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. |
AddNewClippedDocumentCentralized
Ein Dokument mit mehreren Dateien kann von einer Person auf einem Tablet unterzeichnet werden.
Verwenden Sie für alle Parameter die gleiche Liste: Anzahl und Reihenfolge der Werte sowie die Trennzeichen in der Liste müssen identisch sein.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | Variablentyp im Workflow | Beschreibung | Werte |
DateSignedFieldName (string) optional | 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. |
|
DaysBeforeExpiration (int) optional | 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 | |
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. |
|
Language optional | Text | Language to use in email | ca,nl,en,eu,fr,de,iw,pl,pt,es |
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 | |
MultiSectionCount (int) | Integer | Anzahl der zu unterzeichnenden Dateien von einem DocuWare Dokument MultiSectionCount bezieht sich auf ein geklammertes DocuWare Dokument, das aus mehreren Dateien (Sektionen) besteht. | |
MultiSectionNumber (string) | Text | Liste der zu unterzeichnenden Dateien |
|
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. |
|
RejectionReasonFieldName (string) | Text | Legt ein Textfeld als Indexfeld fest. Der Benutzer kann für die Ablehnung einen Grund angeben, der dort eingetragen wird. | |
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur. Meist eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
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. |
Zentralisierte Signatur
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 Validated ID übergeben um eine Signatur anzufordern. Die unterzeichnende Person meldet sich bei Validated ID an und signiert.
Für die zentralisierte Signatur müssen sowohl der Mitarbeiter, der die Signatur anfordert, als auch der Unterzeichner im selben Unternehmen arbeiten, das einen Vertrag mit Validated ID hat. Zudem ist es erforderlich, dass auch die unterzeichnende Person bei Validated ID registriert ist.
Mit dem zentralisierten Verfahren von Validated ID ist sowohl eine fortgeschrittene als auch eine qualifizierte Signatur möglich. Der Unterschied besteht darin, dass der Unterzeichner für das qualifizierte Zertifikat nicht nur bei Validated ID registriert sein, sondern auch eine separate Identifizierung durchlaufen haben muss.
AddNewDocument
Das Dokument kann von einer Person an einer Stelle im Dokument unterzeichnet werden.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | Variablentyp im Workflow | Beschreibung | Werte |
AnchorText (string) | Text | Dies ist die Textstelle, nach der Signature Service im Dokument suchen kann. Wenn er angegeben ist, aber nicht gefunden wird, tritt ein Fehler auf. Wird keine Angabe gemacht, sind die nachfolgenden Ortsangaben absolut und nicht relativ zur Suche nach einem Textstück. | |
AnchorTextOccurrence (int) | Integer | Bezeichnet, bei welchem Ankertext die Signatur platziert werden soll |
|
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. |
|
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 | |
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 | |
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 |
PositionX (int) | Integer | Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen stehen rechts. negative Zahlen links. | |
PositionY (int) | Integer | Relativ zum oberen Rand des Ankertextes ist dies die vertikale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen oben. | |
PostSigningAction (string) | Text | Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird. |
|
RejectionReasonFieldName (string) optional | Text | Spezifiert ein Indexfeld vom Typ Text von dem signierten Dokument. Wenn Validated ID so konfiguriert ist, dass ein Grund für eine Ablehnung angegeben werden muss, wird der eingegebene Text in dieses Feld eingefügt. | |
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
SizeX (int) | Integer | die Breite in Millimeter des Signaturbildes | |
SizeY (int) | Integer | die Höhe in Millimeter des Signaturbildes | |
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. |
AddNewDocumentMultiPositions
Das Dokument kann von einer Person an mehreren Stellen unterzeichnet werden.
Beispiel: Bei Verträgen ist häufig eine Unterschrift am Ende eines Dokuments erforderlich, aber auch einzelne Vertragsbestandteile müssen bestätigt werden.
Die Informationen zu den Unterschriftspositionen im Dokument sind in einer Liste mit Trennzeichen enthalten. Das Trennzeichen wird mit einem eigenen Parameter festgelegt.
Die Reihenfolge der Liste muss für alle Parameter gleich sein. Außerdem müssen die Parameter alle die gleiche Anzahl von Werten haben, die durch das gleiche Trennzeichen getrennt sind.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parametername | 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. |
|
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 | |
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 | |
MultiAnchorText (string) | Text | Ankertexte für die Platzierung der Mehrfach-Signatur | |
MultiAnchorTextOccurrence (string) | Text | Ankertertexte für mehrere Stellen, an denen unterschrieben werden soll. | |
MultiPageNumber (string) | Text | Liste der Seiten, auf denen die Signatur angebracht werden soll. | |
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) | Integer | 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 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. |
|
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
StatusFieldName (string) | Text | Bezeichnet ein Indexfeld vom Dokument, das aktualisiert wird, wenn der Unterzeichner das Dokument im VIDsigner unterzeichnet oder ablehnt. | |
SuccessStatusValue (string) | Text | Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird (siehe SuccessStatusValue). | |
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. |
AddNewClippedDocumentCentralized
Das DocuWare Dokument enthält mehrere Dateien, die alle von einer Person unterzeichnet werden können.
Es wird ein Batch erzeugt. Wenn dieser abgearbeitet ist, wird das Dokument in DocuWare aktualisiert.
Die Reihenfolge der Liste muss für alle Parameter gleich sein. Außerdem müssen die Parameter alle die gleiche Anzahl von Werten haben, die durch das gleiche Trennzeichen getrennt sind.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Parameter | Workflow-Variable | Beschreibung | Werte |
DateSignedFieldName (string) optional | 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. |
|
DaysBeforeExpiration (int) optional | 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 | |
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. |
|
Language optional | Text | Language to use in email | ca,nl,en,eu,fr,de,iw,pl,pt,es |
MultiAnchorText (string) | Text | Ankertexte für die Platzierung der Mehrfach-Signatur | |
MultiAnchorTextOccurrence (string) | Text | Ankertertexte für mehrere Stellen, an denen unterschrieben werden soll. |
|
MultiPageNumber (string) | Text | Liste der Seiten, auf denen die Signatur angebracht werden soll. | |
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 | |
MultiSectionCount (int) | Integer | Anzahl der zu unterzeichnenden Sektionen, (Dateien im DocuWare Dokument) | |
MultiSectionNumber (string) | Text | Liste der zu unterzeichnenden Sektionen, (Dateien im DocuWare Dokument) | |
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 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. |
|
RejectionReasonFieldName (string) | Text | Spezifiert ein Indexfeld vom Typ Text von dem signierten Dokument. Wenn Validated ID so konfiguriert ist, dass ein Grund für eine Ablehnung angegeben werden muss, wird der eingegebene Text in dieses Feld eingefügt. | |
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
StatusFieldName (string) | Text | Bezeichnet ein Indexfeld vom Dokument, das aktualisiert wird, wenn der Unterzeichner das Dokument im VIDsigner unterzeichnet oder ablehnt. | |
SuccessStatusValue (string) | Text | Wert, der beim Signieren eines Dokuments in das entsprechende Indexfeld gesetzt wird (siehe SuccessStatusValue). | |
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. |
Elektronischer Firmenstempel
Der elektronische Firmenstempel, auch Siegel genannt, funktioniert technisch wie eine zentralisierte Signatur und kann ein fortgeschrittenes oder qualifiziertes Zertifikat haben.
Ein Siegel ist jedoch immer an eine juristische Person gebunden, an ein Unternehmen oder an eine andere Organisation. Die elektronische Signatur dagegen ist stets einer natürlichen Person zugeordnet.
Die Organisation, die das Siegel ausstellt, muss bei Validated ID registriert sein. Für eine qualifizierte Signatur muss die Organisation zudem eine separate Identifizierung durchlaufen haben.
Beispiel: Bevor ein Vertrag an den Kunden gesendet wird, wird die Echtheit des Vertrags durch eine automatische Signatur - den elektronischen Firmenstempel - bestätigt. Die Unterschrift eines Mitarbeiters ist nicht erforderlich.
AddNewDocumentStamp
Parametername | Variablentyp im Workflow | Beschreibung | Werte |
AnchorText (string) | Text | Dies ist die Textstelle, nach der Signature Service im Dokument suchen kann. Wenn er angegeben ist, aber nicht gefunden wird, tritt ein Fehler auf. Wird keine Angabe gemacht, sind die nachfolgenden Ortsangaben absolut und nicht relativ zur Suche nach einem Textstück. | |
AnchorTextOccurrence (int) | Integer | Bezeichnet, bei welchem Ankertext die Signatur platziert werden soll |
|
CertificateGUI (string) | Text | Eine GUID für das Zertifikat der Kundenorganisation. Dieser Wert wird von Validated ID bereitgestellt. | |
CertificatePin (string) | Text | Eine PIN von Validated ID für den Kunden. Die PIN muss bereit gestellt werden, damit das Dokument unterzeichnet werden kann. | |
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. |
|
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 | |
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 | |
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 |
PositionX (int) | Integer | Bezogen auf die linke Seite des Ankertextes ist dies die horizontale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen stehen rechts. negative Zahlen links. | |
PositionY (int) | Integer | Relativ zum oberen Rand des Ankertextes ist dies die vertikale Position des auf dem Dokument zu platzierenden Signaturbildes (in Millimeter). Positive Zahlen sind nach unten gerichtet, negative Zahlen oben. | |
PostSigningAction (string) | Text | Gibt an, wie ein signiertes Dokument im Archiv abgelegt wird. |
|
RejectionReasonFieldName (string) optional | Text | Spezifiert ein Indexfeld vom Typ Text von dem signierten Dokument. Wenn Validated ID so konfiguriert ist, dass ein Grund für eine Ablehnung angegeben werden muss, wird der eingegebene Text in dieses Feld eingefügt. | |
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. |
|
SendSignedDocument (Boolean) | Text | Mit "true" erhält der Unterzeichner eine E-Mail mit einer unterzeichneten Version des Dokuments. |
|
SignerEmail (string) | Text | E-Mail-Adresse des unterzeichnenden Benutzers | |
SignerID (string) | Text | Erforderlich für die zentralisierte Signatur von VIDsigner. In den meisten Fällen ist die ID eine Ausweisnummer. | |
SignerName (string) | Text | Name des unterzeichnenden Benutzers | |
SizeX (int) | Integer | die Breite in Millimeter des Signaturbildes | |
SizeY (int) | Integer | die Höhe in Millimeter des Signaturbildes | |
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. |
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. |
Was passiert, nachdem das Dokument signiert oder abgelehnt wurde?
Nachdem das Dokument signiert oder abgelehnt wurde, benachrichtigt Validated ID den DocuWare Signature Service.
Wenn das Dokument signiert wurde, lädt der DocuWare Signature Service das Dokument von Validated ID herunter. Der Parameter „PostSigningAction“ bestimmt, wie das Dokument behandelt wird - vor oder nach dem Originaldokument oder durch die neue Datei ersetzt. DocuWare Signature Service setzt das durch StatusFieldName angegebene Feld mit dem SuccessStatusValue. Der Workflow kann mit diesem Status fortgesetzt werden. .
Wenn das Dokument abgelehnt wird, setzt der DocuWare Signature Service den Wert des durch StatusFieldName angegebenen Feldes auf den FailedStatusValue. Der Workflow kann mit diesem Status fortgesetzt werden.
Der Signaturservice entfernt dann das Dokument aus der Validated ID.