DocuSign eSign Request activity

An activity that requests a new digital signature for a specified document from DocuSign.


DocuSign eSign Request activity

Configure the DocuSign eSign Request activity

To configure the DocuSign eSign Request activity, do the procedure in this topic.

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Digital Signature Digital Signature icon tab.
      2. On the Digital Signature Digital Signature icon tab, drag the DocuSign eSign Request DocuSign eSign Request icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the DocuSign eSign Request activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Source Repository

Specifies the original, or source, location type for your files.

Figure: Source Repository screen

Source Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Amazon S3) - DocuSign eSign Request.

Box Box icon

Function:
Specifies that Box is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Box) - DocuSign eSign Request.

Dropbox Dropbox icon

Function:
Specifies that Dropbox is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Dropbox) - DocuSign eSign Request.

File System File System icon

Function:
Specifies that the file system on the AgilePoint Server machine is the data source for the file.

To select your file in the source location, complete the fields on Source Repository Configuration (File System) - DocuSign eSign Request.

FTP FTP icon

Function:
Specifies that FTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (FTP) - DocuSign eSign Request.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Google Drive) - DocuSign eSign Request.

NetSuite NetSuite icon

Function:
Specifies that NetSuite is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (NetSuite) - DocuSign eSign Request.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive) - DocuSign eSign Request.

OneDrive For Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive For Business) - DocuSign eSign Request.

Salesforce Salesforce icon

Function:
Specifies that Salesforce is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Salesforce) - DocuSign eSign Request.

SFTP SFTP icon

Function:
Specifies that SFTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SFTP) - DocuSign eSign Request.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SharePoint) - DocuSign eSign Request.

DocuSign eSign Request Configuration > Connection

Specifies the document to which e-Signature is requested.

Figure: DocuSign eSign Request Configuration > Connection tab

DocuSign eSign Request Configuration Connection tab

Fields

Field Name Definition

Digital Signature

Function:
Specifies the access token that connects to your DocuSign application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon

Opens this Screen:
Access Token for DocuSign
Function of this Screen:
Configure an access token to connect to DocuSign.

Authentication URL

Function:
Shows the URL to connect to the DocuSign site for authentication.
Accepted Values:
Read only.

When you select the access token from Digital Signature field, this field completes.

Default Value:
None

Document Name

Function:
Specifies the name of the document to be signed.
Accepted Values:
A valid document name.
Default Value:
None
Accepts Process Data Variables:
Yes

DocuSign eSign Request Configuration > Sender tab

Specifies the details of sender who requests a digital signature.

Figure: DocuSign eSign Request Configuration > Sender tab

DocuSign eSign Request Configuration Sender tab

Fields

Field Name Definition

Send On Behalf Of Below User

Function:
Lets you send a DocuSign document in the name of a user registerd in DocuSign.

To use this option, the DocuSign administrator must enable the permissions for Send On Behalf of Rights in the DocuSign account preferences.

Accepted Values:
  • Selected - Lets you send a DocuSign document on behalf of the specified user. To use this option, the value must be an e-mail address registered in DocuSign.
  • Deselected - The specified user can send a DocuSign document.
Default Value:
Deselected
Accepts Process Data Variables:
No

Name

Function:
Specifies the name of the sender.
Accepted Values:
A valid user name.
Default Value:
None
Accepts Process Data Variables:
Yes

E-mail Address

Function:
Specifies the e-mail address of the sender.
Accepted Values:
A valid e-mail address.

If you use process data variables, domain\username is changed automatically to a valid e-mail format.

If you select Send on behalf of below user, you must enter a valid DocuSign registered e-mail address in this field.

Default Value:
None
Accepts Process Data Variables:
Yes

Subject

Function:
Specifies the subject line for your e-mail.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
${ActivityName} in ${ProcessName} is complete

Also refer to:

Message Body

Function:
Specifies the content of your e-mail.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
Yes

DocuSign eSign Request Configuration > Signer tab

Specifies the recipients of the digital signature request.

Figure: DocuSign eSign Request Configuration > Signer tab

DocuSign eSign Request Configuration Signer tab

Fields

Field Name Definition

Signer E-mail Addresses

Function:
Specifies the e-mail addresses of the signer.
Accepted Values:
A list of e-mail addresses, separated by commas (,).

If you use process data variables, domain\username is changed automatically to a valid e-mail format.

Default Value:
None
Accepts Process Data Variables:
Yes
Example:
me@mydomain.com, ${ProcessInitiator}, ${ProcessParticipantUserNames}

CC

Function:
Specifies the recipients in the CC field for your e-mail.
Accepted Values:
A list of e-mail addresses, separated by commas (,).

If you use process data variables, domain\username is changed automatically to a valid e-mail format.

Default Value:
None
Accepts Process Data Variables:
Yes
Example:
  • me@mydomain.com
  • $MANAGER(DOMAIN\john)
  • $MANAGER(${/my:myFields/my:username})

Anchor Text Signing

Function:
Specifies text that shows where the recipient can put signatures, initials and other information in the document.
Accepted Values:
  • Include Signature - The sender puts text to search and put the signature and other information in the document.
  • Include Initials - The sender puts text to search and put the initials and other information in the document.
Default Value:
Selected.

When you select this field, the Signature Details tab and Initial Details tab becomes available.

Accepts Process Data Variables:
No

Free-Form Signing

Function:
Sends the documents to the recipients without adding tags.

When recipients open documents sent for free-form signing, the recipient sees the Click & Drag box in the document. The recipients can click and apply or drag their signature, initials, and other information on the document to complete the sign.

Accepted Values:
  • Selected - The documents are sent to recipients without adding tags.
  • Deselected - Anchor Text Signing option is selected.
Default Value:
Deselected
Accepts Process Data Variables:
No

Enable Manual Offset

Function:
Lets you specify the location for the signature or initials with x (horizontal) and y (vertical) coordinates relative to the anchor text in your document.
Accepted Values:
  • Selected - Lets you specify the location for the signature or initials with x (horizontal) and y (vertical) coordinates.
  • Deselected - Uses the default location for your signature and initials.
Default Value:
Deselected

Signature Flow

Function:
Specifies when the signers must sign the document.
Accepted Values:
  • Parallel - The signers can sign the document in parallel with other signers.
  • Sequential - The signers must sign the document in the order of the signature workflow.
Default Value:
Parallel
Accepts Process Data Variables:
No
Limitations:

The Signature Flow field is available in these releases:

DocuSign eSign Request Configuration > Signature Details tab

Specifies the text to search and put the signature or other information in the document.

Figure: DocuSign eSign Request Configuration > Signature Details tab

DocuSign eSign Request Configuration Signature Details tab

Fields

Field Name Definition

Signature Anchor String

Function:
Specifies the text string to find and then enter the signature in the document.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No

Display document sent date for signature

Function:
Shows the date when the specified document is sent along with the digital signature.
Accepted Values:
  • Selected - Shows both the document sent date and the digital signature.
  • Deselected - Shows only the digital signature.
Default Value:
Selected

Anchor X Offset Start

Function:
Specifies the position in pixels for the first signature or initial from the end x coordinate of the anchor text.
Accepted Values:
A positive integer.
Default Value:
0
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Anchor Y Offset Start

Function:
Specifies the position in pixels for the first signature or initial below the bottom y coordinate for the anchor text.
Accepted Values:
A positive integer.
Default Value:
50
Accepts Process Data Variables:
Yes

X Offset Increment

Function:
Specifies the distance in pixels between two signatures or initials in a series, in width.
Accepted Values:
A positive integer.
Default Value:
100
Accepts Process Data Variables:
Yes

Y Offset Increment

Function:
Specifies the distance in pixels between two signatures or initials in a series, in height.
Accepted Values:
A positive integer.
Default Value:
25
Accepts Process Data Variables:
Yes

Type

Function:
Specifies the tag type.

Tags identify the places in a document where the recipient can put the signature, initials, or other information.

Accepted Values:
  • COMPANY - The recipient's company name shows in the tag.
  • E-MAIL - The recipient's e-mail address shows in the tag.
  • TEXT - The recipient enters text in the tag.
  • TITLE - The recipient's title shows in the tag.
Default Value:
TEXT

Name

Function:
Specifies the name of the tag. The name is a unique identifier for the tag.
Accepted Values:
  • One line of text that can have spaces.
  • A process data variable.

    You can use Process Data screen to specify a process data variable.

Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Value

Function:
Specifies the value of the Name field that shows in the document.
Accepted Values:
Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add Add icon

Function:
Creates a row.

Delete Delete icon

Function:
Deletes the row.

DocuSign eSign Request Configuration > Initial Details tab

Specifies the text to search and then enter initials or other information in a document.

Figure: DocuSign eSign Request Configuration > Initial Details tab

DocuSign eSign Request Configuration Initial Details tab

Fields

Field Name Definition

Initial Anchor String

Function:
Specifies the text string to find and then enter the initial in the document.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No

Display document sent date for signature

Function:
Shows the date when the specified document is sent along with the digital signature.
Accepted Values:
  • Selected - Shows both the document sent date and the digital signature.
  • Deselected - Shows only the digital signature.
Default Value:
Selected

Anchor X Offset Start

Function:
Specifies the position in pixels for the first signature or initial from the end x coordinate of the anchor text.
Accepted Values:
A positive integer.
Default Value:
0
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Anchor Y Offset Start

Function:
Specifies the position in pixels for the first signature or initial below the bottom y coordinate for the anchor text.
Accepted Values:
A positive integer.
Default Value:
50
Accepts Process Data Variables:
Yes

X Offset Increment

Function:
Specifies the distance in pixels between two signatures or initials in a series, in width.
Accepted Values:
A positive integer.
Default Value:
100
Accepts Process Data Variables:
Yes

Y Offset Increment

Function:
Specifies the distance in pixels between two signatures or initials in a series, in height.
Accepted Values:
A positive integer.
Default Value:
25
Accepts Process Data Variables:
Yes

Type

Function:
Specifies the tag type.

Tags identify the places in a document where the recipient can put the signature, initials, or other information.

Accepted Values:
  • COMPANY - The recipient's company name shows in the tag.
  • E-MAIL - The recipient's e-mail address shows in the tag.
  • TEXT - The recipient enters text in the tag.
  • TITLE - The recipient's title shows in the tag.
Default Value:
TEXT

Name

Function:
Specifies the name of the tag. The name is a unique identifier for the tag.
Accepted Values:
  • One line of text that can have spaces.
  • A process data variable.

    You can use Process Data screen to specify a process data variable.

Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Value

Function:
Specifies the value of the Name field that shows in the document.
Accepted Values:
Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Add Add icon

Function:
Creates a row.

Delete Delete icon

Function:
Deletes the row.

DocuSign eSign Request Configuration > Response tab

Specifies the response by the signer for the digital signature request.

Figure: DocuSign eSign Request Configuration > Response tab

DocuSign eSign Request Configuration Response tab

Fields

Field Name Definition

Document ID

Function:
Specifies a unique ID of the document. This ID comes from DocuSign.
Accepted Values:
A valid document ID.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Signing URL

Function:
Specifies the process data variable that stores the reference URL for signing the documents.

The reference URL comes in the response from the DocuSign API.

Accepted Values:
A process data variable.

You can use Process Data screen to specify a process data variable.

Default Value:
None
Accepts Process Data Variables:
Yes

Sign Status

Function:
Specifies a process data variable to store the status of the digital signature request.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

E-mail Sent On

Function:
Specifies the date and time of the digital signature request e-mail.
Accepted Values:
A valid date and time.
Default Value:
None
Accepts Process Data Variables:
Yes