Skip to main content

Installation

Prerequisites​

Perform the following steps, as part of the prerequisites for installing Test Manager.

1. Requirements​

Check the Hardware requirements and Software requirements before installation.

2. Install and enable Test Automation​

You can enable the Test Automation module when you install or upgrade Orchestrator. When you reach UiPath Orchestrator Setup select Test Automation.

docs image

Additionally, you can perform the following steps for enabling the Test Automation feature in Orchestrator, based on the installation type:

  • For MSI intallations:
    1. On the Orchestrator web application server, navigate to Control panel, and then Programs.
    2. Select Orchestrator, and then click Change.
    3. Select Test Automation. A pop-up is displayed, where additional steps are described to finalize the action.
    4. Follow the steps from the pop-up to finalize the action.
  • For Orchestrator deployed in Azure PaaS:
    1. Before running the Publish-Orchestrator.ps1 script, configure the following settings for your App Service:
      1. AppSettings: Key = TestAutomation.ModuleEnabled - Set to True to enable the Test Automation module.
      2. AppSettings: Key = TestAutomation.FeatureEnabledByDefault - Set to True to enable the Test Automation module by default.
      3. ConnectionString: Name = TestAutomation
        • Set the Test Automation database connection string. You can either use a connection string similar to the one used for Orchestrator, or a different one altogether. For example: Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True.
          warning

          Make sure to mark these settings as Deployment slot setting, especially if you are using hotswap slots.

    2. If you already have deployed Orchestrator without enabling the Test Automation module, run the Publish-Orchestrator.ps1 script with the same parameters as for an upgrade, and add the -testAutomationFeatureEnabled parameter.
    3. If you upgrade your Orchestrator instance, add the -testAutomationFeatureEnabled parameter to the Publish-Orchestrator.ps1 script before running it.

3. Configure SQL server users​

Provide the SQL user that you provide in the Authentication Mode field from the Database Settings installation tab, with the necessary rights to create databases. During the installation of Test Manager, a new and dedicated database is created.

note

When you enable the Test Automation feature in the Orchestrator, it creates a dedicated database with the default name UiPathTestAutomation. This database differs from the one created during the Test Manager installation.

  • Regardless of the type of user (domain or SQL) you want to connect to SQL Server, please note that you need to assign it the dbcreator Server Role BEFORE installing Test Manager, as the database is created during this installation process.

  • If security restrictions do not allow the use of the dbcreator Server Role in the service account, create the empty database in SQL Server. The Windows installer connects to SQL Server to verify the existence of the database.

  • After creating the database, you need to provide the user which connects to the SQL database with the db_owner user mapping role, as in the following screenshot.

    docs image

4. Download the installation kit​

Download the UiPath Test Manager installation kit from the Customer Portal.

5. Configure SQL server instance​

Configure the SQL Server instance that you want to use to install Test Manager, using the following requirements:

  • The name of the SQL Server machine;
  • The name of the instance, if it’s not the default instance;
  • The value of the TCP port, if it’s not the default port - 1433;
  • The SQL Server port is open in the firewall of the SQL Server machine;
  • The TCP Protocol in SQL Server Configuration Manager has to be enabled;
  • The SQL Server service needs to listen on a fixed port, not on a dynamically allocated one.

6. Allocate Testing runtime licenses at the tenant level​

After installing Test Manager, you must allocate a Testing runtime license to the tenant where you will use Test Manager.