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 and displayed 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 code displayed and copied during installation or, if not copied, from 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.

The web service has nine defined actions. These actions are available within the Utility - Interact API Blue Prism VBO along with a number of additional actions which map to the web service. The actions are:

Interact Web API

Blue Prism VBO: Utility - Interact API

Get Submission

Get Submission

Get Form Schema

Get Form Schema

Create Submission

Create Submission

Edit Submission Field Value

Edit <Type> Field Value, where the type is:

Update Config

Change Field State to Optional

Change Field State to Mandatory

Change Field State to Read Only

Change Field State to Hidden

Change Page State to Visible

Change Page State to Hidden

Update Status

Move Submission to History Tab

Move Submission to Approved Tab

Move Submission to Review Tab

Move Submission to Declined Tab

Move Submission to Draft Tab

Move Submission to Inbox Tab

Move Submission to Archived Tab

Raise Submission

Raise Submission

Get Users by Form Name

Get Users by Form Name

Upload File

Upload File

The actions are called from the Utility - Interact API VBO so, after the initial configuration of the URL and authorization codes, the Web Service does not need to be amended. Each of the actions within the Utility - Interact API VBO are explained in the next section.