Support Import

Installing ProcessRobot

As of version 2019.1, ProcessRobot installation is now carried out using a single installer, whether the target machine will be used for the ProcessRobot Server, Client Tool(s) (Control Desk, Process Studio, Dashboards) or a Robot (SideBot, SoloBot).

This guide describes the steps required for installing the Server, all Client Tools, and a SideBot on the target machine.

To install a single component on a Client machine, for example Process Studio, the required steps will be the same as those described in this guide, but will not include those specific to installing the Server.

Server installation

The ProcessRobot Server makes use of at least one SQL Server database as the main Database. Optionally, a second database can be used for Logs. If SQL Server has not been set up on the Server machine, the new ProcessRobot installer can be used to install SQL Server Express, for Proof of Concept demonstrations, quick trials, etc. For live production installations, the standard version of SQL Server is required (see Live Installation Requirements).

This guide describes the installation steps to be followed when SQL Server and the database to use for ProcessRobot are already in place.

Launch the ProcessRobot installer .exe or .msi file.

The installation wizard will begin by setting up some requirements for ProcessRobot.

prinstaller3.png

Click ‘Next’ to proceed with the installation.

prinstaller4.png

Accepting the terms of the license agreement is necessary to proceed.

Capture6b.PNG

Choose which components to install:

prinstaller6.png

For example, in this Server installation, also include all Client Tools plus a SideBot:

prinstaller7.png

Enter the Connection String for the existing SQL Server database to be used for ProcessRobot. Optionally select if a second database should be used for Logs. If this option is not selected, Logs will be stored in the same database as the other ProcessRobot data.

prinstaller8.png

Enter the Connection String in the format:

Password=<password>; Persist Security Info=True; User ID=<dbUserName>; Initial Catalog=<dbName>; Data Source=<serverName>;

Where:

<password> is the database user’s password

<dbUserName> is the database user name

<dbName> is the name of the database to be used for ProcessRobot

<serverName>; is the name of the Server machine. One way to retrieve this value is to launch SQL Server Management Studio (SSMS), and execute the following query: SELECT @@SERVERNAME AS 'Server Name'

prinstaller9.png

When selecting to use a separate database for Logs, a second connection must be entered.

prinstaller9b.png
Capture7b.PNG

Choose whether to create Desktop shortcuts for the Client Tools / Robot.

prinstaller13.png

Enter the IP address, host name or Fully Qualified Domain Name (FQDN) of the Server machine and the port number.

The number entered should correspond to a port that is not currently in use, and which complies with ITSEC and IANA (https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml).

A quick way to see which ports are currently in use is to run the following command as an Administrator in the Command Prompt:

netstat -a -b

As an example, this guide will use port number 6090.

prinstaller14.png

In cases where the ProcessRobot Server and Client machines belong to the same Active Directory domain, the host name should suffice.

prinstaller15.png

Note that if there are issues with the DNS, the other ProcessRobot components will not be able to communicate with the Server using only the host name or FQDN. DNS issues can be identified by pinging the host name or FQDN. In such cases, either the Server's IP address must be used instead, or the DNS issues must be resolved.

Select whether to use a Redis deployment. This guide will proceed without enabling this option.

prinstaller16.png

When Client Tools or a Robot are installed, it is necessary to also enter the Server address and port number previously entered in the format <server>:<port>. The <server> value can be entered in any of the three ways described previously, for example:

  • 10.1.182.106:6090 (IP address)

  • PR-SERVER:6090 (host name)

  • PR-SERVER.processrobot.com:6090 (FQDN)

prinstaller20.png

Select the destination file path for the ProcessRobot installation. The default location is: C:\Program Files\ProcessRobot.

prinstaller21.png

Optionally enter a Certificate Name to use for ProcessRobot Custom Authentication. The Certificate must already be set up on the Server machine. For more details about how to set up Certificates, read this article.

To enable Custom Authentication at another time, refer to the article Configuring Custom Authentication after Installation.

prinstaller22.png

Once the Certificate Name has been entered, there are several Certificate Validation Modes to choose from. For Self-Signed Certificates, choose “None”.

For Production grade deployments, the Mode will likely be different. In order to learn more about the Certificate validation modes and decide which one fits your environment, please visit:  https://docs.microsoft.com/en-us/dotnet/api/system.servicemodel.security.x509certificatevalidationmode?view=netframework-4.8

prinstaller34.png
prinstaller35.png

Set the Program Folder name.

prinstaller37.png

Set a Master Key, which is used to encrypt all Credentials stored in ProcessRobot.

prinstaller38.png

Click “Finish” to exit the ProcessRobot installer.

prinstaller39.png

Once the installation is finished, in case the "ProcessRobot Server" service does not start, navigate to the installation folder (usually to C:\Program Files\ProcessRobot\Server) and execute the file ProcessRobotDatabaseUpgrader.exe. This will setup the ProcessRobot database automatically for so that the service will start.

To verify that everything went well, check if the ProcessRobot service is up and running. To do so, open the Windows Task Manager. Under the "Services" tab, find the ProcessRobot Server service.

Capture9b.PNG

Allow the ProcessRobot Server to communicate through the firewall by either allowing the Port # or the ProcessRobot.Server.exe.

Custom Authentication

To enable custom authentication using the Certificate, some additional actions are required beyond the installer steps.

Navigate to the file path where the Server components have been installed, by default C:\Program Files\ProcessRobot\Server. Locate the “AppSettings.config” file.

prinstaller40b.png

Edit the file with a text editor like Microsoft Notepad or Notepad++.

prinstaller41.png

Locate in the file the line with following:

<add key=”SupportMixedAuthentication” value =”false”/>
prinstaller50c.png

Change the value of “false” to “true”.

prinstaller51c.png

Locate the line with the following:

<add key=”CertificateFindValue” value =”ProcessRobot”/>
prinstaller46b.png

Change the value of “ProcessRobot” to the Certificate Name, as entered in the equivalent field in the ProcessRobot installer.

prinstaller55b.png

Save and close the file.

Restart the ProcessRobot Server service through the Windows Task Manager for these changes to take effect.

Capture11b.PNG