Skip to content
PDF

Installing Extension for DocuSign

Prerequisites

This guides assumes the following components to be already installed and configured:

  • AnswerModules ModuleSuite

  • Script Console (OPTIONAL - only for DocuSign webhook configuration)

The following information will be required to complete the configuration procedure:

  • DocuSign API key

  • Docusign API credentials

Authentication Options

The Content Script extension supports two different authentication options when invoking DocuSign APIs:

  • Username / Password
  • Account GUID / RSA Certificate

Refer to the official DocuSign REST API guides for details on how to generate your credentials.

We will refer to the Content Server installation directory as OTCS_HOME

We will refer to the Script Console installation directory as SCRIPT_CONSOLE_HOME

Installation procedure

The Module Suite DocuSign Extension includes two components:

  • Content Script Extension for DocuSign

    This component enables the **docusign* service API in Content Script. The service is the entry point to integrating DocuSign functionality within your applications.*

  • Script Console Extension for DocuSign (Optional)

    This component enables a **DocuSign webhook endpoint* on Script Console. It is only required if you want to receive automatic update notification from DocuSign whenever an envelope status changes. For more details, refer to the official DocuSign REST API Guides related to this topic.*

Installing the Content Script Extension for DocuSign

Run the Module Suite DocuSign installer:

1
module-ansmodulesuitedocusign-1.5.0-OTCSxxx.exe

Follow the installation wizard steps:

  • Select "Next" when ready to start the installation.

  • The installer will prompt you for the location where Content Server is installed. Browse to your OTCS_HOME and select "Next".

  • Review the installation steps for each component to be installed.

  • Click "Finish" to complete the unpacking of the module

Staging

At this point, the Module has been deployed in the Content Server Staging folder and is available for module install through the Content Server administration pages.

  • Access the Content Server Admin pages > Core System - Module Configuration > Install Modules

  • Locate the AnswerModules Module Suite extension for Smart UI module and proceed with installation

  • Restart the OTCS services when prompted in order for the installation to be completed.

Installing the Script Console Extension for DocuSign (OPTIONAL)

Run the Script Console DocuSign Extension installer:

1
script-console-ext-docusign-2.4.0-OTCSxxx.exe

Follow the installation wizard steps

  • Select "Next" when ready to start the installation.

  • The installer will prompt you for the location where your target Script Console instance is installed. Browse to your SCRIPT_CONSOLE_HOME and select "Next".

  • Review the installation steps for each component to be installed.

  • Click "Finish" to complete the installation

Update the security configuration to allow access to the webhook endpoint. Edit the Script Console security config file:

1
<SCRIPT_CONSOLE_HOME>\config\cs-console-security.xml

Add the following rule:

1
<s:http pattern="/ext/docusign/docuSign.cs" security="none"/>

Configuration

The DocuSign Connector requires a few configuration parameters in order to be able to communicate with DocuSign systems using the eSignature REST APIs.

In the OTCS Admin pages > AnswerModules Administration > Base Configuration section, complete the "docusign" API configuration.

The following parameters are available:

Key Description
amcs.docusign.activeProfiles Comma separated list of active DocuSign Accounts profiles (default: "default"). This is a local identifier and will not be sent over to DocuSign. It is only relevant when more than one set of configurations has to be specified.
amcs.docusign.appKey.default DocuSign Integration Key: identifies your app for the DocuSign platform.
amcs.docusign.authUser.default DocuSign Account GUID or Username
amcs.docusign.authServer.default DocuSign authentication endpoint. This can be either account-d.docusign.com for sandbox testing or account.docusign.com for a production account.
amcs.docusign.appSecret.default DocuSign Account Password or RSA Certificate. If an Account GUID has been provided in the "amcs.docusign.authUser.default" field, than this MUST be an RSA Certificate private key. Otherwise, if a Username has been provided, this MUST be the account password.
amcs.docusign.appBasePath.default DocuSign Integration Base Path. This can be either https://demo.docusign.net/restapi for sandbox testing or https://www.docusign.net/restapi for a production account.
amcs.docusign.notifURI.default DocuSign Notification WebHook URI. This is the absolute, publicly accessible URL that DocuSign will call for push notifications. It refers to the endpoint installed on your Script Console instance. This value is OPTIONAL and only required if using the push notifications.

RSA Certificate format

If using the RSA certificate authentication (combined with an account GUID), the following requirements must be met:

  • RSA Certificate must be stored on a single line.
  • Line breaks must be replaced with line feeds ( \n ).
  • The "-----BEGIN RSA PRIVATE KEY-----" block and "-----END RSA PRIVATE KEY-----" must be included.

Example:

-----BEGIN RSA PRIVATE KEY-----\nxxx....xxx\nxxx....xxx=\n-----END RSA PRIVATE KEY-----\n

Save the Base Configuration and restart Content Server services when requested

Admin dashboard

The Module Suite DocuSign Extension supports the storage of a local copy of the signing envelope details within Content Server. The envelope status can either be periodically updated through a scheduled job, or automatically updated using push notifications by DocuSign (using a webhook pattern). An overview of the status of current and past envelopes can be visualized using the DocuSign Connector Admin dashboard.

The dashboard is a Content Script based tool that can be installed in the Content Script Volume using the Module Suite import/upgrade tool.

Before running the import, you should make the lib file available to the tool with the following steps:

  • On the server, navigate to the DocuSign Extension Module folder 

    1
    <OTCS_HOME>\module\ansmodulesuitedocusign_1_5_0\library

    and locate the file named docusign integration.lib.

  • Copy the file to the library folder within the Content Script Module:

    1
    <OTCS_HOME>\module\anscontentscript_2_4_0\library

Now that the library is available, proceed to the import with the following steps:

  • In a web browser, open the Module Suite Administration Base Configuration page. If working in a clustered environment, make sure you connect to the same server on which the library file has been copied.

  • Use the "Import" tool within the base configuration to import the DocuSign Integration library

Once the import is complete, you will be able to access the dashboard by navigating to the following Content Server location:

1
Content Script Volume > DocuSign Integration > CSTools

and running the Dashboard script.