Überblick Methoden für die Workflow-Aktivität Webservice
Zentralisierte Signatur:
AddNewDocument
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "zentralisiert" unterzeichnet werden kann.
Beispiel: Ein Mitarbeiter ist Teil eines Unterschriftprozesses im Unternehmen. Alle Dokumente zur Signatur werden im Validated ID Portal gesammelt. Da der Mitarbeiter bei Validated ID angemeldet ist, kann er sich jederzeit mit Benutzername und Passwort auf dem Signaturportal eingeloggen, die Dokumente prüfen und mit seiner geheimen PIN signieren.AddNewDocumentMultiPositions
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "zentralisiert" von einer Person an mehreren Stellen unterzeichnet werden kann.
Beispiel: wie bei "AddNewDocument" mit dem Unterschied, dass das Bild der Signatur an mehreren Positionen im Dokument angebracht wird.AddNewClippedDocumentCentralized
Sendet mehrere Dateien von einem einzelnen DocuWare Dokument an Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" unterzeichnet werden kann.
Beispiel wie bei “AddNewDocument”, zusätzlich können mehrere Dateien angegeben werden.
Remote Signatur:
AddNewDocumentRemote
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" unterzeichnet werden kann.
Beispiel: Der Unterzeichner teilt dem Mitarbeiter, der die Signatur anfordert, seinen Name, seine E-Mail-Adresse und SMS-fähige Telefonnummer mit. Der Mitarbeiter trägt die Daten in das Workflow-Formular ein und fordert damit die Signatur bei Validated ID an. Der Unterzeichner erhält eine E-Mail mit dem Link zum Dokument sowie eine SMS mit einer TAN, die er zum Auslösen der Signatur verwendet.AddNewDocumentMultiRemote
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" von mehreren Personen unterzeichnet werden kann.
Beispiel: wie unter "AddNewDocumentRemote" mit dem Unterschied, dass mehrere Personen das Dokument zur Signatur aufgefordert werden.AddNewDocumentMultiPositionsRemote
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" von einer Person an mehreren Stellen unterzeichnet werden kann.
Beispiel: wie unter "AddNewDocumentRemote" mit dem Unterschied, dass das Bild der Signatur an mehreren Positionen im Dokument angebracht wird.AddNewClippedDocumentRemote
Die Anwendung ist die gleiche wie bei AddNewDocumentRemote, es können hier jedoch mehrere Dateien angegeben werden.
Biometrische Signatur:
AddNewDocumentBiometric
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "biometisch" auf einem Unterschrifts-Tablett unterzeichnet werden kann.
Beispiel: Der Mitarbeiter am Firmenempfang prüft die Identität des Unterzeichners per Augenschein. Er bestätigt die Identität vom Unterzeichner und trägt dessen Namen im Formular einer Workflow-Aufgabe ein. 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.AddNewDocumentMultiPositionsBiometric
Sendet ein Dokument an Validated ID, damit es von einer Person an mehreren Stellen mit dem Signaturtyp "biometrisch" signiert werden kann.
Das Beispiel ist dasselbe wie bei "AddNewDocumentBiometric" mit dem Unterschied, dass das Bild der Signatur an mehreren Positionen im Dokument angebracht wird.AddNewClippedDocumentCentralized
Sendet mehrere Dateien von einem DocuWare Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren “biometrisch” unterzeichnet werden.
Beispiel: wie bei “AddNewDocumentBiometric”, zusätzlich können mehrere Dateien spezifiziert werden.AddNewDocumentStamp
Sendet ein Dokument zur automatischen Signatur an Validated ID. Damit wird die Echtheit und Authentizität des Dokuments bestätigt.
Beispiel: Ein Vertrag wird, bevor er an den Kunden geschickt wird, durch eine automatische Signatur in seiner Echtheit bestätigt. Die eigenhändige Signatur eines Mitarbeiters ist nicht erforderlich.DeleteUnsignedDocuments
Löscht ein bereits zur Signatur übermitteltes Dokument.
Beispiel: Nach dem Absenden der Signaturanfrage stellt der Mitarbeiter fest, dass er das falsche Dokument verschickt hat. Hiermit kann das Dokument zurückgezogen werden.
AddNewDocument
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "zentralisiert" unterzeichnet werden kann.
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
Sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "zentralisiert" von einer Person an mehreren Stellen unterzeichnet werden kann. Dies ist zum Beispiel bei Verträgen der Fall. Eine Unterschrift ist 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
Sendet mehrere Dateien von einem DocuWare Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "zentralisiert" unterzeichnet werden kann. Beispiel wie bei “AddNewDocument”, zusätzlich können mehrere Dateien angegeben werden.
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. |
AddNewDocumentRemote
Diese Methode sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" unterzeichnet werden kann.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet.
Zusätzliche Parameter zu den Parametern von AddNewDocument:
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
Diese Methode sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" von mehreren Personen unterzeichnet werden kann. Jeder Unterzeichner kann an einem anderen Ort unterschreiben.
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.
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. In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet (siehe Parameter MultiValueSeparator).
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
Diese Methode sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "remote" von einer Person an mehreren Stellen unterzeichnet werden kann.
Die Informationen zum Unterzeichner und die Unterschriftspositionen im Dokument sind in einer Liste mit Trennzeichen enthalten. Das Trennzeichen wird mit einem eigenen Parameter festgelegt.
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. In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet (siehe Parameter MultiValueSeparator).
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
Diese Methode bezieht sich auf ein geklammertes DocuWare Dokument, das aus mehrere Dateien besteht. Mehrere Dateien aus einem DocuWare Dokument werden zur Unterzeichnung mit dem Signaturtyp "remote" an Validated ID gesendet.
Die Anwendung ist die gleiche wie bei AddNewDocumentRemote, mit AddNewClippedDocumentRemote können zusätzlich mehrere Dateien angegeben 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.
Parameter müssen angegeben werden. Ausnahmen sind als "optional" gekennzeichnet. In den Beispielen in der Tabelle wird das Komma als Trennzeichen verwendet (siehe Parameter MultiValueSeparator).
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. |
AddNewDocumentBiometric
Diese Methode sendet ein Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren "biometisch" auf einem Unterschrifts-Tablett unterzeichnet werden kann.
Sendet ein Dokument an Validated ID, damit es von einer Person an mehreren Stellen mit dem Signaturtyp "biometrisch" signiert werden kann.
Zusätzlich zu den Daten des Unterzeichners werden auch die Positionen der angeforderten Signaturen gesendet.
Diese Signatur wird häufig bei Vertragsunterzeichnungen eingesetzt, bei denen eine Unterschrift am Ende eines Dokuments, aber auch für einzelne Vertragsbestandteile erforderlich ist.
Beispiel: Der Mitarbeiter am Firmenempfang prüft und bestätigt die Identität des Unterzeichners. Dann gibt er den Namen des Unterzeichners in das Formular einer Workflow-Aufgabe ein. Die Informationen werden an ein Tablet gesendet, auf dem der Unterzeichner das Dokument unterschreibt. Dabei werden biometrische Daten wie der Schreibdruck für eine mögliche spätere Überprüfung gespeichert.
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
Sendet ein Dokument an Validated ID, damit es von einer Person an mehreren Stellen mit dem Signaturtyp "biometrisch" signiert werden kann.
Zusätzlich zu den Daten des Unterzeichners werden auch die Positionen der angeforderten Signaturen gesendet.
Diese Signatur wird häufig bei Vertragsunterzeichnungen eingesetzt, bei denen eine Unterschrift am Ende eines Dokuments, aber auch für einzelne Vertragsbestandteile erforderlich ist.
Der Awendungsfall ist der gleiche wie für AddNewDocumentBiometric, nur werden zusätzlich zu den Daten des Unterzeichners auch die Positionen der angeforderten Unterschriften übermittelt.
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
Sendet mehrere Dateien von einem DocuWare Dokument zu Validated ID, damit es mit dem Validated ID Authentifizierungsverfahren “biometrisch” unterzeichnet werden.
Beispiel: wie bei “AddNewDocumentBiometric”, zusätzlich können mehrere Dateien spezifiziert 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. |
AddNewDocumentStamp
Diese Methode sendet ein Dokument zur automatischen Signatur an Validated ID. Damit wird wie mit einem Stempel die Echtheit und Authentizität des Dokuments bestätigt.
Damit Signatur automatisch erfolgen kann, ist es erforderlich, dass der Kunde für seine Organisation ein spezielles Zertifikat bei Validated ID hinterlegt.
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 |
|
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, 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. |
DeleteUnsignedDocuments
Diese Methode löscht ein bereits zur Signatur übermitteltes Dokument.
Beispiel: Nach dem Absenden der Signaturanfrage stellt der Mitarbeiter fest, dass er das falsche Dokument verschickt hat. Hiermit kann das Dokument zurückgezogen werden.
Parameter müssen angegeben werden.
Parametername | Variablentyp im Worflow | Beschreibung | Werte |
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. |
Dokumentübergabe nach einer Signatur oder Ablehnung
Sobald 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. Der Parameter "PostSigningAction" entscheidet das weitere Vorgehen – entweder wird das Originaldokument im Archiv mit dem signierten Dokument geklammert oder durch das signierte Dokument ersetzt. Der Signature Service füllt das durch StatusFieldName spezifizierte Feld mit dem Wert vom Parameter SuccessStatusValue. Danach wird der Workflow fortgesetzt.
Wenn das Dokument abgelehnt wird, füllt der Signature Service das Feld dagegen mit dem Wert vom Parameter FailedStatusValue. Auch mit diesem Status wird der Workflow fortgesetzt.
Der Signature Service entfernt das Dokument aus Validated ID.