Skip to end of metadata
Go to start of metadata

Introduction

A DocuSign connection is configured via the DocuSign connector to establish access to an account on the DocuSign server. Once a connection is established, you can configure one or more DocuSign activities associated with that connection to use as a source or target within an operation.

Creating or Editing a DocuSign Connection

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

To configure a new DocuSign connection, within the Connectors filter, click the DocuSign connector block:

Connectivity tab

To configure an existing DocuSign connection, within the Endpoints filter, double-click the DocuSign connection block:

Connectivity tab

This will open a configuration screen for the DocuSign connection, covered next.

Configuring a DocuSign Connection

Configuration of a DocuSign connection includes these fields:

Connectivity tab

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Endpoint Name: Enter a name to use to identify the DocuSign connection. The name must be unique for each DocuSign connection and must not contain forward slashes (/) or colons (:).

  • User GUI (API Username): Enter the DocuSign user GUID (API username). See DocuSign Registration.

  • Integration Key (Client ID): Enter the DocuSign integration key (client ID). See DocuSign Registration.

  • Private Key: Enter the DocuSign RSA keypair private key. See DocuSign Registration.

  • OAuth Base URL Path: Select the DocuSign OAuth base URL path for authentication. Specify either Sandbox or Production, depending on the type of DocuSign account. See DocuSign Registration for a description of the different account types.

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

  • Redirect URI: Enter the DocuSign redirect URI. See DocuSign Registration.

  • Test: Click this button to verify the connection. The server will check only that the specified user can make a connection. When testing the connection for the first time, follow these steps:

    1. The first time that a DocuSign connector configuration is tested, it will fail, showing an error message such as:

      Connectivity error

      Additional information is available at the More Details link below the error message.

    2. 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. (The name of the application will match the name specified at the DocuSign configuration. See DocuSign Registration for details.)

      Connectivity acceptance

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

    4. Click the Test button again. It should show the message "Connection Success".

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

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

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

Next Steps

After configuring a DocuSign connection, you can configure one or more DocuSign activities associated with that connection to use as a source or target within an operation. For more information, see these pages:

  • Get: Retrieves data (such as envelopes, templates, and documents) from a DocuSign connection and is used as a source in an operation.

  • Create: Creates envelopes or templates at a DocuSign connection and is used as a target in an operation.

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

On This Page

Last updated:  Oct 09, 2019

  • No labels