HomeGuidesRecipesAPI
HomeGuidesAPILog In

DocuSign Connector

Overview

Organizations spend billions of dollars on technology solutions to automate their processes, the final step in those processes, the creation of the document and final transaction, is surprisingly still stuck in the past.

When documents need to be signed, inefficient processes like printing, faxing, scanning, overnighting, and data rekeying take over and the inefficiency takes hold.
But this is changing with the integration of SmartIQ forms and DocuSign.

Usage of SmartIQ and DocuSign provides the following benefits:

📘

Note

You must have a valid license key of the DocuSign Connector for the “DocuSign” tab to show up and for the connector to function. If you don’t have a license key, contact your SmartIQ representative.

  • Immediate financial gains – By reducing the transaction time, organizations see needle-moving financial benefits in weeks rather than months or years.
  • Transforms the customer experience – Instead of waiting days, week, or even months for transactions to be completed, progress can be made near instantly. This velocity delights external and internal customers and elevates the organization that provides the superior service.
  • Readily demonstrates compliance – Every document has a readily accessible digital audit trail to making documenting compliance with industry laws and regulations fast and easy.

For more information, Click Here

🚧

Upgrade notice

Note that if you upgrade to v12 of SmartIQ from an earlier version, and previously used the DocuSign connector, you will need a rebuilt copy of the connector. Storage of the connector's settings changed in v12 and requires a connector update.

Connector Components

Action

Data Source

  • Envelope Status
  • Envelope Documents
  • Recipient Information

Question Extension

  • Download Documents

Creating a DocuSign Sandbox

You’ll require a dev sandbox to perform tests and build solutions using SmartIQ and DocuSign.

  1. Create a new free Dev sandbox account Click Here
  2. You'll receive a confirmation email, click "Verify Account".
  3. Change Password.

At this point, you have successfully created a Sandbox that you can be used to develop and test your SmartIQ projects.

  1. Navigate to the Admin Console clicking Go To Admin on the right top menu.
  2. Click API and Keys located on the left menu.
  3. Click Add APP / INTEGRATOR KEY button. A modal windows will pop-up; please provide the follwoing information:
    • App Description: Name for this specific integration; e.g. `SmartIQ'
    • Redirect URIs: Provide Produce URL, note that this value can be defined under Mange > Settings > DocuSign.
  4. On the same Window, click RSA Keypairs (ID) and then copy/paste this text into a local .txt file. Note that you must include -----BEGIN RSA PRIVATE KEY----- To -----END RSA PRIVATE KEY-----
  5. Copy the Integrator Key guid as this value is required in DocuSign Properties in Mange > Settings > DocuSign.

At this we have all parameters required to configure DocuSign in SmartIQ Settings.

  • Integrator Key
  • RSA Kaypairs (ID)
  • Redirect URI

📘

Note

Admin API Username Parameter can be found by navigating to the DocuSign Admin Console > Users. A valid Admin API Username to interact with the core DocuSign API service should be in Guid form, not as an email.

By default, DocuSign Connector will use <<productname>> Produce URL with a slash at the end. However, you can overrride it in Manage > Settings > DocuSign.

In most DocuSign Authentication workflows, SmartIQ will make API calls on behalf of a user, acting as them to create envelopes, add documents, and send these files out for signing. Each of these workflows requires that the user grant explicit consent for SmartIQ to act on their behalf. A Redirect URI is used for SmartIQ to request impersonation consent from an individual user by redirecting the user's browser to the authorization service URI and initiate the authorization process.

After being redirected to the service URI, the user will need to log in to their DocuSign account and be presented with a request to grant signature and impersonation permissions to SmartIQ as shown below:

Once a user has granted consent to an application by clicking the Accept button, they will then be redirected back to the defined Redirect URI. Users will no longer be prompted to do so again unless consent is revoked.

  1. Find the generated Integrator Key and click on the Integrator Key or in the Actions drop down select Edit.
  2. In the Redirect URIs section, click Add.
  3. Enter the new Redirect URI, this should be the <<productname>> Produce URL.

Configuring the Connector settings

  1. In a web browser, navigate to the SmartIQ Manage application and log in. E.g. http:\\serverName\Manage

  2. Navigate to Settings > DocuSign.

  3. Review and update the settings as required each of the required settings are described in the table below.

  4. Click the Save button at the top of the page once you have entered your organization's attributes.

📘

Multiple DocuSign accounts

Click the New Set button to configure additional DocuSign accounts (eg: Dev and Production).

SettingDescription
Production EnvironmentThis should be ticked if you are using a live production account.\nThis will determine the URL to make request to when retrieving account information needed to interact with the core DocuSign API service. https://account-d.docusign.com for the developer sandbox (Testing Environment) https://account.docusign.com for the live production system (Production Environment)
Admin API UsernameSpecify the Organization Admin’s API Username. This can be found by navigating to the DocuSign Admin Console > Users. A valid Admin API Username to interact with the core DocuSign API service should be in Guid form, not as an email.
Integrator KeyDocuSign API Integrator Key (Unique ID for each DocuSign integration). This key is retrieved from the DocuSign administration portal.
RSA Private KeyUpload the text file that contains the RSA Private Key obtained from Installation and Configurations step.
Embedded Signing Return UrlSpecify the URL that the embedded signer’s browser will be re-directed to after the signer has finished.
Redirect URISmartIQ will automatically use the <<productname>> Produce URL as the default Redirect URI used during Consent Access is established the first time DocuSign is used by SmartIQ This option allows to override this value and select a different URL. Note that the exact same URI needs to be also defined in the Redirect URI field when creating an Integration Key in the DocuSign Admin Portal.
Debug ModeIf enabled, the connector will output information about the constructed payload in the project output messages (available in Manage -> Management). This can be used to troubleshoot problems with the payload generation and/or DocuSign's behavior with the received payload.
Private Information in DebugIf enabled, the Debug Mode information will include potentially-sensitive information such as the Admin API Username to assist with detailed troubleshooting
Log ModeTrue/False This option that allows storing in the SmartIQ DB all generated requests to DocuSign. To enable this capability it is required to run the included SQL Script <DocuSignScript.sql (see install package) against your active SmartIQ DB. This option is only recommended for customers that require local audit logs, DocuSign also stores successful requests in its user portal.

Obtaining a DocuSign Admin Consent

Once the DocuSign Connector is installed successfully and the Connector Settings have been configured, SmartIQ will need to obtain consent from a DocuSign Admin user to make API calls on their behalf. SmartIQ will need to redirect the user to the Consent page, the user will need to log in to their DocuSign account and be presented with a request to grant signature and impersonation permissions to SmartIQ

To obtain a DocuSign Admin consent

  1. Create a new SmartIQ Project.
  2. Drag and Drop the "Create DocuSign Envelope" into the project.
  3. Add values to the mandatory inputs of the action, these are:
  • Recipient Name
  • Recipient Email
  • Email Subject
  • Email Blurb

📘

Note

These values could be anything for now since they would not be executed, at this stage we only run the action to obtain consent not to create an envelope.

  1. Publish and then Run the project.
  2. The user will be presented with a request to grant signature and impersonation permissions to SmartIQ
  3. Click Accept and the user should be redirected back to the SmartIQ Produce page.
    Once a user has granted consent to an application, they will no longer be prompted to do so again unless consent is revoked.
    If there’s a need to change the Admin API Username to another admin, this process would need to be done again to obtain consent for the new admin.

Architecture

Using the DocuSign Connector

For all the actions, there are two optional Account Settings inputs as follows:

NameDescription
Account IdOptional value, used where the default account id for the global Admin API Username is not the one needed for the project and an alternative account id is entered here. (Note that this needs to be a guid value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) rather than an integer ID.)
Admin API UsernameOptional value, used where the default Admin API Username in the Global Connector Settings is not the one needed for the project, an alternative Admin API Username is entered here. If an Account Id is also supplied, it needs to be a valid account id for this User. This value will override the global Admin API Username only for this project.

Action - Create DocuSign Envelope

📘

DocuSign Templates

If you have the DocuSign Connector installed, a license for DocuSign in SmartIQ as well as an account in DocuSign, you can use DocuSign templates instead. This enables you to use existing templates and you will not have to use the Create DocuSign Envelope action to connect to the DocuSign template.

While the action extensions are installed, they will not be called until a project is set up in SmartIQ with one or more of the DocuSign actions, with action attributes that instruct the action providers on how to behave.
Action attributes can be set up with fixed values within Design, or they can be set up to refer to values collected via the question set during the generation process.
The Create DocuSign Envelope action supports most of the fields to create and send an envelope using the DocuSign REST API.

Note that since the structure of the action attributes are closely aligned with a DocuSign Create Envelope’s Json request or as when you use the DocuSign REST API Explorer, most of the action attributes’ definition can be found here.

📘

Anchor Tags

If you use DocuSign Anchor Tags in your documents, the Tags must be unique across all documents as when anchor tabs are used, all documents in the envelope are searched by DocuSign for the AnchorTabString.

You can find SmartIQ sample projects Click Here

📘

DocuSign Notary

SmartIQ supports DocuSign Notary. This is done by providing the action input value on Recipient Type - Notary Recipient and Tab Type - Notary Seal in the Create Envelope action. However, the signing recipient must have a Client User Id.

Things to note:

  • DocuSign Notary is a feature that might not be available for all customers. Contact DocuSign support for more information.
  • The following should be set up in DocuSign:
    • The user defined in "Admin Api Username" must have organization_read, notary_read, and notary_write permissions, in addition to the existing signature, and impersonation permissions.
    • There should be existing organisations, notaries, and organisational invites and already set up.
    • The first notary signing request should have been performed and tested on the DocuSign site.

Action - Create DocuSign Embedded Signing URL

Once you’ve added the Create DocuSign Embedded Signing URL action to your project, either on the Finish page or on a workflow transition, use the following table to configure any action attributes that you require.

📘

If you use DocuSign Templates, you can use this action to enable users to complete the workflow in DocuSign without waiting for an email/document to sign.

NameDescription
Envelope IdId of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output.
Client User IdTo perform embedded signing ceremony, the Create DocuSign Embedded Signing URL action requires that you specify which person will be signing by provide the Client User Id that uniquely identify that person. Note: The Client User Id provided in this action must be the exact same as what you used in the Create DocuSign Envelope action.
Return UrlThe URL that the signer’s browser will be re-directed to after the signer has finished. This value could also be set globally across all projects in the DocuSign Connector Settings.

🚧

Note: Client User ID

When using a DocuSign Template the Client User ID input can be omitted, as SmartIQ will automatically retrieve the Client User ID value that was mapped to the template. For this reason the action input is not marked as mandatory - but it still must be supplied if the Embedded Signing URL action is used in conjunction with the Create Envelope Action.

Once all the action attributes are configured, the Create DocuSign Embedded Signing URL action will create an embedded signing URL and immediately redirect the user to that URL to perform a signing ceremony.

Action - Get DocuSign Document

There's a new action included with DocuSign Connector that allows to include DocuSign Documents into SmartIQ in other words, it will allow to include signed documents (individually selected or combined) and the certificate of completion in subsequent Actions and Connectors, for example, storing those documents into Microsoft SharePoint.

Action Inputs

InputDescription
Envelope IdId of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output.
Document IdThe ID of the document being accessed. You can query this value using the Connector Datasource Get Envelope Documents. If no document ID is provided, the action will default to combined option, where all DocuSign Documents included in the envelope are stitched and returned as a PDF.
Document Display NameName of the downloaded document, this value will be used by SmartIQ.
Certificate LanguageSpecifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified, Chinese Traditional, Dutch, English US, French, German, Italian, Japanese, Korean, Portuguese, Portuguese (Brazil), Russian, Spanish.
Include CertificateIncludes the Certificate page with the documents retrieved from Docusign. The default value is True.
Show ChangesWhen set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
WatermarkWhen set to true, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

One action per document downloaded is required.

Action - Setup Docusign Connect Auto-trigger

This action can be used to setup the Docusign connect auto triggering parameters after the envelope is created. For example, if multiple signers are required but a review process is required in between,
this can be used to change what Docusign Connect triggers after the second signature is completed.

NameDescription
Envelope Id (required)Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output.
Docusign ConnectThis hierarchical input then allows the user to setup the Submit Workflow, Generate or Prepare form instructions. See the relevant sections below for documentation regarding these parameters and what combination to use for each trigger type.

If this action is dragged onto a workflow transition, the next stage guid is automatically updated in the envelope.

🚧

Important

This action will reset the Docusign Connect specific fields (those available as inputs of this action under the Docusign Connect input) in the envelope.
If the action to be triggered by Connect is the same as setup in the original envelope, the parameters that specify this action must be setup in this action again.

Set-up DocuSign Datasource and its parameters

To be able to fully utilize all the DocuSign features there are a couple of other configurations that are required to make this all work.

View/Modify Datasource settings in SmartIQ

  1. In a web browser, navigate to the SmartIQ Manage application and log in. E.g. http:\\serverName\manage

  2. Click on Data Connections on the left panel.

  3. Click the New Data Connection button (top left)

  4. Select the Connection type as DocuSign Data Source and then fill in the following settings panels.

SettingDescription
Data Source NameAny relevant name.
Connection TypeDocuSignDataSource
Connection StringAny relevant name, E.g. DocuSign
CredentialsNo Credential Required
Add New Data Source in <<productname>> ManageAdd New Data Source in <<productname>> Manage

Add New Data Source in SmartIQ Manage

  1. Click Save to commit the changes.

  2. Click Test Connection. You should get a message “Connection Successful”. If you have an error, check your credential and integrator key provided in the Connector Settings.

  3. Click on the Data Objects button (top) and add the following objects:

Display NameObject TypeFilter Fields
Get Envelope DocumentsMethodenvelopeId
Get Envelopes StatusMethodenvelopId, fromDate and status
Get Recipient InformationMethodenvelopeId
Data Objects in <<productname>> ManageData Objects in <<productname>> Manage

Data Objects in SmartIQ Manage

Custom Question - DocuSign

The DocuSign Custom Question allows you to have a button in SmartIQ form that once clicked a PDF that contains the combined content of all documents will be downloaded
Once you’ve added the DocuSign custom question to your project use the following table to configure any custom question attributes that you require.

NameDescription
Document UrlURL to the PDF that contains the combined content of all documents in an envelope. This URL can be retrieved from using the DocuSign Data Source Get Envelope Status method – documentsCombinedUri column.

Once all the custom question attributes are configured, the DocuSign custom question allows you to have a “Get” button in your SmartIQ form. When this button is clicked a PDF containing the combined content of all documents in an envelope will be downloaded.

DocuSign Templates

SmartIQ can leverage the existing configuration and investment in DocuSign Templates by mapping the tabs, recipient structure and documents from existing templates in a drag and drop fashion. SmartIQ will populate the tabs and recipient information at runtime instead of recreating the entire process from scratch.

For more information, refer to Template - DocuSign.

DocuSign Connect

Is a fully automated way to get Documents and Data from DocuSign into SmartIQ, allowing to create near-real-time solutions based on events like:

Envelope Events:

  • Envelope Sent
  • Envelope Delivered
  • Envelope Signed/Completed
  • Envelope Declined
  • Envelope Voided

Recipient Events:

  • Recipient Sent
  • Recipient Delivery Failed
  • Recipient Delivered
  • Recipient Signed/Completed
  • Recipient Declined
  • Recipient Authentication Failure

In order to enable this capability, you will need to:

  1. Create a service account in SmartIQ that will be exclusively used by DocuSign Connect.
  2. Enable Connect in your DocuSign Account.
  3. Define the events you are subscribed to (either directly in the DocuSign admin console or per Envelope using the appropriate Action Inputs in Create Envelope Action.

DocuSign Service Account

You will need to create an SmartIQ user account to be used as a "Service Account" by DocuSign Connect. Ensure that this account has the correct permissions to access forms adding it to the appropriate SmartIQ groups and that Impersonate Users permission is enabled. Here some simple steps to demonstrate the creation of this account:

  1. Create a new DocuSign Role (Manage > Roles > New Role) where: Role Name: docusign and the Permission Impersonate Users is selected. This option is required to prepare forms on behalf other users.

  2. Click Save.

  3. Create a new SmartIQ User (Manage > Users > New User) where:
    User Name: docusign
    Password: yourPassword

  4. Click Save.

  5. Click Security and select the relevant Groups to ensure the service account has access to all relevant forms and that the new docusign role is selected.

Enable Connect in DocuSign Admin Console

  1. Navigate to your DocuSign Account using your preferred browser and click on Go To Admin on the upper-right menu.

  2. Click Connect option under INTEGRATIONS in the left side menu.

  3. Click ENABLE CONNECT button.

  4. Click Custom option under ADD CONFIGURATION button

  5. Provide a meaningful Name, like: `SmartIQ'

  6. Under URL to Publish (HTTPS required) provide the following URL: https://{{yourServer}}/Produce/DocuSignConnect

  7. Under Event Settings select Legacy from the Data Format dropdown list and Aggregate from the Event Message Delivery Mode dropdown list.

  8. Under Trigger Events select the events required to trigger the callback to the URL set in URL to Publish. Depending on your configuration in SmartIQ you will probably want Envelope Signed/Completed OR Recipient Signed/Completed.

  9. Click Include Basic Authentication Header and provide SmartIQ Service account Username and password. Note that this account needs to have appropriate permissions to perform SmartIQ operations on those projects that will be automated with DocuSign Connect.

  10. Enable further options as required.

  11. Click Save.

SmartIQ Configuration

DocuSign Connect can be used in one of these three main scenarios:

  • Generate Form
  • Prepare Form
  • Submit Workflow

All three use cases require to include an XML Datasource that will process the metadata returned by DocuSign Connect. Download the XML Schema and default data: Download

📘

Note

All sample projects used in this guide include the default XML datasource and will be imported automatically with the sample project. There's no need to perform the following steps unless you want to modify it

  1. Go to SmartIQ Manage.

  2. Click on Data Connections > New Data Connection.

  3. Define following options:

  1. Click Data Objects > New Data Object.

  2. Provide the following option values:

  • Object Type: Hierarchical XPath
  • Data Object Name / Definition: DocuSignEnvelopeInformation
  • Display Name: DocuSignEnvelopeInformation
  1. Select all available Filter and Display Fields.

Make sure you include this Data Connection in the form that will be used by DocuSign Connect adding the root data source with following parameters:

  • Data Source: DocuSign Connect
  • Table/View: DocuSignEnvelopeInformation
  • Non Visible
  • Selection: Single Row
  • Unique Field: (None)
  • Default Type: Default Index
  • Default Index: 1

A hierarchical data connection can be added pointing to previous data connection, allowing to map and use:

  • CustomFields
  • RecipientStatus
  • TabStatus
  • Fields

More information can be found in official DocuSign Web Page.

Here a brief description of hierarchical datasource configuration:

  • Data Source: Root Datasource, for example: (Question)DocuSign Connect - DocuSign EnvelopeInformation
  • Table/View: Hierarchical entry, for example: EnvelopeStatus\RecipientStatuses\RecipientStatus
  • Non Visible
  • Selection: Single Row
  • Unique Field: (None)
  • Default Type: Default Index
  • Default Index: 1

Configuring these datasources, allows SmartIQ Designers to access data sent by DocuSign Connect to the form.

Generate Form

This scenario allows to automatically run an SmartIQ Form based on a DocuSign Connect Event, allowing to use information sent by DocuSign Connect and perform subsequent Actions. Ensure the DocuSign Service Account is assigned to the correct folder to run this form.

Here a high-level overview of the process

  • Form A: Creates DocuSign Envelope, you need to include the following parameters:
    DocuSign Connect
        Operation: Generate Form
        <<productname>> Data Service Guid: "XML Data Source Guid"
        <<productname>> Generate Form Guid: "Form B Guid"
    
  • Form B: Executed automatically once DocuSign Event is triggered. You will need to include the XML Datasource described above.

You can use the following sample projects to see this scenario in action:

  • Form A: DocuSign Connect - Create Envelope (Generate Form) Download
  • Form B: DocuSign Connect - Generate Form Download

Prepare Form

This scenario allows to pre-fill a Form using data provided by DocuSign Connect once configured event is triggered.

Here a high-level overview of the process

  • Form A: Creates DocuSign Envelope, you need to include the following parameters:
    DocuSign Connect
        Operation: Prepare Form
        <<productname>> Data Service Guid: "XML Data Source Guid"
        <<productname>> Generate Form Guid: "Form C Guid"
        <<productname>>  Prepare Form Guid: "Form B Guid"
        <<productname>> Prepare Form Label: "prepareformurl"
        <<productname>>  Prepare Create In Progress: "True|False"
        <<productname>> Prepare Form Description: "In-Progress Description"
        <<productname>> Prepare Form Impersonate User: "User Details (GUID or UserName)" (ONLY AVAILABE ON INFINITI 11.0.5 onwards)
    

📘

Note

SmartIQ Prepare Create In Progress, SmartIQ Prepare Form Description and SmartIQ Prepare Form Impersonate User are optional parameters.

  • Form B: Form to be pre-filled using data provided by DocuSign Connect. You will need to include the XML Datasource described above.

  • Form C: Used to get the Url of recently pre-filled Form. You will need to create a Label and modify Answer File Properties to Save by unique label and set it to prepareformurl, note that this value is the same specified in <<productname>> Prepare Form Label Action Property.

  • Impersonating User details: This is the Username or User GUID of the user that will be impersonated by the DocuSign Connect service account to prepare the form. Please note that the service account that calls the
    prepare form must have the 'Impersonate Users' permission set in Manage to be allowed to make this call.

You can use the following sample projects to see this scenario in action:

  • Form A: DocuSign Connect - Create Envelope (Prepare Form) Download
  • Form B: DocuSign Connect - Prepare Form Download
  • Form C: DocuSign Connect - Prepare Form Url Download

Submit Workflow

This scenario allows to move an SmartIQ Workflow to a temporary Workflow State waiting for DocuSign Connect to transition it to the next State based on a configured event. Note that the Envelope needs to be created immediately before this "Temporary state" and that is assigned to the DocuSign Service account.

Here a high-level overview of the process

  • Form A: Creates DocuSign Envelope, you need to include the following parameters:
    DocuSign Connect
        Operation: Submit Workflow
        <<productname>> Data Service Guid: "XML Data Source Guid"
    

You can use the following sample projects to see this scenario in action:

  • Form A: DocuSign Connect - Create Envelope (Submit Workflow) Download

Troubleshooting

Consider turning on Troubleshooting mode Mode to troubleshoot problems you experience when running the DocuSign Actions.

Once Troubleshooting Mode has been enabled, SmartIQ will display logging messages of the Action in Management Console.

Workflow Webhook Receiver

This debug option will enable receiving event notifications from third-party senders to help progress workflows and identify issues that occur in your environments. The Workflow Webhook Receiver option is independent of Troubleshooting Mode.

Once the Workflow Webhook Receiver option has been enabled, SmartIQ will display logging messages in Manage > Event Log.

To enable this option:

  1. In Manage, go to Settings > Security.

  2. Select the Workflow Webhook Receiver option.

  1. Click Save.