Application de workflow DOCUSIGNCHECK

Aperçu

L'application de workflow DOCUSIGNCHECK vous permet de vérifier le statut d'une enveloppe et de télécharger son fichier associé, qui est une concaténation de fichiers joints.

Mode de fonctionnement

  • Vous pouvez vérifier le statut d'une enveloppe et télécharger le fichier depuis DocuSign en fonction de vos critères de statut.

  • Des logs d'application sont disponibles. Ceux-ci peuvent être spécifiés en définissant la valeur du paramètre DocuSignCheckLogLevel dans le fichier web.config sur 0 pour désactiver la journalisation, 1 pour les logs d'erreur, 2 pour des logs d'informations ou 3 pour les logs de débogage; la valeur par défaut est 0.

Paramètre requis

Paramètre

Type

Direction

Description

DOCUSIGN_ENVELOPE_ID

TEXT

IN

ID d'enveloppe DocuSign à vérifier

Paramètres facultatifs

Configuration DocuSign

Il existe deux façons de configurer les informations de compte DocuSign : vous pouvez définir la configuration dans le fichier web.config ou dans le panneau de configuration, ou vous pouvez gérer la configuration sur chaque action DOCUSIGNCHECK.

Ces paramètres doivent être associés à un compte et une application DocuSign.

Il est nécessaire d'avoir autorisé votre application DocuSign à être utilisée. Pour ceci rendez-vous sur l'adresse: <SERVER>/oauth/auth?response_type=code&scope=signature%20impersonation&client_id=<CLIENT_ID>&redirect_uri=<REDIRECT_URI>

  • <SERVER> : https://account.docusign.com (production) ou https://account-d.docusign.com (demo).

  • <CLIENT_ID> : Correspond à la valeur de Integration Key de votre application DocuSign

  • <REDIRECT_URI> : Adresse de redirection (ex: https://docusign.com)

Paramètres

Type

Direction

Description

DOCUSIGN_CLIENT_ID

TEXT

IN

ID client DocuSign Correspond à la valeur de Integration Key de votre application DocuSign Par défaut, cette valeur provient du paramètre DocuSignClientId dans le fichier web.config.

DOCUSIGN_USER_GUID

TEXT

IN

GUID utilisateur DocuSign Correspond à la valeur de API Username dans le panneau de configuration de DocuSign Par défaut, cette valeur provient du paramètre DocuSignUserGuid dans le fichier web.config.

DOCUSIGN_AUTH_SERVER

TEXT

IN

Serveur d'authentification DocuSign

Valeurs de DocuSign :

  • account.docusign.com (production)

  • account-d.docusign.com (demo)

Par défaut, cette valeur provient du paramètre DocuSignAuthServer dans le fichier web.config.

DOCUSIGN_RSA_KEY

TEXT

IN

Clé RSA DocuSign

Correspond à la valeur de Private Key de votre application DocuSign Par défaut, cette valeur provient du fichier /Files/DocuSign/rsaKey.pem.

DOCUSIGN_HOST_SERVER

TEXT

IN

Serveur hôte DocuSign Valeurs de DocuSign :

  • https://docusign.net (production)

  • https://demo.docusign.net (demo)

Par défaut, cette valeur provient du paramètre DocuSignHostServer dans le fichier web.config.

Général

Paramètres

Type

Direction

Description

VALID_STATUS_LIST

TEXT

IN

Statut valide pour télécharger le document Par défaut : signed,completed,voided,declined

DOCUSIGN_DOCUMENT

FILE

OUT

Document DocuSign

DOCUSIGN_STATUS

TEXT

OUT

Statut de l'enveloppe

Exemple avec DOCUSIGNSEND

Dans l'exemple suivant, l'action DOCUSIGNSEND est directement suivie par l'action DOCUSIGNCHECK. Cette action reviendra sur elle-même jusqu'à ce que le statut passe à signed, completed, voided ou declined.

Si le statut renvoyé remplit la condition, le document sera téléchargé à partir de DocuSign.

Avec la fonction d'action de boucle système, l'action DOCUSIGNCHECK sera exécutée toutes les x secondes jusqu'à ce que la condition OUT soit remplie.

Configuration d'une action DOCUSIGNCHECK