Integrating BMC Helix Business Workflows with Adobe Sign

As an administrator configure the Adobe Sign account and BMC Helix Business Workflows to enable digitally signing of documents from within a case. Documents are sent for signing to Adobe Sign by using an automated process and signed documents are sent back to BMC Helix Business Workflows by using a webhook configuration. 

Before you begin

Ensure that you have an Adobe Sign Enterprise account.

Workflow

 The following table describes the actions that an administrator must perform to connect BMC Helix Business Workflows with Adobe Sign:

To generate an integration key in Adobe Sign

As an Adobe Sign administrator, you can generate access tokens, that is, integration keys. For a new integration, you must generate an integration key in Adobe Sign and enter the integration key in BMC Helix Business Workflows. The integration key authenticates Adobe Sign and BMC Helix Business Workflows to trust each other and share content.

1. Log in to Adobe Sign as an administrator.
2. Navigate to Account > Adobe Sign API > API Applications.
3. Click Create.
4. In the Create dialog box, provide the following information:
   • Name: Provide a unique name for the application. For example, BMC Helix Business Workflows.
   • Display Name: Provide a unique display name for the application. For example, BWF Adobe.
   • Domain: Select Customer if you want the application to have access to data within your account only.

5. Click Save.
   Adobe Sign creates an API application and automatically assigns an application ID to the application that is integration key for the BMC Helix Business Workflows application.
   The following image displays an example of an API application: 

    Click here to expand

   Click the image to enlarge it.
   

To configure OAuth for the API application

1. Log in to Adobe Sign as an administrator.
2. Navigate to Account > Adobe Sign API > API Applications.
3. Click the application that you created for integrating with BMC Helix Business Workflows. 
   For example, Helix Business Workflows application.
4. Click Configure OAuth for Application.

5. In the Redirect URI box, enter the URL for BMC Helix Business Workflows authentication. 
   You must configure the URL in two different formats. The first format of the URL is the encoded URL, and the second format is the 'as is' format. Separate the two formats with a semicolon (;), and not a comma (,).
   For example, https://<innovation-suite host name>/innovationsuite/index.html%23%2Fcom.bmc.dsm.bwfa/signing-auth;https://<innovation-suite host name>/innovationsuite/index.html#/com.bmc.dsm.bwfa/signing-auth

6. In the Enabled Scopes area, select all the scopes and select account as the modifier:
   • user_login
   • agreement_read
   • agreement_write
   • agreement_send
   • webhook_read
   • webhook_write
   • webhook_retention

   The following image displays an example of the OAuth configuration for the API application:

    Click here to expand

   Click the image to enlarge it.

   

7. Click Save.
   Your Client ID, Client secret and application URL are now available.

To configure a webhook callback for BMC Helix Business Workflows

You must configure a webhook callback and update the Adobe Sign configuration with the callback URL generated.

1. Log in to BMC Helix Innovation Studio as an administrator and navigate to the Administration tab.
2. Select Webhook Connection > Callback Configuration > Webhook Callback Configuration.

3. Provide the following information:

   UI element	Description
   Configuration Name	Enter a unique configuration name, for example Helix Business Workflows configuration.
   Bundle Name	Select Business Workflows.
   Processor	Select Adobe Sign.
   X-ADOBESIGN-CLIENTID	Enter the client ID created when you generated an integration key.

4. Click Save. 
   The Callback URL is automatically generated for your configuration. 

5. Copy the Callback URL.
   

6. Click Close.

To configure the integration in BMC Helix Business Workflows

1. Log in to BMC Helix Business Workflows as an administrator.

2. Click My Application Settings .
   The Settings page opens in a new browser tab.
   

3. Select Application Configuration>Adobe Sign Configuration.

4. Provide the following information:

   UI element	Description
   Client ID	Enter the client ID that was assigned for the API application in Adobe Sign. For example, CBJCHBCAABAAEpMYqcjGxGliQTNei0LnfDmH9UcwT3gs. To find the client ID, in Adobe Sign, navigate to API Applications > select the BMC Helix Business Workflows application > Configure OAuth for Application > Client ID.
   Client Secret	Enter the client secret that was assigned for the API application in Adobe Sign. For example, wNaxPWWsQs-eegZkWBHOC2aXqec14kef. To find the client secret, in Adobe Sign, navigate to API Applications > select the BMC Helix Business Workflows application > Configure OAuth for Application > Client Secret.
   Adobe Authentication URI	Enter https://secure.<region>.echosign.com/public/oauth. Note: Replace <region> with the region displayed in the URL of your Adobe Sign Account home page.
   Redirect URL	Enter the Redirect URL that you provided in Adobe Sign. For example, https://<innovation-suite host name>/innovationsuite/index.html%23%2Fcom.bmc.dsm.bwfa/signing-auth;https://<innovation-suite host name>/innovationsuite/index.html#/com.bmc.dsm.bwfa/signing-auth
   Scope	Do not change the value of this field. For example, user_login:account+agreement_read:account+agreement_write:account+agreement_send:account+webhook_read:account+webhook_write:account+webhook_retention:account

5. Click Register Application in Adobe Sign. 
   The application registration details are authenticated, and BMC Helix Business Workflows is registered with Adobe Sign. 

6. In Webhook Callback URL, enter the callback URL copied during the webhook callback configuration.

7. To generate the webhook entry in your Adobe Sign account, click Register Webhook.
   The following image displays an example of the Adobe Sign configuration: 

    Click here to expand

   Click the image to enlarge it.

   

After you complete the configurations, the Adobe Sign and BMC Helix Business Workflows applications are ready to send and receive documents that are digitally signed by using Adobe Sign. The case business analyst must then create an automated task in BMC Helix Business Workflows, so that documents in the case can be sent to Adobe Sign for signing, and digitally signed documents can be received by BMC Helix Business Workflows and stored in the case or sent to the required stakeholders.

Where to go from here

Creating automated tasks for automatically sending documents for digital signature