Documentation Index

Fetch the complete documentation index at: https://knowledgecenter.docuware.com/llms.txt

Use this file to discover all available pages before exploring further.

Méthodes de service et paramètres avec DocuSign

Prev Next

DocuWare collabore avec DocuSign, prestataire de services de confiance, pour signer des documents au sein d'un processus de travail.

Pour configurer la signature, DocuSign propose une série de méthodes de service, chacune avec ses propres paramètres. Une méthode de service distincte est enregistrée dans la configuration du processus de travail pour chaque signature.

Les méthodes de service offrent notamment les fonctions suivantes :

  • Signer un document à plusieurs endroits, par exemple dans des contrats

  • Signer plusieurs fichiers agrafés au sein d'un même document DocuWare. Cela est utile, par exemple, lorsqu'un accord de confidentialité standard doit être signé en même temps qu'un contrat.

  • Définir un délai pour la signature

DocuWare Signature Service

Pour pouvoir signer des documents dans un processus de travail, le DocuWare Signature Service doit au préalable être intégré au processus de travail via une Web Service activity.  

Signature à distance avec DocuSign

Procédure : pour qu'une personne puisse signer un document, son nom, son adresse e-mail et un numéro de téléphone capable de recevoir des SMS doivent être connus. Ces informations sont transmises par le processus de travail à DocuSign afin de demander une signature. Le signataire reçoit un e-mail contenant le lien vers le document. Selon la méthode d'authentification, le signataire peut alors déclencher la signature.

Les méthodes de service suivantes sont toutes des signatures à distance et présentent le niveau de sécurité « avancé » -  AES.  

Pour ces méthodes, le signataire n'a pas besoin de s'enregistrer auprès de DocuSign.

Les méthodes suivantes sont disponibles pour la signature à distance avec DocuSign :

  • AddNewDocumentRemote

    Cette méthode envoie un fichier d'un document à la signature par une personne. La signature est placée à un emplacement.

  • AddNewDocumentMultiSigners

    Cette méthode envoie un fichier d'un document à la signature par plusieurs personnes. Les signatures sont placées à plusieurs emplacements.

  • AddNewDocumentMultiPositionsRemote

    Cette méthode envoie un fichier d'un document à la signature par une personne. La signature est placée à plusieurs emplacements.

  • AddNewClippedDocument
    Cette méthode envoie plusieurs fichiers d'un document à la signature par une personne. La signature est placée à plusieurs emplacements.

Méthode

Description

Fichiers

Signataires

Emplacements de signature

AddNewDocumentRemote

Cette méthode envoie un fichier d'un document à la signature par une personne. La signature est placée à un emplacement.

1

1

1

AddNewDocumentMultiSigners

Cette méthode envoie un fichier d'un document à la signature par plusieurs personnes. Les signatures sont placées à plusieurs emplacements.

1

plusieurs

plusieurs

AddNewDocumentMultiPositionsRemote

Cette méthode envoie un fichier d'un document à la signature par une personne. La signature est placée à plusieurs emplacements.

1

1

plusieurs

AddNewClippedDocument

Cette méthode envoie plusieurs fichiers d'un document à la signature par une personne. La signature est placée à plusieurs emplacements.

plusieurs

1

plusieurs

AddNewDocumentRemote

Cette méthode envoie un fichier d'un document à la signature par une personne. La signature est placée à un emplacement.

  • Les paramètres doivent être renseignés. Les exceptions sont signalées par la mention « optional ».

Nom du paramètre

Catégorie

Type de variable de processus de travail

Description

Valeurs

Token (string)

General

Text

Le processus de travail utilise le token pour s'authentifier auprès du Signature Service. Le token est créé lors de l'enregistrement du Signature Service et est envoyé par e-mail.

DateSignedFieldName (string)

Fields

Text

Définit un champ index dans lequel la date de signature est saisie. Il peut s'agir d'un champ texte, date ou date/heure.

S'il s'agit d'un champ texte, la date est saisie en UTC et affichée dans DocuWare.

Nous recommandons d'utiliser un champ de type Date ou Date/Heure afin que la date et l'heure s'affichent dans le fuseau horaire local et au format local.

StatusFieldName (string)

Fields

Text

Définit un champ index dans lequel le statut d'une signature est saisi. Il est renseigné avec « SuccessStatusValue » ou « FailureStatusValue ». Ce champ est idéal pour permettre la poursuite du processus de travail après la signature.

SuccessStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature réussie.

FailureStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature échouée.

RejectionReasonFieldName (string)

Optional

Fields

Text

Définit un champ index dans lequel le motif de refus est saisi lorsqu'un signataire a refusé la signature.

DaysBeforeExpiration (int)

Process

Integer

Une valeur >0 définit un délai de signature en jours. Si le délai est dépassé, le document est considéré comme refusé et n'est plus disponible pour la signature.

PostSigningAction (string)

Process

Text

Définit la manière dont le document signé est enregistré dans DocuWare. Le document d'origine peut être écrasé, ou le document signé peut être agrafé devant ou derrière le document d'origine.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Process

String

Définit si, en plus du document signé, un rapport contenant des informations sur le signataire et le processus de signature est joint au document. Ce rapport est un fichier PDF distinct.

  • True

  • False

ReportLanguage (string)

Mandatory for IncludeReport = True

Process

Text

Pour « IncludeReport = True », définit la langue dans laquelle le rapport est généré et joint.

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

IncludeDateSigned (boolean)

optional

Process

String

Définit si la date de signature est incluse dans le document. Les paramètres de position de la date de signature sont alors obligatoires.

  • True

  • false

RecipientAuthenticationType (string)

Process

Text

Définit l'authentification requise dans DocuSign

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

FileCabinetId (string)

Document

Text

Définit, par GUID, l'armoire dans laquelle le document à signer est stocké. Le GUID est affiché dans l'administration de l'armoire.

DocId (int)

Document

Integer

Définit le document à signer par son DocID.

SectionNumber (int)

Position

Integer

Définit le fichier (section) d'un document agrafé qui doit être signé.

  • 0 ou 1 = premier fichier du document

  • -1 = dernier fichier

  • Autre nombre = fichiers suivants

PageNumber (int)

Position

Integer

Définit le numéro de la page du document sur laquelle la signature est placée.

Si un texte d'ancrage est utilisé, le paramètre définit la page à partir de laquelle le texte d'ancrage est recherché.

AnchorText (string)

Position

Text

Définit un texte utilisé comme point de référence pour la position de la signature.

Si aucune valeur n'est définie, le point de référence est le coin supérieur gauche de la page.

AnchorTextOccurrence (int)

Position

Integer

Si le texte d'ancrage apparaît plusieurs fois dans le document, ce paramètre définit l'occurrence utilisée pour calculer la position.

  • 0 ou 1 = première occurrence du texte d'ancrage

  • -1 = dernière occurrence

  • Autre nombre = occurrences suivantes

PositionX (int)

Position

Integer

Définit la position horizontale de la signature. La ligne de référence est la marge gauche de la page ou (lorsqu'un texte d'ancrage est utilisé) le bord gauche du texte trouvé.

Les nombres positifs se trouvent à droite et les nombres négatifs à gauche de la ligne de référence. Les valeurs sont exprimées en millimètres.

PositionY (int)

Position

Integer

Définit la position verticale de la signature. La ligne de référence est la marge supérieure de la page ou (lorsqu'un texte d'ancrage est utilisé) le bord supérieur du texte trouvé.

Les nombres positifs se trouvent en dessous et les nombres négatifs au-dessus de la ligne de référence. Les valeurs sont exprimées en millimètres.

DateSignedPageNumber (int)

optional

Position

Integer

Définit le numéro de la page du document sur laquelle la date est placée.

Si un texte d'ancrage est utilisé, le paramètre définit la page à partir de laquelle le texte d'ancrage est recherché.

  • 0 ou 1 = première page du fichier

  • -1 = dernière page

  • Autre nombre = pages suivantes

DateSignedAnchorText (string)

optional

Position

String

Définit un texte utilisé comme point de référence pour la position de la date.

Si aucune valeur n'est définie, le point de référence est le coin supérieur gauche de la page.

DateSignedAnchorTextOccurrence (int)

optional

Position

Integer

Si le texte d'ancrage apparaît plusieurs fois dans le document, ce paramètre définit l'occurrence utilisée pour calculer la position.

  • 0 ou 1 = première occurrence du texte d'ancrage

  • -1 = dernière occurrence

  • Autre nombre = occurrences suivantes

DateSignedPositionX (int)

Position

Integer

Définit la position horizontale de la date. La ligne de référence est la marge gauche de la page ou (lorsqu'un texte d'ancrage est utilisé) le bord gauche du texte trouvé.

Les nombres positifs se trouvent à droite et les nombres négatifs à gauche de la ligne de référence. Les valeurs sont exprimées en millimètres.

DateSignedPositionY (int)

Position

Integer

Définit la position verticale de la date. La ligne de référence est la marge supérieure de la page ou (lorsqu'un texte d'ancrage est utilisé) le bord supérieur du texte trouvé.

Les nombres positifs se trouvent en dessous et les nombres négatifs au-dessus de la ligne de référence. Les valeurs sont exprimées en millimètres.

SignerName (string)

Signer

Text

Définit le nom de l'utilisateur signataire.

SignerEmail (string)

Signer

Text

Définit l'adresse e-mail de l'utilisateur signataire.

PhoneNumber (string)

Signer

String

Définit le numéro de téléphone du signataire pour l'authentification à deux facteurs. Le numéro de téléphone doit pouvoir recevoir des SMS et être indiqué au format de numéro de téléphone international (par exemple +18455639045).

RecipientMayProvideNumber (Boolean)

Mandatory for RecipientAuthenticationType = Phone or SMS

Signer

Text

Définit si le signataire peut saisir lui-même le numéro de téléphone pour l'authentification à deux facteurs.

  • True

  • False

AccessCode (string)

Mandatory for RecipientAuthenticationType = Access Code

Signer

Text

Définit un code d'accès pour la signature du document. Le code d'accès doit être communiqué au signataire par un canal de communication distinct.

Obligatoire lorsque le type d'authentification est « AccessCode ».

EmailSubject (string)

Signer

Text

Définit l'objet de l'e-mail de notification.

EmailMessage (string)

Signer

Text

Définit un texte affiché dans le corps de l'e-mail de notification.


AddNewDocumentMultiSigners

Cette méthode envoie un fichier d'un document à la signature par plusieurs personnes. Les signatures sont placées à plusieurs emplacements.

  • Les informations relatives aux signataires et aux emplacements de signature dans le document figurent dans une liste avec séparateurs. Le séparateur est défini par un paramètre dédié.

  • Dans les exemples du tableau, la virgule est utilisée comme séparateur (voir le paramètre MultiValueSeparator).

  • Dans les paramètres de liste, l'ordre et le nombre de valeurs séparées par « MultiValueSeparator » doivent être identiques.

  • L'armoire est mise à jour une fois que toutes les personnes ont traité le document.

  • Les paramètres doivent être renseignés. Les exceptions sont signalées par la mention « optional ».

Nom du paramètre

Catégorie

Type de variable de processus de travail

Description

Valeurs

Token (string)

General

Text

Le processus de travail utilise le token pour s'authentifier auprès du Signature Service. Le token est créé lors de l'enregistrement du Signature Service et est envoyé par e-mail.

DateSignedFieldName (string)

Fields

Text

Définit un champ index dans lequel la date de signature est saisie. Il peut s'agir d'un champ texte, date ou date/heure.

S'il s'agit d'un champ texte, la date est saisie en UTC et affichée dans DocuWare.

Nous recommandons d'utiliser un champ de type Date ou Date/Heure afin que la date et l'heure s'affichent dans le fuseau horaire local et au format local.

StatusFieldName (string)

Fields

Text

Définit un champ index dans lequel le statut d'une signature est saisi. Il est renseigné avec « SuccessStatusValue » ou « FailureStatusValue ». Ce champ est idéal pour permettre la poursuite du processus de travail après la signature.

SuccessStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature réussie.

FailureStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature échouée.

RejectionReasonFieldName (string)

Optional

Fields

Text

Définit un champ index dans lequel le motif de refus est saisi lorsqu'un signataire a refusé la signature.

DaysBeforeExpiration (int)

Process

Integer

Une valeur >0 définit un délai de signature en jours. Si le délai est dépassé, le document est considéré comme refusé et n'est plus disponible pour la signature.

PostSigningAction (string)

Process

Text

Définit la manière dont le document signé est enregistré dans DocuWare. Le document d'origine peut être écrasé, ou le document signé peut être agrafé devant ou derrière le document d'origine.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Process

String

Définit si, en plus du document signé, un rapport contenant des informations sur le signataire et le processus de signature est joint au document. Ce rapport est un fichier PDF distinct.

  • True

  • False

ReportLanguage (string)

Mandatory for IncludeReport = True

Process

Text

Pour « IncludeReport = True », définit la langue dans laquelle le rapport est généré et joint.

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

IncludeDateSigned (boolean)

optional

Process

String

Définit si la date de signature est incluse dans le document. Les paramètres de position de la date de signature sont alors obligatoires.

  • True

  • false

RecipientAuthenticationType (string)

Process

Text

Définit l'authentification requise dans DocuSign

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

MultiValueSeparator (string))

Process

Text

Définit la manière dont plusieurs valeurs au sein d'un paramètre sont séparées les unes des autres.

Les séparateurs courants sont la virgule, l'accent circonflexe ^ ou la barre verticale |

MultiSignerCount (int)

Process

Text

Nombre de signataires

OrderedSignature (bool)

Process

Text

Définit si les signataires sont notifiés dans un ordre défini ou simultanément.

Le document dans l'armoire DocuWare n'est mis à jour qu'une fois que tous les signataires ont signé le document.

FileCabinetId (string)

Document

Text

Définit, par GUID, l'armoire dans laquelle le document à signer est stocké. Le GUID est affiché dans l'administration de l'armoire.

DocId (int)

Document

Integer

Définit le document à signer par son DocID.

SectionNumber (int)

Position

Integer

Définit le fichier (section) d'un document agrafé qui doit être signé.

  • 0 ou 1 = premier fichier du document

  • -1 = dernier fichier

  • Autre nombre = fichiers suivants

MultiPageNumber (string)

Position

Text

Liste de plusieurs valeurs « PageNumber » séparées par « MultiValueSeparator ».

MultiAnchorText (string)

Position

Text

Liste de plusieurs valeurs « AnchorText » séparées par « MultiValueSeparator ».

MultiAnchorTextOccurrence (string)

Position

Text

Liste de plusieurs valeurs « AnchorTextOccurence » séparées par « MultiValueSeparator ».

MultiPositionX (string)

Text

Liste de plusieurs valeurs « PositionX » séparées par « MultiValueSeparator ».

MultiPositionY (string)

Text

Liste de plusieurs valeurs « PositionY » séparées par « MultiValueSeparator ».

MultiDateSignedPageNumber (string)

Text

Liste de plusieurs valeurs « DateSignedPageNumber » séparées par « MultiValueSeparator ».

MultiDateSignedAnchorText (string)

Text

Liste de plusieurs valeurs « DateSignedAnchorText » séparées par « MultiValueSeparator ».

MultiDateSignedAnchorTextOccurrence (string)

Text

Liste de plusieurs valeurs « DateSignedAnchorTextOccurence » séparées par « MultiValueSeparator ».

MultiDateSignedPositionX (string)

Text

Liste de plusieurs valeurs « DateSignedPositionX » séparées par « MultiValueSeparator ».

MultiDateSignedPositionY (string)

Text

Liste de plusieurs valeurs « DateSignedPositionY » séparées par « MultiValueSeparator ».

MultiSignerName (string)

Text

Liste de plusieurs valeurs « SignerName » séparées par « MultiValueSeparator ».

MultiSignerEmail (string)

Text

Liste de plusieurs valeurs « SignerEmail » séparées par « MultiValueSeparator ».

MultiSignerPhoneNumber (string)

Text

Liste de plusieurs valeurs « PhoneNumber » séparées par « MultiValueSeparator ».

RecipientMayProvideNumber (Boolean)

Mandatory for RecipientAuthenticationType = Phone or SMS

String

Définit si le signataire peut saisir lui-même le numéro de téléphone pour l'authentification à deux facteurs.

  • True

  • False

AccessCode (string)
Mandatory for RecipientAuthenticationType = Access Code

Signer

Text

Définit un code d'accès pour la signature du document. Le code d'accès doit être communiqué au signataire par un canal de communication distinct.

Obligatoire lorsque le type d'authentification est « AccessCode ».

EmailSubject (string)

Text

Définit l'objet de l'e-mail de notification.

EmailMessage (string)

Text

Définit un texte affiché dans le corps de l'e-mail de notification.

AddNewDocumentMultiPositionsRemote

Cette méthode envoie un fichier d'un document à la signature par une personne. Les signatures sont placées à plusieurs emplacements.

  • Les informations relatives aux signataires et aux emplacements de signature dans le document figurent dans une liste avec séparateurs. Le séparateur est défini par un paramètre dédié.

  • Dans les exemples du tableau, la virgule est utilisée comme séparateur (voir le paramètre MultiValueSeparator).

  • Dans les paramètres de liste, l'ordre et le nombre de valeurs séparées par « MultiValueSeparator » doivent être identiques.

  • Les paramètres doivent être renseignés. Les exceptions sont signalées par la mention « optional ».

Paramètre

Catégorie

Type de variable de processus de travail

Description

Valeurs

Token (string)

General

Text

Le processus de travail utilise le token pour s'authentifier auprès du Signature Service. Le token est créé lors de l'enregistrement du Signature Service et est envoyé par e-mail.

DateSignedFieldName (string)

Fields

Text

Définit un champ index dans lequel la date de signature est saisie. Il peut s'agir d'un champ texte, date ou date/heure.

S'il s'agit d'un champ texte, la date est saisie en UTC et affichée dans DocuWare.

Nous recommandons d'utiliser un champ de type Date ou Date/Heure afin que la date et l'heure s'affichent dans le fuseau horaire local et au format local.

StatusFieldName (string)

Fields

Text

Définit un champ index dans lequel le statut d'une signature est saisi. Il est renseigné avec « SuccessStatusValue » ou « FailureStatusValue ». Ce champ est idéal pour permettre la poursuite du processus de travail après la signature.

SuccessStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature réussie.

FailureStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature échouée.

RejectionReasonFieldName (string)

Optional

Fields

Text

Définit un champ index dans lequel le motif de refus est saisi lorsqu'un signataire a refusé la signature.

DaysBeforeExpiration (int)

Process

Integer

Une valeur >0 définit un délai de signature en jours. Si le délai est dépassé, le document est considéré comme refusé et n'est plus disponible pour la signature.

PostSigningAction (string)

Process

Text

Définit la manière dont le document signé est enregistré dans DocuWare. Le document d'origine peut être écrasé, ou le document signé peut être agrafé devant ou derrière le document d'origine.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Process

String

Définit si, en plus du document signé, un rapport contenant des informations sur le signataire et le processus de signature est joint au document. Ce rapport est un fichier PDF distinct.

  • True

  • False

ReportLanguage (string)

Mandatory for IncludeReport = True

Process

Text

Pour « IncludeReport = True », définit la langue dans laquelle le rapport est généré et joint.

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

RecipientAuthenticationType (string)

Process

Text

Définit l'authentification requise dans DocuSign

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

MultiValueSeparator (string))

Process

Text

Définit la manière dont plusieurs valeurs au sein d'un paramètre sont séparées les unes des autres.

Les séparateurs courants sont la virgule, l'accent circonflexe ^ ou la barre verticale |

MultiSignatureCount (int)

Process

Integer

Nombre d'emplacements de signature

MultiDateSignedCount (int)

Process

Integer

Nombre d'emplacements de date

MultiInitialCount (int)

Process

Integer

Nombre d'emplacements de paraphes

FileCabinetId (string)

Document

Text

Définit, par GUID, l'armoire dans laquelle le document à signer est stocké. Le GUID est affiché dans l'administration de l'armoire.

DocId (int)

Document

Integer

Définit le document à signer par son DocID.

SectionNumber (int)

Position

Integer

Définit le fichier (section) d'un document agrafé qui doit être signé.

  • 0 ou 1 = premier fichier du document

  • -1 = dernier fichier

  • Autre nombre = fichiers suivants

MultiSignaturePageNumber (string)

Position

String

Liste de plusieurs valeurs « PageNumber » séparées par « MultiValueSeparator ».

MultiSignatureAnchorText (string)

Position

String

Liste de plusieurs valeurs « AnchorText » séparées par « MultiValueSeparator ».

MultiSignatureAnchorTextOccurence (string)

Position

String

Liste de plusieurs valeurs « SignatureAnchorTextOccurence » séparées par « MultiValueSeparator ».

MultiSignaturePositionX (string)

Position

String

Liste de plusieurs valeurs « PositionX » séparées par « MultiValueSeparator ».

MultiSignaturePositionY (string)

Position

String

Liste de plusieurs valeurs « PositionY » séparées par « MultiValueSeparator ».

MultiDateSignedPageNumber (string)

Position

String

Liste de plusieurs valeurs « DateSignedPageNumber » séparées par « MultiValueSeparator ».

MultiDateSignedAnchorText (string)

Position

String

Liste de plusieurs valeurs « DateSignedAnchorText » séparées par « MultiValueSeparator ».

MultiDateSignedAnchorTextOccurence (string)

Position

String

Liste de plusieurs valeurs « DateSignedAnchorTextOccurence » séparées par « MultiValueSeparator ».

MultiDateSignedPositionX (string)

Position

String

Liste de plusieurs valeurs « DateSignedPositionX » séparées par « MultiValueSeparator ».

MultiDateSignedPositionY (string)

Position

String

Liste de plusieurs valeurs « DateSignedPositionY » séparées par « MultiValueSeparator ».

MultiInitialPageNumber (string)

Position

String

Liste de plusieurs numéros de page contenant les paraphes du signataire.

MultiInitialAnchorText (string)

Position

String

Définit un texte utilisé comme point de référence pour la position des paraphes.

Si aucune valeur n'est définie, le point de référence est le coin supérieur gauche de la page.

MultiInitialAnchorTextOccurence (string)

Position

String

Liste de plusieurs valeurs « MultiInitialAnchorText » séparées par « MultiValueSeparator ».

MultiInitialPositionX (string)

Position

String

Liste de plusieurs positions horizontales pour les paraphes du signataire

MultiInitialPositionY (string)

Position

String

Liste de plusieurs positions verticales pour les paraphes du signataire

SignerName (string)

Text

Définit le nom de l'utilisateur signataire.

Non nécessaire lorsque « SignerNameEditable » est activé.

SignerEmail (string)

Text

Définit l'adresse e-mail de l'utilisateur signataire.

PhoneNumber (string)

Text

Définit le numéro de téléphone du signataire pour l'authentification à deux facteurs. Le numéro de téléphone doit pouvoir recevoir des SMS et être indiqué au format de numéro de téléphone international (par exemple +18455639045).

RecipientMayProvideNumber (Boolean)

Text

Définit si le signataire peut saisir lui-même le numéro de téléphone pour l'authentification à deux facteurs.

AccessCode (string)

Mandatory for RecipientAuthenticationType = Access Code

Signer

Text

Définit un code d'accès pour la signature du document. Le code d'accès doit être communiqué au signataire par un canal de communication distinct.

Obligatoire lorsque le type d'authentification est « AccessCode ».

EmailSubject (string)

Signer

Text

Définit l'objet de l'e-mail de notification.

EmailMessage (string)

Signer

Text

Définit un texte affiché dans le corps de l'e-mail de notification.

AddNewClippedDocument

Cette méthode envoie plusieurs fichiers d'un document à la signature par une personne. La signature est placée à plusieurs emplacements.

  • Les informations relatives aux signataires et aux emplacements de signature dans le document figurent dans une liste avec séparateurs. Le séparateur est défini par un paramètre dédié.

  • Dans les exemples du tableau, la virgule est utilisée comme séparateur (voir le paramètre MultiValueSeparator).

  • Dans les paramètres de liste, l'ordre et le nombre de valeurs séparées par « MultiValueSeparator » doivent être identiques.

  • Les paramètres doivent être renseignés. Les exceptions sont signalées par la mention « optional ».

Paramètre

Catégorie

Type de variable de processus de travail

Description

Valeurs

Token (string)

General

Text

Le processus de travail utilise le token pour s'authentifier auprès du Signature Service. Le token est créé lors de l'enregistrement du Signature Service et est envoyé par e-mail.

DateSignedFieldName (string)

Fields

Text

Définit un champ index dans lequel la date de signature est saisie. Il peut s'agir d'un champ texte, date ou date/heure.

S'il s'agit d'un champ texte, la date est saisie en UTC et affichée dans DocuWare.

Nous recommandons d'utiliser un champ de type Date ou Date/Heure afin que la date et l'heure s'affichent dans le fuseau horaire local et au format local.

StatusFieldName (string)

Fields

Text

Définit un champ index dans lequel le statut d'une signature est saisi. Il est renseigné avec « SuccessStatusValue » ou « FailureStatusValue ». Ce champ est idéal pour permettre la poursuite du processus de travail après la signature.

SuccessStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature réussie.

FailureStatusValue (string)

Fields

Text

Valeur définie dans le champ index spécifié dans « StatusFieldName » après une signature échouée.

RejectionReasonFieldName (string)

Optional

Fields

Text

Définit un champ index dans lequel le motif de refus est saisi lorsqu'un signataire a refusé la signature.

DaysBeforeExpiration (int)

Process

Integer

Une valeur >0 définit un délai de signature en jours. Si le délai est dépassé, le document est considéré comme refusé et n'est plus disponible pour la signature.

PostSigningAction (string)

Process

Text

Définit la manière dont le document signé est enregistré dans DocuWare. Le document d'origine peut être écrasé, ou le document signé peut être agrafé devant ou derrière le document d'origine.

  • ClipBefore

  • ClipAfter

  • Replace

IncludeReport (boolean)

optional

Process

String

Définit si, en plus du document signé, un rapport contenant des informations sur le signataire et le processus de signature est joint au document. Ce rapport est un fichier PDF distinct.

  • True

  • False

ReportLanguage (string)

Mandatory for IncludeReport = True

Process

Text

Pour « IncludeReport = True », définit la langue dans laquelle le rapport est généré et joint.

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

IncludeDateSigned (boolean)

optional

Process

String

Définit si la date de signature est incluse dans le document. Les paramètres de position de la date de signature sont alors obligatoires.

  • True

  • false

RecipientAuthenticationType (string)

Process

Text

Définit l'authentification requise dans DocuSign

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

MultiValueSeparator (string))

Process

Text

Définit la manière dont plusieurs valeurs au sein d'un paramètre sont séparées les unes des autres.

Les séparateurs courants sont la virgule, l'accent circonflexe ^ ou la barre verticale |

MultiSectionCount (int)

Process

Integer

Nombre de fichiers à signer d'un document DocuWare

FileCabinetId (string)

Document

Text

Définit, par GUID, l'armoire dans laquelle le document à signer est stocké. Le GUID est affiché dans l'administration de l'armoire.

DocId (int)

Document

Integer

Définit le document à signer par son DocID.

MultiSectionNumber (string)

Position

Text

Liste de plusieurs valeurs « SectionNumber » séparées par « MultiValueSeparator ».

MultiAnchorText (string)

Position

Text

Liste de plusieurs valeurs « AnchorText » séparées par « MultiValueSeparator ».

MultiAnchorTextOccurrence (string)

Position

Text

Liste de plusieurs valeurs « AnchorTextOccurence » séparées par « MultiValueSeparator ».

MultiPositionX (string)

Position

Text

Liste de plusieurs valeurs « PositionX » séparées par « MultiValueSeparator ».

MultiPositionY (string)

Position

Text

Liste de plusieurs valeurs « PositionY » séparées par « MultiValueSeparator ».

SignerName (string)

Signer

Text

Définit le nom de l'utilisateur signataire.

SignerEmail (string)

Signer

Text

Définit l'adresse e-mail de l'utilisateur signataire.

PhoneNumber (string)

Signer

String

Définit le numéro de téléphone du signataire pour l'authentification à deux facteurs. Le numéro de téléphone doit pouvoir recevoir des SMS et être indiqué au format de numéro de téléphone international (par exemple +18455639045).

RecipientMayProvideNumber (Boolean)

Mandatory for RecipientAuthenticationType = Phone or SMS

Signer

Text

Définit si le signataire peut saisir lui-même le numéro de téléphone pour l'authentification à deux facteurs.

  • True

  • False

AccessCode (string)

Mandatory for RecipientAuthenticationType = Access Code

Signer

Text

Définit un code d'accès pour la signature du document. Le code d'accès doit être communiqué au signataire par un canal de communication distinct.

Obligatoire lorsque le type d'authentification est « AccessCode ».

EmailSubject (string)

Signer

Text

Définit l'objet de l'e-mail de notification.

EmailMessage (string)

Signer

Text

Définit un texte affiché dans le corps de l'e-mail de notification.

Retrait de la demande de signature

Cette méthode n'est pas une procédure de signature. Elle permet de retirer une demande de signature dans n'importe quelle procédure, par exemple lorsqu'un document erroné a été envoyé par mégarde.

DeleteUnsignedDocuments

Nom du paramètre

Type de variable de processus de travail

Description

Token (string)

Text

Le processus de travail utilise le token pour s'authentifier auprès du Signature Service. Le token est créé lors de l'enregistrement du Signature Service et est envoyé par e-mail.

FileCabinetId (string)

Text

Définit, par GUID, l'armoire dans laquelle le document à signer est stocké. Le GUID est affiché dans l'administration de l'armoire.

DocId (int)

Integer

Définit le document à signer par son DocID.

Après la signature

Une fois que la personne signataire a signé ou refusé le document, DocuSign en informe le DocuWare Signature Service, qui charge alors le document depuis DocuSign. Le paramètre « PostSigningAction » détermine la manière dont le document est traité, par exemple s'il est agrafé ou remplacé par le nouveau fichier.

  • Si le document a été signé, le DocuWare Signature Service inscrit une valeur correspondante via le paramètre « SuccessStatusValue », telle que « Signed ».

  • Si le document a été refusé, le Signature Service utilise le paramètre « FailedStatusValue » pour inscrire, par exemple, « Rejected » dans le champ « StatusField ».

Le processus de travail peut alors se poursuivre. Le Signature Service supprime le document de DocuSign.

Versions prises en charge : DocuWare Cloud + 7.14 + 7.13 + 7.12 + 7.11 + 7.10