> User Documentation Home

User Handbook
Tutorials
Resources

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.

NeoLoad Plugin

View this plugin on the Plugins site

  • graphOptionsInfo (optional)
      Array / List of Nested Object
    • name
      • Type: String
    • curve
        Array / List of Nested Object
      • path
        • Type: String
    • statistic
      • Type: String
  • maxTrends (optional)
    • Type: int
  • showTrendAverageResponse (optional)
    • Type: boolean
  • showTrendErrorRate (optional)
    • Type: boolean

neoloadRun: Run a NeoLoad scenario

This build step executes a NeoLoad scenario and adds trend result graphs to the job page.
  • scenarioName (optional)
    The name of the Scenario to launch.
    • Type: String
  • autoArchive (optional)
    • Type: boolean
  • customCommandLineOptions (optional)
    Include any additional Command Line options here.
    • Type: String
  • displayGUI (optional)
    • Type: boolean
  • executable (optional)
    This is the absolute path to the NeoLoad executable file.
    For example,/opt/NeoLoad 6.5/bin/NeoLoadCmd, C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe or /Applications/NeoLoad 6.5/bin/NeoLoadCmd.
    • Type: String
  • graphOptionsInfo (optional)
      Array / List of Nested Object
    • name
      • Type: String
    • curve
        Array / List of Nested Object
      • path
        • Type: String
    • statistic
      • Type: String
  • htmlReport (optional)
    This is the path where the HTLM report file is created by NeoLoad.
    For example, ${WORKSPACE}/neoload-report/report.html.
    • Type: String
  • junitReport (optional)
    This is the path where the JUnit results file (based on an SLA in NeoLoad) is created.
    For example, ${WORKSPACE}/neoload-report/junit-sla-results.xml.
    • Type: String
  • licenseDuration (optional)
    This is the number of hours to reserve the license. This must be at least as long as the test will last.
    • Type: String
  • licenseServer (optional)
    Choose which server to use to lease the license. If no servers appear, please configure one in the System Configuration screen of Jenkins.
      Nested Object
    • uniqueID
      • Type: String
    • url
      • Type: String
    • loginUser
      • Type: String
    • loginPassword
      • Type: class hudson.util.Secret
    • label
      • Type: String
    • collabPath
      • Type: String
    • licenseID
      • Type: String
  • licenseType (optional)
    • Type: String
  • licenseVUCount (optional)
    This is the number of Virtual Users (User Paths) to reserve with the license.
    • Type: String
  • licenseVUSAPCount (optional)
    This is the number of SAP Virtual Users (User Paths for SAP) to reserve with the license.
    • Type: String
  • localProjectFile (optional)
    This is the local project file path.
    For example,/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp, C:\neoload_projects\JenkinsExample\JenkinsExample.nlp or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.yaml.
    • Type: String
  • maxTrends (optional)
    Limit the number of points in trend charts. You can use 0 value to have unlimited charts
    • Type: int
  • pdfReport (optional)
    This is the path where the PDF report file is created.
    For example, ${WORKSPACE}/neoload-report/report.pdf.
    • Type: String
  • projectType (optional)
    • Type: String
  • publishTestResults (optional)
    When selected, test results are published after the scenario is run.
    • Type: boolean
  • reportType (optional)
    • Type: String
  • sharedProjectName (optional)
    This is the name of the shared project to checkout and load.
    For example, MyProjectName.
    • Type: String
  • sharedProjectServer (optional)
    Choose which server to use. If no servers appear, please configure one in the System Configuration screen of Jenkins.
      Nested Object
    • uniqueID
      • Type: String
    • url
      • Type: String
    • loginUser
      • Type: String
    • loginPassword
      • Type: class hudson.util.Secret
    • label
      • Type: String
  • showTrendAverageResponse (optional)
    When selected, a trend graph of the average response time for all pages is displayed. Note that the build artifacts must include XML results from NeoLoad for the graph to be displayed.
    • Type: boolean
  • showTrendErrorRate (optional)
    When selected, a trend graph of the error rate of the most recent runs is included on the job page. Note that the build artifacts must include XML results from NeoLoad for the graph to be displayed.
    • Type: boolean
  • testDescription (optional)
    The test description entered here appears in the report file.
    • Type: String
  • testResultName (optional)
    This is the name of the test results. The value $Date{hh:mm - dd MMM yyyy} is replaced by the current date by NeoLoad and the value ${BUILD_NUMBER} is replaced by the current build number by Jenkins.
    For example, $Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER}).
    • Type: String
  • xmlReport (optional)
    This is the path where the XML report file is created.
    For example, ${WORKSPACE}/neoload-report/report.xml.
    • Type: String

step([$class: 'NeoBuildAction']): Execute a NeoLoad Scenario

This build step executes a NeoLoad scenario and adds trend result graphs to the job page.
  • executable
    This is the absolute path to the NeoLoad executable file.
    For example,/opt/NeoLoad 6.5/bin/NeoLoadCmd, C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe or /Applications/NeoLoad 6.5/bin/NeoLoadCmd.
    • Type: String
  • projectType
    • Type: String
  • reportType
    • Type: String
  • localProjectFile
    This is the local project file path.
    For example,/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp, C:\neoload_projects\JenkinsExample\JenkinsExample.nlp or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp or C:\neoload_projects\JenkinsExample\JenkinsExample.yaml.
    • Type: String
  • sharedProjectName
    This is the name of the shared project to checkout and load.
    For example, MyProjectName.
    • Type: String
  • scenarioName
    The name of the Scenario to launch.
    • Type: String
  • htmlReport
    This is the path where the HTLM report file is created by NeoLoad.
    For example, ${WORKSPACE}/neoload-report/report.html.
    • Type: String
  • xmlReport
    This is the path where the XML report file is created.
    For example, ${WORKSPACE}/neoload-report/report.xml.
    • Type: String
  • pdfReport
    This is the path where the PDF report file is created.
    For example, ${WORKSPACE}/neoload-report/report.pdf.
    • Type: String
  • junitReport
    This is the path where the JUnit results file (based on an SLA in NeoLoad) is created.
    For example, ${WORKSPACE}/neoload-report/junit-sla-results.xml.
    • Type: String
  • scanAllBuilds
    • Type: boolean
  • displayTheGUI
    When selected, then the NeoLoad GUI is displayed during the test. Note that the user launching the process must be able to display a user interface (which is not always the case for the Jenkins user). Note also that some errors or warning messages may prevent NeoLoad from closing automatically at the end of a test run. Thus this should only be used for testing purposes.
    • Type: boolean
  • testResultName
    This is the name of the test results. The value $Date{hh:mm - dd MMM yyyy} is replaced by the current date by NeoLoad and the value ${BUILD_NUMBER} is replaced by the current build number by Jenkins.
    For example, $Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER}).
    • Type: String
  • testDescription
    The test description entered here appears in the report file.
    • Type: String
  • licenseType
    • Type: String
  • licenseVUCount
    This is the number of Virtual Users (User Paths) to reserve with the license.
    • Type: String
  • licenseVUSAPCount
    This is the number of SAP Virtual Users (User Paths for SAP) to reserve with the license.
    • Type: String
  • licenseDuration
    This is the number of hours to reserve the license. This must be at least as long as the test will last.
    • Type: String
  • customCommandLineOptions
    Include any additional Command Line options here.
    • Type: String
  • publishTestResults
    When selected, test results are published after the scenario is run.
    • Type: boolean
  • sharedProjectServer
    Choose which server to use. If no servers appear, please configure one in the System Configuration screen of Jenkins.
      Nested Object
    • uniqueID
      • Type: String
    • url
      • Type: String
    • loginUser
      • Type: String
    • loginPassword
      • Type: class hudson.util.Secret
    • label
      • Type: String
  • licenseServer
    Choose which server to use to lease the license. If no servers appear, please configure one in the System Configuration screen of Jenkins.
      Nested Object
    • uniqueID
      • Type: String
    • url
      • Type: String
    • loginUser
      • Type: String
    • loginPassword
      • Type: class hudson.util.Secret
    • label
      • Type: String
    • collabPath
      • Type: String
    • licenseID
      • Type: String
  • showTrendAverageResponse
    When selected, a trend graph of the average response time for all pages is displayed. Note that the build artifacts must include XML results from NeoLoad for the graph to be displayed.
    • Type: boolean
  • showTrendErrorRate
    When selected, a trend graph of the error rate of the most recent runs is included on the job page. Note that the build artifacts must include XML results from NeoLoad for the graph to be displayed.
    • Type: boolean
  • graphOptionsInfo
      Array / List of Nested Object
    • name
      • Type: String
    • curve
        Array / List of Nested Object
      • path
        • Type: String
    • statistic
      • Type: String
  • maxTrends
    Limit the number of points in trend charts. You can use 0 value to have unlimited charts
    • Type: int

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.