Configure Blue Prism to use Director

Important information:

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

To configure Blue Prism to use Director, you need to:

  1. Set up a service account in Hub and generate a secret key.
  2. Import the Blue Prism Director API to create the basic credentials and Web API Service.
  3. Modify the credentials to use the Director service account in Blue Prism.
  4. Configure the Web API to communicate with Director. This service includes the actions Add to Queue, and Advise Next Best Item, which can be used in your processes.

Set up a service account

To set up the Director API credentials in Blue Prism, a secret key is required. This is generated from the associated service account in Hub for use with the Director 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 Director 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, Director.

  3. Under Permissions, select Director API.

  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.

Import the Blue Prism Director API

  1. Log into the Blue Prism interactive client, select File and click Import > Release / Skill.

    The Import Release dialog displays.

  2. Click Browse.
  3. Locate and select the Director .bprelease file. An example of the file name is BP Director New Customer Package yyyy_mm_dd.bprelease.

    For example:

    Import Director .bprelease file

    The release file includes example credentials and the configuration for the Director API service. Once the import is complete, the credentials will need modifying to use the service account secret key.

  4. Click Next.

    A progress screen displays.

  5. When the import has completed, click Finish.

Modify the credentials in Blue Prism

  1. In Blue Prism, select System and then click Security > Credentials. See Security > Credentials for additional information.
  2. Select DirectorSvc and click Edit.

    The Credential Details dialog displays.

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

    1. Change the Type to OAuth 2.0 (Client Credentials).
    2. 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.

    3. In Client Secret, enter the secret key that was generated for the service account.
    4. Under Additional Properties, enter bp-director:manage as the Source value.
    5. Credentials Details for Director

  4. On the Access Rights tab of the Credential Details dialog, set up the required access permissions.
  5. Set up the required access permissions on the Access Rights tab of the Credential Details dialog:
    1. On the Security Roles tab, select System Administrators or All Roles, as required.

    2. On the Processes (legacy) tab, select the processes that should have access to this credential, or All Processes.

    3. On the Resources (legacy) tab, select the resources that should have access to the credential, or All Resources.

  6. Click OK.

Configure the Web API

If you need to configure Director, contact Blue Prism Cloud Support for the two URLs that are needed for this procedure; the Base URL (step 3) and the Authentication Server URL (step 4).

  1. In Blue Prism, select System and then click Objects > Web API Services.
  2. Select Blue Prism Director and click Edit Service.
  3. On the Web API: Blue Prism Director opening screen, in Base URL, enter the URL of the Director API service in the format:

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

    For example, https://director.blueprism.com:5002/

    Or, if the default port was used, https://director.blueprism.com/

  4. 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

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