Workflow Envelope

Beginning with version 2.0.0.9 of the Nintex eSign Solution for CRM, it is possible to automate submissions of eSign Envelopes to the Nintex eSignservice in CRM.

In order to automate submissions, certain pieces of information must be present:

  • the eSign instance and credentials must be known

  • the Envelope TemplateID of the template to use for the submission must be fixed

An eSign Envelope is only a container of eSign Documents, so a process step that creates an envelope would be followed by process steps that submit one or more eSign Documents. Finally, none of the eSign Documents will be available to be signed until the envelope is closed.

Create a process

You may create a process that will use the Create eSign Envelope step through the normal mechanism in the Settings->Processes interface

Any normal process step may be added

To create an AssureSign Envelope,

Select to Add a Step

Choose eSign->Create eSign Envelope (this SDK message processing step must have been enabled)

Now, configure the step.

You may choose to:

  • Load the user's eSign Configuration (they must have access to the template with the configuration's template ID)

  • Load a specific eSign Configuration

  • Populate a lookup field on the eSign Document:

    • For example, if you are running the workflow on account, and you want the account lookup field to be populated on the eSign Document entity record that will be created, you must specify the field name of the lookup record. The account lookup field (along with some others) is built in with the solution, and you would enter asign_accountid here. By default, the entity on which the workflow is running will be assumed to be the entity to be populated in this value. Built in lookup fields on the document record are:

      • asign_accountid (for an Account)

      • asign_contactid (for a Contact)

      • asign_contractid (for a Contract)

      • asign_leadid (for a Lead)

      • asign_opportunityid (for an Opportunity)

      • asign_orderid (for an Order)

  • If running in the context of a different entity that exists as a lookup field on the eSign Document entity, you will enter the custom lookup field name that you added

    • It is also possible to populate this lookup field with a related entity field's value that is present on the entity on which the workflow is running. For example, to launch a workflow on account, but attach the eSign document to the account's primary contact, set:

    • Populate THIS Lookup on the eSign Document: asign_contactid

    • Get the Lookup from THIS Entity Field: primarycontactid

  • Enter an Envelope Template ID: this is displayed after you have saved the Envelope Template in the eSign administrative portal

  • Enter an Envelope Name: this may include dynamic values set via the form assistant

  • Set the behaviors for the Envelope, including

    • the View Behavior for signers

    • the Decline Behavior

    • the Workflow Type

  • Optionally, you may enter a Redirect URL that signers will be redirected to after signing

  • Enter a Completed Envelope Password if you would like: this may include dynamic values set via the form assistant

Add Documents to the Envelope

Follow the instructions for submitting eSign Documents using a Template Map to add document submission steps to the process.

The eSign Envelope you created in the Create eSign Envelope step will be used to populate the eSign Envelope lookup property on each document.

You may test for the presence of the envelopes values to ensure the envelope has been successfully created before initiating the Execute eSign Template step.

Close the Envelope

When all documents have been submitted that are a part of the envelope, the envelope must be closed.

  • Select to Add a Step

  • Choose AssureSign->Close AssureSign Envelope

You must configure the eSign Envelope lookup with the returned entity value from the original Create eSign Envelope step.

Follow the normal steps for process activation. When a workflow is run that uses an Execute eSign Template step and fails, check the logs for messages that may have been returned from the Nintex eSign system.