DocuSign Integration Configuration
Before you can create your DocuSign connector, you need to plan for your integration by ensuring it is configured to your needs. Once you have laid out your configuration plan, you can create your integrator key in DocuSign and proceed to the Create connector wizard.
Creating your integrator key in DocuSign
You can create private key, public key, and secret key A secret key is a value that is stored securely in your web server and only shared with your web server and the DocuSign platform. while creating the integrator key. You can use support documents from DocuSign below to create your integration key. Ensure that you choose Authorization Code Grant as the option for authentication.
Only on premise customers have to create an on premise key in DocuSign.
DocuSign Configuration Settings
Once you create a DocuSign connector, you can view all the configuration parameters at any time in the Connectors List view. The Connectors List view can be accessed from the Project Console's Control panel for connectors.
Component |
Function |
---|---|
Stage |
The staging type to use when sending documents to DocuSign. |
UserId |
User Id used to communicate with DocuSign |
Name |
DocuSign account name |
|
DocuSign account name |
Authentication method |
The method Smart Flows uses to authenticate with DocuSign. |
Configuring your DocuSign application.properties
Admins can configure their DocuSign connection to Smart Flows using the parameters below. These parameters relate to the application properties folder for the local server, refer to Installing Smart Flows for more information.
As of October 4, 2022, DocuSign will no longer support docusign.allownative authentication on production environments. If you use it, you should reconfigure your connector to use oauth2 authentication.Please refer to DocuSign's help OAuth 2.0 requirements and migration for more information.
Property |
Description |
Required |
---|---|---|
docusign.allownative |
When true, you can use username/password authentication when setting up a connector to DocuSign. Note that the passwords will be stored in the Smart Flows database. |
No |
docusign.integratorkey |
docusign.integratorkey - alphanumeric identifier (GUID ) value that identifies your application and links it to its configuration values. |
Yes, it is required to use the DocuSign plug-in using oauth authentication. |
docusign.clientid |
docusign.clientid - alphanumeric identifier (GUID ) value that identifies your application and links it to its configuration values. |
Yes, it is required to use the DocuSign plug-in using oauth authentication. |
docusign.clientsecret |
docusign.clientsecret - alphanumeric identifier (GUID ) value that identifies your application and links it to its configuration values. |
Yes, it is required to use the DocuSign plug-in using oauth authentication. This is also required to use the DocuSign sandbox environment. |
docusign.keyfile.public |
Path to the file containing the public part of the sandbox key pair. |
Yes, it is required to use the DocuSign plug-in using oauth authentication. This is also required to use the DocuSign sandbox environment. You must save this file as a separate text file in the Smart Flows Installation folder. |
docusign.keyfile.private |
Path to the file containing the private part of the sandbox key pair. |
Yes, required when you want to use the DocuSign plug-in using oauth authentication. This is also required to use the DocuSign sandbox environment. You must save this file as a separate text file in the Smart Flows Installation folder.
|
docusign.prod.clientsecret |
docusign.clientsecret - alphanumeric identifier (GUID ) value that identifies your application and links it to its configuration values. |
Yes, required when you want to use the DocuSign plug-in using oauth authentication. This is also required to use the DocuSign sandbox environment. |
docusign.prod.keyfile.public |
Path to the file containing the public part of the production key pair. |
Yes, required when you want to use the DocuSign plug-in using oauth authentication. This is also required to use the DocuSign sandbox environment. |
docusign.prod.keyfile.private |
Path to the file containing the private part of the production key pair. |
Yes, required when you want to use the DocuSign plug-in using oauth authentication. This is also required to use the DocuSign sandbox environment. |