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.

Note: If you are still using the Classic Interface and the classic DocuSign app, refer to DocuSign Delivery Options (Classic). Certain features may not function in the same manner as they do in Salesforce Classic, see the Classic and Lightning differences in DocuSign Delivery options table for more information.

Before adding DocuSign integration

Prior to setting up the integration for DocuSign, there are some prerequisites that must be set in the DocuSign Salesforce app:

  • Admin Tools must be purchased and configured.

  • Your DocuSign account must be set up with the correct configuration.

  • Users who need to send out packages using DocuSign need to be added to the User Management List inside of DocuSign Salesforce app.

Jump to:

Troubleshooting DocuSign integration issues

Authorization errors

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 troubleshooting guide for DocuSign integration.

Envelope Status not appearing

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.

 

Add DocuSign as an integration

Check the Before adding DocuSign integration section. If those prerequisites have been met you will then need to add DocuSign as an integration in Nintex DocGen. For more information on adding DocuSign as an integration, see Third Party Integrations.

Add a DocuSign Delivery Option

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

  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.
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).

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.

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

Fields created by administrators in your DocuSign instance can be used in a Nintex DocGen Package document template. By using the autoplace text created for that specific document custom field, you can insert that field into any document for use when sending out a document for signing using the DocuSign delivery method.

Custom fields are also assigned per recipient for input when signing the document. Each recipient on the Document Package can be assigned different signing fields that are only relevant to their signing experience.

Data writeback to Salesforce is also available with the use of Document Custom Fields. A recipient can make a change when interacting with the document, and that change can be written back to Salesforce to update the record and field associated with the custom field.

Document Custom Fields appear at the bottom of the field list in the Field Tagger.

Create DocuSign Document Custom Fields

Before Document Custom Fields can be used in Nintex DocGen , they need to be created and set up in your DocuSigninstance. For information on creating Document Custom Fields, refer to Create custom fields for documents.

Note: Only Document Custom Fields with the AutoPlace Text field filled in appear in the Field Tagger list.  If you do not see a custom field in the Field Tagger list, check if the AutoPlace Text field is filled out.

Add Document Custom Fields to a recipient

After a Document Custom Field is created and autoplace text is set, that field can now be added to a recipient.

  1. Set up your Document Package and add as many recipients as needed.

  2. Click the edit icon next to a recipient that needs to have a custom field set, and click the Edit button.

  3. After the Field Tagger list refreshes, scroll the Field Tagger list down until you see the custom fields.

  4. Locate the custom field in the Field Tagger list and select each field as necessary.

    Note: Document Custom Fields appear as the text filled in the AutoPlace Text field inside of DocuSign.

  5. After the desired fields have been selected, click Done .

  6. Click Save on the Document Package to confirm the addition of these fields.

Document Custom Field writeback to Salesforce

Document Custom Fields can writeback information to a record inside of Salesforce. However, in order for a custom field to write-back data, ensure the following options are selected under the Document Custom Field:

  • Relate to Salesforce

  • Writeback

If information does not writeback to Salesforce, ensure that Salesforce has been added in your connections inside of your DocuSign instance. To confirm, select Connect inside of DocuSign and ensure that Salesforce appears in the list of connected applications.

Migrate from Classic Designer to Lightning Designer

In Classic Designer, it is possible to move a record associated with the DocuSign Delivery Option from the classic to the Lightning Designer for use within the Lightning interface.

  1. In the Classic Designer interface, locate the record that needs to be migrated.

  2. In the Delivery Option details section, select DocuSign LE in the Delivery Package field.

  3. In the Record Type field, click the Change hyperlink.

  4. Select DocuSign in the options. The record migrates and is now usable as a DocuSign Document Package in the Lightning Designer.

Migrating a record and Document Package, does not update the document fields being used for that package. For more information on the differences between legacy field tags and the new field tags, refer to the Recipient Tags section.

  1. Open the Developer Console to query and edit records.

  2. Run the following query to find all the recipients associated with the legacy DocuSign delivery options:

    "SELECT Id, Name, Loop__IntegrationOption__c, Loop__dsSignOptions__c FROM Loop__dsRecipient__c LIMIT 200"

  3. The Loop__dsSignOptions__c field should have a string value that looks like this:

    “dl.signhere;dl.initialhere;dl.fullname;dl.datesign”.

    For example, change “dl.signhere;dl.initialhere;dl.fullname;dl.datesign” to “ds.signhere;ds.initialhere;ds.fullname;ds.datesign”.

  4. Update the value for Loop__dsSignOptions__c field by replacing the "dl" prefix with a "ds" prefix.

  5. Re-tag the document templates. The field tagger should now display the correct tags for the new delivery option in the recipient section. Secure fields will continue to work, so it is not necessary to update secure fields in document templates.

 

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 Classic designer and the Lightning designer. The table below lists out the differences.

  Classic DocuSign Lightning DocuSign
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

Automatically sent

(no secure fields)
Send data back to Salesforce

(DocuSign -> Salesforce)

 DocuSign Connect Document Custom Fields configured in DocuSign
Envelope Status DocuSign Lightning Controls DocuSign Lightning Controls
Mass Yes Yes
Automation Yes No - Coming soon!
Brand Switching Yes No - uses default in DocuSign account
Use existing DS template Yes No
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