DOCUSIGNCHECK Workflow Application
Overview
The DOCUSIGNCHECK workflow application lets you check the status of an envelope and download its associated file, which is a concatenation of attached files.
How it works
You can check the status of an envelope and download the file from DocuSign according to your status criteria.
Application logs are available. These can be specified by setting the value of the
DocuSignCheckLogLevel
parameter in theweb.config
file to0
to deactivate logs,1
for error logs,2
for information logs, or3
for debug logs; the default value is0
.
Required parameter
Parameter | Type | Direction | Description |
| TEXT | IN | DocuSign envelope ID to check |
Optional parameters
DocuSign configuration
There are two ways to configure DocuSign account information: you can define the configuration in the web.config
file or in the Configuration Panel, or you can manage the configuration on each DOCUSIGNCHECK action.
These parameters must be associated to a DocuSign account.
It's necessary to have authorized your DocuSign application for use. To do this, go to the following address: <SERVER>/oauth/auth?response_type=code&scope=signature%20impersonation&client_id=<CLIENT_ID>&redirect_uri=<REDIRECT_URI>
<SERVER>
:https://account.docusign.com
(production) orhttps://account-d.docusign.com
(demo)<CLIENT_ID>
: Corresponds to your DocuSign application'sIntegration Key
value<REDIRECT_URI>
: Redirect address (e.g.https://docusign.com
)
Parameters | Type | Direction | Description |
| TEXT | IN | DocuSign client ID
Corresponds to your DocuSign application's By default, this value comes from the |
| TEXT | IN | DocuSign user GUID
Corresponds to the value of By default, this value comes from the |
| TEXT | IN | DocuSign Auth server DocuSign values:
By default, this value comes from the |
| TEXT | IN | DocuSign RSA key
By default, this value come from the |
| TEXT | IN | DocuSign host server DocuSign values:
By default, this value comes from the |
General
Parameters | Type | Direction | Description |
| TEXT | IN | Valid status to download the document
Default: |
| FILE | OUT | DocuSign document |
| TEXT | OUT | Envelope status |
Example with DOCUSIGNSEND
In the following example, the DOCUSIGNSEND action is directly followed by the DOCUSIGNCHECK action. This action will loop back on itself until the status changes to signed
, completed
, voided
, or declined
.
If the status returned meets the condition, the document will be downloaded from DocuSign.
With the system loop action feature, the DOCUSIGNCHECK action will be executed every x
seconds until the OUT condition is met.