📘

Configuration and Usage

For configuration and usage of this connector please go to the Docusign Connector guide.

Installation Requirements

📘

SaaS Environments

No action needs to be taken for customers on cloud deployments hosted by Smart Communications as the environment should already have this connector installed. If you need a licence please contact your Customer Service Manager.

For customers on self-hosted deployments (either in the cloud or on-premise), consider the following requirements before installing or upgrading this extension:

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

🚧

️ ️Licence key required

You must have a valid license key to enable the DocuSign module. If you do not have one, please contact your SmartIQ representative.

• You must set up an Integrator Key associated with your DocuSign account.

❗

️ Schedule Downtime

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, this 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.

Installation Files

You must have the following installation file:

• DocuSignExtension.dll

Installing the Connector

📘

Make sure a DocuSign license key has been applied before making changes to the Produce and Manage settings.

Produce Configuration

1. Copy the Installation Files 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.

Manage Configuration

1. Copy the Installation Files 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.

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

📘

Note

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

Upgrading the Connector

If your SmartIQ environment is already running an earlier version of the DocuSign connector and you are upgrading to a new version of SmartIQ, 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, refer to “How to upgrade a Legacy DocuSign Connector below.

Can I install both versions at the same time?

No, the version 3 Connector is based on the Provider Model which is incompatible with this version of SmartIQ.

❗

For Legacy Version DocuSign Connectors

If you have been using the legacy version of the Docusign Connector, remove the legacy version of the DocuSign Connector ONLY AFTER 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 Installation Files 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.

How to Upgrade a Legacy DocuSign Connector

📘

This migration has to occur prior to upgrade to the current version.

1. Make sure you remove all files of the current DocuSign Connector from your SmartIQ web server. Navigate to your [<<productname>> 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 the following 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 Installation Files (these files should be found in upgrade pack’s “Bin” folder) into your [<<productname>> Produce Path]\bin and [<<productname>> 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 Installation Files 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.

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, use this path:
c:\inetpub\wwwroot\<<productname>>\IntelledoxScheduler
Also, you must apply the same configuration changes as instructed for the Produce appsettings.json file.