Leapwork Platform | Leapwork Docs

Clean Installation Guide for the Leapwork Platform

All three components of the Leapwork Platform Edition can be installed on the following versions of Windows:

Notes:

.png?cb=50195850a609c6b59906ac16ee817630)

Flow

The studio should be installed on the user’s workstation hence its configuration remains the same for Platform and Enterprise editions. The studio is comparable to a normal Office installation, so, in most cases, no special configuration is required. The minimum hardware configuration requirements are:

Controller

The Controller is the central hub in the Leapwork system and needs to be configured to accommodate the workload. The workload depends on various factors:

The recommendation is to start with a standard server configuration and monitor the Controller machine's memory usage, I/O activity, CPU usage, etc. A standard server configuration could be:

The Controller can run on both physical and virtual servers. If you want to install all components on one machine, the following hardware configuration is required:

Agent

The Agent is used for executing automation flows. Whilst deploying the Agent in the Data Center, it may not be possible to obtain a Windows desktop version. Therefore, the Agent will also run on a Windows Server with Desktop Experience enabled. Here is how to choose the configuration for the Agent machine:

Simulating applications for an end-user:

In this case, the machine should be as similar as possible to the end-user's machine. This will increase the reliability of the automation flows. However, we recommend that the CPU has at least two cores.

The recommended hardware configuration, in this case, would be:

Running automation flows in parallel:

In the case of executing web automation flows, it is possible to set up an environment that points to a Selenium Grid. Selenium Grid allows multiple browsers to run web automation flows in parallel on the same machine. The more powerful the machine, the more browsers can run in parallel.

In this case, a recommended hardware configuration (assuming 4 parallel browser executions) would be as follows:

Getting Ready for Installation

Download Leapwork

.NET Framework

Always follow the installer guidance for your specific Leapwork version to ensure the correct .NET components are installed.

Access Required to Perform Installation

Port and Firewall Opening

Installation Guide

To get an overview of the components of the Leapwork Platform Automation edition, see Architecture Overview.

Leapwork License Credentials

Notes:

  1. Upgrade the .NET Framework to the latest version.
  2. Make sure you have credentials to log in to the Leapwork license engine.
  3. Download the latest version of Leapwork (MSI file) from the CP download page on all machines where it is going to be installed.

Note: The same MSI installer is used to install the Leapwork Controller, Flow, and Agents.

Controller Installation

  1. Open the MSI file location and double-click the .msi-file to start the installation. The first screen will display the version number.

  2. Click the Next button to begin the installation.

  3. Read the end user agreement and tick “I accept the terms in the license agreement” checkbox.

  4. Click the Next button if you agree.

  5. Choose Automation Controller and deselect the other two; you can keep studio if you want to keep it on the controller machine, but we do not recommend having the agent installed on the controller machine.

  6. Click the Next button.

  7. Enter your license key and click Next. To get a license key, click Get a License Key; you’ll be redirected to the Customer Portal.

  8. Click Next. The Database Selection page appears .

From the above two options above, choose the option based on the environment where your SQL Server is deployed (for example, on your own server or in the cloud):

Controller Port

The Flow and the Controller always communicate using internal API calls, and this requires the use of a TCP port. The default is port 9000, which you can change to any other port number that is not in use by other software on your computer.

Controller API Port

For any integration effort, access Leapwork open REST API using the default port number 9001, which you can change to any other port number that is not in use by other software on your computer.

Note: Unless it is necessary for any reason, we do not recommend changing either the Controller or Controller API port numbers.

Path to Videos

This is the path to the file system folder which contains the videos of test results.

  1. Select Add exceptions for Automation Controller in Windows Firewall. This will direct the installation process to add a rule to the Windows Firewall to permit all incoming connections to the Controller.

For the Azure hosted SQL server, the following information needs to be provided on the screen:

Note: For getting the details about the Client ID, Client Secret, and Tenant ID, please reach out to your organization's IT admin.

  1. Enter information into desired fields and click Next. The SQL server Configuration page appears. The following settings are required to connect Controller with SQL Server:
  1. After configuring all settings, click on Test Connection to check everything is correct; if the test connection passes, then click Next on the configuration screen.

  2. Specify a password for the default user (Admin). The Admin user is required for the first login to the Leapwork Flow after installation.

  3. Click Next.

  4. Click Install button to complete the installation process.

  5. Open Leapwork studio.

License Activation

To activate your license, you must obtain it from the CP.

Note: If you do not have access to the CP, please contact your Customer Success Manager (CSM) to request access or to receive your license.

  1. Enter your License Key and click the Validate button; your license will be successfully verified, and you can proceed to complete the Enterprise version installation.

Flow Installation

  1. Open the MSI file location and double-click the .msi-file to start the installation. The first screen will display the version number and ensure that the downloaded version fits your computer.

  2. Click the Next button to begin the installation.

  3. Read the end user agreement by clicking on the EULA tab.

  4. Click the Next button if you agree.

  5. Choose Automation Flow and deselect the other two; you can keep Agent if you want to keep it on the same machine, but we do not recommend having an agent installed on the studio machine.

  6. Click the Next button.

  7. Click Next button.

  8. Click Next button.

  9. Click the Install button to start the installation process.

  10. Installation has been completed. Click the Finish button.

Configuring Flow

  1. When opening Leapwork studio, Leapwork studio Authentication Window opens:

  2. Choose a Controller to select the one used in your organization.

Note: If you can’t find the name of the controller by default, then you can type it manually on the same dropdown control.

  1. Change the port number of the controller if you have changed it during controller installation.

  2. Enable the Web sockets transport protocol checkbox to allow faster communication between Flow, Controller, and Agent.

  3. Once you are done with all the above settings, click the Connect button.

It will return you to the Leapwork Flow Authentication Window. To log into Leapwork for the first time, use your admin credentials in this window.

  1. Enter the credentials and press the Login button.

Leapwork Administration

As an admin, you have access to Leapwork Administration, and you can perform actions shown below:

Agent Installation

  1. Read the end user agreement and tick “I accept the terms in the license agreement” checkbox.

  2. Click the Next button if you agree.

  3. Choose Automation Agent and deselect the other two; we do not recommend having Flow or controller installed on Agent machine.

  4. The configuration screen contains several settings that you can modify before completing the installation.

  5. Click the Next button after choosing your desired configuration.

The settings description

Port: Automation flows run in the Agent, which communicates with the Flow and Controller over a closed remote-control protocol on a configurable TCP port (default: 6777). You can change it to any unused port on the computer.

Note: We recommend keeping the default Controller, Controller API, and Agent ports unless a change is necessary.

Windows login: Agents include a strong security feature to automate logging in and out of Windows.

Agent password: In case you do not want to use the windows login feature, then you should use the Agent password to secure your agents. Because the Agent uses a remote-control protocol, we advise setting up a password to prevent unauthorized parties from connecting to it.

Add exceptions for the Agent in Windows Firewall: A check in this box will direct the installation process to add a rule to the Windows Firewall to permit all incoming connections to the Agent.

  1. Check Enable Selenium Manager to auto-download browser drivers if you want Leapwork Flow to automatically download the matching browser drivers from the internet during runs. Otherwise, leave it unchecked to use the packaged drivers installed locally, then click the Next button.

  2. Click the Next button and then press Install to start the installation process.

  3. Click the Finish button to complete the installation.

  4. To configure the Agent, go to the Flow machine and complete the configuration using Leapwork Flow.

For step-by-step instructions, see the article on configuring an Agent after installation.

For any clarification, please contact on Priority Support.