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:

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

Version History

Version 1.0 (released 21 April 2016)

• Initial Release

Version 1.1 (released 22 August 2016)

• New filter Fields: envelopeId and status available for Get Envelopes Status Method for DocuSign Data Source.
• Support of following recipient types: Agents, Carbon Copy, Certified Delivery, Editor, In Person Signer, Intermediary and Signer.
• Brand Id supported.
• Recipient Recursion supported (allows the same person to sign multiple times in a document).
• Routing Order Supported (sequential and parallel orders for DocuSign workflow).
• New Authentication methods supported: SMS, ID, Phone, Access Code, Social (Facebook, Google, LinkedIn and Salesforce).
• Custom Fonts for Tabs, including Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, OcrA, MSGothic and MSMincho.

Version 1.2 (released 31 March 2017)

• New Syntax to support additional attributes for Signer TAB’s.
• Supplemental Documents
• Sign On Paper
• DocuSign Hyperlinks
• DocuSign Payments

Version 2.0 (released 5 September 2018)

• Introduce DocuSign hierarchical action inputs – a better way to populate envelopes’ fields.
• Dynamic recipients from repeating sections and data sources.
• Support most fields needed for Envelope creations.
• Embedded signing in a separate action, supporting several users and workflow.
• Improved Authentication
• Troubleshooting mode

Note: Requires Infiniti v10

Version 2.1 (released April 2019)

• DocuSign Connect

Version 2.2 (released April 2019)

• Get DocuSign Document Action
• Setup Docusign Connect Auto-trigger Action

Version 3.0

• Mobile Responsive Signing.
• DocuSign Identity.
• Get Document Question improvements.
• Connector performance improvements.

Version 3.1 (February 2020)

• Target DocuSign API v2.1.
• Included Require Upload Signature parameter for Signer and InPersonSigner.

Version 3.1.1 (March 2020)

• Fixed download file issue in Get Document Question

Version 3.2 (March 2020)

• Supports named connector setting sets
• Connector setting value types
• Encrypt Integrator Key and RSA Private Key values

Version 3.2.1 (May 2020)

• Fixed an improper resource shutdown or release on some errors
• Fixed an issue with docusign connect custom input value keys

Note that 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.

Connector Components

Action

• Create DocuSign Envelope
• Create DocuSign Embedded Signing URL
• Setup Docusign Connect Auto-trigger
• Get DocuSign Document

Data Source

• Envelope Status
• Envelope Documents
• Recipient Information

Question Extension

• Download Documents

Installation and Configuration

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.

4. Navigate to the Admin Console clicking Go To Admin on the right top menu.
5. Click API and Keys located on the left menu.
6. 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.
7. 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-----
8. 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

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

• Navigate to Settings and then click on the “DocuSign” tab.
• Review and update the settings as required each of the required settings are described in the table below.
• 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).

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.

4. Publish and then Run the project.
5. The user will be presented with a request to grant signature and impersonation permissions to SmartIQ
6. 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.

Installation

Installation Requirements

Before installing this connector, you must consider the following requirements:

• You must have administrator/elevated permissions to the SmartIQ web server, including the ability to copy and replace files in the SmartIQ installation folder. This is usually c:\inetpub\wwwroot\<<productname>> however may vary from system to system.
• You must have an appropriate DocuSign account including the credentials and integration key to use for authentication with DocuSign. For development and testing purposes, go to DocuSign Developer Center.
• You must have a valid license key for this connector. If you don’t have a license key contact your SmartIQ representative.
• You must set up an Integrator Key associated with your DocuSign account.
• You must have the following installation file:
  • DocuSignExtension.dll

- Changes to the configuration may cause interruptions to users in forms.

- Before installing this Connector in a production SmartIQ environment, ensure the environment is backed up.

- It is recommended that this installation is tested in a non-production environment first, and installed during scheduled downtime.

Use the instructions below to install the connector. If you are upgrading the extension from a previous version, refer to the section Upgrading the Connector.

Note that [<<productname>> Produce Path] refers to the installation path on the web server running SmartIQ, where the Produce site has been installed. By default this is c:\inetpub\wwwroot\<<productname>>\produce however may vary from environment to environment. Equally, [<<productname>> Manage Path] refers to where the Manage site has been installed, and [<<productname>> Scheduler Path] refers to the where the Scheduler service has been installed.

Installing the connector

Produce Configuration

1. Using a text editor Copy the files listed above into the following folder on the SmartIQ web server:
   [<<productname>> Produce Path]\bin
2. Using an editor such as Notepad, open the following file: [<<productname>> Produce Path]\appsettings.json
3. Locate the <Extensions> section and add the following entries:

"DocuSignExtension.CreateEnvelopeAction, DocuSignExtension",
"DocuSignExtension.GetDocuSignDocument, DocuSignExtension",
"DocuSignExtension.SetupConnect, DocuSignExtension",
"DocuSignExtension.CreateEmbeddedSigningURLAction, DocuSignExtension",
"DocuSignExtension.DocuSignDataSource, DocuSignExtension",
"DocuSignExtension.GetDocumentQuestion, DocuSignExtension"

4. Using a web browser, navigate to the SmartIQ Produce to allow the system to register DocuSign Connector. Make sure a DocuSign license key has been applied.

Manage Configuration

1. Using a text editor Copy the files listed above into the following folder on the SmartIQ web server:
   [<<productname>> Manage Path]\bin
2. Using an editor such as Notepad, open the following file: [<<productname>> Manage Path]\appsettings.json
3. Locate the <Extensions> section and add the following entries:

"DocuSignExtension.DocuSignDataSource, DocuSignExtension"

4. Using a web browser, navigate to the SmartIQ Manage to allow the system to register DocuSign Connector. Make sure a DocuSign license key has been applied.

The DocuSign Connector should now be installed, ready for configuration and usage.

Additional configuration might need required in DocuSign Admin Portal to enable additional features like:brand id, supplemental documents, on paper signature and other DocuSign configuration, please refer to DocuSign official documentation.

-Optional- Enabling Log Mode

For tracking purposes, all Create DocuSign Envelope transactions can be stored in the SmartIQ Database when Log Mode is turned on.

1. Using SQL Management Studio connect to the SmartIQ database server.
2. Locate and right click the SmartIQ Database and select New Query.
3. Cut and paste the contents of the DocuSignScript.sql file into the query window and click execute (this file should be found in upgrade pack’s Scripts folder).

Upgrading the Connector

If your SmartIQ environment is already running an earlier version of the DocuSign connector and you are simply upgrading to a new version for SmartIQ version 10, please follow these simple upgrade steps below.

How do I know if I need to run these steps?

A sign that you are using an earlier version of the DocuSign Connector is having a dll called DocuSignConnector.dll in both [<<productname>> Produce Path]\bin and [<<productname>> Manage Path]\bin folder. If this is the case, follow “How to upgrade a Legacy DocuSign Connector” below.

Can I install both versions at the same time?

Yes, the version 3 Connector and the version 4 Extension can co-exist in the same instance. This is to allow existing version 3 users to migrate to the new hierarchical attribute format gradually.

How to upgrade a Legacy DocuSign Connector

1. Make sure you remove all files of the current DocuSign Connector from your SmartIQ web server. Navigate to your [SmartIQ Produce Path]\bin folder, then remove these following files:

• DocuSign.eSign.dll
• DocuSignConnector.dll
• RestSharp.dll

2. Navigate to your [<<productname>> Manage Path]\bin folder, then remove the same files listed in Step 1.
3. Using a text editor such as Notepad, open [<<productname>> Produce Path]\appsettings.json. Locate the “Extensions” section of the appsettings.json file and remove the following entries:

"Intelledox.Action.LegacyAction`1[[DocuSignConnector.DocuSignAction, DocuSignConnector]], Intelledox.Action",
"Intelledox.CustomQuestion.LegacyCustomQuestion`1[[DocuSignConnector.GetDocumentQuestion, DocuSignConnector]], Intelledox.CustomQuestion",
"Intelledox.Datasource.LegacyDatasource`1[[DocuSignConnector.DocuSignDataSource, DocuSignConnector]], Intelledox.Datasource"

4. Locate the “LegacyActions” property if present, and remove the following:

"LegacyActions": {
  "DocuSignConnector.DocuSignAction, DocuSignConnector": {
    "Name": "Send to DocuSign"
  }
}

5. Locate the “LegacyDatasources” property if present, and remove the following:

"LegacyDatasources": {
  "DocuSignConnector.DocuSignDataSource, DocuSignConnector": {
    "Name": "DocuSign"
  }
}

6. Locate the “LegacyCustomQuestions” property if present, and remove the following:

"LegacyCustomQuestions": {
  "DocuSignConnector.GetDocumentQuestion, DocuSignConnector": {
    "Name": "Get Document"
  }
}

7. Using a text editor such as Notepad, open [<<productname>> Manage Path]\appsettings.json. Locate the “Extensions” section of the appsettings.json file and remove the following entries:

"Intelledox.Datasource.LegacyDatasource`1[[DocuSignConnector.DocuSignDataSource, DocuSignConnector]], Intelledox.Datasource"

8. Locate the “LegacyDatasources” property if present, and remove the following:

"LegacyDatasources": {
  "DocuSignConnector.DocuSignDataSource, DocuSignConnector": {
    "Name": "DocuSign"
  }
}

9. Run below database script to completely remove the DocuSign legacy connector from your database:

DELETE FROM [dbo].[ConnectorSettings_Type]
WHERE [ConnectorSettingsTypeId] = '6F56ECB0-FF8E-41B7-BF5A-3C0FC21BFC21'

DELETE FROM [dbo].[ConnectorSettings_ElementType]
WHERE [ConnectorSettingsTypeId] = '6F56ECB0-FF8E-41B7-BF5A-3C0FC21BFC21'

DELETE FROM [dbo].[Routing_Type]
WHERE [RoutingTypeId] = 'AADA7C29-C6BA-4B45-B5F7-59CF60B66A89'

DELETE FROM [dbo].[Routing_ElementType]
WHERE [RoutingTypeId] = 'AADA7C29-C6BA-4B45-B5F7-59CF60B66A89'

DELETE FROM [dbo].[CustomQuestion_Type]
WHERE [CustomQuestionTypeId] = '5F6BF73A-DC92-4379-8480-E9FDA5A36B81'

DELETE FROM [dbo].[CustomQuestion_InputType]
WHERE [CustomQuestionTypeId] = '5F6BF73A-DC92-4379-8480-E9FDA5A36B81'

10. Copy the files listed in Installation and Configurations requirements section (these files should be found in upgrade pack’s “Bin” folder) into your [SmartIQ Produce Path]\bin and [SmartIQ Manage Path]\bin folder:

• DocuSignExtension.dll

11. Using a text editor such as Notepad, open the file [<<productname>> Produce Path]\appsettings.json
12. Locate the <Extensions> section of the appsettings.json file and add the following entries:

"DocuSignExtension.CreateEnvelopeAction, DocuSignExtension",
"DocuSignExtension.CreateEmbeddedSigningURLAction, DocuSignExtension",
"DocuSignExtension.DocuSignDataSource, DocuSignExtension",
"DocuSignExtension.GetDocumentQuestion, DocuSignExtension"

13. Copy the files listed above into the following folder on the SmartIQ web server:
    [<<productname>> Manage Path]\bin
14. Using a text editor such as Notepad, open the following file:
    [<<productname>> Manage Path]\appsettings.json
15. Locate the <Extensions> section of the appsettings.json file and add the following entries:

"DocuSignExtension.DocuSignDataSource, DocuSignExtension"

16. Using a web browser, navigate to the <<productname>> Produce and <<productname>> Manage applications to allow the system to register the Connector.

Only remove the legacy version of the DocuSign Connector when you have finished migrating all your projects to using the newer version of the connector.
If you are still in the progress of migrating your projects, we would recommend keeping both versions of the connector in your environment.

How to upgrade a v10 DocuSign Connector

1. Make sure you clear all action inputs of the DocuSign Connector registered in the database, as the newer version of the connector will re-register them upon successful upgrade. Copy and paste the contents of the DocuSignScript.sql file into the query window and click Execute.

DELETE FROM [dbo].[Routing_ElementType]
  WHERE [RoutingTypeId] = 'CCF35103-A237-46D1-807F-CB7DE26C450E'

2. Copy the files listed above in Installation and Configurations requirements section into the following folders on the SmartIQ web server, overwriting the existing files:
   [<<productname>> Produce Path]\bin and [<<productname>> Manage Path]\bin
3. Using a web browser, navigate to the SmartIQ Produce application to allow the system to register the upgraded connector.
4. In the web browser, also navigate to the SmartIQ Manage application.

Installing DocuSign to support SmartIQ Scheduler

If the target environment is using SmartIQ Scheduler, it is best practice to always install connectors and accelerators to this service at the same time as the installation in SmartIQ Produce application. If this is not installed to the Scheduler there may be errors if any projects are executed from the scheduler that refers to this connector.

To install any connector to the Scheduler, follow the instructions in this guide as they apply to SmartIQ produce, except instead of [<<productname>> Produce Path] use [<<productname>> Scheduler Path], noting that there is no ‘bin’ folder in this path so all files should be copied into the root of this path. For example, consider the path:
c:\inetpub\wwwroot\<<productname>>\produce\bin
To install to the Scheduler, simply use this path:
c:\inetpub\wwwroot\<<productname>>\IntelledoxScheduler
Also, you must apply the same configuration changes as instructed for the Produce appsettings.json file.

Architecture

Using the DocuSign Connector

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

Action - Create DocuSign Envelope

📘

DocuSign Templates

If you have the DocuSign Connector installed, a license for DocuSign in Intelledox 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.

You can find SmartIQ sample projects Click Here

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.

🚧

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 Action

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

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.

If this action is dragged onto a workflow transition, the next stage guid is automatically updated in the envelope.
IMPORTANT NOTE: 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

• In a web browser, navigate to the SmartIQ Manage application and log in. E.g. http:\\serverName\manage
• Click on Data Sources label on the left panel
• Click the New Data Source button (top left)
• Select the Connection type as DocuSignDataSource and then fill in the following settings panels.

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

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.

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.

Troubleshooting

Consider turning on Troubleshooting Mode to troubleshoot problems you experience when running the DocuSign Actions. Instruction on how to configure Troubleshooting Mode can be found here.
Once Troubleshooting Mode has been turned on, SmartIQ will display logging messages of the Action in Management Console.

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

• Navigate to your DocuSign Account using your preferred browser and click on Go To Admin on the upper-right menu.
• Click Connect option under INTEGRATIONS in the left side menu.
• Click ENABLE CONNECT button.
• Click Custom option under ADD CONFIGURATION button
• Provide a meaningful Name, like: `SmartIQ'
• Under URL to Publish (HTTPS required) provide the following URL: https://{{yourServer}}/Produce/DocuSignConnect
• 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.
• 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.
• Enable further options as required.
• 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 <<productname>> Manage.
2. Click on Data Sources.
3. Click on New Data Source.
4. Define following options:

• DataSource Name: DocuSign Connect
• Connection Type: XML
• Schema: Upload DocuSign Connect Schema.xsd
• Default Data: Upload DocuSign Connect Default Data.xml

5. Click on Data Objects.
6. Click on New Data Object.
7. Provide the following option values:

• Object Type: Hierarchical XPath
• Data Object Name / Definition: DocuSignEnvelopeInformation
• Display Name: DocuSignEnvelopeInformation

8. Select all available Filter and Display Fields.

Make sure you include this Datasource in the form that will be used by DocuSign Connect Adding the root datasource 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 datasource can be added pointing to previous datasource, 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:
  Text

  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:

  Text

  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: <<productname>> Prepare Create In Progress, <<productname>> Prepare Form Description and <<productname>> 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:
  Text

  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