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 Infiniti forms and DocuSign.
Usage of Intelledox Infiniti 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
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
Patch 2.2.0.3 (released May 2019)
- Fixed to include getting the base url from the restapi/v2/login_information call
Note: Requires Infiniti v11
Version 3.0 (released June 2019)
- Improved Get Document Question
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 Intelledox representative.
Connector Components
Action
- DocuSign Create Envelope
- DocuSign Create Embedded Signing URL
- DocuSign Setup Connect Auto-trigger
- DocuSign Get Document
DocuSign Data Source
- Envelope Status
- Envelope Documents
- Recipient Information
DocuSign Question Extension
- Download Documents
Installation and Configuration
Creating a DocuSign Sandbox
You’ll require a dev sandbox to perform tests and build solutions using Intelledox Infiniti and DocuSign.
- Create a new free Dev sandbox account Click Here
- You'll receive a confirmation email, click "Verify Account".
- Change Password.
At this point, you have successfully created a Sandbox that you can be used to develop and test your Intelledox Infiniti projects.
- Navigate to the Admin Console clicking Go To Admin on the right top menu.
- Click API and Keys located on the left menu.
- 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.
Intelledox - Infiniti
- Redirect URIs: Provide Produce URL, note that this value can be defined under Mange > Settings > DocuSign.
- App Description: Name for this specific integration; e.g.
- 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----- - 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 Infiniti 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 Infiniti Produce URL
with a slash at the end, however, you can overrride it in Manage -> Settings -> DocuSign.
In most DocuSign Authentication workflows, Infiniti 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 Infiniti to act on their behalf. A Redirect URI is used for Infiniti 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 Infiniti, 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.
- Find the generated Integrator Key and click on the Integrator Key or in the
Actions
drop down selectEdit
. - In the
Redirect URIs
section, clickAdd
. - Enter the new Redirect URI, this should be the
Infiniti Produce URL
.
Configuring the Connector settings
In a web browser, navigate to the Infiniti 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.
Setting | Description |
---|---|
Production Environment | This 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 Username | Specify 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 Key | DocuSign API Integrator Key (Unique ID for each DocuSign integration). This key is retrieved from the DocuSign administration portal. |
RSA Private Key | Upload the text file that contains the RSA Private Key obtained from Installation and Configurations step. |
Embedded Signing Return Url | Specify the URL that the embedded signer’s browser will be re-directed to after the signer has finished. |
Log Mode | True/False This option that allows storing in the Infiniti 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 Infiniti DB. This option is only recommended for customers that require local audit logs, DocuSign also stores successful requests in its user portal. |
Redirect URI | Infiniti will automatically use the Infiniti Produce URL as the default Redirect URI used during Consent Access is established the first time DocuSign is used by Infiniti. 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. |
Ensuring the user profile is loaded
IIS and Azure App Service
This connector implements RSA for authentication, due to the Data Protection Scope of the cryptography, user profile needs to be loaded.
IIS
- Open IIS
- Go to Application Pools
- Select Infiniti App Pool
- Click "Advanced Settings"
- Under Process Model, verify that Load User Profile is set to True
- Restart Infiniti App Pool.
Azure App Service
- Go to your App Service
- Ensure you have a correct tier (at least B1, this will not work for shared infrastructure: F1 or D1).
- Go to Application Settings and create a new app settings entry: WEBSITE_LOAD_USER_PROFILE=1
- Restart App
Obtaining a DocuSign Admin Consent
Once the DocuSign Connector is installed successfully and the Connector Settings have been configured, Infiniti will need to obtain consent from a DocuSign Admin user to make API calls on their behalf. Infiniti 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 Infiniti.
To obtain a DocuSign Admin consent
- Create a new Infiniti Project.
- Drag and Drop the "Create DocuSign Envelope" into the project.
- 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.
- Publish and then Run the project.
- The user will be presented with a request to grant signature and impersonation permissions to Infiniti
- Click “Accept” and the user should be redirected back to the Infiniti 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 Infiniti web server, including the ability to copy and replace files in the Infiniti installation folder. This is usually
c:\inetpub\wwwroot\infiniti
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 Intelledox representative.
- You must set up an Integrator Key associated with your DocuSign account.
- You must have the following installation files:
DocuSignExtension.dll
BouncyCastle.Crypto.dll
- Changes to the configuration may cause interruptions to users in forms.
- Before installing this Connector in a production Infiniti 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 [Infiniti Produce Path]
refers to the installation path on the web server running Infiniti, where the Produce site has been installed. By default this is c:\inetpub\wwwroot\infiniti\produce
however may vary from environment to environment. Equally, [Infiniti Manage Path]
refers to where the Manage site has been installed, and [IntelledoxScheduler Path]
refers to the where the Scheduler service has been installed.
Installing the connector
Produce Configuration
- Using a text editor Copy the files listed above into the following folder on the Infiniti web server:
[Infiniti Produce Path]\bin
- Using an editor such as Notepad, open the following file:
[Infiniti Produce Path]\appsettings.json
- 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"
- Using a web browser, navigate to the Infiniti Produce to allow the system to register DocuSign Connector. Make sure a DocuSign license key has been applied.
Manage Configuration
- Using a text editor Copy the files listed above into the following folder on the Infiniti web server:
[Infiniti Manage Path]\bin
- Using an editor such as Notepad, open the following file:
[Infiniti Manage Path]\appsettings.json
- Locate the
<Extensions>
section and add the following entries:
"DocuSignExtension.DocuSignDataSource, DocuSignExtension"
- Using a web browser, navigate to the Infiniti 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 Infiniti Database when Log Mode is turned on.
- Using SQL Management Studio connect to the Infiniti database server.
- Locate and right click the Infiniti Database and select New Query.
- 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’sScripts
folder).
Upgrading the Connector
If your Infiniti environment is already running an earlier version of the DocuSign connector and you are simply upgrading to a new version for Infiniti 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 [Infiniti Produce Path]\bin
and [Infiniti 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
- Make sure you remove all files of the current DocuSign Connector from your Infiniti web server. Navigate to your [Infiniti Produce Path]\bin folder, then remove these following files:
DocuSign.eSign.dll
DocuSignConnector.dll
RestSharp.dll
- Navigate to your
[Infiniti Manage Path]\bin
folder, then remove the same files listed in Step 1. - Using a text editor such as Notepad, open
[Infiniti Produce Path]\appsettings.json
. Locate the“Extensions”
section of theappsettings.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"
- Locate the
“LegacyActions”
property if present, and remove the following:
"LegacyActions": {
"DocuSignConnector.DocuSignAction, DocuSignConnector": {
"Name": "Send to DocuSign"
}
}
- Locate the
“LegacyDatasources”
property if present, and remove the following:
"LegacyDatasources": {
"DocuSignConnector.DocuSignDataSource, DocuSignConnector": {
"Name": "DocuSign"
}
}
- Locate the
“LegacyCustomQuestions”
property if present, and remove the following:
"LegacyCustomQuestions": {
"DocuSignConnector.GetDocumentQuestion, DocuSignConnector": {
"Name": "Get Document"
}
}
- Using a text editor such as Notepad, open
[Infiniti Manage Path]\appsettings.json
. Locate the“Extensions”
section of theappsettings.json
file and remove the following entries:
"Intelledox.Datasource.LegacyDatasource`1[[DocuSignConnector.DocuSignDataSource, DocuSignConnector]], Intelledox.Datasource"
- Locate the
“LegacyDatasources”
property if present, and remove the following:
"LegacyDatasources": {
"DocuSignConnector.DocuSignDataSource, DocuSignConnector": {
"Name": "DocuSign"
}
}
- 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'
- Copy the files listed in Installation and Configurations requirements section (these files should be found in upgrade pack’s “Bin” folder) into your [Infiniti Produce Path]\bin and [Infiniti Manage Path]\bin folder:
DocuSignExtension.dll
BouncyCastle.Crypto.dll
- Using a text editor such as Notepad, open the file
[Infiniti Produce Path]\appsettings.json
- Locate the
<Extensions>
section of theappsettings.json
file and add the following entries:
"DocuSignExtension.CreateEnvelopeAction, DocuSignExtension",
"DocuSignExtension.CreateEmbeddedSigningURLAction, DocuSignExtension",
"DocuSignExtension.DocuSignDataSource, DocuSignExtension",
"DocuSignExtension.GetDocumentQuestion, DocuSignExtension"
- Copy the files listed above into the following folder on the Infiniti web server:
[Infiniti Manage Path]\bin
- Using a text editor such as Notepad, open the following file:
[Infiniti Manage Path]\appsettings.json
- Locate the
<Extensions>
section of theappsettings.json
file and add the following entries:
"DocuSignExtension.DocuSignDataSource, DocuSignExtension"
- Using a web browser, navigate to the
Infiniti Produce
andInfiniti 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
- 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'
- Copy the files listed above in Installation and Configurations requirements section into the following folders on the Infiniti web server, overwriting the existing files:
[Infiniti Produce Path]\bin
and[Infiniti Manage Path]\bin
- Using a web browser, navigate to the Infiniti Produce application to allow the system to register the upgraded connector.
- In the web browser, also navigate to the Infiniti Manage application.
Installing DocuSign to support Intelledox Infiniti Scheduler
If the target environment is using Intelledox Infiniti Scheduler, it is best practice to always install connectors and accelerators to this service at the same time as the installation in Infiniti 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 Infiniti Produce, except instead of [Infiniti Produce Path]
use [IntelledoxScheduler 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\infiniti\produce\bin
To install to the Scheduler, simply use this path:
c:\inetpub\wwwroot\infiniti\intelledoxscheduler
Also, you must apply the same configuration changes as instructed for the Produce appsettings.json
file.
Architecture
Using the DocuSign Connector
Action - DocuSign Create Envelope
While the action extensions are installed, they will not be called until a project is set up in Infiniti 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 Infiniti sample projects Click Here
Action - DocuSign Create Embedded Signing URL
Once you’ve added the DocuSign Create 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.
Name | Description |
---|---|
Envelope Id | Id of an existing Envelope. This could be retrieved from the DocuSign Create Envelope action output. |
Client User Id | To perform embedded signing ceremony, the DocuSign Create 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 Url | The 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. |
Once all the action attributes are configured, the DocuSign Create Embedded Signing URL action will create an embedded signing URL and immediately redirect the user to that URL to perform a signing ceremony.
Action - DocuSign Get Document
There's a new action included with DocuSign Connector that allows to include DocuSign Documents into Infiniti, 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
Input | Description |
---|---|
Envelope Id | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
Document Id | The 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 Name | Name of the downloaded document, this value will be used by Infiniti. |
Certificate Language | Specifies 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. |
Show Changes | When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. |
Watermark | When 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 - DocuSign Setup 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.
Name | Description |
---|---|
Envelope Id (required) | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
Docusign Connect | This 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 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 Infiniti
- In a web browser, navigate to the Infiniti 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.
Setting | Description |
---|---|
Data Source Name | Any relevant name. |
Connection Type | DocuSignDataSource |
Connection String | Any relevant name, E.g. DocuSign |
Credentials | No Credential Required |
- Click Save to commit the Changes.
- 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.
- Click on the Data Objects Button (top) and add the following objects
Display Name | Object Type | Filter Fields |
---|---|---|
Get Envelope Documents | Method | envelopeId |
Get Envelopes Status | Method | envelopId, fromDate and status |
Get Recipient Information | Method | envelopeId |
Question Extension - DocuSign Get Document
The DocuSign Get Document Question will add a button in the Infiniti form that allows users to download documents directly from DocuSign.
Name | Description |
---|---|
Document Url (Legacy) | URL 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. |
Envelope Id | Id of an existing Envelope. This could be retrieved from the Create DocuSign Envelope action output. |
Document Id | The 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 Name | Name of the downloaded document, this value will be used by Infiniti. |
Certificate Language | Specifies 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. |
Show Changes | When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. |
Watermark | When 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. |
This question was improved in the version 3.0 of the connector. To load the new Question inputs, run the following script in your Infiniti Databse and navigate to Produce.
DELETE
FROM [dbo].[CustomQuestion_Type]
WHERE CustomQuestionTypeId='F85D53A2-3817-4D4F-BFF7-0FDBAC78444B'
GO
DELETE
FROM [dbo].[CustomQuestion_InputType]
WHERE CustomQuestionTypeId='F85D53A2-3817-4D4F-BFF7-0FDBAC78444B'
GO
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, Infiniti will display logging messages of the Action in Management Console.
DocuSign Connect
Is a fully automated way to get Documents and Data from DocuSign into Intelledox - Infiniti, 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:
- Create a service account in Infiniti that will be exclusively used by DocuSign Connect.
- Enable Connect in your DocuSign Account.
- 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 intelledox Infiniti 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 Intelledox Infiniti groups and that Impersonate Users permission is enabled. Here some simple steps to demonstrate the creation of this account:
- Create a new DocuSign Role (Manage > Roles > New Role) where:
Role Name
: docusign and the PermissionImpersonate Users
is selected. (this option is required to prepare forms on behalf other users). - Click
Save
. - Create a new Intelledox Infiniti User (Manage > Users > New User) where:
User Name
: docusign
Password
: yourPassword - Click
Save
. - Click
Security
and select the relevant Groups to ensure the service account has access to all relevant forms and that the newdocusign
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 meaninful Name, like:
Intelledox - Infiniti
- Under URL to Publish (HTTPS required) provide the following URL:
https://{{yourServer}}/Produce/DocuSignConnect
- Click Include Basic Authentication Header and provide Infiniti Service account Username and password. Note that this account needs to have appropiate permissions to perform Infiniti operations on those projects that will be automated with DocuSign Connect.
- Enable further options as required.
- Click Save.
Infiniti 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
- Go to
Infiniti Manage
. - Click on
Data Sources
. - Click on
New Data Source
. - Define following options:
- DataSource Name: DocuSign Connect
- Connection Type: XML
- Schema: Upload DocuSign Connect Schema.xsd
- Default Data: Upload DocuSign Connect Default Data.xml
- Click on
Data Objects
. - Click on
New Data Object
. - Provide the following option values:
- Object Type: Hierarchical XPath
- Data Object Name / Definition: DocuSignEnvelopeInformation
- Display Name: DocuSignEnvelopeInformation
- 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 Infiniti Designers to access data sent by DocuSign Connect to the form.
Generate Form
This scenario allows to automatically run an Infiniti 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.
Note: Infiniti Impersonate User Action input can be used optionally
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 Infiniti Data Service Guid: "XML Data Source Guid" Infiniti 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 Infiniti Data Service Guid: "XML Data Source Guid" Infiniti Generate Form Guid: "Form C Guid" Infiniti Prepare Form Guid: "Form B Guid" Infiniti Prepare Form Label: "prepareformurl" Infiniti Prepare Create In Progress: "True|False" Infiniti Prepare Form Description: "In-Progress Description" Infiniti Prepare Form Impersonate User: "User Details (GUID or UserName)" (ONLY AVAILABE ON INFINITI 11.0.5 onwards) Note: Infiniti Prepare Create In Progress, Infiniti Prepare Form Description and Infiniti 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
toSave by unique label
and set it toprepareformurl
, note that this value is the same specified inInfiniti 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 Infiniti Workflow to a temporay 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 inmediately before this "Temporary state" and that is assigned to the DocuSign Service account.
Note: Infiniti Impersonate User Action input can be used optionally
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 Infiniti 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
Updated over 4 years ago