HomeGuidesRecipesAPI
HomeGuidesAPILog In

DocuSign Configuration

  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 create additional accounts. For example, Sandbox and Production. Additionally, click the Set as Default button to change the default connector set. If the previous Default was set in Design, SmartIQ will now use the new Default connector values.

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.
Log ModeTrue/False

This option allows or disables storing in the SmartIQ database all generated requests to DocuSign. To enable this capability, 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.
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 you to override this value and select a different URL. Note that the exact same URI needs to be 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.
Connect HMAC KeyProvides another layer of security with HMAC with HMAC, an industry standard symmetric hashing system. For more information, refer to HMAC.

🚧

Consent Required Errors

If you receive an error on initial use of Docusign relating to a Consent Required Error, please review the steps to resolve this here

Set-up DocuSign Data Connection 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>> Manage

Add New Data Connection 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