Nintex eSign Delivery Option
The Nintex eSign delivery method enables you to send generated documents to one or many recipients while requesting an eSignature. This topic explains how to configure and use the Nintex eSign delivery option for Nintex DocGen. See Delivery Options to learn more about other options.
If a Nintex eSign delivery Option was created prior to version 18.2, then you will need to re-sync the Templates on the eSign Delivery Option to use the new DocGen eSign Envelope (see Nintex eSign Envelopes). If the Templates are not re-synced, the Nintex eSign Delivery Option will continue to create records for the Envelope Object from the eSign Lightning Application.
To use the Nintex eSign Delivery Option, the current Salesforce user must be an existing user within Nintex eSign.
Before you can use the Nintex eSign delivery option, you'll need a Nintex eSign account. See Try Nintex eSign to sign-up for a trial account.
Note: Additional configuration is required if the email associated with your Nintex eSign username does not match the email associated with your Salesforce username. For information on how to configure a username refer to step 5b in the steps below.
Add Nintex eSign as an integration
After you have downloaded and configured Nintex eSign Lightning, you'll need to add Nintex eSign as an integration in Nintex DocGen. Follow the steps below, or use the DocGen Setup Wizard located in the Nintex Admin tab to perform the integration.
- Select the Nintex Admin tab.
-
Under Configuration, select Integrations.
- To authorize Nintex DocGen for integrations, click the Authorize Nintex DocGen button. A new window opens and asks you to allow access. Click Allow. If you have configured this elsewhere in Nintex DocGen for Salesforce, then these options will not display.
- Under the Add Service drop down, select eSign.
- Select or enter the following fields:
- eSign Identity Provider - The region and URL that you use to log into eSign (e.g. https://account.assuresign.net).
- Nintex eSign Username - The Nintex eSign Admin's username that is used to log into Nintex eSign.
Administrators can configure which Nintex eSign user is used for sending envelopes. To configure a Nintex eSign user for this task, go to Setup > Custom Settings > eSign User Settings > Manage. Then, set the Nintex eSign Context User at the Default Organization Level Value, Profile, or User level.
- Nintex eSign Password - The password associated to the Nintex eSign Admin's username.
- Click Authorize.
- If you have separate environments, complete the following: Select an Environment - The Site URL that displays under the eSign Administration and Settings in Nintex eSign.
- Click Save.
Caution: Once saved, the API user is created in Nintex eSign and is based on the app name and the creator's Salesforce org ID. For example, the format of the API user is DocGen_{org ID}_{GUID added by eSign}.
Add a Nintex eSign Delivery Option
Before you add the delivery option, you'll need to have a complete template in Nintex eSign. A complete template must have webhooks, at least one signer, and a JotBlock An area in Nintex AssureSign templates or documents that indicates where data will be applied. attached to the template. To learn more about creating a complete template in Nintex eSign, see Working With Simple Setup Templates.
Note: If your Nintex eSign delivery option is disabled when you attempt to run a DocGen Package with it, your Nintex eSign license may be expired. Check the Nintex Admin tab to review your license status.
-
Open or Create a DocGen Package.
-
In your DocGen Package, click the Delivery tab.
- In the Select Delivery Method or Storage Location pane, expand Electronic Signature and click Nintex eSign.
- Complete the required fields for Delivery Options. See Delivery Option fields and descriptions .
- Under Nintex eSign as Delivery Method:
- Select an eSign Account from the drop-down.
- Select an eSign Template from the drop-down. (Note that if you alter the template in eSign, you must click Refresh Inputs so that the changes you made are reflected in the Nintex eSign delivery method. In addition, if you alter the default Signer Identifier in eSign, special characters are not supported. Use only alphanumeric characters, spaces, and underscores, but do not use consecutive spaces and underscores. For example, Signer_1 or Signer 1 are supported, but Signer-1, Signer__1, and Signer _1 are not.)
- Under the Signer details, complete the fields. See Nintex eSign as Delivery Method for field details.
- Populate the Sender Input fields if needed. The sender inputs fields are populated from the Edit Sender Input section in Nintex eSign. (Sender Inputs are additional files that are not signed. Attachments are not sender inputs.)
- View and copy Nintex eSign JotBlocks:
- In the upper-right, open the Field Tagger.
- Expand Recipients. Copy all the available JotBlock tags and paste the tags in your Nintex DocGen template. The JotBlock tags are grouped by their associated signer. We recommend that all JotBlock field tags associated with the selected Nintex eSign template are pasted into a template. See Add templates to a DocGen Package
- Save the document and upload it to your DocGen Package under Documents > Templates.
- Confirm the settings and click Save.
- 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. |
Document Output Type* |
|
Make Delivery Option Available On* |
Select one or both of these options to choose what you want your DocGen Package available on.
|
Processing Options* |
|
Help Text |
Type a note or hint for the delivery option you've configured and the hint will display at runtime. |
You must complete any fields that are marked with an asterisk (*). |
Section | Field/Button/Link | Description |
---|---|---|
Nintex eSign as Delivery Method | eSign Account* | The account name that you use in eSign. |
eSign Template* | A template created in eSign that contains webhooks, signers, jotblocks. | |
View Templates in eSign | Allows the DocGen Admin to quickly navigate to the template in eSign while configuring the Nintex eSign delivery method. | |
Refresh Inputs | Updates fields on the Nintex eSign Delivery option to reflect changes made to the template in eSign. | |
Signer Details (The Signer detail fields are auto-populated from the fields located in the Nintex eSign template that you chose. Populate the remaining fields that you need. Required fields are determined by the designer in eSign.) |
Specified Signer* |
See Nintex eSign Specified Signer options to learn more about signer options that you can assign. |
Signer Mobile Phone* | The mobile phone number of the Signer. | |
Password | Signer Password* |
Add a password the Signer must use to access the document. |
Two-Factor Authentication | Signer SMS Auth Phone* | Add a mobile phone number for the Signer to receive a two-factor authentication code when accessing the document. |
Knowledge-Based authentication Knowledge Based Authentication (KBA) is an available option for signer authentication. The KBA process involves presenting the signer with a series of questions that have been generated from public data sources in order to ensure they are the authentic party designated to sign a document. | Signer KBA First Name* | The signer must complete these fields exactly as defined in the Delivery Option or they will not be authorized. |
Signer KBA Last Name* | ||
Signer KBA SSN | ||
Signer KBA Address* | ||
Signer KBA City* | ||
Signer KBA State* | ||
Signer KBA Zip Code* | ||
Signer KBA Birth Month | ||
Signer KBA Birth Day | ||
Signer KBA Birth Year | ||
Sender Inputs |
Multiple fields in eSign. (Addendum Files and Document Files are sender inputs that are not supported by Nintex DocGen.) |
Sender input fields are configured in eSign for a template. Sender Inputs allow the sender to input information at design time to be used in the eSign Envelope. These can be used as default values for Signer Inputs, KBA, etc. |
Signing Options | When the Document is Completed | Select either Do not send to a Related Record (default) or Send to a Related Record. |
Related Record | If Send to a Related Record was selected, choose the related record from this field. The signed document will be attached to the related record selected. Related Record options change based on the relationships configured on the data tab. | |
You must complete any fields that are marked with an asterisk (*). |
Option | Field | Description |
---|---|---|
Contact Specified by End-user | N/A | The user generating documents must select a contact as the recipient. |
Current End-user | N/A | The user generating documents is the recipient. |
Contact Specified | Contact* (using the search field) | Add a contact. The user that generates documents cannot edit this. |
User specified | User* (using the search field) | Add a user. The user that generates documents cannot edit this. |
User Specified (End-user can edit) | User* (using the search field) | Add a user. The user that generates documents cannot edit this. |
Contact Specified (End-user can edit) | Contact* | Add a contact with a Salesforce Lookup field. The user generating the documents can edit this value. |
Name and Email Specified |
|
Type a name and email address. The user generating documents can not change these values. (Use tags from the field tagger to make these fields dynamic.) |
Name and Email Specified by End-user | N/A | Type a name and email address. This is not a user or contact in Salesforce. The user generating documents can use these values or type their own. |
You must complete any fields that are marked with an asterisk (*).
You can use automation with Nintex DocGen Packages via code solutions using the loopMessage class or using RunDocGenAsync action from a Salesforce Flow or Process Builder.
Salesforce Workflow Rules, Outbound Messages, and Scheduled Document Packages are not currently supported.