Install the Process Intelligence Recorder

Prerequisites

The following requirements must be met before installing the Recorder:

  • The user workstations installing the Recorder component and the server hosting the Recording Service component must all be members of the same Active Directory domain.
  • All user accounts on whose computers you intend to install the Recorder must be added to the Recorder writers Active Directory security group you created before the installation.
  • The appropriate browser extensions must be installed to ensure that user activities are recorded in Google Chrome, Microsoft Edge, and Mozilla Firefox browsers. The Firefox extension has several limitations. Please refer to the Known issues for more details.
  • If you plan to record user activities which are using Windows RemoteApp and Citrix Workspace App, install the Recorder on a terminal server.

You might be prompted for a system reboot during the Recorder installation. Please save your work first, otherwise you may lose unsaved changes.

Interactive installation

  1. Run the Recorder installer.

  2. Select the language in which you want to run the installation.

    The Recorder is available in two languages, English and Japanese. The Japanese interface is only available on operating systems where the Japanese locale is enabled.

  3. Read, and if you agree with the terms, accept the license agreement.

  4. Specify the folder where the Recorder will be installed. The default installation folder is: C:\Program Files\BPPI Recorder.

  5. Specify a local or network folder where the program will store its data. To keep data in the %appdata%\BPPI\Recorder\ folder, select Use AppData folder.

    Depending on the operating mode (set in the next installation step), different data is stored in the specified folder:

    • When installed in Standalone mode, application logs and logs with recorded user activity are stored in the folder.

    • When installed in Server managed mode, only application logs are stored in the folder.

  6. If required, specify a tag. A tag is a descriptive text string for the workstation on which your Recorder instance is being installed. When installing in Server managed mode, the tag is passed to the Recording Service and helps the administrator identify a workstation on the Recording Service website. 'Username' is not recommended as a tag because several users could occupy the same workstation.

    For example, you can specify the same tag when installing the Recorder on several workstations, such as, the 'accounting department' tag. You can then easily find these workstations in the Recorders list on the Recording Service website when filtering by the 'accounting department' tag.

  7. Select the Recorder operation mode:

    1. Standalone – When this mode is enabled:

      • Recording control (start/stop) remains with the local computer.
      • The logs with the recorded data are saved on the local computer.
      • The setup installs the Recorder Log Viewer utility. The utility enables logs to be opened that were recorded by the Recorder when installed in Standalone mode. For detailed information on using the Recorder Log Viewer, see Recorder logs.

      Standalone mode is useful for trial purposes. It has the following restrictions:

      • Forms are not available. These are detected automatically by the Recording Service and the Process Intelligence application if the Recorder installed in Server managed mode. Forms are not detected in the Standalone mode.

      • The Obfuscate user data option does not apply to screenshots. This means records in text logs are encrypted, but data in screenshots isn't blurred.

      • Logs are not processed and not sent to the Recording Service. Thus, it is impossible to use the Recording Service to review recorded data and upload logs to Process Intelligence. You'll need to upload collected logs directly to Process Intelligence manually. For detailed information, see Upload logs from a Recorder installed in standalone mode. Logs recorded in Standalone mode can only be uploaded to Task Mining 5.2 projects.

    2. Server managed – When this mode is enabled, the recording can be started and stopped from the Recording Service. User activity logs are automatically saved to the server. Specify the website on which the Recording Service is installed and accessible over network.

  8. Select the browser extensions you want to install. Extensions allow the Recorder to capture user actions in the Google Chrome, Microsoft Edge, and Mozilla Firefox browsers.

    The Firefox extension has several limitations. Please refer to the Known issues for more details.

    After the Recorder has been installed on the users' workstations, each user must enable the browser extensions. See instructions for Google Chrome, Microsoft Edge, and Mozilla Firefox.

If a user has just been added to the Recorder-writer Active Directory security group, you may need to restart the computer to allow the Recorder installed in the Server managed mode to connect to the Recording Service.

Command line installation

Downloading and installing any of the SS&C | Blue Prism® Process Intelligence components, including by silent installation via command line, means that you accept the End User License Terms.

You can install the Recorder components in silent mode using the command line. For silent installation, enter:

Abbyy.Recorder.<version>.exe /silent

You can use the following command-line options described below.

Option

Default Value

Description

/silent

 

Runs the installation in silent mode.

No setup dialog boxes are displayed, and the program is installed in default configuration.

/passive

 

Runs the installation with the progress bar only to be displayed. No other dialog boxes are displayed.

installDir=<path>

C:\Program Files\ABBYY Recorder

The path to the folder where the Recorder will be installed.

DataPath=<path>

%appdata%\ABBYY\Recorder

Folder where the program will store its data.

Depending on the operating mode, different data are stored in the specified folder:

  • If you specify ServerUrl value to install ABBYY Recorder in Server managed mode, only application logs are stored in the folder.
  • If you install ABBYY Recorder in Standalone mode, application logs and logs with recorded user activity are stored in the folder.

Tag=<tag>

 

Tag describing current workstation. No tag is added by default.

ServerUrl=<server URL>

 

Enables the Server managed mode. Specify the website URL on which the Recording Service is installed and accessible over network.

If this option is not specified, the default installation is in Standalone mode.

ChromeExt=<true|false>

true

Installs the Recorder Chrome extension.

EdgeExt=<true|false>

true

Installs the Recorder Edge extension.

FirefoxExt=<true|false>

true

Installs the Recorder Firefox extension.

The setup can only install the Firefox extension under a current user account. For more information, see Recorder Firefox browser extension limitations.

Each user must remove the Firefox extension from Mozilla Firefox manually. For more information, see Install the Firefox browser extension.

ControlButtonsVisible=<true|false>

true

Specifies the mode where most of the standard user interface (UI) is disabled.

The Recorder introduces a custom UI option as an alternative to the classic UI, which hides the Enable/Disable buttons from the user interface when installed in Server managed mode.

It is not recommended to install the Recorder with a custom UI in a production environment.

For detailed instructions, see Install the Recorder with a custom UI .

Install the Recorder with a custom UI

The Recorder includes a powerful security feature that allows users to stop the Recorder from recording their desktop activity. However, in cases where the recording process must only be managed by the administrator through the Recording Service, the end user is prevented from turning the Recorder on or off. For such cases, a custom UI option is available in the Recorder as an alternative to the classic UI, which removes the Enable/Disable buttons from the Recorder UI when it is installed in Server Managed mode. To use this option, all Recorders need to be installed in silent mode using the command line installation and the parameter controlButtonVisible = false. The controlButtonVisible parameter specifies the mode in which most of the standard Recorder UI is turned off, and prevents the user from controlling when the Recorder is on or off.

Example: Abbyy.Recorder.<version>.exe /silent installDir="C:\Recorder" DataPath="C:\Data" Tag="RecorderWorkstation1" ServerUrl="https://myrecordingserviсe.com/" FirefoxExt=false ControlButtonsVisible=false

This command installs Recorder to the C:\Recorder folder in Server Managed mode with the following settings:

  • The Enable/Disable buttons are removed from the Recorder UI. Only the administrator has privileges to control the recording process through the Recording Service website.
  • The Recorder Chrome and Edge extensions are installed. The Firefox extension is not installed.
  • Program logs will be stored in the C:\Data folder.
  • Logs of user activity will be sent to Recording Service hosted at https://myrecordingserviсe.com/.

Perform health check

Verify that the Recorder has installed correctly by doing the following:

  • Check that the Recorder icon appears in the system tray.
  • Open your browser and make sure the Recorder extensions appear in the extensions list.