Integrating BMC Helix Business Workflows with DocuSign
As an administrator, you can enable users to digitally sign documents by using DocuSign. To configure DocuSign to work with BMC Helix Business Workflows, you must perform the following actions:
Task | Product | Action | Reference |
---|---|---|---|
1 | DocuSign | Generate the Hash-based Message Authentication Code (HMAC) key in DocuSign. | To generate the HMAC key in DocuSign |
2 | DocuSign | Configure OAuth for the API application. | To configure for the API application |
3 | BMC Helix Platform | Configure a webhook callback for BMC Helix Business Workflows. | To configure a webhook callback for BMC Helix Business Workflows |
4 | DocuSign | Add the webhook callback URL in DocuSign. | |
5 | BMC Helix Business Workflows | Configure BMC Helix Business Workflows to connect with DocuSign. | To configure integration in BMC Helix Business Workflows |
6 | BMC Helix Business Workflows | Register BMC Helix Business Workflows with DocuSign. | To configure integration in BMC Helix Business Workflows |
Before you begin
Make sure that you have a DocuSign account.
To generate the HMAC key in DocuSign
You must generate the HMAC key in DocuSign and enter the key in BMC Helix Business Workflows. The HMAC key authenticates DocuSign and BMC Helix Business Workflows to trust each other and share content. To generate the HMAC key, perform the following steps:
- Log in to your DocuSign account.
- Navigate to the Admin tab, and from the Integrations section, select Connect.
- On the Connect Configurations page, select Connect Keys, and click Add Secret Key.
The HMAC key is generated. Note the key so that you can use it while configuring BMC Helix Business Workflows to connect to DocuSign.
To configure OAuth for the API application
- Log in to your DocuSign account.
- Navigate to Admin tab, and from the Integrations section, select API and Keys.
- In the My Apps / Integration Keys section, click ADD APP / INTEGRATION KEY.
- Enter a unique name for the application, for example, Business Workflows, click Add, and click Save.
- Click the application that you created for integrating with BMC Helix Business Workflows.
For example, Business Workflows application. - In the Authentication > User Application section, select Authorization Code Grant, and click ADD SECRET KEY.
The secret key is generated. Note the secret key so that you can use the key to configure BMC Helix Business Workflows to connect to DocuSign. - In the Additional settings > Redirect URIs section, click ADD URI, and enter the URL for BMC Helix Business Workflows authentication.
For example, https://<innovation-suite host name>/api/com.bmc.dsm.ticketing-lib/esign/callback/docusign/<integration-key> Click Save.
The following image displays an example of the OAuth configuration for the API application:
For information about how to promote your integration key from your developer sandbox to a DocuSign production account, see
Go-Live overview
in DocuSign.
To configure a webhook callback for BMC Helix Business Workflows
- Log in to BMC Helix Innovation Studio and navigate to the Administration tab.
- Select Webhook Connection > Callback Configuration > Webhook Callback Configuration.
Enter the values for the following fields:
Field Description Configuration Name Enter a unique configuration name, for example Helix Business Workflows configuration.
Bundle Name Select Business Workflows.
Processor Select DocuSign.
DOCUSIGN_HMAC_KEY
Enter the HMAC key that you generated. Click Save.
The Callback URL is automatically generated for your configuration.Copy the Callback URL.
Click Close.
To add the webhook callback URL in DocuSign
- Log in to your DocuSign account.
- Navigate to the Admin tab, and from the Integrations section, select Connect.
- On the Connect Configurations page, select Add Configuration > Custom.
On the Custom Configuration Settings page, enter the values for the following fields:
Name—Enter a name for the configuration.
URL to Publish—Enter the Callback URL generated in BMC Helix Innovation Studio.
For example, https://<innovation-suite host name>/api/rx/application/webhook_callback/WCGADGG8ECDC0AQ1STP0Q0UP4WVFRB/1.
- Select all the Envelope trigger events.
- Select the Include HMAC Signature option.
To configure BMC Helix Business Workflows to connect with DocuSign
Log in to BMC Helix Business Workflows.
Click Application Settings .
The Settings page opens in a new browser tab.Select Application Configuration > DocuSign Configuration.
Enter the values for the following fields:
Field Description Client ID Enter the integration key that was assigned for the API application in DocuSign.
For example, 9c70bd39-1017-476b-a99e-abd83e91e491.
Client Secret Enter the secret key that was assigned for the API application in DocuSign.
For example, ada504cd-9c1c-47f7-8939-9d74ca5a8088.
Authentication URI Enter https://account-d.docusign.com.
Account Id Enter the account ID of the API application in DocuSign. API Access URI
Enter the API Access URI that you provided in DocuSign. Redirect URL
Enter the Redirect URL that you provided in DocuSign.
For example, https://<innovation-suite host name>/api/com.bmc.dsm.ticketing-lib/esign/callback/docusign/<integration-key>.
To test connectivity between BMC Helix Business Workflows and DocuSign, click Test Connection.
To register BMC Helix Business Workflows with DocuSign, click Register Application.
The application registration details are authenticated, and BMC Helix Business Workflows is registered with DocuSign.
The following image displays an example of the DocuSign configuration:
Where to go from here
Creating automated tasks for automatically sending documents for digital signature
Comments
Log in or register to comment.