Skip to Content

DocuSign Connector

Summary

The Harmony DocuSign Connector establishes access to DocuSign.

The DocuSign connector provides an interface for creating a DocuSign connection, the foundation used for generating instances of DocuSign activities. These activities, once configured, interact with DocuSign through the connection.

The DocuSign connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a DocuSign connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific DocuSign connection and its activities are referred to as a DocuSign endpoint:

DocuSign activity types

  • 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.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The DocuSign connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The DocuSign connector uses the DocuSign eSignature REST API v2. Refer to the API documentation for information on the schema nodes and fields.

To use the DocuSign connector, you must retrieve a user ID, integration key, and private key, and configure a redirect URI (as described in DocuSign Prerequisites).

Troubleshooting

If you experience issues with the DocuSign connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.docusign" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.