Configure Blue Prism to use Decision

Important information:

As part of this release into Blue Prism Cloud, Blue Prism is automatically configured with the Decision API. The information provided below is for reference only.

To configure Blue Prism to use your Decision models, you need to:

  1. Set up a service account in Hub and generate a secret key.
  2. Set up the credentials for the Decision service account in Blue Prism.
  3. Import the Blue Prism Decision API Release VBO to communicate with Decision.

Set up a service account

To set up the Decision API credentials in Blue Prism, a secret key is required. This is generated from the associated service account in Hub for use with the Decision API. If you lose the key, you can regenerate another key from the service account. For more information, see Service accounts.

Service accounts can only be created by a Hub administrator.

If you do not have a service account set up for the Decision API, you can create a service account:

  1. In Blue Prism Hub, on the Service accounts page, click Add account.
  2. Enter a unique ID and a friendly name, for example, Decision.

  3. Under Permissions, select Blue Prism Decision API.

    Add a Decision service account

  4. Click Create service account.

    The Add a service account dialog displays with a generated secret key. You will need to enter this key into the Blue Prism interactive client when configuring the associated credential.

  5. Copy the generated secret key to your clipboard ready to paste into the Blue Prism interactive client.

  6. Click OK to close the dialog.

    The Service accounts page displays with the newly created account shown.

Set up credentials in Blue Prism

  1. Log into the Blue Prism interactive client, select System and then click Security > Credentials. See Security > Credentials for additional information.
  2. Click New.

    The Credential Details dialog displays.

  3. On the Application Credentials tab of the Credential Details dialog:

    1. Enter a name.
    2. Change the Type to OAuth 2.0 (Client Credentials).
    3. In Client ID, enter the ID that you used to create the service account above in Set up a service account.

      The client ID is case sensitive. You must ensure you enter the client ID in the same case as defined in the service account.

    4. In Client Secret, enter the secret key that was generated for the service account.
  4. On the Access Rights tab of the Credential Details dialog, set up the required access permissions.
  5. Click OK.

Import the Blue Prism Decision API Release VBO

  1. In Blue Prism, select File and click Import > Release / Skill.

    The Import Release dialog displays.

  2. Click Browse.
  3. Locate and select the Decision API.bprelease file.

    For example:

  4. Click Next.

    The Process Logging Overview screen displays with a summary of the components that will be imported.

  5. Click Next.

    A progress screen displays.

  6. When the import has completed, click Finish.
  7. In Blue Prism, select System and then click Objects > Web API Services.
  8. Select DecisionAPI and click Edit Service.
  9. On the Web API: DecisionAPI opening screen, in Base URL, enter the URL of the Decision API service in the format:

    <Hub host URL>:<port if specified during install>/api/blueprism-decision

    For example, https://hub.blueprism.com:5002/api/blueprism-decision

    Or, if the default port was used, https://hub.blueprism.com/api/blueprism-decision

  10. Select Common Authentication in the navigation tree, then complete the following:
    1. Ensure that Authentication Type is set to OAuth 2.0 (Client Credentials)
    2. In Authorization URI, enter the Authentication Server URL in the format:

      <Authentication Server URL>:<port if specified during install>/connect/token

      For example, https://authentication.blueprism.com:5000/connect/token

      Or, if the default port was used, https://authentication.blueprism.com/connect/token

      If you have upgraded from a version earlier than Hub 4.3, your system will still be using IMS. In this case, you should enter the information in the format:

      <IMS URL>:<port if specified>/connect/token

      For example, https://ims.blueprism.com:5000/connect/token

    3. In Credential, select the credential you created in Set up credentials in Blue Prism.
  11. Click OK to save and complete the setup of the Web API Service.