DocuSign Connection¶

Introduction¶

A DocuSign connection, created using the DocuSign connector, establishes access to DocuSign. Once a connection is configured, you can create instances of DocuSign activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or Edit a DocuSign Connection¶

A new DocuSign connection is created using the DocuSign connector from one of these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The Global Connections page (see Create a Global Connection in Global Connections).

An existing DocuSign connection can be edited from these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
• The Global Connections page (see Edit a Global Connection in Global Connections).

Configure a DocuSign Connection¶

Each user interface element of the DocuSign connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each DocuSign connection and must not contain forward slashes / or colons :. This name is also used to identify the DocuSign endpoint, which refers to both a specific connection and its activities.

• User GUI (API Username): Enter the DocuSign user ID (see DocuSign Prerequisites).

• Integration Key (Client ID): Enter the integration key for the DocuSign app (see DocuSign Prerequisites).

• Private Key: Enter the DocuSign RSA keypair private key for the DocuSign app (see DocuSign Prerequisites).

• OAuth Base URL Path: Select the DocuSign OAuth base URL path for authentication, either Sandbox or Production:

  • Sandbox: Select if you are using a DocuSign developer account.

  • Production: Select if you are using a paid DocuSign account.

• Token Expire In Seconds: Enter the DocuSign token expiration in seconds. The default value is 300 seconds (5 minutes).

• Redirect URI: Enter the DocuSign redirect URI for the DocuSign app (see DocuSign Prerequisites).

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy. When testing the connection for the first time, an error message may be returned that includes a link to a DocuSign acceptance page where you must accept the permissions being requested by the connector:

  1. Copy the URL shown in the error message into a browser. The DocuSign website will prompt for a login and then ask for permission to grant access to the connector.

     

  2. After accepting and granting permission, you will then be redirected to the Redirect URI.

  3. Click the Test button again.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After a DocuSign connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

• Get: Retrieves object data from DocuSign and is intended to be used as a source in an operation.

• Create: Creates object data in DocuSign and is intended to be used as a target in an operation.

• Send: Sends envelopes to recipients in DocuSign and is intended to be used as a target in an operation.