Skip to main content

v10

help center
Submit a request
Submit a request
  1. Total Compensation Management
  2. Technical admin
  3. General

Integrating DocuSign into TCMv10

Nolwenn Marjou
  • Last updated:

Integrating DocuSign into TCMv10

This article details the method to be followed in order to use DocuSign with beqom v10. DocuSign is a third-party application which can be integrated into beqom to facilitate the management of electronic agreements and signatures.

Prerequisites

Before starting the DocuSign integration, the following prerequisites must be met:

  • Purchase a DocuSign API plan from DocuSign based on your requirements.

  • Create a user in the beqom Admin Portal for the esign.beqom services to properly communicate with the beqom tenant. The External SSO User parameter of that user must be set to f6f745b1-dc15-498d-ade1-d1a120f64454 and assigned to a profile that can call the UpdateDocuSignStatus method in NotificationServices.svc.

  • In order for beqom to obtain an acknowledgment from DocuSign about email status, the DocuSign connection settings require a URL to post message status. This URL shares the following format: https://esign.beqom.com/api/docusign/update-status?endPoint={endPointId}. The endPointId parameter can be retrieved by hovering the mouse cursor over the relevant tenant.

Configuring the connection between DocuSign and beqom

The first part of the configuration is to allow the connection between DocuSign and beqom and vice versa.

Allowing beqom to connect to DocuSign

To allow the communication between beqom and Docusign, proceed as follows:

  1. Go to the DocuSign website and connect to your account.

  2. Click the User icon at the top right and click Go to Admin.

  3. Open Integrations > API and Keys.

  4. Click Add App/Integration Key.

  5. Enter a name in the App Name field (for example "beqom").

  6. Check the Authorization Code Grant radio button.

  7. Click +ADD RSA KEYPAIR.

This is an attention message.

Keep a copy of that private key as you will need it later in the configuration and you will not be able to access it again.

  1. Click +ADD URI and fill the Redirect URIs field with https://passport.beqom.com/issue/wsfedEndpoint?endpointId={endpointID} (same endpoindID as defined before).

  2. Save the new app key. The account details are now created.

Configuring DocuSign

The next step is to configure the beqom Web Application with the DocuSign parameters.

  1. Access the beqom Web Application.

  2. Go to Admin > Integrations > DocuSign.

  3. Fill the following fields with the parameters available in your DocuSign account:

    • User ID

    • API Account ID

    • Integration Key (from the above section)

    • RSA Private Key

  4. Click Save.

Consenting to the use of DocuSign

After the above settings are saved in v10, the application generates a link that will redirect you to the DocuSign consent page in order to allow beqom to use your DocuSign account to send documents.

To enable the DocuSign content:

  1. Click the consent link.

  2. Click Accept.

The DocuSign consent status is displayed (as tags) whether the consent has been approved or not, or if any problem is reported.

There are three consent status:

  • No consent given

  • Consent given

  • Configuration issue: the consent may be approved but the configuration encountered problem(s). In that case, check the configuration.

Allowing DocuSign to notify v10

beqom uses an API to obtain messages status from DocuSign. This API is working under the following URL: https://esign.beqom.com/api/docusign/update-status. When this URL is provided to DocuSign Connect in the custom configuration settings, the beqom tenant endpoint ID must be provided as described in the above section.

Once the correct endpoint is provided, proceed as follows to allow notifications:

  1. Log into the DocuSign portal, then click the User icon.

  2. Click Go to Admin, as illustrated in the following figure:

 

  1. In the administrator console, click Connect under the "Integrations" section of the left navigation panel.

  2. In the "Connect Configurations" screen, click Add Configuration > Custom.

  3. Define the name of the configuration.

  4. Once you have set a name, define the following settings:

  1. Click Save.

Once the custom connect configuration has been defined, when messages are sent using this DocuSign account, DocuSign will send an acknowledgment to the esign.beqom.com Web server.

This acknowledgment will be temporarily saved.

Configuring the templates

Now that the communication between DocuSign and v10 is enabled, the next step is to configure the document templates.

Creating the Templates in DocuSign

Before mapping the DocuSign templates in the beqom Admin Portal, you must previously create your own templates in DocuSign. You will find all the required procedures in the DocuSign website.

Mapping the DocuSign templates in beqom

To map the DocuSign template with a source grid in beqom, proceed as follow:

  1. Go to INFO HUB > Communication Workbench > Document in the beqom Admin Portal.

  2. Create a new document or select an existing one.

  3. Click Browse.

  4. Select DocuSign and choose a template among the available templates in your DocuSign account.

  5. Define the source grid by selecting a grid via the Select a Grid drop-down. The list contains only the grid whose underlying table/view contains the column idPayee. If placeholders (fields) are defined in the template, they are displayed in a contextual window as illustrated in the following figure:

  6. Click Ok to confirm the mapping.

Docusign template mapping

Defining the Document Parameters

After the template placeholders have been mapped to the grid fields, the next steps are to define the document parameters:

  • Start and end dates: the start date is not necessarily used but the end date is used as an expiry date for the message once it is sent (the recipients will not be able to sign the document after the defined end date)

  • Population: define the population that must receive the DocuSign message to sign via the To button in the document header.

This is an note/information message.

If the grid which was selected at the creation of the template does not contain any record corresponding to the population to be used to generate the message, then those payees should not receive the DocuSign message to sign. In addition, the payees belonging to the selected population must always have a unique email address. Otherwise, the integration will not work properly.

  • Subject: as the creator of the document, you need to define the subject of the message. This subject will later be used as the email subject when DocuSign sends the message to the recipients' email address.

DocuSign Integration Diagram

The following diagram illustrates the integration process between beqom and DocuSign:

DocuSign integration diagram

Attachments
Was this article helpful?
0 out of 0 found this helpful
Return to top