Install and configure the Digital Worker API

The Blue Prism Digital Worker API provides an interface between Blue Prism Desktop and the Blue Prism database, allowing Blue Prism Desktop to obtain all the information it needs to run automated processes.

To watch the Blue Prism Digital Worker API installation, see the Blue Prism Digital Worker API installation and configuration video

Prerequisites

The Digital Worker API requires the following components to be installed in your Blue Prism environment prior to installation:

  • Blue Prism Enterprise Edition version 7.1 – Your Blue Prism Desktop license gives you access to the Desktop-specific functionality available in Blue Prism.

    The Blue Prism installation used to administer Blue Prism Desktop must be installed in a dedicated environment.

  • Blue Prism API version 7.1 – The API provides an interface for Blue Prism Desktop to connect with the Blue Prism database. It also provides a series of predefined capabilities that are used to interact with Blue Prism programmatically using a RESTful API.
  • The Blue Prism API needs to be installed in your Blue Prism Desktop environment, however, there is no recommended order in which the APIs need to be installed.

  • Blue Prism® Hub version 4.6 – Blue Prism Hub deploys Authentication Server. Authentication Server provides a centralized, common authentication method for users across key Blue Prism components, including Blue Prism Desktop.

Minimum hardware requirements

See Blue Prism software and hardware requirements for details of the minimum requirements for the web server onto which the Digital Worker API will be installed.

Web server IIS configuration

The Digital Worker API must be installed as part of the Blue Prism Desktop installation. The API must be installed on an IIS-enabled server, which should have a low latency connection to the Blue Prism database. The Digital Worker API can be installed on the same server as the Blue Prism API, if required.

If you are installing the Digital Worker API on a separate web server to the Blue Prism API, the following configuration must be applied to the web server that will host the API. If you are installing the Digital Worker API on the same server as the Blue Prism API and have already set up the web server, this step does not need to be repeated. This can be configured using the provided PowerShell script, or manually.

If required, the Digital Worker API can be installed on the same web server as the Blue Prism API, Hub, and Authentication Server.

Scripted configuration

To configure the web server via a script, run the following command using the PowerShell command prompt:

Copy
Install-WindowsFeature -name Web-Server, Web-Windows-Auth -IncludeManagementTools

Configure SSL certificates

An SSL certificate will be required on the device where the Digital Worker API will be installed. It will be used to secure the site that is created. SAN and Wildcard certificates are supported. The certificate must be present on the machine that hosts the API and should be stored in the Trusted Root certificate store. Depending on your infrastructure and IT organization security requirements this could be an internally created SSL certificate or a purchased certificate to protect the website. See Generate a self-signed SSL certificate for information on generating a self-signed certificate.

Enable Authentication Server

To enable authentication against the API, your Blue Prism environment must be configured to use Authentication Server, and Authentication Server must be enabled in the interactive client.

Install the Digital Worker API

After you have installed Hub, Authentication Server, and Blue Prism Enterprise, you can now install the Digital Worker API.

To install the Digital Worker API, download and run the Blue Prism Digital Worker API installer, available from the Blue Prism Portal, and progress through the installer as shown below. The installer must be run with administrator rights.

Step

Installer screen

Details

1

Digital Worker API installation welcome screen

Welcome

If required, select another language for the installer from the drop-down list. The default language is English (United States).

Click Next.

2

Digital Worker API installation license agreement screen License agreement

Read the End-User License Agreement and if you agree to the terms, select the check box.

Click Next.

3

Digital Worker API installation installation destination screen Destination folder

Specify the required installation folder. The default location is C:\Program Files (x86)\Blue Prism\Blue Prism Digital Worker API, but you can choose your own using the Change button.

Click Next.

4

Digital Worker API installation IIS setup screen

IIS Setup

Configure the Internet Information Service (IIS) for the Digital Worker API.

  • Site name – This defaults to Blue Prism API DW and cannot be amended.
  • Host nameEnter the URL of the Digital Worker API website. This URL must also match the site included in the required certificate.
  • Port – Enter the port number for the machine that you are installing the Digital Worker API onto. The default port number is 443.
  • If the Blue Prism API is installed on the same server and you have already used the default port number, you must enter a different port number here.

  • SSL Certificate – Select the appropriate Secure Sockets Layer (SSL) certificate, issued for the website specified for Host name.

Click Next.

5

Digital Worker API installation configure sql screen

Configure SQL connection

Configure the SQL database connection for the Digital Worker API.

  • SQL Server – Enter the SQL server host name or IP address.
  • If using a non-standard SQL port, enter the SQL server host name, followed by the port. For example: SQLSERVER1,1434.

  • Authentication Mode – Select your authentication mode for the account that the API will use to connect to the Blue Prism database:
    • For Windows Authentication (default), this is the identity of the IIS application pool associated with the site.
    • For SQL Authentication, enter the username and password.
  • Database name – Enter the name of your Blue Prism database.

The minimum SQL permissions must be granted to the user who will connect to the Blue Prism database in order for the API to function correctly.

Click Next.

6

Digital Worker API installation configure encryption keys screen

Configure encryption keys

Select the location from which to load the encryption keys.

  • Blue Prism server configuration (recommended) – Select an existing Blue Prism server configuration from which to load the encryption keys.
  • The options available in the drop-down list are taken from the Blue Prism application server configuration. The web server does not need to be able to communicate with a running Blue Prism application server, but the server configuration file must be present on the web server.

  • Load encryption keys from database – Select this option if the encryption keys are stored in the Blue Prism database. This is commonly appropriate for scenarios where no application server is deployed.

Click Next to install the Digital Worker API. A progress bar displays during the installation of the API.

7

Digital Worker API installation installation complete screen

Installation complete

If the installation has completed successfully, click Finish to exit the installer.

If the installation fails, click View Log to see the error that was encountered.

Configure IIS application pool for Windows Authentication access to database

This section applies to Windows Authentication only.

After you have successfully installed the Digital Worker API, you will need to complete the following Internet Information Service (IIS) configuration:

If the Digital Worker API has been configured to use Windows Authentication, the Blue Prism Digital Worker application pool in IIS will need to be updated to run as a user with appropriate access to the Blue Prism database. Follow the steps below when using Windows Authentication for the database connection:

Application pool identities are most commonly set to service accounts.

  1. Launch the Internet Information Services Manager from the Windows Start menu.
  2. In the Connections pane, click Application Pools.

    The Application Pools window displays.

  3. Select Blue Prism API DW.

  4. In the Actions pane, click Advanced Settings.
  5. In the Advanced Settings dialog, expand Process Model and click the ellipsis () next to ApplicationPoolIdentity.

    Configure IIS for Windows Authentication

  6. In the Application Pool Identity dialog, select Custom account and click Set....
  7. In the Set Credentials dialog, enter the Windows login credentials service account that has access to the Blue Prism database and click OK.

    The database user required to connect to the Blue Prism database must have db_datareader and db_datawriter permissions.

    Application pool configuration

  8. In the Connections panel, expand the Sites node and select Blue Prism API DW.
  9. The Blue Prism API DW Home window displays.

  10. In the Actions panel, under Manage Website, click Restart.
  11. Restart site

After you have successfully installed and configured the Digital Worker API, you need to install the Blue Prism Desktop client and configure a connection for use by the Desktop users. See Install and connect the Blue Prism Desktop client for details.

Configure IIS application pool for high usage (optional)

If the Desktop environment is accessed by more than 750 highly active users, then the Digital Worker API may time out, resulting in error messages being displayed. To prevent this from happening, it is recommended that the Regular time intervals (in minutes) setting in the Internet Information Service (IIS) application pool is decreased from 1740 to 180.

To amend this setting in IIS:

  1. Launch IIS from the Windows Start menu.
  2. In the Connections pane, click Application Pools.

    The Application Pools window displays.

  3. Select Blue Prism API DW.

  4. In the Actions pane, click Recycling.
  5. In the Edit Application Pool Recycling Settings dialog, change the value of the Regular time intervals (in minutes) field to 180.
  6. Digital Worker API IIS setting

  7. Click Next, then click Finish to apply the changes.