Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From DocuSign connection/s to launch the CData Query window. To setup a new connection, you will have to click the New DocuSign Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to DocuSign

UseSandbox
UseSandbox indicates whether the current user account is sandbox or not. This is false by default. Set to true if you are using a sandbox account. All the OAuth flows documented below assume that you have set UseSandbox beforehand.

AccountId
AccountId is an optional connection property. It sets automatically after the authentication succeeds. As an alternative, you can manually set it in the connection string if you have access to multiple Account Ids. In order to retrieve account ids, query the UserInfo view.

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. The add-in support OAuth JWT authentication as well. See Creating a Custom OAuth App for more information about creating custom applications.

OAuth

AuthScheme must be set to OAuth in all user account flows.

Desktop Applications

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

OAuthClientId: Set this to the Integrator Key assigned when you registered your app.
OAuthClientSecret: Set this to the Secret Key assigned when you registered your app.
CallbackURL: Set this to the redirect URI defined when you registered your app.

When you connect the add-in opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.

OAuth JWT

Set the AuthScheme to OAuthJWT.

Obtaining a User ID

Retrieve your User ID by navigating, in the DocuSign UI, to Settings > Apps and Keys > My Account Information > User ID.

Obtaining an Integration Key

Follow the procedure below to obtain an integration key:

Log in to a DocuSign developer account.
Navigate to My Apps and Keys.
You will see a dialog box to enter your application's name. Give your application a short, but descriptive name.
Click ADD to add your application. Your application is automatically assigned an integration key (GUID) value that cannot be changed. Save this value.

Application Consent

In order to connect, you must give consent to the application. DocuSign offers three different software patterns for granting consent to an integration key. Grant consent to your application using one of the following methods.

Method 1: Administrative Consent

This is the best option for customer-oriented developers, because it requires nothing from your users.

Note: This pattern can't be used by ISVs.

This method of obtaining consent has the following prerequisites:

Your account must include the Access Management with SSO feature, though it is not required that you install SSO.
- If your developer demo account (demo.docusign.net) does not include this feature, send an email to [email protected] and request that the feature be added to your account. Remember to include your developer demo account ID.
You must claim your email DNS domain via the DocuSign administration tool. A domain can be claimed both by the DocuSign developer demo system (for testing and development), and by your production DocuSign account.
Your users’ email domains must match the claimed email domain.
Your integration key’s management account must be one of the accounts in the DocuSign organization.

If you meet these requirements, grant consent as follows:

In DocuSign Admin, open your organization home page.
In the navigation pane on the left side of the page, select Connected Apps.
Click Authorize Application and choose an application from the drop-down menu.
In the Add New Application dialog, specify the permissions you want to grant to your application.
Click ADD.

Method 2: Individual Consent

This option has no prerequisites and can be used by customer-oriented developers and the customers of ISVs. Each user must perform the following steps.

To obtain individual consent:

Run the GetConsentURL stored procedure. The procedure returns a URL.
Open the returned URL in your browser. A permissions page will display.
Click Accept to grant consent.

Method 3: Administrative Consent for Third-party (ISV) Applications

You can grant administrative consent to third party (ISV) applications.

This method of obtaining consent has the following prerequisites:

All prerequisites for standard Administrative Consent apply (see section above).
ISVs should also support individual consent as a backup, since SSO not all customers will be able to use administative consent.
If you are an ISV using the JWT grant flow, then the management account tied to your application’s integration key should be a DocuSign account that your company controls.

If you meet these requirements, obtain consent as follows. Each user must perform the following steps.

Run the GetConsentURL stored procedure. The procedure returns a URL.
Open the returned URL in your browser. A permissions page will display.
Click Accept to grant consent.

Configuring OAuth JWT Credentials

Using the information you gathered in the above sections, set the following connection properties in the add-in:

OAuthJWTCert: The location of your private key. This should end with ".key".
OAuthJWTCertType: PEMKEY_FILE
OAuthJWTSubject: Your user ID.
OAuthJWTIssuer: Your integration key.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to DocuSign you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

Excel Add-In for DocuSign