DocuSign Delivery Option

If you have a DocuSign account, you can send a generated document to recipients for their eSignature through Nintex DocGen using DocuSign. To use DocuSign to collect eSignatures on your DocGen Package, first add a DocuSign delivery option to the DocGen Package, then create a list of recipients for your DocGen Package. Before DocuSign can be used as a delivery option with Nintex DocGen it needs to be integrated and authorized for use with Nintex DocGen. It is recommended to refer to and Integrating DocuSign with Nintex DocGen.

Note: With the addition of the DocuSign Apps Launcher (DAL) integration there are now two types of delivery options you can choose from: DocuSign (this is the DAL delivery option), or DocuSign (Legacy). For much of this documentation the DAL delivery option is referred to as DocuSign or DAL, and the DocuSign (Legacy) referred to as DocuSign Legacy delivery option.

Important considerations for use of DocuSign integration

Before adding a DocuSign integration to Nintex DocGen there are important considerations that must be made, depending upon on how you plan to use and integrate DocuSign.

  • There are different integrations and authorization methods for use with DocuSign depending on whether you are using DocuSign Legacy delivery option for Salesforce Classic, or the DocuSign Apps Launcher (DAL) delivery option for use in Salesforce Lightning.

  • DocuSign is deprecating it's legacy authentication methods, and certain ways of authorizing DocuSign will no longer be applicable. For more information refer to DocuSign retiring Legacy Authentication - Get Ready!

Migrate an existing Document Package from DocuSign Legacy to DocuSign Apps Launcher for Salesforce Lightning

If you are looking to migrate an existing Document Package that has been set up for use with the DocuSign Legacy delivery option to the DocuSign Apps Launcher (DAL) delivery option, first check out the blog post in regards to DocuSign deprecating its legacy app and the options available to you.  For more information on how to migrate an existing Document Package refer to Migrate from DocuSign Legacy to DocuSign Apps Launcher topic.

This topic contains content around:

Integrating DocuSign with Nintex DocGen

In order to integrate DocuSign for use as a delivery option in Nintex DocGen the following requirements must be met:

Add and authorize DocuSign as an integration

Before the DocuSign Delivery Option can be used, you need to add and configure DocuSign as an integration and select the authorization method you are going to use.

Important: Each Salesforce Org you manage (Production, Developer, Sandbox, Scratch) also needs to be authorized and set up with an integration. It is highly recommended to do whatever testing your organization requires before updating each Salesforce Org.

There are several ways to authorize DocuSign for use with Nintex DocGen, and depending on the use case may determine what type of authorization you plan on using.

Available authorization methods for DocuSign:

Authorization Option Description
OAuth - Admin Consent

The standard authentication method for the DocuSign delivery option. Requires DocuSign Admin Tools to be able to claim a domain. May also ask for a for Admin Consent approval when adding this setting for the first time.

Allows for a single DocuSign Admin Tools administrator to authorize all users under a single DocuSign account. No action is required on the part of the end-users side once Admin Consent has been configured. Every call made to DocuSign is authorized by a single administrative user but with done in context of the user sending out the Document Package.
OAuth - Individual Consent

Allows a user to make a one-time authorization to DocuSign limited to that user's account. Each user that needs to run a DocuSign delivery option for a Document Package will need to authorize their account. During set up of OAuth - Individual Consent admins can send out a URL that user's can use to authorize their account prior to sending out a Document Package. User's can also authorize their account by clicking the Authorize and Send to DocuSign button. This authentication method is also available for the Legacy DocuSign delivery option.
Legacy Authentication (Legacy) The standard authentication method for Legacy versions of DocuSign. DocuSign has since deprecated their legacy authentication options, and this option can no longer be used. If you were previously using this option you will need to switch to either OAuth - Admin Consent or OAuth - Individual Consent.
Send on behalf of (SOBO) (Legacy) Used for prompting the user for a login to DocuSign, used for the Legacy versions of DocuSign. DocuSign has since deprecated their legacy authentication options, and this option can no longer be used. If you were previously using this option you will need to switch to either OAuth - Admin Consent or OAuth - Individual Consent.

Troubleshooting DocuSign integration issues

If you are experiencing issues when trying to set up DocuSign integration or experiencing issues during run or design time using the DocuSign delivery option, refer to our DocuSign Troubleshooting guide.

Some common issues are

When setting up the DocuSign integration there is a chance you may encounter errors that can be troubleshooted.

If you receive an error, refer to the Authorization issues section of the troubleshooting guide.

If you are using Envelope Status on one of your page layouts you should start seeing information related to packages after sending out of a package using DocuSign. If you do not see any information in the Envelope Status section the most common cause is that Salesforce is not properly connected to your instance of the DocuSign Salesforce app.

For more information on how to connect Salesforce to DocuSign, see Troubleshooting DocuSign Issues.

DocuSign is deprecating their legacy authentication methods, and some of previously available authentication methods are no longer available for use. In the case that you are using OAuth - Individual Consent then that means user's will need to authorize their DocuSign account to use the DocuSign delivery option when they go to access Document Custom Fields or when trying to use the Authorize and Send to DocuSign button. For more information on OAuth - Individual Consent refer to DocuSign Delivery Option

In the event that DocGen Packages configured for use with automated workflows, or the autosend function no longer sends out documents after switching to OAuth - Individual Consent, the most common cause for this issue is that the user who is trying to use Autosend or the Service account has not been authorized for DocuSign.For more information on authorizing an account, refer to Authorize a service account or individual users for OAuth - Individual Consent. You can check to see if a user is authorized for use with DocuSign by checking the Connected Apps section in the user's DocuSign account.

Create a DocGen Package using DocuSign as a delivery option

You can add a DocuSign Delivery Option from the DocGen Package Wizard or from the Delivery Options list on a DocGen Package.

Note: With the addition of the DocuSign Apps Launcher (DAL) integration there are now two types of delivery options you can choose from: DocuSign (this is the DAL delivery option), or DocuSign (Legacy).

How-to video: Create a new document package using the DocuSign delivery option

  1. Open or Create a DocGen Package.

  2. In the Select Delivery Method or Storage Location pane, expand Electronic Signature and click Nintex DocGen
  3. Complete the required fields for delivery options. See Delivery Option fields and descriptions .
  4. Add recipients to the package. See Add Recipients to DocuSign Delivery Option.
  5. Save the document and upload it to your DocGen Package under Documents > Templates.
  6. Confirm the settings and click Save.
  7. Test your delivery option.

Delivery Option fields and descriptions

Field Description
Delivery Option Name Specifies the name of the delivery option. The user generating documents will see this name in the delivery option section of the generate documents page.
Signing Preview and Edit Selecting this option will allow you to go to the DocuSign interface where you can add, remove, or edit DocuSign features setup in the DocGen Package.
Make Delivery Option Available On

Select one or both of these options to choose where you want your DocGen Package available on.
Processing Options
  •  Automatically Process and Send:Send the processed DocGen Package without preview.
  •  On Screen and Auto Send: Show a process bar that displays the progress of the DocGen Package that is being created and then automatically send the DocGen Package.
  •  On Screen and Preview Before Sending: Show the process bar and preview the generated document.
    • Preview Step Help Text: The text that displays here will be a preview step during document generation. This field only displays if On Screen and Preview Before Sending is selected.

Help Text

Type a note or hint for the delivery option you've configured, and the hint will display at runtime.

Subject The subject of the email message. This can be made dynamic by using the field tagger. For example: “Quote <<Opportunity_Quote_Num>> or <<Account_Name>> Proposal.
Email Text The body of the email message. This can be made dynamic by using the field tagger.
Signing expires in The number of days before the document(s) can no longer be signed. Document(s) will not expire if set to 0.
Start reminders in Send a reminder about the document in the specified number of days. The reminder will not send if days are set to 0.
Repeat reminders every Set reminders to continually repeat after a specified number of days until the recipient completes the document.
Send warning prior to expiring Send an expiration warning a specified number of days before the document(s) expire. A warning will not be sent if days are set to 0.
Allow Remind and Expire Changes at Runtime If selected, the document sender will be able to change the defaults for reminders and expirations when sending a DocGen Package.
Enforce Signer Visibility If document visibility is set up in your DocuSign Salesforce app account, selecting this box will allow documents with tabs to only be viewed by signers that have a tab on that document. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
Disable Sign on Paper This option prevents recipients from using the print, sign, and fax options during the signing process.
Authoritative Copy The "Default" option uses the Authoritative Copy setting you have set up in DocuSign. Otherwise, you may select if the document is “Authoritative” (original and only version) or “Standard” (non-authoritative).
Brand Id

The brand ID associated with your branding set in DocuSign.

  • Brand Id is located under eSignature -> Brands in your DocuSign instance.

  • Highlight and copy the brand Id located on this page to the Brand Id field in Nintex DocGen.
Template Id

The template id of a template created from within DocuSign.

  • Highlight and copy the template Id from DocuSign to the Template Id field in Nintex DocGen.

Add Recipients to DocuSign Delivery Option

After setting up and selecting the options for the DocuSign delivery, recipients need to be added to the delivery option. You can also set up the order in which recipients receive the documents to sign.

  1. Click Add New Recipient.

  2. Select the Type of recipient.

  3. Search for and select the recipient that needs to be added.

  4. Once recipients have been added, there are several options available in the Advanced tab for configuration.

  5. Click the Done button to add the recipient.

  6. After recipients have been added you can choose the Signing Order. There are a few options available:

    • In Sequence - The package is sent out in the order listed in the Recipients List.

    • Custom - Can be used to set the order something other than the standard in sequence order. For example, if you have four recipients the order can be set to: 1 - 2 - 2 - 3.

Recipient option fields and descriptions

Field Description
Type Determines the type of recipient being added. The selection made here changes some of the available options.
Recipient This field selects the user that needs to be added as the recipient. Fields can be used to determine the signer without needing to add a specific email or specific name.
Embedded Signer

You can make the first recipient an embedded signer by selecting Routed via LOOPlus in this field. Embedded signers can provide their signature by signing within Salesforce immediately after the document is sent for signature. You can set only one recipient (the first) as an embedded signer at this time.
Requires Signature

If you select this checkbox, the user generating documents will have to send the documents to this signer for a signature.
Recipient Tags The Recipient Tags field shows all of the fields currently configured in the field tagger related to recipients. Fields tagged with the prefix of "ds." are fields specifically related to the Salesforce Lightning version of DocuSign. For more information on Recipient Tags refer to Recipient Tags.

Recipient #

Auto-generated number that is one number higher than the previous recipient.

Role Name Enter the role name for the recipient here. This will be visible to the Salesforce users on the run DocGen Package page.
Language Select the language of the email message sent out to the selected recipient.
Require ID Check An identification check is performed if this option is checked
Allow Access Code This field will allow an access code to be added to a recipient.
Display Title Selecting this option will display the recipient's title on the run DocGen Package page.

Recipient Tags

Recipient Tags are available to add for recipients when adding a new recipient to a DocuSign package. There are several things to note when using Recipient Tags:

  • Tags that appear as "dl.fieldname" are fields related to the Legacy version of DocuSign and cannot be edited within the Lightning UI.

  • Tags that appear as "ds.fieldname" are fields related to the Lightning version of DocuSign and cannot be edited within the Classic UI.

Document Custom Fields and Envelope Custom Fields are also available for use when set up in DocuSign.

For more information on how to add and edit recipient tags, refer to Add Recipient Tags and DocuSign Custom Fields.

Batch Document Generation using DocuSign

Sending out documents through Mass is also possible using information from DocuSign. Before Mass generation can be used for DocuSign, ensure that DocuSign has been set up and integrated properly to Nintex DocGen.

  1. From the starting object view list select multiple records.

    For example, to generate a batch document for Opportunity records, select the checkbox next to each record that needs to have a document generated.

  2. Click the Generate Documents button.

  3. Select the Document Package from the package lists to use.

  4. In the delivery method section, click the radio button next to the Send for signing (DocuSign) option.

    After this option is selected, the recipients tied to Document Package display in the DocuSign Recipients section.

  5. To run the batch, click the Run button.

Classic and Lightning differences in DocuSign Delivery options

There are some differences in options and functionality between the DocuSign Legacy delivery option and the new DocuSign Apps Launcher (DAL) delivery option in Salesforce Lightning.

Note: This table is based on the features available as of the DocGen package version 20.6.0 and later.

Classic vs Lightning Differences

  DocuSign Legacy DocuSign (DAL)
Delivery Options Can only be created and edited in Classic designer Can only be created and edited in Lightning designer

Runtime User Mappings

(Salesforce user -> DocuSign user)

 Relies on DocuSign's Legacy Salesforce package be installed (no longer available in AppExchange). Relies on DocuSign App Launcher (DAL) be installed and configured.
Send data to DocuSign

(Salesforce -> DocuSign)

 Secure fields

Document Custom Fields configured in DocuSign
Send data back to Salesforce

(DocuSign -> Salesforce)

 DocuSign Connect Document Custom Fields configured in DocuSign
Envelope Status DocuSign Lightning Controls DocuSign Lightning Controls - Configuring Envelope Status to update when using a DocuSign delivery option in Salesforce Lightning
Use of DocuSign Envelope Custom Fields for reporting Yes Yes
Use Mass Yes Yes
Use Automation Yes No
Use Brand Switching Yes Yes
Use DocuSign Template Yes Yes
Signing Order All Types All Types
Signer Types All Types

All Types apart from -

  • In Person Signer

  • Signing Group
Specified Signer Types All Types

All Types apart from -

  • Selected user

  • User Lookup

  • User Selected email

  • Roles/Groups

  • Dynamic Name and email
Specify Recipient Title Yes No
Specify Recipient Display name Yes No
Specify Recipient Role name Yes No