This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Integrating BMC Helix Innovation Studio with Adobe Acrobat Sign

As an administrator, configure the Adobe Acrobat Sign account and BMC Helix Innovation Studio to enable users to request e-signing of documents and download them from within the application. Documents are sent for e-signing to Adobe Acrobat Sign by using a process action and a notification is sent to BMC Helix Innovation Studio by using a webhook configuration. 

Before you begin

Make sure you have an Adobe Acrobat Sign account.

Workflow

The following image represents the tasks to connect BMC Helix Innovation Studio with Adobe Acrobat Sign:

 The following table describes the actions that an administrator must perform to integrate BMC Helix Innovation Studio with Adobe Acrobat Sign:

TaskProductActionReference
1Adobe Acrobat SignGenerate an integration key in Adobe Acrobat Sign.To generate an integration key in Adobe Acrobat Sign
2Adobe Acrobat SignConfigure OAuth for the API application.To configure OAuth for the API application in Adobe Acrobat Sign
3

BMC Helix Innovation Studio

Create a webhook callback configuration for BMC Helix Innovation Studio.

To configure a webhook callback for Adobe Acrobat Sign
4

BMC Helix Innovation Studio

Configure integration in BMC Helix Innovation Studio.

To configure BMC Helix Innovation Studio to connect with Adobe Acrobat Sign
5

BMC Helix Innovation Studio

Configure the authorized user in BMC Helix Innovation Studio.

To configure the authorized user

To generate an integration key in Adobe Acrobat Sign

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

  1. Log in to Adobe Acrobat Sign.
  2. Navigate to Account > Acrobat Sign API > API Applications.
  3. Click.
  4. In the Create dialog box, provide the following information:
    • Name—Provide a unique name for the application. 
    • Display Name—Provide a unique display name for the application. For example, IS Adobe.
    • Domain—Select Customer if you want the application to have access to data within your account only.
  5. Click Save.
    Adobe Acrobat Sign creates an API application and automatically assigns an application ID to the application. This is the integration key for the BMC Helix Innovation Studio application.
    The following image displays an example of an API application: 

To configure OAuth for the API application

  1. Log in to Adobe Acrobat Sign.
  2. Navigate to Account > Acrobat Sign API > API Applications.
  3. Click the application that you created for integrating with BMC Helix Innovation Studio
  4. Click Configure OAuth for Application.
  5. In the Redirect URI box, enter the URL for BMC Helix Innovation Studio authentication.
    For example, https://<innovation-suite-host-name>/api/rx/application/oauth/callback.
  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:

  7. Click Save.
  8. Copy the Client ID.
  9. Click your application, click View/Edit, and copy the Client secret for your application.
    You will need the Client secret to integrate BMC Helix Innovation Studio with Adobe Acrobat Sign.

To configure a webhook callback for Adobe Acrobat Sign

For Adobe Acrobat Sign, you must configure a webhook callback in BMC Helix Innovation Studio. Alternatively, you can update the Adobe Acrobat Sign configuration with the callback URL generated.

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab.
  2. Select Integrations > Webhook callback configuration, and provide the following information:

    Field

    Description

    Configuration Name

    Enter a unique configuration name.

    Bundle name

    Select your bundle.

    Processor

    Select Adobe Sign.

    X-ADOBESIGN-CLIENTID

    Enter the Client ID created when you generated an integration key.
  3. Click Save
    The Callback URL is automatically generated for your configuration. 

  4. Copy the Callback URL.

  5. Click Close.

To configure BMC Helix Innovation Studio to connect with Adobe Acrobat Sign

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab.

  2. Select Integrations > OAuth configuration.

  3. In the OAuth configuration UI, click New, and enter the values for the following fields:

    Field

    Description

    OAuth provider

    Enter Adobe Acrobat Sign as the service provider for e-signature.

    Client ID

    Enter the client ID copied during OAuth for API application configuration in Adobe Acrobat Sign.

    For example, 9c70bd39-1017-476b-a99e-abd83e91

    Client secret

    Enter the client secret copied during OAuth for API application configuration in Adobe Acrobat Sign.

    For example, ada504cd-9c1c-47f7-8939-9d74ca5a8

    Authorization URL

    Enter https://secure.<region>.echosign.com/public/oauth/v2

    Important: Replace <region> with the region displayed in the URL of your Adobe Acrobat Sign account home page.

    Redirect URL

    Enter the Redirect URL that you provided in Adobe Acrobat Sign.

    For example, https://<innovation-suite-host-name>/api/rx/application/oauth/callback

    Important: Replace the # value in the URL with %23.

    Grant typeSelect Authorization Code.
    Scope

    Enter user_login:account agreement_read:account agreement_write:account agreement_send:account webhook_read:account webhook_write:account webhook_retention:account

    Client credentials transfer mechanism

    Select Form parameters.

    Access token URL

    Enter the URL to get the token from the OAuth2 server. 

    For example, https://secure.<region>.echosign.com/oauth/v2/token

    Important: Replace <region> with the region displayed in the URL of your Adobe Acrobat Sign account home page.

    DescriptionEnter the description for the configuration.
    Refresh token URL

    Enter the URL to get the access token from the OAuth2 server.

    For example, https://secure.<region>.echosign.com/oauth/v2/refresh

    Important: Replace <region> with the region displayed in the URL of your Adobe Acrobat Sign account home page.

    Bundle IDDo not change the default value com.bmc.arsys.rx.settings.
  4. Click Save.
  5. To register BMC Helix Innovation Studio with Adobe Acrobat Sign, click Register application.
  6. To test connectivity between BMC Helix Innovation Studio and Adobe Acrobat Sign, select the configuration, and click Test connection.

    Important

    If the connection fails, verify that you have entered the correct values for all the fields.

The application registration details are authenticated, and BMC Helix Innovation Studio is registered with Adobe Acrobat Sign. 

To configure E-sign

  1. Log in to BMC Helix Innovation Studio and navigate to Administration tab.

  2. Select Integrations > E-sign configuration.

  3. On the E-sign configuration UI, click New, and enter the values for the following fields:

    Field

    Description

    Provider type

    Select Adobe Acrobat Sign as the service provider for e-signature. 

    Important: You cannot have more than one configuration with the same e-signature service provider.

    Authorized user

    Enter the user name of the user who is authorized to get the OAuth token from the e-signature service provider.

    Important: If the user updating this information is the same user who was authorized to get the OAuth token, then you do not need to update this field. The server updates this field with the current user. 

    API access URL

    Enter the REST resource base URL to access the e-signature APIs. 

    For example, https://api.<region>.echosign.com 

    Webhook URL

    Enter the callback URL copied during webhook callback configuration.


  4. Click Save.
  5. To generate the webhook entry in your Adobe Acrobat Sign account, select the configuration, and click Register webhook.

After you complete the configurations, the Adobe Acrobat Sign and BMC Helix Innovation Studio applications are ready to send and receive documents that are e-signed by using Adobe Acrobat Sign.

The application business analyst must create a process in BMC Helix Innovation Studio so that documents in your application are sent to Adobe Acrobat Sign for e-signing, and you receive a notification in BMC Helix Innovation Studio to download the e-signed documents.

Where to go from here

Configuring e-signing in your custom application

Was this page helpful? Yes No Submitting... Thank you

Comments