Using Docusign Custom Fields in Nintex Workflow Cloud

  • 6 August 2018
  • 3 replies
  • 192 views

Badge +3

If you are a current DocuSign customer you are likely familiar with document and envelope Custom Fields.  These custom fields allow users to create custom versions of standard fields and save them for reuse in future documents.  Leveraging custom fields comes in very handy when automating a process using Nintex Workflow Cloud. In this brief blog post I am going to walk you through how you can leverage these custom fields within a Nintex Workflow. There are 3 components to making this work and I will walk through each below.

 

https://support.docusign.com/guides/ndse-admin-guide-custom-fields

 

1.  The DocuSign Custom Field

 

The first thing you need to do is create your custom fields within your DocuSign account.  You can use either standard fields provided to you or create custom new ones.  These fields represent information that is populated during the signature process.  It can be a simple datetime stamp, the signature itself, or the name of the person signing the document.  An example of a list of document fields can be seen in the screenshot below.217966_pastedImage_1.png 

      List of custom fields

 

217982_pastedImage_4.png

 When you click into the details of a custom field you are provided with the ability to configure and format the field itself.  The field we need to pay attention to is called the “AutoPlace Text”.  This is the text you need to add to the DocuSign template being used during the signature process.  It’s basically a placeholder for the signature itself.  The format of this field is pretty simple.  “dl.fullname” is the name of the field and “{r}” represents the recipient.  You can have one to many recipients and both DocuSign and Nintex Workflow Clouds knows how to handle this.  We will talk more about how you use the “{r}” a bit later when we look at the contract template

2.  The DocuSign Template

 

The template is the document being signed.  In this example we will use a simple 2 recipient signature scenario.  In the screenshot below you can see the placement of the DocuSign AutoPlace Text each of which has been highlighted.  Each highlighted item below represents a custom field.  I’ve highlighted them below so you can see them.  The actual template should whites these fields out so the actual value comes through, not the AutoPlace text.  You will notice that each field is prefixed with a number.  The number represents the recipient.  You can have 1 to many recipients.  In this example we have 2 people signing the document.

217983_pastedImage_8.png

      AutoPlace Text Example

 

3. The Nintex Workflow

 

Now we can put everything together.  We are going to use Nintex Workflow cloud to orchestrate a process that starts with a simple partner program signup form.  Once the signup form is submitted, the workflow leverages DocuSign to obtain a signature on an NDA.  The contract template will be stored in Box.  Here is what the workflow looks like.

 

217984_pastedImage_9.png

Let’s take a closer look at the core actions and their configurations.

 

Start Event: Form

This is a simple form that captures the person’s name and a few other pieces of information.

 

Start Event Configuration Resulting Form
217988_pastedImage_16.png 217989_pastedImage_17.png

 

Get Contract Template: Box

This action goes out and grabs the template stored in box and outputs a file variable that is used in the DocuSign Get Signature action.

 217990_pastedImage_18.png

 

Get Signature: DocuSign

This action uses the contract template file variable populated above and routes it to each configured recipient.  Important to note that the number of recipients configured in this action should match the number of recipients/signers used in the template.

217991_pastedImage_19.png

 

Once the workflow is published, the start form can be filled out and submitted. Filling out the form starts the workflow and each configured recipient will receive an email to sign the document seen below.  In the screenshot below you can see the signature field, printed name, and date fields.  The name and date fields are populated by the information filled out in the start form and then passed into the get signature action.  Done! 

 

217992_pastedImage_20.png 

Final Note:

The configuration process for a ingested document with custom tags verses using a DocuSign template are a bit different and as a result can be confusing.   

 

For the ingested document scenario here are the things to make sure are in place.

 

  1. The custom field exists in DocuSign.
  2. The custom field anchor tag is properly placed with the right syntax on the document.
  3. There is no DocuSign template in this scenario so make sure the number of recipients configured in NIntex Workflow Cloud matches the number of signers (anchor tags) on the ingested document.  

 

When using a DocuSign template, you need to refrain from adding recipients to the DocuSign template.  Reason being that Nintex Workflow Cloud will handle this based on how many recipients are configured in the "get Signature" action.  Again the number of signers needs to match between Nintex and the DocuSign template.  

 

For more information on Nintex Workflow Cloud and other powerful use case scenarios please visit https://www.nintex.com/workflow-automation/nintex-workflow-cloud/


3 replies

Userlevel 4
Badge +8

Wow, I think this is my favorite article in the Nintex community!  Thanks Dan Barker

The ability to route a document through multiple signers and leverage Autoplace fields has been something many people have been asking for.  This steps in this post worked perfectly.

I'm curious where you got the documentation about formatting the Autoplace Text with "{r}" for the recipient from?  Is this something generic to DocuSign or specific to the Nintex/DocuSign integration?  The DocuSign documentation around Autoplace text is pretty useless.

I used the identical field configuration and Autoplace text values as you had documented.  Is that required? Or can we use any strings we want combined with the .{r}?  I'm curious if the format has some purpose... What does the "dl." refer to?

Is there any way to get this functionality from the DocuSign actions in Nintex for O365?

Badge +3

Hi Tom,

Glad you enjoyed the post!  Here are answers to your questions. 

The autoplace text formatting is a DocuSign construct.  The documentation on their end has changed a bit over the last year as they've changed how this work (and what it's called). As a result it's a big confusing for sure.  You can create any autoplace text you would like within the DocuSign service as a configuration step as long as it ends in {r}.  You can think of {r} as a recipient index.  There can be one to many of them depending on how you configure the signature transaction.  

 The "dl" in my example refers to "Drawloop".  It helps me know the field was put in the document via our document generation abilities.  You can customize this to be anything you want.  As long as the tags in the document match what's configured on the DocSign side, you should be in good shape.

 

Regarding support for this in O365, that is a great question.  I think fellow product manager Rick De Marco‌ can speak to this.

 

Userlevel 4
Badge +8

Yea I was using the {r} as the recipient index (based on your post).  Works really well. 

It's weird that I could not find that documented anywhere in the DocuSign documentation and had to learn that through Nintex Community!  I have a workflow in N4O365 with pretty much identical DocuSign requirements to your post.  So I'll have the workflow in O365 call a separate workflow in NWC to handle DocuSign. (Unless Rick De Marco‌ can advise how this could be supported in N4O365)

Reply