The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.


step([$class: 'LeapworkJenkinsBridgeBuilder']): Leapwork

  • leapworkHostname : String
    Enter Leapwork Controller hostname or IP
  • leapworkPort : String
    Enter Leapwork controller API port, by default it is 9001.
  • leapworkAccessKey : String
    Enter Leapwork API Access key. If it is invalid or empty, 401 error will be returned.
  • leapworkSchNames : String
    Press button "Select schedules" and you will get all available schedules of your controller which address you've entered before. Use checkboxes to select the schedules you want. Also you can paste list of schedule names, be noticed that they should be separated by new line or comma. WARNING: by clicking a checkbox all schedule names, that DO NOT EXIST OR DISABLED on controller will be removed from the list of schedules in build configuration.
  • leapworkSchIds : String
  • leapworkDelay : String (optional)
    During this time, plugin is going to wait before it tries to get schedule state. If schedule is still running, plugin will wait again.
    By default this value is 5 seconds. It is strongly recommended not to use less value, because if plugin tries to get schedule state and the controller has not created it yet, controller will return 500 error code and your schedule will become Invalid for the plugin.
  • leapworkTimeout : String (optional)
    The 'timeout' property represents the duration within which an operation or request expects to receive a response before considering it unsuccessful or timing out.
    It's measured in seconds, and the default value for this property is set to 300 seconds.
  • leapworkDoneStatusAs : String (optional)
    Choose how plugin should interprete "Done" status: as "Failed" or as "Success".
  • leapworkReport : String (optional)
    Report file name:
    The result of the scheduled tests is saved to an xml file. Per default this file is named "report.xml", but if you are using other build or post build plugins, this file name can already be in use. If so, change the name to something unique. The result file is saved in the following location: "{User path to Jenkins}/Jenkins/workspace/{JOB_NAME}/" To read the generated report files into the build project, add the "Publish Junit test result report" plugin as a "post-build action". In this plugin, use the report file name specified in the Leaptest plugin in 'Test Report XMLs" field (most likely "report.xml"), and please ignore any warnings that the file can't be found - it will be created later.
  • leapworkWritePassedFlowKeyFrames : boolean (optional)
    If selected, keyframes of passed flows will be written to the report file. WARNING: JUnit parser will set all passed flows to "Failed" status, because keyframes are written to "failure" block
  • leapworkEnableHttps : boolean (optional)
    This will enable HTTPs protocol for APIs. Please ensure that HTTPs protocol is enabled in Leapwork as well. Default port is 9002.
  • leapworkScheduleVariables : String (optional)
    Write here schedule variables in "key : value" format. All the variables will be available for all schedules in schedule list to run. Variable key - value pairs must be new line or comma separated. Key and value must be separated with ":" only. WARNING: all key duplicated variables will be ignored.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.