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.

Micro Focus Application Automation Tools

loadRunnerTest: Run LoadRunner performance scenario tests

  • testPaths
    • Type: String
  • archiveTestResultsMode
    To view the run results, do one of the following:
    1) In the left pane, click the Report and Summary link to display the report link and the link to the report folder. From this link, you can open the run results directly in your browser or open the artifacts
    2) From the Build Artifacts:
    • Open the run_results.html to view the run results.
    • Download the zipped report to your desired location and unzip it. In the Run Results Viewer, select the Results.xml file found inside the unzipped folder.
    Note that this option is valid only when using the “Execute test from file system” build step.
    • Type: String
  • analysisTemplate (optional)
    Apply a template for the build (path to a .tem file). Leave blank in order to use the default template.
    • Type: String
  • controllerPollingInterval (optional)
    Polling interval for checking the scenario status, in seconds. The default is 30 seconds.
    • Type: String
  • displayController (optional)
    Display the controller while the scenario is running.
    • Type: String
  • fsTimeout (optional)
    Timeout value in seconds. If left empty, there is no timeout.
    • Type: String
  • ignoreErrorStrings (optional)
    Ignore errors during the scenario run containing any of the strings listed below. For example: "Error: CPU usage for this load generator has exceeded 80%"
    • Type: String
  • perScenarioTimeOut (optional)
    The maximum time allotted for scenario execution, in minutes.
    • Type: String
  • scriptRTSSetModel (optional)
      Nested Object
    • scripts
        Array/List
        Nested Object
      • scriptName
        The script name is found in Controller's Script Information dialog (Percentage Mode scenario) or Group Information dialog (Vuser Group Mode scenario).
        • Type: String
      • additionalAttributes
          Array/List
          Nested Object
        • name
          • Type: String
        • value
          • Type: String
        • description
          • Type: String
  • summaryDataLogModel (optional)
      Nested Object
    • logVusersStates
      Display the number of virtual users in each state.
      • Type: boolean
    • logErrorCount
      Display the number of controller errors.
      • Type: boolean
    • logTransactionStatistics
      Display the number of passed transactions, failed transactions and hits per second.
      • Type: boolean
    • pollingInterval
      The rate at which the messages are displayed (in seconds). Default value is 10 seconds.
      • Type: String

runLoadRunnerScript: Run LoadRunner script

  • scriptPath
    • Type: String

sseBuildAndPublish: Execute tests using ALM Lab Management and Publish tests result

  • almServerName
    • Type: String
  • almProject
    • Type: String
  • credentialsId
    • Type: String
  • clientType
    Client type is required for some ALM above 12.60 in authentication.
    • Type: String
  • almDomain
    • Type: String
  • runType
    • Type: String
  • almEntityId
    • Type: String
  • timeslotDuration
    • Type: String
  • archiveTestResultsMode
    To view the run results, do one of the following:
    1) In the left pane, click the Report and Summary link to display the report link and the link to the report folder. From this link, you can open the run results directly in your browser or open the artifacts
    2) From the Build Artifacts:
    • Open the run_results.html to view the run results.
    • Download the zipped report to your desired location and unzip it. In the Run Results Viewer, select the Results.xml file found inside the unzipped folder.
    Note that this option is valid only when using the “Execute test from file system” build step.
    • Type: String
  • cdaDetails (optional)
      Nested Object
    • deploymentAction
      • Type: String
    • deployedEnvironmentName
      • Type: String
    • deprovisioningAction
      • Type: String
  • description (optional)
    • Type: String
  • environmentConfigurationId (optional)
    To find the ID of your environment configuration, right-click the entity, copy the URL, and paste it to a text editor. Use the number associated with the EntityID at the end of the URL.
    • Type: String
  • postRunAction (optional)
    • Type: String

healthAnalyzer: Micro Focus Health Analyzer

  • products
    Choose the products that you would like to test that correspond to the relevant build step.
      Array/List
      Nested Choice of Objects
    • $class: 'HealthAnalyzerLrStep'
      • checkLrInstallation
        • Type: boolean
      • checkOsVersion
        • Type: boolean
      • checkFiles
          Nested Object
        • filesList
            Array/List
            Nested Object
          • field
            • Type: String

pcBuild: Execute performance test using Performance Center

  • serverAndPort
    • Type: String
  • pcServerName
    Hostname or IP address (if port is not default, specify it).
    For example:
    • mypcserverhostname
    • mypcserverhostname.mycompany.com:81
    • 12.10.35.85:444
    Important: Specifying Performance Center URL will not work.
    • Type: String
  • credentialsId
    • Type: String
  • almDomain
    • Type: String
  • almProject
    • Type: String
  • testId
    • Type: String
  • testInstanceId
    Represents an instance of a performance test within an ALM Test Set. In order to find the test instance id go to: PC Web UI > Test Lab perspective > Performance Test Set table and look for the ID column
    • Type: String
  • autoTestInstanceID
    • Type: String
  • timeslotDurationHours
    • Type: String
  • timeslotDurationMinutes
    • Type: String
  • postRunAction
    • Values: COLLATE, COLLATE_AND_ANALYZE, DO_NOTHING
  • vudsMode
    A Virtual User Day (VUD) license provides you with a specified number of Vusers (VUDs) that you can run an unlimited number of times within a 24 hour period. Before using this option, make sure that VUDs licenses are applied in your Micro Focus Performance Center environment.
    • Type: boolean
  • statusBySLA
    Check this option in order to set the build-step status according to a pre-defined SLA (Service Level Agreement) configured within your performance test. Unless checked, the build-step will be labeled as Passed as long as no failures occurred.
    • Type: boolean
  • description
    • Type: String
  • addRunToTrendReport
    • Type: String
  • trendReportId
    • Type: String
  • HTTPSProtocol
    • Type: boolean
  • proxyOutURL
    Add your local proxy as following: http(s)://host:port
    or Leave empty if not using a local proxy. The following proxy configurations are not supported:
    • PAC (proxy auto-config).
    • Automatic configuration script.
    • Type: String
  • credentialsProxyId
    • Type: String
  • retry
    • Type: String
  • retryDelay
    • Type: String
  • retryOccurrences
    • Type: String

runFromAlmBuilder: Execute Micro Focus functional tests from Micro Focus ALM

  • almServerName
    • Type: String
  • almUserName
    • Type: String
  • almPassword
    • Type: String
  • almDomain
    • Type: String
  • almProject
    • Type: String
  • almTestSets
    • Type: String
  • almRunResultsMode
    • Type: String
  • almTimeout
    • Type: String
  • almRunMode
    • Type: String
  • almRunHost
    • Type: String

sseBuild: Execute Micro Focus tests using Micro Focus ALM Lab Management

  • almServerName
    • Type: String
  • almProject
    • Type: String
  • credentialsId
    • Type: String
  • clientType
    Client type is required for some ALM above 12.60 in authentication.
    • Type: String
  • almDomain
    • Type: String
  • runType
    • Type: String
  • almEntityId
    • Type: String
  • timeslotDuration
    • Type: String
  • cdaDetails (optional)
      Nested Object
    • deploymentAction
      • Type: String
    • deployedEnvironmentName
      • Type: String
    • deprovisioningAction
      • Type: String
  • description (optional)
    • Type: String
  • environmentConfigurationId (optional)
    To find the ID of your environment configuration, right-click the entity, copy the URL, and paste it to a text editor. Use the number associated with the EntityID at the end of the URL.
    • Type: String
  • postRunAction (optional)
    • Type: String

uploadResultToALM: Upload test result to ALM

  • almServerName
    The name of the ALM Server.
    • Type: String
  • credentialsId
    • Type: String
  • almDomain
    The Domain of the project to be used.
    • Type: String
  • clientType
    Client type is required for some ALM above 12.60 in authentication.
    • Type: String
  • almProject
    The project to be used.
    • Type: String
  • testingFramework
    The testing framework that is used when generate the testing result file.
    • Type: String
  • testingTool
    The testing tool that is used when generate the testing result file.
    • Type: String
  • almTestFolder
    The path of the test folder that will contain the uploaded test. The path doesn't include the Root test folder (Subject).
    For example, sampletestfolder\subfolder means, the tests will be uploaded to test folder named 'subfolder', which is under the test folder named 'sampletestfolder',
    and 'sampletestfolder' is under the root test folder 'Subject'.
    • Type: String
  • almTestSetFolder
    The path of the testset folder that will contain the uploaded testset. The path doesn't include the Root testset folder.
    For example, sampletestsetfolder\subfolder means, the testsets will be uploaded to testset folder named 'subfolder', which is under the testset folder named 'sampletestsetfolder',
    and 'sampletestsetfolder' is under the root testset folder 'Root'.
    • Type: String
  • almTimeout
    Number of seconds before timeout. If left empty timeout is unlimited.
    • Type: String
  • testingResultFile
    The condition to find the testing result file, start from the root path of the job. For example, **/junitResult.xml to find testing result file for Junit Plugin, **/testng-results.xml to find testing result file for TestNG plugin.
    • Type: String
  • jenkinsServerUrl
    The HTTP URL of the Jenkins Server, form example, http://myjenkinsserver.test.com:8080 .
    • Type: String

svChangeModeStep: SV: Change Mode of Virtual Service

  • serverName
    • Type: String
  • force
    • Type: boolean
  • mode
    • Values: OFFLINE, SIMULATING, STAND_BY, LEARNING
  • dataModel
      Nested Object
    • selectionType
      • Values: BY_NAME, NONE, DEFAULT
    • dataModel
      • Type: String
  • performanceModel
      Nested Object
    • selectionType
      • Values: BY_NAME, NONE, OFFLINE, DEFAULT
    • performanceModel
      • Type: String
  • serviceSelection
      Nested Object
    • selectionType
      • Values: SERVICE, PROJECT, ALL_DEPLOYED, DEPLOY
    • service
      • Type: String
    • projectPath
      • Type: String
    • projectPassword
      • Type: String

svDeployStep: SV: Deploy Virtual Service

  • serverName
    • Type: String
  • force
    • Type: boolean
  • service
    • Type: String
  • projectPath
    • Type: String
  • projectPassword
    • Type: String
  • firstAgentFallback
    • Type: boolean

svExportStep: SV: Export Virtual Service

  • serverName
    • Type: String
  • force
    • Type: boolean
  • targetDirectory
    • Type: String
  • cleanTargetDirectory
    • Type: boolean
  • serviceSelection
      Nested Object
    • selectionType
      • Values: SERVICE, PROJECT, ALL_DEPLOYED, DEPLOY
    • service
      • Type: String
    • projectPath
      • Type: String
    • projectPassword
      • Type: String
  • switchToStandByFirst
    • Type: boolean
  • archive
    • Type: boolean

svUndeployStep: SV: Undeploy Virtual Service

  • serverName
    • Type: String
  • continueIfNotDeployed
    • Type: boolean
  • force
    • Type: boolean
  • serviceSelection
      Nested Object
    • selectionType
      • Values: SERVICE, PROJECT, ALL_DEPLOYED, DEPLOY
    • service
      • Type: String
    • projectPath
      • Type: String
    • projectPassword
      • Type: String

uftScenarioLoad: Run UFT scenario

  • testPaths
    • Type: String
  • archiveTestResultsMode
    To view the run results, do one of the following:
    1) In the left pane, click the Report and Summary link to display the report link and the link to the report folder. From this link, you can open the run results directly in your browser or open the artifacts
    2) From the Build Artifacts:
    • Open the run_results.html to view the run results.
    • Download the zipped report to your desired location and unzip it. In the Run Results Viewer, select the Results.xml file found inside the unzipped folder.
    Note that this option is valid only when using the “Execute test from file system” build step.
    • Type: String
  • fsTimeout (optional)
    • Type: String
  • fsUftRunMode (optional)
    • Type: String

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.