# LoadRunner Operator This page introduces the LoadRunner operator, a workflow operator that allows piloting performance tests on a target system by leveraging Micro Focus LoadRunner. This page assumes you are familiar with the definition of a workflow and its tasks. If it is not the case, then check [Creating automation workflows](https://docs.akamas.io/akamas-docs/3.2.1-1/using-akamas/preparing-optimization-studies/creating-automation-workflows). ## Prerequisites This section provides the minimum requirements that you should meet in order to use this operator. ### Supported versions * Micro Focus LoadRunner 12.60 or 2020 * Microsoft Windows Server 2016 or 2019 * Powershell version 5.1 or greater ### User and WinRM configuration To configure WinRM to allow Akamas to launch tests please read the [Integrating LoadRunner Professional](https://docs.akamas.io/akamas-docs/3.2.1-1/integrating-akamas/integrating-telemetry-providers/loadrunner-professional-provider) page. All LoadRunner test files (VuGen scripts and folder, lrs files) and their parent folders, must be readable and writable by the user account used by Akamas. ## Configuration options When you define a task that uses the LoadRunner operator you should specify some configuration information to allow the operator to connect to the LoadRunner controller and execute a provided test scenario. You can specify configuration information within the `arguments` that are part of a task in the YAML of the definition of a workflow. You can avoid specifying each configuration information at the task level, by including a `component` property with the name of a component; in this way, the operator will take any configuration information from the properties of the referenced component ### Required properties * `controller` - a set of pieces of information useful for connecting to the LoadRunner controller * `scenarioFile` - the path to the scenario file within the LoadRunner controller to execute the performance test * `resultFolder` - the path to the performance tests results folder with the LoadRunner controller #### Connect to a LoadRunner controller To make it possible for the operator to connect to a LoadRunner controller to execute a performance test you can use the `controller` property within the workflow task definition: {% code lineNumbers="true" %} ```yaml controller: hostname: loarrunner.example.com username: Domain\LoadRunnerUser password: j(sBdH5fsG9.I56P%7n2XPjmgO6!ARm= ``` {% endcode %} ## Operator arguments This table reports the configuration reference for the `arguments` section. | Field | Type | Value restrictions | Required | Default | Description | | ----------------------- | ------ | -------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `controller` | Object | | Yes | | The information required to connect to LoadRunner controller machine. | | `component` | String | | No | | The name of the component from which the operator will take its configuration options | | `scenarioFile` | String | Matches an existing file within the LoadRunner controller | Yes | | The LoadRunner scenario file to execute the performance test. | | `resultFolder` | String | | Yes | |

The folder, on the controller, where Loadrunner will put the results of a performance test.

You can use the placeholders {study}, {exp}, {trial} to generate a path that is unique for the running Akamas trial.

It can be a local path on the controller or on a network share

| | `loadrunnerResOverride` | String | A valid name for a Windows folder | No | res |

The folder name where LoadRunner save the analysis results.

The default value can be changed in the LoadRunner controller.

| | `timeout` | String | The string must contain a numeric value followed by a suffix (s, m, h, d). | No | 2h | The timeout for the Loadrunner scenario. If Loadrunner doesn’t finish the scenario within the specified amount of time, Akamas will consider the workflow as failed. | | `checkFrequency` | String | The string must contain a numeric value followed by a suffix (s, m, h, d). | No | 1m | The interval at which Akamas check’s the status of the Loadrunner scenario. | | `executable` | String | A valid windows path | No | C:\Program Files (x86)\Micro Focus\LoadRunner\bin\Wlrun.exe | The LoadRunner executable path | Important notice: remember to escape your path with 4 backslashes (e.g. `C:\\\\Users\\\\\…`) #### `Controller` arguments This table reports the configuration reference for the `controller` section which is an object with the following fields: | Field | Type | Value restrictions | Required | Default | Description | | ----------------------- | ------ | -------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `controller` | Object | | Yes | | The information required to connect to LoadRunner controller machine. | | `component` | String | | No | | The name of the component from which the operator will take its configuration options. | | `scenarioFile` | String | Matches an existing file within the LoadRunner controller | Yes | | The LoadRunner scenario file to execute the performance test. | | `resultFolder` | String | | Yes | |

The folder, on the controller, where Loadrunner will put the results of a performance test.

You can use the placeholders {study}, {exp}, {trial} to generate a path that is unique for the running Akamas trial.

It can be a local path on the controller or on a network share.

| | `loadrunnerResOverride` | String | A valid name for a Windows folder | No | res |

The folder name where LoadRunner save the analysis results.

The default value can be changed in the LoadRunner controller.

| | `timeout` | String | The string must contain a numeric value followed by a suffix (s, m, h, d). | No | 2h | The timeout for the Loadrunner scenario. If Loadrunner doesn’t finish the scenario within the specified amount of time, Akamas will consider the workflow as failed. | | `checkFrequency` | String | The string must contain a numeric value followed by a suffix (s, m, h, d). | No | 1m | The interval at which Akamas check’s the status of the Loadrunner scenario. | | `executable` | String | A valid windows path | No | C:\Program Files (x86)\Micro Focus\LoadRunner\bin\Wlrun.exe | The LoadRunner executable path. | Important notice: remember to escape your path with 4 backslashes (e.g. `C:\\\\Users\\\\\…`) ### Examples #### A simple performance test {% code lineNumbers="true" %} ```yaml name: "task1" operator: "LoadRunner" arguments: controller: hostname: loarrunner.example.com username: Domain\LoadRunnerUser password: j(sBdH5fsG9.I56P%7n2XPjmgO6!ARm= scenarioFile: 'C:\Users\LoadRunnerUser\Desktop\test\scenario\Scenario1.lrs' resultFolder: 'c:\Temp\{study}\{exp}\{trial}' timeout: 15m checkFrequency: 30sL ``` {% endcode %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.akamas.io/akamas-docs/3.2.1-1/akamas-reference/workflow-operators/loadrunner-operator.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.