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. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Digital Signature tab.

    Digital Signature tab
  3. On the Digital Signature tab, drag the DocuSign eSign Request activity onto your process.

    Drag DocuSign eSign Request activity

General Configuration

Specifies the basic settings for the DocuSign eSign Request activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Source Repository

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

Figure: Source Repository screen

Source Repository screen

Fields

Field NameDefinition

Source Repository

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.

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 NameDefinition

DocuSign

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

Create Add Token icon

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

Authentication URL

Description:
Shows the URL to connect to the DocuSign site for authentication.
Allowed Values:
Read only.

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

Default Value:
None

Document Name

Description:
Specifies the name of the document to be signed.
Allowed Values:
A valid document name.
Default Value:
None
Accepts 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 NameDefinition

Send On Behalf Of Below User

Description:
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.

Allowed 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 Variables:
No

Name

Description:
Specifies the name of the sender.
Allowed Values:
A valid user name.
Default Value:
None
Accepts Variables:
Yes

Email Address

Description:
Specifies the e-mail address of the sender.
Allowed Values:
One line of text (a string) in email address format.

If you use process data variables, domain\username is changed automatically to a valid email 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 Variables:
Yes

Subject

Description:
Specifies the subject line for your email.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
Yes
Example:
${ActivityName} in ${ProcessName} is complete

Also refer to:

Message Body

Description:
Specifies the content of your email.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts 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 NameDefinition

Signer Email Addresses

Description:
Specifies the e-mail addresses of the signer.
Allowed Values:
A list of email addresses, separated by commas (,).

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

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

CC

Description:
Specifies the recipients in the CC field for your email.
Allowed Values:
A list of email addresses, separated by commas (,).

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

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

Anchor Text Signing

Description:
Specifies text that shows where the recipient can put signatures, initials and other information in the document.
Allowed 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 Variables:
No

Free-Form Signing

Description:
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.

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

Enable Manual Offset

Description:
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.
Allowed 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

Description:
Specifies when the signers must sign the document.
Allowed 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 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 NameDefinition

Signature Anchor String

Description:
Specifies the text string to find and then enter the signature in the document.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No

Display document sent date for signature

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

Type

Description:
Specifies the tag type.

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

Allowed Values:
  • COMPANY - The recipient's company name shows in the tag.
  • EMAIL - 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

Description:
Specifies the name of the tag. The name is a unique identifier for the tag.
Allowed 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. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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

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

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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 NameDefinition

Initial Anchor String

Description:
Specifies the text string to find and then enter the initial in the document.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No

Display document sent date for signature

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

Type

Description:
Specifies the tag type.

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

Allowed Values:
  • COMPANY - The recipient's company name shows in the tag.
  • EMAIL - 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

Description:
Specifies the name of the tag. The name is a unique identifier for the tag.
Allowed 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. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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

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

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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 NameDefinition

Document ID

Description:
Specifies a unique ID of the document. This ID comes from DocuSign.
Allowed Values:
A valid document ID.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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

Description:
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.

Allowed Values:
A process data variable.

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

Default Value:
None
Accepts Variables:
Yes

Sign Status

Description:
Specifies a process data variable to store the status of the digital signature request.
Allowed Values:
A process data variable.
Default Value:
None
Accepts Variables:
Yes

Email Sent On

Description:
Specifies the date and time of the digital signature request e-mail.
Allowed Values:
A valid date and time.
Default Value:
None
Accepts Variables:
Yes