Communicating back to Interact

The communication channel back to Interact from Blue Prism is performed by a Blue Prism Web Service. The web service is available as a release that can be imported into Blue Prism. Once imported it will need to be updated with the appropriate base URL and authorization codes to enable secure communication.

If you upgrade Interact to a new release, you must ensure you import the latest release file into Blue Prism.

The image below shows the web API service.

In the main window of the web API service we can see the Base URL defined, this will need to be updated to reflect the configuration of your platform setup.

The Common Parameters section is left blank and the Common Authentication section is used. This requests a Bearer Token using stored credentials from the Credential store.

To set up the credentials, a ‘client_secret’ must be configured. This is generated during the installation process and is stored in the Interact Remote API Secret Key file in C:\Program Files (x86)\Blue Prism\Interact Remote API secret key.txt. See the Interact installation guide for more details.

Configure credentials for the Interact Web API service

When configuring the credentials for the OAuth 2.0 (Client Credentials) the following four values must be configured in the Blue Prism System Settings (Security > Credentials):

  • Client ID – Enter InteractRemoteClient.
  • Client Secret – Enter the secret key file contents found in: C:\Program Files (x86)\Blue Prism\Interact Remote API secret key.txt.
  • grant_type – Set the value to client_credentials.
  • scope – Set the value to interact-remote-api.

Remember to set up the Access Rights tab in the Credentials Details to ensure it can access the processes for the allowed users.

In the web service there are six defined actions:

These actions are called from a supplied Blue Prism Object so after the initial configuration of the URL and authorization codes the Web Service does not need to be amended. In the next section we will go through each of the actions within the Blue Prism Object and explain how they are used.