Installation Guide: Download and install - Platform Version of Leapwork

Installation Guide: Download and install - Platform Version of Leapwork

Introduction

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

Note: The Leapwork Platform edition utilizes the onboard SQLite database.

Studio

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. The user can then down/upgrade the machine as required. 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. The Server is installed on a Windows server. Here is how to choose the configuration for the Agent machine:

Getting Ready for Installation

Download Leapwork

.NET Framework

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 article.

Leapwork License Credentials

  1. Upgrade the .NET Framework to the latest version 4.8 on all machines where it is going to be installed.
  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 Leapwork release page on all machines where it is going to be installed.
  4. Double-click the msi-file to start the installation.

Controller Installation

  1. Open MSI file location and double-click the .msi-file to start the installation. The first screen will display the version number.
  2. Click ' Next' to begin the installation.
  3. Read the end user agreement tick “I accept the terms in the license agreement” checkbox and Click 'Next' button if you agree.
  4. Choose Automation Controller and deselect other two, you can keep studio if you want to keep in the controller machine, but we do not recommend having an agent installed on the controller machine.
  5. Select the second radio button on the screen “ I have license key”. Next, click on the "Get a License key" This will take you to the Leapwork license page.
  6. You will have to log in using your e-mail and the password provided when signing up on leapwork.com. If you experience problems with the login, please contact Leapwork Customer Success.
  7. After successful login on leapwork.com, the license management page opens.
  8. Select your Subscription License as: "Platform -#XXXXX" from dropdown.
  9. Select Generate a license key for options from dropdown.
  10. Specify the number of Agents to add to the Controller. If you have only one controller, then put the total numbers of agents you have purchased; if you have more than one Controller, then you can split agents between the controllers in this step.
  11. Click Get license key.
  12. Copy the license key by clicking Copy license key.
  13. Go back to installer and paste the keys to Enter license key section and click Next button.
  14. Clicking ‘ Next’ button will take you to Controller Configuration page.
  15. Select Add exceptions for the Controller in Windows Firewall.
  16. Click Next.
  17. Specify a password for the default user (“Admin”). The “Admin” user is required for the first login to the Leapwork Studio after installation.
  18. Click Next after setting the password.
  19. Click Next on final warning screen to start the installation process.
  20. Click Finish to complete the installation process.

Studio 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 Next to begin the installation.
  3. Read the end user agreement and select I accept the terms in the license agreement checkbox.
  4. Click Next button if you agree.
  5. Choose Automation Studio and deselect other two; you can keep Agent if you want to keep in the same machine, but we do not recommend having the agent installed on studio machine.
  6. Click Install to start the installation process.
  7. Click Continue to start the IE Addon installation.
  8. Click Ok to finish installation.

Controller Port

The Studio 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.

Configuring Studio

  1. Double click on the Studio Icon on the desktop or your start menu to open Leapwork.
  2. Double click on the Studio Icon Will open Leapwork Studio Authentication Window.
  3. Click on select Controller button first to select the correct controller in your organization.
  4. Click on the Select controller dropdown to find and select your controller installed above (It will appear as IP address or the name of Controller there), if you can’t find the name of the controller by default then you can type it manually on the same dropdown control.
  5. Change the port number of the controller if you have changed it during controller installation.
  6. Select the Web socket protocol as it enables faster communication between Studio, Controller and Agent machines.
  7. Once you are done with all the above settings Connect button will enable, click Connect. This will take you back to the Leapwork Studio Authentication Window. To log in to Leapwork for the first time, you need to use your admin credentials (you created in step 15, Controller Installation) in the Leapwork Studio Authentication Window: Enter the credentials and Press login will let you in to the Leapwork Studio.

Leapwork Administration

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

We recommend you add a few users after installation and check that flow creation is working. Afterward, use the flowing link to import the flows created during the proof of value phase.

Agent 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 Next to begin the installation.
  3. Read the end user agreement and select I accept the terms in the license agreement checkbox.
  4. Click Next if you agree.
  5. Choose Automation Agent and deselect other two; we do not recommend having Studio or controller installed on Agent machine.
  6. The configuration screen contains several settings that you can modify before completing the installation.
  7. Click Next after choosing your desired configuration.
  8. Click on the Install button to start the installation process.
  9. Click Continue to start the IE Addon installation.
  10. Click Ok to finish installation.
  11. Click on Finish to complete the installation.
  12. To Configure Agent, you have to go to the studio machine and configure it using Leapwork Studio. Here is a link which explains how to configure an agent after installation.