Docusign Integration Setup Guide

Docusign integration for CLM

The Appian Contract Lifecycle Management (CLM) solution comes with an integration with Docusign eSignature software that can be used to facilitate and track the contract signing process automatically. Configuration for this integration will take place in both your Appian CLM application and Docusign.

Note that while this guide provides instructions for both the Appian CLM application and Docusign, we strongly recommend consulting the Docusign documentation for Docusign-specific tasks as often as possible or to troubleshoot issues with Docusign. You can also contact Appian support if you run into issues.

Docusign integration setup steps

To ensure the integration works properly, you need to complete the following steps:

• Docusign integration for CLM
• Docusign integration setup steps
  • Resources
• Create Applications and Keys in Docusign
• Grant Consent for Docusign OAuth JWT
• Create a user account in Docusign
• Configure the Docusign Connected System in Appian
• Enable Connect in Docusign
• Configure Connect Security in Docusign
• Copy the listener URL from CLM
• Create a Custom Connect Configuration
• Turn on Docusign feature toggle

Resources

• Docusign Connected System configuration
• Key Docusign Concepts - Appian Community
• Docusign Documentation

Create Applications and Keys in Docusign

The steps in this section should be completed in your Docusign Admin account for each Appian Contract Lifecycle Management (CLM) environment (Dev, Test, Prod).

Reference Docusign's Add Integration Keys documentation for the most precise and up-to-date steps.

To create an app:

1. Sign in to your Docusign Admin account.
2. Go to Settings, and select Apps and Keys.
3. Select ADD APP AND INTEGRATION KEY.
4. Enter a name for your app, such as, CLM Dev, and select CREATE APP.
5. Select the authentication type: Service Integration (JSON Web Token Grant).

To generate a key pair:

1. Select GENERATE RSA to have Docusign generate a key pair.
2. Copy the RSA key pair to a safe location.
   1. You need to paste the private key into the Docusign Connected System in the Appian CLM solution later.
3. Select ADD URL to enter the redirect URL for the Connected Appian CLM environment, which should be the following: https://[customer-specific-domain]/suite/oauth/callback
   1. Update the customer-specific-domain portion of the URL with your organization's domain.
4. Click SAVE.
5. On the Apps and Keys page, copy the Account ID for the application you just created.
   1. You need this Account ID to populate the API Account ID field for the Docusign Connected System in Appian CLM.
6. Select the application you created and copy the Integration Key to a safe place.
   1. You need this Integration Key to populate the Integration Key field on the Docusign Connected System in Appian CLM.

Grant Consent for Docusign OAuth JWT

The steps in this section should be completed in your Docusign Admin account.

Reference Docusign OAuth JWT: Granting Consent documentation for the most precise and up-to-date steps.

Create a user account in Docusign

The steps in this section should be completed in Docusign eSignature Settings.

To facilitate the integration between Appian Contract Lifecycle Management (CLM) and Docusign you need a user account to act as, or impersonate, each user executing a call against Docusign from Appian CLM.

Reference Docusign's Add Users to Accounts documentation for the most precise and up-to-date steps.

To create a user account:

1. In Docusign eSignature Settings, select Users.
2. Select ADD USER.
3. Enter the email address for the new user, and select NEXT.
4. Enter the profile information for the user, and select NEXT.
5. Select the Permission Profile, DS Sender.
6. Select ADD USER.
7. Complete the steps in the activation email for the user account to be updated to Active.
8. For the newly created user, select ACTIONS, then View.
9. Copy the user's API Username in a safe place.
   1. You need this value later on for configuration of the Docusign Connected System in Appian CLM.

Configure the Docusign Connected System in Appian

Complete the steps in this section in Appian Contract Lifecycle Management (CLM). Configuring the Docusign Connected System enables Appian CLM to authenticate with Docusign using the Docusign connected system included in the Appian CLM application.

To configure the Docusign Connected System:

1. Sign in to your Dev environment of Appian CLM.
2. Go to Appian Designer.
3. Select Objects.
4. Search for CLM Docusign Connected System.
5. Select the object to open the configuration modal.
6. Complete the Docusign Connected System configuration as follows.
   1. For Authentication, select JWT Grant.
   2. For Instance URL, enter https://demo.docusign.net.
   3. For API Account ID, copy and paste in the Account ID displayed for the App you created in Docusign eSignature Admin on the Apps and Keys page.
   4. For API Username, paste in the API Username you copied from the user account you created in Docusign eSignature Settings > Users.
   5. For Integration Key, paste in the Integration Key you copied from the application you created in Docusign eSignature Settings > Apps and Keys.
   6. For Private RSA Key, paste the entire private key into the field.
   7. For Docusign Environment, select the appropriate environment based on the Appian CLM environment you're configuring.
7. Select TEST CONNECTION to verify that Appian can successfully authenticate with Docusign.

See also: Docusign Connected System

Enable Connect in Docusign

Complete the steps in this section in Docusign to enable Connect, Docusign's webhook service.

Reference Docusign's Enable Connect documentation for the most precise and up-to-date steps.

To enable Connect:

1. In Docusign, select Settings.
2. Select INTEGRATIONS, and select Connect.
3. Select ENABLE CONNECT.

Configure Connect Security in Docusign

Reference Docusign's Connect Security Options documentation to determine which authentication method you want to enable for Docusign Connect webhook messages from Docusign to Appian CLM. You'll need to configure Connect for each Appian environment.

Copy the listener URL from CLM

Complete the steps in this section in Appian Contract Lifecycle Management (CLM). You need to retrieve the web API listener URL so you can configure it in Docusign.

To retrieve the web API listener URL:

1. Sign in to your Appian Development environment as an Administrator.
2. Go to Appian Designer.
3. Select Objects.
4. Select the Web API filter.
5. Search for docusign.
6. Select the object, CLM_WEBAPI_Docusign_EventHandling.
7. Copy the listener URL, which should look like the following: https://[customer-specific-domain]/suite/webapi/docuSignConnect
   1. You need this URL value when you configure Connect in Docusign so that Docusign Connect knows where to send webhook messages.

Create a Custom Connect Configuration

The steps in this section should be completed in Docusign. You need to create a custom Connect configuration for each Appian Contract Lifecycle Management (CLM) environment.

Refer to Docusign's Create a Connect Configuration for the most up-to-date and precise steps.

Also reference the following additional Docusign documentation to complete this setup:

• Connect Settings and Information
• Connect Events
• Recommendations for Receiving Documents from Connect

To create a custom Connect configuration:

1. In Docusign eSignature, select Settings.
2. Select INTEGRATIONS, and select Connect.
3. Select ADD CONFIGURATION > Custom.
4. Complete the configuration web form as follows.
   1. For Name, name the custom configuration something specific which clearly indicates that it is for webhook messages to Appian CLM and the specific environment. For example, AppianCLMDev.
   2. For URL to Publish, paste in the Web API URL you copied from the CLM_WEBAPI_Docusign_EventHandling object in the previous step.
   3. Check Enable Log.
   4. Check Require Acknowledgement.
   5. For Data Format, select REST v2.1: JSON.
   6. For Event Message Delivery Mode, select Send Individual Messages (SIM).
   7. For Appian CLM to function properly, you must select the following events in Trigger Events to permit Connect to send messages to Appian CLM:
      1. Under Envelope Events, select Envelope Signed/Completed and Envelope Voided.
         1. NOTE: Separately in the POST Create Envelope call from Appian, you can define all or some of these enabled events to be returned for each envelope. Out of the box, only the envelope-completed event is included in the POST call from Appian CLM.
      2. Under Recipient Events, select the following:
         1. Recipient Signed/Completed
         2. Recipient Reassign
         3. Recipient Declined
   8. In Envelope and Recipients, select Include Data.
      1. From the dropdown, select Recipients.
      2. Select the attributes you want to receive in the webhook messages from Docusign Connect. If you are not concerned about receiving too many concurrent event messages from Docusign at any one time, you can check Documents to receive the signed/completed document in the webhook message.
   9. In Associated Users/Groups, select Select Users/Groups to include, and check the user account created in the earlier step.
   10. In Integration and Security Settings, check the authentication method you want to use to authenticate webhook messages from Docusign Connect to Appian. See Docusign's Connect Basic Authentication Configuration documentation for specific steps to use Basic Authentication.
5. Select ADD CONFIGURATION.

Turn on Docusign feature toggle

Make sure the constant CLM_FEATURE_TOGGLE_DOCUSIGN is set to True in Appian Designer.

Feedback