Overview
The DOCUSIGNSEND workflow application lets you send one or more documents to DocuSign for electronic signature.
The DOCUSIGNCHECK workflow application lets you check the status of an envelope and download its associated file, which is a concatenation of attached files.
For more information and complete instructions on how to configure and use the applications, as well as examples, see the DOCUSIGNSEND Workflow Application and DOCUSIGNCHECK Workflow Application sections in the WorkflowGen Administration Guide.
DOCUSIGNSEND
Required parameters
You can use either of the following configurations: with a signers list or with signer numbers.
With a list of signers
Parameter | Type | Direction | Description |
---|---|---|---|
SIGNER_NAME_LIST |
TEXT | IN | Names of signers, separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_EMAIL_LIST |
TEXT | IN | Emails of signers, separated by the value defined in the DATA_SEPARATOR parameter |
FILEx |
FILE | IN | File(s) to send, where x corresponds to the file number; you can add one or multiple files |
With signer numbers
Parameter | Type | Direction | Description |
---|---|---|---|
SIGNER_NAMEx |
TEXT | IN | Name(s) of signer(s), where x corresponds to the signer number; you can add one or multiple signers |
SIGNER_EMAILx |
TEXT | IN | Email(s) of signer(s), where x corresponds to the signer number; you can add one or multiple signers |
FILEx |
FILE | IN | File(s) to send, where x corresponds to the file number; you can add one or multiple files |
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 DOCUSIGNSEND action.
Note: These parameters must be associated to a DocuSign account.
Parameters | Type | Direction | Description |
---|---|---|---|
DOCUSIGN_CLIENT_ID |
TEXT | IN | DocuSign client ID Corresponds to your DocuSign application’s Integration Key valueBy default, this value comes from the DocuSignClientId parameter in the web.config . |
DOCUSIGN_USER_GUID |
TEXT | IN | DocuSign user GUID Corresponds to the value of API Username in the DocuSign Control PanelBy default, this value comes from the DocuSignUserGuid parameter in the web.config . |
DOCUSIGN_AUTH_SERVER |
TEXT | IN | DocuSign Auth server DocuSign values:
DocuSignAuthServer parameter in the web.config . |
DOCUSIGN_RSA_KEY |
TEXT | IN | DocuSign RSA key By default, this value come from the /Files/DocuSign/rsaKey.pem file. |
DOCUSIGN_HOST_SERVER |
TEXT | IN | DocuSign host server DocuSign values:
DocuSignHostServer parameter in the web.config . |
General
Parameters | Type | Direction | Description |
---|---|---|---|
DATA_SEPARATOR |
TEXT | IN | Separator used to separate SIGNERS_NAME_LIST , SIGNERS_EMAIL_LIST , and SIGNER_ACCESS_CODE_LIST contentDefault: , |
EMAIL_SUBJECT |
TEXT | IN | Email subject used for the DocuSign envelope Default: Please sign this document sent from WorkflowGen |
PREFIX_SIGNHERE |
TEXT | IN | Prefix of the SignHere tag Default: /s |
SUFFIX_SIGNHERE |
TEXT | IN | Suffix of the SignHere tag Default: / |
X_OFFSET_SIGNHERE |
TEXT | IN | Vertical alignment of the SignHere tag in pixels Default: 0 |
Y_OFFSET_SIGNHERE |
TEXT | IN | Horizontal alignment of the SignHere tag in pixels Default: 0 |
PREFIX_FULLNAME |
TEXT | IN | Prefix of the Full name tag Default: /f |
SUFFIX_FULLNAME |
TEXT | IN | Suffix of the Full name tag Default: / |
X_OFFSET_FULLNAME |
NUMERIC | IN | Vertical alignment of the Full name tag in pixels Default: 0 |
Y_OFFSET_FULLNAME |
NUMERIC | IN | Horizontal alignment of the Full name tag in pixels Default: 0 |
PREFIX_DATE |
TEXT | IN | Prefix of the Date tagDefault: /d |
SUFFIX_DATE |
TEXT | IN | Suffix of the Date tagDefault: / |
X_OFFSET_DATE |
NUMERIC | IN | Vertical alignment of the Date tag in pixels Default: 0 |
Y_OFFSET_DATE |
NUMERIC | IN | Horizontal alignment of the Date tag in pixels Default: 0 |
Return parameter
Parameter | Type | Direction | Description |
---|---|---|---|
DOCUSIGN_ENVELOPE_ID |
TEXT | OUT | Contains the DocuSign envelope ID; you can use this ID in the DOCUSIGNCHECK workflow application |
DOCUSIGNCHECK
Required parameter
Parameter | Type | Direction | Description |
---|---|---|---|
DOCUSIGN_ENVELOPE_ID |
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.
Note: These parameters must be associated to a DocuSign account.
Parameters | Type | Direction | Description |
---|---|---|---|
DOCUSIGN_CLIENT_ID |
TEXT | IN | DocuSign client ID Corresponds to your DocuSign application’s Integration Key valueBy default, this value comes from the DocuSignClientId parameter in the web.config . |
DOCUSIGN_USER_GUID |
TEXT | IN | DocuSign user GUID Corresponds to the value of API Username in the DocuSign configuration panelBy default, this value comes from the DocuSignUserGuid parameter in the web.config . |
DOCUSIGN_AUTH_SERVER |
TEXT | IN | DocuSign Auth server DocuSign values:
DocuSignAuthServer parameter in the web.config . |
DOCUSIGN_RSA_KEY |
TEXT | IN | DocuSign RSA key By default, this value come from the /Files/DocuSign/rsaKey.pem file. |
DOCUSIGN_HOST_SERVER |
TEXT | IN | DocuSign host server DocuSign values:
DocuSignHostServer parameter in the web.config . |
General
Parameters | Type | Direction | Description |
---|---|---|---|
VALID_STATUS_LIST |
TEXT | IN | Valid status to download the document Default: signed,completed,voided,declined |
DOCUSIGN_DOCUMENT |
FILE | OUT | DocuSign document |
DOCUSIGN_STATUS |
TEXT | OUT | Envelope status |