Leapwork Silent install guide

A silent install is the installation of a software program that requires no user interaction. It is a convenient way to streamline the installation process of a desktop application like LEAPWORK Studio, LEAPWORK Controller, or the LEAPWORK Agent.

The LEAPWORK installer is based on MSI, and can be used from the command-line like this:

msiexec.exe [MSI COMMAND] [MSI INSTALLER FILE PATH] [MSI COMMAND OPTIONS] [INSTALLER PACKAGE PARAMETERS]

• [MSI COMMAND]

• • • /i -- normal installation;

    • /x -- uninstall the package.

      • /quiet

        • quiet mode (there is no user interaction)

• [MSI INSTALLER FILE PATH]:

• • • a (quoted if contains spaces) path to the installer file;

• [MSI COMMAND OPTIONS]:

• • • /qn -- queit/no UI installation;

    • /norestart -- no restart;

    • /forcerestart -- forced restart;

    • /l*v -- enables verbose logging;

[INSTALLER PACKAGE PARAMETERS]: An optional list of the package parameters. It may contain a list of required "features" and other parameters like ports, shortcuts, paths &, etc. Any parameter's value should be quoted if it contains spaces.

List of features

• AgentFeature -- the agent;
• ControllerFeature -- the controller;
• StudioFeature -- the studio.

Common Properties

• • ADDLOCAL -- a comma-separated list of features to be installed. Default: all features;

  • LEAPWORK_AGENT_PORT -- a TCP port to be used by the Agent. Possible values: any valid TCP port. Default: 6777;

  • LEAPWORK_AGENT_FIREWALLEXCEPTION -- indicates whether to create a rule for the Agent's port in the firewall. Possible values: true/false. Default: true;

  • LEAPWORK_AGENT_PASSWORD -- a password that secures the connection to the Agent. Possible values: any string. Default: empty string;

  • LEAPWORK_CONTROLLER_PORT -- a TCP port to be used by the Controller. Possible values: any valid TCP port. Default 9000.

  • LEAPWORK_CONTROLLER_API_PORT – an HTTP port for Public REST API endpoints. Possible values. Default 9001.

  • LEAPWORK_CONTROLLER_PASSWORD – initial password for LEAPWORK administrator by default called as “admin”.

  • LEAPWORK_CONTROLLER_FIREWALLEXCEPTION -- indicates whether to create a rule for the Controller's port in the firewall. Possible values: true/false. Default: true;

  • LEAPWORK_ASSETS_DIR -- a path to a folder where all assets will be stored. Possible values: string, any valid path. Default: C:\Program Files\LEAPWORK\Assets\;

  • LEAPWORK_MEDIA_DIR -- a path to a folder where video and screenshots files of flows will be stored. Possible values: string, any valid path. Default: C:\Program Files\LEAPWORK\Assets\;

  • LEAPWORK_STUDIO_SHORTCUT -- indicates whether to create shortcuts for the Studio on the desktop and in the Start menu. Possible values: true/false. Default: true;

  • LEAPWORK_LOGS_DIR -- a path to a folder where all application log will be written. Possible values: string, any valid path. Default: C:\Program Files\LEAPWORK\Logs\.

  • API_ACCESS_KEY -- An API access key value. Value length must be 16 or more symbols, must contain lower and upper cases of English alphabet only and numbers;

  • LICENSE_KEY - LEAPWORK License key for the controller (and agent). Agents-only license is not supported.

Enterprise Properties

• LEAPWORK_MSSQL_ASSET_DB_NAME – A name for Assets database; Default: Asset;

• LEAPWORK_MSSQL_REPORT_DB_NAME – A name for Report database; Default: Report;

• LEAPWORK_MSSQL_CONNECTION_TYPE - Type of connection to a database. Possible variants:

  • StandardSecurity

  • TrustedConnection

• LEAPWORK_MSSQL_INITIAL_CATALOG - Database initial catalog. Default: master;

• LEAPWORK_MSSQL_SERVER_ADDRESS - IP address or hostname where MSSQL server is running;

• LEAPWORK_MSSQL_INTEGRATED_SECURITY - Security type specification for StandardSecurity connection type. Default: SSPI;

• LEAPWORK_MSSQL_USER_NAME - User name for accessing the database using StandardSecurity connection type.

• LEAPWORK_MSSQL_PASSWORD - Password for accessing the database using StandardSecurity connection type.

• LEAPWORK_WINDOWS_USERNAME - Windows user name for accessing the database using TrustedConnection connection type. Must be with domain or machine name, like LEAPWORKDomain\User1 or AUTOMATIONMachine\User2

• LEAPWORK_WINDOWS_PASSWORD - Windows user password for accessing the database using TrustedConnectionconnection type.

Silent install using the previous configuration from the registry

• USE_CONFIGURATION_FROM_REGISTRY - A special flag that allows using previous configuration values from the registry in case of previous LEAPWORK installation (Now LEAPWORK is not installed on the machine). Possible values: true and false. The default value is false and you don’t need to add it as a parameter if you don’t want to use values from the registry. Be noticed, that this flag will work only if the next properties in the registry must exist and conditions are satisfied:

• • • DataBase.The type must exist with possible value SQLite or MSSQL;

    • For Enterprise installation:

      • MSSQL.AssetDbName must exist, value is not whitespace or empty;

      • MSSQL.ReportDbName must exist, value is not whitespace or empty;

      • MSSQL.ConnectionType must exist with possible value StandardSecurity or TrustedConnection;

      • MSSQL.ServerAddress must exist, value is not whitespace or empty;

      • MSSQL.InitialCatalog must exist, value is not whitespace or empty;

      • MSSQL.IntegratedSecurity must exist in the case of StandardSecurity connection type.

      • MSSQL.UserName must exist in the case of StandardSecurity connection type.

      • Windows.UserName must exist in the case of TrustedConnectionconnection type.

    • For Platform/Trial installation:

      • DB_KEY_SETUP must exist, value is not whitespace or empty;

      • LEAPWORK_ASSETS_DIR contains SQLite database files from the previous installation;

Example of silent install command with logging and access key with all default values:

msiexec /i "C:\Users\localadmin\Downloads\LEAPWORK_Experimental_x64_2019.1.1265.msi" /qn /norestart /L*V "C:\Users\localadmin\Downloads\example.log" API_ACCESS_KEY="yYjxcgMdT53ueZOc"

Example of how to uninstall Leapwork in silent mode without user interaction(without confirmation about uninstalling):

msiexec /x "C:\Users\localadmin\Downloads\LEAPWORK_Experimental_x64_2019.1.1265.msi" /quiet /qn /norestart /L*V "C:\Users\localadmin\Downloads\example.log"

Enterprise with connection type StandardSecurity:

msiexec /i "C:\Users\localadmin\Downloads\LEAPWORK_Experimental_x64_2021.1.200.msi" /qn /norestart /L*V "D:\logs\exampleSilent.log" API_ACCESS_KEY="yYjxcgMdT53ueZOc" LEAPWORK_AGENT_PORT="6777" LEAPWORK_CONTROLLER_PORT="9000" LEAPWORK_CONTROLLER_API_PORT="9001" LEAPWORK_MSSQL_ASSET_DB_NAME="AssetTest" LEAPWORK_MSSQL_REPORT_DB_NAME="ReportTest" LEAPWORK_MSSQL_CONNECTION_TYPE="StandardSecurity" LEAPWORK_MSSQL_INITIAL_CATALOG="master" LEAPWORK_MSSQL_INTEGRATED_SECURITY="SSPI" LEAPWORK_MSSQL_SERVER_ADDRESS="localhost" LEAPWORK_CONTROLLER_PASSWORD="admin" LEAPWORK_MSSQL_USER_NAME="superuser" LEAPWORK_MSSQL_PASSWORD="superuser" LICENSE_KEY="GZ4cQT0LwbLX5dzMY1lWpIMN6y5b5nFa8VCBxJieDzOGhcisjF6DERp4K17JbT7LEd2MIDqr+E2teE3l0kUP9jzkRd5G0z04LxGsS2F/ZIarDqcccLimbz0M6XItC2s4H7J4E/pto12QzcK8ZBeSuw=="

Enterprise with connection type TrustedConnection:

msiexec /i "C:\Users\localadmin\Downloads\LEAPWORK_Experimental_x64_2021.1.200.msi" /qn /norestart /L*V "D:\logs\exampleSilent.log" API_ACCESS_KEY="yYjxcgMdT53ueZOc" LEAPWORK_AGENT_PORT="6777" LEAPWORK_CONTROLLER_PORT="9000" LEAPWORK_CONTROLLER_API_PORT="9001" LEAPWORK_MSSQL_ASSET_DB_NAME="AssetTest" LEAPWORK_MSSQL_REPORT_DB_NAME="ReportTest" LEAPWORK_MSSQL_CONNECTION_TYPE="TrustedConnection" LEAPWORK_MSSQL_INITIAL_CATALOG="master" LEAPWORK_MSSQL_SERVER_ADDRESS="localhost" LEAPWORK_CONTROLLER_PASSWORD="admin" LEAPWORK_WINDOWS_USERNAME="AUTOMATION5\localadmin" LEAPWORK_WINDOWS_PASSWORD="Leapwork@2019" LICENSE_KEY="GZ4cQT0LwbLX5dzMY1lWpIMN6y5b5nFa8VCBxJieDzOGhcisjF6DERp4K17JbT7LEd2MIDqr+E2teE3l0kUP9jzkRd5G0z04LxGsS2F/ZIarDqcccLimbz0M6XItC2s4H7J4E/pto12QzcK8ZBeSuw=="

Platform/Trial with the license:

msiexec /i "C:\Users\localadmin\Downloads\LEAPWORK_Experimental_x64_2021.1.200.msi" /qn /norestart /L*V "D:\logs\exampleSilent.log" API_ACCESS_KEY="yYjxcgMdT53ueZOc" LEAPWORK_AGENT_PORT="6777" LEAPWORK_CONTROLLER_PORT="9000" LEAPWORK_CONTROLLER_API_PORT="9001" LEAPWORK_CONTROLLER_PASSWORD="admin" LICENSE_KEY="klxRqXnfSp6rsqIQX1xZ9KB1Qg1thPWm6zQADbGZNEzToz0rUWGo8dmfWcZDLDj6Go0QUbVxYj8CFmMzoNJCScrAgNh0guBDP0IxZKwh5B/g87Q3bkk18Ol64pcSH1s13ekmgHTzT4tXeHk82nQE+Q=="

Trial with no license:

msiexec /i "C:\Users\localadmin\Downloads\LEAPWORK_Experimental_x64_2021.1.200.msi" /qn /norestart /L*V "D:\logs\exampleSilent.log" API_ACCESS_KEY="yYjxcgMdT53ueZOc" LEAPWORK_AGENT_PORT="6777" LEAPWORK_CONTROLLER_PORT="9000" LEAPWORK_CONTROLLER_API_PORT="9001" LEAPWORK_CONTROLLER_PASSWORD="admin"

Example of installation using the previous configuration from the registry:

msiexec /i "D:\LEAPWORK_Experimental_x64_2021.1.250.msi" /qn /norestart /L*V "D:\logs\exampleSilent1.log" USE_CONFIGURATION_FROM_REGISTRY="true"

Please note: Windows 7 and Windows Server 2008 require a restart after installation, which can be done manually or by adding a restart command in your command line script.

For any clarification, please contact our Priority Support.