Skip to main content
Mitratech Success Center
Client Support Center

Need help? Click a product group below to select your application and get access to knowledge articles, webinars, training content, and release notes or to contact our support team.

Authorized users - log in to create a ticket, view tickets status and check your success plan details.

 

DocuSign Integration Setup for TAP Application

  1. Last updated
  2. Save as PDF

Overview

This article explains how to integrate DocuSign with the TAP application. It includes detailed instructions for creating a new app and key in DocuSign, configuring necessary settings, and integrating the app with TAP.

Configure DocuSign for Integration with TAP

Before You Begin

Ensure that you have:

  • Administrator access to DocuSign
  • Super Administrator access to the TAP application
  • A valid DocuSign account email and password

Important: Each TAP tenant supports only one eSignature provider. You can configure either DocuSign or Adobe Sign, not both.

Instructions Screenshot for Reference

1. Login to your DocuSign account. Navigate to Admin tab > Integrations > Apps and Keys and click Add App and Integration Key button. Enter a name for your app and click the Create App button.

clipboard_ea795d698d12f247a6c4e88a8a86ae9e9.png

A new page opens displaying the App’s basic configuration settings.

  • Enter all the required details.
  • Under Additional Settings, add the required URL values.
  • To ensure that TAP syncs and displays the status of signed documents, provide a redirect URL.
  • Save your changes.
 clipboard_ea1d65d7223710ed573deb9521cc0629c.png

2. Login to TAP application (Super Admin access required).

 Add a new and or another DocuSign account for TAP 04.png

3. Navigate to Administration > Integrations > eSignature Keys > Click on New DocuSign Connection button.

The Administrator DocuSign Account page appears. Enter the following DocuSign Account details:

clipboard_e7e785ee531256116e1582cefcff1e699.png

  • DocuSign Email Address - Email associated with the DocuSign Account.
  • DocuSign Account ID - Available in DocuSign. Navigate to Admin tab > API and Keys > My Account Information > API Account ID.
  • DocuSign Password - The App Password generated in DocuSign (not your login password). Open the Profile menu > Manage Profile > Privacy and Security > Additional Security > Select Generate App Password. (The App Password is displayed only once. If lost, you must generate a new one.)

Note: Use this Link to access your DocuSign account and retrieve the required details (email address, Account ID, and App Password) for configuring the DocuSign connection in TAP.

 clipboard_ee632693370b280761af949c4cc2ab662.png

4. TAP validates the credentials with DocuSign. If validation succeeds, the DocuSign connection status becomes Active.

 clipboard_ec90fe2de8e1706e23dab50847b75ec77.png
Troubleshooting

Problem Description: 

If you run into an error 'Invalid Credentials' or the account does not save and remains on the configuration screen: 

Navigate back to the DocuSign account > Admin > API and Keys

If the Account's Base URI is not 'https://docusign.net/api/3.0

clipboard_e61dd66f0ebddaf47a0349cfa503e6a47.png

Create a support ticket with the new URL for a change on the TAP side. 

Note for Mitratech Internal:

In the latest DocuSign accounts, the account base URLs are under na1/na2/na3 servers and might look like https://na1.docusign.net. When the client creates a support ticket to change this URL in the portal settings, please create a hosting ticket to change the 'ESDefaultEndpointBaseUrl' setting  to https://na1.docusign.net/api/3.0. 

Ensure you add api/3.0 at the end of URL so that our code calls DocuSign API endpoint for authentication which only works with entire https://na1.docusign.net/api/3.0. If we update the URL without api/3.0 then the e-Signature connection would result in 500 Internal server error in console & the portal logs will show the below error.

MessageText==>
The request failed with the error message:
--
<html><head><title>Object moved</title></head><body>
<h2>Object moved to <a href="/Member/404Error.aspx?aspxerrorpath=/accountmanagement.asmx">here</a>.</h2>
</body></html>

--. ExceptionType==> System.Net.WebException Exception==> The request failed with the error message:
--
<html><head><title>Object moved</title></head><body>
<h2>Object moved to <a href="/Member/404Error.aspx?aspxerrorpath=/accountmanagement.asmx">here</a>.</h2>
</body></html

Configure Admin and User Permissions

To integrate DocuSign with the TAP application, specific administrative and user permissions must be configured for a successful setup.

Enable "Allow All" Admin Access in Permission Profiles

To add a new DocuSign key to the TAP application, you must first enable "Allow All" administrative access. (This step is mandatory.)

Navigate to Admin tab > Users and Groups > Permission Profiles. Select Edit option from the Action menu of the permission profile to enable the access.

clipboard_e8b6745f05052515d679f2fe417dd9a14.png

Change Admin Permissions in Permission Profiles

After adding the eSign key, you can change the administrative permissions back to "None".

clipboard_e54f5b9a6fc8247e5cd30a9cb7b2e9d34.png

Configure User Permissions in Permission Profiles

Under the "User Permissions" tab, enable the following permissions. These are the minimum required permissions to use DocuSign within the TAP application.

  1. Enable "Allow users to send envelopes".
  2. Enable "Allow view and manage envelope rights through API".
  3. Enable "Allow send on behalf of other users through API".

clipboard_e91c294f5d0cc3d5ff201378181a722ce.png

Uses of DocuSign Integration with TAP

The DocuSign integration within TAP can be utilized in the following scenarios:

Scenarios Screenshot for Reference

Enabling e-Signature Support in a Workflow

  • When setting up a workflow with two stages, select e-Signature Support for the relation between the stages.
  • Check the Enable e-Signature Support checkbox.
 clipboard_e27360b0d18ed6a16051ebd02e5efb8d3.png

Assigning the DocuSign Account

  • Navigate to the API tab in the workflow settings.
  • The DocuSign account you created will be available in the e-Signature Administrator Account dropdown.
 clipboard_e364fd8d23aa5e1d03281649e83304823.png

Adding DocuSign Connection to a User

Navigate to Administration > Users > Edit Workflow. Scroll down to find the option to add a DocuSign connection administrator account. The newly created DocuSign account will be available in this dropdown.

 clipboard_ed7a53e252e4757cf38a7b61c17d62ff0.png