Workflow Applications: ADOBESIGNSEND & ADOBESIGNCHECK usage

Development Workflow Applications
1

Overview

The ADOBESIGNSEND workflow application lets you send one or multiple documents to Adobe Sign for electronic signature.

The ADOBESIGNCHECK workflow application lets you verify the status of an agreement and download its associated file, which is a concatenation of attached files.

For more information and complete instructions on how to use the applications, including how to configure the Adobe Sign API, as well as examples, see the ADOBESIGNSEND Workflow Application and ADOBESIGNCHECK Workflow Application sections in the WorkflowGen Administration Guide.

ADOBESIGNSEND

Required parameters

You can use one of the following two configurations: with a list of signers 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 Email addresses 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 the signer(s), where x corresponds to the signer number; you can add one or multiple signers
SIGNER_EMAILx TEXT IN Email address(es) of the 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

Adobe Sign configuration

Parameters Type Direction Description
ADOBESIGN_CLIENT_ID TEXT IN Adobe Sign client ID client Adobe Sign By default, this value comes from the AdobeSignClientId parameter in the web.config file.
ADOBESIGN_CLIENT_SECRET TEXT IN Adobe Sign client secret

By default, this value comes from the AdobeSignClientSecret parameter in the web.config file.
ADOBESIGN_REFRESH_TOKEN TEXT IN Authentication refresh token

By default, this value comes from the AdobeSignAuthServer parameter in the web.config file.
ADOBESIGN_HOST_SERVER TEXT IN Adobe Sign host server (e.g. https://api.naX.adobesign.com , where X is the server ID)

By default, this value comes from the AdobeSignHostServer parameter in the web.config file.

General

Parameters Type Direction Description
DATA_SEPARATOR TEXT IN Separator used to the separate the contents of SIGNERS_NAME_LIST , SIGNERS_EMAIL_LIST , and SIGNER_ROLE_LIST
Default: , (comma)
SIGNER_ROLE_LIST TEXT IN Roles of the signers, separated by the value defined in the DATA_SEPARATOR parameter
SIGNER_ROLEX TEXT IN Role(s) of the signer(s), where x corresponds to the signer number; you can add one or multiple signers
AGREEMENT_NAME TEXT IN Name of the agreement, which will be displayed in the email sent to the user
Default: WorkflowGen

Return parameter

Parameter Type Direction Description
ADOBESIGN_AGREEMENT_ID TEXT OUT Contains the Adobe Sign agreement ID; you can use this ID in the ADOBESIGNCHECK workflow application.

ADOBESIGNCHECK

Required parameter

Parameter Type Direction Description
ADOBESIGN_AGREEMENT_ID TEXT IN ID of the Adobe Sign agreement to verify

Optional parameters

Adobe Sign configuration

Parameters Type Direction Description
ADOBESIGN_CLIENT_ID TEXT IN Adobe Sign client ID

By default, this value comes from the AdobeSignClientId parameter in the web.config file.
ADOBESIGN_CLIENT_SECRET TEXT IN Adobe Sign client secret

By default, this value comes from the AdobeSignClientSecret parameter in the web.config file.
ADOBESIGN_REFRESH_TOKEN TEXT IN Authentication refresh token

By default, this value comes from the AdobeSignAuthServer parameter in the web.config file.
ADOBESIGN_HOST_SERVER TEXT IN Adobe Sign host server (e.g. https://api.naX.adobesign.com , where x is the server ID)

By default, this value comes from the AdobeSignHostServer parameter in the web.config file.

General

Parameters Type Direction Description
VALID_STATUS_LIST TEXT IN Valid status to download the document

Possible values:
  • OUT_FOR_SIGNATURE
  • OUT_FOR_DELIVERY
  • OUT_FOR_ACCEPTANCE
  • OUT_FOR_FORM_FILLING
  • OUT_FOR_APPROVAL
  • AUTHORING
  • CANCELLED
  • SIGNED
  • APPROVED
  • DELIVERED
  • ACCEPTED
  • FORM_FILLED
  • EXPIRED
  • ARCHIVED
  • PREFILL
  • WIDGET_WAITING_FOR_VERIFICATION
  • DRAFT
  • DOCUMENTS_NOT_YET_PROCESSED
  • WAITING_FOR_FAXIN
  • WAITING_FOR_VERIFICATION
Default: SIGNED,APPROVED,CANCELLED,EXPIRED,ARCHIVED
ADOBESIGN_DOCUMENT FILE OUT Adobe Sign document
ADOBESIGN_STATUS TEXT OUT Agreement status