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.

Table of Contents

Build Steps from Json Plugin
- step([$class: 'BuildStepsFromJsonBuilder']): Build Steps from Json

Build Steps from Json Plugin

View this plugin on the Plugins site

`step([$class: 'BuildStepsFromJsonBuilder'])`: Build Steps from Json

buildStep

Nested Choice of Objects

$class: 'A3Builder'
- project_file : String
  Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
  (Note: a³ workspace files (also .apx) are not supported as input.)
- analysis_ids : String
  The following values are allowed:
  
  Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
  
  No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
- pedantic_level : String
- export_a3apxworkspace : String
  Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
- copy_report_file : boolean
- copy_result_file : boolean
- skip_a3_analysis : boolean
  This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
$class: 'ACSDeploymentBuilder'
- context
ACXScanBuilder
- ncScanType : String
- ncWebsiteId : String
- ncProfileId : String
- ncDoNotFail : boolean (optional)
- ncReportType : String (optional)
- acxServerURL : String (optional)
- credentialsId : String (optional)
- ncApiToken : Object (optional)
- ncConfirmed : boolean (optional)
- ncIgnoreFalsePositive : boolean (optional)
- ncIgnoreRiskAccepted : boolean (optional)
- ncSeverity : String (optional)
- ncStopScan : boolean (optional)
cfyAzureArm
- azureCredentialsId : String (optional)
  
  The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
- credentialsId : String (optional)
  
  The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
- debugOutput : boolean (optional)
  If checked, then printed Cloudify events and logs will include debug-level records.
- deploymentId : String (optional)
- echoEnvData : boolean (optional)
  
  If checked, then the created environment's data will be printed to the job's log.
- echoInputs : boolean (optional)
  If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
- envDataLocation : String (optional)
  
  Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
- location : String (optional)
  
  The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location Cloudify secret will be used.
- parameters (optional)
  
  YAML/JSON of parameters to pass to the template.
  - Type: java.util.Map<java.lang.String, java.lang.Object>
- parametersAsString : String (optional)
- parametersFile : String (optional)
  
  Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
- resourceGroupName : String (optional)
  
  Name of resource group to create for the template.
- templateFile : String (optional)
  
  Workspace-relative path of the ARM template file.
- tenant : String (optional)
$class: 'AWSEBBuilder'
- extensions
  - awsRegion
    AWS Region (e.g. us-east-1) This will be the default if no valid environments are provided in the Regions field.
    - Values: GovCloud, US_GOV_EAST_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, EU_NORTH_1, EU_SOUTH_1, EU_SOUTH_2, AP_EAST_1, AP_SOUTH_1, AP_SOUTH_2, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, US_ISO_EAST_1, US_ISOB_EAST_1, US_ISO_WEST_1
  - awsRegionText : String
    AWS Region (e.g. us-east-1) Needs to match an environment name. If one is missing, write an issue so we can update the aws sdk.
  - credentialsString : String
  - credentialsText : String
    Use a credentials name that will be resolved during the build.
  - applicationName : String
    AWS EB Application Name (e.g.: "myapp")
  - versionLabelFormat : String
    How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
  - versionDescriptionFormat : String
    Sets the description of the version to be published. Jenkins environment variables are supported such as ${GIT_BRANCH} - ${BUILD_TAG}
  - failOnError : boolean
    If any of the environments fail to update, or if there are no matching environments then fail the build.
  - extensions
    - $class: 'AWSEBElasticBeanstalkSetup'
    - $class: 'AWSEBS3Setup'
      
      bucketName : String
      S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
      
      bucketRegion : String
      S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
      
      keyPrefix : String
      Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
      
      rootObject : String
      
      Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
      
      It could be either a path to a zip file or a directory.
      
      If its a directory, includes and excludes are used to build the zip file
      
      includes : String
      Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
      
      excludes : String
      Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
      
      overwriteExistingFile : boolean
      
      useTransferAcceleration : boolean
      If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
    - $class: 'ByName'
      
      envNameList : String
      Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
    - $class: 'ByUrl'
      
      urlList : String
      Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
  - envLookup
    - $class: 'AWSEBElasticBeanstalkSetup'
    - $class: 'AWSEBS3Setup'
      
      bucketName : String
      S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
      
      bucketRegion : String
      S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
      
      keyPrefix : String
      Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
      
      rootObject : String
      
      Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
      
      It could be either a path to a zip file or a directory.
      
      If its a directory, includes and excludes are used to build the zip file
      
      includes : String
      Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
      
      excludes : String
      Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
      
      overwriteExistingFile : boolean
      
      useTransferAcceleration : boolean
      If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
    - $class: 'ByName'
      
      envNameList : String
      Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
    - $class: 'ByUrl'
      
      urlList : String
      Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
$class: 'AWSEBDeploymentBuilder'
- config
  - Type: class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfig
- applicationName : String (optional)
  AWS EB Application Name (e.g.: "myapp")
- awsRegion : String (optional)
  AWS Region (e.g. us-east-1)
- bucketName : String (optional)
  
  S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
  
  (Optional, will call createStorageLocation if blank)
- checkHealth : boolean (optional)
  Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
- credentialId : String (optional)
  Select the credentials to use.
- environmentName : String (optional)
  Optional: AWS EB Environment name(s) to deploy to.
  
  Can accept single or multiple comma-separated values. Examples:
  
  "my-prod-env" (single environment)
  
  "my-dev-env,my-staging-env" (multiple environments)
  
  When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
- excludes : String (optional)
  Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
- includes : String (optional)
  Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
- keyPrefix : String (optional)
  Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
- maxAttempts : int (optional)
- rootObject : String (optional)
  Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
  
  Examples:
  
  File, like target/mywebapp.war: The war file will be uploaded
  
  A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
- skipEnvironmentUpdates : boolean (optional)
- sleepTime : int (optional)
- versionDescriptionFormat : String (optional)
  How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
- versionLabelFormat : String (optional)
  How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
- zeroDowntime : boolean (optional)
awsebReleaser
- credentialId : String
  Select the credentials to use.
- awsRegion : String
  AWS Region.
- applicationName : String
  AWS EB Application Name (e.g.: "myapp").
- environmentId : String
  AWS EB Environment name to deploy to.
- versionLabel : String
abapCi
- abapPackagename : String (optional)
- atcVariant : String (optional)
- sapSystemLabel : String (optional)
- runAtcChecks : boolean (optional)
- runUnitTests : boolean (optional)
- treatWarningAtcChecksAsErrors : boolean (optional)
- useJenkinsProjectName : boolean (optional)
- withCoverage : boolean (optional)
snActivatePlugin
- credentialsId : String (optional)
  User name and password defined in global credentials (credentials ID is required here).
  This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
- apiVersion : String (optional)
  Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
- pluginId : String (optional)
  Unique identifier of the plugin. You can locate this identifier on the Plugins page within the card of the desired plugin; identified with the name "ID".
- url : String (optional)
  ServiceNow instance url. This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
addchangestobuildchangelog
- changelogPath : String
- changelogText : String
$class: 'AddComment'
- prefix : String
  Enter the syntax. Example: P1#I10 (P3 - Project ID, I10 - Item ID). You can only add a comment up to 10 items.
- note : String
  Any malicious content will be automatically removed.
- logfile : String
  Upload the build log file as an attachment.
$class: 'AddTestToSetStep'
- domain : String
  HP ALM Domain
- project : String
  HP ALM Project name
- testPlanPath : String
  Path to a test or test folder in HP ALM which shall be added to a test set
- testSetPath : String
  Path to a test set in HP ALM into which test(s) shall be added
allocateDS
- dsn : String
- dsOrg
  - Values: PO, POE, PS, VS
- primary : int
- secondary : int
- recFm
  - Values: F, FB, V, VB, U, VSAM, VA
- alcUnit (optional)
  - Values: TRK, CYL
- avgBlk : int (optional)
- blkSize : int (optional)
- dataClass : String (optional)
- dirBlk : int (optional)
- dsModel : String (optional)
- dsnType (optional)
  - Values: LIBRARY, HFS, PDS, LARGE, BASIC, EXTREQ, EXTPREF
- lrecl : int (optional)
- mgntClass : String (optional)
- storClass : String (optional)
- unit : String (optional)
- volser : String (optional)
$class: 'AmxEclipseAntBuilder'
- targets : String
  Specify a list of Ant targets to be invoked over Tibco amx_eclipse_ant wrapper, or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- name : String
  For projects that need to use TIBCO amx_eclipse_ant wrapper as the build system. This causes Jenkins to invoke amx_eclipse_ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
  Jenkins supplies some environment variables that can be used from within the build script.
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Please refer to TIBCO Documentation for any detail
- buildFile : String
  If your build requires a custom -buildfile, specify it here. By default amx_eclipse_ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory. Please refer to TIBCO Documentation for any detail
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
- amxEclipseAntTra : String
  If your build requires a custom TRA properties file, specify it here. Please refer to TIBCO Documentation for any detail.
- businessStudioWs : String
  If your build requires a custom Business Studio workspace to use, specify it here. By default amx_eclipse_ant use user home as location for "workspace"" creation. this option force amx_eclipse_ant to use a custom workspace by flag "-data 'your-custom-ws'" Please refer to TIBCO Documentation for any detail.
anchore
- name : String
  Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
- annotations (optional)
  - key : String
  - value : String
- autoSubscribeTagUpdates : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
- bailOnFail : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
- bailOnPluginFail : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
- engineCredentialsId : String (optional)
- engineRetries : String (optional)
  Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
- engineurl : String (optional)
  Anchore Engine URL
- engineverify : boolean (optional)
- forceAnalyze : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
- policyBundleId : String (optional)
  ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
$class: 'AnsibleAdHocCommandBuilder'
- hostPattern : String
  The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
- inventory
  - $class: 'InventoryContent'
    content : String
    
    dynamic : boolean
    Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
  - $class: 'InventoryDoNotSpecify'
  - $class: 'InventoryPath'
    path : String
    Specify the inventory host path or a comma separated host list
- module : String
  Module name to execute. The shell module is used when left empty.
- command : String
  Module arguments or shell command to execute
- additionalParameters : String (optional)
  Any additional parameters to pass to the ansible command.
  Warning:
  The content of this textbox will be passed as is to the command line.
- ansibleName : String (optional)
- becomeUser : String (optional)
  Desired become user. "root" is used when this field is empty.
- colorizedOutput : boolean (optional)
  Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- credentialsId : String (optional)
  Select the credentials for the SSH connections. Only private key authentication is supported.
- disableHostKeyChecking : boolean (optional)
  Check this box if you really want to disable the validation of the hosts SSH server keys.
- extraVars (optional)
  - hidden : boolean (optional)
  - key : String (optional)
  - secretValue (optional)
    - Type: class hudson.util.Secret
- forks : int (optional)
  Specify number of parallel processes to use. Set to 0 to use the default value.
- hostKeyChecking : boolean (optional)
- sudo : boolean (optional)
  Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- sudoUser : String (optional)
  Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- unbufferedOutput : boolean (optional)
  Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- vaultCredentialsId : String (optional)
  Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
cfyAnsible
- additionalArgs : String (optional)
- ansibleEnvVars : String (optional)
- credentialsId : String (optional)
  
  The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
- debugLevel : int (optional)
- debugOutput : boolean (optional)
- deploymentId : String (optional)
- echoEnvData : boolean (optional)
- echoInputs : boolean (optional)
  If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
- envDataLocation : String (optional)
- optionsConfig : String (optional)
- playbookPath : String (optional)
- remergeSources : boolean (optional)
- runData : String (optional)
- savePlaybook : boolean (optional)
- scpExtraArgs : String (optional)
- sensitiveKeys : String (optional)
- sftpExtraArgs : String (optional)
- sourcePath : String (optional)
- sources : String (optional)
- sshCommonArgs : String (optional)
- sshExtraArgs : String (optional)
- startAtTask : String (optional)
- tenant : String (optional)
- timeout : int (optional)
$class: 'AnsiblePlaybookBuilder'
- playbook : String
  Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
- inventory
  - $class: 'InventoryContent'
    content : String
    
    dynamic : boolean
    Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
  - $class: 'InventoryDoNotSpecify'
  - $class: 'InventoryPath'
    path : String
    Specify the inventory host path or a comma separated host list
- additionalParameters : String (optional)
  Any additional parameters to pass to the ansible command.
  Warning:
  The content of this textbox will be passed as is to the command line.
- ansibleName : String (optional)
- becomeUser : String (optional)
  Desired become user. "root" is used when this field is empty.
- colorizedOutput : boolean (optional)
  Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- credentialsId : String (optional)
  Select the credentials for the SSH connections. Only private key authentication is supported.
- disableHostKeyChecking : boolean (optional)
  Check this box if you really want to disable the validation of the hosts SSH server keys.
- extraVars (optional)
  - hidden : boolean (optional)
  - key : String (optional)
  - secretValue (optional)
    - Type: class hudson.util.Secret
- forks : int (optional)
  Specify number of parallel processes to use. Set to 0 to use the default value.
- hostKeyChecking : boolean (optional)
- limit : String (optional)
  Further limit selected hosts to an additional pattern.
- skippedTags : String (optional)
  only run plays and tasks whose tags do not match these values.
- startAtTask : String (optional)
  Start the playbook at the task matching this name.
- sudo : boolean (optional)
  Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- sudoUser : String (optional)
  Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- tags : String (optional)
  Only run plays and tasks tagged with these values.
- unbufferedOutput : boolean (optional)
  Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- vaultCredentialsId : String (optional)
  Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
$class: 'AnsibleTower'
- towerServer : String (optional)
- jobTemplate : String (optional)
- towerCredentialsId : String (optional)
- jobType : String (optional)
- extraVars : String (optional)
- jobTags : String (optional)
- skipJobTags : String (optional)
- limit : String (optional)
- inventory : String (optional)
- credential : String (optional)
- scmBranch : String (optional)
- verbose : boolean (optional)
- importTowerLogs : String (optional)
- removeColor : boolean (optional)
- templateType : String (optional)
- importWorkflowChildLogs : boolean (optional)
$class: 'AnsibleTowerProjectRevisionFreestyle'
- towerServer : String (optional)
- towerCredentialsId : String (optional)
- project : String (optional)
- revision : String (optional)
- verbose : boolean (optional)
- throwExceptionWhenFail : boolean (optional)
$class: 'AnsibleTowerProjectSyncFreestyle'
- towerServer : String (optional)
- towerCredentialsId : String (optional)
- project : String (optional)
- verbose : boolean (optional)
- importTowerLogs : boolean (optional)
- removeColor : boolean (optional)
$class: 'AnsibleVaultBuilder'
- action : String (optional)
  Desired vault action.
- ansibleName : String (optional)
- content : String (optional)
  Desired encrypted content.
- input : String (optional)
  Desired input file to encrypt.
- newVaultCredentialsId : String (optional)
  Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
- output : String (optional)
  Desired output file for encrypted content.
- vaultCredentialsId : String (optional)
  Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
ant
For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
Jenkins supplies some environment variables that can be used from within the build script.
- targets : String
  Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- antName : String
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- buildFile : String
  If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'AntExec'
- scriptSource : String
  Runs entered Apache Ant tasks as a build file with only one target, untill you write code into the "Extended script source", but the target created from this code will always be the default target of the created build file.
  
  The script will run with WORKSPACE as the current directory. Build will be considered as failure if any Ant task fails. You can use Ant-Contrib tasks (if it is enabled in global configuration). You need to use namespace "antcontrib" (example: "<antcontrib:if>").
- extendedScriptSource : String
  Into this field you can enter a code, you could not able to enter into the previous field, as it should not appear within the Ant target. The entries can be other targets, import/include tasks etc. With this extension you are able to create more complex Ant build file with just one limitation - the first field (textarea) must always be used for default Ant target. This field is optional.
- scriptName : String
  Here you can enter the name for your new script. The name will be also used for default Ant target. This build file will then have a name that differs from the default name, so it will not be overwritten by the upcoming build step and therefore it might be used repeatedly, or it can be included/imported.
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
- antName : String
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m.
  Note that other Ant options (such as -lib) should not be here.
- keepBuildfile : boolean
- verbose : boolean
- emacs : boolean
- noAntcontrib : boolean
  
  Disabling usage of Ant-Contrib Tasks in this build step.
antws
For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
Jenkins supplies some environment variables that can be used from within the build script.
- targets : String
  Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- antName : String
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- buildFile : String
  If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'ApiFortressBuilder'
- mode : String
  When running in single test mode, once specific test will run. When running in automatch mode, a collection of tests will run.
- hook : String
  The API Hook URL.
  API Hooks are unique urls connected to projects. They provide access to API Fortress automation API and will allow you to run tests.
  You can create one in the API Fortress Company dashboard.
- id : String
  Test ID
  When running in Single Test mode, you have to provide the ID of the test you want to run. You can find this information in the interstitial page of the test.
  Automatch URL
  When running in Automatch mode, introduce here the URL of the resource that you are willing to test.
  Tag
  When running in tag mode, introduce the tag of the tests you want to run.
  Project
  When running in project mode, no value is required.
- blocking : boolean
  Set this flag is a test failure must determine a build failure.
- dryrun : boolean
  Set this flag if you don't want the event to be stored in API Fortress.
- silent : boolean
  Set this flag if a failure should not generate API Fortress alerts.
- param1name : String
- param1value : String
- param2name : String
- param2value : String
- param3name : String
- param3value : String
appray
- appRayUrl : String
  App-Ray instance URL. Default: https://demo.app-ray.co
- outputFilePath : String
  Name of the binary file (apk, ipa) to be scanned relative to the workspace. You can use Jenkins variables to specify the filename.
- waitTimeout : int
  Timeout of waiting for ending of a scan. (For big application sometimes it take more than 30 minute!)
- riskScoreThreshold : int
  The minimum risk score to check the apk validity. It is the output of then scan. You can check the scores on the app-ray instance.
- credentialsId : String
  Use email address as a username and please provide a password. The user must have full-access access right in App-Ray in order to be able to submit applications for scanning.
appscan
- scanner
  - dynamic_analyzer
    target : String
    
    hasOptions : boolean
    
    extraField : String (optional)
    
    loginPassword : String (optional)
    
    loginType : String (optional)
    
    loginUser : String (optional)
    
    optimization : String (optional)
    
    presenceId : String (optional)
    
    scanFile : String (optional)
    
    scanType : String (optional)
    
    trafficFile : String (optional)
  - static_analyzer
    target : String
    
    hasOptions : boolean
    
    openSourceOnly : boolean (optional)
- name : String
- type : String
- application : String
- credentials : String
- email : boolean (optional)
- failBuild : boolean (optional)
- failBuildNonCompliance : boolean (optional)
- failureConditions (optional)
  - failureType : String
  - threshold : int
- intervention : boolean (optional)
- target : String (optional)
- wait : boolean (optional)
appscanenterprise
- credentials : String
- folder : String
- testPolicy : String
- template : String
- jobName : String
- accessId : String (optional)
- agent : String (optional)
- application : String (optional)
- email : boolean (optional)
- exploreData : String (optional)
- failBuild : boolean (optional)
- failureConditions (optional)
  - failureType : String
  - threshold : int
- loginType : String (optional)
- scanType : String (optional)
- secretKey : String (optional)
- target : String (optional)
- testOptimization : String (optional)
- trafficFile : String (optional)
- wait : boolean (optional)
$class: 'AppScanSourceBuilder'
- disableScan : boolean
- applicationFile : String
- acceptSSL : boolean
- customScanWorkspace : String
  This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
  
  If this field is blank, the default scan directory will be used.
  
  The default directory is this job's build folder, as defined by Jenkins.
- installation : String (optional)
$class: 'AppScanStandardBuilder'
- startingURL : String
  Insert the URL that you want AppScan Standard to start scanning from.
  Spiders will find the remaining URLs in the domain to be included for scanning.
- installation : String
- additionalCommands : String (optional)
  Provide additional and optional commands to run on AppScan Standard CLI.
  AppScanCMD exec|ex|e Parameters: [ /dest_scan|/dest|/d ] [ /base_scan|/base|/b ] [ /old_host|/ohost|/oh ] [ /new_host|/nhost|/nh ] [ /scan_template|/stemplate|/st ] [ /login_file|/lfile|/lf ] [ /multi_step_file|/mstepfile|/mf ] [ /manual_explore_file|/mexplorefile|/mef ] [ /policy_file|/pfile|/pf ] [ /additional_domains|/adomains|/ad ] [ /report_file|/rf ] [ /report_type|/rt {xml} ] [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] [ /scan_log|/sl {false} ] [ /explore_only|/eo {false} ] [ /test_only|/to {false} ] [ /multi_step|/mstep|/ms {false} ] [ /continue|/c {false} ] [ /merge_manual_explore_requests|/mmer {false} ] [ /include_responses|/ir {false} ] [ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ] Creates new scan with base_scan's configuration saving dest_scan and creating report, if configured. AppScanCMD report|rep|r Parametrs: /base_scan|/base|/b /report_file|/rf /report_type|/rt [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] Creates a report for base_scan. AppScanCMD close_proxy|cprxy|cpr Closes AppScan proxy if was previously opened. More info. at: (9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- authScan : boolean (optional)
  Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.
  If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
- authScanPw : String (optional)
  Provide the password corresponding to the account's user name inserted above.
  Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- authScanRadio : boolean (optional)
  Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.
  A login sequence may be recorded using AppScan Standard's GUI by following these steps:
  
  "Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
  
  Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
- authScanUser : String (optional)
  Provide the user name of an account with access to the private functionalities of the website.
  Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- generateReport : boolean (optional)
  Check this option if you want AppScan Standard to generate a report after scannning.
  The report is available in HTML and PDF.
  
  The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
- htmlReport : boolean (optional)
  This report can be integrated with the HTML Publisher Plugin.
- includeURLS : String (optional)
  This is used to include URLs for scanning,
  Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
- pathRecordedLoginSequence : String (optional)
  Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- pdfReport : boolean (optional)
  A PDF report is generated.
- policyFile : String (optional)
  Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.
  A Test Policy File can be created following these steps:
  
  "Scan" > "Scan Configuration" > "Test Policy" > "Export".
- reportName : String (optional)
  Provide the name to save the report with.
  To configure HTML Publisher Plugin properly, the names in the configuration must match.
- verbose : boolean (optional)
  Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
xooa
- name : String
  Xooa Jenkins
- appId : String
$class: 'AppUploaderBuilder'
- buildFilePath : String
  Please specify the absolute path or relative to the app(.apk or .ipa) file to be uploaded.
  The app_url of the uploaded app can be accessed from the environment variable BROWSERSTACK_APP_ID.
AppdomeBuilder
- token
  - Type: class hudson.util.Secret
- teamId : String
- platform
  - AndroidPlatform
    certificateMethod
    Nested Choice of Objects
    Android_AutoDevSign
    
    fingerprint : String
    
    googleSigning : boolean (optional)
    
    Android_AutoSign
    
    keystorePath : String
    
    keystorePassword
    Type: class hudson.util.Secret
    
    keystoreAlias
    Type: class hudson.util.Secret
    
    keyPass
    Type: class hudson.util.Secret
    
    googleSignFingerPrint (optional)
    Nested Object
    googleSignFingerPrint : String (optional)
    
    googleSign (optional)
    Nested Object
    googleSignFingerPrint : String (optional)
    
    Android_PrivateSign
    
    fingerprint : String
    
    googleSigning : boolean (optional)
    
    appPath : String (optional)
    
    fusionSetId : String (optional)
  - IosPlatform
    certificateMethod
    Nested Choice of Objects
    iOS_AutoDevSign
    
    provisioningProfiles
    Array / List of Nested Object
    item : String
    
    entitlements
    Array / List of Nested Object
    item : String
    
    iOS_AutoSign
    
    keystorePath : String
    
    keystorePassword
    Type: class hudson.util.Secret
    
    entitlements
    Array / List of Nested Object
    item : String
    
    provisioningProfiles (optional)
    Array / List of Nested Object
    item : String
    
    iOS_PrivateSign
    
    provisioningProfiles
    Array / List of Nested Object
    item : String
    
    appPath : String (optional)
    
    fusionSetId : String (optional)
- outputLocation : String (optional)
applatix
- axUrl : String
  The URL of Applatix system. For example: https://applatix.yourcompany.com
- axUsername : String
  Applatix credential: username
- axPassword : String
  Applatix credential: password
- axServiceTemplateName : String
- axServiceTemplateRepository : String
  The repository where your Service Template is.
- axServiceTemplateBranch : String
  The branch where your Service Template is.
- axServiceTemplateParameters
  The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
  - key : String
  - value : String
snApplyChanges
- credentialsId : String (optional)
  User name and password defined in global credentials (credentials ID is required here) used for the instance (usually where the application will be published).
- apiVersion : String (optional)
  Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
- appScope : String (optional)
  Required if application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
- appSysId : String (optional)
  Required if application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
- branchName : String (optional)
  Name of the branch in the source control system from which to acquire the application.
- url : String (optional)
  ServiceNow instance url (usually where the application will be published to).
$class: 'ApprendaBuilder'
- appAlias : String
  The Applicaton Alias to be used.
- appName : String
  The Applicaton Name to be used.
- versionAlias : String
  The application Version Alias to target.
- stage : String
  The desired Apprenda Application lifecycle Stage.
- artifactName : String
  The filename of the Apprenda Application Package. For example myapplication.zip.
- credentialsId : String
- prefix : String
  The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
- advVersionAliasToBeForced : String
  The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
- advancedNewVersionOption : String
- customPackageDirectory : String
  The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
- applicationPackageURL : String
  The complete URL to the Apprenda Application Package, starting with http:// or https://.
- archiveUploadMethod : String
- buildWithParameters : boolean
  Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
aqua
- locationType : String
- registry : String
  Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
- register : boolean
- localImage : String
  Path of local Docker image, including tag. E.g. my_ubuntu:latest
- hostedImage : String
  Path of Docker image on registry, including tag. E.g. google/mysql:latest
- onDisallowed : String
- notCompliesCmd : String
  A shell command to execute when image does not comply with Aqua security policy
- hideBase : boolean
- showNegligible : boolean
- policies : String
  Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
- customFlags : String
- localToken : String (optional)
  Scanner Token for Aqua API. * This token will override the Global Token/Username-Password. * Scanner token entered here is applied at job level. User can use a different token for different builds.
- tarFilePath : String (optional)
- containerRuntime : String (optional)
- scannerPath : String (optional)
aquaMicroscanner
- imageName : String
- onDisallowed : String
- notCompliesCmd : String
  A shell command to execute when image does not comply with Aqua security policy
- outputFormat : String
aquaServerlessScanner
- onDisallowed : String
- notCompliesCmd : String
- codeScanPath : String
- customFlags : String
arachniScanner
- url : String
  URL of the system under scan.
- checks : String
  Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
- scope
  - pageLimit : int
    Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
  - excludePathPattern : String
    Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
- userConfig
  - filename : String
    Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
- format : String
$class: 'ArtifactDeployerBuilder'
- includes : String
  
  Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
  Artifacts are deployed from the workspace. You can change this basedir by specifying the basedir field under Advanced.
- basedir : String
  
  By default, the basedir is the job workspace.
  Give a value to override the default value.
  
  Path relative to workspace is permitted.
- excludes : String
  
  Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.
- remote : String
  
  Artifacts will be deployed in the specified output directory.
  The remote location must be accessible through the build machine (controller and agent node).
  If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins controller.
  Make sure the Jenkins process have the right permissions to write to the remote location.
  For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine.
- flatten : boolean
  
  Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
- deleteRemote : boolean
  
  Delete the output directory before deploying artifacts.
- deleteRemoteArtifacts : boolean
- failNoFilesDeploy : boolean
$class: 'ArtifactPromotionBuilder'
Here you can configure the artifact promotion plugin for single artifacts. In the first section (Artifact Information) you enter the coordinates of your artifact.
In the Staging Repository Information section you tell there your source repository is, e.g. http://192.168.56.24/nexus/content/repositories/staging/.
In the following section Release Repository Information, you enter the information about the target repository, e.g. http://192.168.56.24/nexus/content/repositories/releases/. In both sections, you can add user credentials. If you do, the connection to the repository servers will be done using these credentials. If you don't suppot credentials, the access will be done without any authentication.
Both repositorys should be release repositories, not snapshot repos! The password(s) will be saved currently using the standard Jenkins functionality to save those. It's planned to use in the future the credentials plugin.
- groupId : String
- artifactId : String
- classifier : String
- version : String
- extension : String
- stagingRepository : String
- stagingUser : String
- stagingPW : String
- releaseUser : String
- releasePW : String
- releaseRepository : String
- promoterClass : String
- debug : boolean
- skipDeletion : boolean
  
  'Skip deletion' option preserves the files in the staging repository.
  
  Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
reportArtifactRelease
- applicationName : String (optional)
- applicationVersion : String (optional)
- applicationComponent : String (optional)
- artifactName : String (optional)
- artifactURL : String (optional)
- repositoryName : String (optional)
- tags : String (optional)
artifactResolver
Resolves artifacts against one or more remote maven repositories.
- artifacts
  - groupId : String
  - artifactId : String
  - version : String
  - classifier : String (optional)
  - deployToLocal : boolean (optional)
  - deployToRemote : boolean (optional)
  - extension : String (optional)
  - failOnError : boolean (optional)
  - pomFile : String (optional)
  - targetFileName : String (optional)
- enableRepositoryLogging : boolean (optional)
- enableTransferLogging : boolean (optional)
- repositoryId : String (optional)
- targetDirectory : String (optional)
artifactVersion
- name : String (optional)
- description : String (optional)
- type : String (optional)
- groupId : String (optional)
- artifactId : String (optional)
- stage : String (optional)
- flow : String (optional)
- stageDescription : String (optional)
- version : String (optional)
artifactVersion
- variableName : String
- name : String (optional)
- stage : String (optional)
- version : String (optional)
assertthatBddFeatures
- projectId : String
  Jira project id.
- credentialsId : String
- outputFolder : String
  
  Output folder for feature files withing workspace. Default ./features/.
  By default features are downloaded to the root of the workspace.
- jql : String
- tags : String
- mode : String
- proxyURI : String
- proxyUsername : String
- proxyPassword : String
- jiraServerUrl : String
  Jira Server URL. Populate only if using Jira Server version (e.g. https://mycompanyjira.com). Leave blank for cloud.
- numbered : boolean
- ignoreCertErrors : boolean
$class: 'AssociateItemToRelease'
- releasePrefix : String
  Enter the release details. Example: P2#R10
- itemPrefix : String
  Enter the prefix of your item here. Example: P1#I10 (P1 - Project number, I10 - Item number), P#I11, P#I12, P2#I13
associateTag
- nexusInstanceId : String
- tagName : String
  The tag which will be applied to components matching the specified search criteria
- search
  The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
  - key : String
  - value : String
$class: 'AstreeBuilder'
- dax_file : String
  Absolute path to the DAX file containing the analysis specification and configuration.
  Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
  Paths and environment variables are evaluated on the machine running Jenkins.
- analysis_id : String
  ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
  Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- output_dir : String
  Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
  Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- skip_analysis : boolean
  This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
- genXMLOverview : boolean
- genXMLCoverage : boolean
- genXMLAlarmsByOccurence : boolean
- genXMLAlarmsByCategory : boolean
- genXMLAlarmsByFile : boolean
- genXMLRulechecks : boolean
- dropAnalysis : boolean
  When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
  This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
  Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
  This option corresponds to adding a --drop to a command line call to Astrée.
- genPreprocessOutput : boolean
- failonswitch
  This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
  
  Only Errors
  ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
  This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
  
  Errors and Alarms
  ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
  This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
  
  Errors, Alarms, and Data-Flow Anomalies
  ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
  This setting fails builds on any reported potential code defect or anomaly.
  - failon : String
audit
- credentialsId : String (optional)
- minScore : int (optional)
- platformUrl : String (optional)
- apiTags : String (optional)
- branchName : String (optional)
- defaultCollectionName : String (optional)
- ignoreFailures : boolean (optional)
- ignoreNetworkErrors : boolean (optional)
- jsonReport : String (optional)
- logLevel : String (optional)
- prId : String (optional)
- prTargetBranch : String (optional)
- repositoryName : String (optional)
- rootDirectory : String (optional)
- shareEveryone : String (optional)
- skipLocalChecks : boolean (optional)
- tagName : String (optional)
$class: 'AutEnvironmentBuilder'
- autEnvironmentModel
  - almServerName : String
  - almUserName : String
  - almPassword : String
  - almDomain : String
  - almProject : String
  - clientType : String
    Client type should be provided if your server is ALM version 12.60 or above.
  - autEnvironmentId : String
    Assign ID of an AUT Environment that exists in the ALM project you selected.
  - useExistingAutEnvConf : boolean
  - existingAutEnvConfId : String
  - createNewAutEnvConf : boolean
  - newAutEnvConfName : String
  - autEnvironmentParameters
    - name : String
      The name must be set in the same hierarchical structure as it defined in ALM ( 'Parameters' tab of the AUT Environment)
      For example: 'Parameters/DB_Setting/Oracle/username'
    - value : String
      If you are using a 'From JSON' type, specify here the path for the element you would like to get.
      Make sure you are using JsonPath style for defining it.
    - paramType : String
      Manual - the value you'll assign for 'Parameter value' field will be used as is.
      Environmnet - the value you'll assign for 'Parameter value' will be looked for in the environment parameters and the resolved value will be used. If you named your parameter 'my_parameter' put here 'my_parameter' (exactly the same value).
      From JSON - the value you'll assign for 'Parameter value' will be looked for in the JSON file you specified for the 'Path to JSON file' entry.
    - shouldGetOnlyFirstValueFromJson : boolean
  - pathToJsonFile : String
    A path to the JSON file that will be loaded in order to assign values to all the AUT Environment Parameters of 'From JSON' type.
  - outputParameter : String
    The name of the build environment parameter that will get the ID of the updated/created AUT Environment Configuration. It then can be used as a parameter for following build steps.
    The parameter must be a String Parameter.
    If you named your parameter 'output_parameter' put here 'output_parameter' (exactly the same value).
autifyMobile
- credentialsId : String
  Select the credentials of "Secret Text" storing the Personal Access Token of Autify for Mobile.
  
  See Autify's document to understand how to generate the Personal Access Token.
- autifyUrl : String
  The URL of your test plan you want to run on Autify for Mobile e.g. https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
- autifyPath : String (optional)
- buildId : String (optional)
- buildPath : String (optional)
  If it's a relative path, it will be relative from the workspace directory.
- shellInstallerUrl : String (optional)
- timeout : String (optional)
  Only meaningful if you check "Wait".
  Timeout seconds when waiting the test finishes. If exceeds, the step will fail.
- wait : boolean (optional)
  If checked, the step will wait until the Autify's test plan finishes.
autifyMobileUpload
- credentialsId : String
  Select the credentials of "Secret Text" storing the Personal Access Token of Autify for Mobile.
  
  See Autify's document to understand how to generate the Personal Access Token.
- workspaceId : String
- buildPath : String
  If it's a relative path, it will be relative from the workspace directory.
- autifyPath : String (optional)
- shellInstallerUrl : String (optional)
autifyWeb
- credentialsId : String
  Select the credentials of "Secret Text" storing the Personal Access Token of Autify for Web.
  
  See Autify's document to understand how to generate the Personal Access Token.
- autifyUrl : String
  The URL of your test plan or test scenario you want to run on Autify for Web e.g. https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
- autifyConnect : String (optional)
- autifyConnectClient : boolean (optional)
  If checked, the step will start Autify Connect Client locally with an ephemeral Autify Connect Access Point. "Wait" option must be also checked.
- autifyConnectClientExtraArguments : String (optional)
- autifyPath : String (optional)
- browser : String (optional)
- device : String (optional)
- deviceType : String (optional)
- os : String (optional)
- osVersion : String (optional)
- shellInstallerUrl : String (optional)
- testExecutionName : String (optional)
- timeout : String (optional)
  Only meaningful if you check "Wait".
  Timeout seconds when waiting the test finishes. If exceeds, the step will fail.
- urlReplacements (optional)
  List of a pair of URLs to replace the URL when Autify test accesses. This is useful when you want to run the same Autify test in a different stage e.g. running a test recorded in production against staging.
  - patternUrl : String
  - replacementUrl : String
- wait : boolean (optional)
  If checked, the step will wait until the Autify's test plan or scenario finishes.
$class: 'Autogen'
- element : String
  
  Specify the name of the element in your Endevor® sandbox that you want to include in the autogeneration process, for example, RUNCOB01. The maximum length is 8 characters.
  
  You can specify several specific comma-separated elements within the sandbox, for example, RUNCOB01, RUNCOB02.
  
  You can use wildcards % and * to define the name patterns for the element names.
  Examples:
  Specify * to include all elements from the sandbox in the autonegeration process.
  Specify RUNCOB* to include all element names that start with "RUNCOB".
  Specify %%%COB* to include elements that contain the substring COB starting after position three.
- environment : String
  
  Provide the environment for the Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
- system : String
  
  Provide the system name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
- subsystem : String
  
  Provide the subsystem name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
- stage : String
  
  Specify the environment stage in your Endevor® that you want to include in the autogeneration process, for example, 1.
- instance : String
  
  Specify the instance name of the environment that is associated with Endevor® Web services, for example, WEBSMFNE.
- signout : boolean
  
  Select this option to work with elements in Endevor® that might be currently worked on by another user.
  
  Select the Override signout option only if you have the permission to override the signout of another user.
$class: 'AwsBatchBuilder'
- jobname : String
- jobdefinition : String
- command : String
- jobqueue : String
- vcpu : String
- memory : String
- retries : String
azureCLI
- principalCredentialId : String
  The Service Principal credentials required to connect to your Azure account.
  More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
  If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
  If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
- commands
  - script : String
  - exportVariablesString : String
    Export the output of the command to environment variables
    The format: /"variable from JSON" | "desired environment variable name"
    For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
azureDownload
- storageCredentialId : String
- downloadType : String
- buildSelector (optional)
  - downstream
    upstreamProjectName : String
    
    Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
    
    Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
    
    Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
    
    AbstractProject based projects:
    
    Freestyle projects
    
    Multi-configuration projects
    
    Maven projects
    
    Non AbstractProject based projects:
    
    Pipeline jobs (aka. Workflow jobs)
    
    upstreamBuildNumber : String
    The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
  - lastWithArtifacts
  - lastCompleted
  - $class: 'MultiJobBuildSelector'
  - buildParameter
    parameterName : String
    Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.
    You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
  - permalink
    id : String
  - $class: 'PromotedBuildSelector'
    level : int
  - latestSavedBuild
  - specific
    buildNumber : String
    While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
  - lastSuccessful
    stable : boolean (optional)
  - upstream
    allowUpstreamDependencies : boolean (optional)
    
    fallbackToLastSuccessful : boolean (optional)
    
    upstreamFilterStrategy (optional)
    Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
    
    Values: UseGlobalSetting, UseOldest, UseNewest
  - workspace
- containerName : String (optional)
  Enter a storage container name.
  Environment variables can also be referenced.
  For example: ${JOB_NAME}
- deleteFromAzureAfterDownload : boolean (optional)
  If checked, the file copy on Azure will be removed after it's downloaded to local.
- downloadDirLoc : String (optional)
  Enter a download path. If not specified, the files will be downloaded into the job's workspace.
  Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
- excludeFilesPattern : String (optional)
  Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
  For example: ${JOB_NAME}
- fileShare : String (optional)
  Enter a Azure File Storage Share name.
  Environment variables can also be referenced.
  For example: ${JOB_NAME}
- flattenDirectories : boolean (optional)
  If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
- includeArchiveZips : boolean (optional)
  The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
- includeFilesPattern : String (optional)
  Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
  For example: ${JOB_NAME}
- projectName : String (optional)
  The name of the project to download the managed artifact from.
- verbose : boolean (optional)
  Enabling this will provide more logging on downloading files.
$class: 'BDSBuilder'
- projectFile : String
- switches : String
- installationName : String

$class: 'BapFtpBuilder'

Send files over FTP as a build step during the build.

publishers

Array / List of Nested Object

configName : String

Select an FTP configuration from the list configured in the global configuration of this Jenkins.

The configuration defines the connection properties and base directory of the FTP server.
verbose : boolean
Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.

transfers

Array / List of Nested Object

sourceFiles : String

Files to upload to a server.

The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String

Exclude files from the Transfer set.

The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String

Optional destination folder.

This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String

First part of the file path that should not be created on the remote server.

Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.

If you use remove prefix, then ALL source file paths MUST start with the prefix.
asciiMode : boolean

Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.

Use with ASCII text files to fix the line terminators when transferring between different operating systems.

remoteDirectorySDF : boolean

Select this to include the timestamp in the remote directory.

The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.

Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

Remote directory	Directories created
`'qa-approved/'yyyyMMddHHmmss`	`qa-approved/20101107154555`
`'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}'`	`builds/2010/11/07/build-456` (if the build was number 456)
`yyyy_MM/'build'-EEE-d-HHmmss`	`2010_11/build-Sun-7-154555`
`yyyy-MM-dd_HH-mm-ss`	`2010-11-07_15-45-55`

flatten : boolean

Only create files on the server, don't create directories (except for the remote directory, if present).

All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean

Select to delete all files and directories within the remote directory before transferring files.
noDefaultExcludes : boolean
makeEmptyDirs : boolean

The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.

The Source files and Exclude files both accept multiple patterns that by default are split using
```
[, ]+
```
which is how Ant, by default, handles multiple patterns in a single string.

The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.

useWorkspaceInPromotion : boolean

Set the root directory for the Source files to the workspace.

By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
usePromotionTimestamp : boolean

Use the build time of the promotion when the remote directory is a date format.

By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
ftpRetry

If publishing to this server fails, try again.

Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
- retries : int
  The number of times to retry this server in the event of failure.
- retryDelay : long
  The time to wait, in milliseconds, before attempting another transfer.
ftpLabel

Set the label for this Server instance - for use with Parameterized publishing.

Expand the help for Parameterized publishing for more details.
- label : String
  
  Set the label for this Server instance - for use with Parameterized publishing.
  
  Expand the help for Parameterized publishing for more details.
ftpCredentials
Set the username and password to use with this connection.
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
- username : String
- password : String

continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
- parameterName : String
  The name of the parameter or environment variable that will contain the expression for matching the labels.

$class: 'BapSshBuilderPlugin'

Send files or execute commands over SSH as a build step during the build.

publishers

Array / List of Nested Object

configName : String

Select an SSH configuration from the list configured in the global configuration of this Jenkins.

The configuration defines the connection properties and base directory of the SSH server.
verbose : boolean
Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems.

transfers

Array / List of Nested Object

sourceFiles : String

Files to upload to a server.

The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String

Exclude files from the Transfer set.

The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String

Optional destination folder.

This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String

First part of the file path that should not be created on the remote server.

Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.

If you use remove prefix, then ALL source file paths MUST start with the prefix.

remoteDirectorySDF : boolean

Select this to include the timestamp in the remote directory.

Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

Remote directory	Directories created
`'qa-approved/'yyyyMMddHHmmss`	`qa-approved/20101107154555`
`'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}'`	`builds/2010/11/07/build-456` (if the build was number 456)
`yyyy_MM/'build'-EEE-d-HHmmss`	`2010_11/build-Sun-7-154555`
`yyyy-MM-dd_HH-mm-ss`	`2010-11-07_15-45-55`

flatten : boolean

Only create files on the server, don't create directories (except for the remote directory, if present).

All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean
noDefaultExcludes : boolean
makeEmptyDirs : boolean

The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.

The Source files and Exclude files both accept multiple patterns that by default are split using
```
[, ]+
```
which is how Ant, by default, handles multiple patterns in a single string.

The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
execCommand : String (optional)

A command to execute on the remote server.

This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
execTimeout : int (optional)

Timeout in milliseconds for the Exec command.

Set to zero to disable.

usePty : boolean (optional)

Exec the command in a pseudo tty.

This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:

requiretty      If set, sudo will only run when the user is logged in
                to a real tty.  When this flag is set, sudo can only be
                run from a login session and not via other means such
                as cron(8) or cgi-bin scripts.  This flag is off by
                default.

useAgentForwarding : boolean (optional)

Exec the command using Agent Forwarding.

Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.

From the ssh(1) man page:

        Enables forwarding of the authentication agent connection.  This can also be specified on a per-host basis in a configuration file.

        Agent forwarding should be enabled with caution.  Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
        An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.

useSftpForExec : boolean (optional)

Using SFTP protocol instead of SSH for Exec command.

Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls

useWorkspaceInPromotion : boolean

Set the root directory for the Source files to the workspace.

By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory.
usePromotionTimestamp : boolean

Use the build time of the promotion when the remote directory is a date format.

By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
sshRetry

If publishing to this server or command execution fails, try again.

Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
- retries : int
  The number of times to retry this server in the event of failure.
- retryDelay : long
  The time to wait, in milliseconds, before attempting another transfer.
sshLabel

Set the label for this Server instance - for use with Parameterized publishing.

Expand the help for Parameterized publishing for more details.
- label : String
  
  Set the label for this Server instance - for use with Parameterized publishing.
  
  Expand the help for Parameterized publishing for more details.
sshCredentials
Set the credentials to use with this connection.
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
- username : String
  The username to connect with.
- encryptedPassphrase : String
  The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
  Leave blank if the key is not encrypted.
- key : String
  
  The private key.
  
  Paste the private key here, or provide the path to the file containing the key in Path to key.
- keyPath : String
  
  The path to the private key.
  
  Either supply the path to the file containing the key, or paste the key into the Key box.
  The Path to key can be absolute, or relative to $JENKINS_HOME

continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
- parameterName : String
  The name of the parameter or environment variable that will contain the expression for matching the labels.

batchFile

command : String

configuredLocalRules (optional)

Array / List of Nested Choice of Objects

retainOnlyVariables

Limit which environment variables are passed to a build step.

Environment variables passed to the build step are filtered, unless listed below.

The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:

If the environment variable originates from Jenkins configuration, such as JOB_URL , it will not be passed to the build step unless specified here.
If the environment variable originates from outside Jenkins, such as PATH , the behavior depends on the option Process environment variables handling : If that option is set to Retain , the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove , the variable will not be passed to the build step.

The following table shows the effect of filtering on an environment variable:

Behavior	Originally defined outside Jenkins	Originally defined inside Jenkins
Process environment variables handling: reset	Variable is reset to original value	Variable is removed
Process environment variables handling: removed	Variable is removed	Variable is removed

processVariablesHandling (optional)
- Values: RESET, REMOVE
retainCharacteristicEnvVars : boolean (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
variables : String (optional)

Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.

unstableReturn : int (optional)
If set, the batch errorlevel result that will be interpreted as an unstable build result. If the final errorlevel matches the value, the build results will be set to unstable and next steps will be continued. Supported values match the widest errorlevel range for Windows like systems. In Windows NT4 and beyond the ERRORLEVEL is stored as a four byte, signed integer, yielding maximum and minimum values of 2147483647 and -2147483648, respectively. Older versions of Windows use 2 bytes. DOS like systems use single byte, yielding errorlevels between 0-255. The value 0 is ignored and does not make the build unstable to keep the default behaviour consistent.

snBatchInstall

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be installed.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
batchName : String (optional)
Required. User specified descriptive name for this batch request.
file : String (optional)
Name of the batch file with json manifest. If only a name is given or relative path then the file will be searched in WORKSPACE directory of the build.
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json.
notes : String (optional)
User specified additional notes about the batch install plan.
Default: null

packages : String (optional)

Required. JSON array, where each object specifies details of a package to install.

        
    [{
        "id": "String",
        "load_demo_data": Boolean,
        "notes": "String",
        "requested_customized_version": "String",
        "requested_version": "String",
        "type": "String"
    }]

id	Required. Sys_id of the application or identifier of the plugin to install.
load_demo_data	Flag that indicates whether demo data is loaded when installing the package. Valid values: `true`: Demo data should be loaded. `false`: Demo data should not be loaded. Default: `false`
notes	User specified notes about the package. Default: `null`
requested_customized_version	Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3.
requested_customized_version	Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application.
requested_version	Required if `type` is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3.
type	Required. Type of package. Valid values: `application` `plugin`

url : String (optional)
ServiceNow instance url where the application will be installed.
useFile : boolean (optional)
Specifies if manifest json file will be used to define the batch. The file can be stored in git repository (in this case SCM should be configured).
Default: false

snBatchRollback
- credentialsId : String (optional)
  User name and password defined in global credentials (credentials ID is required here).
  If ServiceNow Parameters are used, then credentials for installation instance will be used.
- apiVersion : String (optional)
  Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
- rollbackId : String (optional)
  Unique identifier (sys_id) of the rollback installed before.
- url : String (optional)
  ServiceNow instance url where the batch of packages was installed.
  If ServiceNow Parameters are used, then the URL of installation instance will be used.
greet
- apiKey
  - Type: class hudson.util.Secret
- appType : String
- appPath : String
- packageName : String
- scanTimeout : String
- severityThreshold : String
$class: 'BeaglePlugin'
- apptoken
  
  Generate your Application Token From Beagle
  
  Home -> Applications -> Select your Application -> Settings -> Application Token
  - Type: class hudson.util.Secret
- accesstoken
  
  Generate your Access Token From Beagle User Settings
  
  Settings -> Access Token -> Generate Your New Personal Access Token
  - Type: class hudson.util.Secret
$class: 'BeakerBuilder'
- jobSource
  - $class: 'FileJobSource'
    jobPath : String
  - $class: 'StringJobSource'
    jobContent : String
- downloadFiles : boolean

$class: 'BeginAnalysis'

logLevel
- Values: OFF, INFO, DEBUG, WARN, ERROR
buildSessionId : String
appName : String
moduleName : String
branch : String
enableMultipleBuildFiles : boolean
overrideJars : boolean
multipleBuildFiles : boolean
labId : String
testStage : String
packagesIncluded : String
packagesExcluded : String
filesIncluded : String
filesExcluded : String
classLoadersExcluded : String
In order to exclude class loaders from the build, please provide comma separated list of class loaders names to exclude. Class loader name should be the class loader full package name. e.g. 'com.example.package.SomeClassLoader'
recursive : boolean
workspacepath : String
buildScannerJar : String
testListenerJar : String
testListenerConfigFile : String
autoRestoreBuildFile : boolean
sealightsMavenPluginInstallationArguments : String
buildFilesPatterns : String
buildFilesFolders : String
logEnabled : boolean
logDestination
- Values: CONSOLE, FILE
logFolder : String
buildStrategy
- Values: ONE_BUILD, BUILD_EACH_MODULE
slMvnPluginVersion : String
buildName
- $class: 'DefaultBuildName'
- $class: 'EmptyBuildName'
- $class: 'LatestBuildName'
- $class: 'ManualBuildName'
  - insertedBuildName : String
- $class: 'UpstreamBuildName'
  - upstreamProjectName : String
executionType
- Values: FULL, TESTS_ONLY, ONLY_LISTENER
override_customerId : String
override_url : String
override_proxy : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
buildsessionidfile	Set build session id file for this build.
createbuildsessionid	When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
sealightsJvmParams	Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue)
buildScannerParams	Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue)
testListenerJvmParams	Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue)

includeResources : boolean
When checked, the build session id and token files will be added to the artifacts as as resources in the folder.

benchmark
- filepath : String
  Please insert a filepath.
$class: 'BitbucketPublisher'
- serverUrl : String (optional)
  Bitbucket Server Url.
- credentialsId : String (optional)
  Credentials for bitucket server. The user must have access to create project and repository.
- projectKey : String (optional)
  Input the project key for the bitbucket.
- createProject (optional)
  Check this if you want to create the bitbucket project.
  - projectName : String
  - projectUsers : String
  - projectGroups : String
- createJenkinsJobs (optional)
  Check this if you want to use the bitbucket post commit external hook to call.
  - ciServer : String
- projectName : String (optional)
  Input name of the Bitbucket project.
$class: 'BladeBuilder'
- blades
  - $class: 'CodeScan'
    source : String
    
    exclude : String
    
    noCache : boolean
    
    noProxy : boolean
    
    noBlame : boolean
    
    ruleset : String
    
    severityLevel : String
    
    severityThreshold : int
    
    autoUpdate : boolean (optional)
    
    credentialsId : String (optional)
    
    debug : boolean (optional)
    
    directory : String (optional)
    
    environment : String (optional)
    
    forceVersion : String (optional)
    
    ignoreFailure : boolean (optional)
    
    onFailureCmd : String (optional)
    
    timeout : int (optional)
  - $class: 'ImageScan'
    image : String
    
    exclude : String
    
    noCache : boolean
    
    noProxy : boolean
    
    noBlame : boolean
    
    ruleset : String
    
    severityLevel : String
    
    severityThreshold : int
    
    autoUpdate : boolean (optional)
    
    credentialsId : String (optional)
    
    debug : boolean (optional)
    
    directory : String (optional)
    
    environment : String (optional)
    
    forceVersion : String (optional)
    
    ignoreFailure : boolean (optional)
    
    onFailureCmd : String (optional)
    
    timeout : int (optional)
$class: 'BlueprintLaunch'
- projectName : String
  
  Project selection is mandatory.
- blueprintName : String
  
  Blueprint selection is mandatory.
- applicationName : String
  
  Application Name is mandatory.
  
  This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
- appProfileName : String
  
  Application Profile selection is mandatory.
- actionName : String
  
  The field is mandatory
  
  Select the required action need to run after the application launch from the list of actions, else please select none.
- runtimeVariables : String
  
  Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
- waitForSuccessFulLaunch : boolean
- blueprintDescription : String
  
  Description is fetched from the selected Calm blueprint
BMC DevOps for CFA Plugin
- server : String
  URL or IP address.
- port : String
  z/OSMF Port
- user : String
  z/OS user name
- jclContent : String
- chkfreq : String
- jobCard : String
- acctno : String
- thresh : String
- sortby : String
- pswd : String
- prilog : String
- cfaLoadLibs
  - lib : String
- cfaSldsLibs
  - sldsname : String
  - sldsver : String
  - sldsunit : String
  - sldsvolser : String
- cfaDliLibs
  - dliname : String
  - dliver : String
  - dliunit : String
  - dlivolser : String
- cfaJobnames
  - jobname : String
- cfaReconSets
  - recon1 : String
  - recon2 : String
  - recon3 : String
- goodRC : String
  Any value that is above the acceptable return code will be considered as FAILURE.
- bmcSlds : boolean
  
  You can use the SLDS keyword on the ANALYZE control statement to identify explicitly an input log data set to use as input to the analysis process. SLDS=(dataSetName,Rvr, unit,volser) If you want CFA to read multiple log data sets, specify multiple instances of the SLDS keyword.
  Example: IMSA is an IMS version 14.1 system and creates generations of SLDSs that use the naming convention imsid.SLDS.Ddate.GENnnn. The SLDSs are cataloged. To analyze log records that IMSA wrote to generations 10 through 12 on March 29, 2015, specify the following keywords on the ANALYZE control statement:
  SLDS=(IMSA.SLDS.D2008088.GEN010, R141)
  SLDS=(IMSA.SLDS.D2008088.GEN011, R141)
  SLDS=(IMSA.SLDS.D2008088.GEN012, R141)
- bmcDb2log : boolean
  
  You can use the DB2LOG keyword on the ANALYZE control statement to identify a DB2 log data set that was created by a DB2 subsystem.
  Note: If you specify the DB2LOG keyword, do not specify the DB2BSDS keyword.
- db2log : String
  Specify the fully qualified data set name. No default value is provided.
  If you omit the DB2LOG keyword, CFA does not read any DB2 logs.
- db2bsds : String
- limit : String
- skip : String
- maxlogs : String
  If you specify a value from 1 through 999, Log Analyzer stops reading log data sets after it reaches the specified number of log data sets. If Log Analyzer does not read other log data sets because the specified limit was reached, a warning message indicates the number of log data sets that were not read.
  
  If you want Log Analyzer to read all log data sets, specify MAXLOGS=999.
  
  The default is MAXLOGS=100 (Log Analyzer reads a maximum of 100 log data sets).
- bmcDb2bsds : boolean
  You can use the DB2BSDS keyword on the ANALYZE control statement to identify a DB2 bootstrap data set (BSDS).
  Specify the fully qualified data set name. This name should refer to a VSAM key-sequenced data set (KSDS).
  Do not specify the name of a BSDS archive copy, which is not a VSAM KSDS. BSDS cannot be a TAPE dataset.
  Note:
  
  No default value is provided. If you omit the DB2BSDS keyword, CFA does not read any DB2 BSDSs.
  
  If you specify the DB2BSDS keyword, do not specify the DB2LOG keyword.
- bmcLimit : boolean
  You can use the LIMIT keyword (or the LIM abbreviation) on the ANALYZE control statement to set a limit on the number (1 through 9999999999) of log records to process from an input log data set.
  Note:
  
  The default is LIMIT=9999999999.
  
  If you specify the LIMIT keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.
- bmcSkip : boolean
  
  You can use the SKIP keyword on the ANALYZE control statement to specify a number (1 through 9999999999) of log records in an input log data set to skip before CFA begins to process records.
  The default is SKIP=0, which skips no records.
  Note:
  If you specify the SKIP keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.
- bmcActiveOlds : boolean
  You can use the ACTIVEOLDS keyword (or the AOLDS abbreviation) on the ANALYZE control statement to specify whether CFA can select an active OLDS during RECON processing
- bmcImsid : boolean
  
  You can use the IMSID keyword on the ANALYZE control statement to specify one or more IMSIDs.
  If you do not check this option,then the the default IMSID=ALL will be taken and all log records for all IMS systems that are associated with the input RECON data set (or data sets) will be considered.
  Note:
  If you specify the SLDS keyword, you cannot specify the IMSID keyword. The IMSID keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.
- bmcDlilog : boolean
  You can use the DLILOG keyword on the ANALYZE control statement to identify explicitly an input dli log data set to use as input to the analysis process.
  Specify the keyword values as follows:
  DLILOG=(dataSetName,Rnn)
  DLILOG=(dataSetName,Rvr,unit,volser)
  Notes:
  
  This keyword is used only for the APPCHECK report.
  
  The DLILOG datasets that are processed for the APPCHECK report for DLI are the DLI logs created by using the DLI batch job that uses the //IEFRDER DD statement. For more information about //IEFRDER DD, refer to the IBM IMS Program Restart Facility for z/OS documentation.
- bmcMaxlogs : boolean
  
  You can use the MAXLOGS keyword (or the MAXL abbreviation) on the ANALYZE control statement to control the number of log data sets that Log Analyzer processes.
  
  Use this keyword when you are using implicit specification of log data sets and Log Analyzer is reading RECON data sets to determine which log data sets to process. In this case, the number of log data sets to be processed is unknown. The MAXLOGS keyword can help you prevent a problem that could result from processing an excessive number of log data sets.
  
  The MAXLOGS keyword works differently, depending on how you specify the value:
- bmcJobname : boolean
  You can use the JOBNAME keyword on the ANALYZE control statement to specify one or more JOBNAMEs. Each JOBNAME (one to eight characters) identifies a Job name. Log Analyzer uses the JOBNAME when determining which dli log data sets to use as input.
  To process log records for all Job names that are associated with the input RECON data set (or data sets), specify JOBNAME=ALL.
  If you omit the JOBNAME sub-keyword, Log Analyzer uses the default value ALL.
  Note:
  
  If you specify the DLILOGS keyword, you cannot specify the JOBNAME keyword. The JOBNAME keyword applies only if Log Analyzer is reading RECON data sets to determine which log data sets to process.
  
  Log Analyzer will process all the jobs in the DLILOGs that get selected by the JOBNAME filter.
  
  To later filter the report by job name, use the JOB sub-keyword of the APPCHECK report.
- cfaImsids
  - imsid : String
- bmcRecon : boolean
  
  You can use the RECON keyword on the ANALYZE control statement to specify the names of a set of RECON data sets to examine during the CFA job.
  
  If you want CFA to examine multiple sets of RECON data sets, you must specify each set with a separate RECON keyword.
  
  If you specify the RECON keyword, your user ID must have Security Access Facility (SAF) READ access to the RECON data sets.
  
  You can specify from one to three data set names. One of the specified data set names must be designated as COPY1 by IMS.
  
  Example:
  The RECON data sets for the IMSA system are named IMSA.RECON1 and IMSA.RECON2, and the RECON data sets for the IMSB system are named IMSB.RECON1 and IMSB.RECON2. To examine IMSA and IMSB RECON data sets in the CFA job, specify the following keywords on the ANALYZE control statement:
  RECON=(IMSA.RECON1, IMSA.RECON2)
  RECON=(IMSB.RECON1, IMSB.RECON2)
  Note:
  If you specify the RECON keyword, you must specify the INTERVAL control statement with a START time value and a STOP time value.
- bmcTimezone : boolean
  You can use the TIMEZONE keyword on the ANALYZE control statement to specify how time values are interpreted when you are specifying time input values and when CFA is displaying time values in reports and on panels.
  Note:
  The default is TIMEZONE=LOCAL.
- bmcStartInterval : boolean
  You can use the START keyword on the INTERVAL control statement for the following purposes:
  
  Specify the beginning a range of log records to identify as candidates for the record selection process.
  
  Control the beginning of range of log data sets to allocate from RECON information.
  
  Reduce the overall number of log records that are selected from input SLDS or extract files.
- bmcStopInterval : boolean
  
  You can use the STOP keyword on the INTERVAL control statement for the following purposes:
  � Specify the end of a range of log records to identify as candidates for the record selection process
  � Control the end of range of log data sets to allocate from RECON information
  � Reduce the overall number of log records that are selected from input SLDS or extract files
- start
  - value : String
  - startDate : String
  - startlogSeq : String
- stop
  - value : String
  - stopDate : String
  - stoplogSeq : String
- tz
  - value : String
  - timezoneoffset : String
- jobInclude : String
- jobExclude : String
- psbInclude : String
- psbExclude : String
- maxlogsRc : String
  If you specify a value from 1 through 999 followed by literal R and a return code (08 through 99), Log Analyzer issues the specified return code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the return code at the conclusion of the RECON analysis phase without reading any input log data sets.
  
  Example:
  
  If you want Log Analyzer to issue return code 16 and terminate the job step if more than 10 log data sets would be read, specify the following keyword on the ANALYZE control statement:
  
  MAXLOGS=(10,R16)
- maxlogsAbend : String
  If you specify a value from 1 through 999 followed by an abend code (1 through 4095), Log Analyzer issues a user abend code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the user abend at the conclusion of the RECON analysis phase without reading any input log data sets.
  
  Example:
  
  If you want Log Analyzer to issue a user abend, with abend code U4000, if more than 120 log data sets would be read, specify the following keyword on the ANALYZE control statement:
  
  MAXLOGS=(120,4000)
- bmcJobInc : boolean
  This OPTION includes information for BMP jobs with the specified job names and omits information for all other jobs that CFA finds in the input logs.
- bmcJobExc : boolean
  This OPTION omits information for BMP jobs with the specified job names and includes information for all other jobs that CFA finds in the input logs. For jobName, specify the name of each job to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %)
- bmcPsbInc : boolean
  This OPTION includes information for BMP jobs with the specified PSB names and omits information for all other BMP jobs that CFA finds in the input logs
- bmcPsbExc : boolean
  This OPTION omits information for BMP jobs with the specified PSB names and includes information for all other BMP jobs that CFA finds in the input logs. For psbName, specify the name of each PSB to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %)
- bmcChkfreq : boolean
  You can use the CHKFREQ subkeyword in an APPCHECK expression to filter the information in the Application Checkpoint report, based on checkpoint frequency.
- bmcThresh : boolean
  You can use the THRESH subkeyword in an APPCHECK expression to specify the time unit to use for the threshold value in a checkpoint frequency filter. Valid values are MIN (minutes) and SEC (seconds). If you omit the THRESH subkeyword, CFA uses the default value MIN.
- bmcPrilog : boolean
  You can use the PRILOG keyword on the ANALYZE control statement to specify the logs type associated with the input RECON data set (or data sets) to use as input to the analysis process.
  You can select one of the following values:
  
  SLDS - Process SLDS associated with the input RECON data set (or data sets).
  
  DLI - Process DLI datasets associated with the input RECON data set (or data sets).
  
  BOTH - Process SLDS and DLI datasets associated with the input RECON data set (or data sets).
  
  Note:
  
  If you omit the PRILOG option, Log Analyzer uses the default value SLDS.
  
  If you select the SLDS keyword, you cannot specify the PRILOG keyword. The PRILOG keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.
- bmcAppcheck : boolean
  You can use the APPCHECK keyword on the REPORTS control statement to control production of the Application Checkpoint report.
- bmcAll : boolean
  To produce the Application Checkpoint report with default filters, specify APPCHECK=ALL. With this keyword, CFA includes all batch message processing (BMP) jobs that are found in the input logs, and does not filter the information by checkpoint frequency.
- bmcLsec : boolean
  You can use the LSEC subkeyword in an APPCHECK expression to display the LUOW information with job duration of less than a second for jobs in the Application Checkpoint report.
- chkfreqval : String
- bmcPlanInc : boolean
  This OPTION includes information for batch jobs with the specified Plan names and omits information for all other batch jobs that CFA finds in the input logs.
- planInclude : String
- bmcPlanExc : boolean
  This OPTION omits information for batch jobs with the specified Plan names and includes information for all other batch jobs that CFA finds in the input logs. For PlanName, specify the name of each Plan to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %).
- planExclude : String
- bmcSortby : boolean
  You can use the SORTBY subkeyword in an APPCHECK expression to sort the information in the Application Checkpoint report, based on either checkpoint frequency or start time.
- bmcCsv : boolean
  You can use the CSVRPT subkeyword to create output file in CSV form. Log Analyzer writes the CSV reports to SYSOUT-type data sets.
- bmcFullreport : boolean
  View Full report shows CSV file in MS excel application.
BMC DevOps for BMC AMI Change Manager for IMS TM Plugin
- server : String
  URL or IP address.
- port : String
  z/OSMF Port
- user : String
  z/OS user name
- pswd : String
- jclContent : String
- jclType : String
- dlist : String
  The DELTA List PDS member name is also the DELTA List name. Any valid PDS member name is acceptable to BMC AMI Change Manager for IMS TM.
- jobCard : String
- acctno : String
- dPds : String
  DELTA Lists for all BMC AMI Change Manager for IMS TM users are stored in the active DELTA List library (PDS).
  The DELTA List PDS is normally allocated with RECFM=VB, LRECL=259, and BLKSIZE=23476. Although the block size could be shortened or lengthened as needed, half-track blocking is recommended.
- dOptionsPds : String
  
  Specify the name of the data set where the BMC AMI Change Manager for IMS TM Global Options load module (DLP$GBL0) should be stored or retrieved.
  
  It is recommended that you use the same data set that contains the IMSID options modules (DLP#iiii), and Group options modules (DLPZgggg).
  
  This data set should have been created during BMC AMI Change Manager for IMS TM installation. JCL to allocate this data set is included in the BMC AMI Change Manager for IMS TM control library.
- target : String
  IMSID or GROUP NAME in which to execute the DELTA List.
- mode : String
  Option 'Optimize execution', instructs DELTA PLUS to attempt execution of the ENTIRE DELTA List as a single unit-of-work in IMS. This is the recommended mode due to the speed in which the request is executed.
  Note: You must select this option for a DELTA List that is defined as Dependent to execute in the fashion Dependent implies.
  
  Option 'One element at a time', instructs BMC AMI Change Manager for IMS TM to execute the DELTA List sequentially, one element at a time. This mode is much slower than Optimize execution mode. However, there are certain occasions when one element at a time is desirable. For example, transactions T1, T2 and T3 all require the MAXRGN parameter be changed from 3 to 4. Since they must be stopped before they can be revised, you want them stopped for the shortest amount of time possible. With Optimized mode, ALL the /STOP commands are done BEFORE the DELTA revise is done, and ALL the /START commands are done AFTER the revise is done. Using 'One element at a time' mode, the /STOP is done for T1, T1 is revised, then the /START command for T1 is issued before any activity takes place for T2 or T3.
  
  This mode contains suboption Pause after elements with errors which instructs BMC AMI Change Manager for IMS TM to stop the DELTA List execution when an error is encountered. For additional information on the Pause option, place the cursor on the phrase highlighted above, and press HELP (F1).
- ims_cmd : String
  
  It will process an EXECUTE input record to insert an IMS Command Element into the Delta List PDS Member.
  
  The EXECUTE input record format is as follows: EXECUTE /CMD Command_Parameters
  
  e.g.: EXECUTE /STO PROG PGMD
- title : String
  Title of the DELTA List. A maximum of 28 characters is allowed.
- notes : String
  Notes for the Delta List Member
- dlistRecords
  - action : String
  - elementType : String
  - elementName : String
  - ims_cmd : String
  - appnewname : String
  - appres : String
  - dbnewname : String
  - dbres : String
  - acc : String
  - auto : String
  - rand : String
  - randonly : String
  - rldareas : String
  - iovfext : String
  - dbrelgsam : String
  - dbcopyacb : String
  - apprelgsam : String
  - appcopyacb : String
  - ty : String
  - schd : String
  - appfp : String
  - dyn : String
  - gpsb : String
  - lang : String
  - apptls : String
  - rtcnewname : String
  - rtcinq : String
  - rtcpsbname : String
  - psb : String
  - trannewname : String
  - wfi : String
  - npri : String
  - lpri : String
  - lco : String
  - mseg : String
  - resp : String
  - cl : String
  - plc : String
  - time : String
  - para : String
  - uschd : String
  - traninq : String
  - recv : String
  - tranfp : String
  - emhs : String
  - mper : String
  - uc : String
  - edit : String
  - lsid : String
  - rsid : String
  - spa : String
  - spad : String
  - segs : String
  - oseg : String
  - msc : String
  - dc : String
  - mreg : String
  - ser : String
  - aoi : String
  - trantls : String
  - exptm : String
  - terminalmask : String
  - terminalnewname : String
  - sign : String
  - ltermmask : String
  - ltermnewname : String
  - ass : String
  - msn : String
  - l61 : String
  - subpoolmask : String
  - subpoolnewname : String
  - msg : String
  - bmcAppNew : boolean
  - bmcAppRes : boolean
  - bmcDbNewname : boolean
  - bmcDbRes : boolean
  - bmcAcc : boolean
  - bmcAuto : boolean
  - bmcRand : boolean
  - bmcRandOnly : boolean
  - bmcRldAreas : boolean
  - bmcIoVfExt : boolean
  - bmcDbCopyAcb : boolean
  - bmcDbRelGsam : boolean
  - bmcAppCopyAcb : boolean
  - bmcAppRelGsam : boolean
  - bmcTy : boolean
  - bmcSchd : boolean
  - bmcAppFp : boolean
  - bmcDyn : boolean
  - bmcGpsb : boolean
  - bmcLang : boolean
  - bmcApptls : boolean
  - bmcRtcsPsbName : boolean
  - bmcRtcInq : boolean
  - bmcRtcsNew : boolean
  - bmcPsb : boolean
  - bmcTranNewName : boolean
  - bmcWfi : boolean
  - bmcNpri : boolean
  - bmcLpri : boolean
  - bmcLco : boolean
  - bmcMseg : boolean
  - bmcResp : boolean
  - bmcCl : boolean
  - bmcPlc : boolean
  - bmcTime : boolean
  - bmcPara : boolean
  - bmcUschd : boolean
  - bmcTranInq : boolean
  - bmcRecv : boolean
  - bmcTranFp : boolean
  - bmcEmhs : boolean
  - bmcMper : boolean
  - bmcUc : boolean
  - bmcEdit : boolean
  - bmcLsid : boolean
  - bmcRsid : boolean
  - bmcSpa : boolean
  - bmcSpad : boolean
  - bmcSegs : boolean
  - bmcOseg : boolean
  - bmcMsc : boolean
  - bmcDc : boolean
  - bmcMreg : boolean
  - bmcSer : boolean
  - bmcAoi : boolean
  - bmcTls : boolean
  - bmcExptm : boolean
  - bmcTermMask : boolean
  - bmcTermNew : boolean
  - bmcSign : boolean
  - bmcLtermMask : boolean
  - bmcLtermNew : boolean
  - bmcAss : boolean
  - bmcMsn : boolean
  - bmcL61 : boolean
  - bmcSpMask : boolean
  - bmcSpNewName : boolean
  - bmcMsg : boolean
- dlpLoadLibs
  - lib : String
- vds : String
  (Optional)
  Specify the name of the member (the Variable Definition Set) in the Variable Definition Library that contains the variable definitions for this DELTA List. The Variable Definition Sets are members that contain the definitions for the symbolic variables used by BMC AMI Change Manager for IMS TM in DELTA List processing.
- goodRC : String
  Any value that is above the acceptable return code will be considered as FAILURE.
- dependent : boolean
- mark : boolean
  
  Select this field to inform BMC AMI Change Manager for IMS TM to execute Marked elements only.
  
  A beneficial use of this function is a DELTA List containing many elements that has failed. Instead of creating another DELTA List that contains corrections for the failed element(s) from the previous DELTA List, simply correct the error(s) in the original DELTA List, Mark only those elements which require execution, and select the 'Execute Marked elements only' option at DELTA List execution.
- coord : boolean
$class: 'BootPluginBuilder'
- tasks : String
  Provide a valid boot task, this could be a built in task or a user defined. Try 'boot help' for list of tasks.
- jvmOpts : String
  Specify JVM Options to be used within boot tasks.
$class: 'BranchDestructionStep'
- project : String
- branch : String
$class: 'BranchGenerationStep'
- projectConfig
  - pipelineConfig
    - destructor : boolean
    - authorisations : String
    - branchSCMParameter : boolean
    - branchParameters : String
    - generationExtension : String
    - pipelineGenerationExtension : String
    - disableDslScript : boolean
    - scriptDirectory : String
    - namingStrategy
      Nested Object
      projectFolderPath : String
      
      branchFolderPath : String
      
      projectSeedName : String
      
      projectDestructorName : String
      
      branchSeedName : String
      
      branchStartName : String
      
      branchName : String
      
      ignoredBranchPrefixes : String
    - eventStrategy
      Nested Object
      delete : boolean
      
      auto : boolean
      
      trigger : boolean
      
      commit : String
  - project : String
  - scmType : String
  - scmUrl : String
  - scmCredentials : String
  - triggerIdentifier : String
  - triggerType : String
  - triggerSecret : String
dotnetBuild
The dotnet build command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
1. An executable that can be used to run the application, if the project type is an executable targeting .NET Core 3.0 or later.
2. Symbol files used for debugging, with a .pdb extension.
3. A .deps.json file, which lists the dependencies of the application or library.
4. A .runtimeconfig.json file, which specifies the shared runtime and its version for an application.
5. Other libraries that the project depends on (via project references or NuGet package references).
(see also: Microsoft Documentation)
- charset : String (optional)
  The character set to use for the step's output. If not specified, the charset associated with the build will be used.
- configuration : String (optional)
  Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
- continueOnError : boolean (optional)
  If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
- force : boolean (optional)
  Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
- framework : String (optional)
  Compiles for a specific framework. The framework must be defined in the project file.
- noDependencies : boolean (optional)
  Ignores project-to-project references and only restores the root project.
- noIncremental : boolean (optional)
  Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
- noRestore : boolean (optional)
  Doesn't execute an implicit restore when running the command.
- nologo : boolean (optional)
  Doesn't display the startup banner or the copyright message.
  
  Available since: .NET Core SDK 3.0
- option : String (optional)
- options : Array / List of String (optional)
- optionsString : String (optional)
  For more information about these options, see the MSBuild Command-Line Reference.
  
  If targets and/or properties are also configured, those will be passed after these options.
- outputDirectory : String (optional)
  Directory in which to place the built binaries. If not specified, the default path is ./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a specific framework when you specify this option.
- project : String (optional)
  The MSBuild project or solution to build. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
- properties (optional)
  - Type: java.util.Map<java.lang.String, java.lang.String>
- propertiesString : String (optional)
  Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
- runtime : String (optional)
  Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the RID catalog.
- sdk : String (optional)
  Name of a .NET SDK to use so that dotnet will be in the path.
  If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
- showSdkInfo : boolean (optional)
  If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
- shutDownBuildServers : boolean (optional)
  If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
  
  Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
  
  Available since: .NET Core SDK 2.1
- specificSdkVersion : boolean (optional)
  Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
  By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
  
  Note: This will silently overwrite any global.json already present in the current directory.
- target : String (optional)
- targets : Array / List of String (optional)
- targetsString : String (optional)
  Specifies the MSBuild targets to build. If none are specified, the default target specified in the project will be built.
- unstableIfErrors : boolean (optional)
  If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
- unstableIfWarnings : boolean (optional)
  If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
- verbosity : String (optional)
  Sets the MSBuild verbosity level.
- versionSuffix : String (optional)
  Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
- workDirectory : String (optional)
  The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
reportBuild
- applicationName : String (optional)
- applicationVersion : String (optional)
- applicationComponent : String (optional)
- artifactFileName : String (optional)
- artifactFileSizeLimit : int (optional)
buildAddUrl
- title : String
- url : String
$class: 'BuildBuilder'
- dbFolder
  - value
    - Values: vcsroot, subfolder, scaproject
  - subfolder : String
  - projectPath : String
- packageid : String
  Enter an ID for the build artifact you want to build. Typically, this will be the same as your database name.
- tempServer
  - value : String
  - serverName : String
  - dbName : String
  - serverAuth
    - value : String
    - username : String
    - password
      Type: class hudson.util.Secret
  - encryptConnection : boolean
  - trustServerCertificate : boolean
- options : String
- dataOptions : String
- transactionIsolationLevel
  - Values: Serializable, Snapshot, RepeatableRead, ReadCommitted, ReadUncommitted
- filter : String
- packageVersion : String
  Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
- dlmDashboard
  - dlmDashboardHost : String
  - dlmDashboardPort : String
- sqlChangeAutomationVersionOption
  - value
    - Values: Latest, Specific
  - specificVersion : String
buildDescription
Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.
- descriptionTemplate : String
buildName
Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.
- nameTemplate : String
$class: 'BuildNameUpdater'
This plugin updates build name and description during the build process. Values to set could be stored in a file in the build workspace or in an environment variable.
- fromFile : boolean
- buildName : String
- fromMacro : boolean
- macroTemplate : String
- macroFirst : boolean
crxBuild
Create and build a content package on CRX by specifying a workspace filter, and then download it to the workspace to get archived as a backup, or as the beginning of a magical content package adventure, full of drama, suspense, and deployments to lower environments!
- packageId : String (optional)
  Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.
  
  A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version". The version may be omitted.
  
  This field supports parameter tokens.
- baseUrl : String (optional)
  Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.
  
  If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.
  
  For example, to override the Username without changing the associated password or private key, you may use the following form:
  
  http://deployer@localhost:4502
  
  To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:
  http://deployer:Password123@localhost:4502
  
  This field supports parameter tokens.
- credentialsId : String (optional)
  Select the login credentials for authenticating requests to the CRX server.
  
  [Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.
  
  Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- download : boolean (optional)
  Check this box to download the package after building it.
- localDirectory : String (optional)
  Specify a path relative to the workspace where the package will be downloaded (if the "Download" box is checked).
  
  This field supports parameter tokens.
- requestTimeout : long (optional)
  Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- serviceTimeout : long (optional)
  Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- waitDelay : long (optional)
  Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- wspFilter : String (optional)
  Specify a package workspace filter in a simple text format that will be applied to the package before build. This defines what content will be captured by the package.
  
  Simple spec is defined simply as a line-by-line format where:
  
  each line consists of significant text before an optional comment character (#)
  
  each line that begins with a "/" begins a new filter root.
  
  the first non-empty, non-comment line must define a new filter root
  
  each non-empty, non-comment line after a filter root that begins with a "+" or "-" defines an include or exclude rule, respectively. Everything following the "+" or "-" must be a valid regular expression
  
  Content is "covered" by a filter root if the content path starts with, or is the same as the filter root path. Once the "covering" filter root is identified, its include/exclude rules are evaluated from top to bottom, by matching the content path against each rule pattern (which is a Java regular expression). The last rule whose pattern matches the content path defines whether that content is included (line starts with "+") or excluded (line starts with "-"). If no rules are defined, all content covered by that root path is included
  
  For example, to include everything under /etc except for packages:
  
  /etc # define /etc as the filter root +/etc(/.*)? # include everything under /etc -/etc/packages(/.)? # exclude package paths
  To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
  
  /content/acme # include the site content /apps/acme # include the app code
  This field supports parameter tokens.
$class: 'BuildScanner'
Trigger automated Acunetix scans as part of your web application's build process
- profile : String
  The Scan Type used to scan the target
- target : String
  The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
- repTemp : String
  Generate a Report after the scan completes. The report is available for download from Acunetix backend within a time frame of one hour
- threat : String
  The Threat Level (High, Medium, Low) to fail the build on
- stopScan : boolean
  If selected, the scan will be stopped if the build fails (Threat Level is reached)
- svRep : boolean
  Option to download the report in the project workspace from where it can be used for other operations like attaching to an email or archiving.
  Note: Archiving can be done with "Archive the artifacts" post-build action
- incScan : boolean
  This will create an Incremental scan. The first scan will scan all the site. Subsequent scans will only scan the changes in the site, resulting in smaller scans.
- incScanId : String
- stopTargetScans : boolean
  This is useful when older versions of the web application are discarded by the CI/CD when an updated version is created.
$class: 'BuildStepBuilder'
- sourceFolderMode : String
- subfolder : String
- packageId : String
- serverType : String
- server : String
- authenticationType : String
- userName : String
- password
  - Type: class hudson.util.Secret
- database : String
- compareOptions : String (optional)
- filterFile : String (optional)
- transactionIsoLvl : String (optional)
$class: 'BuildStepWithTimeout'
- buildStep : Build Step (hudson.tasks.BuildStep)
- strategy
  - $class: 'AbsoluteTimeOutStrategy'
    Terminate a build based on a fixed time-out period.
    
    timeoutMinutes : String
    If configured, and if a build does not complete by the specified amount of time (in minutes; at least 3), then the build will be terminated automatically. This is useful if you have experienced infinite loops in your test, for example.
  - $class: 'DeadlineTimeOutStrategy'
    Terminate a build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
    
    deadlineTime : String
    If configured, and if a build does not complete by next deadline time (specified in 24-hour format as HH:MM:SS or HH:MM), then the build will be terminated automatically.
    Variable references are allowed to define deadline time.
    
    deadlineToleranceInMinutes : int
    Period in minutes after the deadline time when a build should be immediately terminated. E.g. if deadline is defined as "13:50", tolerance as "5" minutes and build is scheduled to run at "13:52" it will be immediately terminated. However if it is scheduled at "13:56", build's deadline will be set at "13:50" of next day.
  - $class: 'ElasticTimeOutStrategy'
    Terminate a build based on a specified percentage of the mean of the duration of the n most recent non-failing builds.
    
    timeoutPercentage : String
    If a build takes longer than this percentage of the n most recent non-failing builds, the build will be terminated. If there are no such builds, the "Timeout minutes" field will be used instead.
    
    timeoutMinutesElasticDefault : String
    
    numberOfBuilds : String
    
    failSafeTimeoutDuration : boolean
  - $class: 'LikelyStuckTimeOutStrategy'
    Terminate a build when it has taken many times longer than previous ones.
  - $class: 'NoActivityTimeOutStrategy'
    Terminate a build when there has not been any log output since the last n seconds.
    
    timeoutSecondsString : String
    Seconds to detect timeout since the last log output. This is useful to terminate a build if there has not been any activity for a long time. Be careful with log output delay for buffering.
  - $class: 'RunConditionTimeoutStrategy'
    Sets a conditional timeout. The strategy will take a timeout from a first matching condition. The default value will be used if all evaluations fail or return false.
    This extension uses run condition as condition sources.
    
    conditions
    Array / List of Nested Object
    condition
    A Run Condition to be evaluated.
    
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    timeout : long
    Timeout in minutes, which will be set if the condition above returns true.
    
    defaultTimeout : long
    A default timeout in minutes. This value will be used if all condition evaluations fail or return false.
- operationList
  - $class: 'AbortAndRestartOperation'
    maxRestarts : String
    Count of maximum restarts. 0 means without a limit.
  - $class: 'AbortOperation'
    Abort the build. This is a default operation performed if no operations are specified.
  - $class: 'BuildStepOperation'
    Perform a build step or a post-build action as a timeout action.
    This never ensure all build steps and post-build actions works correct.
    
    buildstep : Build Step (hudson.tasks.BuildStep)
    
    continueEvenFailed : boolean
    Continue subsequent timeout actions even when the build step failed. If unchecked, subsequent timeout actions is not executed, and the build will be marked as failure.
    
    createLauncher : boolean
    Build steps like "Execute shell", "Execute Windows batch command" and so on, requires Launcher object to execute an external program. Build Timeout does not provide Launcher for build steps by default and those build steps fail. Checking here provides the build step a new created Launcher. You should not check here as long as the build step can run without this (that is, it does not require an external program).
  - $class: 'FailOperation'
    The build will be marked as failed.
  - $class: 'WriteDescriptionOperation'
    Writing the build description.
    
    description : String
    A description to set. {0} will be replaced with timeout minutes.
$class: 'BuildStepsFromJsonBuilder'
$class: 'BuildoutBuilder'
- pythonName : String
- buildoutCfg : String
- nature : String
- command : String
- ignoreExitCode : boolean
byteguardGreet
- token : String
- task_id : String
$class: 'CFLaunchBuilder'
- cfComposition : String
- setCFVars
  - vars
    - Variable : String
    - Value : String
$class: 'CIMessageBuilder'
- providerData (optional)
  - activeMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    messageProperties : String (optional)
    
    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
    
    messageType (optional)
    
    Type of CI message to be sent.
    
    Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - activeMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    selector : String (optional)
    
    JMS selector to choose messages that will fire the trigger.
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - fedmsgPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - fedmsgSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - rabbitMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    fedoraMessaging : boolean (optional)
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    schema : String (optional)
    
    Path to message schema.
    
    severity : int (optional)
    
    Severity of the message.
  - rabbitMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
$class: 'CIMessageSubscriberBuilder'
Subscribe to the CI message bus and wait for a message matching the specified JMS selector.

The variable value specifies the name of an environment variable in which to place the received message body.

The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
- providerData (optional)
  - activeMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    messageProperties : String (optional)
    
    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
    
    messageType (optional)
    
    Type of CI message to be sent.
    
    Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - activeMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    selector : String (optional)
    
    JMS selector to choose messages that will fire the trigger.
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - fedmsgPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - fedmsgSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - rabbitMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    fedoraMessaging : boolean (optional)
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    schema : String (optional)
    
    Path to message schema.
    
    severity : int (optional)
    
    Severity of the message.
  - rabbitMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
$class: 'CRDABuilder'
- file : String (optional)
- crdaKeyId : String (optional)
- cliVersion : String (optional)
  You must provide the CRDA cli version for the analysis. To see all versions click on CRDA CLI . Check the Readme for the compatible versions with the plugin.
- consentTelemetry : boolean (optional)
  
  CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
execMan
- requestType : String (optional)
- altCTMConfig (optional)
  Optional alternative Continuous Testing Manager configuration. If provided, these parameters override those specified in Jenkins global configuration.
  - url : String
  - credentials : String
- execParams (optional)
  Optional execution request parameters. Both a key and value must be specified. The value can refer to Jenkins environment variables using this syntax - ${JENKINS_ENV_VAR}. For example - ${BUILD_ID}.
  - list (optional)
    - key : String
    - value : String
- postExecute (optional)
  Optional post execution action. To perform any post action, provide action name along with the need parameters.
  - action : String
  - params : String
- request (optional)
  Select this to run a pre-defined Suite configured on the Continuous Testing Manager.
  - name : String
- waitConfig (optional)
  Optional execution request wait configuration. Both the polling interval and maximum run time must be specified in seconds.
  - pollInterval : String
  - maxRunTime : String
$class: 'CToolBuilder'
Executes a tool of the CMake-suite with arbitrary command-line arguments.
Useful to run cmake in script mode (cmake -P <script file>) or command mode (cmake -E <command>).
- installationName : String
- arguments : String (optional)
- ignoredExitCodes : String (optional)
- toolId : String (optional)
- workingDir : String (optional)
generateCache
Generate ECU-TEST file caches (A2L, ELF, Bus, Model and Service caches are supported).
- caches
  - type
    - Values: A2L, ELF, BUS, MODEL, SERVICE
  - filePath : String
  - dbChannel : String
  - clear : boolean
$class: 'CallFunction'
Call a function You can choose:
- Function name
- Function Arguments
- functionName : String (optional)
- argumentList : Array / List of String (optional)
- argument : String (optional)
$class: 'CallOtherJenkinsBuilder'
- hostName : String
- jobName : String
- span : String
- retry : String
- userName : String
- password : String
- parameters : String
$class: 'CaptureIOSDeviceScreenshot'
Captures a screen shot from each connected iOS device. The image will be stored in a TIFF file matching the device's UDID (e.g. 3c701dda15e238cf3f2831346067751a5c942297.tiff).
- url : String
- cloudTestServerID : String
  Select the server to download iOSAppInstaller.zip from.
- additionalOptions : String
  If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.
carbonetes
- name : String
- credentialsId : String (optional)
- engineTimeout : int (optional)
- failBuildOnPluginError : boolean (optional)
- failBuildOnPolicyEvaluationFailResult : boolean (optional)
- image : String (optional)
- policyBundleID : String (optional)
- registryURI : String (optional)
carl
- installationName : String
- sourcePath : String
- applicationName : String
- archivePdf : boolean (optional)
- displayLog : boolean (optional)
- logPath : String (optional)
- outputPath : String (optional)
- qualityGate : String (optional)
venafiVcertRequestCertificate
- connectorName : String
- zoneConfigName : String
  The name of the zone configuration to use.
  
  When using Venafi as a Service, zone names are in the format of app name\api alias
- commonName : String
- privKeyOutput : String
- certOutput : String
- certChainOutput : String
- country : String (optional)
- dnsNames (optional)
  - hostName : String
- emailAddresses (optional)
  - address : String
- expirationWindow : int (optional)
  Number of hours before certificate expiry to request a new certificate.
- ipAddresses (optional)
  - address : String
- keyType (optional)
  - Values: RSA, ECDSA
- locality : String (optional)
- organization : String (optional)
- organizationalUnit : String (optional)
- province : String (optional)
changeAsmVer
This build step can be used to change the version in the AssemblyInfo.cs file from a .NET Project, it's going to find every AssemblyInfo.cs file in the workspace and change the version from [AssemblyVersion] and [AssemblyFileVersion] attributes. It's recommended to use this plugin with the auto-generated AssemblyInfo.cs from VisualStudio.
- versionPattern : String
- assemblyCompany : String (optional)
- assemblyCopyright : String (optional)
- assemblyCulture : String (optional)
- assemblyDescription : String (optional)
- assemblyFile : String (optional)
  Set the file name to search. If the value is empty the default filename is : **/AssemblyInfo.cs. You can use an ant fileset pattern.
- assemblyProduct : String (optional)
- assemblyTitle : String (optional)
- assemblyTrademark : String (optional)
- regexPattern : String (optional)
  Regex Pattern in which version is stated. Specify this value if you want to use for versioning other than assembly files (e.g. visual studio extensions .vsix). For assembly (.dll) versioning you do not need to specify anything here.
- replacementPattern : String (optional)
  Version value specified in regexPattern will be replaced by this. Use if you want versioning other than assembly files. e.g. "Version(\"%s\")" where %s will be new version number. For assembly (.dll) versioning keep this field blank.
$class: 'ChangeEventBuilder'
Create Change Events on PagerDuty services as Jenkins build steps.
- integrationKey : String
  This is the 32 character Integration Key for an Integration on a Service, or a token that resolves to the key.
- customDetails : String (optional)
  The JSON to be included in the custom details of the change event. Token macro substitution is enabled for this field.
- summaryText : String (optional)
  This is an alternate summary text, that can be passed onto Pager duty change events. If omitted it will default to current build's fullDisplayName.
chatterPost
Simple step for posting a Chatter buildUrlTitle/body to a specified channel or the user's wall.
Usage Example:
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
- credentialsId : String
  Utilizes the Credentials Plugin's Username with Password credentials storage to communicate with Chatter.
  If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
  
  See Identity Confirmation in the salesforce.com online help for more information.
- body : String
  The body text for your Chatter post
- buildUrlTitle : String (optional)
  The buildUrlTitle for your Chatter post. If left blank, the title will be set to your job/pipeline name and number (JOB_NAME BUILD_DISPLAY_NAME)
- recordId : String (optional)
  Id of record to chatter to (e.g. a group, or a custom object), leave blank to chatter to user's wall.
- server : String (optional)
  If left blank will connect to production, if you want to connect to a sandbox or have the my domains feature enabled, enter URL of alternative login server, e.g. https://test.salesforce.com
$class: 'CheckGate'
- pipelineId : String
- stageName : String
- versionId : String
- fatal : String
$class: 'CheckGateBuilder'
- project : String
  Select project.
- gate : String
checkmarxASTScanner
- useOwnServerCredentials : boolean (optional)
- serverUrl : String (optional)
  The base URL of your CxAST environment.
- useAuthenticationUrl : boolean (optional)
  The base URL of your Checkmarx authentication server (IAM). Required for CxAST cloud platform.
- baseAuthUrl : String (optional)
- tenantName : String (optional)
- projectName : String (optional)
  The name of your Project in CxAST. If you enter the name of an existing Project, then this build step will trigger a scan of that Project. If you enter a new Project name, then, when a scan is triggered it will create a new Project in CxAST with the specified name.
- credentialsId : String (optional)
  Create "Checkmarx Client Id and Client Secret" type credentials in Jenkins and enter your oAuth2 clientId and secret. This will be used to authenticate access to the CxAST platform whenever a scan is triggered.
- useOwnAdditionalOptions : boolean (optional)
- additionalOptions : String (optional)
  You can customize your scan by adding additional arguments. The Jenkins plugin supports all CxAST CLI arguments. See documentation here
  e.g- --sast-incremental true
- branchName : String (optional)
- checkmarxInstallation : String (optional)
  Select the Checkmarx CLI installation in Jenkins that will be used for triggering scans. This should have been configured in the Jenkins Global Tool Configuration section.
chlAtuoAction
- content : String
- browserString : String
- runScriptOnly : boolean
- rootPath : String
- libPath : String
$class: 'ChrootBuilder'
- chrootName : String
- ignoreExit : boolean
  The build will always succeed.
- additionalPackages : String
  Additional packages to install into the chroot environment by 'apt-get'. These packages are persisted in the tarball to speed up subsequent builds. If you don't want this bahaviour use the 'Clear' option.
- packagesFile : String
  Enter a list of comma separated relative paths to files in the workspace, which contain additionals packages for apt-get to install. Such files might be placed in a git repository wich is previously checked out.
- clear : boolean
  Uses a fresh copied chroot tarball without packages installed from previous runs. The build will take longer but the build results will be more meaningful.
- command : String
- loginAsRoot : boolean
  When this box is unchecked the subsequent commands are run inside chroot as a user with the same uid and gid as jenkins does. Whenever possible leave this box unchecked, but e. g. for testing installations it might be important to be root.
- noUpdate : boolean
  When this option is enabled, the repository indices are only updated if extra packages are going to be installed. When disabling repository updates, self contained builds, which do not have to install packages, will run faster. Because packages can also be installed from commands within the buildstep, by default, the package indices are always updated.
- forceInstall : boolean
  This option allows to force the installation of the specified packages. The underlying container will do whatever it can do to fulfill this request. This allows actions like downgrading, installing untrusted packages, etc.
$class: 'CifsBuilderPlugin'
- publishers
  - configName : String
  - verbose : boolean
  - transfers
    - sourceFiles : String
    - excludes : String
    - remoteDirectory : String
    - removePrefix : String
    - remoteDirectorySDF : boolean
    - flatten : boolean
    - cleanRemote : boolean
    - noDefaultExcludes : boolean
    - makeEmptyDirs : boolean
    - patternSeparator : String
  - useWorkspaceInPromotion : boolean
  - usePromotionTimestamp : boolean
  - retry
    - retries : int
    - retryDelay : long
  - label
    - label : String
- continueOnError : boolean
- failOnError : boolean
- alwaysPublishFromMaster : boolean
- masterNodeName : String
- paramPublish
  - parameterName : String
$class: 'ClangScanBuildBuilder'
Use this option to execute clang scan-build against and XCode project.
- target : String
  Provide the exact name of the XCode target you wish to have compiled and analyzed. You can use targets for all versions of XCode. This field is not required if you are using XCode and providing workspace and scheme.
- targetSdk : String
  This should be set the simulator version of a currently installed SDK. For later versions of XCode, you can set this value to 'iphonesimulator' to automatically use the latest available version of the SDK. If this does not work, you can identify a specific version by issuing the following command in Terminal:
  
  xcodebuild -showsdks
  
  It should typically look like 'iphonesimulator4.2' where the version number may change depending on your XCode installation.
- config : String
  Provide the XCode config you wish to execute scan-build against. It is recommended that you always use 'Debug' because this will allow clang to use assertions to eliminate false positives.
- clangInstallationName : String
- xcodeProjectSubPath : String
  If your XCode project is located in a sub-folder of this job's workspace, provide the path here relative to the workspace. e.g. myProj/subfolder
- workspace : String
  In XCode 4 and later, you are able to configure named workspaces which are basically containers for multiple XCode projects. If your build requires a workspace, please provide its name in this field. When you provide a workspace you are XCode requires that you also provide a scheme.
- scheme : String
  If you are leveraging XCode workspaces and schemes, provide the name of your scheme here.
- scanbuildargs : String
  This field can be used to pass additional arguments to clang scan-build. The arguments will appear before the xcodebuild sub command. You can view the assembled command by viewing the job's build console.
  
  scan-build uses the 'clang' executable relative to itself for static analysis by default.
  --use-analyzer Xcode using the 'clang' packaged with Xcode (on OS X)
  --use-analyzer [path to clang] to use the 'clang' from 'path to clang' or $PATH if no path specified.
- xcodebuildargs : String
  This field can be used to pass additional arguments to clang scan-build. The arguments will appear after the xcodebuild sub command. You can view the assembled command by viewing the job's build console.
  
  -derivedDataPath $WORKSPACE/build is to save build products and other derived data to build directory under current workspace
- outputFolderName : String
googleStorageUpload
- credentialsId : String
- bucket : String
- pattern : String
- pathPrefix : String (optional)
- sharedPublicly : boolean (optional)
- showInline : boolean (optional)
dotnetClean
The dotnet clean command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.

(see also: Microsoft Documentation)
- charset : String (optional)
  The character set to use for the step's output. If not specified, the charset associated with the build will be used.
- configuration : String (optional)
  Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project. This option is only required when cleaning if you specified it during build time.
- continueOnError : boolean (optional)
  If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
- framework : String (optional)
  The framework that was specified at build time. The framework must be defined in the project file. If you specified the framework at build time, you must specify the framework when cleaning.
- nologo : boolean (optional)
  Doesn't display the startup banner or the copyright message.
  
  Available since: .NET Core SDK 3.0
- option : String (optional)
- options : Array / List of String (optional)
- optionsString : String (optional)
  For more information about these options, see the MSBuild Command-Line Reference.
  
  If targets and/or properties are also configured, those will be passed after these options.
- outputDirectory : String (optional)
  The directory that contains the build artifacts to clean. If you specified the framework when the project was built, that same framework should also be specified for this cleanup action.
- project : String (optional)
  The MSBuild project or solution to clean. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
- properties (optional)
  - Type: java.util.Map<java.lang.String, java.lang.String>
- propertiesString : String (optional)
  Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
- runtime : String (optional)
  Cleans the output folder of the specified runtime. This is used when a self-contained deployment was created.
- sdk : String (optional)
  Name of a .NET SDK to use so that dotnet will be in the path.
  If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
- showSdkInfo : boolean (optional)
  If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
- shutDownBuildServers : boolean (optional)
  If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
  
  Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
  
  Available since: .NET Core SDK 2.1
- specificSdkVersion : boolean (optional)
  Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
  By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
  
  Note: This will silently overwrite any global.json already present in the current directory.
- unstableIfErrors : boolean (optional)
  If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
- unstableIfWarnings : boolean (optional)
  If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
- verbosity : String (optional)
  Sets the MSBuild verbosity level.
- workDirectory : String (optional)
  The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
cleanPerformanceMeasurement
- cleanMeasurement : boolean (optional)
- cleanRCA : boolean (optional)
- cleanRTS : boolean (optional)
examCleanTarget
validNetwork
- username : String
- password : String
- projectId : String
- filepath : String
$class: 'ClifBuilder'
- clifName : String
- clifOpts : String
- testPlanFile : String
- reportDir : String
$class: 'CloudBuildBuilder'
This build step invokes Google Cloud Build.
- input
  - credentialsId : String
  - request
    - file
      
      filename : String
      The path to the YAML build request file to pass to Google Cloud Build.
    - inline
      
      request : String
      The YAML Build Request to pass to Google Cloud Build.
  - source (optional)
    - local
      
      path : String
      The source to use in the build request. This may be either:
      
      A path to a file within the workspace. The file must be a compressed gzipped tarball (.tgz or .tar.gz) or zip file (.zip), or
      
      A path to a directory within the workspace. The contents of the directory will be archived as a gzipped tarball (.tgz) and uploaded to a temporary Cloud Storage bucket.
    - repo
      
      branch : String (optional)
      
      commit : String (optional)
      
      projectId : String (optional)
      ID of the project that owns the repo. If omitted, the project ID requesting the build is assumed.
      
      repoName : String (optional)
      Name of the repo. If omitted, the name "default" is assumed.
      
      tag : String (optional)
    - storage
      
      bucket : String
      
      object : String
  - substitutionList (optional)
    - items
      User-defined substitutions to be added to the build request. The set of user-defined substitutions referenced in the build request must exactly match the set of substitutions defined here. For details, see Build Requests - User-defined substitutions.
      
      Array / List of Nested Object
      key : String
      The name of the user-defined substitution. This must begin with an underscore (_) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
      
      value : String
      The value of the user-defined substitution. This must not expand to longer than 100 characters. For details, see Build Requests - User-defined substitutions.
  - substitutions (optional)
    - Type: java.util.Map<java.lang.String, java.lang.String>
pushToCloudFoundry
- target : String
- organization : String
- cloudSpace : String
- credentialsId : String
- manifestChoice (optional)
  - appName : String (optional)
  - appPath : String (optional)
  - buildpack : String (optional)
  - command : String (optional)
  - domain : String (optional)
  - envVars (optional)
    - key : String
    - value : String
  - hostname : String (optional)
  - instances : String (optional)
  - manifestFile : String (optional)
  - memory : String (optional)
  - noRoute : String (optional)
  - servicesNames (optional)
    - name : String
  - stack : String (optional)
  - timeout : String (optional)
  - value : String (optional)
- pluginTimeout : String (optional)
- selfSigned : String (optional)
- servicesToCreate (optional)
  - name : String
  - type : String
  - plan : String
  - resetService : boolean (optional)
cloudhubDeployer
- environmentId : String
- orgId : String
- appName : String
  The application name identifies your application not only in Runtime Manager but also in the public cloudhub.io domain. For example, an application named myapplication is accessible at http://myapplication.cloudhub.io. To avoid domain conflicts, the application name must be globally unique across CloudHub.The application name can contain between 3 and 42 alphanumeric characters (a-z, A-Z, 0-9) and dashes (-). They cannot contain spaces or other characters.
- muleVersion : String
  The runtime version must be the same Mule version used to develop your application.
- filePath : String
  Workspace-relative path of the artifact file to upload (it should resolve to a single file). Can use wildcards like module/dist/**/*.jar, See the @includes of Ant fileset for the exact format. Examples: File, like target/my-mule-app.jar or target/**/*.jar : The jar file will be uploaded to cloudhub.
- credentialsId : String (optional)
  Jenkins credentials containing The Anypoint Platform account username and password with sufficient access to perform deployment related activities on CloudHub.
- requestMode (optional)
  Type of Operation to perform on CloudHub. CREATE - Deploy/Create new application UPDATE - Update application with new package and settings provided. UPDATE_FILE - Update just the zip/jar file of application, rest all settings ignored. CREATE_OR_UPDATE - Deploy/Create new application(if not already present) or update the existing application. RESTART - Restart the application already present. DELETE - Delete the application.
  - Values: CREATE, UPDATE, CREATE_OR_UPDATE, UPDATE_FILE, RESTART, DELETE
- region : String (optional)
  If you have global deployment enabled on your account, you can change the deployment region.
- autoScalePolicy (optional)
  - autoScalePolicyName : String (optional)
    The auto scaling policy name.
  - enableAutoScalePolicy : boolean (optional)
  - id : String (optional)
  - maxScale : int (optional)
    The maximum number of workers or size of workers for auto scaling. Allowed Values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
  - minScale : int (optional)
    The minimum number of workers or size of workers for auto scaling. Allowed values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
  - scaleBasedOn : String (optional)
    The metric based on which auto scaling policy scales. Allowed values: CPU, MEMORY
  - scaleDown (optional)
    - Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
  - scaleDownNextScaleWaitMins : int (optional)
    Number of minutes to wait before applying new scale down policy.
  - scaleDownPeriodCount : int (optional)
    The time in minutes to monitor the CPU/memory for low usage before scaling down.
  - scaleDownValue : int (optional)
    The CPU or memory usage below which scale down policy will take effect.
  - scaleType : String (optional)
    The scale type of the auto scaling policy. Allowed values: WORKER_COUNT, WORKER_SIZE
  - scaleUp (optional)
    - Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
  - scaleUpNextScaleWaitMins : int (optional)
    Number of minutes to wait before applying new scale up policy.
  - scaleUpPeriodCount : int (optional)
    The time in minutes to monitor the CPU/memory for high usage before scaling up.
  - scaleUpValue : int (optional)
    The CPU or memory usage above which scale up policy will take effect.
- autoStart : boolean (optional)
  Check this flag to autostart the application after it is deployed
- debugMode (optional)
  Use this to log additional details/info from the http requests.
  - Values: ENABLED, DISABLED
- enableAutoScalePolicy : boolean (optional)
- envVars (optional)
  you can specify properties (key-value pairs) that the application uses during deployment and while running.
  - key : String (optional)
  - value : String (optional)
- ignoreGlobalSettings : boolean (optional)
  If checked settings from global configuration will be used that are under manage jenkins.
- logLevels (optional)
  You can configure the logging level (DEBUG, WARN, ERROR, or INFO) for the application
  - levelCategory (optional)
    - Values: DEBUG, WARN, ERROR, INFO
  - packageName : String (optional)
- loggingNgEnabled : boolean (optional)
  Check this if you want to use your own logging solution using Log4j configuration.
- monitoringAutoRestart : boolean (optional)
  CloudHub automatically restarts your application when the monitoring system discovers an issue.
- monitoringEnabled : boolean (optional)
  Use Anypoint Monitoring and Visualizer for Mule applications running on supported versions of Mule.
- objectStoreV1 : boolean (optional)
  Object Store v2 is enabled by default in Mule 4. In Mule 3, select this option to use Object Store v1.
- persistentQueues : boolean (optional)
  You can use persistent queues on your application to store data in an input queue to disk. Persistent queues protect against message loss and enable you to distribute workloads across a set of workers.
- persistentQueuesEncrypted : boolean (optional)
  If you enable persistent queues, you can optionally encrypt the data stored in the input queue on disk.
- timeoutConnection : int (optional)
  Max time to try before failing the request.
- timeoutResponse : int (optional)
  Max time to wait for response before failing the request.
- verifyDeployments : boolean (optional)
  Verify if API is stated after deployment.
- verifyIntervalInSeconds : int (optional)
- workerAmount : int (optional)
  No of workers to run for API.
- workerCpu : String (optional)
  Compute Capacity for each worker(vCores). Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 2 or 16
- workerMemory : String (optional)
  Heap memory (Or Ram) for each worker. Check MuleSoft Documentation for available sizes (worker-size-and-vcores. Example Values :- "500 MB", "1.5 GB" or "32 GB"
- workerType : String (optional)
  Type of worker to use "Micro", "Small", "Medium" or "Large". Check MuleSoft Documentation for additional details.
- workerWeight : String (optional)
  Weight for worker type. Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 0.2 or 1
$class: 'CloudShellConfig'
- buildStep
  - $class: 'StartSandbox'
    blueprintName : String
    Enter the name or id of a CloudShell blueprint.
    
    sandboxDuration : String
    The sandbox duration in minuets.
    
    maxWaitForSandboxAvailability : int
    Enter the number of minutes to wait until the Sandbox becomes available in case no resources are available to reserve it.
    
    setupTimeout : int
    Enter the number of minutes to wait for the sandbox setup to complete
    
    params : String (optional)
    Blueprint Parameter in this syntax: "input1=my_name; input2=30"
    
    sandboxDomain : String (optional)
    Sandbox will be created in the following domain.
    
    sandboxName : String (optional)
    Sandboxes will be created with this name instead of the blueprint name.
$class: 'CmakeBuilder'
Uses CMake to generate build-scripts and can run these.
This causes Jenkins to invoke cmake -G with the given options.
Any non-zero exit code during build-script generation causes Jenkins to mark the build as a failure.
It also can expose the CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
- installationName : String
- buildDir : String (optional)
- buildType : String (optional)
- cleanBuild : boolean (optional)
- cmakeArgs : String (optional)
- generator : String (optional)
- preloadScript : String (optional)
- sourceDir : String (optional)
- steps (optional)
  - args : String (optional)
    Specify arguments to pass to the build tool or to cmake. Arguments must be separated by spaces but may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
    Most of the time, you will want to leave this empty (to call the default build target) or you will specify just some build target names here.
  - envVars : String (optional)
    Specify extra environment variables to pass to the build tool as key-value pairs here.
    Each entry must be on its own line, for example:
    DESTDIR=${WORKSPACE}/artifacts/dir KEY=VALUE
  - withCmake : boolean (optional)
    Whether to run the actual build tool directly (by expanding $CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
    
    Leave unchecked for minimal performance overhead.
    
    Make it checked, if you selected one of the Visual Studio or Xcode generators above AND if you run CMake v. 2.8.11 or newer.
$class: 'CocoaPodsBuilder'
- cleanpods : boolean
  If checked the "pod" folder will be deleted before updating the pods
$class: 'CodeBuilder'
- credentialsType : String
- credentialsId : String
- proxyHost : String
- proxyPort : String
- awsAccessKey : String
- awsSecretKey
  - Type: class hudson.util.Secret
- awsSessionToken : String
- region : String
- projectName : String
- sourceVersion : String
- sseAlgorithm : String
- sourceControlType : String
- localSourcePath : String
- workspaceSubdir : String
- gitCloneDepthOverride : String
- reportBuildStatusOverride : String
- secondarySourcesOverride : String
- secondarySourcesVersionOverride : String
- artifactTypeOverride : String
- artifactLocationOverride : String
- artifactNameOverride : String
- artifactNamespaceOverride : String
- artifactPackagingOverride : String
- artifactPathOverride : String
- artifactEncryptionDisabledOverride : String
- overrideArtifactName : String
- secondaryArtifactsOverride : String
- envVariables : String
- envParameters : String
- buildSpecFile : String
- buildTimeoutOverride : String
- sourceTypeOverride : String
- sourceLocationOverride : String
- environmentTypeOverride : String
- imageOverride : String
- computeTypeOverride : String
- cacheTypeOverride : String
- cacheLocationOverride : String
- cacheModesOverride : String
- cloudWatchLogsStatusOverride : String
- cloudWatchLogsGroupNameOverride : String
- cloudWatchLogsStreamNameOverride : String
- s3LogsStatusOverride : String
- s3LogsEncryptionDisabledOverride : String
- s3LogsLocationOverride : String
- certificateOverride : String
- serviceRoleOverride : String
- insecureSslOverride : String
- privilegedModeOverride : String
- cwlStreamingDisabled : String
- exceptionFailureMode : String
- downloadArtifacts : String
- downloadArtifactsRelativePath : String
- workspaceExcludes : String (optional)
- workspaceIncludes : String (optional)
$class: 'CodeCoverageBuilder'
- connectionId : String
- credentialsId : String
- analysisPropertiesPath : String
- analysisProperties : String
codescene
- credentialsId : String
  Select username/password credentials defined in Jenkins configuration. This is a safe way to use credentials in Jenkins plugin. See Injecting Secrets into Jenkins Build Jobs for more details.
- deltaAnalysisUrl : String
- repository : String
- analyzeBranchDiff : boolean (optional)
- analyzeLatestIndividually : boolean (optional)
  Commits not seen in previous successful builds will be used for separate delta analyses.
- baseRevision : String (optional)
- couplingThresholdPercent : int (optional)
- failOnDecliningCodeHealth : boolean (optional)
  Check this option to mark the build as unstable if the Code Health of a hotspot declines.
- failOnFailedGoal : boolean (optional)
  Check this option to mark the build as unstable if a goal -- as defined by CodeScene's Intelligent Notes -- is violated. This could be a supervised hotspot that suddenly declines in Code Health, or a module indicated as No Problem that starts to accumulate complex code, etc.
- letBuildPassOnFailedAnalysis : boolean (optional)
  By default we fail the build if CodeScene couldn't run an analysis (e.g. couldn't update the repository). This behaviour can be overridden here.
- markBuildAsUnstable : boolean (optional)
- originUrl : String (optional)
- riskThreshold : int (optional)
$class: 'CodeStreamBuilder'
- serverUrl : String
  vRealize Automation host.
- userName : String
  User name
- password : String
  Password
- tenant : String
  Tenant
- pipelineName : String
  CodeStream pipeline name. Please not only latest version of this pipeline will be executed.
- waitExec : boolean
- pipelineParams
  - value : String
  - name : String
CodeThreatScan
- ctServer : String
- max_number_of_critical : int
- max_number_of_high : int
- weakness_is : String
- condition : String
- project_name : String
- fileName : String
- credentialsId : String
$class: 'CodefreshPipelineBuilder'
- selectPipeline
  Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
  - cfPipeline : String
  - cfBranch : String
- setCFVars
  - vars
    - Variable : String
    - Value : String
$class: 'CommentsRemoverBuilder'
- filename : String
  Name of the input file to have comments removed from
- language : String
  Language of the input file - helps locate comments
- outputDir : String
  After execution the result will be in this directory in the workspace
$class: 'CompareBuilder'
Compare two different schemas (from database, repository or snapshot). Based on it you can do in the next steps further actions (like generating report or alter script)
- outputFolder : String
  Path to the folder in that should be used to store compare output.
  It serves as input for following steps like Generate create SQL script or Generate Report.
  
  Folder location must be specified as:
  
  Absolute path to location on your Jenkins master node
  
  Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
  
  Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}/dir.
- srcInputType : String
- tgtInputType : String
- srcInputFileOrFolder : String
  Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Snapshot - input is snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- tgtInputFileOrFolder : String
  Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Snapshot - input is snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- configFile : String
  Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
  
  File location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
$class: 'CompareWithBaselineBuilder'
Compare your current schema with the baseline. In case that the schema is different the build step will fail.
- outputFolder : String
  Path to the folder in that should be used to store baseline compare output.
  It serves as input for following steps like Generate create SQL script or Generate Report.
  
  Folder location must be specified as:
  
  Absolute path to location on your Jenkins master node
  
  Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
  
  Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- srcInputType : String
- tgtInputType : String
- srcInputFileOrFolder : String
  Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Baseline - input is baseline snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- tgtInputFileOrFolder : String
  Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Baseline - input is baseline snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- configFile : String
  Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
  
  File location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.

$class: 'CompoundBuilder'

role : String
number : String

actualBuilder

Nested Choice of Objects

$class: 'A3Builder'
- project_file : String
  Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
  (Note: a³ workspace files (also .apx) are not supported as input.)
- analysis_ids : String
  The following values are allowed:
  
  Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
  
  No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
- pedantic_level : String
- export_a3apxworkspace : String
  Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
- copy_report_file : boolean
- copy_result_file : boolean
- skip_a3_analysis : boolean
  This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
$class: 'ACSDeploymentBuilder'
- context
ACXScanBuilder
- ncScanType : String
- ncWebsiteId : String
- ncProfileId : String
- ncDoNotFail : boolean (optional)
- ncReportType : String (optional)
- acxServerURL : String (optional)
- credentialsId : String (optional)
- ncApiToken : Object (optional)
- ncConfirmed : boolean (optional)
- ncIgnoreFalsePositive : boolean (optional)
- ncIgnoreRiskAccepted : boolean (optional)
- ncSeverity : String (optional)
- ncStopScan : boolean (optional)
cfyAzureArm
- azureCredentialsId : String (optional)
  
  The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
- credentialsId : String (optional)
  
  The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
- debugOutput : boolean (optional)
  If checked, then printed Cloudify events and logs will include debug-level records.
- deploymentId : String (optional)
- echoEnvData : boolean (optional)
  
  If checked, then the created environment's data will be printed to the job's log.
- echoInputs : boolean (optional)
  If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
- envDataLocation : String (optional)
  
  Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
- location : String (optional)
  
  The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location Cloudify secret will be used.
- parameters (optional)
  
  YAML/JSON of parameters to pass to the template.
  - Type: java.util.Map<java.lang.String, java.lang.Object>
- parametersAsString : String (optional)
- parametersFile : String (optional)
  
  Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
- resourceGroupName : String (optional)
  
  Name of resource group to create for the template.
- templateFile : String (optional)
  
  Workspace-relative path of the ARM template file.
- tenant : String (optional)
$class: 'AWSEBBuilder'
- extensions
  - awsRegion
    AWS Region (e.g. us-east-1) This will be the default if no valid environments are provided in the Regions field.
    - Values: GovCloud, US_GOV_EAST_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, EU_NORTH_1, EU_SOUTH_1, EU_SOUTH_2, AP_EAST_1, AP_SOUTH_1, AP_SOUTH_2, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, US_ISO_EAST_1, US_ISOB_EAST_1, US_ISO_WEST_1
  - awsRegionText : String
    AWS Region (e.g. us-east-1) Needs to match an environment name. If one is missing, write an issue so we can update the aws sdk.
  - credentialsString : String
  - credentialsText : String
    Use a credentials name that will be resolved during the build.
  - applicationName : String
    AWS EB Application Name (e.g.: "myapp")
  - versionLabelFormat : String
    How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
  - versionDescriptionFormat : String
    Sets the description of the version to be published. Jenkins environment variables are supported such as ${GIT_BRANCH} - ${BUILD_TAG}
  - failOnError : boolean
    If any of the environments fail to update, or if there are no matching environments then fail the build.
  - extensions
    - $class: 'AWSEBElasticBeanstalkSetup'
    - $class: 'AWSEBS3Setup'
      
      bucketName : String
      S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
      
      bucketRegion : String
      S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
      
      keyPrefix : String
      Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
      
      rootObject : String
      
      Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
      
      It could be either a path to a zip file or a directory.
      
      If its a directory, includes and excludes are used to build the zip file
      
      includes : String
      Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
      
      excludes : String
      Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
      
      overwriteExistingFile : boolean
      
      useTransferAcceleration : boolean
      If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
    - $class: 'ByName'
      
      envNameList : String
      Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
    - $class: 'ByUrl'
      
      urlList : String
      Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
  - envLookup
    - $class: 'AWSEBElasticBeanstalkSetup'
    - $class: 'AWSEBS3Setup'
      
      bucketName : String
      S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
      
      bucketRegion : String
      S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
      
      keyPrefix : String
      Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
      
      rootObject : String
      
      Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
      
      It could be either a path to a zip file or a directory.
      
      If its a directory, includes and excludes are used to build the zip file
      
      includes : String
      Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
      
      excludes : String
      Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
      
      overwriteExistingFile : boolean
      
      useTransferAcceleration : boolean
      If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
    - $class: 'ByName'
      
      envNameList : String
      Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
    - $class: 'ByUrl'
      
      urlList : String
      Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
      When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
      If not set, then all environments under the Application will be updated together.
$class: 'AWSEBDeploymentBuilder'
- config
  - Type: class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfig
- applicationName : String (optional)
  AWS EB Application Name (e.g.: "myapp")
- awsRegion : String (optional)
  AWS Region (e.g. us-east-1)
- bucketName : String (optional)
  
  S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
  
  (Optional, will call createStorageLocation if blank)
- checkHealth : boolean (optional)
  Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
- credentialId : String (optional)
  Select the credentials to use.
- environmentName : String (optional)
  Optional: AWS EB Environment name(s) to deploy to.
  
  Can accept single or multiple comma-separated values. Examples:
  
  "my-prod-env" (single environment)
  
  "my-dev-env,my-staging-env" (multiple environments)
  
  When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
- excludes : String (optional)
  Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
- includes : String (optional)
  Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
- keyPrefix : String (optional)
  Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
- maxAttempts : int (optional)
- rootObject : String (optional)
  Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
  
  Examples:
  
  File, like target/mywebapp.war: The war file will be uploaded
  
  A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
- skipEnvironmentUpdates : boolean (optional)
- sleepTime : int (optional)
- versionDescriptionFormat : String (optional)
  How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
- versionLabelFormat : String (optional)
  How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
- zeroDowntime : boolean (optional)
awsebReleaser
- credentialId : String
  Select the credentials to use.
- awsRegion : String
  AWS Region.
- applicationName : String
  AWS EB Application Name (e.g.: "myapp").
- environmentId : String
  AWS EB Environment name to deploy to.
- versionLabel : String
abapCi
- abapPackagename : String (optional)
- atcVariant : String (optional)
- sapSystemLabel : String (optional)
- runAtcChecks : boolean (optional)
- runUnitTests : boolean (optional)
- treatWarningAtcChecksAsErrors : boolean (optional)
- useJenkinsProjectName : boolean (optional)
- withCoverage : boolean (optional)
snActivatePlugin
- credentialsId : String (optional)
  User name and password defined in global credentials (credentials ID is required here).
  This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
- apiVersion : String (optional)
  Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
- pluginId : String (optional)
  Unique identifier of the plugin. You can locate this identifier on the Plugins page within the card of the desired plugin; identified with the name "ID".
- url : String (optional)
  ServiceNow instance url. This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
addchangestobuildchangelog
- changelogPath : String
- changelogText : String
$class: 'AddComment'
- prefix : String
  Enter the syntax. Example: P1#I10 (P3 - Project ID, I10 - Item ID). You can only add a comment up to 10 items.
- note : String
  Any malicious content will be automatically removed.
- logfile : String
  Upload the build log file as an attachment.
$class: 'AddTestToSetStep'
- domain : String
  HP ALM Domain
- project : String
  HP ALM Project name
- testPlanPath : String
  Path to a test or test folder in HP ALM which shall be added to a test set
- testSetPath : String
  Path to a test set in HP ALM into which test(s) shall be added
allocateDS
- dsn : String
- dsOrg
  - Values: PO, POE, PS, VS
- primary : int
- secondary : int
- recFm
  - Values: F, FB, V, VB, U, VSAM, VA
- alcUnit (optional)
  - Values: TRK, CYL
- avgBlk : int (optional)
- blkSize : int (optional)
- dataClass : String (optional)
- dirBlk : int (optional)
- dsModel : String (optional)
- dsnType (optional)
  - Values: LIBRARY, HFS, PDS, LARGE, BASIC, EXTREQ, EXTPREF
- lrecl : int (optional)
- mgntClass : String (optional)
- storClass : String (optional)
- unit : String (optional)
- volser : String (optional)
$class: 'AmxEclipseAntBuilder'
- targets : String
  Specify a list of Ant targets to be invoked over Tibco amx_eclipse_ant wrapper, or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- name : String
  For projects that need to use TIBCO amx_eclipse_ant wrapper as the build system. This causes Jenkins to invoke amx_eclipse_ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
  Jenkins supplies some environment variables that can be used from within the build script.
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Please refer to TIBCO Documentation for any detail
- buildFile : String
  If your build requires a custom -buildfile, specify it here. By default amx_eclipse_ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory. Please refer to TIBCO Documentation for any detail
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
- amxEclipseAntTra : String
  If your build requires a custom TRA properties file, specify it here. Please refer to TIBCO Documentation for any detail.
- businessStudioWs : String
  If your build requires a custom Business Studio workspace to use, specify it here. By default amx_eclipse_ant use user home as location for "workspace"" creation. this option force amx_eclipse_ant to use a custom workspace by flag "-data 'your-custom-ws'" Please refer to TIBCO Documentation for any detail.
anchore
- name : String
  Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
- annotations (optional)
  - key : String
  - value : String
- autoSubscribeTagUpdates : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
- bailOnFail : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
- bailOnPluginFail : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
- engineCredentialsId : String (optional)
- engineRetries : String (optional)
  Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
- engineurl : String (optional)
  Anchore Engine URL
- engineverify : boolean (optional)
- forceAnalyze : boolean (optional)
  If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
- policyBundleId : String (optional)
  ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
$class: 'AnsibleAdHocCommandBuilder'
- hostPattern : String
  The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
- inventory
  - $class: 'InventoryContent'
    content : String
    
    dynamic : boolean
    Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
  - $class: 'InventoryDoNotSpecify'
  - $class: 'InventoryPath'
    path : String
    Specify the inventory host path or a comma separated host list
- module : String
  Module name to execute. The shell module is used when left empty.
- command : String
  Module arguments or shell command to execute
- additionalParameters : String (optional)
  Any additional parameters to pass to the ansible command.
  Warning:
  The content of this textbox will be passed as is to the command line.
- ansibleName : String (optional)
- becomeUser : String (optional)
  Desired become user. "root" is used when this field is empty.
- colorizedOutput : boolean (optional)
  Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- credentialsId : String (optional)
  Select the credentials for the SSH connections. Only private key authentication is supported.
- disableHostKeyChecking : boolean (optional)
  Check this box if you really want to disable the validation of the hosts SSH server keys.
- extraVars (optional)
  - hidden : boolean (optional)
  - key : String (optional)
  - secretValue (optional)
    - Type: class hudson.util.Secret
- forks : int (optional)
  Specify number of parallel processes to use. Set to 0 to use the default value.
- hostKeyChecking : boolean (optional)
- sudo : boolean (optional)
  Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- sudoUser : String (optional)
  Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- unbufferedOutput : boolean (optional)
  Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- vaultCredentialsId : String (optional)
  Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
cfyAnsible
- additionalArgs : String (optional)
- ansibleEnvVars : String (optional)
- credentialsId : String (optional)
  
  The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
- debugLevel : int (optional)
- debugOutput : boolean (optional)
- deploymentId : String (optional)
- echoEnvData : boolean (optional)
- echoInputs : boolean (optional)
  If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
- envDataLocation : String (optional)
- optionsConfig : String (optional)
- playbookPath : String (optional)
- remergeSources : boolean (optional)
- runData : String (optional)
- savePlaybook : boolean (optional)
- scpExtraArgs : String (optional)
- sensitiveKeys : String (optional)
- sftpExtraArgs : String (optional)
- sourcePath : String (optional)
- sources : String (optional)
- sshCommonArgs : String (optional)
- sshExtraArgs : String (optional)
- startAtTask : String (optional)
- tenant : String (optional)
- timeout : int (optional)
$class: 'AnsiblePlaybookBuilder'
- playbook : String
  Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
- inventory
  - $class: 'InventoryContent'
    content : String
    
    dynamic : boolean
    Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
  - $class: 'InventoryDoNotSpecify'
  - $class: 'InventoryPath'
    path : String
    Specify the inventory host path or a comma separated host list
- additionalParameters : String (optional)
  Any additional parameters to pass to the ansible command.
  Warning:
  The content of this textbox will be passed as is to the command line.
- ansibleName : String (optional)
- becomeUser : String (optional)
  Desired become user. "root" is used when this field is empty.
- colorizedOutput : boolean (optional)
  Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- credentialsId : String (optional)
  Select the credentials for the SSH connections. Only private key authentication is supported.
- disableHostKeyChecking : boolean (optional)
  Check this box if you really want to disable the validation of the hosts SSH server keys.
- extraVars (optional)
  - hidden : boolean (optional)
  - key : String (optional)
  - secretValue (optional)
    - Type: class hudson.util.Secret
- forks : int (optional)
  Specify number of parallel processes to use. Set to 0 to use the default value.
- hostKeyChecking : boolean (optional)
- limit : String (optional)
  Further limit selected hosts to an additional pattern.
- skippedTags : String (optional)
  only run plays and tasks whose tags do not match these values.
- startAtTask : String (optional)
  Start the playbook at the task matching this name.
- sudo : boolean (optional)
  Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- sudoUser : String (optional)
  Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- tags : String (optional)
  Only run plays and tasks tagged with these values.
- unbufferedOutput : boolean (optional)
  Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- vaultCredentialsId : String (optional)
  Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
$class: 'AnsibleTower'
- towerServer : String (optional)
- jobTemplate : String (optional)
- towerCredentialsId : String (optional)
- jobType : String (optional)
- extraVars : String (optional)
- jobTags : String (optional)
- skipJobTags : String (optional)
- limit : String (optional)
- inventory : String (optional)
- credential : String (optional)
- scmBranch : String (optional)
- verbose : boolean (optional)
- importTowerLogs : String (optional)
- removeColor : boolean (optional)
- templateType : String (optional)
- importWorkflowChildLogs : boolean (optional)
$class: 'AnsibleTowerProjectRevisionFreestyle'
- towerServer : String (optional)
- towerCredentialsId : String (optional)
- project : String (optional)
- revision : String (optional)
- verbose : boolean (optional)
- throwExceptionWhenFail : boolean (optional)
$class: 'AnsibleTowerProjectSyncFreestyle'
- towerServer : String (optional)
- towerCredentialsId : String (optional)
- project : String (optional)
- verbose : boolean (optional)
- importTowerLogs : boolean (optional)
- removeColor : boolean (optional)
$class: 'AnsibleVaultBuilder'
- action : String (optional)
  Desired vault action.
- ansibleName : String (optional)
- content : String (optional)
  Desired encrypted content.
- input : String (optional)
  Desired input file to encrypt.
- newVaultCredentialsId : String (optional)
  Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
- output : String (optional)
  Desired output file for encrypted content.
- vaultCredentialsId : String (optional)
  Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
ant
For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
Jenkins supplies some environment variables that can be used from within the build script.
- targets : String
  Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- antName : String
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- buildFile : String
  If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'AntExec'
- scriptSource : String
  Runs entered Apache Ant tasks as a build file with only one target, untill you write code into the "Extended script source", but the target created from this code will always be the default target of the created build file.
  
  The script will run with WORKSPACE as the current directory. Build will be considered as failure if any Ant task fails. You can use Ant-Contrib tasks (if it is enabled in global configuration). You need to use namespace "antcontrib" (example: "<antcontrib:if>").
- extendedScriptSource : String
  Into this field you can enter a code, you could not able to enter into the previous field, as it should not appear within the Ant target. The entries can be other targets, import/include tasks etc. With this extension you are able to create more complex Ant build file with just one limitation - the first field (textarea) must always be used for default Ant target. This field is optional.
- scriptName : String
  Here you can enter the name for your new script. The name will be also used for default Ant target. This build file will then have a name that differs from the default name, so it will not be overwritten by the upcoming build step and therefore it might be used repeatedly, or it can be included/imported.
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
- antName : String
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m.
  Note that other Ant options (such as -lib) should not be here.
- keepBuildfile : boolean
- verbose : boolean
- emacs : boolean
- noAntcontrib : boolean
  
  Disabling usage of Ant-Contrib Tasks in this build step.
antws
For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
Jenkins supplies some environment variables that can be used from within the build script.
- targets : String
  Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- antName : String
- antOpts : String
  If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- buildFile : String
  If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- properties : String
  Properties needed by your ant build can be specified here (in standard properties file format):
  # comment name1=value1 name2=$VAR2
  These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'ApiFortressBuilder'
- mode : String
  When running in single test mode, once specific test will run. When running in automatch mode, a collection of tests will run.
- hook : String
  The API Hook URL.
  API Hooks are unique urls connected to projects. They provide access to API Fortress automation API and will allow you to run tests.
  You can create one in the API Fortress Company dashboard.
- id : String
  Test ID
  When running in Single Test mode, you have to provide the ID of the test you want to run. You can find this information in the interstitial page of the test.
  Automatch URL
  When running in Automatch mode, introduce here the URL of the resource that you are willing to test.
  Tag
  When running in tag mode, introduce the tag of the tests you want to run.
  Project
  When running in project mode, no value is required.
- blocking : boolean
  Set this flag is a test failure must determine a build failure.
- dryrun : boolean
  Set this flag if you don't want the event to be stored in API Fortress.
- silent : boolean
  Set this flag if a failure should not generate API Fortress alerts.
- param1name : String
- param1value : String
- param2name : String
- param2value : String
- param3name : String
- param3value : String
appray
- appRayUrl : String
  App-Ray instance URL. Default: https://demo.app-ray.co
- outputFilePath : String
  Name of the binary file (apk, ipa) to be scanned relative to the workspace. You can use Jenkins variables to specify the filename.
- waitTimeout : int
  Timeout of waiting for ending of a scan. (For big application sometimes it take more than 30 minute!)
- riskScoreThreshold : int
  The minimum risk score to check the apk validity. It is the output of then scan. You can check the scores on the app-ray instance.
- credentialsId : String
  Use email address as a username and please provide a password. The user must have full-access access right in App-Ray in order to be able to submit applications for scanning.
appscan
- scanner
  - dynamic_analyzer
    target : String
    
    hasOptions : boolean
    
    extraField : String (optional)
    
    loginPassword : String (optional)
    
    loginType : String (optional)
    
    loginUser : String (optional)
    
    optimization : String (optional)
    
    presenceId : String (optional)
    
    scanFile : String (optional)
    
    scanType : String (optional)
    
    trafficFile : String (optional)
  - static_analyzer
    target : String
    
    hasOptions : boolean
    
    openSourceOnly : boolean (optional)
- name : String
- type : String
- application : String
- credentials : String
- email : boolean (optional)
- failBuild : boolean (optional)
- failBuildNonCompliance : boolean (optional)
- failureConditions (optional)
  - failureType : String
  - threshold : int
- intervention : boolean (optional)
- target : String (optional)
- wait : boolean (optional)
appscanenterprise
- credentials : String
- folder : String
- testPolicy : String
- template : String
- jobName : String
- accessId : String (optional)
- agent : String (optional)
- application : String (optional)
- email : boolean (optional)
- exploreData : String (optional)
- failBuild : boolean (optional)
- failureConditions (optional)
  - failureType : String
  - threshold : int
- loginType : String (optional)
- scanType : String (optional)
- secretKey : String (optional)
- target : String (optional)
- testOptimization : String (optional)
- trafficFile : String (optional)
- wait : boolean (optional)
$class: 'AppScanSourceBuilder'
- disableScan : boolean
- applicationFile : String
- acceptSSL : boolean
- customScanWorkspace : String
  This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
  
  If this field is blank, the default scan directory will be used.
  
  The default directory is this job's build folder, as defined by Jenkins.
- installation : String (optional)
$class: 'AppScanStandardBuilder'
- startingURL : String
  Insert the URL that you want AppScan Standard to start scanning from.
  Spiders will find the remaining URLs in the domain to be included for scanning.
- installation : String
- additionalCommands : String (optional)
  Provide additional and optional commands to run on AppScan Standard CLI.
  AppScanCMD exec|ex|e Parameters: [ /dest_scan|/dest|/d ] [ /base_scan|/base|/b ] [ /old_host|/ohost|/oh ] [ /new_host|/nhost|/nh ] [ /scan_template|/stemplate|/st ] [ /login_file|/lfile|/lf ] [ /multi_step_file|/mstepfile|/mf ] [ /manual_explore_file|/mexplorefile|/mef ] [ /policy_file|/pfile|/pf ] [ /additional_domains|/adomains|/ad ] [ /report_file|/rf ] [ /report_type|/rt {xml} ] [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] [ /scan_log|/sl {false} ] [ /explore_only|/eo {false} ] [ /test_only|/to {false} ] [ /multi_step|/mstep|/ms {false} ] [ /continue|/c {false} ] [ /merge_manual_explore_requests|/mmer {false} ] [ /include_responses|/ir {false} ] [ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ] Creates new scan with base_scan's configuration saving dest_scan and creating report, if configured. AppScanCMD report|rep|r Parametrs: /base_scan|/base|/b /report_file|/rf /report_type|/rt [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] Creates a report for base_scan. AppScanCMD close_proxy|cprxy|cpr Closes AppScan proxy if was previously opened. More info. at: (9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- authScan : boolean (optional)
  Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.
  If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
- authScanPw : String (optional)
  Provide the password corresponding to the account's user name inserted above.
  Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- authScanRadio : boolean (optional)
  Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.
  A login sequence may be recorded using AppScan Standard's GUI by following these steps:
  
  "Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
  
  Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
- authScanUser : String (optional)
  Provide the user name of an account with access to the private functionalities of the website.
  Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- generateReport : boolean (optional)
  Check this option if you want AppScan Standard to generate a report after scannning.
  The report is available in HTML and PDF.
  
  The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
- htmlReport : boolean (optional)
  This report can be integrated with the HTML Publisher Plugin.
- includeURLS : String (optional)
  This is used to include URLs for scanning,
  Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
- pathRecordedLoginSequence : String (optional)
  Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- pdfReport : boolean (optional)
  A PDF report is generated.
- policyFile : String (optional)
  Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.
  A Test Policy File can be created following these steps:
  
  "Scan" > "Scan Configuration" > "Test Policy" > "Export".
- reportName : String (optional)
  Provide the name to save the report with.
  To configure HTML Publisher Plugin properly, the names in the configuration must match.
- verbose : boolean (optional)
  Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
xooa
- name : String
  Xooa Jenkins
- appId : String
$class: 'AppUploaderBuilder'
- buildFilePath : String
  Please specify the absolute path or relative to the app(.apk or .ipa) file to be uploaded.
  The app_url of the uploaded app can be accessed from the environment variable BROWSERSTACK_APP_ID.
AppdomeBuilder
- token
  - Type: class hudson.util.Secret
- teamId : String
- platform
  - AndroidPlatform
    certificateMethod
    Nested Choice of Objects
    Android_AutoDevSign
    
    fingerprint : String
    
    googleSigning : boolean (optional)
    
    Android_AutoSign
    
    keystorePath : String
    
    keystorePassword
    Type: class hudson.util.Secret
    
    keystoreAlias
    Type: class hudson.util.Secret
    
    keyPass
    Type: class hudson.util.Secret
    
    googleSignFingerPrint (optional)
    Nested Object
    googleSignFingerPrint : String (optional)
    
    googleSign (optional)
    Nested Object
    googleSignFingerPrint : String (optional)
    
    Android_PrivateSign
    
    fingerprint : String
    
    googleSigning : boolean (optional)
    
    appPath : String (optional)
    
    fusionSetId : String (optional)
  - IosPlatform
    certificateMethod
    Nested Choice of Objects
    iOS_AutoDevSign
    
    provisioningProfiles
    Array / List of Nested Object
    item : String
    
    entitlements
    Array / List of Nested Object
    item : String
    
    iOS_AutoSign
    
    keystorePath : String
    
    keystorePassword
    Type: class hudson.util.Secret
    
    entitlements
    Array / List of Nested Object
    item : String
    
    provisioningProfiles (optional)
    Array / List of Nested Object
    item : String
    
    iOS_PrivateSign
    
    provisioningProfiles
    Array / List of Nested Object
    item : String
    
    appPath : String (optional)
    
    fusionSetId : String (optional)
- outputLocation : String (optional)
applatix
- axUrl : String
  The URL of Applatix system. For example: https://applatix.yourcompany.com
- axUsername : String
  Applatix credential: username
- axPassword : String
  Applatix credential: password
- axServiceTemplateName : String
- axServiceTemplateRepository : String
  The repository where your Service Template is.
- axServiceTemplateBranch : String
  The branch where your Service Template is.
- axServiceTemplateParameters
  The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
  - key : String
  - value : String
snApplyChanges
- credentialsId : String (optional)
  User name and password defined in global credentials (credentials ID is required here) used for the instance (usually where the application will be published).
- apiVersion : String (optional)
  Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
- appScope : String (optional)
  Required if application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
- appSysId : String (optional)
  Required if application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
- branchName : String (optional)
  Name of the branch in the source control system from which to acquire the application.
- url : String (optional)
  ServiceNow instance url (usually where the application will be published to).
$class: 'ApprendaBuilder'
- appAlias : String
  The Applicaton Alias to be used.
- appName : String
  The Applicaton Name to be used.
- versionAlias : String
  The application Version Alias to target.
- stage : String
  The desired Apprenda Application lifecycle Stage.
- artifactName : String
  The filename of the Apprenda Application Package. For example myapplication.zip.
- credentialsId : String
- prefix : String
  The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
- advVersionAliasToBeForced : String
  The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
- advancedNewVersionOption : String
- customPackageDirectory : String
  The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
- applicationPackageURL : String
  The complete URL to the Apprenda Application Package, starting with http:// or https://.
- archiveUploadMethod : String
- buildWithParameters : boolean
  Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
aqua
- locationType : String
- registry : String
  Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
- register : boolean
- localImage : String
  Path of local Docker image, including tag. E.g. my_ubuntu:latest
- hostedImage : String
  Path of Docker image on registry, including tag. E.g. google/mysql:latest
- onDisallowed : String
- notCompliesCmd : String
  A shell command to execute when image does not comply with Aqua security policy
- hideBase : boolean
- showNegligible : boolean
- policies : String
  Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
- customFlags : String
- localToken : String (optional)
  Scanner Token for Aqua API. * This token will override the Global Token/Username-Password. * Scanner token entered here is applied at job level. User can use a different token for different builds.
- tarFilePath : String (optional)
- containerRuntime : String (optional)
- scannerPath : String (optional)
aquaMicroscanner
- imageName : String
- onDisallowed : String
- notCompliesCmd : String
  A shell command to execute when image does not comply with Aqua security policy
- outputFormat : String
aquaServerlessScanner
- onDisallowed : String
- notCompliesCmd : String
- codeScanPath : String
- customFlags : String
arachniScanner
- url : String
  URL of the system under scan.
- checks : String
  Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
- scope
  - pageLimit : int
    Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
  - excludePathPattern : String
    Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
- userConfig
  - filename : String
    Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
- format : String
$class: 'ArtifactDeployerBuilder'
- includes : String
  
  Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
  Artifacts are deployed from the workspace. You can change this basedir by specifying the basedir field under Advanced.
- basedir : String
  
  By default, the basedir is the job workspace.
  Give a value to override the default value.
  
  Path relative to workspace is permitted.
- excludes : String
  
  Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.
- remote : String
  
  Artifacts will be deployed in the specified output directory.
  The remote location must be accessible through the build machine (controller and agent node).
  If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins controller.
  Make sure the Jenkins process have the right permissions to write to the remote location.
  For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine.
- flatten : boolean
  
  Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
- deleteRemote : boolean
  
  Delete the output directory before deploying artifacts.
- deleteRemoteArtifacts : boolean
- failNoFilesDeploy : boolean
$class: 'ArtifactPromotionBuilder'
Here you can configure the artifact promotion plugin for single artifacts. In the first section (Artifact Information) you enter the coordinates of your artifact.
In the Staging Repository Information section you tell there your source repository is, e.g. http://192.168.56.24/nexus/content/repositories/staging/.
In the following section Release Repository Information, you enter the information about the target repository, e.g. http://192.168.56.24/nexus/content/repositories/releases/. In both sections, you can add user credentials. If you do, the connection to the repository servers will be done using these credentials. If you don't suppot credentials, the access will be done without any authentication.
Both repositorys should be release repositories, not snapshot repos! The password(s) will be saved currently using the standard Jenkins functionality to save those. It's planned to use in the future the credentials plugin.
- groupId : String
- artifactId : String
- classifier : String
- version : String
- extension : String
- stagingRepository : String
- stagingUser : String
- stagingPW : String
- releaseUser : String
- releasePW : String
- releaseRepository : String
- promoterClass : String
- debug : boolean
- skipDeletion : boolean
  
  'Skip deletion' option preserves the files in the staging repository.
  
  Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
reportArtifactRelease
- applicationName : String (optional)
- applicationVersion : String (optional)
- applicationComponent : String (optional)
- artifactName : String (optional)
- artifactURL : String (optional)
- repositoryName : String (optional)
- tags : String (optional)
artifactResolver
Resolves artifacts against one or more remote maven repositories.
- artifacts
  - groupId : String
  - artifactId : String
  - version : String
  - classifier : String (optional)
  - deployToLocal : boolean (optional)
  - deployToRemote : boolean (optional)
  - extension : String (optional)
  - failOnError : boolean (optional)
  - pomFile : String (optional)
  - targetFileName : String (optional)
- enableRepositoryLogging : boolean (optional)
- enableTransferLogging : boolean (optional)
- repositoryId : String (optional)
- targetDirectory : String (optional)
artifactVersion
- name : String (optional)
- description : String (optional)
- type : String (optional)
- groupId : String (optional)
- artifactId : String (optional)
- stage : String (optional)
- flow : String (optional)
- stageDescription : String (optional)
- version : String (optional)
artifactVersion
- variableName : String
- name : String (optional)
- stage : String (optional)
- version : String (optional)
assertthatBddFeatures
- projectId : String
  Jira project id.
- credentialsId : String
- outputFolder : String
  
  Output folder for feature files withing workspace. Default ./features/.
  By default features are downloaded to the root of the workspace.
- jql : String
- tags : String
- mode : String
- proxyURI : String
- proxyUsername : String
- proxyPassword : String
- jiraServerUrl : String
  Jira Server URL. Populate only if using Jira Server version (e.g. https://mycompanyjira.com). Leave blank for cloud.
- numbered : boolean
- ignoreCertErrors : boolean
$class: 'AssociateItemToRelease'
- releasePrefix : String
  Enter the release details. Example: P2#R10
- itemPrefix : String
  Enter the prefix of your item here. Example: P1#I10 (P1 - Project number, I10 - Item number), P#I11, P#I12, P2#I13
associateTag
- nexusInstanceId : String
- tagName : String
  The tag which will be applied to components matching the specified search criteria
- search
  The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
  - key : String
  - value : String
$class: 'AstreeBuilder'
- dax_file : String
  Absolute path to the DAX file containing the analysis specification and configuration.
  Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
  Paths and environment variables are evaluated on the machine running Jenkins.
- analysis_id : String
  ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
  Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- output_dir : String
  Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
  Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- skip_analysis : boolean
  This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
- genXMLOverview : boolean
- genXMLCoverage : boolean
- genXMLAlarmsByOccurence : boolean
- genXMLAlarmsByCategory : boolean
- genXMLAlarmsByFile : boolean
- genXMLRulechecks : boolean
- dropAnalysis : boolean
  When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
  This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
  Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
  This option corresponds to adding a --drop to a command line call to Astrée.
- genPreprocessOutput : boolean
- failonswitch
  This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
  
  Only Errors
  ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
  This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
  
  Errors and Alarms
  ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
  This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
  
  Errors, Alarms, and Data-Flow Anomalies
  ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
  This setting fails builds on any reported potential code defect or anomaly.
  - failon : String
audit
- credentialsId : String (optional)
- minScore : int (optional)
- platformUrl : String (optional)
- apiTags : String (optional)
- branchName : String (optional)
- defaultCollectionName : String (optional)
- ignoreFailures : boolean (optional)
- ignoreNetworkErrors : boolean (optional)
- jsonReport : String (optional)
- logLevel : String (optional)
- prId : String (optional)
- prTargetBranch : String (optional)
- repositoryName : String (optional)
- rootDirectory : String (optional)
- shareEveryone : String (optional)
- skipLocalChecks : boolean (optional)
- tagName : String (optional)
$class: 'AutEnvironmentBuilder'
- autEnvironmentModel
  - almServerName : String
  - almUserName : String
  - almPassword : String
  - almDomain : String
  - almProject : String
  - clientType : String
    Client type should be provided if your server is ALM version 12.60 or above.
  - autEnvironmentId : String
    Assign ID of an AUT Environment that exists in the ALM project you selected.
  - useExistingAutEnvConf : boolean
  - existingAutEnvConfId : String
  - createNewAutEnvConf : boolean
  - newAutEnvConfName : String
  - autEnvironmentParameters
    - name : String
      The name must be set in the same hierarchical structure as it defined in ALM ( 'Parameters' tab of the AUT Environment)
      For example: 'Parameters/DB_Setting/Oracle/username'
    - value : String
      If you are using a 'From JSON' type, specify here the path for the element you would like to get.
      Make sure you are using JsonPath style for defining it.
    - paramType : String
      Manual - the value you'll assign for 'Parameter value' field will be used as is.
      Environmnet - the value you'll assign for 'Parameter value' will be looked for in the environment parameters and the resolved value will be used. If you named your parameter 'my_parameter' put here 'my_parameter' (exactly the same value).
      From JSON - the value you'll assign for 'Parameter value' will be looked for in the JSON file you specified for the 'Path to JSON file' entry.
    - shouldGetOnlyFirstValueFromJson : boolean
  - pathToJsonFile : String
    A path to the JSON file that will be loaded in order to assign values to all the AUT Environment Parameters of 'From JSON' type.
  - outputParameter : String
    The name of the build environment parameter that will get the ID of the updated/created AUT Environment Configuration. It then can be used as a parameter for following build steps.
    The parameter must be a String Parameter.
    If you named your parameter 'output_parameter' put here 'output_parameter' (exactly the same value).
autifyMobile
- credentialsId : String
  Select the credentials of "Secret Text" storing the Personal Access Token of Autify for Mobile.
  
  See Autify's document to understand how to generate the Personal Access Token.
- autifyUrl : String
  The URL of your test plan you want to run on Autify for Mobile e.g. https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
- autifyPath : String (optional)
- buildId : String (optional)
- buildPath : String (optional)
  If it's a relative path, it will be relative from the workspace directory.
- shellInstallerUrl : String (optional)
- timeout : String (optional)
  Only meaningful if you check "Wait".
  Timeout seconds when waiting the test finishes. If exceeds, the step will fail.
- wait : boolean (optional)
  If checked, the step will wait until the Autify's test plan finishes.
autifyMobileUpload
- credentialsId : String
  Select the credentials of "Secret Text" storing the Personal Access Token of Autify for Mobile.
  
  See Autify's document to understand how to generate the Personal Access Token.
- workspaceId : String
- buildPath : String
  If it's a relative path, it will be relative from the workspace directory.
- autifyPath : String (optional)
- shellInstallerUrl : String (optional)
autifyWeb
- credentialsId : String
  Select the credentials of "Secret Text" storing the Personal Access Token of Autify for Web.
  
  See Autify's document to understand how to generate the Personal Access Token.
- autifyUrl : String
  The URL of your test plan or test scenario you want to run on Autify for Web e.g. https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
- autifyConnect : String (optional)
- autifyConnectClient : boolean (optional)
  If checked, the step will start Autify Connect Client locally with an ephemeral Autify Connect Access Point. "Wait" option must be also checked.
- autifyConnectClientExtraArguments : String (optional)
- autifyPath : String (optional)
- browser : String (optional)
- device : String (optional)
- deviceType : String (optional)
- os : String (optional)
- osVersion : String (optional)
- shellInstallerUrl : String (optional)
- testExecutionName : String (optional)
- timeout : String (optional)
  Only meaningful if you check "Wait".
  Timeout seconds when waiting the test finishes. If exceeds, the step will fail.
- urlReplacements (optional)
  List of a pair of URLs to replace the URL when Autify test accesses. This is useful when you want to run the same Autify test in a different stage e.g. running a test recorded in production against staging.
  - patternUrl : String
  - replacementUrl : String
- wait : boolean (optional)
  If checked, the step will wait until the Autify's test plan or scenario finishes.
$class: 'Autogen'
- element : String
  
  Specify the name of the element in your Endevor® sandbox that you want to include in the autogeneration process, for example, RUNCOB01. The maximum length is 8 characters.
  
  You can specify several specific comma-separated elements within the sandbox, for example, RUNCOB01, RUNCOB02.
  
  You can use wildcards % and * to define the name patterns for the element names.
  Examples:
  Specify * to include all elements from the sandbox in the autonegeration process.
  Specify RUNCOB* to include all element names that start with "RUNCOB".
  Specify %%%COB* to include elements that contain the substring COB starting after position three.
- environment : String
  
  Provide the environment for the Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
- system : String
  
  Provide the system name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
- subsystem : String
  
  Provide the subsystem name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
- stage : String
  
  Specify the environment stage in your Endevor® that you want to include in the autogeneration process, for example, 1.
- instance : String
  
  Specify the instance name of the environment that is associated with Endevor® Web services, for example, WEBSMFNE.
- signout : boolean
  
  Select this option to work with elements in Endevor® that might be currently worked on by another user.
  
  Select the Override signout option only if you have the permission to override the signout of another user.
$class: 'AwsBatchBuilder'
- jobname : String
- jobdefinition : String
- command : String
- jobqueue : String
- vcpu : String
- memory : String
- retries : String
azureCLI
- principalCredentialId : String
  The Service Principal credentials required to connect to your Azure account.
  More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
  If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
  If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
- commands
  - script : String
  - exportVariablesString : String
    Export the output of the command to environment variables
    The format: /"variable from JSON" | "desired environment variable name"
    For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
azureDownload
- storageCredentialId : String
- downloadType : String
- buildSelector (optional)
  - downstream
    upstreamProjectName : String
    
    Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
    
    Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
    
    Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
    
    AbstractProject based projects:
    
    Freestyle projects
    
    Multi-configuration projects
    
    Maven projects
    
    Non AbstractProject based projects:
    
    Pipeline jobs (aka. Workflow jobs)
    
    upstreamBuildNumber : String
    The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
  - lastWithArtifacts
  - lastCompleted
  - $class: 'MultiJobBuildSelector'
  - buildParameter
    parameterName : String
    Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.
    You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
  - permalink
    id : String
  - $class: 'PromotedBuildSelector'
    level : int
  - latestSavedBuild
  - specific
    buildNumber : String
    While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
  - lastSuccessful
    stable : boolean (optional)
  - upstream
    allowUpstreamDependencies : boolean (optional)
    
    fallbackToLastSuccessful : boolean (optional)
    
    upstreamFilterStrategy (optional)
    Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
    
    Values: UseGlobalSetting, UseOldest, UseNewest
  - workspace
- containerName : String (optional)
  Enter a storage container name.
  Environment variables can also be referenced.
  For example: ${JOB_NAME}
- deleteFromAzureAfterDownload : boolean (optional)
  If checked, the file copy on Azure will be removed after it's downloaded to local.
- downloadDirLoc : String (optional)
  Enter a download path. If not specified, the files will be downloaded into the job's workspace.
  Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
- excludeFilesPattern : String (optional)
  Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
  For example: ${JOB_NAME}
- fileShare : String (optional)
  Enter a Azure File Storage Share name.
  Environment variables can also be referenced.
  For example: ${JOB_NAME}
- flattenDirectories : boolean (optional)
  If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
- includeArchiveZips : boolean (optional)
  The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
- includeFilesPattern : String (optional)
  Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
  For example: ${JOB_NAME}
- projectName : String (optional)
  The name of the project to download the managed artifact from.
- verbose : boolean (optional)
  Enabling this will provide more logging on downloading files.
$class: 'BDSBuilder'
- projectFile : String
- switches : String
- installationName : String

$class: 'BapFtpBuilder'

Send files over FTP as a build step during the build.

publishers

Array / List of Nested Object

configName : String

Select an FTP configuration from the list configured in the global configuration of this Jenkins.

The configuration defines the connection properties and base directory of the FTP server.
verbose : boolean
Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.

transfers

Array / List of Nested Object

sourceFiles : String

Files to upload to a server.

The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String

Exclude files from the Transfer set.

The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String

Optional destination folder.

This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String

First part of the file path that should not be created on the remote server.

Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.

If you use remove prefix, then ALL source file paths MUST start with the prefix.
asciiMode : boolean

Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.

Use with ASCII text files to fix the line terminators when transferring between different operating systems.

remoteDirectorySDF : boolean

Select this to include the timestamp in the remote directory.

Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

Remote directory	Directories created
`'qa-approved/'yyyyMMddHHmmss`	`qa-approved/20101107154555`
`'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}'`	`builds/2010/11/07/build-456` (if the build was number 456)
`yyyy_MM/'build'-EEE-d-HHmmss`	`2010_11/build-Sun-7-154555`
`yyyy-MM-dd_HH-mm-ss`	`2010-11-07_15-45-55`

flatten : boolean

Only create files on the server, don't create directories (except for the remote directory, if present).

All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean

Select to delete all files and directories within the remote directory before transferring files.
noDefaultExcludes : boolean
makeEmptyDirs : boolean

The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.

The Source files and Exclude files both accept multiple patterns that by default are split using
```
[, ]+
```
which is how Ant, by default, handles multiple patterns in a single string.

The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.

useWorkspaceInPromotion : boolean

Set the root directory for the Source files to the workspace.

By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
usePromotionTimestamp : boolean

Use the build time of the promotion when the remote directory is a date format.

By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
ftpRetry

If publishing to this server fails, try again.

Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
- retries : int
  The number of times to retry this server in the event of failure.
- retryDelay : long
  The time to wait, in milliseconds, before attempting another transfer.
ftpLabel

Set the label for this Server instance - for use with Parameterized publishing.

Expand the help for Parameterized publishing for more details.
- label : String
  
  Set the label for this Server instance - for use with Parameterized publishing.
  
  Expand the help for Parameterized publishing for more details.
ftpCredentials
Set the username and password to use with this connection.
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
- username : String
- password : String

continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
- parameterName : String
  The name of the parameter or environment variable that will contain the expression for matching the labels.

$class: 'BapSshBuilderPlugin'

Send files or execute commands over SSH as a build step during the build.

publishers

Array / List of Nested Object

configName : String

Select an SSH configuration from the list configured in the global configuration of this Jenkins.

The configuration defines the connection properties and base directory of the SSH server.
verbose : boolean
Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems.

transfers

Array / List of Nested Object

sourceFiles : String

Files to upload to a server.

The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String

Exclude files from the Transfer set.

The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String

Optional destination folder.

This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String

First part of the file path that should not be created on the remote server.

Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.

If you use remove prefix, then ALL source file paths MUST start with the prefix.

remoteDirectorySDF : boolean

Select this to include the timestamp in the remote directory.

Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

Remote directory	Directories created
`'qa-approved/'yyyyMMddHHmmss`	`qa-approved/20101107154555`
`'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}'`	`builds/2010/11/07/build-456` (if the build was number 456)
`yyyy_MM/'build'-EEE-d-HHmmss`	`2010_11/build-Sun-7-154555`
`yyyy-MM-dd_HH-mm-ss`	`2010-11-07_15-45-55`

flatten : boolean

Only create files on the server, don't create directories (except for the remote directory, if present).

All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean
noDefaultExcludes : boolean
makeEmptyDirs : boolean

The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.

The Source files and Exclude files both accept multiple patterns that by default are split using
```
[, ]+
```
which is how Ant, by default, handles multiple patterns in a single string.

The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
execCommand : String (optional)

A command to execute on the remote server.

This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
execTimeout : int (optional)

Timeout in milliseconds for the Exec command.

Set to zero to disable.

usePty : boolean (optional)

Exec the command in a pseudo tty.

This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:

requiretty      If set, sudo will only run when the user is logged in
                to a real tty.  When this flag is set, sudo can only be
                run from a login session and not via other means such
                as cron(8) or cgi-bin scripts.  This flag is off by
                default.

useAgentForwarding : boolean (optional)

Exec the command using Agent Forwarding.

Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.

From the ssh(1) man page:

        Enables forwarding of the authentication agent connection.  This can also be specified on a per-host basis in a configuration file.

        Agent forwarding should be enabled with caution.  Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
        An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.

useSftpForExec : boolean (optional)

Using SFTP protocol instead of SSH for Exec command.

Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls

useWorkspaceInPromotion : boolean

Set the root directory for the Source files to the workspace.

By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory.
usePromotionTimestamp : boolean

Use the build time of the promotion when the remote directory is a date format.

By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
sshRetry

If publishing to this server or command execution fails, try again.

Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
- retries : int
  The number of times to retry this server in the event of failure.
- retryDelay : long
  The time to wait, in milliseconds, before attempting another transfer.
sshLabel

Set the label for this Server instance - for use with Parameterized publishing.

Expand the help for Parameterized publishing for more details.
- label : String
  
  Set the label for this Server instance - for use with Parameterized publishing.
  
  Expand the help for Parameterized publishing for more details.
sshCredentials
Set the credentials to use with this connection.
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
- username : String
  The username to connect with.
- encryptedPassphrase : String
  The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
  Leave blank if the key is not encrypted.
- key : String
  
  The private key.
  
  Paste the private key here, or provide the path to the file containing the key in Path to key.
- keyPath : String
  
  The path to the private key.
  
  Either supply the path to the file containing the key, or paste the key into the Key box.
  The Path to key can be absolute, or relative to $JENKINS_HOME

continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
- parameterName : String
  The name of the parameter or environment variable that will contain the expression for matching the labels.

batchFile

command : String

configuredLocalRules (optional)

Array / List of Nested Choice of Objects

retainOnlyVariables

Limit which environment variables are passed to a build step.

Environment variables passed to the build step are filtered, unless listed below.

The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:

If the environment variable originates from Jenkins configuration, such as JOB_URL , it will not be passed to the build step unless specified here.
If the environment variable originates from outside Jenkins, such as PATH , the behavior depends on the option Process environment variables handling : If that option is set to Retain , the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove , the variable will not be passed to the build step.

The following table shows the effect of filtering on an environment variable:

Behavior	Originally defined outside Jenkins	Originally defined inside Jenkins
Process environment variables handling: reset	Variable is reset to original value	Variable is removed
Process environment variables handling: removed	Variable is removed	Variable is removed

processVariablesHandling (optional)
- Values: RESET, REMOVE
retainCharacteristicEnvVars : boolean (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
variables : String (optional)

Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.

unstableReturn : int (optional)
If set, the batch errorlevel result that will be interpreted as an unstable build result. If the final errorlevel matches the value, the build results will be set to unstable and next steps will be continued. Supported values match the widest errorlevel range for Windows like systems. In Windows NT4 and beyond the ERRORLEVEL is stored as a four byte, signed integer, yielding maximum and minimum values of 2147483647 and -2147483648, respectively. Older versions of Windows use 2 bytes. DOS like systems use single byte, yielding errorlevels between 0-255. The value 0 is ignored and does not make the build unstable to keep the default behaviour consistent.

snBatchInstall

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be installed.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
batchName : String (optional)
Required. User specified descriptive name for this batch request.
file : String (optional)
Name of the batch file with json manifest. If only a name is given or relative path then the file will be searched in WORKSPACE directory of the build.
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json.
notes : String (optional)
User specified additional notes about the batch install plan.
Default: null

packages : String (optional)

Required. JSON array, where each object specifies details of a package to install.

        
    [{
        "id": "String",
        "load_demo_data": Boolean,
        "notes": "String",
        "requested_customized_version": "String",
        "requested_version": "String",
        "type": "String"
    }]

id	Required. Sys_id of the application or identifier of the plugin to install.
load_demo_data	Flag that indicates whether demo data is loaded when installing the package. Valid values: `true`: Demo data should be loaded. `false`: Demo data should not be loaded. Default: `false`
notes	User specified notes about the package. Default: `null`
requested_customized_version	Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3.
requested_customized_version	Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application.
requested_version	Required if `type` is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3.
type	Required. Type of package. Valid values: `application` `plugin`

url : String (optional)
ServiceNow instance url where the application will be installed.
useFile : boolean (optional)
Specifies if manifest json file will be used to define the batch. The file can be stored in git repository (in this case SCM should be configured).
Default: false

snBatchRollback
- credentialsId : String (optional)
  User name and password defined in global credentials (credentials ID is required here).
  If ServiceNow Parameters are used, then credentials for installation instance will be used.
- apiVersion : String (optional)
  Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
- rollbackId : String (optional)
  Unique identifier (sys_id) of the rollback installed before.
- url : String (optional)
  ServiceNow instance url where the batch of packages was installed.
  If ServiceNow Parameters are used, then the URL of installation instance will be used.
greet
- apiKey
  - Type: class hudson.util.Secret
- appType : String
- appPath : String
- packageName : String
- scanTimeout : String
- severityThreshold : String
$class: 'BeaglePlugin'
- apptoken
  
  Generate your Application Token From Beagle
  
  Home -> Applications -> Select your Application -> Settings -> Application Token
  - Type: class hudson.util.Secret
- accesstoken
  
  Generate your Access Token From Beagle User Settings
  
  Settings -> Access Token -> Generate Your New Personal Access Token
  - Type: class hudson.util.Secret
$class: 'BeakerBuilder'
- jobSource
  - $class: 'FileJobSource'
    jobPath : String
  - $class: 'StringJobSource'
    jobContent : String
- downloadFiles : boolean

$class: 'BeginAnalysis'

logLevel
- Values: OFF, INFO, DEBUG, WARN, ERROR
buildSessionId : String
appName : String
moduleName : String
branch : String
enableMultipleBuildFiles : boolean
overrideJars : boolean
multipleBuildFiles : boolean
labId : String
testStage : String
packagesIncluded : String
packagesExcluded : String
filesIncluded : String
filesExcluded : String
classLoadersExcluded : String
In order to exclude class loaders from the build, please provide comma separated list of class loaders names to exclude. Class loader name should be the class loader full package name. e.g. 'com.example.package.SomeClassLoader'
recursive : boolean
workspacepath : String
buildScannerJar : String
testListenerJar : String
testListenerConfigFile : String
autoRestoreBuildFile : boolean
sealightsMavenPluginInstallationArguments : String
buildFilesPatterns : String
buildFilesFolders : String
logEnabled : boolean
logDestination
- Values: CONSOLE, FILE
logFolder : String
buildStrategy
- Values: ONE_BUILD, BUILD_EACH_MODULE
slMvnPluginVersion : String
buildName
- $class: 'DefaultBuildName'
- $class: 'EmptyBuildName'
- $class: 'LatestBuildName'
- $class: 'ManualBuildName'
  - insertedBuildName : String
- $class: 'UpstreamBuildName'
  - upstreamProjectName : String
executionType
- Values: FULL, TESTS_ONLY, ONLY_LISTENER
override_customerId : String
override_url : String
override_proxy : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
buildsessionidfile	Set build session id file for this build.
createbuildsessionid	When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
sealightsJvmParams	Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue)
buildScannerParams	Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue)
testListenerJvmParams	Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue)

includeResources : boolean
When checked, the build session id and token files will be added to the artifacts as as resources in the folder.

benchmark
- filepath : String
  Please insert a filepath.
$class: 'BitbucketPublisher'
- serverUrl : String (optional)
  Bitbucket Server Url.
- credentialsId : String (optional)
  Credentials for bitucket server. The user must have access to create project and repository.
- projectKey : String (optional)
  Input the project key for the bitbucket.
- createProject (optional)
  Check this if you want to create the bitbucket project.
  - projectName : String
  - projectUsers : String
  - projectGroups : String
- createJenkinsJobs (optional)
  Check this if you want to use the bitbucket post commit external hook to call.
  - ciServer : String
- projectName : String (optional)
  Input name of the Bitbucket project.
$class: 'BladeBuilder'
- blades
  - $class: 'CodeScan'
    source : String
    
    exclude : String
    
    noCache : boolean
    
    noProxy : boolean
    
    noBlame : boolean
    
    ruleset : String
    
    severityLevel : String
    
    severityThreshold : int
    
    autoUpdate : boolean (optional)
    
    credentialsId : String (optional)
    
    debug : boolean (optional)
    
    directory : String (optional)
    
    environment : String (optional)
    
    forceVersion : String (optional)
    
    ignoreFailure : boolean (optional)
    
    onFailureCmd : String (optional)
    
    timeout : int (optional)
  - $class: 'ImageScan'
    image : String
    
    exclude : String
    
    noCache : boolean
    
    noProxy : boolean
    
    noBlame : boolean
    
    ruleset : String
    
    severityLevel : String
    
    severityThreshold : int
    
    autoUpdate : boolean (optional)
    
    credentialsId : String (optional)
    
    debug : boolean (optional)
    
    directory : String (optional)
    
    environment : String (optional)
    
    forceVersion : String (optional)
    
    ignoreFailure : boolean (optional)
    
    onFailureCmd : String (optional)
    
    timeout : int (optional)
$class: 'BlueprintLaunch'
- projectName : String
  
  Project selection is mandatory.
- blueprintName : String
  
  Blueprint selection is mandatory.
- applicationName : String
  
  Application Name is mandatory.
  
  This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
- appProfileName : String
  
  Application Profile selection is mandatory.
- actionName : String
  
  The field is mandatory
  
  Select the required action need to run after the application launch from the list of actions, else please select none.
- runtimeVariables : String
  
  Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
- waitForSuccessFulLaunch : boolean
- blueprintDescription : String
  
  Description is fetched from the selected Calm blueprint
BMC DevOps for CFA Plugin
- server : String
  URL or IP address.
- port : String
  z/OSMF Port
- user : String
  z/OS user name
- jclContent : String
- chkfreq : String
- jobCard : String
- acctno : String
- thresh : String
- sortby : String
- pswd : String
- prilog : String
- cfaLoadLibs
  - lib : String
- cfaSldsLibs
  - sldsname : String
  - sldsver : String
  - sldsunit : String
  - sldsvolser : String
- cfaDliLibs
  - dliname : String
  - dliver : String
  - dliunit : String
  - dlivolser : String
- cfaJobnames
  - jobname : String
- cfaReconSets
  - recon1 : String
  - recon2 : String
  - recon3 : String
- goodRC : String
  Any value that is above the acceptable return code will be considered as FAILURE.
- bmcSlds : boolean
  
  You can use the SLDS keyword on the ANALYZE control statement to identify explicitly an input log data set to use as input to the analysis process. SLDS=(dataSetName,Rvr, unit,volser) If you want CFA to read multiple log data sets, specify multiple instances of the SLDS keyword.
  Example: IMSA is an IMS version 14.1 system and creates generations of SLDSs that use the naming convention imsid.SLDS.Ddate.GENnnn. The SLDSs are cataloged. To analyze log records that IMSA wrote to generations 10 through 12 on March 29, 2015, specify the following keywords on the ANALYZE control statement:
  SLDS=(IMSA.SLDS.D2008088.GEN010, R141)
  SLDS=(IMSA.SLDS.D2008088.GEN011, R141)
  SLDS=(IMSA.SLDS.D2008088.GEN012, R141)
- bmcDb2log : boolean
  
  You can use the DB2LOG keyword on the ANALYZE control statement to identify a DB2 log data set that was created by a DB2 subsystem.
  Note: If you specify the DB2LOG keyword, do not specify the DB2BSDS keyword.
- db2log : String
  Specify the fully qualified data set name. No default value is provided.
  If you omit the DB2LOG keyword, CFA does not read any DB2 logs.
- db2bsds : String
- limit : String
- skip : String
- maxlogs : String
  If you specify a value from 1 through 999, Log Analyzer stops reading log data sets after it reaches the specified number of log data sets. If Log Analyzer does not read other log data sets because the specified limit was reached, a warning message indicates the number of log data sets that were not read.
  
  If you want Log Analyzer to read all log data sets, specify MAXLOGS=999.
  
  The default is MAXLOGS=100 (Log Analyzer reads a maximum of 100 log data sets).
- bmcDb2bsds : boolean
  You can use the DB2BSDS keyword on the ANALYZE control statement to identify a DB2 bootstrap data set (BSDS).
  Specify the fully qualified data set name. This name should refer to a VSAM key-sequenced data set (KSDS).
  Do not specify the name of a BSDS archive copy, which is not a VSAM KSDS. BSDS cannot be a TAPE dataset.
  Note:
  
  No default value is provided. If you omit the DB2BSDS keyword, CFA does not read any DB2 BSDSs.
  
  If you specify the DB2BSDS keyword, do not specify the DB2LOG keyword.
- bmcLimit : boolean
  You can use the LIMIT keyword (or the LIM abbreviation) on the ANALYZE control statement to set a limit on the number (1 through 9999999999) of log records to process from an input log data set.
  Note:
  
  The default is LIMIT=9999999999.
  
  If you specify the LIMIT keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.
- bmcSkip : boolean
  
  You can use the SKIP keyword on the ANALYZE control statement to specify a number (1 through 9999999999) of log records in an input log data set to skip before CFA begins to process records.
  The default is SKIP=0, which skips no records.
  Note:
  If you specify the SKIP keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.
- bmcActiveOlds : boolean
  You can use the ACTIVEOLDS keyword (or the AOLDS abbreviation) on the ANALYZE control statement to specify whether CFA can select an active OLDS during RECON processing
- bmcImsid : boolean
  
  You can use the IMSID keyword on the ANALYZE control statement to specify one or more IMSIDs.
  If you do not check this option,then the the default IMSID=ALL will be taken and all log records for all IMS systems that are associated with the input RECON data set (or data sets) will be considered.
  Note:
  If you specify the SLDS keyword, you cannot specify the IMSID keyword. The IMSID keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.
- bmcDlilog : boolean
  You can use the DLILOG keyword on the ANALYZE control statement to identify explicitly an input dli log data set to use as input to the analysis process.
  Specify the keyword values as follows:
  DLILOG=(dataSetName,Rnn)
  DLILOG=(dataSetName,Rvr,unit,volser)
  Notes:
  
  This keyword is used only for the APPCHECK report.
  
  The DLILOG datasets that are processed for the APPCHECK report for DLI are the DLI logs created by using the DLI batch job that uses the //IEFRDER DD statement. For more information about //IEFRDER DD, refer to the IBM IMS Program Restart Facility for z/OS documentation.
- bmcMaxlogs : boolean
  
  You can use the MAXLOGS keyword (or the MAXL abbreviation) on the ANALYZE control statement to control the number of log data sets that Log Analyzer processes.
  
  Use this keyword when you are using implicit specification of log data sets and Log Analyzer is reading RECON data sets to determine which log data sets to process. In this case, the number of log data sets to be processed is unknown. The MAXLOGS keyword can help you prevent a problem that could result from processing an excessive number of log data sets.
  
  The MAXLOGS keyword works differently, depending on how you specify the value:
- bmcJobname : boolean
  You can use the JOBNAME keyword on the ANALYZE control statement to specify one or more JOBNAMEs. Each JOBNAME (one to eight characters) identifies a Job name. Log Analyzer uses the JOBNAME when determining which dli log data sets to use as input.
  To process log records for all Job names that are associated with the input RECON data set (or data sets), specify JOBNAME=ALL.
  If you omit the JOBNAME sub-keyword, Log Analyzer uses the default value ALL.
  Note:
  
  If you specify the DLILOGS keyword, you cannot specify the JOBNAME keyword. The JOBNAME keyword applies only if Log Analyzer is reading RECON data sets to determine which log data sets to process.
  
  Log Analyzer will process all the jobs in the DLILOGs that get selected by the JOBNAME filter.
  
  To later filter the report by job name, use the JOB sub-keyword of the APPCHECK report.
- cfaImsids
  - imsid : String
- bmcRecon : boolean
  
  You can use the RECON keyword on the ANALYZE control statement to specify the names of a set of RECON data sets to examine during the CFA job.
  
  If you want CFA to examine multiple sets of RECON data sets, you must specify each set with a separate RECON keyword.
  
  If you specify the RECON keyword, your user ID must have Security Access Facility (SAF) READ access to the RECON data sets.
  
  You can specify from one to three data set names. One of the specified data set names must be designated as COPY1 by IMS.
  
  Example:
  The RECON data sets for the IMSA system are named IMSA.RECON1 and IMSA.RECON2, and the RECON data sets for the IMSB system are named IMSB.RECON1 and IMSB.RECON2. To examine IMSA and IMSB RECON data sets in the CFA job, specify the following keywords on the ANALYZE control statement:
  RECON=(IMSA.RECON1, IMSA.RECON2)
  RECON=(IMSB.RECON1, IMSB.RECON2)
  Note:
  If you specify the RECON keyword, you must specify the INTERVAL control statement with a START time value and a STOP time value.
- bmcTimezone : boolean
  You can use the TIMEZONE keyword on the ANALYZE control statement to specify how time values are interpreted when you are specifying time input values and when CFA is displaying time values in reports and on panels.
  Note:
  The default is TIMEZONE=LOCAL.
- bmcStartInterval : boolean
  You can use the START keyword on the INTERVAL control statement for the following purposes:
  
  Specify the beginning a range of log records to identify as candidates for the record selection process.
  
  Control the beginning of range of log data sets to allocate from RECON information.
  
  Reduce the overall number of log records that are selected from input SLDS or extract files.
- bmcStopInterval : boolean
  
  You can use the STOP keyword on the INTERVAL control statement for the following purposes:
  � Specify the end of a range of log records to identify as candidates for the record selection process
  � Control the end of range of log data sets to allocate from RECON information
  � Reduce the overall number of log records that are selected from input SLDS or extract files
- start
  - value : String
  - startDate : String
  - startlogSeq : String
- stop
  - value : String
  - stopDate : String
  - stoplogSeq : String
- tz
  - value : String
  - timezoneoffset : String
- jobInclude : String
- jobExclude : String
- psbInclude : String
- psbExclude : String
- maxlogsRc : String
  If you specify a value from 1 through 999 followed by literal R and a return code (08 through 99), Log Analyzer issues the specified return code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the return code at the conclusion of the RECON analysis phase without reading any input log data sets.
  
  Example:
  
  If you want Log Analyzer to issue return code 16 and terminate the job step if more than 10 log data sets would be read, specify the following keyword on the ANALYZE control statement:
  
  MAXLOGS=(10,R16)
- maxlogsAbend : String
  If you specify a value from 1 through 999 followed by an abend code (1 through 4095), Log Analyzer issues a user abend code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the user abend at the conclusion of the RECON analysis phase without reading any input log data sets.
  
  Example:
  
  If you want Log Analyzer to issue a user abend, with abend code U4000, if more than 120 log data sets would be read, specify the following keyword on the ANALYZE control statement:
  
  MAXLOGS=(120,4000)
- bmcJobInc : boolean
  This OPTION includes information for BMP jobs with the specified job names and omits information for all other jobs that CFA finds in the input logs.
- bmcJobExc : boolean
  This OPTION omits information for BMP jobs with the specified job names and includes information for all other jobs that CFA finds in the input logs. For jobName, specify the name of each job to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %)
- bmcPsbInc : boolean
  This OPTION includes information for BMP jobs with the specified PSB names and omits information for all other BMP jobs that CFA finds in the input logs
- bmcPsbExc : boolean
  This OPTION omits information for BMP jobs with the specified PSB names and includes information for all other BMP jobs that CFA finds in the input logs. For psbName, specify the name of each PSB to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %)
- bmcChkfreq : boolean
  You can use the CHKFREQ subkeyword in an APPCHECK expression to filter the information in the Application Checkpoint report, based on checkpoint frequency.
- bmcThresh : boolean
  You can use the THRESH subkeyword in an APPCHECK expression to specify the time unit to use for the threshold value in a checkpoint frequency filter. Valid values are MIN (minutes) and SEC (seconds). If you omit the THRESH subkeyword, CFA uses the default value MIN.
- bmcPrilog : boolean
  You can use the PRILOG keyword on the ANALYZE control statement to specify the logs type associated with the input RECON data set (or data sets) to use as input to the analysis process.
  You can select one of the following values:
  
  SLDS - Process SLDS associated with the input RECON data set (or data sets).
  
  DLI - Process DLI datasets associated with the input RECON data set (or data sets).
  
  BOTH - Process SLDS and DLI datasets associated with the input RECON data set (or data sets).
  
  Note:
  
  If you omit the PRILOG option, Log Analyzer uses the default value SLDS.
  
  If you select the SLDS keyword, you cannot specify the PRILOG keyword. The PRILOG keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.
- bmcAppcheck : boolean
  You can use the APPCHECK keyword on the REPORTS control statement to control production of the Application Checkpoint report.
- bmcAll : boolean
  To produce the Application Checkpoint report with default filters, specify APPCHECK=ALL. With this keyword, CFA includes all batch message processing (BMP) jobs that are found in the input logs, and does not filter the information by checkpoint frequency.
- bmcLsec : boolean
  You can use the LSEC subkeyword in an APPCHECK expression to display the LUOW information with job duration of less than a second for jobs in the Application Checkpoint report.
- chkfreqval : String
- bmcPlanInc : boolean
  This OPTION includes information for batch jobs with the specified Plan names and omits information for all other batch jobs that CFA finds in the input logs.
- planInclude : String
- bmcPlanExc : boolean
  This OPTION omits information for batch jobs with the specified Plan names and includes information for all other batch jobs that CFA finds in the input logs. For PlanName, specify the name of each Plan to include or exclude. You can specify multiple names (separated by commas). You can use wildcards (* and %).
- planExclude : String
- bmcSortby : boolean
  You can use the SORTBY subkeyword in an APPCHECK expression to sort the information in the Application Checkpoint report, based on either checkpoint frequency or start time.
- bmcCsv : boolean
  You can use the CSVRPT subkeyword to create output file in CSV form. Log Analyzer writes the CSV reports to SYSOUT-type data sets.
- bmcFullreport : boolean
  View Full report shows CSV file in MS excel application.
BMC DevOps for BMC AMI Change Manager for IMS TM Plugin
- server : String
  URL or IP address.
- port : String
  z/OSMF Port
- user : String
  z/OS user name
- pswd : String
- jclContent : String
- jclType : String
- dlist : String
  The DELTA List PDS member name is also the DELTA List name. Any valid PDS member name is acceptable to BMC AMI Change Manager for IMS TM.
- jobCard : String
- acctno : String
- dPds : String
  DELTA Lists for all BMC AMI Change Manager for IMS TM users are stored in the active DELTA List library (PDS).
  The DELTA List PDS is normally allocated with RECFM=VB, LRECL=259, and BLKSIZE=23476. Although the block size could be shortened or lengthened as needed, half-track blocking is recommended.
- dOptionsPds : String
  
  Specify the name of the data set where the BMC AMI Change Manager for IMS TM Global Options load module (DLP$GBL0) should be stored or retrieved.
  
  It is recommended that you use the same data set that contains the IMSID options modules (DLP#iiii), and Group options modules (DLPZgggg).
  
  This data set should have been created during BMC AMI Change Manager for IMS TM installation. JCL to allocate this data set is included in the BMC AMI Change Manager for IMS TM control library.
- target : String
  IMSID or GROUP NAME in which to execute the DELTA List.
- mode : String
  Option 'Optimize execution', instructs DELTA PLUS to attempt execution of the ENTIRE DELTA List as a single unit-of-work in IMS. This is the recommended mode due to the speed in which the request is executed.
  Note: You must select this option for a DELTA List that is defined as Dependent to execute in the fashion Dependent implies.
  
  Option 'One element at a time', instructs BMC AMI Change Manager for IMS TM to execute the DELTA List sequentially, one element at a time. This mode is much slower than Optimize execution mode. However, there are certain occasions when one element at a time is desirable. For example, transactions T1, T2 and T3 all require the MAXRGN parameter be changed from 3 to 4. Since they must be stopped before they can be revised, you want them stopped for the shortest amount of time possible. With Optimized mode, ALL the /STOP commands are done BEFORE the DELTA revise is done, and ALL the /START commands are done AFTER the revise is done. Using 'One element at a time' mode, the /STOP is done for T1, T1 is revised, then the /START command for T1 is issued before any activity takes place for T2 or T3.
  
  This mode contains suboption Pause after elements with errors which instructs BMC AMI Change Manager for IMS TM to stop the DELTA List execution when an error is encountered. For additional information on the Pause option, place the cursor on the phrase highlighted above, and press HELP (F1).
- ims_cmd : String
  
  It will process an EXECUTE input record to insert an IMS Command Element into the Delta List PDS Member.
  
  The EXECUTE input record format is as follows: EXECUTE /CMD Command_Parameters
  
  e.g.: EXECUTE /STO PROG PGMD
- title : String
  Title of the DELTA List. A maximum of 28 characters is allowed.
- notes : String
  Notes for the Delta List Member
- dlistRecords
  - action : String
  - elementType : String
  - elementName : String
  - ims_cmd : String
  - appnewname : String
  - appres : String
  - dbnewname : String
  - dbres : String
  - acc : String
  - auto : String
  - rand : String
  - randonly : String
  - rldareas : String
  - iovfext : String
  - dbrelgsam : String
  - dbcopyacb : String
  - apprelgsam : String
  - appcopyacb : String
  - ty : String
  - schd : String
  - appfp : String
  - dyn : String
  - gpsb : String
  - lang : String
  - apptls : String
  - rtcnewname : String
  - rtcinq : String
  - rtcpsbname : String
  - psb : String
  - trannewname : String
  - wfi : String
  - npri : String
  - lpri : String
  - lco : String
  - mseg : String
  - resp : String
  - cl : String
  - plc : String
  - time : String
  - para : String
  - uschd : String
  - traninq : String
  - recv : String
  - tranfp : String
  - emhs : String
  - mper : String
  - uc : String
  - edit : String
  - lsid : String
  - rsid : String
  - spa : String
  - spad : String
  - segs : String
  - oseg : String
  - msc : String
  - dc : String
  - mreg : String
  - ser : String
  - aoi : String
  - trantls : String
  - exptm : String
  - terminalmask : String
  - terminalnewname : String
  - sign : String
  - ltermmask : String
  - ltermnewname : String
  - ass : String
  - msn : String
  - l61 : String
  - subpoolmask : String
  - subpoolnewname : String
  - msg : String
  - bmcAppNew : boolean
  - bmcAppRes : boolean
  - bmcDbNewname : boolean
  - bmcDbRes : boolean
  - bmcAcc : boolean
  - bmcAuto : boolean
  - bmcRand : boolean
  - bmcRandOnly : boolean
  - bmcRldAreas : boolean
  - bmcIoVfExt : boolean
  - bmcDbCopyAcb : boolean
  - bmcDbRelGsam : boolean
  - bmcAppCopyAcb : boolean
  - bmcAppRelGsam : boolean
  - bmcTy : boolean
  - bmcSchd : boolean
  - bmcAppFp : boolean
  - bmcDyn : boolean
  - bmcGpsb : boolean
  - bmcLang : boolean
  - bmcApptls : boolean
  - bmcRtcsPsbName : boolean
  - bmcRtcInq : boolean
  - bmcRtcsNew : boolean
  - bmcPsb : boolean
  - bmcTranNewName : boolean
  - bmcWfi : boolean
  - bmcNpri : boolean
  - bmcLpri : boolean
  - bmcLco : boolean
  - bmcMseg : boolean
  - bmcResp : boolean
  - bmcCl : boolean
  - bmcPlc : boolean
  - bmcTime : boolean
  - bmcPara : boolean
  - bmcUschd : boolean
  - bmcTranInq : boolean
  - bmcRecv : boolean
  - bmcTranFp : boolean
  - bmcEmhs : boolean
  - bmcMper : boolean
  - bmcUc : boolean
  - bmcEdit : boolean
  - bmcLsid : boolean
  - bmcRsid : boolean
  - bmcSpa : boolean
  - bmcSpad : boolean
  - bmcSegs : boolean
  - bmcOseg : boolean
  - bmcMsc : boolean
  - bmcDc : boolean
  - bmcMreg : boolean
  - bmcSer : boolean
  - bmcAoi : boolean
  - bmcTls : boolean
  - bmcExptm : boolean
  - bmcTermMask : boolean
  - bmcTermNew : boolean
  - bmcSign : boolean
  - bmcLtermMask : boolean
  - bmcLtermNew : boolean
  - bmcAss : boolean
  - bmcMsn : boolean
  - bmcL61 : boolean
  - bmcSpMask : boolean
  - bmcSpNewName : boolean
  - bmcMsg : boolean
- dlpLoadLibs
  - lib : String
- vds : String
  (Optional)
  Specify the name of the member (the Variable Definition Set) in the Variable Definition Library that contains the variable definitions for this DELTA List. The Variable Definition Sets are members that contain the definitions for the symbolic variables used by BMC AMI Change Manager for IMS TM in DELTA List processing.
- goodRC : String
  Any value that is above the acceptable return code will be considered as FAILURE.
- dependent : boolean
- mark : boolean
  
  Select this field to inform BMC AMI Change Manager for IMS TM to execute Marked elements only.
  
  A beneficial use of this function is a DELTA List containing many elements that has failed. Instead of creating another DELTA List that contains corrections for the failed element(s) from the previous DELTA List, simply correct the error(s) in the original DELTA List, Mark only those elements which require execution, and select the 'Execute Marked elements only' option at DELTA List execution.
- coord : boolean
$class: 'BootPluginBuilder'
- tasks : String
  Provide a valid boot task, this could be a built in task or a user defined. Try 'boot help' for list of tasks.
- jvmOpts : String
  Specify JVM Options to be used within boot tasks.
$class: 'BranchDestructionStep'
- project : String
- branch : String
$class: 'BranchGenerationStep'
- projectConfig
  - pipelineConfig
    - destructor : boolean
    - authorisations : String
    - branchSCMParameter : boolean
    - branchParameters : String
    - generationExtension : String
    - pipelineGenerationExtension : String
    - disableDslScript : boolean
    - scriptDirectory : String
    - namingStrategy
      Nested Object
      projectFolderPath : String
      
      branchFolderPath : String
      
      projectSeedName : String
      
      projectDestructorName : String
      
      branchSeedName : String
      
      branchStartName : String
      
      branchName : String
      
      ignoredBranchPrefixes : String
    - eventStrategy
      Nested Object
      delete : boolean
      
      auto : boolean
      
      trigger : boolean
      
      commit : String
  - project : String
  - scmType : String
  - scmUrl : String
  - scmCredentials : String
  - triggerIdentifier : String
  - triggerType : String
  - triggerSecret : String
dotnetBuild
The dotnet build command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
1. An executable that can be used to run the application, if the project type is an executable targeting .NET Core 3.0 or later.
2. Symbol files used for debugging, with a .pdb extension.
3. A .deps.json file, which lists the dependencies of the application or library.
4. A .runtimeconfig.json file, which specifies the shared runtime and its version for an application.
5. Other libraries that the project depends on (via project references or NuGet package references).
(see also: Microsoft Documentation)
- charset : String (optional)
  The character set to use for the step's output. If not specified, the charset associated with the build will be used.
- configuration : String (optional)
  Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
- continueOnError : boolean (optional)
  If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
- force : boolean (optional)
  Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
- framework : String (optional)
  Compiles for a specific framework. The framework must be defined in the project file.
- noDependencies : boolean (optional)
  Ignores project-to-project references and only restores the root project.
- noIncremental : boolean (optional)
  Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
- noRestore : boolean (optional)
  Doesn't execute an implicit restore when running the command.
- nologo : boolean (optional)
  Doesn't display the startup banner or the copyright message.
  
  Available since: .NET Core SDK 3.0
- option : String (optional)
- options : Array / List of String (optional)
- optionsString : String (optional)
  For more information about these options, see the MSBuild Command-Line Reference.
  
  If targets and/or properties are also configured, those will be passed after these options.
- outputDirectory : String (optional)
  Directory in which to place the built binaries. If not specified, the default path is ./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a specific framework when you specify this option.
- project : String (optional)
  The MSBuild project or solution to build. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
- properties (optional)
  - Type: java.util.Map<java.lang.String, java.lang.String>
- propertiesString : String (optional)
  Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
- runtime : String (optional)
  Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the RID catalog.
- sdk : String (optional)
  Name of a .NET SDK to use so that dotnet will be in the path.
  If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
- showSdkInfo : boolean (optional)
  If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
- shutDownBuildServers : boolean (optional)
  If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
  
  Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
  
  Available since: .NET Core SDK 2.1
- specificSdkVersion : boolean (optional)
  Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
  By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
  
  Note: This will silently overwrite any global.json already present in the current directory.
- target : String (optional)
- targets : Array / List of String (optional)
- targetsString : String (optional)
  Specifies the MSBuild targets to build. If none are specified, the default target specified in the project will be built.
- unstableIfErrors : boolean (optional)
  If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
- unstableIfWarnings : boolean (optional)
  If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
- verbosity : String (optional)
  Sets the MSBuild verbosity level.
- versionSuffix : String (optional)
  Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
- workDirectory : String (optional)
  The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
reportBuild
- applicationName : String (optional)
- applicationVersion : String (optional)
- applicationComponent : String (optional)
- artifactFileName : String (optional)
- artifactFileSizeLimit : int (optional)
buildAddUrl
- title : String
- url : String
$class: 'BuildBuilder'
- dbFolder
  - value
    - Values: vcsroot, subfolder, scaproject
  - subfolder : String
  - projectPath : String
- packageid : String
  Enter an ID for the build artifact you want to build. Typically, this will be the same as your database name.
- tempServer
  - value : String
  - serverName : String
  - dbName : String
  - serverAuth
    - value : String
    - username : String
    - password
      Type: class hudson.util.Secret
  - encryptConnection : boolean
  - trustServerCertificate : boolean
- options : String
- dataOptions : String
- transactionIsolationLevel
  - Values: Serializable, Snapshot, RepeatableRead, ReadCommitted, ReadUncommitted
- filter : String
- packageVersion : String
  Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
- dlmDashboard
  - dlmDashboardHost : String
  - dlmDashboardPort : String
- sqlChangeAutomationVersionOption
  - value
    - Values: Latest, Specific
  - specificVersion : String
buildDescription
Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.
- descriptionTemplate : String
buildName
Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.
- nameTemplate : String
$class: 'BuildNameUpdater'
This plugin updates build name and description during the build process. Values to set could be stored in a file in the build workspace or in an environment variable.
- fromFile : boolean
- buildName : String
- fromMacro : boolean
- macroTemplate : String
- macroFirst : boolean
crxBuild
Create and build a content package on CRX by specifying a workspace filter, and then download it to the workspace to get archived as a backup, or as the beginning of a magical content package adventure, full of drama, suspense, and deployments to lower environments!
- packageId : String (optional)
  Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.
  
  A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version". The version may be omitted.
  
  This field supports parameter tokens.
- baseUrl : String (optional)
  Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.
  
  If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.
  
  For example, to override the Username without changing the associated password or private key, you may use the following form:
  
  http://deployer@localhost:4502
  
  To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:
  http://deployer:Password123@localhost:4502
  
  This field supports parameter tokens.
- credentialsId : String (optional)
  Select the login credentials for authenticating requests to the CRX server.
  
  [Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.
  
  Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- download : boolean (optional)
  Check this box to download the package after building it.
- localDirectory : String (optional)
  Specify a path relative to the workspace where the package will be downloaded (if the "Download" box is checked).
  
  This field supports parameter tokens.
- requestTimeout : long (optional)
  Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- serviceTimeout : long (optional)
  Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- waitDelay : long (optional)
  Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- wspFilter : String (optional)
  Specify a package workspace filter in a simple text format that will be applied to the package before build. This defines what content will be captured by the package.
  
  Simple spec is defined simply as a line-by-line format where:
  
  each line consists of significant text before an optional comment character (#)
  
  each line that begins with a "/" begins a new filter root.
  
  the first non-empty, non-comment line must define a new filter root
  
  each non-empty, non-comment line after a filter root that begins with a "+" or "-" defines an include or exclude rule, respectively. Everything following the "+" or "-" must be a valid regular expression
  
  Content is "covered" by a filter root if the content path starts with, or is the same as the filter root path. Once the "covering" filter root is identified, its include/exclude rules are evaluated from top to bottom, by matching the content path against each rule pattern (which is a Java regular expression). The last rule whose pattern matches the content path defines whether that content is included (line starts with "+") or excluded (line starts with "-"). If no rules are defined, all content covered by that root path is included
  
  For example, to include everything under /etc except for packages:
  
  /etc # define /etc as the filter root +/etc(/.*)? # include everything under /etc -/etc/packages(/.)? # exclude package paths
  To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
  
  /content/acme # include the site content /apps/acme # include the app code
  This field supports parameter tokens.
$class: 'BuildScanner'
Trigger automated Acunetix scans as part of your web application's build process
- profile : String
  The Scan Type used to scan the target
- target : String
  The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
- repTemp : String
  Generate a Report after the scan completes. The report is available for download from Acunetix backend within a time frame of one hour
- threat : String
  The Threat Level (High, Medium, Low) to fail the build on
- stopScan : boolean
  If selected, the scan will be stopped if the build fails (Threat Level is reached)
- svRep : boolean
  Option to download the report in the project workspace from where it can be used for other operations like attaching to an email or archiving.
  Note: Archiving can be done with "Archive the artifacts" post-build action
- incScan : boolean
  This will create an Incremental scan. The first scan will scan all the site. Subsequent scans will only scan the changes in the site, resulting in smaller scans.
- incScanId : String
- stopTargetScans : boolean
  This is useful when older versions of the web application are discarded by the CI/CD when an updated version is created.
$class: 'BuildStepBuilder'
- sourceFolderMode : String
- subfolder : String
- packageId : String
- serverType : String
- server : String
- authenticationType : String
- userName : String
- password
  - Type: class hudson.util.Secret
- database : String
- compareOptions : String (optional)
- filterFile : String (optional)
- transactionIsoLvl : String (optional)
$class: 'BuildStepWithTimeout'
- buildStep : Build Step (hudson.tasks.BuildStep)
- strategy
  - $class: 'AbsoluteTimeOutStrategy'
    Terminate a build based on a fixed time-out period.
    
    timeoutMinutes : String
    If configured, and if a build does not complete by the specified amount of time (in minutes; at least 3), then the build will be terminated automatically. This is useful if you have experienced infinite loops in your test, for example.
  - $class: 'DeadlineTimeOutStrategy'
    Terminate a build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
    
    deadlineTime : String
    If configured, and if a build does not complete by next deadline time (specified in 24-hour format as HH:MM:SS or HH:MM), then the build will be terminated automatically.
    Variable references are allowed to define deadline time.
    
    deadlineToleranceInMinutes : int
    Period in minutes after the deadline time when a build should be immediately terminated. E.g. if deadline is defined as "13:50", tolerance as "5" minutes and build is scheduled to run at "13:52" it will be immediately terminated. However if it is scheduled at "13:56", build's deadline will be set at "13:50" of next day.
  - $class: 'ElasticTimeOutStrategy'
    Terminate a build based on a specified percentage of the mean of the duration of the n most recent non-failing builds.
    
    timeoutPercentage : String
    If a build takes longer than this percentage of the n most recent non-failing builds, the build will be terminated. If there are no such builds, the "Timeout minutes" field will be used instead.
    
    timeoutMinutesElasticDefault : String
    
    numberOfBuilds : String
    
    failSafeTimeoutDuration : boolean
  - $class: 'LikelyStuckTimeOutStrategy'
    Terminate a build when it has taken many times longer than previous ones.
  - $class: 'NoActivityTimeOutStrategy'
    Terminate a build when there has not been any log output since the last n seconds.
    
    timeoutSecondsString : String
    Seconds to detect timeout since the last log output. This is useful to terminate a build if there has not been any activity for a long time. Be careful with log output delay for buffering.
  - $class: 'RunConditionTimeoutStrategy'
    Sets a conditional timeout. The strategy will take a timeout from a first matching condition. The default value will be used if all evaluations fail or return false.
    This extension uses run condition as condition sources.
    
    conditions
    Array / List of Nested Object
    condition
    A Run Condition to be evaluated.
    
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    timeout : long
    Timeout in minutes, which will be set if the condition above returns true.
    
    defaultTimeout : long
    A default timeout in minutes. This value will be used if all condition evaluations fail or return false.
- operationList
  - $class: 'AbortAndRestartOperation'
    maxRestarts : String
    Count of maximum restarts. 0 means without a limit.
  - $class: 'AbortOperation'
    Abort the build. This is a default operation performed if no operations are specified.
  - $class: 'BuildStepOperation'
    Perform a build step or a post-build action as a timeout action.
    This never ensure all build steps and post-build actions works correct.
    
    buildstep : Build Step (hudson.tasks.BuildStep)
    
    continueEvenFailed : boolean
    Continue subsequent timeout actions even when the build step failed. If unchecked, subsequent timeout actions is not executed, and the build will be marked as failure.
    
    createLauncher : boolean
    Build steps like "Execute shell", "Execute Windows batch command" and so on, requires Launcher object to execute an external program. Build Timeout does not provide Launcher for build steps by default and those build steps fail. Checking here provides the build step a new created Launcher. You should not check here as long as the build step can run without this (that is, it does not require an external program).
  - $class: 'FailOperation'
    The build will be marked as failed.
  - $class: 'WriteDescriptionOperation'
    Writing the build description.
    
    description : String
    A description to set. {0} will be replaced with timeout minutes.
$class: 'BuildStepsFromJsonBuilder'
$class: 'BuildoutBuilder'
- pythonName : String
- buildoutCfg : String
- nature : String
- command : String
- ignoreExitCode : boolean
byteguardGreet
- token : String
- task_id : String
$class: 'CFLaunchBuilder'
- cfComposition : String
- setCFVars
  - vars
    - Variable : String
    - Value : String
$class: 'CIMessageBuilder'
- providerData (optional)
  - activeMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    messageProperties : String (optional)
    
    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
    
    messageType (optional)
    
    Type of CI message to be sent.
    
    Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - activeMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    selector : String (optional)
    
    JMS selector to choose messages that will fire the trigger.
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - fedmsgPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - fedmsgSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - rabbitMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    fedoraMessaging : boolean (optional)
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    schema : String (optional)
    
    Path to message schema.
    
    severity : int (optional)
    
    Severity of the message.
  - rabbitMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
$class: 'CIMessageSubscriberBuilder'
Subscribe to the CI message bus and wait for a message matching the specified JMS selector.

The variable value specifies the name of an environment variable in which to place the received message body.

The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
- providerData (optional)
  - activeMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    messageProperties : String (optional)
    
    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
    
    messageType (optional)
    
    Type of CI message to be sent.
    
    Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - activeMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    selector : String (optional)
    
    JMS selector to choose messages that will fire the trigger.
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - fedmsgPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - fedmsgSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - rabbitMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    fedoraMessaging : boolean (optional)
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    schema : String (optional)
    
    Path to message schema.
    
    severity : int (optional)
    
    Severity of the message.
  - rabbitMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
$class: 'CRDABuilder'
- file : String (optional)
- crdaKeyId : String (optional)
- cliVersion : String (optional)
  You must provide the CRDA cli version for the analysis. To see all versions click on CRDA CLI . Check the Readme for the compatible versions with the plugin.
- consentTelemetry : boolean (optional)
  
  CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
execMan
- requestType : String (optional)
- altCTMConfig (optional)
  Optional alternative Continuous Testing Manager configuration. If provided, these parameters override those specified in Jenkins global configuration.
  - url : String
  - credentials : String
- execParams (optional)
  Optional execution request parameters. Both a key and value must be specified. The value can refer to Jenkins environment variables using this syntax - ${JENKINS_ENV_VAR}. For example - ${BUILD_ID}.
  - list (optional)
    - key : String
    - value : String
- postExecute (optional)
  Optional post execution action. To perform any post action, provide action name along with the need parameters.
  - action : String
  - params : String
- request (optional)
  Select this to run a pre-defined Suite configured on the Continuous Testing Manager.
  - name : String
- waitConfig (optional)
  Optional execution request wait configuration. Both the polling interval and maximum run time must be specified in seconds.
  - pollInterval : String
  - maxRunTime : String
$class: 'CToolBuilder'
Executes a tool of the CMake-suite with arbitrary command-line arguments.
Useful to run cmake in script mode (cmake -P <script file>) or command mode (cmake -E <command>).
- installationName : String
- arguments : String (optional)
- ignoredExitCodes : String (optional)
- toolId : String (optional)
- workingDir : String (optional)
generateCache
Generate ECU-TEST file caches (A2L, ELF, Bus, Model and Service caches are supported).
- caches
  - type
    - Values: A2L, ELF, BUS, MODEL, SERVICE
  - filePath : String
  - dbChannel : String
  - clear : boolean
$class: 'CallFunction'
Call a function You can choose:
- Function name
- Function Arguments
- functionName : String (optional)
- argumentList : Array / List of String (optional)
- argument : String (optional)
$class: 'CallOtherJenkinsBuilder'
- hostName : String
- jobName : String
- span : String
- retry : String
- userName : String
- password : String
- parameters : String
$class: 'CaptureIOSDeviceScreenshot'
Captures a screen shot from each connected iOS device. The image will be stored in a TIFF file matching the device's UDID (e.g. 3c701dda15e238cf3f2831346067751a5c942297.tiff).
- url : String
- cloudTestServerID : String
  Select the server to download iOSAppInstaller.zip from.
- additionalOptions : String
  If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.
carbonetes
- name : String
- credentialsId : String (optional)
- engineTimeout : int (optional)
- failBuildOnPluginError : boolean (optional)
- failBuildOnPolicyEvaluationFailResult : boolean (optional)
- image : String (optional)
- policyBundleID : String (optional)
- registryURI : String (optional)
carl
- installationName : String
- sourcePath : String
- applicationName : String
- archivePdf : boolean (optional)
- displayLog : boolean (optional)
- logPath : String (optional)
- outputPath : String (optional)
- qualityGate : String (optional)
venafiVcertRequestCertificate
- connectorName : String
- zoneConfigName : String
  The name of the zone configuration to use.
  
  When using Venafi as a Service, zone names are in the format of app name\api alias
- commonName : String
- privKeyOutput : String
- certOutput : String
- certChainOutput : String
- country : String (optional)
- dnsNames (optional)
  - hostName : String
- emailAddresses (optional)
  - address : String
- expirationWindow : int (optional)
  Number of hours before certificate expiry to request a new certificate.
- ipAddresses (optional)
  - address : String
- keyType (optional)
  - Values: RSA, ECDSA
- locality : String (optional)
- organization : String (optional)
- organizationalUnit : String (optional)
- province : String (optional)
changeAsmVer
This build step can be used to change the version in the AssemblyInfo.cs file from a .NET Project, it's going to find every AssemblyInfo.cs file in the workspace and change the version from [AssemblyVersion] and [AssemblyFileVersion] attributes. It's recommended to use this plugin with the auto-generated AssemblyInfo.cs from VisualStudio.
- versionPattern : String
- assemblyCompany : String (optional)
- assemblyCopyright : String (optional)
- assemblyCulture : String (optional)
- assemblyDescription : String (optional)
- assemblyFile : String (optional)
  Set the file name to search. If the value is empty the default filename is : **/AssemblyInfo.cs. You can use an ant fileset pattern.
- assemblyProduct : String (optional)
- assemblyTitle : String (optional)
- assemblyTrademark : String (optional)
- regexPattern : String (optional)
  Regex Pattern in which version is stated. Specify this value if you want to use for versioning other than assembly files (e.g. visual studio extensions .vsix). For assembly (.dll) versioning you do not need to specify anything here.
- replacementPattern : String (optional)
  Version value specified in regexPattern will be replaced by this. Use if you want versioning other than assembly files. e.g. "Version(\"%s\")" where %s will be new version number. For assembly (.dll) versioning keep this field blank.
$class: 'ChangeEventBuilder'
Create Change Events on PagerDuty services as Jenkins build steps.
- integrationKey : String
  This is the 32 character Integration Key for an Integration on a Service, or a token that resolves to the key.
- customDetails : String (optional)
  The JSON to be included in the custom details of the change event. Token macro substitution is enabled for this field.
- summaryText : String (optional)
  This is an alternate summary text, that can be passed onto Pager duty change events. If omitted it will default to current build's fullDisplayName.
chatterPost
Simple step for posting a Chatter buildUrlTitle/body to a specified channel or the user's wall.
Usage Example:
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
- credentialsId : String
  Utilizes the Credentials Plugin's Username with Password credentials storage to communicate with Chatter.
  If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
  
  See Identity Confirmation in the salesforce.com online help for more information.
- body : String
  The body text for your Chatter post
- buildUrlTitle : String (optional)
  The buildUrlTitle for your Chatter post. If left blank, the title will be set to your job/pipeline name and number (JOB_NAME BUILD_DISPLAY_NAME)
- recordId : String (optional)
  Id of record to chatter to (e.g. a group, or a custom object), leave blank to chatter to user's wall.
- server : String (optional)
  If left blank will connect to production, if you want to connect to a sandbox or have the my domains feature enabled, enter URL of alternative login server, e.g. https://test.salesforce.com
$class: 'CheckGate'
- pipelineId : String
- stageName : String
- versionId : String
- fatal : String
$class: 'CheckGateBuilder'
- project : String
  Select project.
- gate : String
checkmarxASTScanner
- useOwnServerCredentials : boolean (optional)
- serverUrl : String (optional)
  The base URL of your CxAST environment.
- useAuthenticationUrl : boolean (optional)
  The base URL of your Checkmarx authentication server (IAM). Required for CxAST cloud platform.
- baseAuthUrl : String (optional)
- tenantName : String (optional)
- projectName : String (optional)
  The name of your Project in CxAST. If you enter the name of an existing Project, then this build step will trigger a scan of that Project. If you enter a new Project name, then, when a scan is triggered it will create a new Project in CxAST with the specified name.
- credentialsId : String (optional)
  Create "Checkmarx Client Id and Client Secret" type credentials in Jenkins and enter your oAuth2 clientId and secret. This will be used to authenticate access to the CxAST platform whenever a scan is triggered.
- useOwnAdditionalOptions : boolean (optional)
- additionalOptions : String (optional)
  You can customize your scan by adding additional arguments. The Jenkins plugin supports all CxAST CLI arguments. See documentation here
  e.g- --sast-incremental true
- branchName : String (optional)
- checkmarxInstallation : String (optional)
  Select the Checkmarx CLI installation in Jenkins that will be used for triggering scans. This should have been configured in the Jenkins Global Tool Configuration section.
chlAtuoAction
- content : String
- browserString : String
- runScriptOnly : boolean
- rootPath : String
- libPath : String
$class: 'ChrootBuilder'
- chrootName : String
- ignoreExit : boolean
  The build will always succeed.
- additionalPackages : String
  Additional packages to install into the chroot environment by 'apt-get'. These packages are persisted in the tarball to speed up subsequent builds. If you don't want this bahaviour use the 'Clear' option.
- packagesFile : String
  Enter a list of comma separated relative paths to files in the workspace, which contain additionals packages for apt-get to install. Such files might be placed in a git repository wich is previously checked out.
- clear : boolean
  Uses a fresh copied chroot tarball without packages installed from previous runs. The build will take longer but the build results will be more meaningful.
- command : String
- loginAsRoot : boolean
  When this box is unchecked the subsequent commands are run inside chroot as a user with the same uid and gid as jenkins does. Whenever possible leave this box unchecked, but e. g. for testing installations it might be important to be root.
- noUpdate : boolean
  When this option is enabled, the repository indices are only updated if extra packages are going to be installed. When disabling repository updates, self contained builds, which do not have to install packages, will run faster. Because packages can also be installed from commands within the buildstep, by default, the package indices are always updated.
- forceInstall : boolean
  This option allows to force the installation of the specified packages. The underlying container will do whatever it can do to fulfill this request. This allows actions like downgrading, installing untrusted packages, etc.
$class: 'CifsBuilderPlugin'
- publishers
  - configName : String
  - verbose : boolean
  - transfers
    - sourceFiles : String
    - excludes : String
    - remoteDirectory : String
    - removePrefix : String
    - remoteDirectorySDF : boolean
    - flatten : boolean
    - cleanRemote : boolean
    - noDefaultExcludes : boolean
    - makeEmptyDirs : boolean
    - patternSeparator : String
  - useWorkspaceInPromotion : boolean
  - usePromotionTimestamp : boolean
  - retry
    - retries : int
    - retryDelay : long
  - label
    - label : String
- continueOnError : boolean
- failOnError : boolean
- alwaysPublishFromMaster : boolean
- masterNodeName : String
- paramPublish
  - parameterName : String
$class: 'ClangScanBuildBuilder'
Use this option to execute clang scan-build against and XCode project.
- target : String
  Provide the exact name of the XCode target you wish to have compiled and analyzed. You can use targets for all versions of XCode. This field is not required if you are using XCode and providing workspace and scheme.
- targetSdk : String
  This should be set the simulator version of a currently installed SDK. For later versions of XCode, you can set this value to 'iphonesimulator' to automatically use the latest available version of the SDK. If this does not work, you can identify a specific version by issuing the following command in Terminal:
  
  xcodebuild -showsdks
  
  It should typically look like 'iphonesimulator4.2' where the version number may change depending on your XCode installation.
- config : String
  Provide the XCode config you wish to execute scan-build against. It is recommended that you always use 'Debug' because this will allow clang to use assertions to eliminate false positives.
- clangInstallationName : String
- xcodeProjectSubPath : String
  If your XCode project is located in a sub-folder of this job's workspace, provide the path here relative to the workspace. e.g. myProj/subfolder
- workspace : String
  In XCode 4 and later, you are able to configure named workspaces which are basically containers for multiple XCode projects. If your build requires a workspace, please provide its name in this field. When you provide a workspace you are XCode requires that you also provide a scheme.
- scheme : String
  If you are leveraging XCode workspaces and schemes, provide the name of your scheme here.
- scanbuildargs : String
  This field can be used to pass additional arguments to clang scan-build. The arguments will appear before the xcodebuild sub command. You can view the assembled command by viewing the job's build console.
  
  scan-build uses the 'clang' executable relative to itself for static analysis by default.
  --use-analyzer Xcode using the 'clang' packaged with Xcode (on OS X)
  --use-analyzer [path to clang] to use the 'clang' from 'path to clang' or $PATH if no path specified.
- xcodebuildargs : String
  This field can be used to pass additional arguments to clang scan-build. The arguments will appear after the xcodebuild sub command. You can view the assembled command by viewing the job's build console.
  
  -derivedDataPath $WORKSPACE/build is to save build products and other derived data to build directory under current workspace
- outputFolderName : String
googleStorageUpload
- credentialsId : String
- bucket : String
- pattern : String
- pathPrefix : String (optional)
- sharedPublicly : boolean (optional)
- showInline : boolean (optional)
dotnetClean
The dotnet clean command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.

(see also: Microsoft Documentation)
- charset : String (optional)
  The character set to use for the step's output. If not specified, the charset associated with the build will be used.
- configuration : String (optional)
  Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project. This option is only required when cleaning if you specified it during build time.
- continueOnError : boolean (optional)
  If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
- framework : String (optional)
  The framework that was specified at build time. The framework must be defined in the project file. If you specified the framework at build time, you must specify the framework when cleaning.
- nologo : boolean (optional)
  Doesn't display the startup banner or the copyright message.
  
  Available since: .NET Core SDK 3.0
- option : String (optional)
- options : Array / List of String (optional)
- optionsString : String (optional)
  For more information about these options, see the MSBuild Command-Line Reference.
  
  If targets and/or properties are also configured, those will be passed after these options.
- outputDirectory : String (optional)
  The directory that contains the build artifacts to clean. If you specified the framework when the project was built, that same framework should also be specified for this cleanup action.
- project : String (optional)
  The MSBuild project or solution to clean. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
- properties (optional)
  - Type: java.util.Map<java.lang.String, java.lang.String>
- propertiesString : String (optional)
  Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
- runtime : String (optional)
  Cleans the output folder of the specified runtime. This is used when a self-contained deployment was created.
- sdk : String (optional)
  Name of a .NET SDK to use so that dotnet will be in the path.
  If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
- showSdkInfo : boolean (optional)
  If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
- shutDownBuildServers : boolean (optional)
  If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
  
  Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
  
  Available since: .NET Core SDK 2.1
- specificSdkVersion : boolean (optional)
  Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
  By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
  
  Note: This will silently overwrite any global.json already present in the current directory.
- unstableIfErrors : boolean (optional)
  If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
- unstableIfWarnings : boolean (optional)
  If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
- verbosity : String (optional)
  Sets the MSBuild verbosity level.
- workDirectory : String (optional)
  The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
cleanPerformanceMeasurement
- cleanMeasurement : boolean (optional)
- cleanRCA : boolean (optional)
- cleanRTS : boolean (optional)
examCleanTarget
validNetwork
- username : String
- password : String
- projectId : String
- filepath : String
$class: 'ClifBuilder'
- clifName : String
- clifOpts : String
- testPlanFile : String
- reportDir : String
$class: 'CloudBuildBuilder'
This build step invokes Google Cloud Build.
- input
  - credentialsId : String
  - request
    - file
      
      filename : String
      The path to the YAML build request file to pass to Google Cloud Build.
    - inline
      
      request : String
      The YAML Build Request to pass to Google Cloud Build.
  - source (optional)
    - local
      
      path : String
      The source to use in the build request. This may be either:
      
      A path to a file within the workspace. The file must be a compressed gzipped tarball (.tgz or .tar.gz) or zip file (.zip), or
      
      A path to a directory within the workspace. The contents of the directory will be archived as a gzipped tarball (.tgz) and uploaded to a temporary Cloud Storage bucket.
    - repo
      
      branch : String (optional)
      
      commit : String (optional)
      
      projectId : String (optional)
      ID of the project that owns the repo. If omitted, the project ID requesting the build is assumed.
      
      repoName : String (optional)
      Name of the repo. If omitted, the name "default" is assumed.
      
      tag : String (optional)
    - storage
      
      bucket : String
      
      object : String
  - substitutionList (optional)
    - items
      User-defined substitutions to be added to the build request. The set of user-defined substitutions referenced in the build request must exactly match the set of substitutions defined here. For details, see Build Requests - User-defined substitutions.
      
      Array / List of Nested Object
      key : String
      The name of the user-defined substitution. This must begin with an underscore (_) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
      
      value : String
      The value of the user-defined substitution. This must not expand to longer than 100 characters. For details, see Build Requests - User-defined substitutions.
  - substitutions (optional)
    - Type: java.util.Map<java.lang.String, java.lang.String>
pushToCloudFoundry
- target : String
- organization : String
- cloudSpace : String
- credentialsId : String
- manifestChoice (optional)
  - appName : String (optional)
  - appPath : String (optional)
  - buildpack : String (optional)
  - command : String (optional)
  - domain : String (optional)
  - envVars (optional)
    - key : String
    - value : String
  - hostname : String (optional)
  - instances : String (optional)
  - manifestFile : String (optional)
  - memory : String (optional)
  - noRoute : String (optional)
  - servicesNames (optional)
    - name : String
  - stack : String (optional)
  - timeout : String (optional)
  - value : String (optional)
- pluginTimeout : String (optional)
- selfSigned : String (optional)
- servicesToCreate (optional)
  - name : String
  - type : String
  - plan : String
  - resetService : boolean (optional)
cloudhubDeployer
- environmentId : String
- orgId : String
- appName : String
  The application name identifies your application not only in Runtime Manager but also in the public cloudhub.io domain. For example, an application named myapplication is accessible at http://myapplication.cloudhub.io. To avoid domain conflicts, the application name must be globally unique across CloudHub.The application name can contain between 3 and 42 alphanumeric characters (a-z, A-Z, 0-9) and dashes (-). They cannot contain spaces or other characters.
- muleVersion : String
  The runtime version must be the same Mule version used to develop your application.
- filePath : String
  Workspace-relative path of the artifact file to upload (it should resolve to a single file). Can use wildcards like module/dist/**/*.jar, See the @includes of Ant fileset for the exact format. Examples: File, like target/my-mule-app.jar or target/**/*.jar : The jar file will be uploaded to cloudhub.
- credentialsId : String (optional)
  Jenkins credentials containing The Anypoint Platform account username and password with sufficient access to perform deployment related activities on CloudHub.
- requestMode (optional)
  Type of Operation to perform on CloudHub. CREATE - Deploy/Create new application UPDATE - Update application with new package and settings provided. UPDATE_FILE - Update just the zip/jar file of application, rest all settings ignored. CREATE_OR_UPDATE - Deploy/Create new application(if not already present) or update the existing application. RESTART - Restart the application already present. DELETE - Delete the application.
  - Values: CREATE, UPDATE, CREATE_OR_UPDATE, UPDATE_FILE, RESTART, DELETE
- region : String (optional)
  If you have global deployment enabled on your account, you can change the deployment region.
- autoScalePolicy (optional)
  - autoScalePolicyName : String (optional)
    The auto scaling policy name.
  - enableAutoScalePolicy : boolean (optional)
  - id : String (optional)
  - maxScale : int (optional)
    The maximum number of workers or size of workers for auto scaling. Allowed Values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
  - minScale : int (optional)
    The minimum number of workers or size of workers for auto scaling. Allowed values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
  - scaleBasedOn : String (optional)
    The metric based on which auto scaling policy scales. Allowed values: CPU, MEMORY
  - scaleDown (optional)
    - Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
  - scaleDownNextScaleWaitMins : int (optional)
    Number of minutes to wait before applying new scale down policy.
  - scaleDownPeriodCount : int (optional)
    The time in minutes to monitor the CPU/memory for low usage before scaling down.
  - scaleDownValue : int (optional)
    The CPU or memory usage below which scale down policy will take effect.
  - scaleType : String (optional)
    The scale type of the auto scaling policy. Allowed values: WORKER_COUNT, WORKER_SIZE
  - scaleUp (optional)
    - Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
  - scaleUpNextScaleWaitMins : int (optional)
    Number of minutes to wait before applying new scale up policy.
  - scaleUpPeriodCount : int (optional)
    The time in minutes to monitor the CPU/memory for high usage before scaling up.
  - scaleUpValue : int (optional)
    The CPU or memory usage above which scale up policy will take effect.
- autoStart : boolean (optional)
  Check this flag to autostart the application after it is deployed
- debugMode (optional)
  Use this to log additional details/info from the http requests.
  - Values: ENABLED, DISABLED
- enableAutoScalePolicy : boolean (optional)
- envVars (optional)
  you can specify properties (key-value pairs) that the application uses during deployment and while running.
  - key : String (optional)
  - value : String (optional)
- ignoreGlobalSettings : boolean (optional)
  If checked settings from global configuration will be used that are under manage jenkins.
- logLevels (optional)
  You can configure the logging level (DEBUG, WARN, ERROR, or INFO) for the application
  - levelCategory (optional)
    - Values: DEBUG, WARN, ERROR, INFO
  - packageName : String (optional)
- loggingNgEnabled : boolean (optional)
  Check this if you want to use your own logging solution using Log4j configuration.
- monitoringAutoRestart : boolean (optional)
  CloudHub automatically restarts your application when the monitoring system discovers an issue.
- monitoringEnabled : boolean (optional)
  Use Anypoint Monitoring and Visualizer for Mule applications running on supported versions of Mule.
- objectStoreV1 : boolean (optional)
  Object Store v2 is enabled by default in Mule 4. In Mule 3, select this option to use Object Store v1.
- persistentQueues : boolean (optional)
  You can use persistent queues on your application to store data in an input queue to disk. Persistent queues protect against message loss and enable you to distribute workloads across a set of workers.
- persistentQueuesEncrypted : boolean (optional)
  If you enable persistent queues, you can optionally encrypt the data stored in the input queue on disk.
- timeoutConnection : int (optional)
  Max time to try before failing the request.
- timeoutResponse : int (optional)
  Max time to wait for response before failing the request.
- verifyDeployments : boolean (optional)
  Verify if API is stated after deployment.
- verifyIntervalInSeconds : int (optional)
- workerAmount : int (optional)
  No of workers to run for API.
- workerCpu : String (optional)
  Compute Capacity for each worker(vCores). Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 2 or 16
- workerMemory : String (optional)
  Heap memory (Or Ram) for each worker. Check MuleSoft Documentation for available sizes (worker-size-and-vcores. Example Values :- "500 MB", "1.5 GB" or "32 GB"
- workerType : String (optional)
  Type of worker to use "Micro", "Small", "Medium" or "Large". Check MuleSoft Documentation for additional details.
- workerWeight : String (optional)
  Weight for worker type. Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 0.2 or 1
$class: 'CloudShellConfig'
- buildStep
  - $class: 'StartSandbox'
    blueprintName : String
    Enter the name or id of a CloudShell blueprint.
    
    sandboxDuration : String
    The sandbox duration in minuets.
    
    maxWaitForSandboxAvailability : int
    Enter the number of minutes to wait until the Sandbox becomes available in case no resources are available to reserve it.
    
    setupTimeout : int
    Enter the number of minutes to wait for the sandbox setup to complete
    
    params : String (optional)
    Blueprint Parameter in this syntax: "input1=my_name; input2=30"
    
    sandboxDomain : String (optional)
    Sandbox will be created in the following domain.
    
    sandboxName : String (optional)
    Sandboxes will be created with this name instead of the blueprint name.
$class: 'CmakeBuilder'
Uses CMake to generate build-scripts and can run these.
This causes Jenkins to invoke cmake -G with the given options.
Any non-zero exit code during build-script generation causes Jenkins to mark the build as a failure.
It also can expose the CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
- installationName : String
- buildDir : String (optional)
- buildType : String (optional)
- cleanBuild : boolean (optional)
- cmakeArgs : String (optional)
- generator : String (optional)
- preloadScript : String (optional)
- sourceDir : String (optional)
- steps (optional)
  - args : String (optional)
    Specify arguments to pass to the build tool or to cmake. Arguments must be separated by spaces but may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
    Most of the time, you will want to leave this empty (to call the default build target) or you will specify just some build target names here.
  - envVars : String (optional)
    Specify extra environment variables to pass to the build tool as key-value pairs here.
    Each entry must be on its own line, for example:
    DESTDIR=${WORKSPACE}/artifacts/dir KEY=VALUE
  - withCmake : boolean (optional)
    Whether to run the actual build tool directly (by expanding $CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
    
    Leave unchecked for minimal performance overhead.
    
    Make it checked, if you selected one of the Visual Studio or Xcode generators above AND if you run CMake v. 2.8.11 or newer.
$class: 'CocoaPodsBuilder'
- cleanpods : boolean
  If checked the "pod" folder will be deleted before updating the pods
$class: 'CodeBuilder'
- credentialsType : String
- credentialsId : String
- proxyHost : String
- proxyPort : String
- awsAccessKey : String
- awsSecretKey
  - Type: class hudson.util.Secret
- awsSessionToken : String
- region : String
- projectName : String
- sourceVersion : String
- sseAlgorithm : String
- sourceControlType : String
- localSourcePath : String
- workspaceSubdir : String
- gitCloneDepthOverride : String
- reportBuildStatusOverride : String
- secondarySourcesOverride : String
- secondarySourcesVersionOverride : String
- artifactTypeOverride : String
- artifactLocationOverride : String
- artifactNameOverride : String
- artifactNamespaceOverride : String
- artifactPackagingOverride : String
- artifactPathOverride : String
- artifactEncryptionDisabledOverride : String
- overrideArtifactName : String
- secondaryArtifactsOverride : String
- envVariables : String
- envParameters : String
- buildSpecFile : String
- buildTimeoutOverride : String
- sourceTypeOverride : String
- sourceLocationOverride : String
- environmentTypeOverride : String
- imageOverride : String
- computeTypeOverride : String
- cacheTypeOverride : String
- cacheLocationOverride : String
- cacheModesOverride : String
- cloudWatchLogsStatusOverride : String
- cloudWatchLogsGroupNameOverride : String
- cloudWatchLogsStreamNameOverride : String
- s3LogsStatusOverride : String
- s3LogsEncryptionDisabledOverride : String
- s3LogsLocationOverride : String
- certificateOverride : String
- serviceRoleOverride : String
- insecureSslOverride : String
- privilegedModeOverride : String
- cwlStreamingDisabled : String
- exceptionFailureMode : String
- downloadArtifacts : String
- downloadArtifactsRelativePath : String
- workspaceExcludes : String (optional)
- workspaceIncludes : String (optional)
$class: 'CodeCoverageBuilder'
- connectionId : String
- credentialsId : String
- analysisPropertiesPath : String
- analysisProperties : String
codescene
- credentialsId : String
  Select username/password credentials defined in Jenkins configuration. This is a safe way to use credentials in Jenkins plugin. See Injecting Secrets into Jenkins Build Jobs for more details.
- deltaAnalysisUrl : String
- repository : String
- analyzeBranchDiff : boolean (optional)
- analyzeLatestIndividually : boolean (optional)
  Commits not seen in previous successful builds will be used for separate delta analyses.
- baseRevision : String (optional)
- couplingThresholdPercent : int (optional)
- failOnDecliningCodeHealth : boolean (optional)
  Check this option to mark the build as unstable if the Code Health of a hotspot declines.
- failOnFailedGoal : boolean (optional)
  Check this option to mark the build as unstable if a goal -- as defined by CodeScene's Intelligent Notes -- is violated. This could be a supervised hotspot that suddenly declines in Code Health, or a module indicated as No Problem that starts to accumulate complex code, etc.
- letBuildPassOnFailedAnalysis : boolean (optional)
  By default we fail the build if CodeScene couldn't run an analysis (e.g. couldn't update the repository). This behaviour can be overridden here.
- markBuildAsUnstable : boolean (optional)
- originUrl : String (optional)
- riskThreshold : int (optional)
$class: 'CodeStreamBuilder'
- serverUrl : String
  vRealize Automation host.
- userName : String
  User name
- password : String
  Password
- tenant : String
  Tenant
- pipelineName : String
  CodeStream pipeline name. Please not only latest version of this pipeline will be executed.
- waitExec : boolean
- pipelineParams
  - value : String
  - name : String
CodeThreatScan
- ctServer : String
- max_number_of_critical : int
- max_number_of_high : int
- weakness_is : String
- condition : String
- project_name : String
- fileName : String
- credentialsId : String
$class: 'CodefreshPipelineBuilder'
- selectPipeline
  Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
  - cfPipeline : String
  - cfBranch : String
- setCFVars
  - vars
    - Variable : String
    - Value : String
$class: 'CommentsRemoverBuilder'
- filename : String
  Name of the input file to have comments removed from
- language : String
  Language of the input file - helps locate comments
- outputDir : String
  After execution the result will be in this directory in the workspace
$class: 'CompareBuilder'
Compare two different schemas (from database, repository or snapshot). Based on it you can do in the next steps further actions (like generating report or alter script)
- outputFolder : String
  Path to the folder in that should be used to store compare output.
  It serves as input for following steps like Generate create SQL script or Generate Report.
  
  Folder location must be specified as:
  
  Absolute path to location on your Jenkins master node
  
  Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
  
  Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}/dir.
- srcInputType : String
- tgtInputType : String
- srcInputFileOrFolder : String
  Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Snapshot - input is snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- tgtInputFileOrFolder : String
  Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Snapshot - input is snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- configFile : String
  Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
  
  File location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
$class: 'CompareWithBaselineBuilder'
Compare your current schema with the baseline. In case that the schema is different the build step will fail.
- outputFolder : String
  Path to the folder in that should be used to store baseline compare output.
  It serves as input for following steps like Generate create SQL script or Generate Report.
  
  Folder location must be specified as:
  
  Absolute path to location on your Jenkins master node
  
  Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
  
  Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- srcInputType : String
- tgtInputType : String
- srcInputFileOrFolder : String
  Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Baseline - input is baseline snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- tgtInputFileOrFolder : String
  Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Baseline - input is baseline snapshot file
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- configFile : String
  Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
  
  File location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
$class: 'CompoundBuilder'
$class: 'ConditionalBuilder'
- runCondition
  - $class: 'AlwaysRun'
  - $class: 'And'
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
  - $class: 'BatchFileCondition'
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
  - $class: 'BooleanCondition'
    token : String
  - $class: 'CauseCondition'
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
  - $class: 'DayCondition'
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
  - $class: 'ExpressionCondition'
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
  - $class: 'ExtendedCauseCondition'
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
  - $class: 'FileExistsCondition'
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
  - $class: 'FilesMatchCondition'
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
  - $class: 'LegacyBuildstepCondition'
    condition : String
    
    invert : boolean
  - $class: 'NeverRun'
  - $class: 'NodeCondition'
    allowedNodes : Array / List of String
  - $class: 'Not'
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
  - $class: 'NumericalComparisonCondition'
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
  - $class: 'OntrackDSLRunCondition'
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
  - $class: 'Or'
    conditions
    Array / List of Nested Object
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    condition
    Nested Choice of Objects
    $class: 'AlwaysRun'
    
    $class: 'And'
    
    conditions
    Array / List of Nested Object
    
    $class: 'BatchFileCondition'
    
    command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    
    $class: 'BooleanCondition'
    
    token : String
    
    $class: 'CauseCondition'
    
    Run if the current build has a specific cause (e.g triggered by SCM or timer).
    
    buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'DayCondition'
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    
    Nested Choice of Objects
    $class: 'SelectDays'
    
    days
    Array / List of Nested Object
    day : int
    
    selected : boolean
    
    $class: 'Weekday'
    
    $class: 'Weekend'
    
    $class: 'ExpressionCondition'
    
    expression : String
    The regular expression used to match the label - Java regular expression syntax
    
    label : String
    The label that will be tested by the regular expression
    
    $class: 'ExtendedCauseCondition'
    
    condition
    Nested Choice of Objects
    $class: 'UpstreamCauseCondition'
    
    projects : String
    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    
    $class: 'UserBuildCauseCondition'
    
    users : String
    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
    
    exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    
    $class: 'FileExistsCondition'
    
    file : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'FilesMatchCondition'
    
    includes : String
    
    excludes : String
    
    baseDir
    Nested Choice of Objects
    $class: 'ArtifactsDir'
    
    $class: 'JenkinsHome'
    
    $class: 'Workspace'
    
    $class: 'LegacyBuildstepCondition'
    
    condition : String
    
    invert : boolean
    
    $class: 'NeverRun'
    
    $class: 'NodeCondition'
    
    allowedNodes : Array / List of String
    
    $class: 'Not'
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
    
    $class: 'NumericalComparisonCondition'
    
    lhs : String
    
    rhs : String
    
    comparator
    Nested Choice of Objects
    $class: 'EqualTo'
    
    $class: 'GreaterThan'
    
    $class: 'GreaterThanOrEqualTo'
    
    $class: 'LessThan'
    
    $class: 'LessThanOrEqualTo'
    
    $class: 'NotEqualTo'
    
    $class: 'OntrackDSLRunCondition'
    
    ontrackScriptLocation
    Nested Object
    value : String
    
    scriptPath : String
    
    scriptText : String
    
    sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
    
    injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
    injectProperties : String
    
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
    
    ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
    
    $class: 'Or'
    
    $class: 'ShellCondition'
    
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
    
    $class: 'StatusCondition'
    
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    $class: 'StringsMatchCondition'
    
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
    
    $class: 'TextFinderCondition'
    
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
    
    $class: 'TimeCondition'
    
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
    
    $class: 'VariableExistsCondition'
    
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
  - $class: 'ShellCondition'
    command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
  - $class: 'StatusCondition'
    worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    
    bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
  - $class: 'StringsMatchCondition'
    arg1 : String
    
    arg2 : String
    
    ignoreCase : boolean
    Ignore the case of the strings when matching them
  - $class: 'TextFinderCondition'
    fileSet : String
    
    regexp : String
    
    checkConsoleOutput : boolean
  - $class: 'TimeCondition'
    earliest : String
    
    latest : String
    
    useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
  - $class: 'VariableExistsCondition'
    variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
- runner
  If the evaluation of a run condition fails, should the build fail, be marked unstable, run the build step ...
  A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
  ...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.
  - $class: 'DontRun'
  - $class: 'Fail'
  - $class: 'Run'
  - $class: 'RunUnstable'
  - $class: 'Unstable'
- conditionalbuilders : Array / List of Build Step (hudson.tasks.BuildStep)
$class: 'ConfigFileBuildStep'
Make globally configured files available in your local workspace. All files configured via the config-file-provider plugin are available and can be referenced.
- managedFiles
  - fileId : String
    Name of the file.
  - replaceTokens : boolean (optional)
    Decides whether the token should be replaced using macro.
  - targetLocation : String (optional)
    Name of the file (with optional file relative to workspace directory) where the config file should be copied.
  - variable : String (optional)
    Name of the variable which can be used as the reference for further configuration.
$class: 'ConfluenceReleaseNotesPublisher'
- jiraCredentialsID : String
  These jira credentials and project will be used to operate on.
- confluenceCredentialsID : String
  This confluence together with the credentials will be used to publish the page.
- spaceKey : String
  The key of the space on which the new page will be published
- jqlFilter : String
  A JQL filter used to select the tickets that will be shown on the newly created page. See the JIRA documentation for more information on how to use JQL.
- pageTitle : String
  The title of the new page that will be published.
- parentPageTitle : String
  If specified the entire content tree of the space is searched for a page with this title. The new release notes page will be then published as a child page of this one.
$class: 'ConsulBuilder'
- installationName : String
- operationList
  - $class: 'ConsulGetKV'
    valuePath : String
    Consul path for the required value.
    e.g. mysql/config/users/admin
    
    environmentVariableName : String
    Environment variable name for the value.
  - $class: 'ConsulServiceDiscoveryOperation'
    serviceName : String
    Service name to look in consul
    
    serviceTag : String
    Service tag - leave empty for no tag filtering.
    
    environmentVariableName : String
    Environment variable name for the response.
    Leave empty to use the same name of the service.
    
    healthStatus : String
    Service health status.
    
    addPort : boolean
    Add port number to response?
    The port will be added for every ip address - {ip}:{port}
  - $class: 'ConsulSetKV'
    valuePath : String
    Consul path to set with your value.
    e.g. mysql/config/users/admin
    
    value : String
    Value or ENV var name to use.
- consulSettingsProfileName : String
$class: 'ConsulKVBuilder'
- hostUrl : String
  Host URL should contain protocol (HTTP/HTTPS)://<HOST_NAME>.
- key : String
  Key is used in GET/PUT requests to lookup the value from, or right the key/value pair to the Consul key/value store.
- aclToken : String (optional)
  Token is used to supply UUID token for Consul ACL token calls. Token can be supplied by build parameters.
- apiUri : String (optional)
  URL Override is used to override the K,V API URL.
- debugMode (optional)
  Enable Debug messages for more verbose logging.
  - Values: ENABLED, DISABLED
- envVarKey : String (optional)
  ENV Varaible Key is used to store the retrieved value in the build ENV variables to be used downstream.
- ignoreGlobalSettings : boolean (optional)
- keyValue : String (optional)
  Value is used in PUT calls to insert/update a key/value pair.
- requestMode (optional)
  Request Mode set to READ will execute a GET to lookup the value, WRITE will execute a PUT to insert/update the value.
  - Values: READ, WRITE, DELETE
- timeoutConnection : int (optional)
  Connection timeout in milliseconds, default is 10000.
- timeoutResponse : int (optional)
  Response timeout in milliseconds, default is 30000.
assessContainerImage
- failOnPluginError : boolean (optional)
  Enable this option to fail the build if the plugin encountered any errors.
- imageId : String (optional)
  Provide a Docker image ID or name which can be referenced by the Docker daemon (e.g. my-repo/my-image:my-tag).
- nameRules (optional)
  - packageName
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    contains : String
    Set the name that will trigger the selected action.
  - vulnerabilityCategory
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    contains : String
    Set the name that will trigger the selected action.
  - vulnerabilityTitle
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    contains : String
    Set the name that will trigger the selected action.
  - vulnerablePackageName
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    contains : String
    Set the name that will trigger the selected action.
- thresholdRules (optional)
  - criticalVulnerabilities
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - cvssV2Score
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - exploitableVulnerabilities
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - vulnerabilitiesWithMalwareKits
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - moderateVulnerabilities
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - packageRiskScore
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - riskScore
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - severeVulnerabilities
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
  - totalVulnerabilities
    action : String
    Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
    
    threshold : String
    Set the numeric threshold value that will trigger the selected action.
- treatWarningsAsErrors : boolean (optional)
  Enable this option to treat warnings as errors, which will fail the build.
- workspaceDir : String (optional)
contentReplace
- configs (optional)
  - filePath : String
    A relative or absolute file path
  - fileEncoding : String
  - configs
    - matchCount : int (optional)
      
      Set "Match count" to 0 will do replace all
    - replace : String (optional)
      
      You can use variables enclosed in ${}. e.g. $11.0.${BUILD_ID}
      
      So, The string "Version=0.0.1" would be replace to Version=1.0.9 when the value of BUILD_ID is 9
    - search : String (optional)
      
      Regex expression for search. e.g. (Version=)([0-9]+\.[0-9]+\.[0-9]+)
    - verbose : boolean (optional)
      
      Check "Verbose" to display in the console all the replacements made.
$class: 'ContinuousReleaseProperties'
- properties
  - Type: java.util.Map<java.lang.String, java.lang.String>
$class: 'CoordinatorBuilder'
Add/Remove node, add/remove jobs, rename, check, right click to switch on Serial or Parallel pattern and have fun!
- executionPlan
  - Type: class org.jenkinsci.plugins.coordinator.model.TreeNode
$class: 'CopadoBuilder'
- stepName : String
- webhookUrl : String
  Enter the Copado URL for the test that you want to run on this build step. The Copado URLs (webhooks) that are available for Copado can be found using this url http://docs.copa.do.
- api_key : String
  Enter your Copado API Key. A personal API Key is generated from the Account Summary tab in Copado. This makes it easy to use the API.
  
  To obtain a new personal API Key, navigate in Copado to the Account Summary tab - API Key and press the "Generate new API Key" button if you haven't done it already.
  
  Please note that resetting/changing the API will require these values here to be updated too.
- timeout : int
  Enter timeout in seconds for your Copado jobs to complete. After the Copado task is triggered, this plugin will repeatedly poll the Copado API (approx. 10 every second) for the result. If the time it takes to complete the test exceeds this timeout value, this build step will abort and fail.
copyArtifacts
- projectName : String
  The name of the project to copy artifacts from.
  
  Maven projects:
  
  Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
  Example: MyMavenJob/my.group$MyModule
  
  Matrix projects:
  
  Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
  Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=agentA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=agentB/dist/mybuild.jar.
  
  To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
  Example: MyMatrixJob/jdk=Java6u17
  
  To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
  Example: OtherMatrixJob/jdk=$jdk
  
  Multibranch Pipeline projects:
  
  Use a path consisting of the project name followed by the branch name.
  Example: /MyMultibranchProject/MyBranch
  
  Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
  Example: ../MyMultibranchProject/feature%2Fnavigation
  
  See "How to reference another project by name" for more information.
- excludes : String (optional)
  Specify paths or patterns of artifacts to exclude, even if specified in "Artifacts to copy". Can be blank.
- filter : String (optional)
  Relative paths to artifact(s) to copy or leave blank to copy all artifacts. This works just as a filter, and doesn't care whether all specified artifacts really exists. Check the /artifact/ browser of a build to see the relative paths to use here, as the build page typically hides intermediate directories. Can use wildcards like module/dist/**/*.zip, and use comma (followed by optional whitespace) to separate multiple entries. See the @includes of Ant fileset for the exact format. May also contain references to build parameters like $PARAM.
- fingerprintArtifacts : boolean (optional)
  Automatically fingerprint all artifacts that are copied as part of this build step.
- flatten : boolean (optional)
  Ignore the directory structure of the artifacts in the source project and copy all matching artifacts directly into the specified target directory. By default the artifacts are copied in the same directory structure as the source project.
- includeBuildNumberInTargetPath : boolean (optional)
  Include build number in target path. Default is false.
  When true, the build number of the source project will be included in the target path. This is particularly useful when the selector is specific and the value is a permalink, e.g. lastSuccessfulBuild.
- optional : boolean (optional)
  Allow this build to continue even if no build is found that matches the "Which build" condition. By default this build step fails the build if no artifacts are copied.
- parameters : String (optional)
  
  Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
  
  You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
- resultVariableSuffix : String (optional)
  The build number of the selected build will be recorded into the variable named COPYARTIFACT_BUILD_NUMBER_(SUFFIX) for later build steps to reference. You can specify that suffix part for that variable here.
  If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
  
  Example:
  
  Source project name Suffix to be used
  
  Project-ABC PROJECT_ABC
  
  tool1-release1.2 TOOL_RELEASE_
- selector (optional)
  How to select the build to copy artifacts from, such as latest successful or stable build, or latest "keep forever" build. Other plugins may provide additional selections.
  The build number of the selected build will be recorded in the environment for later build steps to reference. For details, see the help of "Result variable suffix" in "Advanced" section.
  - downstream
    upstreamProjectName : String
    
    Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
    
    Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
    
    Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
    
    AbstractProject based projects:
    
    Freestyle projects
    
    Multi-configuration projects
    
    Maven projects
    
    Non AbstractProject based projects:
    
    Pipeline jobs (aka. Workflow jobs)
    
    upstreamBuildNumber : String
    The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
  - lastWithArtifacts
  - lastCompleted
  - $class: 'MultiJobBuildSelector'
  - buildParameter
    parameterName : String
    Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.
    You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
  - permalink
    id : String
  - $class: 'PromotedBuildSelector'
    level : int
  - latestSavedBuild
  - specific
    buildNumber : String
    While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
  - lastSuccessful
    stable : boolean (optional)
  - upstream
    allowUpstreamDependencies : boolean (optional)
    
    fallbackToLastSuccessful : boolean (optional)
    
    upstreamFilterStrategy (optional)
    Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
    
    Values: UseGlobalSetting, UseOldest, UseNewest
  - workspace
- target : String (optional)
  Target base directory for copy, or leave blank to use the workspace. Directory (and parent directories, if any) will be created if needed. May contain references to build parameters like $PARAM.
$class: 'CreateBaselineBuilder'
Set the current state of your schema as the baseline to detect any changes that has been made into the schema since now.
- outputFile : String
  Path to the file that should be used to store baseline.
  
  File location must be specified as:
  
  Absolute path to location on your Jenkins master node
  
  Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. file.
  
  Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- inputFileOrFolder : String
  Specify input folder/file for creating baseline. It should depend on input type you have selected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
$class: 'CreateBuildBuilder'
Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_BUILD_NUMBER environment variable with the value returned from BuildMaster for the new build.

If your Jenkins job has produced artifacts to be loaded into BuildMaster, you have the following options. The choice is largely dependent on how you import the build artifacts into BuildMaster:
1. Use BuildMasters Jenkins Extensions 'Jenkins::Import-Artifact' statement to import artifacts directly from Jenkins: the post build action is required
2. Use BuildMasters 'Create-Artifact' statement to import files from a folder that you've placed the artifacts into from the Jenkins build (eg using ArtifactDeployer Plugin): either the post build or build step actions will be fine
3. Use an external artifact repository such as Nexus, Artifactory or ProGet: either the post build or build step actions will be fine
- applicationId : String
  The identifier of the BuildMaster application to trigger the build for.
  
  Options are:
  
  The BUILDMASTER_APPLICATION_ID variable populated by a previous step
  
  An application
- releaseNumber : String
  The BuildMaster release number to trigger the build for. Options are:
  
  BUILDMASTER_RELEASE_NUMBER: variable populated by a previous step
  
  Latest Active Release: will automatically get the latest active release number from BuildMaster for the selected application
  
  [Release Number]: a release number from the list of active releases
  
  The job will fail if there is no active BuildMaster release.
- deployToFirstStage (optional)
  Will trigger the deployment to the first stage, and any subsequent stages where the stage is configured to automatically deploy to the next stage.
  - waitUntilCompleted : boolean
    If checked waits until BuildMaster has completed the deployment, otherwise will exits immediately after triggering the deployment to the first stage.
  - printLogOnFailure : boolean (optional)
    If checked will print the BuildMaster log for the deployment to the Jenkins console if the build fails - but only if the "Wait until deployment completed" option is also checked.
- variables : String (optional)
  Provide a list of variables to pass to the build.
  
  A variable must be in the format "variable=value"
  
  Additional variables must be declared on separate lines
  
  Lines starting with # are treated as comments
  
  When using pipeline script and you want to pass several variables use one of these formats:
  
  Separate variables using newline character. Generated script will resemble: variables: 'var1=one\nvar2=two'
  
  Separate variables using multi-line string. Generated script will resemble: variables: '''var1=one
  var2=two'''
$class: 'CreateCustomTaskrun'
- name : String
- generateName : String
- namespace : String
- clusterName : String
- workspaces
  - name : String
  - claimName : String
- params
  - name : String
  - value : String
- taskRef : String
createCloudifyEnv
Creates a topology from an environment blueprint.

The "Output File" parameter denotes where the new environment's outputs will be written to. Later build steps can inspect this file in order to grab information pertinent to them (such as IP addresses, user names and so forth).

All input fields support standard Jenkins parameters' expansion. For example, the string ${app_name} will be expanded, in runtime, to the value of a build parameter called app_name .

For explanation about the format of the outputs file, refer to the help tooltip for that parameter.
- blueprintId : String (optional)
  
  Unique identifier for the created deployment.
- credentialsId : String (optional)
  
  The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
- debugOutput : boolean (optional)
  If checked, then printed Cloudify events and logs will include debug-level records.
- deploymentId : String (optional)
  
  Identifies the blueprint to create a deployment off.
- echoInputs : boolean (optional)
  If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
- echoOutputs : boolean (optional)
  At the end of the build step, print the outputs and capabilities to the console.
- inputs : String (optional)
  
  A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file " parameter.
- inputsFile : String (optional)
  
  A path (relative to the workspace root) to a YAML/JSON file containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs " parameter.
- mapping : String (optional)
  
  If specified, this YAML/JSON will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
  
  This parameter must not be provided if "mapping file" is provided.
- mappingFile : String (optional)
  
  If specified, this YAML/JSON file will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
  
  This parameter must not be provided if "mapping" is provided.
- outputFile : String (optional)
  Name of file into which the deployment's outputs and capabilities will be written. The file will be a JSON, adhering to the following format:
  
  { "outputs": <outputs_dictionary>, "capabilities": <capabilities_dictionary> }
- skipInstall : boolean (optional)
  Only create a Cloudify deployment; skip running the install workflow.
- tenant : String (optional)
  
  Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
$class: 'CreateFingerprint'
Create Fingerprints of specified files during a build process
- targets : String
$class: 'CreateRelease'
- prefix : String
  Enter the prefix of your project here. Example: P10 (P10 - Project number)
- itemPrefix : String
  Enter the prefix of your item here. Example: P1#I10 (P1 - Project number, I10 - Item number), P#I11, P#I12, P2#I13
- releaseName : String
  Enter the name of the release here
- description : String
  Add a line or two to describe the release
- stage : String
  Mention the stage of the release
- owner : String
  Mention the email id of the release’s owner
- period : String
  Mention the number of days required for the release (not lesser than 3)
$class: 'CreateSnapshotBuilder'
Save your database schema to a file to have the possibility to return to it any time later.
- outputFile : String
  Path to the file that should be used to store snapshots.
  
  File location must be specified as:
  
  Absolute path to location on your Jenkins master node
  
  Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
  
  Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- inputFileOrFolder : String
  Specify input folder/file for creating snapshot. It should depend on input type you have selected.
  
  Database - input is exported connection file
  
  File System Synchronization - input is folder mapped through Toad Edge file system synchronization
  
  Folder/file location must be specified as:
  
  Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
createTag
- nexusInstanceId : String
- tagName : String
  Tag name is required and must be unique. Name can only contain letters, numbers, underscores, hyphens and dots and cannot start with an underscore or dot. The name cannot exceed 256 characters
- tagAttributesJson : String (optional)
  Optional metadata for the tag in JSON format. These attributes will be merged with those contained in the attributes file if both are provided. Attributes in this field will override those present in the file
- tagAttributesPath : String (optional)
  The file path (environment-aware) to the optional metadata for the tag, using the workspace as the base path
createTask
- artifact : String (optional)
- artifactType : String (optional)
- autoUpgradable : boolean (optional)
- environment : String (optional)
- isjob : boolean (optional)
- overrideWithDefaultParameters : boolean (optional)
- parameters : String (optional)
- runtime : String (optional)
- runtimeType : String (optional)
- workspace : String (optional)
$class: 'CreateTemplate'
- cloud : String
- workspace : String
  The workspace in ElasticBox.
- instanceTags : String
- templateName : String
- provider : String
- datacenter : String
- folder : String
- datastore : String
- claimFilter : String
- policyName : String
- claims : String
$class: 'CreateVM'
- INSTANCE_NAME : String
- GCP_PROJECT_ID : String
- IMAGE_NAME : String
- scriptType : String
$class: 'CreateVirtualService'
- config : String
- rrFilePath : String
- host : String
- username : String
- password
  - Type: class hudson.util.Secret
- isstart : boolean
- token
  - Type: class hudson.util.Secret
$class: 'CriticalBlockEnd'
Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'
Delimit the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
crowdStrikeSecurity
- imageName : String (optional)
  Image Name
  
  Image Name is the name of the Docker container image. This plugin will attempt to "docker push" that image name to the Falcon API servers to enqueue the image layers for image assessment. May only contain letters (a-z), numbers (0-9), underscore (_), hyphen (-), and period (.). Must not exceed 4096 characters in length.
- imageTag : String (optional)
  Image Tag
  
  Image Tag is the name of the Docker container image tag. This determines which version of the given Docker container image to assess. If you aren't sure, you can try a value like "latest”. May only contain letters (a-z), numbers (0-9), underscore (_), hyphen (-), and period (.). Must not exceed 127 characters in length.
- enforce : boolean (optional)
  Image Doesn't Comply With Policy
  
  Enforce CrowdStrike Falcon API recommendation by immediately aborting and failing the build.
- timeout : int (optional)
  Timeout
  
  Timeout is the number of seconds to wait before giving up (ie. if there is some issue, such as network connectivity to Falcon). To err on the side of safety, when a timeout is reached, it will be treated the same as if Falcon had recommended to prevent the build. This timeout is for the entire build step. Must be an integer between 1 and 1799.The maximum timeout session would be 30 minutes.
$class: 'CucumberSlackBuildStepNotifier'
- channel : String
- json : String
- hideSuccessfulResults : boolean
$class: 'CustomPythonBuilder'
- home : String
- nature : String
- command : String
- ignoreExitCode : boolean
$class: 'CxScanBuilder'
- credentialsId : String
  This option is for users that may already have Jenkins credentials, as defined in Jenkins, and would like to use them with the CxSAST Jenkins plugin. Select your credentials from the drop-down list.
  NOTE: If your credentials do not exist in the system, you can add them by clicking Add and selecting Jenkins (see Adding Jenkins Credentials to the CxSAST Jenkins Plugin, for more information).
- sastCredentialsId : String
- buildStep : String
- teamPath : String
- sastEnabled : boolean
- exclusionsSetting : String
- failBuildOnNewResults : boolean
  Enables the option to fail the build according to the defined severity (or higher). This option works in addition to the regular thresholds (e.g. if "x" total high vulnerabilities were found OR at least 1 new vulnerability, fail the build). This option is only available if the "Enable vulnerability threshold" parameter is enabled.
- failBuildOnNewSeverity : String
- useOwnServerCredentials : boolean (optional)
- serverUrl : String (optional)
  Checkmarx server url or ip address with or without port. Syntax: http(s)://server-name:port. Example: http://checkmarx-server, https://10.0.0.255:9495
- username : String (optional)
  Login username
- password : String (optional)
  Login password
- isProxy : boolean (optional)
- configAsCode : boolean (optional)
  Create cx.config config-as-code input file at the root of the repo in '.checkmarx' folder. For example .checkmarx/cx.config
- projectName : String (optional)
  A full absolute name of a project. The full Project name includes the whole path to the project, including Server, service provider, company, and team. Example: "CxServer\SP\Company\Users\bs_java" If project with such a name doesn't exist in the system, new project will be created. May reference build parameters like ${PARAM}.
- projectId : long (optional)
- groupId : String (optional)
  Fully qualified team name for the project.
- preset : String (optional)
  Select the scan preset for this project
- jobStatusOnError (optional)
  Determines how to act when a triggered Checkmarx scan in synchronous mode fails and returns an error message (i.e. no scan results, not to be confused with valid scan results that exceed the threshold).
  
  FAILURE is equivalent to a Job error that fails the entire build.
  
  UNSTABLE is equivalent to a Job warning that allows the build to proceed normally but provides an unstable status upon completion.
  
  Use the global setting implies that this project uses the value either FAILURE or UNSTABLE defined globally by the CxSAST Jenkins plugin.
  - Values: GLOBAL, FAILURE, UNSTABLE, ABORTED
- presetSpecified : boolean (optional)
- excludeFolders : String (optional)
  Comma separated list of folders to exclude from scan. Entries in this list are automatically converted to exclude wildcard patterns and appended to the full pattern list provided in the advanced section. May reference build parameters like ${PARAM}.
  Conversion is done as follows:
  fold1, fold2 fold3
  is converted to:
  !**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
- filterPattern : String (optional)
  Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!".
  Example: **/*.java, **/*.html, !**\test\**\XYZ*
  Pattern Syntax A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found. When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied. The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched. The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name. There is a special case regarding the use of File.separators at the beginning of the pattern and the string to match: When a pattern starts with a File.separator, the string to match must also start with a File.separator. When a pattern does not start with a File.separator, the string to match may not start with a File.separator. When one of these rules is not obeyed, the string will not match. When a name path segment is matched against a pattern path segment, the following special characters can be used: '*' matches zero or more characters '?' matches one character. May reference build parameters like ${PARAM}. Examples: "**\*.class" matches all .class files/dirs in a directory tree. "test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test. "**" matches everything in a directory tree. "**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
- incremental : boolean (optional)
  Run incremental scan instead of full scan.
- fullScansScheduled : boolean (optional)
- fullScanCycle : int (optional)
  Incremental scans are faster, but with time they become less accurate.
  Therefore, after a number of incremental scans it is recommended to perform a full scan.
  Here you can schedule periodic full scans to be executed after a certain number of incremental scans.
  
  Alternatively, if you want to run full scans on weekends, you can create 2 separate jobs.
  First job - to run incremental scans on weekdays and second job - to run full scans on weekends.
- postScanActionId : int (optional)
  Select Post Scan Action name that is to be performed automatically after a scan.(Note that the feature works with 9.3 version SAST onwards.)
- sourceEncoding : String (optional)
  Source code character encoding.
- comment : String (optional)
  Free text comment. If the comment contains variables like ${GIT_COMMIT}, ${GIT_BRANCH}, ${GIT_URL}, ${GIT_AUTHOR_NAME} or any Jenkins variable. It shall be expanded as long as it is a valid variable available to Jenkins else considers it as plain text.
- skipSCMTriggers : boolean (optional)
  Do not perform Checkmarx scan when the build was triggered by SCM Change.
- waitForResultsEnabled : boolean (optional)
  In synchronous mode, Checkmarx build step will wait for Checkmarx scan to complete, then retrieve scan results and optionally check vulnerability thresholds. When disabled, the build step finishes after scan job submissions to Checkmarx server.
- vulnerabilityThresholdEnabled : boolean (optional)
  Mark the build as unstable if the number of high severity vulnerabilities is above the specified threshold.
- highThreshold : int (optional)
  High severity vulnerability threshold. If set, the threshold is crossed if number of high severity vulnerabilities exceeds it.
- mediumThreshold : int (optional)
  Medium severity vulnerability threshold. If set, the threshold is crossed if number of medium severity vulnerabilities exceeds it.
- lowThreshold : int (optional)
  Low severity vulnerability threshold. If set, the threshold is crossed if number of low severity vulnerabilities exceeds it.
- osaHighThreshold : int (optional)
  High severity vulnerabilities threshold for dependency scan. If set, the threshold is crossed if number of high severity vulnerabilities exceeds it.
- osaMediumThreshold : int (optional)
  Medium severity vulnerabilities threshold for dependency scan. If set, the threshold is crossed if number of medium severity vulnerabilities exceeds it.
- osaLowThreshold : int (optional)
  Low severity vulnerabilities threshold for dependency scan. If set, the threshold is crossed if number of low severity vulnerabilities exceeds it.
- generatePdfReport : boolean (optional)
  Downloads a PDF report with scan results from the Checkmarx server. The report is available via a link on "Checkmarx Scan Results" page.
- enableProjectPolicyEnforcement : boolean (optional)
  Mark the build as failed or unstable if the project's policy is violated.
  Note:
  Assigning a policy to a project is done from within CxSAST
- thresholdSettings : String (optional)
- vulnerabilityThresholdResult : String (optional)
- avoidDuplicateProjectScans : boolean (optional)
  If there is a scan of this project in the queue in status working or queued do not send a new scan request to Checkmarx
- addGlobalCommenToBuildCommet : boolean (optional)
  Allow global sast comment to be added to the build comment.By default the global comment is empty. When both job level comments and global comments are provided and 'Allow Global comment' is selected, then both comments shall be concatenated.
- generateXmlReport : boolean (optional)
  Generate full XML and HTML CxSAST scan reports. These reports will contain additional information about the detected vulnerabilities
- hideDebugLogs : boolean (optional)
  Enabling this will not generate any debug level logs in the job output.
- forceScan : boolean (optional)
  Force Scan - If force scan is enabled, SAST will perform scan even if there are no code changes.
- customFields : String (optional)
  Add scan level custom fields and its value. Example: field1:value1,field2:value2.(Note that the feature works with 9.4 version SAST onwards.)
- dependencyScanConfig (optional)
  - SASTUserName : String (optional)
  - dependencyScanExcludeFolders : String (optional)
  - dependencyScanPatterns : String (optional)
  - dependencyScannerType (optional)
    - Values: OSA, SCA
  - enableScaResolver (optional)
    - Values: SCA_RESOLVER, MANIFEST
  - fsaVariables : String (optional)
  - isExploitablePath : boolean (optional)
  - isIncludeSources : boolean (optional)
  - osaArchiveIncludePatterns : String (optional)
  - osaInstallBeforeScan : boolean (optional)
  - overrideGlobalConfig : boolean (optional)
  - pathToScaResolver : String (optional)
  - sastCredentialsId : String (optional)
  - scaAccessControlUrl : String (optional)
  - scaConfigFile : String (optional)
  - scaCredentialsId : String (optional)
  - scaEnvVariables : String (optional)
  - scaResolverAddParameters : String (optional)
  - scaSASTProjectFullPath : String (optional)
  - scaSASTProjectID : String (optional)
  - scaSastServerUrl : String (optional)
  - scaServerUrl : String (optional)
  - scaTeamId : String (optional)
  - scaTeamPath : String (optional)
  - scaTenant : String (optional)
  - scaTimeout : int (optional)
  - scaWebAppUrl : String (optional)
  - useJobLevelSastDetails : boolean (optional)
- excludeOpenSourceFolders : String (optional)
- includeOpenSourceFolders : String (optional)
- osaArchiveIncludePatterns : String (optional)
  
  Comma separated list of archive wildcard patterns to include their extracted content for the scan. eg. *.zip, *.jar, *.ear
  Supported archive types are: jar, war, ear, sca, gem, whl, egg, tar, tar.gz, tgz, zip, rar
  Leave empty to extract all archives
- osaEnabled : boolean (optional)
- osaInstallBeforeScan : boolean (optional)
  Select this option in order to be able to scan packages from various dependency managers (NPM, Nugget, Python and more.) as part of the CxOSA scan
- overrideProjectSetting : boolean (optional)
  When selected, preset & engine configuration value selected in the pipeline will be saved on the CxSAST project.
- thisBuildIncremental : boolean (optional)
DASTScan
- apikey (optional)
  
  Your API key can be found on the Breachlock Platform under
  
  Organization settings > Integrations > Jenkins
  - Type: class hudson.util.Secret
- asset : String (optional)
  Select the asset that will be scanned on build.
  
  If the asset you are looking for is missing:
  
  Make sure it's registered on the Breachlock Platform.
  
  Check if your Jenkins installation can connect to https://app.breachlock.com/.
  
  Contact support if the problem keeps persisting.
- email : String (optional)
  
  The email-address you registered on Breachlock Platform.
osfBuilderSuiteForSFCCDataImport
- hostname : String (optional)
- tfCredentialsId : String (optional)
- ocCredentialsId : String (optional)
- ocVersion : String (optional)
- archiveName : String (optional)
- sourcePath : String (optional)
- includePatterns (optional)
  - includePattern : String
- excludePatterns (optional)
  - excludePattern : String
- importStrategy : String (optional)
- tempDirectory : String (optional)
$class: 'DaticalDBBuilder'
- daticalDBProjectDir : String
  The Datical DB Project Directory is the path location of your Datical DB Project folder. This will contain a datical.project file.
  
  Typically, this will be a relative path as it will be created by Jenkins during source code checkout. If you Datical DB Project is stored in the db folder under the root of your source tree and is named "My Project", you should enter ./db/My Project.
- daticalDBServer : String
  The Datical DB Server Name is the name of the server you wish to manage with Datical DB. You can determine this value by opening Datical DB and choosing a server listed in your Deployment Plan. Directory is the path location of your Datical DB Project folder. This will contain a datical.project file.
- daticalDBAction : String
  The Datical DB Action is the action you wish Datical DB to perform.
  
  This can include the following:
- Forecast - provides a report detail the changes, if any, that will be applied to your database along with impact analysis. This does NOT commit changes to your database. This file will be stored in your build workspace. Requires DB Server specification.
- Snapshot - reverse engineers your database schema to a Datical DB XML file. This file will be stored in your build workspace. Requires DB Server specification.
- Deploy - executes any changes required as detailed in your Project. This will generate a report detailing the chnages and be stored in your build workspace. Requires DB Server specification.
- Status - provides the current status of the database in relation to your Project. DB Server specification is optional.
- Status (Detailed) - details the current status of the database in relation to your Project. DB Server specification is required.
- Check Drivers - validates the appropriate JDBC driver is available to Datical DB for your specific Project. The location of the drivers is specified in the Jenkins global config. (Jenkins --> Manage Jenkins --> Configure System --> Datical DB)
- Check Rules - validates the Rules located in your Datical DB project.
- Generate Change Log from Differences - generates a new Change Log representing the difference between two databases in your Datical DB project. Two Servers are required (e.g., Source Target). diffChangelog reference db target db --output path. Output is optional.
- Generate Report from Differences - like the previous Action, generates a report representing the difference between two databases in your Datical DB project. Two Servers are required (e.g., Source Target). diff reference db target db.
- History - provides a history report of changes applied to your database(s).
- Rollback - Roll the target database back to a given revision, date or by number of steps.
- Deploy with Auto Rollback - Identical to "Deploy" but will Automatically Rollback to previous state in event of error.
- Create Datical Project - Creates a new Datical Project in the Project Directory. Useful for when you are only provided the changelog.xml file.
- Create New Database Definition - Adds a new Database Definition to an existing Datical Project. (e.g., DbDefClass MysqlDbDef name Dev username datical password password hostname localhost port 3306 database dev)
- Install License - Installs a license file. Requires the path to the new license file.
- Set Property - Set a Datical DB Property in daticaldb.properties.
- Create Datical Project (project_creatory.groovy) - Creates a Datical Project using Provisiong Files. See project_creator.groovy in repl/scripts.
- Baseline Datical Project (project_baseline.groovy) - Baselines a Datical Project. See project_baseline.groovy in repl/scripts

daticalDBCmdProject : String
The Datical DB Command is the fully qualified location of the Datical DB CLI command. It will override the Global Datical DB Command. This is typically not needed.

This should be a fully qualified file path such as C:\DaticalDB\repl\hammer.bat or /opt/DaticalDB/repl/hammer.
daticalDBExportSQL : String
When checked for Deploy and Forecast actions, Datical DB will export SQL to be run against the target server.
daticalDBExportRollbackSQL : String
When checked for Deploy and Forecast actions, Datical DB will export Rollback SQL to be run against the target server. When checked for Rollback, will only export SQL and NOT perform a Rollback.
daticalDBScriptDir : String
The Datical DB Script Directory is the fully qualified location of the Datical DB Scripts.

This should be a fully qualified file path such as file:/C:\DaticalDB\repl\scripts or /opt/DaticalDB/repl/scripts.

Source project name	Suffix to be used
Project-ABC	PROJECT_ABC
tool1-release1.2	TOOL_RELEASE_

debianPbuilder

additionalBuildResults : String (optional)
When running a build in the chroot environment, there are occasionally files that you must retrieve from the chroot that are not part of the normal build. For example, some files that you may need to get back would include test results, auto-generated files, etc.

Set this variable in order to get the files back from the chroot build environment.

The files that are retrieved will also automatically be archived as well with the other build results.

This must be a comma-separated list; spaces are allowed.
architecture : String (optional)
The architecture to build this as.

If the project is using the Matrix Build plugin, leave this blank (the architectures to build for are defined by the 'architecture' environment variable).

This is mostly to support Pipeline, however it can be used as a normal parameter as well.
artifactoryRepoName : String (optional)
If you are generating a spec file for use with Artifactory, this defines the repository that you would like to upload it to.
buildAsTag : boolean (optional)
Set this to mark this as building a tag. When a build comes from a tag, the deb version does not get incremented(i.e. it is exactly as set in the debian/changelog file). If using SVN, this plugin automatically looks at the SVN_URL_1 environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. If using Git, this plugin automatically looks at the GIT_BRANCH environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. Alternatively, you can also set the environment variable DEB_PBUILDER_BUILDING_TAG to either true or false.
components : String (optional)
The components to build with. By default, pbuilder sets this to 'main'. If you're building an Ubuntu package, you may need to set this to "main restricted universe multiverse"

The setting guessComponents must be false for this setting to be honored.
debianDirLocation : String (optional)

The location of the debian/ directory, relative to workspace root

This may also be set globally
distribution : String (optional)

The distribution to build for. By default, this checks the distribution that is set in debian/changelog. If the version in the changelog is UNRELEASED, it attempts to use the currently running distribution if this parameter is NULL or a 0-length string.
extraPackages : String (optional)

Extra packages to install in the chroot environment. Corresponds to EXTRAPACKAGES in the pbuilder configuration
generateArtifactorySpecFile : boolean (optional)
Generate a spec file to be used with Artifactory in order to upload files. By default, this will generate the file with the .deb, .tar* and .gz files for uploading.

This will generate a spec file in the workspace called artifactory-spec-debian-pbuilder/debian-pbuilder.spec which you can then use to upload the binaries to Artifactory. This is intended to be used in conjunction with the Artifactory Jenkins plugin.
guessComponents : boolean (optional)
If set to true, automatically try to guess the components. This means that if we think we are building an Ubuntu package on Debian, our components will be automatically set to "main restricted universe multiverse"
keyring : String (optional)

The keyring to build with. By default, we will attempt to figure out if we are building a Debian package on Ubuntu, and if we think that we are this will be set to /usr/share/keyrings/debian-archive-keyring.gpg. This file is part of the debian-archive-keyring package. If you need to use a custom keyring, put it in here. If for some reason the auto-detection is not working properly, set this to the string 'disabled' and no keyring settings for pbuilder will be set.
mirrorSite : String (optional)

The mirror site to use. If this is not set or a 0-length string, then the default mirror site for this distribution will be used. The default mirror site is defined in /etc/pbuilderrc
numberCores : int (optional)

The number of cores to use when building. By default, this is 1. Set to -1 in order to use as many cores as possible when building. In order for this to take effect, you need to make sure that your debian/rules is setup properly. See this post.
otherMirror : String (optional)

The extra mirror to use. Corresponds to OTHERMIRROR configuration option in pbuilder
pbuilderType : String (optional)
pristineTarName : String (optional)
If this field set, and if source/format indicates that this is a quilt package, we will attempt to checkout the given original tar file.

runAutomationHubBuild

testSuiteId : String
startOnly : boolean (optional)
userKeyId : String (optional)
userKeySecret (optional)
- Type: class hudson.util.Secret

dotnetNuGetDelete

The dotnet nuget delete command deletes or unlists a package from the server. For nuget.org, the action is to unlist the package.

(see also: Microsoft Documentation)

apiKeyId : String (optional)
The API key for the server.
charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
forceEnglishOutput : boolean (optional)
Forces the application to run using an invariant, English-based culture.
noServiceEndpoint : boolean (optional)
Doesn't append "api/v2/package" to the source URL.

Available since: .NET Core SDK 2.1
packageName : String (optional)
Name/ID of the package to delete.
packageVersion : String (optional)
Version of the package to delete.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
source : String (optional)
Specifies the server URL. Supported URLs for nuget.org include https://www.nuget.org, https://www.nuget.org/api/v3, and https://www.nuget.org/api/v2/package. For private feeds, replace the host name (for example, %hostname%/api/v3).
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

$class: 'DeleteApplication'

serverName : String
Select the a server from the list of servers configured in Jenkins Global Configuration.
appName : String
Name of the gear to be deleted.
domain : String
Select the user domain containing the application.

deleteCloudifyBlueprint

Use this step to delete a Cloudify blueprint from Cloudify Manager.

blueprintId : String (optional)
ID of blueprint to delete.
credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
tenant : String (optional)

Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

deleteComponents

nexusInstanceId : String
tagName : String
Components associated with this tag will be deleted

deleteCloudifyEnv

Deletes a Cloudify environment.

credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean (optional)
If checked, then printed Cloudify events and logs will include debug-level records.
deleteBlueprintIfLast : boolean (optional)

If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
deploymentId : String (optional)
ignoreFailure : boolean (optional)

If checked, then failures during the removal of the environment will be ignored.
skipUninstall : boolean (optional)
Only delete the Cloudify deployment; skip running the uninstall workflow.
tenant : String (optional)

Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

$class: 'DeleteEnvironmentBuilder'

systemId : int
environmentName : String

$class: 'DeleteRaw'

deleteAllStatus
- resourceName : String
resourceType : String (optional)
clusterName : String (optional)
resourceName : String (optional)

$class: 'DeleteVirtualService'

serviceName : String

$class: 'DeleteVirtualizeBuilder'

serverType : String
serverHost : String
serverName : String

dependencyCheck

odcInstallation : String
additionalArguments : String (optional)
Defines the arguments to pass to the command-line tool. By default, the following options will be passed if not specified:

--project The name of the Jenkins job

--scan The build workspace

--format XML
skipOnScmChange : boolean (optional)
If enabled, a Dependency-Check analysis will not be performed if the job was triggered by an SCM change.
skipOnUpstreamChange : boolean (optional)
If enabled, a Dependency-Check analysis will not be performed if the job was triggered by an upstream change.
stopBuild : boolean (optional)
If enabled, it stops the build when the Dependency-Check analysis exit with code different than 0.

$class: 'DeployApplication'

This plugin creates a container on the OpenShift PaaS and deploys the application into the container.

serverName : String
Select the a server from the list of servers configured in Jenkins Global Configuration.
appName : String
Select a name for the application. If the application doesn't exist, it will be created before the deployment.
cartridges : String
Specify a space delimited list of cartridges to be assigned to the application. e.g. jbosseap-6 mysql-5.5

Note that the specified cartridges need to be available on the selected OpenShift server. For a complete list of available cartridges on OpenShift refer to OpenShift web console or use the command line too 'rhc cartridges'. Here is the list of some of the most common cartridges:
- jbossas-7
- jbosseap-6
- nodejs-0.10
- perl-5.10
- php-5.3
- php-5.4
- zend-6.1
- python-2.6
- python-2.7
- python-3.3
- ruby-1.8
- ruby-1.9
- ruby-2.0
- jbossews-1.0
- jbossews-2.0
- 10gen-mms-agent-0.1
- mongodb-2.4
- mysql-5.1
- mysql-5.5
- phpmyadmin-4
- postgresql-8.4
- postgresql-9.2
domain : String
Select the user domain for the application. Note that the domain needs to be created before hand. The plugin will not create it if it doesn't exist.
gearProfile : String
Select the gear profile to be used when creating the application
deploymentPackage : String
The location of the deployment package can be specified as a directory path or a URL (e.g. to Nexus). The packages can be of type .WAR or .EAR in case of GIT deployment and .TAR.GZ archive for BINARY deployment. Examples:
- target/
- http://www.myrepo.com/org/keycloak/keycloak-server/1.0.2.Final/keycloak-server-1.0.2.Final.war
- https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=central&g=org.keycloak&a=keycloak-server&v=1.0.2.Final&e=war
In case of URL or when only one deployment package exists in the given directory, the package is deployed under the root ("/") context. When multiple packages are found, all are deployed under their own context paths.

Token macro expressions can be used for specifying a URL:
https://repo/nexus/service/local/artifact/maven/redirect?r=central&g=${ENV,var="GROUPID"}&a=${ENV,var="ARTIFACTID"}&v=${ENV, var="VERSION"}&e=war

Check Token Macro Plugin for further details.
environmentVariables : String

Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
autoScale : boolean
deploymentType
Type of deployment the application accepts ('git' or 'binary')
- Values: GIT, BINARY
openshiftDirectory : String
The .openshift directory is a directory where a user can create action hooks, set markers, and create cron jobs. Check OpenShift User Guide for further details.

$class: 'DeployBox'

id : String
cloud : String
workspace : String
The workspace in ElasticBox to look for box to launch.
box : String
The box in the selected workspace to launch.
boxVersion : String
The version of the selected box. If Latest is selected then the version will be the box itself or the last version depending on how the box is shared in the selected workspace.
instanceName : String
profile : String
claims : String
provider : String
location : String
instanceEnvVariable : String
Define an environment variable for the instance deployed by this build step. The variable will hold the instance ID.
Additional instance properties will also be available via other environment variables that have the defined variable as prefix of their name. For example, if INSTANCE is specified for this field then the following environment variables are available:
  INSTANCE - ID of the deployed instance
  INSTANCE_URL - URL of the deployed instance
  INSTANCE_SERVICE_ID - service ID of the deployed instance
  INSTANCE_TAGS - comma-separate list of tags of the deployed instance
If 1 is specified for Number of Instances then the following environment variables are available:
  INSTANCE_MACHINE_NAME - VM name of the deployed instance
  INSTANCE_PUBLIC_ADDRESS - VM public address of the deployed instance
  INSTANCE_PRIVATE_ADDRESS - VM private address of the deployed instance
If Number of Instances is greater than 1, the following environment variable are available:
  INSTANCE_MACHINE_NAMES - space-separate list of VM names
  INSTANCE_PUBLIC_ADDRESSES - space-separate list of public addresses of the VMs
  INSTANCE_PRIVATE_ADDRESSES - space-separate list of private addresses of the VMs
tags : String
Comma-separate tags to be added to the instance. These tags will be used to look up for the instance to determine whether the instance already exists. Build parameters or environment variables can be specified in tag with the format ${VARIABLE_NAME}
variables : String
expiration
Select whether the deployed instance will be expired via termination or shutdown in a specific number of hours from now or at a specific date and time in the future.
- $class: 'AlwaysOn'
- $class: 'ShutDown'
  - hours : String
  - date : String
    Date in format MM/dd/yyyy
  - time : String
    Time in format HH:mm with hour from 00 to 23
- $class: 'Terminate'
  - hours : String
  - date : String
    Date in format MM/dd/yyyy
  - time : String
    Time in format HH:mm with hour from 00 to 23
autoUpdates : String
alternateAction : String
waitForCompletion : boolean
waitForCompletionTimeout : int
Timeout in minutes to wait for this Deploy Box build step to complete. This field is ignored if Wait for completion is unchecked.
boxDeploymentType : String

samDeploy

settings
- credentialsId : String
- region : String
- s3Bucket : String
  The name of the S3 bucket where this command uploads the artifacts that are referenced in your template.
  S3 bucket will be created automatically if it does not exist.
- stackName : String
  The name of the AWS SAM stack you're deploying to. If you specify an existing stack, the command updates the stack. If you specify a new stack, the command creates it.
- templateFile : String
  The path, relative to the workspace directory, where your AWS SAM template is located.
  
  Examples:
  template.yaml
  app/template.json
- kmsKeyId : String (optional)
  The ID of an AWS KMS key that the command uses to encrypt artifacts that are at rest in the S3 bucket. If not specified, SSE-AES256 is used.
- outputTemplateFile : String (optional)
  The path to the file (relative to the workspace directory) where the build step writes the output AWS SAM template.
  template-#jobId.yaml by default.
- parameters (optional)
  A list of key-value pairs that specify input parameters for the change set.
  - key : String
  - value : String
- roleArn : String (optional)
  The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS SAM assumes when executing the change set.
- s3Prefix : String (optional)
  A prefix name that the command adds to the artifacts' name when it uploads them to the S3 bucket. The prefix name is a path name (folder name) for the S3 bucket.
- tags (optional)
  A list of tags to associate with the stack that is created or updated. AWS SAM also propagates these tags to resources in the stack.
  - key : String
  - value : String

crxDeploy

Deploy CRX Content Package files from the workspace to a configured Adobe Granite repository via the CRX Package Manager.

Only package files with .zip or .jar extensions will be identified and deployed.

packageIdFilters : String (optional)
Specify a list of package ID filters and path filters to match against identified Vault packages located in the workspace. Each filter string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':').
Package ID filters must follow one of three patterns:
- group:name:version
- group:name
- name
Each segment in the package ID filter may be either ommitted or replaced with an asterisk ('*') to represent a wildcard.

This step now supports path filters as well. A path filter is a path suffix relative to the localDirectory ending in '.zip' or '.jar', which may include '**', '*', and '?' wildcard characters.

For example, this pattern will match all zip files under the Local Directory:
```
        **/*.zip
    
```
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
```
        Packages/acme-*.zip
    
```
Matching packages will be uploaded in the order in which the filters are specified. Only the highest matching version of a package identified by 'group:name' will be deployed, and it will only be deployed once per build step, regardless of the number of matching filters.

This field supports parameter tokens.
baseUrls : String (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

Multiple urls can be specified, one per line. All specified packages will be deployed to one server before beginning deployments to the next one.

If login credentials for one of the servers are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http://deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:

http://deployer:Password123@localhost:4502

This field supports parameter tokens.
acHandling : String (optional)
Change the way content ACL's included in the package filter scope are handled during installation.

Defer to Package

Allow package to specify AC Handling mode. (This can be dangerous. Consider using a Validate CRX Content Packages step to check packages for destructive AC Handling rules before you deploy them.)

Ignore

Ignores the packaged access control and leaves the target unchanged.

MergePreserve

Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e. content first). It never alters access control entries already existing in the content.

Merge

Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e. package first). It never alters access control entries of principals not present in the package.

Overwrite

Applies the access control provided with the package to the target. This also removes existing access control.

Clear

Clears all access control on the target system.
autosave : int (optional)
Specify the number of changes to batch before saving the JCR session during package installation.
behavior : String (optional)
Specify the behavior when a package exists on the target server that has the same package ID as one you are trying to deploy.
credentialsId : String (optional)
Select the login credentials with which content packages will be deployed to the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
disableForJobTesting : boolean (optional)
Check this box to disable package deployment during Jenkins Job testing. For example, it is often necessary to test changes to artifact resolution configuration or to test Vault package identification. By checking this box, you can be sure that no installation will occur on any Granite server, and you will also see additional debug messaging in the console log describing the results of identification of Vault packages in the workspace.
localDirectory : String (optional)
Specify a path relative to the workspace in which to scan for packages.

This field supports parameter tokens.
recursive : boolean (optional)
Check this box to install any sub-packages along with the deployed package.
replicate : boolean (optional)
Check this box to replicate each package after installation. This will not be attempted if the package installation fails, and only packages which have actually been installed by this step (rather than simply uploaded or skipped) will be replicated. This happens asynchronously, so you won't really know if the replication was successful or not unless you manually check your replication agent logs. For this reason, it might be better instead to deploy to each replication target directly.
requestTimeout : long (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
serviceTimeout : long (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
waitDelay : long (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.

$class: 'DeployPromotionBuilder'

hosts
- Type: com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>

$class: 'DeployScriptBuilder'

Execute any arbitrary SQL script on a selected database.

out : String
Specify full path to target connection file.

File location must be specified as:
- Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
in : String
Specify path to file that contains SQL script.

File location must be specified as:
- Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.

buildMasterDeployBuildToStage

Deploys (or re-deploys) a build to a particular stage.

Note: that when used in a pipeline step that the applicationId, releaseNumber, and buildNumber fields are required:

buildMasterDeployBuildToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, buildNumber: BUILDMASTER_BUILD_NUMBER)

applicationId : String
The identifier of the BuildMaster application to trigger the build for.

Options are:
- The BUILDMASTER_APPLICATION_ID variable populated by a previous step
- An application id
- An application name
releaseNumber : String
The BuildMaster release number to trigger the build for. Options are:
- BUILDMASTER_RELEASE_NUMBER: variable populated by a previous step
- Latest Active Release: will automatically get the latest active release number from BuildMaster for the selected application
- [Release Number]: a release number from the list of active releases
The job will fail if there is no active BuildMaster release.
buildNumber : String

The BuildMaster build number to trigger the deployment for.

The must be set to an existing build number. Typically this would be obtained from the output of the createBuild step which populates the BUILDMASTER_BUILD_NUMBER environment variable.
force : boolean (optional)
Force deployment into the stage, even if a previous stage has failed.
printLogOnFailure : boolean (optional)
If checked will print the BuildMaster log for the deployment to the Jenkins console if the build fails - but only if the "Wait until deployment completed" option is also checked.
stage : String (optional)

Optional. If not supplied, the next stage in the pipeline will be used.
variables : String (optional)

Set deployment level variables.
waitUntilCompleted : boolean (optional)
If checked waits until BuildMaster has completed the deployment, otherwise will exits immediately after triggering the deployment. Defaults to checked.

$class: 'Deployer'

stack : String
The GitHub repository where the stack is stored, in the form <owner>/<name> (no spaces!).
dryRun : boolean
Whether to deploy in dry-run mode.
branch : String
The repository branch to deploy.
apiKey : String
The Stack Hammer API key, copied from the stack settings dialog in the Stack Hammer user interface.

addDeployToDashboard

env : String
buildNumber : String

$class: 'DeploymentBuilder'

url : String
Enter the Convertigo server url here. COnvertigo server url is in this form
http://<server>:<port>/convertigo
userId : String
Enter the Convertigo server administration console userid here..
password : String
Enter the Convertigo server administration console password here.
enableZipFile : boolean
enableAutoDeploy : boolean
enableTestCase
- testcaseblock
  - projectname : String
    Select in this list here a project name you want to test. This list is retrieved from the target Convertigo server each time you add a new Test block.
  - testcasename : String
    Select in this list here a test case you want to run.
  - xpath : String
    By clicking the Execute Testcase button you will have the data resulting from a testcase. Reading this data you will be able to enter assertions in this text box your assertions. Supported Syntax is :
    
    assert ok
    xpath expression1
    xpath expression2
    ...
    xpath expressionn
    
    assert nok
    xpath expression1
    xpath expression2
    ...
    xpath expressionn
    
    All Xpath expressions below assert ok must match to have this test to be a success.
    One Xpath expressions below assert nok must match to have this test to be a failure.
    
    You can test you assertions by clicking the Validate XPath button. The test result will display beneath this text box.

reportDeployOperation

targetService : String (optional)
applicationName : String (optional)
applicationVersion : String (optional)
tags : String (optional)

$class: 'DescribeWithParamsBuilder'

starter : boolean
Do you want to show the name of the starter?
separator : String
Line end separator for your "Markup Formatter" setting.

For example, "" for "Plain text", and "<br>" for "Safe HTML".
excludes : String
The parameters that you want to hide, separated by ";".

$class: 'DescriptionSetterBuilder'

This plugin automatically sets a description for the build as a step during building.

A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.

The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable

regexp : String
If configured, the regular expression will be applied to each line in the build log. A description will be set based on the first match.
To select the version of a Maven release, you can use this regular expression:
```
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
```
description : String
The description to set on the build.
- If a regular expression is configured, every instance of \n will be replaced with the n-th group of the regular expression match.
- If the description is empty, the first group selected by the regular expression will be used as description.
- If no regular expression is configured, the description is taken verbatim.

$class: 'DestroyVM'

INSTANCE_NAME : String
GCP_PROJECT_ID : String
IMAGE_NAME : String

$class: 'DevOpsCreateArtifactPackageBuildStep'

name : String (optional)
Collection of artifact versions used as input to a CD pipeline, or for associating test results.
artifactsPayload : String (optional)
ArtifactPayload
"name" --> Artifact name for which different builds (artifact versions) are generated.
"version" --> Specific version of the artifact. Deployable component of an application generated by a CI build. When provided, semantic version is used.
"semanticVersion" --> Optional attribute of an artifact version that, when provided, is used to determine commits for a change. Semantic version format is (MAJOR.MINOR.PATCH).
"repository" --> Target for artifacts generated in a build, and also a source of artifacts required by a build.

Example:
{"artifacts":[{"name": "sa-web.jar", "version": "1.9", "repositoryName": "services-1031"}, {"name": "sa-db.jar", "version": "1.3.2", "repositoryName": "services-1032"}], "branchName": "master"}

$class: 'DevOpsRegisterArtifactBuildStep'

artifactsPayload : String (optional)
ArtifactPayload
"name" --> Artifact name for which different builds (artifact versions) are generated.
"version" --> Specific version of the artifact. Deployable component of an application generated by a CI build. When provided, semantic version is used.
"semanticVersion" --> Optional attribute of an artifact version that, when provided, is used to determine commits for a change. Semantic version format is (MAJOR.MINOR.PATCH).
"repository" --> Target for artifacts generated in a build, and also a source of artifacts required by a build.

Example:
{"artifacts":[{"name": "sa-web.jar", "version": "1.9", "repositoryName": "services-1031"}, {"name": "sa-db.jar", "version": "1.3.2", "repositoryName": "services-1032"}], "branchName": "master"}

devSpacesCreate

azureCredentialsId : String
aksName : String (optional)
kubeconfigId : String (optional)
resourceGroupName : String (optional)
sharedSpaceName : String (optional)
The name of the parent dev space of the current dev space.
spaceName : String (optional)

svCreateAndDeployVirtualService

Create and deploy Virtual Service from VSI/VSM, RR Pairs, or the following specifications: Swagger, WSDL, or RAML.

useCustomRegistry : boolean
Set to true to override the default global connection setting to CA DevTest registry for the particular project
host : String
The correct hostname or registry name needs to be entered
port : String
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
vseName : String
Use the name of the VSE to which you want this build step to apply
config : String
Configuration JSON

Example of using a configuration object that includes port and SSL information

{ "virtualService": { "version": "2", "name": "API_Test_1", "description": "Invoke API V2", "status": "" }, "transportProtocol": { "typeId": "HTTP", "basePath": "/", "useGateway": true, "duptxns": true, "hostHeaderPassThrough": false }, "dataProtocol": { "forRequest": true, "typeId": "RESTDPH" } }
deploy : String
If true will atomically deploy the newly created virtual service on to the VSE
undeploy : String
If selected will undeploy virtual service if it exists on Virtual Service Environment.
inputFile1 : String
Path to input file that will be uploaded to the VSE. The input file can be Request/Response (file or zip), VSM/VSI, Swagger, RAML, or WADL file.
Possibilities:
for files in job workspace you can specify:
- relative path to input file in job workspace (example: dir/test-req.txt)
for files on the DevTest machine you can specify:
- absolute path to file (example: file:///C:/something/test-req.txt)
- http location of input file (example: http://something/test-req.txt)
inputFile2 : String
Path to input file that will be uploaded to the VSE. The input file can be Request/Response or VSM/VSI file.
Possibilities:
for files in job workspace you can specify:
- relative path to input file in job workspace (example: dir/test-rsp.txt)
for files on the DevTest machine you can specify:
- absolute path to file (example: file:///C:/something/test-rsp.txt)
- http location of input file (example: http://something/test-rsp.txt)
activeConfig : String
Path to active project config file that will be uploaded to the VSE.
Possibilities:
for files in job workspace you can specify:
- relative path to input file in job workspace (example: dir/project.config)
for files on the DevTest machine you can specify:
- absolute path to file (example: file:///C:/something/project.config)
dataFiles : String
Path to data file that will be uploaded to the VSE. The input should be data file in one of the content type defined in <LISA_HOME>/contenttype.xml,
Possibilities:
for files in job workspace you can specify:
- relative path to input file in job workspace (example: dir/data.csv)
for files on the DevTest machine you can specify:
- absolute path to file (example: file:///C:/something/data.csv)
swaggerurl : String
Swagger (OpenAPI) 2.0 or 3.0 document URL
ramlurl : String
RAML 0.8 spec URL
wadlurl : String
WADL URL
tokenCredentialId : String

The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
Set to true if the CA DevTest API are set to accept only https connections

svDeployTest

Deploys and starts CA DevTest test or test suite provided as a .mar file.

Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

useCustomRegistry : boolean
Set to true to override the default global connection setting to CA DevTest registry for the particular project
host : String
The correct hostname or registry name needs to be entered
port : String
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
marFilePath : String
Path to MAR file that will be uploaded to the VSE. Needs to be relative path to MAR file in job workspace.
testType : String
Choose whether mar file contains test or test suite.
tokenCredentialId : String

The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
Set to true if the CA DevTest API are set to accept only https connections

svDeployVirtualService

Deploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.

Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

useCustomRegistry : boolean
Set to true to override the default global connection setting to CA DevTest registry for the particular project
host : String
The correct hostname or registry name needs to be entered
port : String
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
vseName : String
Use the name of the VSE to which you want this build step to apply
marFilesPaths : String
Path to MAR file that will be uploaded to the VSE. The field supports multiple strings delimited by a separate line or comma.
Possibilities:
for files in job workspace you can specify:
- relative path to MAR file in job workspace (example: dir/test.mar)
- path to MAR files using ant glob syntax (example: **/*.mar)
for files on the DevTest machine you can specify:
- absolute path to file (example: file:///C:/something/test.mar)
- http location of MAR file (example: http://something/test.mar)
tokenCredentialId : String

The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
Set to true if the CA DevTest API are set to accept only https connections

svStartVirtualService

Starts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.

Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

useCustomRegistry : boolean
Set to true to override the default global connection setting to CA DevTest registry for the particular project
host : String
The correct hostname or registry name needs to be entered
port : String
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
vseName : String
Use the name of the VSE to which you want this build step to apply
vsNames : String
Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
tokenCredentialId : String

The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
Set to true if the CA DevTest API are set to accept only https connections

svStopVirtualService

Stops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.

Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

useCustomRegistry : boolean
Set to true to override the default global connection setting to CA DevTest registry for the particular project
host : String
The correct hostname or registry name needs to be entered
port : String
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
vseName : String
Use the name of the VSE to which you want this build step to apply
vsNames : String
Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
tokenCredentialId : String

The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
Set to true if the CA DevTest API are set to accept only https connections

svUndeployVirtualService

Undeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.

Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established

useCustomRegistry : boolean
Set to true to override the default global connection setting to CA DevTest registry for the particular project
host : String
The correct hostname or registry name needs to be entered
port : String
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
vseName : String
Use the name of the VSE to which you want this build step to apply
vsNames : String
Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
tokenCredentialId : String

The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
Set to true if the CA DevTest API are set to accept only https connections

importDeveloperProfile

importIntoExistingKeychain : boolean (optional)
keychainId : String (optional)
keychainName : String (optional)
keychainPath : String (optional)
keychainPwd (optional)
- Type: class hudson.util.Secret
profileId : String (optional)

$class: 'DiawiUploader'

token : String
fileName : String
proxyHost : String
proxyPort : int
proxyProtocol : String

$class: 'DisableVirtualService'

serviceName : String

$class: 'DistTestingBuilder'

The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".

This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)

Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.

If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.

Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.

It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.

It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.

distLocations
- distDir : String
libLocations
- libDir : String
testDir : String

This specifies a relative path in the project workspace where compiled tests resides. For example if tests are in build/test/classes then type "build/test/classes". In case you check "Compile tests" checkbox this relative path will be used for storing compiled tests classes which were before check-out from a repository.
waitForNodes : boolean

Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
compileTests : boolean

If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".

$class: 'DockerBuilderControl'

option
- $class: 'DockerBuilderControlOptionProvisionAndStart'
  - cloudName : String
  - templateId : String
- $class: 'DockerBuilderControlOptionRun'
  - cloudName : String
  - image : String
  - pullCredentialsId : String
  - dnsString : String
  - network : String
  - dockerCommand : String
  - mountsString : String
  - volumesFrom : String
  - environmentsString : String
  - hostname : String
  - user : String
  - extraGroupsString : String
  - memoryLimit : int
  - memorySwap : int
  - cpus : String
  - cpuPeriod : long
  - cpuQuota : long
  - cpuShares : int
  - shmSize : int
  - bindPorts : String
  - bindAllPorts : boolean
  - privileged : boolean
  - tty : boolean
  - macAddress : String
- $class: 'DockerBuilderControlOptionStart'
  - cloudName : String
  - containerId : String
- $class: 'DockerBuilderControlOptionStop'
  - cloudName : String
  - containerId : String
  - remove : boolean
- $class: 'DockerBuilderControlOptionStopAll'
  - remove : boolean

$class: 'DockerBuilderNewTemplate'

Adds specified image configuration to all Docker Clouds.

dockerTemplate
- dockerTemplateBase
  - $class: 'DockerTemplateBase'
    - image : String
      The hash or tagged name of the image that you wish docker to run (e.g "docker run -i -t <id> /bin/bash")
    - bindAllPorts : boolean (optional)
    - bindPorts : String (optional)
      Bind ports from inside the container to outside of the host, scheme is hostport:containerport. Same effect as the "-p" or "-P" option on the CLI. Docker documentation
    - capabilitiesToAddString : String (optional)
      
      A list of new line separated capabilities.
      
      Each line represents an option for the --cap-add parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
      
      Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
    - capabilitiesToDropString : String (optional)
      
      A list of new line separated capabilities.
      
      Each line represents an option for the --cap-drop parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
      
      Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
    - cpuPeriod : long (optional)
      
      Set the period of CPUs to limit the container’s CPU usage.
      
      The default CPU CFS (Completely Fair Scheduler) period is 100000us.
      
      Consult Docker Run Documentation for further information.
    - cpuQuota : long (optional)
      
      Limits the container’s CPU usage.
      
      The default 0 value allows the container to take 100% of a CPU resource.
      
      Consult Docker Run Documentation for further information.
    - cpuShares : int (optional)
      Similarly the operator can increase the priority of this container. By default (no value), all containers run at the same priority and get the same proportion of CPU cycles, but you can tell the kernel to give more shares of CPU time to one or more containers when you start them via Docker.
      
      Consult Docker Run Documentation for further information.
    - cpus : String (optional)
      
      Specify how much of the available CPU resources a container can use as a floating point number.
      
      The default is not set.
      
      Consult Docker Run Documentation for further information.
    - devicesString : String (optional)
      New line separated list of devices to be mapped (e.g: /dev/fuse). The full scheme is origin:destination:permissions, although just specifying the origin is enough. Docker documentation
    - dnsString : String (optional)
      Set the DNS servers to use within your images, if not set Docker will use DNS settings of the host
    - dockerCommand : String (optional)
      Specifies a command to be executed upon containter start. Note this setting might have impact on the Launch mechanism, for example SSH Launcher do configure sshd with injected keys authentication, overriding this command might prevent the agent to start. Please refer to docker documentation for more details.
      Supplied command must keep the container running, so Jenkins can establish a remote connection at any time. If not set, Jenkins will configure a general purpose command to just wait for stdin.
      If you need your image to start some additional services, you should consider using an Entrypoint, and follow best practices so that the command is eventually executed by your entrypoint script.
    - environmentsString : String (optional)
      
      Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.
      
      Note that quotes are not interpreted.
      e.g. foo="bar" will result in the quotes being part of foo's value.
      
      Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
      e.g. The single setting:
      JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
      can be (accidentally) turned into three separate settings:
      JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
      thus preventing the configuration from working as was intended.
    - extraDockerLabelsString : String (optional)
      
      A list of new line separated docker labels to be set on the container, Specified in the form "label_name=value".
      
      This has no effect on Jenkins functionality, and is not related to the labels used by Jenkins to map jobs to agent nodes. These labels are metadata attached to the docker container itself (again, not the jenkins agent), and which can typically be read using the docker inspect command.
      
      This can be useful when using a docker cluster (like docker swarm) to pass information to the scheduler, in conjunction with constraints; or to let other services (portainer, prometheus...) know how they should categorize or otherwise deal with this specific container.
      
      Notes:
      
      spaces are the beginning and end of the label name and value will be removed
      
      invalid lines will be ignored
    - extraGroupsString : String (optional)
      Run a container with the specified additional groups (e.g. "docker run --group-add ...").
      Refer to the docker run command reference for the correct syntax.
    - extraHostsString : String (optional)
      A list of new line separated hostnames/IP mappings to be added to the container’s /etc/hosts file. Specified in the form "hostname:IP".
    - hostname : String (optional)
    - macAddress : String (optional)
      Container MAC address (e.g. 92:d0:c6:0a:29:33)
    - memoryLimit : int (optional)
      
      The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.
      
      When the processes inside the container exceed the memory limit, effects vary depending on your setup, e.g. out of memory errors may occur or the operating system could start killing processes.
      
      Consult Docker Run Documentation for further information.
      
      Note that on most Docker installations, the memory limit will not stop Jenkins/Docker from spawning so many containers that the machines total available memory will be exceeded. However, some Docker installations might be able to constrain the number of containers automatically using the memory limit.
    - memorySwap : int (optional)
      The operator can constrain the swap memory available to a container. This value is the total memory available to the container (swap + memory). To disable swap limit, you can set it to "-1".
      
      Consult Docker Run Documentation for further information.
    - mountsString : String (optional)
      New line separated list of host mounts : type=volume|bind|tmpfs|npipe[,src|source=<some source>],dst|destination|target=<some target>[,<key>=<value>]*
      See the official documentation
    - network : String (optional)
    - privileged : boolean (optional)
    - pullCredentialsId : String (optional)
    - securityOptsString : String (optional)
      
      A list of new line separated security options.
      
      Each line represents an option for the --security-opt parameter sent to the docker server. The options are in the format key=value.
      
      Please check https://docs.docker.com/engine/reference/run/#security-configuration for further information.
    - shmSize : int (optional)
      Size of /dev/shm in MB. If you omit the size entirely (or use the value 0), the system uses 64 MB.
      
      Consult Docker Run Documentation for further information.
    - tty : boolean (optional)
    - user : String (optional)
      Run a container with the specified user (e.g. "docker run --user ...").
      Refer to the docker run command reference for the correct syntax. Note that you have to specify a numeric uid if you want to run a container as a user, which exists on the host machine but does not exist within the container.
    - volumesFromString : String (optional)
      New line separated list of volumes to inherit from another container. Specified in the form <container name>[:<ro|rw>]
      If accessmode not specified, then default rw will be used.
      See the official documentation
- connector
  
  For all connection methods, Jenkins will start by triggering a docker run. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.
  
  There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.
  
  Attach Docker container
  
  This method runs a container, then connects to it using docker exec, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
  
  Connect with JNLP
  
  The container will only be passed an initial docker run command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
  
  Connect with SSH
  
  The specified image is expected to run an SSH server. Then, it will treat that computer like it usually does for any SSH connected agent: the master will log into it, copy the remoting agent, then start it.
  - attach
    - entryPointCmdString : String (optional)
    - javaExe : String (optional)
    - jvmArgsString : String (optional)
    - user : String (optional)
      User that the Jenkins agent code will run as.
      The container's default user (typically "root") will be used if this is left blank.
  - jnlp
    - jnlpLauncher
      Nested Choice of Objects
      inbound
      
      tunnel : String
      
      webSocket : boolean (optional)
      Use WebSocket to connect to the Jenkins master rather than the TCP port. See JEP-222 for background.
      
      workDirSettings (optional)
      Nested Object
      disabled : boolean
      Allows disabling Remoting Work Directory for the agent. In such case the agent will be running in the legacy mode without logging enabled by default.
      
      workDirPath : String
      If defined, a custom Remoting work directory will be used instead of the Agent Root Directory. This option has no environment variable resolution so far, it is recommended to use only absolute paths.
      
      internalDir : String
      Defines a storage directory for the internal data. This directory will be created within the Remoting working directory.
      
      failIfWorkDirIsMissing : boolean
      If defined, Remoting will fail at startup if the target work directory is missing. The option may be used to detect infrastructure issues like failed mount.
    - entryPointArgumentsString : String (optional)
    - jenkinsUrl : String (optional)
      If needed, the Jenkins URL can be overwritten with this property (e.g. to support other HTTP(S) endpoints due to reverse proxies or firewalling). By default the URL from the global Jenkins configuration is used.
    - user : String (optional)
      User that the jenkins agent process will be run as. If not specified, the image's default user (typically "root").
  - ssh
    - sshKeyStrategy
      Define how a SSH key pair is configured for ssh authentication in container.
      
      Nested Choice of Objects
      $class: 'InjectSSHKey'
      
      user : String
      Injected SSH key will let agent start as root in container. If you want to use another user configure it's name here. Please note such a user must pre-exist in container image.
      
      $class: 'ManuallyConfiguredSSHKey'
      
      credentialsId : String
      
      sshHostKeyVerificationStrategy
      Nested Choice of Objects
      $class: 'KnownHostsFileKeyVerificationStrategy'
      
      Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.
      
      This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins controller to update the file as required, potentially using the ssh hostname command to initiate a connection and update the file appropriately.
      
      $class: 'ManuallyProvidedKeyVerificationStrategy'
      
      Checks the key provided by the remote host matches the key set by the user who configured this connection.
      
      key : String
      The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.
      
      $class: 'ManuallyTrustedKeyVerificationStrategy'
      
      Checks the remote key matches the key currently marked as trusted for this host.
      
      Depending on configuration, the key will be automatically trusted for the first connection, or an authorised user will be asked to approve the key. An authorised user will be required to approve any new key that gets presented by the remote host.
      
      requireInitialManualTrust : boolean
      Require a user with Computer.CONFIGURE permission to authorise the key presented during the first connection to this host before the connection will be allowed to be established.
      
      If this option is not enabled then the key presented on first connection for this host will be automatically trusted and allowed for all subsequent connections without any manual intervention.
      
      $class: 'NonVerifyingKeyVerificationStrategy'
      
      Does not perform any verification of the SSH key presented by the remote host, allowing all connections regardless of the key they present.
    - javaPath : String (optional)
    - jvmOptions : String (optional)
    - launchTimeoutSeconds : int (optional)
    - maxNumRetries : int (optional)
      The number of times that attempts to connect to the newly-spun Docker container will be retried before the operation is abandoned.
      Note: That this field applies first to checks that the SSH port is open for new TCP connections, and secondly to checks that the SSH service that owns the TCP port is accepting SSH connections.
      e.g. a value of 3 would mean that (up to) 4 attempts (1 initial attempt plus 3 retries) would be made to check the availability of the TCP port, followed by (up to) 4 attempts (1 initial attempt plus 3 retries) to check the availability of the SSH service itself.
    - port : int (optional)
    - prefixStartSlaveCmd : String (optional)
    - retryWaitTime : int (optional)
      Number of seconds to wait between attempts to connect to the newly-started Docker container.
    - suffixStartSlaveCmd : String (optional)
- labelString : String
  Labels to give these nodes (for limiting your builds)
- instanceCapStr : String
  
  The maximum number of containers, based on this template, that this provider is allowed to run in total. A negative value, or zero, or 2147483647 all mean "no limit" is imposed on the this template, although the overall cloud instance limit (if any) will still apply.
  
  Note that containers which have not been created by Jenkins are not included in this total.
  
  As an alternative, some Docker setups can also determine the maximum number of containers automatically using memory/cpu constraints.
- disabled (optional)
  - disabledByChoice : boolean (optional)
  - enabledByChoice : boolean (optional)
    If not ticked then this functionality will be disabled.
    This can be used to e.g. take a cloud or template out of action for maintenance etc.
    Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.
- mode (optional)
  - Values: NORMAL, EXCLUSIVE
- name : String (optional)
  Name prefix to use for all the Jenkins nodes created from this template.
  Jenkins will append a unique ID to this name in order to create individual node names.
  If blank or just whitespace, a default of "docker" will be used.
- nodeProperties (optional)
  - Type: ? extends hudson.slaves.NodeProperty<?>
- pullStrategy (optional)
  Pull strategy during provisioning before image run.
  - Values: PULL_ALWAYS, PULL_LATEST, PULL_NEVER
- pullTimeout : int (optional)
  Timeout, in seconds, to apply when expecting data from the Docker API when performing the docker pull operation. 0 means no time limit, but this is not recommended (if your docker API locks up, some aspects of Jenkins can also lock up).
  i.e. you probably want this set to as long as it takes to pull the entire image onto a fresh docker server. e.g. a few minutes.
  Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).
- remoteFs : String (optional)
  Root directory within your image for the Jenkins user to use
- removeVolumes : boolean (optional)
  Remove the volumes associated to the container during container remove.
- retentionStrategy (optional)
  
  Specify the strategy when docker containers shall be started and stopped:
  
  Docker Once Retention Strategy (default)
  
  For each job in the queue, an own docker container is started. Once the job has finished, the container is shut down.
  
  Docker Cloud Retention Strategy (experimental)
  
  Based on the workload provided by the queue (load average), new docker containers are started on demand. After the job(s) have finished, the container is not shut down immediately. If no new job was executed on this agent/container during the period of the Idle delay, the container is shut down.
  
  Keep this agent on-line as much as possible (experimental)
  
  Starts as many containers as specified in the Instance Capacity (obeying the Container Cap) and tries to keep them always running (i.e. a new container is started in case another one belonging to this template was shut down).
  
  Take this agent on-line according to a schedule (experimental)
  
  Based on a cron-schedule agents are brought on-line and will keep running. Once the specified period in the schedule is over, the agents will be shut down.
  
  Take this agent on-line when in demand and off-line when idle (experimental)
  
  Containers are started if there are jobs waiting for execution in the queue. They are only started, if the jobs are waiting a certain threshold of time there (In demand delay). After the jobs have finished, the container is not shut down immediately. If no new job was executed on this agent/container during the period of the Idle delay, the container is shut down.
  - idleMinutes : int
    Number of minutes of idleness after which to kill the agent; serves a backup in case the strategy fails to detect the end of a task
  - numberOfTasksInProgress : int (optional)
  - terminateOnceDone : boolean (optional)
- stopTimeout : int (optional)
  Timeout, in seconds, to apply when stopping the container after a job has finished. The default of 10s is fine for most cases. However, if you container needs to do some cleanup after the agent has stopped you can increase the timeout. If the container fails to stop gracefully before the timeout ends, the container will be killed.

$class: 'DockerBuilderPublisher'

Build step that sends a Dockerfile for building to docker host that used for this build run.

dockerFileDirectory : String
fromRegistry
- url : String
  URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
- credentialsId : String
cloud : String
Cloud to do the build on - or, if empty, use the cloud that the build was performed on.
tagsString : String
Repository name (and optionally a tag) to be applied to the resulting image in case of success.
Multiple entries are permitted if separated by newlines.
Environment variable substitution is performed on the strings so you can use e.g. ${BUILD_NUMBER} as part of each entry.
Each entry must be of the form IMAGE[:TAG] as per the docker tag command.
pushOnSuccess : boolean
If enabled (and the docker image builds successfully), the resulting docker image will be pushed to the registry (or registries) specified within the "Image" field.
pushCredentialsId : String
Credentials to push to a private registry.
cleanImages : boolean
cleanupWithJenkinsJobDelete : boolean
buildArgs (optional)

A map of build-time variables.
- Type: java.util.Map<java.lang.String, java.lang.String>
buildArgsString : String (optional)

A list of new line separated build-time variables, specified in the form "name=value".
noCache : boolean (optional)
If set, builds the image with --no-cache which disables caching of layers. See the docker build command for more information.
pull : boolean (optional)
If set, builds the image with --pull to pull the latest version of the base image, instead of using the local one. See the docker build command for more information.

$class: 'DockerComposeBuilder'

useCustomDockerComposeFile : boolean
dockerComposeFile : String
option
- $class: 'ExecuteCommandInsideContainer'
  - privilegedMode : boolean
  - service : String
  - command : String
  - index : int
  - workDir : String
- $class: 'StartAllServices'
- $class: 'StartService'
  - service : String
  - scale : int
- $class: 'StopAllServices'
- $class: 'StopService'
  - service : String

$class: 'DockerPullImageBuilder'

registry
- url : String
  URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
- credentialsId : String
image : String
Image ID on DockerHub. When set in combination with DockerHub trigger, a build will run when dockerhub builds a new image.

dockerShell

connector (optional)
- $class: 'CloudNameDockerConnector'
  - cloudName : String
- $class: 'DockerConnector'
  - serverUrl : String
    The URL to use to access your Docker server API (e.g: http://172.16.42.43:4243 or unix://).
  - apiVersion : String (optional)
    Docker Daemon API version. Should be set when plugin underlying library can't connect to new daemon because docker daemon API become backward incompatible.
    Version in format "1.22". Connector will append "/v${VERSION}" to api url for connector, where ${VERSION} is entered string. For details see docker_remote_api
  - connectTimeout : int (optional)
    Timeout for opening connection to Docker API. 0 is infinity.
    Works only for Jersey.
  - connectorType (optional)
    Docker-java provides different connection implementations based on different client libraries. In case you have some errors please try other.
    - Values: JERSEY, NETTY, OKHTTP
  - credentialsId : String (optional)
  - readTimeout : int (optional)
    Read timeout to Docker API. In seconds. 0 is infinity.
containerLifecycle (optional)
- createContainer (optional)
  - bindAllPorts : boolean (optional)
  - bindPorts : String (optional)
    Bind ports from inside the container to outside of the host, scheme is hostport:containerport. Same effect as the "-p" or "-P" option on the CLI. Docker documentation
  - command : String (optional)
    The command to run for this image, replaced by Jenkins Launchers
  - cpuShares : int (optional)
    Similarly the operator can increase the priority of this container. By default (no value), all containers run at the same priority and get the same proportion of CPU cycles, but you can tell the kernel to give more shares of CPU time to one or more containers when you start them via Docker.
    
    Consult https://docs.docker.com/engine/reference/run/#cpu-share-constraint for further information.
  - cpusetCpus : String (optional)
    Please follow format described at https://docs.docker.com/engine/reference/run/#cpuset-constraint
  - cpusetMems : String (optional)
    https://docs.docker.com/engine/reference/run/#cpuset-constraint
  - devicesString : String (optional)
    Add host device to container. For format please refer to Add host device to container (--device) documentation
  - dnsString : String (optional)
    Set the DNS servers to use within your images, if not set Docker will use DNS settings of the host
  - dockerLabelsString : String (optional)
  - entrypoint : String (optional)
  - environmentString : String (optional)
  - extraHostsString : String (optional)
    A list of new line separated hostnames/IP mappings to be added to the container’s /etc/hosts file. Specified in the form "hostname:IP".
  - hostname : String (optional)
  - linksString : String (optional)
    Add link to another container. Only the form container:alias is supported (e.g. the_db_container:db).
    Consult https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/#communication-across-links for further information.
  - macAddress : String (optional)
    Container MAC address (e.g. 92:d0:c6:0a:29:33)
  - memoryLimit : long (optional)
    The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.
    
    Consult Docker Run Documentation for further information.
  - networkMode : String (optional)
    Set the Network mode for the container:
    - Empty: undefined, docker daemon defaults
    - 'bridge': creates a new network stack for the container on the docker bridge
    - 'none': no networking for this container
    - 'container:<name | id>': reuses another container network stack
    - 'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
  - privileged : boolean (optional)
  - restartPolicy (optional)
    - policyName
      - Values: NO, UNLESS_STOPPED, ALWAYS, ON_FAILURE
    - maximumRetryCount : int
  - shmSize : long (optional)
  - tty : boolean (optional)
  - user : String (optional)
  - volumesFromString : String (optional)
    New line separated list of volumes to inherit from another container. Specified in the form <container name>[:<ro|rw>]
    If accessmode not specified, then default rw will be used.
  - volumesString : String (optional)
    New line separated list of host volume mounts : <host/path>[<container/path>[<:mode>]]
    
    container/path create empty volume container/path
    
    host/path:container/path will mount host/path from host to container's container/path, read/write
    
    host/path:container/path:rw will mount host/path from host to container's container/path, read/write
    
    host/path:container/path:ro will mount host/path from host to container's container/path, read-only
    
    Note: if access mode not specified, then default rw will be used.
  - workdir : String (optional)
- image : String (optional)
  The hash or tagged name of the image that you wish docker to run (e.g "docker run -i -t /bin/bash")
- pullImage (optional)
  - connector (optional)
    - $class: 'CloudNameDockerConnector'
      cloudName : String
    - $class: 'DockerConnector'
      serverUrl : String
      The URL to use to access your Docker server API (e.g: http://172.16.42.43:4243 or unix://).
      
      apiVersion : String (optional)
      Docker Daemon API version. Should be set when plugin underlying library can't connect to new daemon because docker daemon API become backward incompatible.
      Version in format "1.22". Connector will append "/v${VERSION}" to api url for connector, where ${VERSION} is entered string. For details see docker_remote_api
      
      connectTimeout : int (optional)
      Timeout for opening connection to Docker API. 0 is infinity.
      Works only for Jersey.
      
      connectorType (optional)
      Docker-java provides different connection implementations based on different client libraries. In case you have some errors please try other.
      
      Values: JERSEY, NETTY, OKHTTP
      
      credentialsId : String (optional)
      
      readTimeout : int (optional)
      Read timeout to Docker API. In seconds. 0 is infinity.
  - credentialsId : String (optional)
    Credentials for pulling docker image. Supported only "Docker Registry Auth" type.
  - pullStrategy (optional)
    - Values: PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVER
  - registriesCreds (optional)
    - registryAddr : String
    - credentialsId : String
- removeContainer (optional)
  - force : boolean (optional)
    Force the removal of a running container (uses SIGKILL)
  - removeVolumes : boolean (optional)
    Remove the volumes associated with the container
- stopContainer (optional)
  - connector (optional)
    - $class: 'CloudNameDockerConnector'
      cloudName : String
    - $class: 'DockerConnector'
      serverUrl : String
      The URL to use to access your Docker server API (e.g: http://172.16.42.43:4243 or unix://).
      
      apiVersion : String (optional)
      Docker Daemon API version. Should be set when plugin underlying library can't connect to new daemon because docker daemon API become backward incompatible.
      Version in format "1.22". Connector will append "/v${VERSION}" to api url for connector, where ${VERSION} is entered string. For details see docker_remote_api
      
      connectTimeout : int (optional)
      Timeout for opening connection to Docker API. 0 is infinity.
      Works only for Jersey.
      
      connectorType (optional)
      Docker-java provides different connection implementations based on different client libraries. In case you have some errors please try other.
      
      Values: JERSEY, NETTY, OKHTTP
      
      credentialsId : String (optional)
      
      readTimeout : int (optional)
      Read timeout to Docker API. In seconds. 0 is infinity.
  - timeout : int (optional)
    Sending SIGTERM and then SIGKILL after a grace period
executorScript : String (optional)
longConnector (optional)
- $class: 'CloudNameDockerConnector'
  - cloudName : String
- $class: 'DockerConnector'
  - serverUrl : String
    The URL to use to access your Docker server API (e.g: http://172.16.42.43:4243 or unix://).
  - apiVersion : String (optional)
    Docker Daemon API version. Should be set when plugin underlying library can't connect to new daemon because docker daemon API become backward incompatible.
    Version in format "1.22". Connector will append "/v${VERSION}" to api url for connector, where ${VERSION} is entered string. For details see docker_remote_api
  - connectTimeout : int (optional)
    Timeout for opening connection to Docker API. 0 is infinity.
    Works only for Jersey.
  - connectorType (optional)
    Docker-java provides different connection implementations based on different client libraries. In case you have some errors please try other.
    - Values: JERSEY, NETTY, OKHTTP
  - credentialsId : String (optional)
  - readTimeout : int (optional)
    Read timeout to Docker API. In seconds. 0 is infinity.
shellScript : String (optional)

$class: 'DoktorStep'

server : String
markdownIncludePatterns
- value : String
markdownExcludePatterns
- value : String
asciidocIncludePatterns
- value : String
asciidocExcludePatterns
- value : String

$class: 'DotNetCoreRunner'

targetCode : String

Your c# code to execute, the plugin will rebuild your code if detect some change. These are some examples of the target code for this plugin:

Simple example:

            //Simple Example
            public class JenkinsPlugin
            {
                public static void ScriptMain()
                {
                    Console.WriteLine("Hello World from c#!!!");
                }
            }

Saving environment variables:

            // Complete example
            using DotNetTools.Jenkins;
            using System;

            public class JenkinsPlugin
            {
                public static void ScriptMain(JenkinsManager manager)
                {
                    Console.WriteLine("Hello World from c#!!!");
                    manager.SetSessionEnv("PI", Math.PI.ToString());
                }
            }

You can use this two methods from the DotNetTools.Jenkins.JenkinsManager class:

            public void SetSessionEnv(string key, string value);
            public string GetSessionEnv(string key);

additionalPackages : String
A json object that represents the additional packages required to compile the c# code:
Examples:
- { "Nancy": "2.0.0-clinteastwood", "System.ValueTuple": "4.3.0"}
- { "Nancy": null}
Note that if you specify a null value for a package version then the latest one will be used.

downloadDS

dsn : String
getETag : boolean (optional)
vol : String (optional)

downloadProgetPackage

Downloads a universal ProGet package to specified folder and will optionally unpack it for you.

Download options are:

Package - Download ProGet universal package (ZIP file with extension of 'upack')
Content as ZIP - Download content as ZIP file
Content as TGZ - Download content as TGZ file
Unpack Content - Extract the package content once downloaded

In all cases except 'Unpack Content' the environment variable PROGET_FILE will be populated with the name of the downloaded file

See Inedo documentation.

feedName : String
groupName : String
packageName : String
version : String
downloadFormat : String
downloadFolder : String
The folder to download the package to. The path can include environment variables in the format ${VAR} or $VAR.
If a full pathname is not supplied then the downloaded package 'should' end up in the workspace, but this is not guaranteed. If you wish the package to be placed in the workspace the it is best to use the Jenkins variable ${WORKSPACE}

See the list of available environment variables.

crxDownload

Download CRX Content Package files from a configured Adobe Granite repository into the workspace via the CRX Package Manager.

packageIds : String (optional)
Specify a list of package IDs to download to the workspace. Each package ID string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version".

This field supports parameter tokens.
baseUrl : String (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http://deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:

http://deployer:Password123@localhost:4502

This field supports parameter tokens.
credentialsId : String (optional)
Select the login credentials with which content packages will be downloaded from the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
ignoreErrors : boolean (optional)
Check this box to ignore errors during download such that the build continues after completion of this step.
localDirectory : String (optional)
Specify a path relative to the workspace to which packages will be downloaded.

This field supports parameter tokens.
rebuild : boolean (optional)
Check this box to rebuild each package before downloading it. If rebuilding a package fails, the job will fail, unless Ignore Errors is also checked. If there are errors during rebuild, but it is ultimately reported as successful, then the job will be marked as unstable and the download step will continue.
requestTimeout : long (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
serviceTimeout : long (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
waitDelay : long (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.

googleStorageDownload

credentialsId : String
bucketUri : String

This specifies the cloud object to download from Cloud Storage. You can view these by visiting the "Cloud Storage" section of the Cloud Console for your project.
A single asterisk can be specified in the object path (not the bucket name), past the last "/". The asterisk behaves consistently with gsutil. For example, gs://my-bucket-name/pre/a_*.txt would match the objects in cloud bucket my-bucket-name that are named pre/a_2.txt or pre/a_abc23-4.txt, but not pre/a_2/log.txt.
localDirectory : String
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
- path/to/dir
pathPrefix : String (optional)

The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.

$class: 'DoxygenBuilder'

doxyfilePath : String
installationName : String
continueOnBuildFailure : boolean
unstableIfWarnings : boolean

$class: 'DrMemoryBuilder'

executable : String
arguments : String
logPath : String
treatFailed : boolean
Enable this if dr-memory command line interface returns a non-zero return value even when the program creates a proper analysis

$class: 'DropAllBuilder'

changeLogFile : String (optional)
changeLogParameters : String (optional)
contexts : String (optional)
Liquibase contexts to execute under.
credentialsId : String (optional)
installationName : String (optional)
labels : String (optional)
Liquibase labels to execute
liquibasePropertiesPath : String (optional)
A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
password : String (optional)
resourceDirectories : String (optional)
Leave blank for workspace root. May be relative to workspace or an absolute path.
url : String (optional)
example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
username : String (optional)

$class: 'DrupalInstanceBuilder'

db : String
Specify the database connection string, e.g. mysql://user:password@localhost/db
root : String
Specify a local directory for the Drupal root (relative to the workspace root). If left empty, the workspace root itself will be used.
profile : String
Specify an installation profile. Drupal 7 natively includes three installation profiles: 'minimal', 'standard' and 'testing'.
refresh : boolean

If checked, every build will wipe out and recreate a fresh Drupal instance.

Note that creating a fresh Drupal instance sends an email to the site administrator (by default admin@example.net) which may be annoying.
updb : boolean
If checked, every build will run update.php. This option only makes sense if 'Create a fresh installation for every build' is unchecked.

$class: 'DrupalReviewBuilder'

Review code using the Coder Review module.

If your code base does not include Coder, then Coder will be downloaded automatically.

style : boolean
comment : boolean
sql : boolean
security : boolean
i18n : boolean
root : String
Specify a local directory for the Drupal root (relative to the workspace root). If left empty, the workspace root itself will be used.
logs : String
Specify a local directory to dump code review results (relative to the workspace root). Use the Checkstyle plugin to interpret results in a post-build action.
except : String
Specify modules/themes that should not be reviewed, relative to the Drupal root directory.

For instance if you want to review only custom code then you might want to exclude contributed and core projects:
```
    sites/all/modules/contrib/**,
    sites/all/themes/contrib/**,
    modules/**,
    themes/**,
    profiles/**
    
```
This field supports FileSet includes.
ignoresPass : boolean

If checked, warnings flagged as ignored will pass.

Note that the ignore system was introduced in Coder 7.x-2.4. This option will be ignored if using an older version of Coder.

$class: 'DrupalTestsBuilder'

uri : String
URI of the Drupal site. Simpletest requires this option to be set.
root : String
Specify a local directory for the Drupal root (relative to the workspace root). If left empty, the workspace root itself will be used.
logs : String
Specify a local directory to dump test results (relative to the workspace root). Use the JUnit plugin to interpret results in a post-build action.

exceptGroups : String

Specify Simpletest groups that should not be tested. For instance if you want to run tests only on custom code then you might want to exclude core groups:

  Actions, Aggregator, AJAX, Batch API, Block, Blog, Book, Bootstrap, Cache, Color, Comment, Contact, Contextual, Dashboard, Database, DBLog, Entity API, Field API, Field types, Field UI, File, File API, File API (remote), Filter, Form API, Forum, Help, Image, Locale, Mail, Menu, Module, Node, OpenID, Pager, Path, Path API, PHP, Poll, Profile, RDF, Search, Session, Shortcut, SimpleTest, Statistics, Syslog, System, Taxonomy, Theme, Tracker, Translation, Trigger, Update, Update API, Upgrade path, User, XML-RPC

Multiple groups can be separated by a comma.

exceptClasses : String

Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.

Multiple classes can be separated by a comma.

$class: 'ECXCDMBuilder'

name : String
Enter the ECX user name.
password : String
Enter the ECX password.
url : String
Enter the ECX URL and then press the Test Connection button to ensure this job can contact the ECX server.
job : String
Enter a job id that can be found in the list above and in square brackets.
production : boolean
Select this checkbox if using ECX in production with a valid certificate.
maxWaitTime : int
Enter the amount of time in seconds to wait for an ECX job to complete.

$class: 'EclipseBuckminsterBuilder'

installationName : String
commands : String
logLevel : String
params : String
targetPlatformName : String
userTemp : String
userOutput : String
userCommand : String
userWorkspace : String
globalPropertiesFile : String
equinoxLauncherArgs : String

$class: 'EditVirtualService'

config : String

eggplantRunner

CACertPath : String (optional)
backoffFactor : String (optional)
clientId : String (optional)
clientSecret (optional)
- Type: class hudson.util.Secret
dryRun : boolean (optional)
eggplantRunnerPath : String (optional)
logLevel (optional)
- Values: INFO, DEBUG, WARNING, ERROR
modelName : String (optional)
pollInterval : String (optional)
requestRetries : String (optional)
requestTimeout : String (optional)
serverURL : String (optional)
suiteName : String (optional)
testConfig (optional)
- $class: 'ModelBased'
  - name : String
  - model : String
- $class: 'ScriptBased'
  - name : String
  - suite : String
- $class: 'TestConfigId'
  - id : String
testConfigId : String (optional)
testConfigName : String (optional)
testEnvironmentTimeout : String (optional)
testResultPath : String (optional)

$class: 'ElasticsearchQueryBuilder'

query : String
Elastic Search query to run
aboveOrBelow : String
Whether the threshold value is too high or too low. If set to gte counts greater than or equal to threshold will fail the build. If set to lte counts less than or equal to threshold with fail the build.
threshold : long
The count of query results in a given time to trigger build failure
since : long
How long ago to look back for results relative to the time the build executes must be greater than 0.
units : String
Time units for the since value

$class: 'EnableVirtualService'

serviceName : String

$class: 'EndAnalysisBuildStep'

restoreBuildFile
- shouldRestore : boolean
  SeaLights Jenkins Plugin updates the customer's build file by adding relevant plugins automatically. Customers which would like to keep the build file as is, should check this option. By checking this option, SeaLights Jenkins Plugin will override the modified build file with a copy of the original one, thus overriding its changes to the file.
- folders : String
- parentPom : String

$class: 'EnvInjectBuilder'

propertiesFilePath : String
propertiesContent : String

$class: 'EnvPropagatorBuilder'

envVariableString : String
Provide build env variables in format PARAM1=VAL1:PARAM2=VAL2... Existing build env variables will be overwritten and the new ones will be added and made available to the next build steps.

$class: 'EnvironmentManagerBuilder'

systemId : int
environmentId : int
instanceId : int
copyToServer : boolean
newEnvironmentName : String
serverType : String
serverId : int
serverHost : String
serverName : String
copyDataRepo : boolean
repoType : String
repoHost : String
repoPort : int
repoUsername : String
repoPassword : String
abortOnFailure : boolean

$class: 'EnvironmentTagBuilder'

credentials : String
region : String

$class: 'EstimateBuilder'

name : String
The name field is used to specify the PaaSLane application that the artifacts mapped later will be associated with. For example, if the name of this field is "My Application" and you match 3 artifacts, there will be an application "My Application" with 3 modules that get profiled.
token : String
The "Authentication Token" field contains the PaaSLane token associated with a specific user in a specific tenant. This token can be gotten by logging into PaaSLane, clicking the username dropdown and selecting to "Get Token". Once you have clicked this option you should be presented with the time sensitive token.
archiveFilePath : String
This optional value specifies an offset from the workspace of where to start looking for artifacts to include in the application. This, paired with "Regular Expression for Selecting Modules" and "Exclude Regular Expressions" help to specify included artifacts.
regWhichIncludedModules : String
This value specifies the Ant style regular expression used to search for artifacts residing under "Path to Artifact(s)". For examples of Ant Style regular expressions, please see examples.
reportConfigName : String
Name of the Report Config to use when generating the Report. If you leave this field blank, PaaSLane will use the Default Report Config.

To see your existing Report Configs, go to the PaaSLane UI, click "Applications", and click "New Report" next to an existing application. Under the "Create Report" button, you will see a dropdown that contains a list of existing Report Configs. You can click "Advanced" to see details and further configure your report.
uri : String
The "PaaSLane URL" field specifies the root url, including the host, port and context that define the location of the PaaSLane profiling environment to use. For most SaaS customers, this will be https://agent.paaslane.com/paaslaneagentserver. However, customers utilizing distributed profiling, will want to get their URL from their administrator.
saasuri : String
The "PaaSLane SaaS URL" field specifies the root url, including the host, port and context that define the location of the PaaSLane profiling environment to use. For most customers, this will be https://app.paaslane.com/paaslane.
language : String
The "Language" selection specifies which language rules should be applied to the artifacts that are uploaded and profiled.
regexExclude : String
The "Exclude Regular Expressions" field contains a comma separated list of regular expression patterns that will be applied to every matched artifact. If any of the patterns match the path of the artifact being reviewed, then that artifact will not be sent to PaaSLane. Examples of these regular expressions can be found here.
testOnly : boolean
The "Test, but don't send files" field, when checked, will only display the files that would have been sent, based on the parameters. Use this field to get the parameters correct.
maxNumberOfViolations : long
"Fail when Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable alerts. Anything more than this number will cause a failure.
failBlockTotalVio : boolean
The "Fail when Total Alert count greater than..." selection specifies if builds should be failed based on the total number of Alerts found.
- If this is not selected, builds will never be failed based on the number of total alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of total alerts provided.
maxNumberOfBlockerViolations : long
"Fail when Blocker Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable blocker alerts. Anything more than this number will cause a failure.
failBlockBlockerVio : boolean
The "Fail when Blocker Alert count greater than..." selection specifies if builds should be failed based on the number of Blocker Alerts found.
- If this is not selected, builds will never be failed based on the number of blocker alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of blocker alerts provided.
maxNumberOfImportantViolations : long
"Fail when Important Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable important alerts. Anything more than this number will cause a failure.
failBlockImportantVio : boolean
The "Fail when Important Alert count greater than..." selection specifies if builds should be failed based on the number of Important Alerts found.
- If this is not selected, builds will never be failed based on the number of important alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of important alerts provided.
maxNumberOfOptimizationViolations : long
"Fail when Optimization Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable optimization alerts. Anything more than this number will cause a failure.
failBlockOptimizationVio : boolean
The "Fail when Optimization Alert count greater than..." selection specifies if builds should be failed based on the number of Optimization Alerts found.
- If this is not selected, builds will never be failed based on the number of optimization alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of optimization alerts provided.
maxNumberOfWarningViolations : long
"Fail when Warning Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable optimization alerts. Anything more than this number will cause a failure.
failBlockWarningVio : boolean
The "Fail when Warning Alert count greater than..." selection specifies if builds should be failed based on the number of Warning Alerts found.
- If this is not selected, builds will never be failed based on the number of warning alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of warning alerts provided.

examTest_ExecutionFile

For projects that use EXAM as the test system. This causes Jenkins to invoke EXAM with the given options.

examName : String
pythonName : String
examReport : String
systemConfiguration : String (optional)
clearWorkspace : boolean (optional)
javaOpts : String (optional)
logging : boolean (optional)
loglevelLibCtrl : String (optional)
loglevelTestCtrl : String (optional)
loglevelTestLogic : String (optional)
pathExecutionFile : String (optional)
pathPCode : String (optional)
pdfMeasureImages : boolean (optional)
pdfReport : boolean (optional)
pdfReportTemplate : String (optional)
pdfSelectFilter : String (optional)
reportPrefix : String (optional)
testrunFilter (optional)
- name : String
- value : String
- adminCases : boolean
- activateTestcases : boolean
timeout : int (optional)

examTest_Model

For projects that use EXAM as the test system. This causes Jenkins to invoke EXAM with the given options.

examName : String
pythonName : String
examReport : String
executionFile : String (optional)
systemConfiguration : String (optional)
clearWorkspace : boolean (optional)
examModel : String (optional)
javaOpts : String (optional)
logging : boolean (optional)
loglevelLibCtrl : String (optional)
loglevelTestCtrl : String (optional)
loglevelTestLogic : String (optional)
modelConfiguration : String (optional)
pdfMeasureImages : boolean (optional)
pdfReport : boolean (optional)
pdfReportTemplate : String (optional)
pdfSelectFilter : String (optional)
reportPrefix : String (optional)
testrunFilter (optional)
- name : String
- value : String
- adminCases : boolean
- activateTestcases : boolean
timeout : int (optional)

runexe

exeName : String
cmdLineArgs : String (optional)
failBuild : boolean (optional)

executeCerberusCampaign

campaignName : String
Enter the campaign name.
environment : String
browser : String
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
screenshot : String
verbose : String
pageSource : String
seleniumLog : String
timeOut : String
retries : String
priority : String
tag : String
Tag for the execution of this campaign. Tag is used to group and display all testcases execution of the campaign.
Use $[current_timestamp] to put the current timestamp to the job execution.
ss_p : String
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
ssIp : String
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
robot : String
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
manualHost : String
manualContextRoot : String
country : String
If empty, the countries defined on the campaign will be used.
cerberusUrl : String
timeOutForCampaignExecution : int
executor : String

$class: 'ExecuteCommandAction'

command : String
The command to apply to the issue, can be left empty to only send a comment.
search : String
Search query to find issues to update. If both search query and and issue in text is set, the command will be applied to the union of the two.
issueInText : String
Text to search for issues ids for which the command will be applied. If both search query and issue in text is set, the command will be applied to the union of the two. Entering ${YOUTRACK_CHANGES} will insert the commit messages for the build concatenated together.
comment : String
The comment to set on the issues found.
commentVisibility : String

jobDsl

additionalClasspath : String (optional)
Newline separated list of additional classpath entries for the Job DSL scripts. All entries must be relative to the workspace root, e.g. build/classes/main. Supports Ant-style patterns like lib/*.jar.
additionalParameters (optional)
- Type: java.util.Map<java.lang.String, java.lang.Object>
failOnMissingPlugin : boolean (optional)
If checked, the build will be marked as failed if a plugin must be installed or updated to support all features used in the DSL scripts. If not checked, the build will be marked as unstable instead.
failOnSeedCollision : boolean (optional)
Fail build if generated item(s) have the same name as existing items already managed by another seed job. By default, this plugin will always regenerate all jobs and views, thus updating previously generated jobs and views even if managed by another seed job. Check this box if you wish to fail the job if a generated item name collision is detected.
ignoreExisting : boolean (optional)
Ignore previously generated jobs and views. By default, this plugin will always regenerate all jobs and views, thus updating previously generated jobs and views. Check this box if you wish to leave previous jobs and views as is.
ignoreMissingFiles : boolean (optional)
Ignore missing DSL scripts. If not checked, the build step will fail if a configured script is missing or if a wildcard does not match any files.
lookupStrategy (optional)
Determines how relative job names in DSL scripts are interpreted. You will only see a difference when the seed job is located in a folder.
- Jenkins Root When this option is selected relative job names are always interpreted relative to the Jenkins root.
- Seed Job If you choose this option relative job names in DSL scripts will be interpreted relative to the folder in which the seed job is located. Suppose you have a seed job which is located in a folder named seedJobFolder and a DSL script which creates a job named subfolder2/job. The job that is created by the seed job will be at the location /seedJobFolder/subfolder2/job.
- Values: JENKINS_ROOT, SEED_JOB
removedConfigFilesAction (optional)
Specifies what to do when previously generated config files are not referenced anymore.
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise config files may be deleted and re-created. See JENKINS-44142 for details.
- Values: IGNORE, DELETE
removedJobAction (optional)
Specifies what to do when a previously generated job is not referenced anymore.
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" or "Disable" only for the last Job DSL build step. Otherwise jobs will be deleted and re-created or disabled and re-enabled and you may lose the job history of generated jobs. See JENKINS-44142 for details.
- Values: IGNORE, DISABLE, DELETE
removedViewAction (optional)
Specifies what to do when a previously generated view is not referenced anymore.
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise views may be deleted and re-created. See JENKINS-44142 for details.
- Values: IGNORE, DELETE
sandbox : boolean (optional)
If checked, runs the DSL scripts in a sandbox with limited abilities. You will also need to configure this job to run with the identity of a particular user. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the scripts.
scriptText : String (optional)
DSL Script, which is groovy code. Look at documentation for details on the syntax.
targets : String (optional)
Newline separated list of DSL scripts, located in the Workspace. Can use wildcards like 'jobs/**/*.groovy'. See the @includes of Ant fileset for the exact format.
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
unstableOnDeprecation : boolean (optional)
If checked, marks the build as unstable when using deprecated features. If not checked, a warning will be printed to the build log only.
useScriptText : boolean (optional)

$class: 'ExecuteJobBuilder'

jobId : long
jobName : String
jobType : String
abortOnFailure : boolean
abortOnTimeout : boolean
timeoutMinutes : int
publish : boolean
projectId : long
buildId : String
sessionTag : String
appendEnv : boolean

executeKatalon

version : String
location : String
executeArgs : String
x11Display : String
xvfbConfiguration : String

executeKatalonTestOps

credentialsId : String
serverUrl : String
projectId : String
planId : String

execMan

requestType : String (optional)
altEMConfig (optional)
Optional alternative Execution Manager configuration. If provided, these parameters override those specified in Jenkins global configuration.
- url : String
- credentials : String
bookmark (optional)
Select this to run a predefined bookmark configured on the Execution Manager via the Management Studio.
- name : String
- folder : String (optional)
execParams (optional)
Optional execution request parameters. Both a key and value must be specified. The value can refer to Jenkins environment variables using this syntax - ${JENKINS_ENV_VAR}. For example - ${BUILD_ID}.
- list (optional)
  - key : String
  - value : String
postExecute (optional)
Optional post execution action. To perform any post action, provide action name along with the need parameters.
- action : String
- params : String
processList (optional)
Select this to execute a list of Certify processes without creating a request or bookmark first.
- database : String
  Alias name of the Certify connection saved in Management Studio > Configuration > Certify Configuration.
- project : String
  Certify project where processes reside.
- processes
  List of the fully qualified path to each process.
  - processPath : String
- folder : String
  Folder where Certify Results will be saved. If not specified, results go to the root results folder.
- requestName : String
  Name given to the request execution.
request (optional)
Select this to run a predefined request configured on the Execution Manager.
- name : String
waitConfig (optional)
Optional execution request wait configuration. Both the polling interval and maximum run time must be specified in seconds.
- pollInterval : String
- maxRunTime : String

$class: 'ExecuteStepBuilder'

server : String
authenticationType : String
userName : String
password
- Type: class hudson.util.Secret
database : String
filesToExecute : String
compareOptions : String (optional)
fileEncoding : String (optional)
filterFile : String (optional)
ignoreError : boolean (optional)
transactionIsoLvl : String (optional)
zipPassword (optional)
- Type: class hudson.util.Secret

executeTestsFromAlmOctane

This build step is intended to support execution of automated tests from Micro Focus ALM Octane.
There are several modes of execution :

Mode	Explanation
Execute suite runs in ALM Octane	Execute suites according to specified suite IDs. New suite runs will be created and executed in ALM Octane. Jenkins job is finished after triggering the suite runs. The job does not wait until the suite runs are finished. This method is useful if you want to schedule suite execution in ALM Octane. By default, newly created suite runs will have name of suite and will be assigned to default release. In order to override this default behaviour, add following parameters (one or more) to job with your desired values: octane_release_id octane_new_suite_run_name
Get tests from suites and trigger execution jobs	Get tests from suites and trigger execution jobs : Get tests from specified suite IDs. (This method assumes that tests are assigned to test runner jobs from the current Jenkins.) Tests are send to execution by their assigned test runner jobs. The main job is finished after the test runner jobs are finished. This method is useful if you intend to add your job to the ALM Octane Pipeline module.

configurationId : String
workspaceId : String
executionMode : String
ids : String

executeCloudifyWorkflow

This step executes a workflow on Cloudify Manager.

credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean (optional)
If checked, then printed Cloudify events and logs will include debug-level records.
deploymentId : String (optional)
ID of the Cloudify environment to delete.
executionParameters : String (optional)

Parameters to pass to the execution, in YAML/JSON format.
printLogs : boolean (optional)
If checked, then the execution's events and logs are printed to the build log. Note that this implies "wait for completion".
tenant : String (optional)

Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
waitForCompletion : boolean (optional)
If checked, then the build waits for the execution to finish. If the execution ends in any way other than success, the build step will fail.
workflowId : String (optional)

The ID of the workflow to execute.

$class: 'ExecutorBuildStep'

frameworkType : String
The supported framework by this step are XCUITest (by Apple) and Espresso (by Google).
runningType : String
- Fast Feedback - will distribute the tests between the maximum pull of devices available. Every test will be execute once.
- Coverage - will execute all the tests on all of the selected devices. Every test will be execute on every selected device.
app : String
The application to test, in case of XCUITest should be an IPA file and in case of Espresso should be an APK file.
testApplication : String
The application contain the tests to execute, in case of XCUITest should be an IPA file and in case of Espresso should be an APK file.
deviceQueries : String
A query string that will enable to select the devices that will be used. For example:
- @serialnumber=’aabbccddee’
  Will select a specific device with a given serial number of udid.
- @os=’android’ and @versionnumber > 5.0
  Select android with a version that is bigger than 5.0
Other field that can be used:
- manufacture: device manufacture for example: samsung
- model: Device model, for example: SM-G935F
- modelName: Device marketing name: for example: Galaxy S7 Edge
- name
- os: Operating system.
- remote: If device is connected through SeeTestCloud or not (values are true/false).
- serialnumber: S/N of the device.
- version: The device's operating system version (for example 4.1.2).
- versionnumber: The device's operating system version number (for example 4.1).
- category: The device category. Currently supported in android devices. possible values- 'WATCH', 'PHONE' or 'TABLET'.
runTags : String
All tests that are part of this step will be ‘tagged’ with the provided key value. The tags will enable to filter your specific execution.
executorOptions
- maxDevices : int
  Accepted value: [1..1000]. Default is 10
  
  Set the maximum number of devices to allocate for this step execution.
  
  Only applicable for Fast feedback mode.
- minDevices : int
  Accepted value: [1..1000]. Default is 10
  
  Set the minimum number of devices to allocate for this step execution.
  
  Only applicable for Fast feedback mode.
- ignoreTestsFile : String
  - iOS - xcscheme file
  - Android - text file with include full class name:
    - <class name 1>,<method name 1>
    - <class name 2>,<method name 2>
- overallExecTimeout : int
  Set the step overall execution timeout. If the step execution time exceeded the given time, it will end with failure.
- creationTimeout : int

exportIpa

appURL : String (optional)
archiveDir : String (optional)
Specify the location of the path (usually BUILD_DIR specified by xcodebuild) to read the Archive for exporting the IPA file.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
```
${WORKSPACE}/build
```
assetPackManifestURL : String (optional)
compileBitcode : boolean (optional)
copyProvisioningProfile : boolean (optional)
developmentTeamID : String (optional)
developmentTeamName : String (optional)
displayImageURL : String (optional)
fullSizeImageURL : String (optional)
ipaExportMethod : String (optional)
ipaName : String (optional)
ipaOutputDirectory : String (optional)
keychainId : String (optional)
keychainName : String (optional)
keychainPath : String (optional)
keychainPwd (optional)
- Type: class hudson.util.Secret
manualSigning : boolean (optional)
packResourcesAsset : boolean (optional)
provisioningProfiles (optional)
- provisioningProfileAppId : String
- provisioningProfileUUID : String
resourcesAssetURL : String (optional)
signingMethod : String (optional)
stripSwiftSymbols : boolean (optional)
symRoot : String (optional)
thinning : String (optional)
unlockKeychain : boolean (optional)
uploadBitcode : boolean (optional)
uploadSymbols : boolean (optional)
xcodeName : String (optional)
xcodeProjectPath : String (optional)
xcodeSchema : String (optional)
xcodeWorkspaceFile : String (optional)

exportPackages

Exports ECU-TEST packages and their attributes to a test management system like RQM or ALM.

exportConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportPackageConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectArchiveConfig'
  - tmsPath : String
  - importPath : String
  - importConfigPath : String
  - replaceFiles : boolean
- $class: 'ImportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectConfig'
  - tmsPath : String
  - importPath : String
  - importMissingPackages : boolean
  - credentialsId : String
  - timeout : String
  - tmProjectId : String
- $class: 'ImportProjectDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String

$class: 'ExportParametersBuilder'

filePath : String
The path of exported file. This can be relative path against the workspace. Proper file extension is added to the end of path. You can prevent it by adding "." to the end of path. If parameters are actually exported to file, The path is provided as a parameter EXPORT_PARAMS_FILE.
fileFormat : String
The format of exported file. You can select one of the followings.
- Properties (.properties)
- XML (.xml)
- JSON (.json)
- YAML (.yml)
If parameters are actually exported to file, The format name is provided as a parameter EXPORT_PARAMS_FORMAT.
keyPattern : String
You can specify the list of keys delimited by ",". A key is treated as prefix. If it matches the beginning of parameter's key, its parameter would be exported. If empty, all parameters would be exported.
useRegexp : boolean
Check if you want to use regular expression as key pattern.

exportProjects

Exports ECU-TEST projects and their attributes to a test management system like RQM or ALM.

exportConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportPackageConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectArchiveConfig'
  - tmsPath : String
  - importPath : String
  - importConfigPath : String
  - replaceFiles : boolean
- $class: 'ImportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectConfig'
  - tmsPath : String
  - importPath : String
  - importMissingPackages : boolean
  - credentialsId : String
  - timeout : String
  - tmProjectId : String
- $class: 'ImportProjectDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String

$class: 'ExporterBuilder'

$class: 'ExtensiveTestingBuilder'

testPath : String
login : String
password : String
serverUrl : String
projectName : String
debug : boolean

downloadFeatureFiles

Downloads feature files from Zephyr Scale.

serverAddress : String
One of the preconfigured Jira instances. If you do not have any, please go to General Configuration and set up a new Jira instance.
projectKey : String
Jira project key to filter test cases.
targetPath : String
The path where the downloaded feature files will be placed.

featureManagementConfig

credentialsId : String
The User token is used to create the secret text credential by interacting with the CloudBees REST API to download the configuration.
To retrieve your API token, from the CloudBees Feature Management Home page, from the left pane select App settings. In the Integrations tab under API, select Show to display the User token, then select Copy.
applicationIdAndName : String
The CloudBees Feature Management application.
The Flag and Target group configurations are downloaded and displayed for this application when the environment is selected.
environmentIdAndName : String

$class: 'FeedStatus'

prefix : String
Enter the project ID here. Example: P10. The following status will be added in the project’s Feed section.
status : String
Brief the status here. Note: All the script related information that you add in the status will be automatically removed.

$class: 'FetchTestAssets'

username : String
profile : String
giturl : String
ipAddress : String

$class: 'FigletBuilder'

message : String
Help file for fields are discovered through a file name convention. This file is help for the "name" field. You can have arbitrary HTML here. You can write this file as a Jelly script if you need a dynamic content (but if you do so, change the extension to .jelly).

fileOperations

fileOperations
- fileCopyOperation
  - includes : String
    Files included to copy, this supports ant-style file pattern ex: target/*/final*.xml
  - excludes : String
    Files excluded from copying, this supports ant-style file pattern ex: target/*/final*.xml
  - targetLocation : String
    Destination folder location to copy the files. Base directory is workspace.
  - flattenFiles : boolean
    If selected, files are copied directly to the target location without preserving source file sub-directory structure.
  - renameFiles : boolean
    By default, the file name of the source file is preserved. When flattening files, this can cause problems if files of the same name exist in multiple source sub-directories. Selecting this option allows the output file name to be manipulated to avoid file name clashes.
  - sourceCaptureExpression : String
    Java-style regular expression that is run against the full path of each matching source file. This should be used to capture parts of the path that will be used in the target name expression to make each file name unique across all subdirectories.
  - targetNameExpression : String
    An expression that provides the desired target file name. This can reference variables captured in the source capture expression by using $1, $2 etc.
- fileCreateOperation
  - fileName : String
    Path and Name of the file to be created in workspace.
  - fileContent : String
    File content to be created, use environment variables where needed.
- fileDeleteOperation
  - includes : String
    Files included to delete, this supports ant-style file pattern ex: target/*/final*.xml
  - excludes : String
    Files excluded from deleting, this supports ant-style file pattern ex: target/*/final*.xml
- fileDownloadOperation
  - url : String
    Url of the file to download.
  - userName : String
  - password : String
  - targetLocation : String
    Destination location to download the file. Base directory is workspace.
  - targetFileName : String
  - proxyHost : String
  - proxyPort : String
- fileJoinOperation
  - sourceFile : String
    Source file path to copy the content.
  - targetFile : String
    Target file path to append the content from source file.
- filePropertiesToJsonOperation
  - sourceFile : String
    Source file path of properties.
  - targetFile : String
    Target file path to create or update with json data.
- fileRenameOperation
  - source : String
    File to be renamed.
  - destination : String
    Destination file location to rename. Base directory is workspace.
- fileTransformOperation
  - includes : String
    Files included to copy, this supports ant-style file pattern ex: target/*/final*.xml
  - excludes : String
    Files excluded from copying, this supports ant-style file pattern ex: target/*/final*.xml
- fileUnTarOperation
  - filePath : String
    Source tar file location.
  - targetLocation : String
    Destination folder location to untar the files. Base directory is workspace.
  - isGZIP : boolean
- fileUnZipOperation
  - filePath : String
    Source zip file location.
  - targetLocation : String
    Destination folder location to unzip the files. Base directory is workspace.
- fileZipOperation
  - folderPath : String
    Path of the file or folder to create a zip file for, relative to the workspace directory.
  - outputFolderPath : String
    Path to a target directory for the zip file, relative to the workspace directory. Defaults to workspace directory if not defined.
- folderCopyOperation
  - sourceFolderPath : String
    Folder to be copied.
  - destinationFolderPath : String
    Destination folder location to copy the files. Base directory is workspace.
- folderCreateOperation
  - folderPath : String
    Path and Name of the folder to be created in workspace.
- folderDeleteOperation
  - folderPath : String
    Path and Name of the folder to be deleted in workspace.
- folderRenameOperation
  - source : String
    Folder to be renamed.
  - destination : String
    Destination folder name to rename. Base directory is workspace.

$class: 'FitnesseBuilder'

options
- Type: java.util.Map<java.lang.String, java.lang.String>

$class: 'FixResultBuilder'

Set the build result (helps testing project configurations, notifications, promotions, upstream/downstream dependencies etc.)

defaultResultName : String
Set the build result for when the build number is not listed in the advanced options
success : String
A list of comma or space separated build numbers for which the result should be success
unstable : String
A list of comma or space separated build numbers for which the result should be unstable
failure : String
A list of comma or space separated build numbers for which the result should be failure
aborted : String
A list of comma or space separated build numbers for which the result should be aborted

flywayrunner

installationName : String
flywayCommand : String
url : String
locations : String
commandLineArgs : String
credentialsId : String

$class: 'FogbugzLinkBuilder'

frugalTesting

userId : String
testId : String
runTag : String
getJtl : boolean
serverUrl : String (optional)

$class: 'FtpRenameBuilder'

ftpServer : String
ftpPort : int

if you don't specify the port, the default port is 21.
ftpUser : String
ftpPassword
- Type: class hudson.util.Secret
ftpPath : String

Specify the path to your artifact.
artifactName : String (optional)
newArtifactName : String (optional)
remoteDirectory : String (optional)

Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.

$class: 'FuzzBuildStep'

configurationFilePath : String

The file path where the test configuration file (*.set or *.testplan) for this job can be found, relative to the project's workspace.

A test configuration file defines what kind of testing is to be done, and can be created using Defensics. Configure a test suite in Defensics and save the settings file in File -> Save Settings.
configurationOverrides : String (optional)
Additional test configuration settings that override the settings saved in the test configuration file. This can be useful if, for example, the test target address needs to be set dynamically.

The available settings are the same as the Defensics command line settings. Each setting should follow the format '--setting-name value'. Multiple settings are separated with spaces.

Example for HTTP Server Test Suite:
```
--uri https://example.com --http-status-filter "1xx 2xx 3xx" 
```
defensicsInstance : String (optional)
Select Defensics instance to use for running tests. Instances can be added in Jenkins' global configuration under the Defensics section.
saveResultPackage : boolean (optional)
Check this if you want Jenkins to download the Defensics result package and store it for the build. The result package includes all logs for the test run. The package can be downloaded from the build status page. Use with caution as the package filesize can be large.

$class: 'FxCopBuilder'

toolName : String
files : String

Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.

Command Line Argument: /file:[ file/directory ]
outputXML : String

FxCop project or XML report output file.

Command Line Argument: /out:[ output file path ]
ruleSet : String

Rule set to be used for the analysis.

Command Line Argument: /ruleset:=[ Rule set file path ]
ignoreGeneratedCode : boolean

Suppress analysis results against generated code.

Command Line Argument: /ignoregeneratedcode
forceOutput : boolean

Write output XML and project files even in the case where no violations occurred.

Command Line Argument: /forceoutput
cmdLineArgs : String
failBuild : boolean

$class: 'GCloudSDKBuilder'

command : String

$class: 'GCloudSDKWithAuthBuilder'

credentialsId : String
command : String

$class: 'GatekeeperCommit'

commitUsername : String
User name in format: "Foo Bar ". Required.

$class: 'GatekeeperMerge'

commitUsername : String
User name in format: "Foo Bar ". Required.
releaseFilePath : String
Relative (inside of the repository) path to the release file would be added/replaced and committed if target release branch does not exist. Optional.
releaseFileContentTemplate : String
Mustache template to be rendered and put to release file. Optional. Available context:
- release - the number of release
UTF-8 encoding is expected.

$class: 'GatekeeperPush'

gcrImageVulnerabilityScanner

imageName : String (optional)

genexusb

gxInstallationId : String
GeneXus installation to use for building.
kbPath : String
Path to the Knowledge Base to build (eg: "${WORKSPACE}\KBname" or "C:\MyCustomPath\MyKb").
kbVersion : String
Name of the Version to build. If you leave it blank the 'Trunk' version will be selected by default.
kbEnvironment : String
Name of the Environment to build. If you leave it blank the first Environment will be selected by default.
kbDbCredentialsId : String
Credentials used to connect to SQL Server. Select "none" for Windows Authentication.
forceRebuild : boolean
By default GeneXus specify and generate only the objects that were affected by changes since the last build. An object may be affected because it was directly modified or because any other object on which it depends was changed. Set this option if for any reason you want to force the build for all objects.

$class: 'GenerateChangeScriptBuilder'

Generate an alter SQL script based on a previous schema compare build step.

in : String
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.

Folder location must be specified as:
- Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
out : String
Path to the file that should be used to store SQL change script.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.

$class: 'GenerateCreateScriptBuilder'

Generate a create SQL script from your repository, saved snapshot or database.

outputFile : String
Path to the file that should be used to store create SQL script.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
inputFileOrFolder : String
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Snapshot - input is snapshot file
Folder/file location must be specified as:
- Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.

$class: 'GenerateJenkinsReportBuilder'

Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.

Warning: You can include only one Generate Jenkins HTML comparison report step per project.

inputFolder : String
Specify path to input folder containing output from "Run Compare" build step.

Folder location must be specified as:
- Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.

$class: 'GenerateStandaloneReportBuilder'

Generate a HTML report based on a previous schema compare build step.

inputFolder : String
Specify path to input folder containing output from "Run Compare" build step.

Folder location must be specified as:
- Relative or absolute path to your project's workspace. Relative path should start with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
outputFolder : String
Specify path to folder where standalone report will be exported.

Folder location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.

examTCG

For projects that use EXAM as the test system. This causes Jenkins to invoke EXAM with the given options.

examName : String
examModel : String (optional)
modelConfiguration : String (optional)
element : String (optional)
descriptionSource : String (optional)
documentInReport : boolean (optional)
errorHandling : String (optional)
frameSteps : Array / List of String (optional)
mappingList : String (optional)
testCaseStates : Array / List of String (optional)
variant : String (optional)
javaOpts : String (optional)
overwriteDescriptionSource : boolean (optional)
overwriteFrameSteps : boolean (optional)
overwriteMappingList : boolean (optional)
timeout : int (optional)

ghostInspector

apiKey : String
Enter your Ghost Inspector API key. This is a unique, private key provided with your account which allows you to access the API. You can find it in your Account Settings in the Ghost Inspector application.
suiteId : String
Enter the ID of the Ghost Inpsector suite that you would like to execute.
startUrl : String
(Optional) Enter a custom URL to run the test suite on. If you're running your tests on the local build of your application, you may wish to create an local tunnel and use that URL here.
params : String
(Optional) Additional parameters to pass to the API in the form of "viewport=1024x768&customVar=foo". You may wish to override the screen size or include custom variables.

gitAutomerger

checkoutFromRemote : boolean (optional)
detailConflictReport : boolean (optional)
limitAuthorsInDetailReport : int (optional)
limitCommitsInDetailReport : int (optional)
logLevel (optional)
- Values: TRACE, DEBUG, INFO, WARN, ERROR
mergeRules (optional)
- path : String
- resolution
  - Values: KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOP
releaseBranchPattern : String (optional)
remoteName : String (optional)

gitbisect

jobToRun : String
goodStartCommit : String
badEndCommit : String
searchIdentifier : String
revisionParameterName : String
retryCount : int
continuesBuild : boolean
minSuccessfulIterations : int
overrideGitCommand : boolean
gitCommand : String

gitHubPRStatus

statusMessage
- content : String
  Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
  If token-macro plugin enabled, then support token expansion.
  If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.

$class: 'GitHubSetCommitStatusBuilder'

contextSource (optional)
- $class: 'DefaultCommitContextSource'
  Uses display name property defined in "GitHub project property" with fallback to job name.
- $class: 'ManuallyEnteredCommitContextSource'
  You can define context name manually.
  - context : String
    Allows env vars and token macros.
statusMessage (optional)
- content : String
  Message content that will be expanded using core variable expansion i.e. ${WORKSPACE}
  and Token Macro Plugin tokens.

$class: 'GitStatusWrapperBuilder'

The gitStatusWrapper builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically

Check documentation here

buildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
account : String (optional)

The GitHub account that owns the repos that contains the commit to notify

Default: If SCM used, plugin will attempt to get details from SCM execution

Check documentation here
credentialsId : String (optional)

The GitHub credentials, username/password or username/accessToken
description : String (optional)

The notification description, it will be displayed by GitHub

Default: ""

Check documentation here
failureDescription : String (optional)

The notification description for a failure, it will be displayed by GitHub

Default: value set to description

This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"

Check documentation here
gitApiUrl : String (optional)

If you are a user of GitHub Enterprise use this field to set your custom API endpoint

Default: https://api.github.com
gitHubContext : String (optional)

The git status context key. Keys are used by GitHub to differentiate between notifications

Default: gitStatusWrapper

Check documentation here
repo : String (optional)

The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field

Default: If SCM used, plugin will attempt to get details from SCM execution

Check documentation here
sha : String (optional)

The SHA that identifies the commit to notify

Default: If SCM used, plugin will attempt to get details from SCM execution

Check documentation here
successDescription : String (optional)

The notification description for a success, it will be displayed by GitHub

Default: value set to description

This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"

Check documentation here
targetUrl : String (optional)

Use this field to specify a custom target URL for the notification

Default: Jenkins build URL

Check documentation here

$class: 'GitToIspwPublish'

app : String (optional)
branchMapping : String (optional)
connectionId : String (optional)
credentialsId : String (optional)
ispwConfigPath : String (optional)
runtimeConfig : String (optional)
stream : String (optional)
subAppl : String (optional)

$class: 'GnatmakeBuilder'

gnatName : String
switches : String
fileNames : String
modeSwitches : String

gprbuild

This build step can be used to build GNAT project files by invoking GPRbuild.

installationName : String (optional)
Name of the GNAT installation to use as configured in Jenkins.
names : String (optional)
Main source files represent the sources to be used as the main programs. If they are not specified on the command line, GPRbuild uses the source files specified with the Main attribute in the project file. If none exists, then no executable will be built. It is also possible to specify absolute file names, or file names relative to the current directory.
proj : String (optional)
GPRbuild requires a project file, which may be specified on the command line either directly or through the -P switch. If not specified, GPRbuild uses the project file default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
switches : String (optional)

GPRbuild takes into account switches that may be specified on the command line or in attributes Switches(<main or language>) or Default_Switches (<language>) in package Builder of the main project.

Go to AdaCore documentation for switches.

gradle

buildFile : String (optional)
If your gradle build script is not named build.gradle, specify the gradle build name script.
gradleName : String (optional)
makeExecutable : boolean (optional)
passAllAsProjectProperties : boolean (optional)
passAllAsSystemProperties : boolean (optional)
projectProperties : String (optional)
rootBuildScriptDir : String (optional)
If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, as parent where ${WORKSPACE}/parent is the absolute. If left empty, defaults to build.gradle in ${WORKSPACE} directory.
switches : String (optional)
Specify a list of Gradle switches to be invoked, or leave it empty.
systemProperties : String (optional)
tasks : String (optional)
Specify a list of Gradle tasks to be invoked.
useWorkspaceAsHome : boolean (optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor agent in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
useWrapper : boolean (optional)
wrapperLocation : String (optional)
By default, the Gradle plugin tries to locate the wrapper executable (gradlew on Unix and gradlew.exe on Windows) next to the build script. If it is not there it will look in the workspace root. If your workspace has the wrapper somewhere else, specify the path to the directory (relative to workspace) containing the wrapper executable here, such as parent instead of just ${workspace}/parent.

gradleForesight

projectId : String
Thundra Foresight Test Project Id
credentialId : String
thundraAgentVersion : String (optional)
thundraGradlePluginVersion : String (optional)

$class: 'Groovy'

Executes a groovy script.

scriptSource
- $class: 'FileScriptSource'
  - scriptFile : String
- $class: 'StringScriptSource'
  - command : String
groovyName : String
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
parameters : String
Parameters for the Groovy executable.
scriptParameters : String
These parameters will be passed to the script.
properties : String
Instead of passing properties using the -D parameter you can define them here.
javaOpts : String
Direct access to JAVA_OPTS. Properties allows only -D properties, while sometimes also other properties like -XX need to be setup. It can be done here. This line is appended at the end of JAVA_OPTS string.
classPath : String
Specify script classpath here. Each line is one class path item.

$class: 'GroovyRemoteBuilder'

remoteName : String
script : String

examRun_Groovy

For projects that use EXAM as the test system. This causes Jenkins to invoke EXAM with the given options.

examName : String
script : String (optional)
startElement : String (optional)
examModel : String (optional)
modelConfiguration : String (optional)
javaOpts : String (optional)
timeout : int (optional)
useStartElement : boolean (optional)

grypeScan

Allow usage of grype, a vulnerability scanner for container images and filesystems.

scanDest : String
Scan targets can be explicitly provided with a following scheme:
- docker:yourrepo/yourimage:tag use images from the Docker daemon
- docker-archive:path/to/yourimage.tar use a tarball from disk for archives created from "docker save"
- oci-archive:path/to/yourimage.tar use a tarball from disk for OCI archives (from Skopeo or otherwise)
- oci-dir:path/to/yourimage read directly from a path on disk for OCI layout directories (from Skopeo or otherwise)
- dir:path/to/yourproject read directly from a path on disk (any directory)
- registry:yourrepo/yourimage:tag pull image directly from a registry (no container runtime required)
repName : String
autoInstall : boolean
If active, download and install grype by ececution of install.sh automatically in job workspace, otherwise 'grype' executable needs to be available in the PATH.

$class: 'GsshCommandBuilder'

disable : boolean
serverInfo : String
shell : String

$class: 'GsshFtpDownloadBuilder'

disable : boolean
serverInfo : String
remoteFile : String
localFolder : String
fileName : String

$class: 'GsshFtpUploadBuilder'

disable : boolean
serverInfo : String
localFilePath : String
remoteLocation : String
fileName : String

$class: 'GsshShellBuilder'

disable : boolean
serverInfo : String
shell : String

habitat

task : String (optional)
directory : String (optional)
artifact : String (optional)
channel : String (optional)
origin : String (optional)
bldrUrl : String (optional)
authToken : String (optional)
lastBuildFile : String (optional)
format : String (optional)
searchString : String (optional)
command : String (optional)
binary : String (optional)
path : String (optional)
docker : boolean (optional)

healthAnalyzer

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

greet

name : String
Your name.
useFrench : boolean (optional)
Use French?

nodePoolHold

duration : String
Allows the user to specify how long to hold the nodepool node. Default is 1 day. The value should be a positive integer between 1 and 99 inclusive with a one letter unit signifying how long to hold the node (m=minutes, h=hours, d=days, w=weeks, M=months). However, maximum hold duration is 1 month. Examples include: 40m, 1h, 6h, 3d, 3w, 1M.
reason : String

$class: 'HorreumExpect'

credentials : String (optional)
Credentials used for authorization in Keycloak. The user account must have the uploader role; otherwise the build steps will fail.
test : String (optional)
Name or ID of the test this run belongs to.
timeout : long (optional)
Timeout (in seconds) within which the run should be updloaded. If a matching run is not uploaded Horreum will notify users subscribed to this test as this is probably a result of failure in the build.
expectedBy : String (optional)
Name of the entity that runs this test.
backlink : String (optional)
URL leading from Horreum (or the notifications) to this build. Use $BUILD_URL.
quiet : boolean (optional)

$class: 'HorreumUpload'

files : String
credentials : String (optional)
Credentials used for authorization in Keycloak. The user account must have the uploader role; otherwise the build steps will fail.
test : String (optional)
Name or ID of the test this run belongs to.
owner : String (optional)
Team owning the run. Usually this is a lowercase identifier ending with -team, e.g. dev-team.
access : String (optional)
Access mode for the run:
- PUBLIC: everyone can see the run
- PROTECTED: only authenticated (logged-in) users can see the run
- PRIVATE: only owner team can see the run.
start : String (optional)
Run start timestamp formatted as ISO-8601 timestamp (e.g. 2021-12-03T10:15:30.00Z), millisecond epoch time or JSON Path into the uploaded JSON file in one of those formats.
stop : String (optional)
Run termination timestamp formatted as ISO-8601 timestamp (e.g. 2021-12-03T10:15:30.00Z), millisecond epoch time or JSON Path into the uploaded JSON file in one of those formats.
schema : String (optional)
URI of the schema. If this is not set the schema will be fetched from the uploaded JSON file, under $schema property. If Horreum has the JSON schema for this URI recorded it will validate the uploaded JSON against it.
jsonFile : String (optional)
Path to the JSON file that will be uploaded as run data.
addBuildInfo : boolean (optional)
Automatically add information to the JSON object about the Jenkins job and build that executes the upload. Default is false.
quiet : boolean (optional)

$class: 'HttpRequest'

url : String
acceptType (optional)
- Values: NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_FORM_DATA, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAM
authentication : String (optional)
consoleLogResponseBody : boolean (optional)
contentType (optional)
- Values: NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_FORM_DATA, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAM
customHeaders (optional)
- name : String
- value : String
- maskValue : boolean
formData (optional)
- uploadFile : String
- name : String
- fileName : String
- contentType : String
- body : String
httpMode (optional)
- Values: GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCH
httpProxy : String (optional)
ignoreSslErrors : boolean (optional)
multipartName : String (optional)
outputFile : String (optional)
passBuildParameters : boolean (optional)
proxyAuthentication : String (optional)
quiet : boolean (optional)
requestBody : String (optional)
timeout : int (optional)
uploadFile : String (optional)
useSystemProperties : boolean (optional)
validResponseCodes : String (optional)
validResponseContent : String (optional)
wrapAsMultipart : boolean (optional)

hugo

baseUrl : String (optional)
buildFuture : boolean (optional)
destination : String (optional)
environment : String (optional)
hugoHome : String (optional)
verbose : boolean (optional)

$class: 'HyperBuilder'

image : String
commands : String

ipythonBuilder

code : String
Copy and paste your code to execute in selected server
Eg: print(" Hello Jenkins, from Machine Learning Plugin ...... ! ")
filePath : String
Path of file that contains python code to be executed in the server
Eg: /home/alice/iris/ml.py
parserType : String
task : String
Folder name that will be used for saving html/images/graphs generated by the script file or code
Eg: Training
kernelName : String
Globally configured Jupyter kernels. If any kernels are not shown
- Manage Jenkins --> Configure System
- Under Kernel Configuration

$class: 'ITest'

workspace : String

Required.

(1) Provide the full path to the iTest workspace containing projects, or

(2) Leave blank to indicate that the current job's workspace is also an iTest workspace (must contain an .iTestWorkspace file as created by iTest)
projects : String

Required. Specify the name of the iTest project to export in an ITAR file (required to use iTestRT). Separate names of multiple projects with comma.

Note: The project must exist within the specified iTest workspace.
testcases : String

Required. Specify path to test case or test suite to run: must include extension (path/name.fftc or path/name.ffts). Separate multiple with a comma.

Accepted Formats:
project://projectname/path/to/testcase
/full/path/to/testcase

Examples:
project://system_test/regression_test.fftc
${WORKSPACE}/system_test/regression_test.fftc
testbed : String

Specify the URI of the testbed or topology to use for execution. Must include file extension. Overrides the testbed specified in the test case file.

Accepted Formats:
/path/to/topology.tbml

Examples:
${WORKSPACE}/system_test/topologies/demo.tbml
params : String

Specify a parameter value in the format parameter=value. Separate multiple parameter/value pairs with a comma.

Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument takes precedence over the values in the parameter file.
paramFile : String

Specify URI of a parameter file in an iTest readable format.

Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument take precedence over the values in the parameter file.
testReportRequired : boolean

Check this to generate test report in HTML format.

A link to the report will be provided on the project page, and the report will be available in the iTest workspace specified in the project configuration page.
dbCustomTag : String

This option enables you to define and assign a value to a custom tag.

Example: Create a tag that holds the build number so that you compare test execution results between builds.

For tests run against build 54322, use: --tag buildNumber=54322

Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.

$class: 'ImportFiles'

Imports one or more XML files into the CloudTest server.

url : String
cloudTestServerID : String
Select the server to import objects into.
files : String
Can use wildcards like 'clips/**/*.xml'. See the @includes of Ant fileset for the exact format. The base directory is the workspace.
excludes : String
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be imported even if it matches the mask specified in 'File(s) to import' section.
mode : String
Specify how to handle importing an object that already exists.
additionalOptions : String
If you need to pass any other command line options to the SCommand utility, specify them here. You can separate options with new lines as well as whitespaces.

importPackages

Imports ECU-TEST packages and their attributes from a test management system like RQM or ALM.

importConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportPackageConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectArchiveConfig'
  - tmsPath : String
  - importPath : String
  - importConfigPath : String
  - replaceFiles : boolean
- $class: 'ImportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectConfig'
  - tmsPath : String
  - importPath : String
  - importMissingPackages : boolean
  - credentialsId : String
  - timeout : String
  - tmProjectId : String
- $class: 'ImportProjectDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String

importProjects

Imports ECU-TEST projects and their attributes from an archive or a test management system like RQM or ALM.

importConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportPackageConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ExportProjectConfig'
  - filePath : String
  - exportPath : String
  - createNewPath : boolean
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportPackageDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectArchiveConfig'
  - tmsPath : String
  - importPath : String
  - importConfigPath : String
  - replaceFiles : boolean
- $class: 'ImportProjectAttributeConfig'
  - filePath : String
  - credentialsId : String
  - timeout : String
- $class: 'ImportProjectConfig'
  - tmsPath : String
  - importPath : String
  - importMissingPackages : boolean
  - credentialsId : String
  - timeout : String
  - tmProjectId : String
- $class: 'ImportProjectDirConfig'
  - tmsPath : String
  - importPath : String
  - credentialsId : String
  - timeout : String

$class: 'InfluxDBPublisher'

userCredentialsID : String
dbUrl : String
dbName : String
content : String

influxDbQuery

checkName : String
Logical name for the check.
influxQuery : String
InfluxDB select query supposed to return 1 value. It can be a sum, count or function returning only one value. May use Jenkins tokens such as build number in the query. e.g.
expectedThreshold : double
Threshold for the value returned by query result. If exceeded and if Mark Build Unstable is selected, the build will be marked unstable.
markUnstable : boolean (optional)
Check if we should mark the build unstable if the threshold is exceeded.
retryCount : int (optional)
Max number of times to execute the query as a single post-build step.
retryInterval : int (optional)
Time to wait in between each query in seconds, default to 30s.
showResults : boolean (optional)
Check if we should should display the query results in the Jenkins console.

insightAppSec

region : String
The data storage region of the target InsightAppSec instance.
insightCredentialsId : String
appId : String
The App containing the Scan Config you wish to scan.
scanConfigId : String
The Scan Config you wish to scan.
buildAdvanceIndicator : String
This configuration option can be used to augment how the build advances based on the status of the scan submitted
- Scan has been submitted - Advance the build when the scan has been submitted successfully
- Scan has been started - Advance the build when the scan has been started successfully
- Scan has been completed - Advance the build when the scan has been completed successfully
- Vulnerability results query has returned no vulnerabilities - Advance the build when the scan has been completed and the vulnerability search query has returned no vulnerabilities
vulnerabilityQuery : String
- An InsightAppSec search query may be supplied to search vulnerabilities found by the scan.
- For example, if you wish to fail the build when high severity vulnerabilities have been found, use:
```
                       vulnerability.severity='HIGH'
            
```
- The query supplied will automatically be scoped to the scan
- For more information on vulnerability search queries, consult the InsightAppSec API search documentation here:
  https://help.rapid7.com/insightappsec/en-us/api/v1/docs.html#tag/Search
- If left blank, the build will fail when any vulnerabilities have been found in the scan
maxScanPendingDuration : String
A max scan pending duration may be provided so that the length of time the CI process takes to provide feedback can be controlled.
- This option is ignored if 'Scan has been submitted' has been selected as the build advance indicator
- The duration will take affect when the scan has been submitted
- Upon reaching the duration, the scan will be cancelled and the build will fail
The following format must be used for defining a duration:
```
       0d 5h 30m
    
```
- (d) - Days
- (h) - Hours
- (m) - Minutes
A quantity must be supplied for each of the above. e.g.
- 1 day: 1d 0h 0m
- 5 hours: 0d 5h 0m
- 3 hours, 30 minutes: 0d 3h 30m
maxScanExecutionDuration : String
A max scan execution duration may be provided so that the length of time the CI process takes to provide feedback can be controlled.
- This option is ignored if 'Scan has been submitted' has been selected as the build advance indicator
- This option is ignored if 'Scan has been started' has been selected as the build advance indicator
- The duration will take affect when the scan moves into scanning state
- Upon reaching the duration, the in-progress scan will be stopped and the build will advance as normal
The following format must be used for defining a duration:
```
       0d 5h 30m
    
```
- (d) - Days
- (h) - Hours
- (m) - Minutes
A quantity must be supplied for each of the above. e.g.
- 1 day: 1d 0h 0m
- 5 hours: 0d 5h 0m
- 3 hours, 30 minutes: 0d 3h 30m
enableScanResults : boolean

Flag to indicate if scan results should be viewable when a build has finished.

When enabled, a new action will be provided to view scan results, labeled 'InsightAppSec Scan Results'.

Note: All users with access to view the build job history will be able to view InsightAppSec scan results

snInstallApp

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be installed.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
appScope : String (optional)
Required if application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
appSysId : String (optional)
Required if application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
appVersion : String (optional)
Version of the application to install. If empty, the published version will be used.
baseAppAutoUpgrade : boolean (optional)
Only applicable if Application Customization is active and the associated application is a higher version than the currently installed version. Flag that indicates whether the associated base application should be automatically upgraded to a newer version.
Valid values:
- true: Automatically upgrade the associated application when a newer version becomes available.
- false: Upgrades need to be explicitly installed.
Data type: Boolean
Default: false
baseAppVersion : String (optional)
Only applicable if Application Customization is active. Version of the base application on which to apply the customizations. A base application is any third-party application that comes in the ServiceNow Store.
Data type: String
Default: If the version field in the associated Custom Application [sys_app] or Store Application [sys_store_app] table is set, then that value is used. If the version field is not set.
url : String (optional)
ServiceNow instance url where the application will be installed.

$class: 'InstallBuilder'

apkFile : String
uninstallFirst : boolean
failOnInstallFailure : boolean

snInstanceScan

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance (usually where the application will be published).
apiVersion : String (optional)
comboSysId : String (optional)
requestBody : String (optional)
scanType : String (optional)
suiteSysId : String (optional)
targetRecordSysId : String (optional)
targetTable : String (optional)
url : String (optional)
ServiceNow instance url (usually where the application will be published to).

$class: 'IqPolicyEvaluatorBuildStep'

iqStage : String
Controls the stage the policy evaluation will be run against on the Nexus IQ Server.
iqOrganization : String
Select an IQ Organization. This determines the organization under which the application will be created in case the application doesn't exist and the automatic application creation configuration is enabled.
iqApplication
- manualApplication
  - applicationId : String
    Specify the IQ Application ID. Determines the policy elements (policies, labels, and license threat groups) to associate with this build, and is managed via the Nexus IQ Server.
- selectedApplication
  - applicationId : String
    Select an IQ Application from a list of available IQ Applications. Determines the policy elements (policies, labels, and license threat groups) to associate with this build, and is managed via the Nexus IQ Server.
iqScanPatterns
A list of Ant-style patterns relative to the workspace root that denote the files/archives to be scanned, e.g. **/target/*.war or **/target/*.ear. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
- scanPattern : String
iqModuleExcludes
A comma-separated list of Ant-style patterns relative to the workspace root that denote the module information files (**/nexus-iq/module.xml) to be ignored, e.g. **/my-module/target/**, **/another-module/target/**. If unspecified all modules will contribute dependency information (if any) to the scan.
- moduleExclude : String
failBuildOnNetworkError : boolean
Controls the build outcome if there is a failure in communicating with the Nexus IQ Server (e.g. network outage). If checked, the build will be marked as failed. Otherwise, the build is only marked as unstable.
jobCredentialsId : String
To use the IQ server credentials configured in Nexus global configuration for this job select - none -, otherwise select different credentials.
enableDebugLogging : boolean
advancedProperties : String
Provide advanced properties to the IQ Server in <key>=<value> pairs, with each additional property appearing on a new line. eg:
key1=value1 key2=value2
iqInstanceId : String (optional)

$class: 'IspwRestApiRequest'

connectionId : String (optional)
consoleLogResponseBody : boolean (optional)
credentialsId : String (optional)
ispwAction : String (optional)
ispwRequestBody : String (optional)
skipWaitingForSet : boolean (optional)

$class: 'IssueFieldUpdateStep'

JiraIssueFieldUpdater can be used to update custom Jira issue field.

issueSelector (optional)
- $class: 'DefaultIssueSelector'
- $class: 'ExplicitIssueSelector'
  - issueKeys : String
- $class: 'JqlIssueSelector'
  - jql : String
- $class: 'P4JobIssueSelector'
fieldId : String (optional)
fieldValue : String (optional)

$class: 'IssueUpdatesBuilder'

restAPIUrl : String
userName : String
password : String
jql : String
Similar to:
'project="A project key as in Jira" and status="The name of the status as in Jira"'
or
'project="A project key as in Jira" and status="The name of the status as in Jira" and fixVersion="A fix version as in Jira"'
workflowActionName : String
The name of a workflow action to be executed, depending on your Jira/ Greenhopper workflow configuration. Examples:
In Testing
In Review
On Hold
Resolve Issue
Stop Progress
comment : String
customFieldId : String
The key of the custom field. Example:
customfield_10862
customFieldValue : String
The value to be set to custom field. Build variables and environment variables in format $SOMEVAR are supported. Examples:
ver $VERSION_NUMBER
resettingFixedVersions : boolean
If is checked, the existing fixed versions of the issues will be removed before the specified fixed versions be added (overwritten); otherwise the fixed versions will be added to the issues.
With this option checked, and "Fixed versions to be added" left empty will effectively remove all existing fixed versions of the issues.
createNonExistingFixedVersions : boolean
If is checked, the given fix versions will be created in the Projects before trying to add them to the Issues otherwise only existing fix versions will be added to the issues.
With this option checked, and "Fixed versions to be added" left empty will effectively remove all existing fixed versions of the issues.
fixedVersions : String
The human readable names (not ID) of the versions delimited by comma. Build variables and environment variables in format $SOMEVAR are supported. Examples:
Kanban Board, RC, v$VERSION_NUMBER
The versions are project specific, only the versions that are applicable to the issues are added, others are ignored, for details please consult Jenkins log.
failIfJqlFails : boolean
failIfNoIssuesReturned : boolean
failIfNoJiraConnection : boolean

$class: 'JBossBuilder'

operation
- value
  - Values: START_AND_WAIT, START, SHUTDOWN, CHECK_DEPLOY
- properties : String
- stopOnFailure : boolean
serverName : String

$class: 'JIRATicketEditor'

jiraCredentialsID : String
These jira credentials and project will be used to operate on.
newTicketsTemplates
Allows you to provide templates for new tickets which will be published on JIRA.
- performDuplicateCheck : boolean
  When checked, the ticket creation will be skipped if a ticket with equal summary already exists.
  If the the ticket is a sub-ticket, only tickets with the same parent are considered for the suplicate check.
- parentJQL : String
  If the ticket type is a sub-task, specify here the JQL Query to select this new tickets parent. If the number of tickets matching this query is not exactly one, the build will fail. If the type is not a sub-task, this field is simply ignored.
- title : String
  The title (also called summary) of the new ticket.
- type : String
  The type of the new ticket, e.g. task or bug.
- priority : String
  The priority of the new ticket, e.g. medium.
- description : String
  A more detailed description of the issue represented by this ticket.
- envVarName : String
  If not empty, the plugin will store the Ticket-Key of the generated Ticket in this variable.
  For example, entering "myissue".
- fieldValues
  - fieldHumanReadableName : String
    The name of the field to be set. The field must have either the type string, number, or version. For versions, the name of the version to set must be given as value.
  - valueToSet : String
    The value which will be assigned to the given field.
modifyTicketsTemplates
Allows you to specify JQL filters along with modifications. The modifications will be applied on all Tickets matching the filter.
- jqlFilter : String
  The plugin will use this JQL-Query to select the tickets to modify from JIRA, see the documentation there on how to write such queries.
- commitRegEx : String
  To make use of this option, the build must be triggered by the Github Pull Request builder plugin.
  When the build is then triggered for a certain pull request, the commit messages of all commits associated with this pull request are extracted and
  matched against the regular expression given in this field. All matches in every commit are then used as ticket keys to select the tickets to modify.
  To specify, what part of the regular expression is the actual ticket key, use a named capturing group with the name "key".
  For example, the regular expression "\[(?&ltkey>.*?)\]" will extract the contents specified in square brackets as Ticket keys.
- ticketSource : String
- modifications
  - $class: 'AddCommentModification'
    - commentBody : String
      The value which will be assigned to the given field.
  - $class: 'ModifyArrayFieldModification'
    - fieldHumanReadableName : String
      The name of the field to be set. The field must have either the type string, number, or version. For versions, the name of the version to set must be given as value.
    - modificationType : String
    - modificationValue : String
      The value which will be used to perform the given modification.
      Add will add the given value to the field, remove will remove the specified value if it is existent. Replace will first clear the field and then place the given value in it.
  - $class: 'PerformTransitionModification'
    - transitionName : String
      The name of the transition to perform.
    - comment : String
      The comment to leave as reason for the transition
  - $class: 'SetFieldModification'
    - fieldHumanReadableName : String
      The name of the field to be set. The field must have either the type string, number, or version. For versions, the name of the version to set must be given as value.
    - valueToSet : String
      The value which will be assigned to the given field.

$class: 'JIRAVersionEditor'

jiraCredentialsID : String
These jira credentials and project will be used to operate on.
versionModifiactions
- versionName : String
- replaceDescription : boolean
- descriptionText : String
- releaseState : String
- failOnJQL : boolean
- failQuery : String

reportJMeterPerformanceTest

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
jmeterReportPath : String (optional)

$class: 'JSLintBuilder'

includePattern : String

The files to include in an Ant-style filter. See javadoc

Example: lib/**/*.js
This would grab files including lib/foo.js and lib/foo/bar/baz.js

Example: lib/*.js
This would include lib/foo.js but not lib/foo/bar.js
excludePattern : String

The files to exclude in an Ant-style filter. See javadoc

Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
logfile : String

The file to output to in a Checkstyle XML format

Example: target/jslint.xml
arguments : String

The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D

Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue

Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.

Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.

The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };

$class: 'JabberBuilder'

builderName : String

jacked

scanDest : String
repName : String
scanName : String
Input Image name, Directory path, tar file path, or sbom file path.
severityType : String
Select a threshold that will fail the build when equal to or above the severity found in the results.
scanType : String
Scan Type: Image, Directory, Tar File and SBOM File.
- Image: Provide the image to be scanned.
- Directory: Provide the target directory path to be scanned.
- Tar File: Provide the target tar file path to be scanned.
- SBOM File: Provide the target Diggity JSON Format SBOM file path to be scanned.
skipFail : boolean
- Warning: If the value is checked, it will restrict the plugin from failing the build based on the assessment result.
- Default: false / unchecked.
skipDbUpdate : boolean
- Warning: If the value is checked, it will skip check database update while scanning.
- Default: false / unchecked.
ignorePackageNames : String
Usage: Ignore the following package names when scanning. Leave blank if not using.
- Example Input Format: dpkg,tar,gzip
ignoreCves : String
Usage: Ignore the following CVEs when scanning. Leave blank if not using.
- Example Input Format: CVE-2022-24775,CVE-2022-1304,TEMP-0000000-6F6CD4

venafiCodeSignWithJarSigner

tppName : String
The Venafi Trust Protection Platform (TPP) to use for signing. You can define TPPs under "Manage Jenkins" -> "Configure System" -> "Venafi Code Signing".
certLabel : String
The label of the certificate (inside the TPP) to use for code signing. You can obtain a list of labels with 'pkcs11config listcertificates'.
credential
- credentialsId : String
extraArgs (optional)
This plugin invokes Jarsigner under the hood. Here you can specify extra custom CLI arguments to pass to Jarsigner.

These arguments will be appended to the Jarsigner CLI invocation, and take precedence over any arguments implicitly passed by this plugin.
- argument : String
file : String (optional)
The path to the file to be signed.

Either a path or a glob must be given.
glob : String (optional)
A glob that specifies the files to be signed.

Either a path or a glob must be given.
timestampingServers (optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.

If you specify more than one server, then a random one will be used.

Tip: here are some public timestamping authorities that you can use:
- http://timestamp.digicert.com
- http://timestamp.globalsign.com
- http://timestamp.comodoca.com/authenticode
- http://tsa.starfieldtech.com
- address : String
venafiClientToolsDir : String (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
- Linux: /opt/venafi/codesign
- macOS: /Library/Venafi/CodeSigning
- Windows: autodetected from the registry, or (if that fails): C:\Program Files\Venafi CodeSign Protect

venafiVerifyWithJarSigner

tppName : String
The Venafi Trust Protection Platform (TPP) that contains the certificate that the signed file(s) were signed by. You can define TPPs under "Manage Jenkins" -> "Configure System" -> "Venafi Code Signing".
certLabel : String
The label of the certificate (inside the TPP) that was used for signing the file(s). You can obtain a list of labels with 'pkcs11config listcertificates'.
credential
- credentialsId : String
file : String (optional)
The path to the file to be verified.

Either a path or a glob must be given.
glob : String (optional)
A glob that specifies the files to be verified.

Either a path or a glob must be given.
venafiClientToolsDir : String (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
- Linux: /opt/venafi/codesign
- macOS: /Library/Venafi/CodeSigning
- Windows: autodetected from the registry, or (if that fails): C:\Program Files\Venafi CodeSign Protect

$class: 'JbpmUrlResourceBuilder'

url : String
processId : String

SoapUIPro

pathToTestrunner : String
pathToProjectFile : String
environment : String (optional)
projectPassword : String (optional)
slmLicenceAccessKey : String (optional)
testCase : String (optional)
testCaseTags : String (optional)
testSuite : String (optional)
testSuiteTags : String (optional)

jf

args : Object

$class: 'JigomergeBuilder'

source : String
username : String
password : String
oneByOne : boolean
eager : boolean
validationScript : String
dryRun : boolean
verbose : boolean
ignoreMergePatterns : String
commitCommentPrefix : String

$class: 'JiraEnvironmentVariableBuilder'

Extracts Jira information for the build to environment variables.

Available variables:

JIRA_ISSUES - A comma separated list of issues which are referenced in the version control system changelog
JIRA_URL - Primary URL for the Jira server

Typical usage:

Add this build step
Use the "Progress Jira issues by workflow action" or "Move issues matching JQL to the specified version" with JQL like:
```
issue in (${JIRA_ISSUES})
```

issueSelector
- $class: 'DefaultIssueSelector'
- $class: 'ExplicitIssueSelector'
  - issueKeys : String
- $class: 'JqlIssueSelector'
  - jql : String
- $class: 'P4JobIssueSelector'

$class: 'JiraExtBuildStep'

issueStrategy
How to find the JIRA issues to update.
- $class: 'FirstWordOfCommitStrategy'
- $class: 'FirstWordOfUpstreamCommitStrategy'
- $class: 'MentionedInCommitStrategy'
- $class: 'SingleTicketStrategy'
  - issueKey : String
    The JIRA issue key to use. For example, JENKINS-101
extensions
- $class: 'AddComment'
  - postCommentForEveryCommit : boolean
    Whether to post a comment to a JIRA ticket for every commit. This is useful if the comment contains stuff specific to the commit, such as commit message.
  - commentText : String
- $class: 'AddFixVersion'
  - fixVersion : String
    
    The Fix Version to append. Must exist.
- $class: 'AddLabel'
  - labelName : String
    The label to add
- $class: 'AddLabelToField'
  - fieldName : String
    The name of the field. For custom fields this will have something like customfield_12349
  - fieldValue : String
    Space delimited labels to add to field.
- $class: 'Transition'
  - transitionName : String
    The name of the transition to use. For example: Close, Re-Open, or Resolve
- $class: 'UpdateField'
  - fieldName : String
    The name of the field. For custom fields this will have something like customfield_12349
  - fieldValue : String
    The value of the field to set.

$class: 'JiraIssueUpdateBuilder'

Performs a Jira workflow action for every issue that matches the JQL query. A common use might be to consider a ticket "confirmed" in the last build step of a job, or to mark an issue as "merged" if the job is used to merge changes from one SCM repository to another.

Optionally, include a comment that will be attached to those tickets that are modified as a result of this build step.

jqlSearch : String
Issues which match this JQL Query will be progressed using the specified workflow action.
This can contain $PARAM values which will be replaced by the build parameters.
Example:
```
project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
```
or (e.g., combined with a Jira Issue Parameter, selecting one issue from a JQL result set):
```
issue = $ISSUE_ID
```
workflowActionName : String
The workflow action to be performed on the selected Jira issues.
Be mindful of the issues being selected by the JQL query, because not all actions are valid for all issue statuses.
NOTE: the Jenkins user must have access to perform the workflow step, as if the user were logged in and viewing the issue in a web browser.
comment : String
An optional comment to be added to the issue after updating the workflow. If left empty, no comment will be added.
This can contain $PARAM values which will be replaced by the build parameters.

$class: 'JiraReleaseVersionUpdaterBuilder'

jiraProjectKey : String

Specify the project key. A project key is the all capitals part before the issue number in Jira.

(EXAMPLE-100)
jiraRelease : String
Specify the name of the parameter which will contain the release version. This can reference a build parameter.
jiraDescription : String
Optional
Specify a description of the release version. This can reference a build parameter.

$class: 'JiraVersionCreatorBuilder'

jiraVersion : String
Specify the name of the parameter which will contain the release version. This can reference a build parameter.
jiraProjectKey : String

Specify the project key. A project key is the all capitals part before the issue number in Jira.

(EXAMPLE-100)

$class: 'JobConfigRebrander'

$class: 'JobDeleteBuilder'

target : String
Regular expression of the job to be deleted. Variable will be expanded.

$class: 'JobStrongAuthSimpleBuilder'

jobUsers : String
Set the users who approve the execution of a job.
useGlobalUsers : boolean
If checked, append global setting of `Users`.
jobMinAuthUserNum : int
Minimum number of User who approve, which continue the execution of a job.
useJobExpireTime : boolean
If checked, check the period which user approved in expire time from build started.
jobExpireTimeInHours : int
The period which treats the time of which as effective recognition from a start time.
It will not treat, if it is recognized when the time more than the expire time.

$class: 'JobcopyBuilder'

fromJobName : String
The name of the job used as the copy source. Variables will be expaneded.
toJobName : String
The name of the job that will be created or overwritten. Variables will be expanded.
overwrite : boolean
Whether to overwrite the job if it already exists.
jobcopyOperationList
Additional operations to copy a project.
- $class: 'DisableOperation'
- $class: 'EnableOperation'
- $class: 'ReplaceOperation'
  - fromStr : String
    A string that will be replaced.
  - expandFromStr : boolean
    Whether expand variables in From String.
  - toStr : String
    A string that will be replaced with.
  - expandToStr : boolean
    Whether expand variables in To String.
additionalFilesetList
You can copy files additional to job main configuration file (config.xml). This is useful for the case some job configurations are stored in another files (e.g. Promoted Builds Plugin). Copy operations can be also applied, but operations are designed for main configuration files, so may not work correctly for other files.
- includeFile : String
  Specify files to copy. Multiple files can be specified with separating with comma(,). Wildcard is available like '**/*.xml'. See includes attribute of Ant FileSet Type for the exact format. The base directory is the job directory (${JENKINS_HOME}/jobs/JOBNAME).
- excludeFile : String
  Specify files not to copy (even specified in Files field).
- overwrite : boolean
  overwrite or skip the file if it already exists.
- jobcopyOperationList
  - $class: 'DisableOperation'
  - $class: 'EnableOperation'
  - $class: 'ReplaceOperation'
    - fromStr : String
      A string that will be replaced.
    - expandFromStr : boolean
      Whether expand variables in From String.
    - toStr : String
      A string that will be replaced with.
    - expandToStr : boolean
      Whether expand variables in To String.

$class: 'KanboardTaskFetcher'

projectIdentifier : String
taskReference : String
taskAttachments : String (optional)
taskLinks : String (optional)

$class: 'KarafBuildStepBuilder'

useCustomKaraf : boolean
karafHome : String
flags : String
-a [port]
specify the port to connect to
-h [host]
specify the host to connect to
-u [user]
specify the user name
-p [password]
specify the password (optional, if not provided, the password is prompted)
-v
raise verbosity
-l
set client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]
retry connection establishment (up to attempts times)
-d [delay]
intra-retry delay (defaults to 2 seconds)
-f [file]
read commands from the specified file
-k [keyFile]
specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]
define the client idle timeout
option
- $class: 'KarafCommandFileOption'
  - file : String
- $class: 'KarafCommandScriptOption'
  - script : String (optional)

unlockMacOSKeychain

keychainId : String (optional)
keychainName : String (optional)
keychainPath : String (optional)
keychainPwd (optional)
- Type: class hudson.util.Secret

$class: 'KlocworkBuildSpecBuilder'

Integration analysis (Full)

Use the following steps to perform a Klocwork integration analysis and load the results to the Klocwork Server:

Klocwork - Step 1 (CI/Full) - Capture Build Information runs a Klocwork build specification generation tool to capture compilation information about the project Klocwork - Step 2 (Full) - Run Analysis runs the Klocwork Server analysis engine against the data captured within the build specification Klocwork - Step 3 (Full) - Load Analysis Results runs the Klocwork Server load tool, which imports analysis data into the Klocwork Server database

Differential Analysis (CI)

Use the following steps to perform a differential analysis, which does not publish the results to the Klocwork Server and only reports the new issues detected since the previous integration analysis. Differential analysis can be used as a quality measure to reduce new issues being added to the Klocwork Server, and can also be configured to only analyze the changed files from the checkin, making the process much quicker:

buildSpecConfig
- buildCommand : String
  Specify your project's build command. This command is used to compile the project and capture information about the build in a build specification file that Klocwork will use for the analysis.
- tool : String
  The Klocwork tool used to generate the build specification, by default this is set to kwinject.
  Tools Available: kwinject monitors your C/C++ build to create a build specification kwmaven creates a Java build specification based on the information in your maven build file kwmavenw creates a Java build specification based on the information in your maven wrapper file kwjsspec creates a Javascript build specification file kwpyspec creates a Python build specification file kwktspec creates a Kotlin build specification file kwant creates a Java build specification based on the information in your ant build file create tracefile uses kwinject to create a trace file, mainly used for debugging kwgradle creates a Java build specification based on the information in your Gradle build file kwgradlew creates a Java build specification based on the information in your Gradle wrapper file
- output : String
  Specify the build specification output filename and, optionally, its file path. By default, the build specification is written to kwinject.out in the current working directory. The specified file path can be absolute or relative to the current working directory. By default, the current working directory is the workspace directory.
- additionalOpts : String
  Specify other tool options here. Separate the options with whitespace; surround any arguments with whitespace in double quotes.
- ignoreErrors : boolean
  Ignore any error return codes from this step and continue.
- workDir : String (optional)
  Specify the working directory path from where the Klocwork Build Spec Generation command will be executed. This path must both exist and be relative to the workspace directory. If no value is specified in this field then the Klocwork Build Spec Generation command will be executed from the workspace directory.

$class: 'KlocworkCiBuilder'

ciConfig
- buildSpec : String
  Build specification to use for analysis. Path is relative to the workspace
- projectDir : String
- cleanupProject : boolean
- reportFile : String
  XML report file in which to store Klocwork results. Optional, in case you want to use the XML report for something custom; otherwise, a default file is created for the post-build step.
- additionalOpts : String
  Additional options added to the kwciagent run command. For example, specify the number of jobs/threads to use (--jobs-num) or which filters to apply (--severity --taxonomy --system)
  
  See the Klocwork documentation for more information.
- incrementalAnalysis : boolean
  
  Analyze changed files only
  
  This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit-like behavior . The goal is that only changed files are analyzed by the Klocwork kwciagent tool to replicate the local analysis developers would perform by using our supported IDE plugins or the command line utility. To enable this behavior, the plugin takes a list of the changed files from the SCM; this enables the system to analyze only the changed files when the workspace isn’t kept. Leave this cleared to analyze the whole project, or, if the workspace is kept, to perform a standard incremental analysis.
  
  Diff file list
  
  The diff file list is the file that contains the changed source files for Klocwork to analyze. All analyzed files must exist in the build specification generated by kwinject.
  
  Note: All files to be analyzed must exist in the build specification.
  
  Using Git
  
  If using Git, provide the previous commit that Git should perform a "diff" against. The change list between the current commit and the specified previous commit will be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build. Note: If you are using Git jenkins plugin to obtain source files for you pipeline job be sure to use 'Pipeline script from SCM' and specify the previous commit with the environment variable, 'GIT_PREVIOUS_COMMIT'. Also be aware that the first build in the job won't be able to access GIT_PREVIOUS_COMMIT and the first build will run full CI analysis.
  
  Manual
  
  If you are not using Git, or want to manually generate the change list by using Git, select this option. You will need to generate the diff file list by using a custom build-step (or similar). List one changed source file on each line of the file.
- differentialAnalysisConfig
  - diffType : String
  - gitPreviousCommit : String
  - diffFileList : String

$class: 'KlocworkServerAnalysisBuilder'

serverConfig
- buildSpec : String
  Build specification to use for analysis. Path is relative to the workspace.
- tablesDir : String
  Specify the location of the tables directory, for example, ${MY_VAR}/kwtables.
- incrementalAnalysis : boolean
- ignoreCompileErrors : boolean
  Ignore compile errors encountered by kwbuildproject. This setting will not ignore a return code that indicates that kwbuildproject failed to the extent that no results are generated.
- importConfig : String
  Optionally, provide configuration files to import to the project before running the analysis. If the checker configuration (for example, analysis_profile.pconf) is under version control, you can provide the file here and it will be automatically imported for each build.
  
  Specify multiple files by separating them with commas (",").
- additionalOpts : String
- disableKwdeploy : boolean
  By default, kwdeploy runs before the analysis, to ensure the checkers are up-to-date. Enable this setting if you don't want kwdeploy to run before the analysis.
- duplicateFrom : String (optional)
  Optional setting to specify the name of an existing Klocwork project. Klocwork will duplicate that project's configuration settings.
- enabledCreateProject : boolean (optional)
  Enable to create a new Klocwork project on the server if one does not exist with the name specified. This can be useful when using multi-branch pipeline jobs.

$class: 'KlocworkServerLoadBuilder'

serverConfig (optional)
- tablesDir : String (optional)
- buildName : String (optional)
  Specify the name of the build for the Klocwork server, for example, ${MY_VAR}-${GIT_COMMIT}. If empty, Klocwork uses an auto increment to name the builds.
- additionalOpts : String (optional)
reportConfig (optional)
- displayChart : boolean
- chartHeight : String (optional)
- chartWidth : String (optional)
- query : String (optional)

$class: 'KlocworkXSyncBuilder'

syncConfig
- dryRun : boolean
  Cross synchronisation reads and writes to the Klocwork database. Therefore, we strongly recommend that you first try a Dry Run of the command (which skips the writing) and verify that the command works as expected.
- lastSync : String
  Specify the "last synchronisation" date (how far back Klocwork should go when synchronising issue citations).
  
  Format is "DD-MM-YYYY hh:mm:ss".
  
  For example, "03-00-0000 00:00:00" will go back 3 days in time.
- projectRegexp : String
  A regular expression that is used to retrieve Klocwork projects that should be processed during synchronisation. If you want to process all projects, leave empty.
  
  For example, if you prepend projects with "DEPT-" to indicate a particular department the regular expression "^DEPT-" will match all these projects
- statusAnalyze : boolean
- statusIgnore : boolean
- statusNotAProblem : boolean
- statusFix : boolean
- statusFixInNextRelease : boolean
- statusFixInLaterRelease : boolean
- statusDefer : boolean
- statusFilter : boolean
- additionalOpts : String
  Additional options added to the kwxsync command.
  
  See the Klocwork documentation for more information.

$class: 'KojiBuilder'

kojiBuild : String
Koji build ID, can be NVR or maven coordinate with release number suffix.
kojiTarget : String
kojiPackage : String
kojiOptions : String
kojiTask : String
kojiScratchBuild : boolean
kojiScmUrl : String

cfyKubernetes

allowNodeRedefinition : boolean (optional)
apiKeyCredentialsId : String (optional)

The ID of the credentials entry that contains the API key.

This parameter is optional; the API key may also be provided through "API options", however this method is preferred.

If provided, then this credentials entry must either be of type "text" or "file". In the latter case, the file is read as-is and the resultant string is used as the API credentials.
apiKeyFile : String (optional)

Path to file, relative to the Jenkins workspace, containing the API key.

This parameter is optional, as the API key may be provided by other means.
caCert : String (optional)
Path, relative to the workspace's root, of a file containing the CA certificates store to use for verifying the Kubernetes host's certificate.
credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean (optional)
If checked, then printed Cloudify events and logs will include debug-level records.
definition (optional)
- Type: java.util.Map<java.lang.String, java.lang.Object>
definitionAsString : String (optional)
The Kubernetes application definition.
definitionFile : String (optional)
Path, relative to the Jenkins workspace root, to a file containing the Kubernetes application definition.
deploymentId : String (optional)

ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
echoEnvData : boolean (optional)

If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean (optional)
If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
envDataLocation : String (optional)

Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
gcpCredentialsFile : String (optional)

A YAML/JSON file containing GCP service account details, to use for authentication against GCP.

This parameter is optional, and is only relevant for authenticating against GCP.

If provided, it should follow the same layout as described in the "GCP Credentials ID" parameter.
gcpCredentialsId : String (optional)
The ID of the credentials to be used for authentication against GCP.

This parameter is optional, and is only relevant for authenticating against GCP.

If provided, it should be the ID of either a string-type or file-type credentials entry, with the standard GCP service account YAML/JSON syntax:
```
{
  "type": "...",
  "project_id": "...",
  "private_key_id": "...",
  "private_key": "...",
  "client_email": "...",
  "client_id": "...",
  "auth_uri": "...",
  "token_uri": "...",
  "auth_provider_x509_cert_url": "...",
  "client_x509_cert_url": "..."
}
	
```
k8sDebug : boolean (optional)
k8sMaster : String (optional)
The Kubernetes master host to use. This can also be provided through the API Options field; it is available as a separate parameter for convenience.
namespace : String (optional)
The application's namespace. Note: value provided here will overwrite the namespace value in the options field, if exists.
options (optional)
- Type: java.util.Map<java.lang.String, java.lang.Object>
optionsAsString : String (optional)
Kubernetes options.
optionsFile : String (optional)
Path, relative to the Jenkins workspace root, to a file containing Kubernetes options.
skipSslVerification : boolean (optional)
sslCertFile : String (optional)
Path, relative to the workspace's root, of a file containing the certificate presented to the Kubernetes host.
sslKeyFile : String (optional)
Path, relative to the workspace's root, of a file containing the key for the certificate presented to the Kubernetes host.
tenant : String (optional)
validateStatus : boolean (optional)
If checked, then the status of the Kubernetes application is validated after provisioning.

kubernetesEngineDeploy

cluster : String (optional)
clusterName : String (optional)
credentialsId : String (optional)
location : String (optional)
manifestPattern : String (optional)
namespace : String (optional)
projectId : String (optional)
verboseLogging : boolean (optional)
verifyDeployments : boolean (optional)
verifyServices : boolean (optional)
verifyTimeoutInMinutes : int (optional)
zone : String (optional)

loadcompletetest

project : String (optional)
test : String (optional)
actionOnErrors : String (optional)
actionOnWarnings : String (optional)
executorVersion : String (optional)
generateMHT : boolean (optional)
generatePDF : boolean (optional)
timeout : String (optional)
useTimeout : boolean (optional)

leanIXMicroserviceIntelligence

apitoken (optional)
- Type: class hudson.util.Secret
dependencymanager : String (optional)
deploymentstage : String (optional)
deploymentversion : String (optional)
hostname : String (optional)
jobresultchoice : String (optional)
lxmanifestpath : String (optional)
mavensettingspath : String (optional)
useleanixconnector : boolean (optional)

lacework

customFlags : String

Specify any desired command-line flags to be passed to the Lacework scanner.
fixableOnly : boolean

Whether the build step should only return information for fixable vulnerabilities.
imageName : String
imageTag : String
noPull : boolean

Whether the build step should attempt to pull container images that don't exist locally.
evaluatePolicies : boolean

Whether the build step should evaluate against policies which are assigned in the Lacework platform.
saveToLacework : boolean

Whether the build step should save assessment results to the Lacework platform.
disableLibraryPackageScanning : boolean

Whether the build step should disable scanning of programming language libraries.
showEvaluationExceptions : boolean

Whether the build step should display evaluation exceptions.
tags : String

Specify any desired tags, in JSON key/value format, to be assigned to the Lacework scanner assessment.

eventSourceLambda

lambdaEventSourceBuildStepVariables
- awsRegion : String
- functionName : String
- eventSourceArn : String
- awsAccessKeyId : String (optional)
- awsSecretKey : String (optional)
- functionAlias : String (optional)
- useInstanceCredentials : boolean (optional)

invokeLambda

lambdaInvokeBuildStepVariables
- awsRegion : String
- functionName : String
- synchronous : boolean
- awsAccessKeyId : String (optional)
- awsSecretKey : String (optional)
- jsonParameters (optional)
  - envVarName : String
  - jsonPath : String (optional)
- payload : String (optional)
- useInstanceCredentials : boolean (optional)

publishLambda

lambdaPublishBuildStepVariables
- awsRegion : String
- functionARN : String
- functionAlias : String
- versionDescription : String
- awsAccessKeyId : String (optional)
- awsSecretKey : String (optional)
- useInstanceCredentials : boolean (optional)

deployLambda

lambdaUploadBuildStepVariables
- awsRegion : String
- functionName : String
- updateMode : String
- alias : String (optional)
- artifactLocation : String (optional)
- awsAccessKeyId : String (optional)
- awsSecretKey : String (optional)
- createAlias : boolean (optional)
- deadLetterQueueArn : String (optional)
- description : String (optional)
- enableDeadLetterQueue : boolean (optional)
- environmentConfiguration (optional)
  - environment
    - key : String
    - value : String
  - configureEnvironment : boolean (optional)
  - kmsArn : String (optional)
- handler : String (optional)
- memorySize : String (optional)
- publish : boolean (optional)
- role : String (optional)
- runtime : String (optional)
- securityGroups : String (optional)
- subnets : String (optional)
- timeout : String (optional)
- useInstanceCredentials : boolean (optional)

$class: 'LeapworkJenkinsBridgeBuilder'

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.
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.

$class: 'LeiningenBuilder'

task : String
Provide leiningen task and arguments here. task can be any of:
- check
- help
- repl
- uberjar
- classpath
- install
- retest
- upgrade
- clean
- jar
- run
- version
- compile
- javac
- search
- with-profile
- deploy
- plugin
- show-profiles
- deps
- pom
- test
- do
- repeat
- trampoline
subdirPath : String
Subdirectory path relative to workspace to run Leiningen in.

checkETLicense

Check ECU-TEST license.

Pipelines usage:

Signatures:

checkETLicense(String toolName) : void

Examples:

checkETLicense('ECU-TEST')

toolName : String
installation (optional)
- name : String
- home : String
- properties
  - Type: ? extends hudson.tools.ToolProperty<?>
timeout : String (optional)

lighthouseReport

file : String
JSON report file to load
name : String (optional)
Report name (Optional)

dotnetListPackage

The dotnet list package command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process.

(see also: Microsoft Documentation)

charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
config : String (optional)
Configuration file containing the NuGet sources to use when searching for newer packages. Requires the --outdated, --deprecated or --vulnerable option.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
deprecated : boolean (optional)
Lists packages that have been deprecated. Cannot be combined with --vulnerable or --outdated options.

Available since: .NET Core SDK 3.1.300
framework : String (optional)
frameworks : Array / List of String (optional)
frameworksString : String (optional)
Displays only the packages applicable for the specified target frameworks.
highestMinor : boolean (optional)
Considers only the packages with a matching major version number when searching for newer packages. Requires the --outdated option.
highestPatch : boolean (optional)
Considers only the packages with a matching major and minor version numbers when searching for newer packages. Requires the --outdated option.
includePrerelease : boolean (optional)
Considers packages with prerelease versions when searching for newer packages. Requires the --outdated option.
includeTransitive : boolean (optional)
Lists transitive packages, in addition to the top-level packages. When specifying this option, you get a list of packages that the top-level packages depend on.
outdated : boolean (optional)
Lists packages that have newer versions. Cannot be combined with --deprecated or --vulnerable options.
project : String (optional)
The project or solution file to operate on. If not specified, the command searches the current directory for one. If more than one solution or project is found, an error is thrown.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
source : String (optional)
sources : Array / List of String (optional)
sourcesString : String (optional)
The NuGet sources to use when searching for packages. Requires the --outdated>, --deprecated> or --vulnerable> option.
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
verbosity : String (optional)
Sets the verbosity level of the command.

Note that this option only has an effect since the .NET 5 SDK.
vulnerable : boolean (optional)
Lists packages that have known vulnerabilities. Cannot be combined with --deprecated or --outdated options.

Available since: .NET Core SDK 5.0.200
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

$class: 'LoadImpactTestRunTask'

apiTokenId : String
loadTestId : int
criteriaDelayValue : int
criteriaDelayUnit : String
criteriaDelayQueueSize : int
abortAtFailure : boolean
thresholds
- metric : String
- operator : String
- value : int
- result : String
pollInterval : int
logHttp : boolean
logJson : boolean

$class: 'LoadNinjaBuilder'

apiKey : String
Your LoadNinja API KEY.
scenarioId : String
The Scenario Id of the Load Ninja load test you want to run.
oeb
- errorPassCriteria : String
odb
- durationPassCriteria : String

greet

testId : String
credentialsId : String

$class: 'LoadtestBuilder'

loadtestBuilderModel
- environmentShortName : String
- authToken : String
  Enter your LTP authentication token
- presetName : String
  The name of the load test preset as you saved it in LTP.
- loadtestScenario : String
  The name of the load test scenario to run the loadtest with e.g myscenario.class or scenario1.zip
- loadtestThresholdParameters
  - metricType : String
  - evaluationDirection : String
  - numericValue : double

dotnetNuGetLocals

The dotnet nuget locals command clears or lists local NuGet resources in the http-request cache, temporary cache, or machine-wide global packages folder.

(see also: Microsoft Documentation)

cacheLocation : String (optional)
The cache location to list or clear. It accepts one of the following values:
- all: Indicates that the specified operation is applied to all cache types: http-request cache, global packages cache, and the temporary cache.
- global-packages: Indicates that the specified operation is applied only to the global packages cache. The other cache locations aren't affected.
- http-cache: Indicates that the specified operation is applied only to the http-request cache. The other cache locations aren't affected.
- temp: Indicates that the specified operation is applied only to the temporary cache. The other cache locations aren't affected.
charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
forceEnglishOutput : boolean (optional)
Forces the application to run using an invariant, English-based culture.
operation : String (optional)
Two operations are supported:
- clear: The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders that weren't cleared.
- list: Displays the path to the specified cache location.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

$class: 'LoginBuilder'

credentialsId : String
Credentials to a Turbo account which will be used to execute the build script.
hubUrl : String
Optional parameter. The hub server to use. Example: https://turbo.net.

mabl

restApiKeyId : String
ID of the mabl API key credential for your workspace. The key is kept safely in Jenkins credentials using Secret text kind. Make sure that you set the ID of the credential as IDs are used to select the credential from the drop-down list. The scope of the credential must be Global and the credential may be kept in any domain (including the unrestricted Global credentials or any other domain). More info.
environmentId : String
Input a valid API key to populate the environment selection drop-down.
applicationId : String
Input a valid API key to populate the application selection drop-down.
apiBaseUrl : String (optional)
appBaseUrl : String (optional)
continueOnMablError : boolean (optional)
continue build, if error occurred in mabl system (e.g. connection failure, system outage)
continueOnPlanFailure : boolean (optional)
continue build, even if triggered Plans do not complete successfully (e.g. bad assertion)
disableSslVerification : boolean (optional)
disable SSL verification (only required if Jenkins is behind a MITM proxy)
labels : String (optional)
Comma-separated list of labels.
mablBranch : String (optional)
mabl will run tests using this mabl branch name. Note that this branch is not the branch name in the source control repository. The branch in mabl must exist before triggering the tests.

$class: 'MailCommandBuilder'

　To recieve e-mail that CLI command is written, set properties.

POP3 mail server address	Set POP3 mail server's hostname or ip address.
POP3 mail server port	Set POP3 mail server's port. Default value is 110.
POP3 User Name	Set POP3 mail server's user account.
POP3 Password	Set POP3 mail server's password.

address : String
port : String
username : String
password : String

$class: 'MakeAppTouchTestable'

Makes the specified project compatible with SOASTA TouchTest, by adding the TouchTest Driver library.

url : String
cloudTestServerID : String
Select the server to download MakeAppTouchTestable.zip from. This also specifies where any required Mobile App objects should be created.
inputType : String
Defines the type of input file that will be made TouchTestable. See Input File help for more details.
projectFile : String
The type of file (or directory) being made TouchTestable.
- Project instruments the source code of an iOS or Android project.
- APK instruments the binary content of a compiled Android .apk file.
- IPA instruments the binary content of a compiled iOS .ipa file.
- iOS App Bundle instruments the binary content of an iOS application bundle (.app directory).
More information can be found here.
target : String
For iOS apps, this specifies the Xcode target that MakeAppTouchTestable should modify.
launchURL : String
The URL that TouchTest Agent should use to launch the app (e.g. "myapp://"). If no launch URL is specified, then MakeAppTouchTestable will automatically generate one.
backupModifiedFiles : boolean
Create a backup of any file that is modified by MakeAppTouchTestable. The backup files will be stored in a timestamped sub-directory of the project.
additionalOptions : String
If you need to pass any other command line options to the MakeAppTouchTestable utility, specify them here. You can separate options with new lines as well as whitespaces.
javaOptions : String
Add additional JVM arguments. Default (when no value is given): -Xmx1024m

$class: 'ManageInstance'

cloud : String
workspace : String
The workspace in ElasticBox.
operations
- Type: ? extends com.elasticbox.jenkins.builders.Operation

$class: 'MatlabBuilder'

matlabRoot : String (optional)
Enter the full path to the MATLAB root folder, which is returned by the matlabroot function.

Example:

Windows:
C:\Program Files\MATLAB\R2019a
Linux:
/usr/local/MATLAB/R2019a
Mac:
/Applications/MATLAB_R2019a.app

Note: If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.
testRunTypeList (optional)
Select the test run mode from the following options.
Run Tests Automatically: Runs all tests in the Jenkins workspace, including tests in subfolders.
Use Custom MATLAB Command: Use your own custom MATLAB commands or script file to run your tests.

Nested Choice of Objects

$class: 'RunTestsAutomaticallyOption'
- taCoberturaChkBx : boolean (optional)
  
  Generate a Cobertura code coverage report, named cobertura.xml, to be stored in the matlabTestArtifacts folder of the current Jenkins workspace.
- taJunitChkBx : boolean (optional)
  
  Generate a JUnit style test report, named junittestresults.xml, to be stored in the matlabTestArtifacts folder of the current Jenkins workspace.
- taModelCoverageChkBx : boolean (optional)
  
  Generate a Cobertura model coverage report, coberturamodelcoverage.xml, and save it in the matlabTestArtifacts folder of the Jenkins workspace. This report includes coverage results for Simulink® models that are tested using Simulink Test™.
  
  Note: This feature requires a Simulink Coverage™ license and is supported only in MATLAB R2018b or a newer release.
- taPDFReportChkBx : boolean (optional)
  
  Generate a test report in PDF format, testreport.pdf, and save it in the matlabTestArtifacts folder of the Jenkins workspace.
  
  Due to Jenkins Content Security Policy rules, the generated report might not open properly from within the Jenkins workspace. Consider copying the report to a location outside the workspace and opening it from there. For more information, see Configuring Jenkins Content Security Policy.
  
  Note:This feature is not currently supported on MacOS platforms.
- taSTMResultsChkBx : boolean (optional)
  
  Export Simulink Test™ Manager results in MLDATX format, simulinktestresults.mldatx, and save them in the matlabTestArtifacts folder of the Jenkins workspace.
  
  Note: This feature requires a Simulink Test license and is supported only in MATLAB R2019a or a newer release.
- tatapChkBx : boolean (optional)
  
  Generate a TAP style test report, named taptestresults.tap, to be stored in the matlabTestArtifacts folder of the current Jenkins workspace.
$class: 'RunTestsWithCustomCommandOption'
- customMatlabCommand : String (optional)
  To run your tests, enter MATLAB commands separated by semicolons.
  Example: cd c:\MATLAB\tests; runtests('IncludingSubfolder','true');
  
  Recommendation:If you require a number of MATLAB commands to execute your build, consider writing a MATLAB script and executing the script file instead.
  Note: The build will fail if the execution of any MATLAB command causes an error.

maven

targets : String
name : String
pom : String
properties : String
Properties needed by your Maven build can be specified here (in the standard properties file format):
```
# comment
name1=value1
name2=value2
```
These are passed to Maven like "-Dname1=value1 -Dname2=value2"
jvmOptions : String
usePrivateRepository : boolean
settings
The settings element in the settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml , but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
There are two locations where a settings.xml file per default may live:
- The Maven install - default: $M2_HOME/conf/settings.xml
- A user's install - default: ${user.home}/.m2/settings.xml
The former settings.xml are also called global settings, the latter settings.xml are referred to as user settings. If both files exists, their contents gets merged, with the user-specific settings.xml being dominant.
see also: settings.xml reference
- standard
  Use default maven settings ( $HOME/.m2/settings.xml ) as set on build node.
- filePath
  Use a custom settings.xml file. Such a file is checked out from SCM as part of the job or a well known location.
  - path : String
    Path to settings.xml file, relative to project workspace or absolute (variables are supported).
- $class: 'MvnSettingsProvider'
  select the provided settings.xml for this project
  - settingsConfigId : String
globalSettings
- standard
  Use default maven settings ( $HOME/.m2/settings.xml ) as set on build node.
- $class: 'FilePathGlobalSettingsProvider'
  Use a custom global settings.xml file from job workspace. Such a file is checked out from SCM as part of the job or a well known location.
  - path : String
    Path to settings.xml file, relative to project workspace or absolute (variables are supported).
- $class: 'MvnGlobalSettingsProvider'
  select the provided global settings.xml for this project
  - settingsConfigId : String
injectBuildVariables : boolean
Pass all build variables into maven process in form of java properties. This is seldom needed as Jenkins provides it as environment variables anyway. Preferred way to access Jenkins build variables is to explicitly map it to property in Properties section ( MY_VAR=${MY_VAR} ).

$class: 'Maven3Builder'

mavenName : String
rootPom : String
goals : String
mavenOpts : String
useWrapper : boolean

reportMavenDependenciesAnalysis

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
reportPath : String (optional)

$class: 'MavenDeploymentDownloader'

This builder allows to download artifacts which where uploaded to a maven repository. The source project must have the 'Link to maven deployments' option enabled.

projectName : String
The project/job from which the artifacts should be copied from. This project must have the 'Link to maven deployments' option enabled, only artifacts which where recorded by the maven deployment linker plugin can be downloaded.
filePattern : String
All files matching this pattern will be copied to the target location. (default: .*)
permaLink : String
Which build of the project should the artifacts be copied from?
targetDir : String
The directory to copy the files to.
stripVersion : boolean
Should the version be striped of the filenames?
With the 'Strip Version Pattern' in the advanced section, one is able to overwrite how the striping is done.
stripVersionPattern : String
(optional) The regular expression used to strip the version of the files. The first group of the pattern will be used as the name of the target file and the last group will be used as the extension of the file. e.g. (firstGroup).(lastGroup)
failIfNoArtifact : boolean
Should the build fail if there was no artifact found to download?
cleanTargetDir : boolean
Should the content of the target directory be deleted first?

$class: 'MavenSealightsBuildStep'

beginAnalysis

Nested Object

logLevel
- Values: OFF, INFO, DEBUG, WARN, ERROR
buildSessionId : String
appName : String
moduleName : String
branch : String
enableMultipleBuildFiles : boolean
overrideJars : boolean
multipleBuildFiles : boolean
labId : String
testStage : String
packagesIncluded : String
packagesExcluded : String
filesIncluded : String
filesExcluded : String
classLoadersExcluded : String
In order to exclude class loaders from the build, please provide comma separated list of class loaders names to exclude. Class loader name should be the class loader full package name. e.g. 'com.example.package.SomeClassLoader'
recursive : boolean
workspacepath : String
buildScannerJar : String
testListenerJar : String
testListenerConfigFile : String
autoRestoreBuildFile : boolean
sealightsMavenPluginInstallationArguments : String
buildFilesPatterns : String
buildFilesFolders : String
logEnabled : boolean
logDestination
- Values: CONSOLE, FILE
logFolder : String
buildStrategy
- Values: ONE_BUILD, BUILD_EACH_MODULE
slMvnPluginVersion : String
buildName
- $class: 'DefaultBuildName'
- $class: 'EmptyBuildName'
- $class: 'LatestBuildName'
- $class: 'ManualBuildName'
  - insertedBuildName : String
- $class: 'UpstreamBuildName'
  - upstreamProjectName : String
executionType
- Values: FULL, TESTS_ONLY, ONLY_LISTENER
override_customerId : String
override_url : String
override_proxy : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
buildsessionidfile	Set build session id file for this build.
createbuildsessionid	When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
sealightsJvmParams	Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue)
buildScannerParams	Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue)
testListenerJvmParams	Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue)

includeResources : boolean
When checked, the build session id and token files will be added to the artifacts as as resources in the folder.

buildStepMode
- $class: 'DisableSealightsView'
  - targets : String
- $class: 'InvokeMavenCommandView'
  - targets : String
- $class: 'OffView'
- $class: 'PrepareSealightsView'
  - additionalMavenArguments : String
name : String
pom : String
properties : String
Properties needed by your Maven build can be specified here (in the standard properties file format):
```
# comment
name1=value1
name2=value2
```
These are passed to Maven like "-Dname1=value1 -Dname2=value2"
jvmOptions : String
usePrivateRepository : boolean
settings
The settings element in the settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
There are two locations where a settings.xml file per default may live:
- The Maven install - default: $M2_HOME/conf/settings.xml
- A user's install - default: ${user.home}/.m2/settings.xml
The former settings.xml are also called global settings, the latter settings.xml are referred to as user settings. If both files exists, their contents gets merged, with the user-specific settings.xml being dominant.
see also: settings.xml reference
- standard
  Use default maven settings ( $HOME/.m2/settings.xml ) as set on build node.
- filePath
  Use a custom settings.xml file. Such a file is checked out from SCM as part of the job or a well known location.
  - path : String
    Path to settings.xml file, relative to project workspace or absolute (variables are supported).
- $class: 'MvnSettingsProvider'
  select the provided settings.xml for this project
  - settingsConfigId : String
globalSettings
- standard
  Use default maven settings ( $HOME/.m2/settings.xml ) as set on build node.
- $class: 'FilePathGlobalSettingsProvider'
  Use a custom global settings.xml file from job workspace. Such a file is checked out from SCM as part of the job or a well known location.
  - path : String
    Path to settings.xml file, relative to project workspace or absolute (variables are supported).
- $class: 'MvnGlobalSettingsProvider'
  select the provided global settings.xml for this project
  - settingsConfigId : String

mavenSnapshotCheck

check : boolean (optional)
This will check the SNAPSHOT of pom.xml if you check the checkbox.
pomFiles : String (optional)
The pomFiles parameter used to check only the specified pom files.
excludePomFiles : String (optional)
The excludePomFiles parameter used to skip check the specified pom files.

$class: 'MdtoolSolutionBuilder'

installationName : String
solutionPath : String
Give the Solution file (.sln) from the module root (SCM root directory or workspace directory) that plugin will use to build.
You can use build variables through the syntax ${var}.
target
- value : String
  Name of the target: Build or Clean.
  Supported targets:
  - Build: build the project (the default target).
  - Clean: clean the project.
configuration
- value : String
  Name of the solution configuration to build.
project
- value : String
  Name of the project to build.
runtime
- value : String
  Prefix of the Mono runtime to build against.

measure

VMs : int (optional)
androidCompileSdkVersion : String (optional)
androidGradleTasks : String (optional)
androidGradleVersion : String (optional)
androidManifest : String (optional)
androidMinSdkVersion : String (optional)
androidTargetSdkVersion : String (optional)
androidTestPackageName : String (optional)
clazzFolders : String (optional)
cleanGoal : String (optional)
clearMockitoCaches : boolean (optional)
commitDiff : int (optional)
createDefaultConstructor : boolean (optional)
credentialsId : String (optional)
directlyMeasureKieker : boolean (optional)
displayLogs : boolean (optional)
displayRCALogs : boolean (optional)
displayRTSLogs : boolean (optional)
excludeByRule : String (optional)
excludeForTracing : String (optional)
excludeLog4jSlf4jImpl : boolean (optional)
excludeLog4jToSlf4j : boolean (optional)
excludes : String (optional)
executeBeforeClassInMeasurement : boolean (optional)
executeParallel : boolean (optional)
executeRCA : boolean (optional)
failOnRtsError : boolean (optional)
generateCoverageSelection : boolean (optional)
generateTwiceExecutability : boolean (optional)
importLogSizeInMb : int (optional)
includeByRule : String (optional)
includes : String (optional)
iterations : int (optional)
kiekerQueueSize : long (optional)
kiekerWaitTime : int (optional)
linearizeHistory : boolean (optional)
measureJMH : boolean (optional)
measurementMode (optional)
- Values: LEVELWISE, COMPLETE, UNTIL_STRUCTURE_CHANGE, UNTIL_SOURCE_CHANGE
nightlyBuild : boolean (optional)
onlyMeasureWorkload : boolean (optional)
onlyOneCallRecording : boolean (optional)
pl : String (optional)
properties : String (optional)
redirectSubprocessOutputToFile : boolean (optional)
redirectToNull : boolean (optional)
removeSnapshots : boolean (optional)
repetitions : int (optional)
showStart : boolean (optional)
significanceLevel : double (optional)
statisticalTest (optional)
- Values: T_TEST, BIMODAL_T_TEST, AGNOSTIC_T_TEST, MANN_WHITNEY_TEST, CONFIDENCE_INTERVAL, ANY, ANY_NO_AGNOSTIC
testClazzFolders : String (optional)
testExecutor : String (optional)
testGoal : String (optional)
testTransformer : String (optional)
timeout : long (optional)
traceSizeInMb : int (optional)
updateSnapshotDependencies : boolean (optional)
useAggregation : boolean (optional)
useAlternativeBuildfile : boolean (optional)
useAnbox : boolean (optional)
useGC : boolean (optional)
useSourceInstrumentation : boolean (optional)
warmup : int (optional)
writeAsZip : boolean (optional)
xmx : String (optional)

$class: 'MendCnScannerBuilder'

userEmail : String
userKey
- Type: class hudson.util.Secret
mendUrl : String
repoNames : String
List of repositories to scan from, separate by comma

$class: 'MergebaseStepBuilder'

projectName : String (optional)
severityThreshold : String (optional)
mbScanPath : String (optional)
scanAll : boolean (optional)
debugMode : boolean (optional)
jsonOutput : boolean (optional)
killBuild : boolean (optional)

redmineMetricsReport

settings (optional)
- url : String
- apiKey : String
  
  Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
  
  If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
- projectName : String
  
  Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
- customQueryId : int
- sprintSize : int
  
  Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.

$class: 'MicroDocsChecker'

microDocsReportFile : String
microDocsProjectName : String
microDocsGroupName : String
microDocsEnvironments : String
microDocsSourceFolder : String
microDocsFailBuild : boolean
microDocsPublish : boolean
microDocsNotifyPullRequest : boolean

minio

bucket : String
The bucket to upload the files to. This bucket will be created if it does not yet exist. Please note the restrictions in bucket naming
includes : String
File pattern to indicate which files will be uploaded. Multiple entries can be used when separated by a ","
credentialsId : String (optional)
Credentials to use when authenticating to Minio. If host is left blank the global configured credentials will be used
excludes : String (optional)
host : String (optional)
URL where Minio is reachable by Jenkins. Leave this blank to use global configuration
targetFolder : String (optional)
If you want to store the artifacts in a specific folder in Minio you can specify it with this parameter. Environment variables can be used with the ${...} syntax.

minioDelete

bucket : String
The bucket to download the files from. An error will be thrown if this bucket does not exist.
files : String
Indicates what files should be deleted in Minio. Environment variables can be used with the ${...} syntax. Multiple files can be separated using ",".
credentialsId : String (optional)
Credentials to use when authenticating to Minio. If host is left blank the global configured credentials will be used
failOnNonExisting : boolean (optional)
By default the plugin will not error out if it tries to delete a file that doesn't exist.
host : String (optional)
URL where Minio is reachable by Jenkins. Leave this blank to use global configuration

minioDownload

bucket : String
The bucket to download the files from. An error will be thrown if this bucket does not exist.
file : String
Indicates what file should be downloaded. Environment variables can be used with the ${...} syntax.
credentialsId : String (optional)
Credentials to use when authenticating to Minio. If host is left blank the global configured credentials will be used
excludes : String (optional)
failOnNonExisting : boolean (optional)
Uncheck this if you want the build to continue when a non-existing file is encountered.
host : String (optional)
URL where Minio is reachable by Jenkins. Leave this blank to use global configuration
targetFolder : String (optional)
Optionally indicate what directory in your workspace the objects should be downloaded to. Environment variables can be used with the ${...} syntax.

$class: 'MobileStudioTestBuilder'

Jenkins plugin for execution of Progress Mobile Studio tests.

mobileStudioRunnerPath : String
Full path to Mobile Studio Runner executable.
testPath : String
The full path to the .mttest test or .mtlist (test list) to run.
msgServer : String (optional)
deviceId : String (optional)
projectRoot : String (optional)
The path to the project root folder.
testAsUnit : boolean (optional)
If checked MobileStudio test will be converted to JUnit test, else test will be converted to testsuite and test steps will be converted to JUnit test.

$class: 'MockLoadBuilder'

Generates load on the Jenkins build node and over the remoting channel. There will be a random number of build artifacts created matching the file name pattern mock-artifact-*.txt. There will be a JUnit test report with the file name mock-junit.xml. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.

averageDuration : long
The average duration that the build should take. The actual duration of each step will be randomly selected where with an expected standard deviation equal to the square root of the expected average duration.

$class: 'ModelBuilder'

pushGuardSettings
- minBufferSize : String
hubUrls : String
Optional parameter. Multiple hub urls, comma separated. Eg: https://turbo.net, https://stage.turbo.net
When multiple hubs are specified, the streaming model will be pushed to all hubs.

$class: 'MonitorRemoteJobBuilder'

hostName : String
jobName : String
timeBefore : String
It is determined as working last build if it is carried out within the set time.
if set "1h", last build is after one ours ago from now, it regard task as working normal. Berow charactor is usable.
1. d for date.
2. h for hour.
3. m for minute.
4. s for second.
userName : String
password : String
useSSL : boolean

$class: 'MonkeyBuilder'

filename : String
packageId : String
eventCount : int
throttleMs : int
seed : String
categories : String
extraParameters : String

moveComponents

nexusInstanceId : String
destination : String
The repository to which components will be moved
search (optional)
- Type: java.util.Map<java.lang.String, java.lang.String>
tagName : String (optional)
Components associated with this tag will be moved to the selected destination repository

msbuild

msBuildName : String
msBuildFile : String

Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
cmdLineArgs : String

This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
buildVariablesAsProperties : boolean

If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.

Beware : Sensitive build variables such as passwords will not be added.
continueOnBuildFailure : boolean

If set to true, Job will continue despite MSBuild build failure.
unstableIfWarnings : boolean

If set to true and warnings on compilation, the build will be unstable.
doNotUseChcpCommand : boolean

$class: 'MsBuildSQRunnerBegin'

additionalArguments : String (optional)
msBuildScannerInstallationName : String (optional)
projectKey : String (optional)
projectName : String (optional)
projectVersion : String (optional)
sonarInstallationName : String (optional)

$class: 'MsBuildSQRunnerEnd'

$class: 'MsTestBuilder'

msTestName : String
testFiles : String

Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll

Command Line Argument: /testcontainer

categories : String

Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:

Cateogry Filter	Result
Priority1	Any test with category Priority1
Priority1&SpeedTest	Test that have both Priority1 and SpeedTest categories
Priority1\|SpeedTest	Tests that have either Priority1 or SpeedTest categories
Priority1&!SpeedTest	Test that have Priority1 category and also do not have SpeedTest category.

Command Line Argument: /category

resultFile : String

Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.

Command Line Argument: /resultsfile
cmdLineArgs : String
continueOnFail : boolean

Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
failIfNoTests : boolean

Specify if the build should fail if no test files are found.

$class: 'MultiJobBuilder'

phaseName : String
phaseJobs
- jobName : String
- jobAlias : String
- jobProperties : String
- currParams : boolean
- configs
  - $class: 'BooleanParameters'
    - configs
      This passes Boolean parameters to the downstream jobs
      
      Array / List of Nested Object
      name : String
      
      value : boolean
  - $class: 'CurrentBuildParameters'
  - $class: 'FileBuildParameters'
    - propertiesFile : String
      Comma separated list of absolute or relative paths to file(s) that contains the parameters for the new project. Relative paths are originated from the workspace. The file should have KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
    - encoding : String
      Specify the encoding of contents of the files. If not specified, default encoding of the platform is used.
    - failTriggerOnMissing : boolean
      When enabled blocks the triggering of the downstream jobs if any of the files are not found in the workspace.
    - useMatrixChild : boolean
      Use files in workspaces of child builds (that is, builds for each axes combination). This works only when used in publishers of multi-configuration projects. Ignored when used in builders.
    - combinationFilter : String
      Write groovy expression to filter child builds whose files to use. If not specified, uses all children. See Combination Filter of Configuration Matrix for details of groovy expression.
    - onlyExactRuns : boolean
      Use child builds that is triggered exactly by the parent build. This affects the behavior when you triggered only some of combinations using plugins, you removed some values from axes, and so on.
    - textParamValueOnNewLine : boolean
      When enabled properties containing newline character(s) are propagated as TextParameterValue which is a specialized StringParameterValue commonly used for handling multi-line strings in Jenkins. When disabled (default) all properties are propagated as StringParameterValue.
      TextParameterValue and StringParameterValue are typically rendered differently by Jenkins and plugins such as the Rebuild plugin.
  - $class: 'GeneratorCurrentParameters'
  - $class: 'GitRevisionBuildParameters'
    This "parameter" passes the SHA1 commit ID that was built by this project into the specified job, and thereby causes the specified job to check out the exact same commit. This is useful to chain multiple activities in a sequence that acts on the same commit in different ways.
    - combineQueuedCommits : boolean
      This checkbox cause the all revisions to be be ignored apart from the last one if a build is already in the queue.
      Does not combine entries with builds of manually started downstream job that are queued. (Ones that do no have a git hash attached to them)
      Warning: There is no consideration for multiple branches, or any other behaviour, it is your responsibility to make sure that the hashes provided come from the same branch.
  - $class: 'MatrixSubsetBuildParameters'
    - filter : String
      Specifies the Groovy filter expression that restricts the subset of the combinations that the downstream project will run.
      See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
      
      What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
      
      Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
  - $class: 'NodeLabelBuildParameter'
    - name : String
      This parameter type defines where the target job should be executed, the value must match either a label or a node name - otherwise the job will just stay in the queue. The NodeLabel parameter passed to the target job, does not have to exist on the target job (but if the target has one defined, it should match the name). This way it is possible to trigger jobs on different nodes then they are actually configured.
    - nodeLabel : String
      The node can be static or a token to be expanded by the token macro plugin.
  - $class: 'NodeParameters'
  - $class: 'PredefinedBuildParameters'
    - properties : String
      KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
    - textParamValueOnNewLine : boolean
      When enabled properties containing newline character(s) are propagated as TextParameterValue which is a specialized StringParameterValue commonly used for handling multi-line strings in Jenkins. When disabled (default) all properties are propagated as StringParameterValue.
      TextParameterValue and StringParameterValue are typically rendered differently by Jenkins and plugins such as the Rebuild plugin.
  - $class: 'PredefinedGeneratorParameters'
    - properties : String
      KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
  - $class: 'SubversionRevisionBuildParameters'
    This parameter passes the Subversion revisions that were used in this build to the downstream builds.
    - includeUpstreamParameters : boolean
      This option passes through the subversion parameters that were passed into this build from upstream builds, so that they can be used on downstream projects.
- killPhaseOnJobResultCondition
  - Values: FAILURE, NEVER, UNSTABLE
- disableJob : boolean
- enableRetryStrategy : boolean
- parsingRulesPath : String
- maxRetries : int
- enableCondition : boolean
- abortAllJob : boolean
- condition : String
- buildOnlyIfSCMChanges : boolean
- applyConditionOnlyIfNoSCMChanges : boolean
- aggregatedTestResults : boolean
continuationCondition
- Values: ALWAYS, SUCCESSFUL, COMPLETED, UNSTABLE, FAILURE
executionType
- Values: PARALLEL, SEQUENTIALLY
quietPeriodGroovy : String

mavenForesight

projectId : String
Thundra Foresight Test Project Id
credentialId : String
thundraAgentVersion : String (optional)

$class: 'MystBuilder'

mystAction : String
MyST action to be execute.
config : String
mystWorkspace : String
properties : String
mystInstallationName : String

NCScanBuilder

ncScanType : String
ncWebsiteId : String
ncProfileId : String
ncDoNotFail : boolean (optional)
ncReportType : String (optional)
credentialsId : String (optional)
ncApiToken : Object (optional)
ncConfirmed : boolean (optional)
ncIgnoreFalsePositive : boolean (optional)
ncIgnoreRiskAccepted : boolean (optional)
ncServerURL : String (optional)
ncSeverity : String (optional)
ncStopScan : boolean (optional)

$class: 'NISConnection'

viewUrl : String
The tabpanel displays the names of the tasks which are analyzed.
address : String
Host name (of target server)
port : int
Port (of target server)
prozent : int
Percentage of tasks, which should be accomplished

npm

command : String
workspaceSubdirectory : String (optional)

apiKey

validateDnsUrlConnection : boolean
apiUrl : String (optional)
The Base URL of the NowSecure API, by default this is https://lab-api.nowsecure.com. For Enterprise installs, this URL will differ.
group : String (optional)
Specify group-id where the app belongs
binaryName : String (optional)
Specify the filename of Android or iOS application, only apk and ipa formats are supported respectively. You can specify filename if it was generated by a previous step and is stored under the artifacts directory or the full path of the file.
description : String (optional)
Specify description of this step
waitForResults : boolean (optional)
Check this option if you would like to wait until security analysis is completed. This step would fail if any critical errors are found.
waitMinutes : int (optional)
Specify, in minutes, how long this step should wait for results. If analysis takes longer than this limit, the step would timeout.
breakBuildOnScore : boolean (optional)
Break the build when the application's security score is lower then the defined threshold.
scoreThreshold : int (optional)
Specify a number between 1 and 100, 1 being the lower and 100 being the highest, to act as a threshold for breaking builds.
apiKey : String (optional)
The API Key is used to authenticate against the NowSecure Auto API. See https://docs.nowsecure.com/auto/integration-services/jenkins-integration/ for instructions on generating an API Key.
useBuildEndpoint : boolean (optional)
artifactsDir : String (optional)
debug : boolean (optional)
password : String (optional)
proxyEnabled : boolean (optional)
showStatusMessages : boolean (optional)
Specify if status messages for automation testing should be displayed
stopTestsForStatusMessage : String (optional)
username : String (optional)
validateDnsUrlConnectionEnabled : boolean (optional)
Check this option if you would like to validate DNS and URL access for NowSecure API

$class: 'NSiqBuilder'

srcDir : String
fileFilter : String

$class: 'NantBuilder'

nantBuildFile : String
nantName : String
targets : String
properties : String

$class: 'NeoBuildAction'

This build step executes a NeoLoad scenario and adds trend result graphs to the job page.

executable : String
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.
projectType : String
reportType : String
localProjectFile : String
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.
sharedProjectName : String
This is the name of the shared project to checkout and load.
For example, MyProjectName.
scenarioName : String
The name of the Scenario to launch.
htmlReport : String
This is the path where the HTLM report file is created by NeoLoad.
For example, ${WORKSPACE}/neoload-report/report.html.
xmlReport : String
This is the path where the XML report file is created.
For example, ${WORKSPACE}/neoload-report/report.xml.
pdfReport : String
This is the path where the PDF report file is created.
For example, ${WORKSPACE}/neoload-report/report.pdf.
junitReport : String
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.
scanAllBuilds : boolean
displayTheGUI : boolean
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.
testResultName : String
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}).
testDescription : String
The test description entered here appears in the report file.
licenseType : String
licenseVUCount : String
This is the number of Virtual Users (User Paths) to reserve with the license.
licenseVUSAPCount : String
This is the number of SAP Virtual Users (User Paths for SAP) to reserve with the license.
licenseDuration : String
This is the number of hours to reserve the license. This must be at least as long as the test will last.
customCommandLineOptions : String
Include any additional Command Line options here.
publishTestResults : boolean
When selected, test results are published after the scenario is run.
sharedProjectServer
Choose which server to use. If no servers appear, please configure one in the System Configuration screen of Jenkins.
- uniqueID : String
- url : String
- loginUser : String
- loginPassword
  - Type: class hudson.util.Secret
- label : 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.
- uniqueID : String
- url : String
- loginUser : String
- loginPassword
  - Type: class hudson.util.Secret
- label : String
- collabPath : String
- licenseID : String
showTrendAverageResponse : boolean
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.
showTrendErrorRate : boolean
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.
graphOptionsInfo
- name : String
- curve
  - path : String
- statistic : String
maxTrends : int
Limit the number of points in trend charts. You can use 0 value to have unlimited charts

$class: 'NerrvanaPlugin'

settingsXmlString : String
loglevel : String
Workspace folder help file

$class: 'NetStormBuilder'

This build step can be used to invoke Netstorm tasks

URLConnectionString : String
username : String
password : Object
project : String
subProject : String
scenario : String
testMode : String
baselineType : String
pollInterval : String
profile : String
generateReport : boolean
doNotWaitForTestCompletion : boolean
rampupDuration : String
skipSSLCertCheck : boolean
skipSSLHostCheck : boolean
protocol : String (optional)
repoIp : String (optional)
repoPort : String (optional)
repoPath : String (optional)
repoUsername : String (optional)
repoPassword : String (optional)
script : String (optional)
page : String (optional)
advanceSett : String (optional)
urlHeader : String (optional)
hiddenBox : String (optional)
gitPull : String (optional)
testProfileBox : String (optional)
totalusers : String (optional)
rampUpSec : String (optional)
rampupmin : String (optional)
rampuphour : String (optional)
duration : String (optional)
serverhost : String (optional)
sla : String (optional)
testName : String (optional)
scriptPath : String (optional)
emailid : String (optional)
emailidCC : String (optional)
emailidBcc : String (optional)
testsuite : String (optional)
dataDir : String (optional)
checkRuleFileUpload : String (optional)

neuvector

repository : String
Enter the name of the repository to scan.
registrySelection : String
Select a registry by its nickname from the drop down menu, or select Local. Registries can be added in the global settings.
nameOfVulnerabilityToExemptFour : String (optional)
nameOfVulnerabilityToExemptOne : String (optional)
nameOfVulnerabilityToExemptThree : String (optional)
nameOfVulnerabilityToExemptTwo : String (optional)
nameOfVulnerabilityToFailFour : String (optional)
nameOfVulnerabilityToFailOne : String (optional)
nameOfVulnerabilityToFailThree : String (optional)
nameOfVulnerabilityToFailTwo : String (optional)
numberOfHighSeverityToFail : String (optional)
Minimum number of high vulnerabilities to fail the build. Leave blank or zero if not applicable.
numberOfMediumSeverityToFail : String (optional)
Minimum number of medium vulnerabilities to fail the build. Leave blank or zero if not applicable.
scanLayers : boolean (optional)
Check to scan the image layers, and get the number of vulnerabilities for each layer.
scanTimeout : int (optional)
The timeout value in minutes for the local image scan. The default is 10 minutes.
standaloneScanner : boolean (optional)
tag : String (optional)
Enter the image tag. The default tag is ‘latest’.

$class: 'NewEngineBuilder'

imageName : String
bailOnFail : boolean (optional)
bailOnPluginFail : boolean (optional)
cliVersionToApply : String (optional)
customCliVersion : String (optional)
engineCredentialsId : String (optional)
engineURL : String (optional)
engineVerify : boolean (optional)
inlineScanExtraParams : String (optional)
policiesToApply : String (optional)
scannerBinaryPath : String (optional)

$class: 'NexusArtifactUploader'

nexusVersion : String
protocol : String
nexusUrl : String
If Nexus Url is http://mynexusrepo:8081/nexus the value for this field is mynexusrepo:8081/nexus
groupId : String
version : String
repository : String
RepositoryId of the Repository in Nexus to which this artifact to be uploaded.
credentialsId : String
artifacts
- artifactId : String
- type : String
  Extension of the artifact for ex: artifact file name is artifact.zip the extension is zip.
- classifier : String
  Classifier of the artifact.
- file : String
  File path in the workspace. ex:artifact.zip or artifact.jar

$class: 'NexusPublisherBuildStep'

nexusInstanceId : String
nexusRepositoryId : String
The publisher currently supports hosted release Maven 2 repositories. This list is limited to repositories which meet this requirement.
packages
- $class: 'MavenPackage'
  - mavenCoordinate
    - groupId : String
    - artifactId : String
    - version : String
    - packaging : String
  - mavenAssetList
    - filePath : String
    - classifier : String
    - extension : String
tagName : String (optional)
Tag is only available for Nexus Repository Manager 3+

nirmata

For projects that use Nirmata as part of the build system. This causes Jenkins to invoke Nirmata Service with the given actions, following fields and options. Jenkins will mark the build as a failure if any issue is encountered.

builder
Select the required action from the drop-down

Delete App in Environment
Deletes the specified application from the specified environment.

Deploy App in Environment
Deploys the specified application from catalog to specified application.

Update App in Catalog
Updates the specified application in specified catalog.

Update App in Environment
Updates the specified application in specified environment.
- deleteAppInEnvironment
  - endpoint : String
  - apikey : String
  - environment : String
  - application : String
  - timeout : int
- deployAppInEnvironment
  - endpoint : String
  - apikey : String
  - environment : String
  - application : String
  - timeout : int
  - catalog : String
  - directories : String
  - includescheck : boolean
  - includes : String
  - excludescheck : boolean
  - excludes : String
  - deployType : String
- updateAppInCatalog
  - endpoint : String
  - apikey : String
  - catalog : String
  - timeout : int
  - directories : String
  - includescheck : boolean
  - includes : String
  - excludescheck : boolean
  - excludes : String
- updateAppInEnvironment
  - endpoint : String
  - apikey : String
  - environment : String
  - application : String
  - timeout : int
  - directories : String
  - includescheck : boolean
  - includes : String
  - excludescheck : boolean
  - excludes : String

nodejsci

command : String
nodeJSInstallationName : String
cacheLocationStrategy (optional)
- default
- executor
- workspace
configId : String (optional)

$class: 'NopmdCheckPublisher'

filesetList
- pattern : String
  Patterns of files that must be included. You can use wildcards like Apache Ant fileset. "*" is used to match zero or more characters, "**" is used to match zero or more directories.
- excludePattern : String
  Patterns of files that must be excluded.

$class: 'NotifyEventsBuilder'

token : String
title : String
message : String
priority : String
level : String
attachBuildLog : boolean
attachment : String

$class: 'NouvolaBuilder'

planID : String
You can find your plan ID by signing into https://divecloud.nouvola.com and going to Tests -> Test Plans. The ID can be found in the table next to the plan you wish to run.
apiKey : String
Your Nouvola API Key can be found in https://divecloud.nouvola.com by clicking on ACCOUNT and selecting the "API & Keys" tab.
credsPass : String
If you setup your Nouvola DiveCloud test with credentials, you will need to enter the encryption key you saved with those credentials.
waitTime : String
If you are not using a return URL, the plugin will poll the DiveCloud API for results. You may enter a time in minutes for the job to wait before commencing polling based on the expected time taken by the test plan to complete.
returnURL : String
Nouvola Divecloud plugin uses Nouvola's webhook service. In order to get a callback from the webhook service once the tests are completed, you will need to give a web url that the webhook service can send its payload to. If you do not have one, the Jenkins job will exit once a test plan is successfully triggered without waiting for a callback.
listenTimeOut : String
If you are using a return URL for Nouvola Divecloud's webhook service to return results, enter a period in minutes for which the listener should wait for a callback from the service. This value should be the approximate length of the test plan. This can be gauged based on your experience with the tests. If this value is not given a default value of 30 minutes will be used.

$class: 'NucleiBuilder'

targetUrl : String
For more info visit:
- https://nuclei.projectdiscovery.io/
- https://github.com/projectdiscovery/nuclei
additionalFlags : String (optional)
For more info please see
nuclei --help
or visit:
- https://nuclei.projectdiscovery.io/
- https://github.com/projectdiscovery/nuclei
nucleiVersion : String (optional)
By default we recommended using the latest version of Nuclei.
This option is offered to handle potential compatibility issues.
In case of such issues:
- please make sure you are using the latest version of the plugin.
- if the issue still persists choose an older version of Nuclei to maintain compatibility.
- notify the development team by creating an issue, so we can make the necessary changes.
reportingConfiguration : String (optional)
Offers Reporting and Issue Tracking capabilities (e.g. Jira/GitHub etc)
For the full list of supported platforms, usage and documentation please visit https://nuclei.projectdiscovery.io/nuclei/get-started.html#nuclei-reporting

$class: 'OOBuildStep'

For projects that use Operations Orchestration as an automation system. This causes Jenkins to invoke flows from a selected server.

ooServer : String
basepath : String
The path to the directory that contains the flow that you want to run. The path can be found in Operation Orchestration Central under Content Management\Flow Library
```
Default path: /Library
```
```
E.g.:
    Library/Tutorials/subflows/
    Library/Templates
    
```
selectedFlow : String
args
- name : String
- value : String
retVariableToCheck : String
comparisonOrdinal : int
valueToCompareWith : String
desiredResultType : String
stepExecutionTimeout : String
This input configures the step execution timeout of the plugin to xxx ms. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
runName : String

ostorlabScan

waitForResults : boolean
riskThreshold
- Values: HIGH, MEDIUM, LOW, POTENTIALLY, HARDENING
apiKey : String
JsonCredentials : String
filePath : String (optional)
title : String (optional)
scanProfile : String (optional)
platform : String (optional)
waitMinutes : int (optional)
breakBuildOnScore : boolean (optional)
credentials (optional)
- name : String
- value : String
scoreThreshold (optional)
- Values: HIGH, MEDIUM, LOW, POTENTIALLY, HARDENING
waitingForResults : boolean (optional)

$class: 'Oak9Builder'

orgId : String (optional)
Your oak9 Organization ID
projectId : String (optional)
Your oak9 Project ID
credentialsId : String (optional)
Your oak9 authentication key
maxSeverity : int (optional)
baseUrl : String (optional)
pollingTimeoutSeconds : int (optional)
The amount of time in seconds to wait for a validation to complete

$class: 'OctoperfBuilder'

credentialsId : String (optional)
Select the Octoperf credentials to use.
workspaceId : String (optional)
Select the Octoperf Workspace.
projectId : String (optional)
Select the Octoperf Project.
scenarioId : String (optional)
OctoPerf's plugin for Jenkins allows users to automate load tests from the Cloud.
Just choose the scenario you want to run. Let Jenkins start and stop the test and document the results.
After the run, a test report will be generated directly into Jenkins and your OctoPerf account.
If the test list is empty, you must insert your unique OctoPerf Username and password into the Jenkins settings, or create a test in your OctoPerf account.
testName : String (optional)

Name of the test. Leave empty to take scenario's name by default.
stopConditions (optional)
- Type: ? extends org.jenkinsci.plugins.octoperf.conditions.TestStopCondition

octopusPack

toolId : String
The Octopus Deploy Command Line executable
packageId : String
The ID of the package; e.g. MyCompany.MyApp
packageFormat : String
ZIP is the recommended format.
sourcePath : String
The root folder containing files and folders to pack. Defaults to the working directory.
additionalArgs : String (optional)
Additional arguments to be passed to the Octo executable.
includePaths : String (optional)
Newline-separated files to include in the package. Defaults to **
outputPath : String (optional)
The folder into which the generated package file will be written. Defaults to the working directory.
overwriteExisting : boolean (optional)
Overwrite any existing package
packageVersion : String (optional)
The version number of the package. Defaults to a timestamp-based version.
verboseLogging : boolean (optional)
Enable debug logging

octopusPushBuildInformation

serverId : String
The identifier of the Octopus Server instance which you want to use for deploying this release.
Server Id is set in the global OctopusDeploy Plugin configuration.
spaceId : String
If left empty the Default space for the Octopus Server instance will be used.
Otherwise, specify a space by name. The space specified must exist in the Octopus Server instance.
toolId : String
The Octopus Deploy Command Line executable
packageId : String
Newline-separated package IDs; e.g.
MyCompany.MyApp
MyCompany.MyApp2
packageVersion : String
The version number of the package. Defaults to a timestamp-based version.
commentParser : String
Octopus can associate the work items or issues addressed by the changes in the package to the package. Select the issue tracking system that you use, or leave this option blank if you do not use a supported issue tracker.
overwriteMode
Normally, if the same build information already exists on the server, the server will reject the build information push. This practice ensures build information isn't accidentally overwritten or ignored. Enable this setting to override allow build information to be overwritten.
- Values: FailIfExists, OverwriteExisting, IgnoreIfExists
additionalArgs : String (optional)
Additional arguments to be passed to the Octo executable.
gitBranch : String (optional)
gitCommit : String (optional)
gitUrl : String (optional)
verboseLogging : boolean (optional)

octopusPushPackage

serverId : String
The identifier of the Octopus Server instance which you want to use for deploying this release.
Server Id is set in the global OctopusDeploy Plugin configuration.
toolId : String
The Octopus Deploy Command Line executable
packagePaths : String
Newline-separated paths of package files that will be pushed. Ant-style wildcards like dir/**/*.zip are supported.
overwriteMode
Normally, if the same package already exists on the server, the server will reject the package push. This practice ensures a package isn't accidentally overwritten or ignored. Use this setting to override this behavior.
- Values: FailIfExists, OverwriteExisting, IgnoreIfExists
additionalArgs : String (optional)
Additional arguments to be passed to the Octo executable.
spaceId : String (optional)
If left empty the Default space for the Octopus Server instance will be used.
Otherwise, specify a space by name. The space specified must exist in the Octopus Server instance.
verboseLogging : boolean (optional)
Enable debug logging

OneSky

projectId : String (optional)
Try to look for this on the URL after selecting the project from the menu
resourcesPath : String (optional)

$class: 'OntrackDSLStep'

ontrackScriptLocation
- value : String
- scriptPath : String
- scriptText : String
sandbox : boolean
If set, the Ontrack DSL script will run in a Groovy sandbox.
injectEnvironment : String
Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
```
        ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
    
```
injectProperties : String
You can define variables to inject into the script by using a property-like format.

For example, the following text:
```
        BRANCH = 1.0
        BUILD = ${VERSION}
    
```
would inject the corresponding BRANCH and BUILD variables in the script:
```
        ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
```
In the text:
- declare properties using name = value syntax
- empty lines are ignored
- lines started by # are ignored
- patterns like ${VAR} are expanded using VAR from the current environment variables.
ontrackLog : boolean
If set, the connections (request + response) to Ontrack will be logged in the build console output.
ignoreFailure : boolean
If set, a failure in contacting Ontrack won't make the step fail.

$class: 'OpenShiftBuildVerifier'

apiURL : String
bldCfg : String
If you run `oc get bc` for the project listed in "nameSpace", that is the value you want to put here.
namespace : String
authToken : String
verbose : String
checkForTriggeredDeployments : String
This flag is the toggle for turning on or off the verification that any deployments triggered by this build's output fired.
waitTime : String
waitUnit : String

$class: 'OpenShiftBuilder'

apiURL : String
bldCfg : String
If you run `oc get bc` for the project listed in "nameSpace", that is the value you want to put here.
namespace : String
env
Specify a list of environment variables to include in the build (see `oc start-build -e ...`).
- name : String
  The name of the environment variable to set.
- value : String
  The value for the environment variable.
authToken : String
verbose : String
commitID : String
The value here is what you supply with the --commit option when invoking the OpenShift `oc start-build` command. It allows you to point the OpenShift build to a specific commit hash from the git-log of the source repository. If you do not supply a value, the plugin assumes the latest version from the source repository should be used.
buildName : String
The value here is what you supply with the --from-build option when invoking the OpenShift `oc start-build` command. It allows you to point to OpenShift build to a previously run build, and run another build with exactly the same source and destination metadata. If you do not supply a value, the plugin will generate a new OpenShift build based on the Build Configuration referenced.
showBuildLogs : String
Indicates whether the build logs get dumped to the console of the Jenkins build.
checkForTriggeredDeployments : String
This flag is the toggle for turning on or off the verification that any deployments triggered by this build's output fired.
waitTime : String
waitUnit : String

$class: 'OpenShiftCreator'

apiURL : String
namespace : String
authToken : String
verbose : String
jsonyaml : String
The JSON or YAML formatted text that conforms to the schema for defining the various OpenShift resources.

$class: 'OpenShiftDeleterJsonYaml'

apiURL : String
namespace : String
authToken : String
verbose : String
jsonyaml : String
The JSON or YAML formatted text that conforms to the schema for defining the various OpenShift resources.

$class: 'OpenShiftDeleterLabels'

apiURL : String
namespace : String
authToken : String
verbose : String
types : String
The comma separated list of types of API objects to delete, where those objects have labels corresponding to the specified key/value pairs. See https://docs.openshift.org/latest/rest_api/index.html for the supported types.
keys : String
The comma separated list of keys of the labels in the API objects to delete.
values : String
The comma separated list of values of the labels in the API objects to delete.

$class: 'OpenShiftDeleterList'

apiURL : String
namespace : String
authToken : String
verbose : String
types : String
The comma separated list of types of API objects to delete. See https://docs.openshift.org/latest/rest_api/index.html for the supported types.
keys : String
The comma separated list of keys of the API objects to delete.

$class: 'OpenShiftDeployer'

apiURL : String
depCfg : String
If you run `oc get dc` for the project listed in "nameSpace", that is the value you want to put here.
namespace : String
authToken : String
verbose : String
waitTime : String
waitUnit : String

$class: 'OpenShiftDeploymentVerifier'

apiURL : String
depCfg : String
If you run `oc get dc` for the project listed in "nameSpace", that is the value you want to put here.
namespace : String
replicaCount : String
This optional field's value represents the number expected running pods for the deployment for the DeploymentConfig specified. If no value is specified it will work the number of running pods against the desired replica count in the DeploymentConfig.
authToken : String
verbose : String
verifyReplicaCount : String
This flag is the toggle for turning on or off the verification that the specified replica count for the deployment has been reached.
waitTime : String
waitUnit : String

$class: 'OpenShiftExec'

apiURL : String
namespace : String
authToken : String
verbose : String
pod : String
The pod in which to execute a command.
container : String
The container in which to execute a command. If not specified, the first container in the pod will be used.
command : String
The name of the command to execute.
arguments
Specify a list of arguments to pass to the command.
- value : String
  The value for the environment variable.
waitTime : String
waitUnit : String

$class: 'OpenShiftImageTagger'

apiURL : String
testTag : String
The name of the existing tag, or an actual, existing image ID. The image referenced will have the new tag applied to it.
prodTag : String
One or more tag names in a comma delimited list. If multiple streams and multiple destination tags are specified, the two lists must contain the same number of elements.
namespace : String
authToken : String
verbose : String
testStream : String
The name of the ImageStream for the existing tag.
prodStream : String
One or more ImageStream names in a comma delimited list. If multiple streams and multiple destination tags are specified, the two lists must contain the same number of elements.
destinationNamespace : String
The value here should match the value from the output from `oc project` if you created the resources related to this task from the command line. If nothing is specified, the plugin will inspect the PROJECT_NAME environment variable.
destinationAuthToken : String
The value here is what you supply with the --token option when invoking the OpenShift `oc` command. If you do not supply a value, the plugin will assume it is running in the OpenShift Jenkins image and attempt to load the kubernetes service account token stored in that image.
alias : String
This flag is the equivalent of the `--alias` option for the `oc tag` command. When false, the destination tag type is "ImageStreamImage", and when true, the destination tag type is "ImageStreamTag".

$class: 'OpenShiftScaler'

apiURL : String
depCfg : String
If you run `oc get dc` for the project listed in "nameSpace", that is the value you want to put here.
namespace : String
replicaCount : String
The value here should be the number of started pods desired for the deployment specified. It is the equivalent of the value supplied to --replicas with an `oc scale` command invocation. This is a required parameter. If an integer is not specified here, this build step can not be added to the job. Note: specifying a 0 is allowed, and means you do not want any pods for the specified deployment config running.
authToken : String
verbose : String
verifyReplicaCount : String
This flag is the toggle for turning on or off the verification that the specified replica count for the deployment has been reached.
waitTime : String
waitUnit : String

$class: 'OpenShiftServiceVerifier'

apiURL : String
svcName : String
The equivalent to the name supplied to a `oc get service` command line invocation.
namespace : String
authToken : String
verbose : String

$class: 'OrchestratorBuilder'

serverUrl : String
vRealize Orchestrator Server URL
userName : String
User name
password : String
Password
tenant : String
Tenant to which the user belongs to
workflowName : String
Orchestrator workflow name
waitExec : boolean
Execute and Wait for the workflow to be complete
inputParams
Input parameters for the workflow. Select the parameter from the drop down for which you wish to provide input.
- name : String
- type : String
- value : String

cfyOutputsToInputs

This step maps outputs and capabilities, of an environment created by Cloudify, into inputs of another deployment.

This step takes two inputs:

A JSON file in the format generated by the "Build Cloudify Environment" ("outputs file"). For more information, refer to the tooltip of the "Outputs File" parameter.
A JSON file (or string) containing the mapping.

The format of the mapping JSON is as follows:

{
    "outputs": {
    	"<output_name>": "<input_name>",
    	"<output_name>": "<input_name>",
    	...
    },
    "capabilities": {
    	"<capability_name>": "<input_name>",
    	"<capability_name>": "<input_name>",
    	...
    }
}

At the end, a file will be generated, containing a JSON compatible with Cloudify's standard "Deployment Inputs" structure, namely:

{
	"<input_name>": "<intput_value>",
	"<input_name>": "<intput_value>",
	...

For example, if the "outputs file" is as follows:

{
	"outputs": {
		"endpoint": "10.0.0.130",
		"username": "centos"
	},
	"capabilities": {
		"public_key": "/tmp/public_key"
	}
}

And the mapping is as follows:

{
	"outputs": {
		"username": "app_username"
	},
	"capabilities": {
		"public_key": "app_data"
	}
}

Then the resultant inputs file will be as follows:

{
	"app_username": "centos",
	"app_data": "/tmp/public_key"
}

credentialsId : String (optional)
inputsLocation : String (optional)

Path to the inputs file to be created.
mapping : String (optional)

A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
mappingLocation : String (optional)

A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.

outputsLocation : String (optional)

Location of the outputs JSON file, containing outputs and capabilities of another deployment. The file must be in the following format:

{
    "outputs": {
    	"<output_name>": "<output_value>",
    	"<output_name>": "<output_value>",
    	...
    },
    "capabilities": {
    	"<capability_name>": "<capability_value>",
    	"<capability_name>": "<capability_value>",
    	...
    }
}

tenant : String (optional)

Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

oversecuredUpload

integrationId : String
branchName : String
appPath : String

dotnetPack

The dotnet pack command builds the project and creates NuGet packages. The result of this command is a NuGet package (that is, a .nupkg file).

(see also: Microsoft Documentation)

charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
configuration : String (optional)
Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
force : boolean (optional)
Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
includeSource : boolean (optional)
Includes the debug symbols NuGet packages in addition to the regular NuGet packages in the output directory. The sources files are included in the src folder within the symbols package.
includeSymbols : boolean (optional)
Includes the debug symbols NuGet packages in addition to the regular NuGet packages in the output directory.
noBuild : boolean (optional)
Doesn't build the project before packing, and does not perform an implicit restore.
noDependencies : boolean (optional)
Ignores project-to-project references and only restores the root project.
noRestore : boolean (optional)
Doesn't execute an implicit restore when running the command.
nologo : boolean (optional)
Doesn't display the startup banner or the copyright message.

Available since: .NET Core SDK 3.0
option : String (optional)
options : Array / List of String (optional)
optionsString : String (optional)
For more information about these options, see the MSBuild Command-Line Reference.

If targets and/or properties are also configured, those will be passed after these options.
outputDirectory : String (optional)
Places the built packages in the directory specified.
project : String (optional)
The project or solution to pack. It's either a path to a csproj file, vbproj file, fsproj file, a solution file, or to a directory. If not specified, the command searches the current directory for a project or solution file.
properties (optional)
- Type: java.util.Map<java.lang.String, java.lang.String>
propertiesString : String (optional)
Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
runtime : String (optional)
Specifies the target runtime to restore packages for. For a list of Runtime Identifiers (RIDs), see the RID catalog.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean (optional)
If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.

Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).

Available since: .NET Core SDK 2.1
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
unstableIfErrors : boolean (optional)
If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
unstableIfWarnings : boolean (optional)
If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
verbosity : String (optional)
Sets the MSBuild verbosity level.
versionSuffix : String (optional)
Defines the value for the $(VersionSuffix) MSBuild property in the project.
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

uTesterPageCountTask

initialUrl : String
The initial URL to check.
urlsWhiteList : String
A list of URLs (one per line) to whitelist.
pageCount : int
The Page Count.
rulesList
A list of JSON rules to evaluate.
- rule : String
complianceMinimum : float
The minimum compliance level needed to pass (if multiple data results exist this will check each).
allowSimultaneousLogins : boolean
loginFlowJson : String
useRunner : boolean
fetchResponseTimeout : int
The number of seconds to wait for a response from the User1st API before failing (default of 120).

$class: 'ParallelTestExecutor'

Given another job that runs tests, executes multiple runs of it concurrently by interleaving tests, achieving the parallel test execution semantics.

This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.

Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.

You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.

Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.

At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.

parallelism
- count
  Always divide the tests into N parallel sub-tasks of about equal size. This mode is useful if your build slaves are not elastic to control the resource consumption by this task.
  - size : int
- time
  Divide the tests into parallel sub-tasks each no bigger than N minutes. Combined with elastic slaves, such as EC2, the turn-around time of the tests will remain the same no matter how many tests you add.
  This value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
  
  "N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
  - mins : int
testJob : String
Specify the name of the test job that executes the actual tests.
patternFile : String
A text file that lists one Java source file name per line gets created by this path inside the workspace of the test job. The path is relative to the workspace of the test job. Your test job must honor this exclusion list while executing tests. See the help of this builder for more details.
testReportFiles : String
The GLOB syntax that specifies test reports and its associated files that need to be copied back into this build to tally the test reports. This includes the JUnit-compatible XML files, as well as files that capture stdout/stderr of those tests (if they are placed separately.)
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
archiveTestResults : boolean
If you uncheck this you need to configure your own JUnit archiver in the Publisher section. The test reports are copied to "test-splits/reports/".
parameters
You can specify additional parameters given to the test job.
- $class: 'BooleanParameters'
  - configs
    This passes Boolean parameters to the downstream jobs
    - name : String
    - value : boolean
- $class: 'CurrentBuildParameters'
- $class: 'FileBuildParameters'
  - propertiesFile : String
    Comma separated list of absolute or relative paths to file(s) that contains the parameters for the new project. Relative paths are originated from the workspace. The file should have KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
    Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
  - encoding : String
    Specify the encoding of contents of the files. If not specified, default encoding of the platform is used.
  - failTriggerOnMissing : boolean
    When enabled blocks the triggering of the downstream jobs if any of the files are not found in the workspace.
  - useMatrixChild : boolean
    Use files in workspaces of child builds (that is, builds for each axes combination). This works only when used in publishers of multi-configuration projects. Ignored when used in builders.
  - combinationFilter : String
    Write groovy expression to filter child builds whose files to use. If not specified, uses all children. See Combination Filter of Configuration Matrix for details of groovy expression.
  - onlyExactRuns : boolean
    Use child builds that is triggered exactly by the parent build. This affects the behavior when you triggered only some of combinations using plugins, you removed some values from axes, and so on.
  - textParamValueOnNewLine : boolean
    When enabled properties containing newline character(s) are propagated as TextParameterValue which is a specialized StringParameterValue commonly used for handling multi-line strings in Jenkins. When disabled (default) all properties are propagated as StringParameterValue.
    TextParameterValue and StringParameterValue are typically rendered differently by Jenkins and plugins such as the Rebuild plugin.
- $class: 'GeneratorCurrentParameters'
- $class: 'GitRevisionBuildParameters'
  This "parameter" passes the SHA1 commit ID that was built by this project into the specified job, and thereby causes the specified job to check out the exact same commit. This is useful to chain multiple activities in a sequence that acts on the same commit in different ways.
  - combineQueuedCommits : boolean
    This checkbox cause the all revisions to be be ignored apart from the last one if a build is already in the queue.
    Does not combine entries with builds of manually started downstream job that are queued. (Ones that do no have a git hash attached to them)
    Warning: There is no consideration for multiple branches, or any other behaviour, it is your responsibility to make sure that the hashes provided come from the same branch.
- $class: 'MatrixSubsetBuildParameters'
  - filter : String
    Specifies the Groovy filter expression that restricts the subset of the combinations that the downstream project will run.
    See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
    
    What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
    
    Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
- $class: 'NodeLabelBuildParameter'
  - name : String
    This parameter type defines where the target job should be executed, the value must match either a label or a node name - otherwise the job will just stay in the queue. The NodeLabel parameter passed to the target job, does not have to exist on the target job (but if the target has one defined, it should match the name). This way it is possible to trigger jobs on different nodes then they are actually configured.
  - nodeLabel : String
    The node can be static or a token to be expanded by the token macro plugin.
- $class: 'NodeParameters'
- $class: 'PredefinedBuildParameters'
  - properties : String
    KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
    Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
  - textParamValueOnNewLine : boolean
    When enabled properties containing newline character(s) are propagated as TextParameterValue which is a specialized StringParameterValue commonly used for handling multi-line strings in Jenkins. When disabled (default) all properties are propagated as StringParameterValue.
    TextParameterValue and StringParameterValue are typically rendered differently by Jenkins and plugins such as the Rebuild plugin.
- $class: 'PredefinedGeneratorParameters'
  - properties : String
    KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
    Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
- $class: 'SubversionRevisionBuildParameters'
  This parameter passes the Subversion revisions that were used in this build to the downstream builds.
  - includeUpstreamParameters : boolean
    This option passes through the subversion parameters that were passed into this build from upstream builds, so that they can be used on downstream projects.
estimateTestsFromFiles : boolean
The first run (or a run without any reference to test result from previous runs) will estimate tests according the content of workspace and maven java project patterns for tests. The Tests will be splitted according to this estimation.
includesPatternFile : String (optional)
A text file that lists one Java source file name per line gets created by this path inside the workspace of the test job. The path is relative to the workspace of the test job. Your test job must honor this inclusion list while executing tests. See the help of this builder for more details.

$class: 'ParameterPoolBuilder'

projects : String
Multiple projects can be specified to check for values. The parameter name should be the same in each project.
If this is left blank, the current project that this build step is in is used. Variables can be used to specify the project names.
name : String
Name for the parameter. This name will be exposed as an environmental variable. This allows subsequent build steps to use the value.
values : String
Values for the parameter pool. Separate values by comma.
For ranges of values use [start..end]
E.g. for say vm1, vm2, vm3, vm4 do vm[1..4]
This can be combined with regular parameters.
testVm, vm[1..4]
will result in a pool of values of testVm, vm1, vm2, vm3, vm4
Descending order e.g. vm[4..1] is supported as well. The order of the values is also taken into account when selecting from two valid values
preferError : boolean
Check if you want the job to prefer parameter values from failed builds.
This can be useful for circumstances where there is a long running build that would refresh an environment.
Failed builds are termed any build that was not successful or unstable.
This plugin takes the view that unstable builds still were for the most part functional.

$class: 'PartialReleaseMgrSuccessfulBuilder'

pcBuild

serverAndPort : String
pcServerName : String
Hostname or IP address The LoadRunner Enterprise Hostname or IP address. If the port of the LRE server is different than the default one, mention it by adding a collon (:) and then the port number
Example: mypcserver.mycompany.net or 182.138.255.1 or mypcserver.mycompany.net:81

If the LRE server requires to be accessed via a tenant, you can specify it by adding the tenant details to the LRE Server field.
Example: mypcserver.mycompany.net/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3 or 182.138.255.1/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3 or mypcserver.mycompany.net:81/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3

Important: Do not use the full URL of LoadRunner Enterprise server.
For example, using https://mypcserver/LoadTest will fail. Instead, just specify 'mypcserver' value in 'LRE Server' field and switch on the 'Use HTTPS Protocol' if secured protocol is required.
credentialsId : String
LoadRunner Enterprise User / Token's Credentials or parameter pointing to such credentials.
almDomain : String
almProject : String
testId : String
testInstanceId : String
Represents an instance of a performance test within an ALM Test Set. In order to find the test instance id go to: LRE Web UI > Testing > Select the relevant test > Test Details tab > Assigned Test Set drop down list > Edit the Test Set and look for the Test Instance ID column
autoTestInstanceID : String
timeslotDurationHours : String
timeslotDurationMinutes : String
postRunAction
- Values: COLLATE, COLLATE_AND_ANALYZE, DO_NOTHING
vudsMode : boolean
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 LoadRunner Enterprise environment.
statusBySLA : boolean
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.
description : String
addRunToTrendReport : String
trendReportId : String
HTTPSProtocol : boolean
proxyOutURL : String
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.
credentialsProxyId : String
retry : String
retryDelay : String
retryOccurrences : String
authenticateWithToken : boolean

From LRE 2021 R1, you can use a token associated with your user for authentication.

If LRE is defined to use SSO, this will be the only way for this plugin to authenticate to LRE.

To use it, have a token issued to your user in LRE.

In Jenkins, create new Jenkins credentials based on the LRE token you received: use the ClientIdKey in the Username and the ClientSecretKey key in the password.

Then use the new Jenkins credentials with this checkbox switched on.

pcGitBuild

The plugin allows to synchronize scripts from Git repository to Micro Focus LoadRunner Enterprise project.
The plugin respects the subfolders structure defined in Git when synchronizing LoadRunner scripts to Performance Center 12.60 and above. For previous versions, all scripts will be uploaded to the same root folder in the Test Plan tree of the LoadRunner Enterprise project (scripts with duplicated named will be overwritten).

description : String
pcServerName : String
Hostname or IP address The LoadRunner Enterprise Hostname or IP address. If the port of the LRE server is different than the default one, mention it by adding a collon (:) and then the port number
Example: mypcserver.mycompany.net or 182.138.255.1 or mypcserver.mycompany.net:81

If the LRE server requires to be accessed via a tenant, you can specify it by adding the tenant details to the LRE Server field.
Example: mypcserver.mycompany.net/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3 or 182.138.255.1/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3 or mypcserver.mycompany.net:81/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3

Important: Do not use the full URL of LoadRunner Enterprise server.
For example, using https://mypcserver/LoadTest will fail. Instead, just specify 'mypcserver' value in 'LRE Server' field and switch on the 'Use HTTPS Protocol' if secured protocol is required.
httpsProtocol : boolean
credentialsId : String
LoadRunner Enterprise User / Token's Credentials or parameter pointing to such credentials.
almDomain : String
almProject : String
serverAndPort : String
proxyOutURL : String
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.
credentialsProxyId : String
subjectTestPlan : String
The Test Plan folder path in LoadRunner Enterprise where the scripts will be loaded.
Available paths can be found in the LoadRunner Enterprise interface: Test Management -> Test Plan
The path must begin with "Subject" and be separated with backslashes (\).
The path is case-sensitive!
Important: For Performance Center Server below version 12.60:
- the specified folder must exist at the time of the build (the plugin can not create folders independently).
- Scripts saved in Git subfolders will be synchronized to the specified subject and in case of duplicated script names in Git, the last uploaded script to LRE will overwrite the previously uploaded script(s) with the same name.
uploadScriptMode
This corresponds to the similar option existing in LoadRunner Enterprise / VuGen:
- All Files: All script files are uploaded (this takes longer to load).
- Runtime Files: Only the required files are uploaded (script files, Runtime Settings, parameter files, etc.)
Recommended value: "Runtime Files".
- Values: RUNTIME_FILES, ALL_FILES
removeScriptFromPC
This option will allow you to synchronize scripts deletion from Git to LoadRunner Enterprise.

The recommended value is " Yes".
- Values: YES, NO

importTests

How to import tests from YAML files saved in the Git repository

Copy your YAML files to a folder in your Git repository (YAML files under the root of the Git repository will be ignored). The plugin will create the test in the LoadRunner Enterprise project according to:

The file name (without extension) which will be used as test name.
The location of the file in the Git repository which will be the location of the test under the root folder ('Subject') in the Test Management tree.
The content of the YAML file which must be composed according to the parameters described in the tables below.

Note:

All parameters must be in lowercase.
When a backslash (\) occurs in a value provided to a parameter (for example, a folder separator in a file path), a double backslash (\\) must be used instead.
This feature is supported with Performance Center 12.61 and later versions.

Root parameters of the YAML file:

Parameter	Description	Required
controller	Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project. From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).	No
lg_amount	Number of load generators to allocate to the test (every group in the test will be run by the same load generators).	Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below).
group	Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below.	Yes
scheduler	Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below.	No
lg_elastic_configuration	Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1.	Yes, if a load generator is defined to be provisioned from a Docker image.
controller_elastic_configuration	Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1.	Yes, if the Controller is defined to be provisioned from a Docker image.

group:

Parameter	Description	Required
group_name	Name of the group (it must be a unique name if several groups are defined).	Yes
vusers	Number of virtual users to allocate to the group for running the script.	Yes
script_id	ID of the script in the LoadRunner Enterprise project.	Not required if the 'script_path' parameter is specified.
script_path	Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject").	Not required if 'script_id' parameter is specified
lg_name	List of load generators to allocate to the group for running the script. The supported values are: The hostname, as defined in LoadRunner Enterprise, of an existing load generator in LoadRunner Enterprise allocated as a host. "LG" followed by a number, to use an automatically matched load generator (recommended). "DOCKER" followed by a number, to use a dynamic load generator (available from Performance Center 12.62, if your project is set to work with Docker). This option requires the 'lg_elastic_configuration' parameter to be defined (see the 'lg_elastic_configuration' table below).	No
command_line	The command line applied to the group.	No
rts	Object defining the runtime settings of the script. See the 'rts' table below.	No

rts:

Parameter	Description	Required
pacing	Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below).	No
thinktime	Can be used to define think time (see the 'thinktime' table below).	No
java_vm	Can be used when defining Java environment runtime settings (see the 'java_vm' table below).	No
jmeter	Can be used to define JMeter environment runtime settings (see the 'jmeter' table below).	No

pacing:

Parameter	Description	Required
number_of_iterations	Specifies the number of iterations to run; this must be a positive number.	Yes
type	Possible values for type attribute are: "immediately": ignores 'delay' and 'delay_random_range' parameters. This is the default value when no type is specified. "fixed delay": 'delay' parameter is mandatory. "random delay": 'delay' and 'delay_random_range' parameters are mandatory. "fixed interval": 'delay' parameter is mandatory. "random interval": 'delay' and 'delay_random_range' parameters are mandatory.	No
delay	Non-negative number (less than 'delay_at_range_to_seconds' when specified).	Depends on the value provided for the 'type' parameter.
delay_random_range	Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter).	Depends on the value provided for the 'type' parameter.

thinktime:

Parameter	Description	Required
type	The ThinkTime Type attribute is one of: "ignore": This is the default value when no type is specified. "replay": Provide 'limit_seconds' parameter with value. "modify": Provide 'limit_seconds' and 'multiply_factor' parameters with values. "random": Provide 'limit_seconds', 'min_percentage' and 'max_percentage' parameters with values.	No
min_percentage	This must be a positive number.	Depends on the value provided for the 'type' parameter.
max_percentage	This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter).	Depends on the value provided for the 'type' parameter.
limit_seconds	This must be a positive number.	Depends on the value provided for the 'type' parameter.
multiply_factor	The recorded think time is multiplied by this factor at runtime.	Depends on the value provided for the 'type' parameter.

java_vm:

Parameter	Description	Required
jdk_home	The JDK installation path.	No
java_vm_parameters	List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag.	No
use_xboot	Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string).	No
enable_classloader_per_vuser	Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads).	No
java_env_class_paths	A list of classpath entries. Use a double backslash (\\) for folder separators.	No

jmeter:

Parameter	Description	Required
start_measurements	Boolean value to enable JMX measurements during performance test execution.	No
jmeter_home_path	Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used.	No
jmeter_min_port	This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used.	No
jmeter_max_port	This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used.	No
jmeter_additional_properties	JMeter additional properties file. Use double slash (\\) for folder separator.	No

scheduler:

Parameter	Description	Required
rampup	Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test.	No
duration	Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion.	No

lg_elastic_configuration: (available from Performance Center 12.62 and plugin version 1.1.1)

Parameter	Description	Required
image_id	This number can be retrieved from: The Administration page of LoadRunner Enterprise (you might need to turn to your LoadRunner Enterprise administrator as accessing this page requires admin privileges): select the Orchestration section -> switch to Docker Images tab -> you will have the list of all available Docker images for Load Generator purposes with their ID. You can make sure the images are available to your project from the Orchestrators tab. A LoadRunner Enterprise Rest API command applied on the project (replace the bracketed values): GET - http(s)://(PCServer):(PortNumber)/LoadTest/rest/domains/(DomainName)/projects/(ProjectName)/dockerimages/ and select any valid image not having the value 'controller' for purpose.	Yes if one of the load generator is defined to be provisioned from Docker image.
memory_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits
cpu_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits

controller_elastic_configuration: (available from Performance Center 12.62 and plugin version 1.1.1)

Parameter	Description	Required
image_id	This number can be retrieved from: The Administration page of LoadRunner Enterprise (you might need to turn to your LoadRunner Enterprise administrator as accessing this page requires admin privileges): select the Orchestration section -> switch to Docker Images tab -> you will have the list of all available Docker images for Controller purposes with their ID. You can make sure the images are available to your project from the Orchestrators tab. A LoadRunner Enterprise Rest API command applied on the project (replace the bracketed values): GET - http(s)://(PCServer):(PortNumber)/LoadTest/rest/domains/(DomainName)/projects/(ProjectName)/dockerimages/ and select any valid image having the value 'controller' for purpose.	Yes if the Controller is defined to be provisioned from Docker image.
memory_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits
cpu_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits

In the example below:

The plugin automatically assigns the file name as the test name, and the folder path of the file in the Git repository is used to create the location of the test under the root folder ('Subject') in the LoadRunner Enterprise project.
In the content:
- Since no Controller and no load generator amount were specified, a random available Controller will be allocated to the test just before it is run and the 'lg_name' parameter specified in each group will be used.
- In the 'group' parameter:
  - We added two scripts. For each, we provided a unique value in the 'group_name' parameter, and the number of virtual users to run the group.
  - Since we did not know the ID of the scripts, we used the 'script_path' parameter in which we entered the script path (without "Subject") followed by the script name, and used double backslashes for separators.
  - We specified the load generators that will be used by each group (in this case, load generators will automatically be matched as we use the 'LG' prefix).
In the scheduler:
- We want all Virtual Users to be initialized gradually (45 seconds).
- We want the test to stop after 5 minutes (300 seconds).


##################################################
group:
- group_name: "TEstInt"
  vusers: '20'
  script_path: "plugin\\TEstInt"
  lg_name:
  - "LG1"
  - "LG2"
- group_name: "Mtours"
  vusers: '20'
  script_path: "plugin\\mtours"
  lg_name:
  - "LG3"
  - "LG4"
scheduler:
  rampup: '45'
  Duration: '300'
##################################################

In the example below:

The plugin automatically assigns the file name as the test name, and the folder path of the file in the Git repository is used to create the location of the test under the root folder ('Subject') in the LoadRunner Enterprise project.
Since the 'controller' and the 'lg_amount' parameters are specified, the specified Controller will be used to run the test and three automatch load generators will be used and shared by all groups.
The content of the file is defined with seven groups, all being set with the “rts” parameter:
- The “pacing” parameter is used with different options for all groups.
- The “java_vm” parameter is used for five scripts with JavaVM for protocol.
- The “thinktime” parameter is used with different options for four groups.
- The “jmeter” parameter is used for two scripts with JMeter for protocol.
In the scheduler:
- We want all Virtual Users to be initialized gradually (120 seconds).
- We want the test to stop after 10 minutes (600 seconds).


##################################################
controller: "mycontroller"
lg_amount: 3
group:
  - group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
    vusers: 50
    script_id: 394
    rts:
      pacing:
        number_of_iterations: 2
        type: "immediately"
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        use_xboot: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"
      thinktime:
        type: "ignore"

  - group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
    vusers: 50
    script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
    rts:
      pacing:
        number_of_iterations: 2
        type: "fixed delay"
        delay: 10
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
      thinktime:
        type: "replay"
        limit_seconds: 30

  - group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
    vusers: 50
    script_id: 394
    rts:
      pacing:
        number_of_iterations: 2
        type: "random delay"
        delay: 10
        delay_random_range: 20
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"
      thinktime:
        type: "modify"
        limit_seconds: 30
        multiply_factor: 2

  - group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
    vusers: 50
    #script_id: 392
    script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
    rts:
      pacing:
        number_of_iterations: 2
        type: "fixed interval"
        delay: 10
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"
      thinktime:
        type: "random"
        limit_seconds: 30
        min_percentage: 2
        max_percentage: 3

  - group_name: "JavaHTTP_BigXML_pacing_random_interval"
    vusers: 50
    script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
    rts:
      pacing:
        number_of_iterations: 2
        type: "random interval"
        delay: 10
        delay_random_range: 20
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"

  - group_name: "Mtours_pacing_random_interval"
    vusers: 50
    script_path: "scripts\\Mtours"
    rts:
      pacing:
        number_of_iterations: 2
        type: "random interval"
        delay: 10
        delay_random_range: 20
      jmeter:
        start_measurements: true
        jmeter_home_path: "c:\\jmeter"
        jmeter_min_port: 2001
        jmeter_max_port: 3001
        jmeter_additional_properties: "jmeter_additional_properties"
  - group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
    vusers: 50
    script_path: "scripts\\Mtours"
    rts:
      pacing:
        number_of_iterations: 2
        type: "random interval"
        delay: 10
        delay_random_range: 20
      jmeter:
        start_measurements: true

scheduler:
  rampup: 120
  duration: 600
##################################################

Values: YES, NO

authenticateWithToken : boolean

From LRE 2021 R1, you can use a token associated with your user for authentication.

If LRE is defined to use SSO, this will be the only way for this plugin to authenticate to LRE.

To use it, have a token issued to your user in LRE.

In Jenkins, create new Jenkins credentials based on the LRE token you received: use the ClientIdKey in the Username and the ClientSecretKey key in the password.

Then use the new Jenkins credentials with this checkbox switched on.

pcRunBuild

serverAndPort : String
pcServerName : String
Hostname or IP address The LoadRunner Enterprise Hostname or IP address. If the port of the LRE server is different than the default one, mention it by adding a collon (:) and then the port number
Example: mypcserver.mycompany.net or 182.138.255.1 or mypcserver.mycompany.net:81

If the LRE server requires to be accessed via a tenant, you can specify it by adding the tenant details to the LRE Server field.
Example: mypcserver.mycompany.net/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3 or 182.138.255.1/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3 or mypcserver.mycompany.net:81/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3

Important: Do not use the full URL of LoadRunner Enterprise server.
For example, using https://mypcserver/LoadTest will fail. Instead, just specify 'mypcserver' value in 'LRE Server' field and switch on the 'Use HTTPS Protocol' if secured protocol is required.
credentialsId : String
LoadRunner Enterprise User / Token's Credentials or parameter pointing to such credentials.
almDomain : String
almProject : String
testToRun : String
testId : String

testContentToCreate : String

How to create a test from YAML input

The content of the field must either be:

Text in YAML syntax composed according to the parameters described in the tables below. You must set values to the 'test_name' and 'test_folder_path' parameters and continue with the'test_content' parameter and its sub-parameters.
As opposed to the previous option, you can also specify as value a relative path to a YAML file within the workspace (or within your Git repository cloned within the workspace). In the YAML file, only specify the parameters defined in the 'test_content' table. The following logic will be used to create the LoadRunner Enterprise test:
- The file name (without extension) will be used as the test name.
- The location of the file in the Git repository will be the location of the test under the root folder ('Subject') in the Test Management tree.
- The content of the YAML file must consist of the parameters, and their sub-parameters, listed in the 'test_content' table below.

Note:

All parameters must be in lowercase.
When a backslash (\) occurs in a value provided to a parameter (for example, a folder separator in a file path), a double backslash (\\) must be used instead.
This feature is supported with Performance Center 12.61 and later versions.

Root parameters of the field

Parameter	Description	Required
test_name	The test name.	Yes
test_folder_path	The location of the test in the Test Management folder tree of the LoadRunner Enterprise project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the LoadRunner Enterprise root folder (named "Subject")	Yes
test_content	The content of the test that requires additional parameters specified in the 'test_content' table below.	Yes

test_content (if a YAML file is specified in the field, those are the root parameter to be used in the file content):

Parameter	Description	Required
controller	Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project. From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).	No
lg_amount	Number of load generators to allocate to the test (every group in the test will be run by the same load generators).	Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below).
group	Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below.	Yes
scheduler	Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below.	No
lg_elastic_configuration	Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1.	Yes, if a load generator is defined to be provisioned from a Docker image.
controller_elastic_configuration	Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1.	Yes, if the Controller is defined to be provisioned from a Docker image.

group:

Parameter	Description	Required
group_name	Name of the group (it must be a unique name if several groups are defined).	Yes
vusers	Number of virtual users to allocate to the group for running the script.	Yes
script_id	ID of the script in the LoadRunner Enterprise project.	Not required if the 'script_path' parameter is specified.
script_path	Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject").	Not required if 'script_id' parameter is specified
lg_name	List of load generators to allocate to the group for running the script. The supported values are: The hostname, as defined in LoadRunner Enterprise, of an existing load generator in LoadRunner Enterprise allocated as a host. "LG" followed by a number, to use an automatically matched load generator (recommended). "DOCKER" followed by a number, to use a dynamic load generator. Available from Performance Center 12.62, if your project is set to work with Docker. This option requires the 'lg_elastic_configuration' parameter to be defined (see the 'lg_elastic_configuration' table below).	No
command_line	The command line applied to the group.	No
rts	Object defining the runtime settings of the script. See the 'rts' table below.	No

rts:

Parameter	Description	Required
pacing	Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below).	No
thinktime	Can be used to define think time (see the 'thinktime' table below).	No
java_vm	Can be used when defining Java environment runtime settings (see the 'java_vm' table below).	No
jmeter	Can be used to define JMeter environment runtime settings (see the 'jmeter' table below).	No

pacing:

Parameter	Description	Required
number_of_iterations	Specifies the number of iterations to run; this must be a positive number.	Yes
type	Possible values for type attribute are: "immediately": ignores 'delay' and 'delay_random_range' parameters. This is the default value when no type is specified. "fixed delay": 'delay' parameter is mandatory. "random delay": 'delay' and 'delay_random_range' parameters are mandatory. "fixed interval": 'delay' parameter is mandatory. "random interval": 'delay' and 'delay_random_range' parameters are mandatory.	No
delay	Non-negative number (less than 'delay_at_range_to_seconds' when specified).	Depends on the value provided for the 'type' parameter.
delay_random_range	Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter).	Depends on the value provided for the 'type' parameter.

thinktime:

Parameter	Description	Required
type	The ThinkTime Type attribute is one of: "ignore": This is the default value when no type is specified. "replay": Provide 'limit_seconds' parameter with value. "modify": Provide 'limit_seconds' and 'multiply_factor' parameters with values. "random": Provide 'limit_seconds', 'min_percentage' and 'max_percentage' parameters with values.	No
min_percentage	This must be a positive number.	Depends on the value provided for the 'type' parameter.
max_percentage	This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter).	Depends on the value provided for the 'type' parameter.
limit_seconds	This must be a positive number.	Depends on the value provided for the 'type' parameter.
multiply_factor	The recorded think time is multiplied by this factor at runtime.	Depends on the value provided for the 'type' parameter.

java_vm:

Parameter	Description	Required
jdk_home	The JDK installation path.	No
java_vm_parameters	List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag.	No
use_xboot	Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string).	No
enable_classloader_per_vuser	Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads).	No
java_env_class_paths	A list of classpath entries. Use a double backslash (\\) for folder separators.	No

jmeter:

Parameter	Description	Required
start_measurements	Boolean value to enable JMX measurements during performance test execution.	No
jmeter_home_path	Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used.	No
jmeter_min_port	This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used.	No
jmeter_max_port	This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used.	No
jmeter_additional_properties	JMeter additional properties file. Use double slash (\\) for folder separator.	No

scheduler:

Parameter	Description	Required
rampup	Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test.	No
duration	Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion.	No

lg_elastic_configuration: (available from Performance Center 12.62 and plugin version 1.1.1)

Parameter	Description	Required
image_id	This number can be retrieved from: The Administration page of LoadRunner Enterprise (you might need to turn to your LoadRunner Enterprise administrator as accessing this page requires admin privileges): select the Orchestration section -> switch to Docker Images tab -> you will have the list of all available Docker images for Load Generator purposes with their ID. You can make sure the images are available to your project from the Orchestrators tab. A LoadRunner Enterprise Rest API command applied on the project (replace the bracketed values): GET - http(s)://(PCServer):(PortNumber)/LoadTest/rest/domains/(DomainName)/projects/(ProjectName)/dockerimages/ and select any valid image not having the value 'controller' for purpose.	Yes if one of the load generator is defined to be provisioned from Docker image.
memory_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits
cpu_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits

controller_elastic_configuration: (available from Performance Center 12.62 and plugin version 1.1.1)

Parameter	Description	Required
image_id	This number can be retrieved from: The Administration page of LoadRunner Enterprise (you might need to turn to your LoadRunner Enterprise administrator as accessing this page requires admin privileges): select the Orchestration section -> switch to Docker Images tab -> you will have the list of all available Docker images for Controller purposes with their ID. You can make sure the images are available to your project from the Orchestrators tab. A LoadRunner Enterprise Rest API command applied on the project (replace the bracketed values): GET - http(s)://(PCServer):(PortNumber)/LoadTest/rest/domains/(DomainName)/projects/(ProjectName)/dockerimages/ and select any valid image having the value 'controller' for purpose.	Yes if the Controller is defined to be provisioned from Docker image.
memory_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits
cpu_limit	This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored).	Yes, if the image is defined with resource limits

In the next example, the value of the field is set with the code below:

The test name is "mytestname" and it will be placed in the LoadRunner Enterprise project under the folder path "Subject\\Tests\\mytests" (the root folder of the folders, which is "Subject", should not be specified in the parameter). The folder separator is a double backslash (\\).
In the content:
- Since no Controller or load generator amount were specified, a random available Controller will be used to run the test, and the 'lg_name' parameter specified in each group will be used.
- In the 'group' parameter:
  - We added two scripts. For each, we provided a unique value in the 'group_name' parameter, and the number of virtual users to run the group.
  - Since we did not know the ID of the scripts, we used the 'script_path' parameter in which we entered the script path (without "Subject") followed by the script name, and used double backslashes for separators.
  - We specified the load generators that will be used by each group (in this case, load generators will automatically be matched as we use the 'LG' prefix).
In the scheduler:
- We want all Virtual Users to be initialized gradually (45 seconds).
- We want the test to stop after 5 minutes (300 seconds).


##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
  group:
    - group_name: "TEstInt"
      vusers: '20'
      script_path: "plugin\\TEstInt"
      lg_name:
        - "LG1"
        - "LG2"
    - group_name: "Mtours"
      vusers: '20'
      script_path: "plugin\\mtours"
      lg_name:
        - "LG3"
        - "LG4"
  scheduler:
    rampup: '45'
    duration: '300'
##################################################

In the next example, a YAML file location is specified as value and the content of the file contains the code below:

The plugin automatically assigns the file name as the test name, and the folder path of the file in the Git repository is used to create the location of the test under the root folder ('Subject') in the LoadRunner Enterprise project.
In the content:
- Since no Controller or load generator amount were specified, a random available Controller will be used to run the test, and the 'lg_name' parameter specified in each group will be used.
- In the 'group' parameter:
  - We added two scripts. For each, we provided a unique value in the 'group_name' parameter, and the number of virtual users to run the group.
  - Since we did not know the ID of the scripts, we used the 'script_path' parameter in which we entered the script path (without "Subject") followed by the script name, and used double backslashes for separators.
  - We specified the load generators that will be used by each group (in this case, load generators will automatically be matched as we use the 'LG' prefix).
In the scheduler:
- We want all Virtual Users to be initialized gradually (45 seconds).
- We want the test to stop after 5 minutes (300 seconds).


##################################################
group:
  - group_name: "TEstInt"
    vusers: '20'
    script_path: "plugin\\TEstInt"
    lg_name:
      - "LG1"
      - "LG2"
  - group_name: "Mtours"
    vusers: '20'
    script_path: "plugin\\mtours"
    lg_name:
      - "LG3"
      - "LG4"
scheduler:
  rampup: '45'
  duration: '300'
##################################################

In the next example, a YAML file location is specified as value and the content of the file contains the code below:

The plugin automatically assigns the file name as the test name, and the folder path of the file in the Git repository is used to create the location of the test under the root folder ('Subject') in the LoadRunner Enterprise project.
Since the 'controller' parameter and the 'lg_amount' parameter are specified, the specified controller will be used to run the test and three automatch load generators will be used and shared by all groups.
The content of the file is defined with seven groups, all being set with the “rts” parameter:
- The “pacing” parameter is used with different options for all groups.
- The “java_vm” parameter is used for five scripts with JavaVM for protocol.
- The “thinktime” parameter is used with different options for four groups.
- The “jmeter” parameter is used for two scripts with JMeter for protocol.
In the scheduler:
- We want all Virtual Users to be initialized gradually (120 seconds).
- We want the test to stop after 10 minutes (600 seconds).


##################################################
controller: "mycontroller"
lg_amount: 3
group:
  - group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
    vusers: 50
    script_id: 394
    rts:
      pacing:
        number_of_iterations: 2
        type: "immediately"
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        use_xboot: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"
      thinktime:
        type: "ignore"

  - group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
    vusers: 50
    script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
    rts:
      pacing:
        number_of_iterations: 2
        type: "fixed delay"
        delay: 10
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
      thinktime:
        type: "replay"
        limit_seconds: 30

  - group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
    vusers: 50
    script_id: 394
    rts:
      pacing:
        number_of_iterations: 2
        type: "random delay"
        delay: 10
        delay_random_range: 20
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"
      thinktime:
        type: "modify"
        limit_seconds: 30
        multiply_factor: 2

  - group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
    vusers: 50
    #script_id: 392
    script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
    rts:
      pacing:
        number_of_iterations: 2
        type: "fixed interval"
        delay: 10
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"
      thinktime:
        type: "random"
        limit_seconds: 30
        min_percentage: 2
        max_percentage: 3

  - group_name: "JavaHTTP_BigXML_pacing_random_interval"
    vusers: 50
    script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
    rts:
      pacing:
        number_of_iterations: 2
        type: "random interval"
        delay: 10
        delay_random_range: 20
      java_vm:
        jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
        java_vm_parameters: "java_vm_parameters"
        enable_classloader_per_vuser: true
        java_env_class_paths:
          - "java_env_class_path1"
          - "java_env_class_path2"

  - group_name: "Mtours_pacing_random_interval"
    vusers: 50
    script_path: "scripts\\Mtours"
    rts:
      pacing:
        number_of_iterations: 2
        type: "random interval"
        delay: 10
        delay_random_range: 20
      jmeter:
        start_measurements: true
        jmeter_home_path: "c:\\jmeter"
        jmeter_min_port: 2001
        jmeter_max_port: 3001
        jmeter_additional_properties: "jmeter_additional_properties"
  - group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
    vusers: 50
    script_path: "scripts\\Mtours"
    rts:
      pacing:
        number_of_iterations: 2
        type: "random interval"
        delay: 10
        delay_random_range: 20
      jmeter:
        start_measurements: true

scheduler:
  rampup: 120
  duration: 600
##################################################

testInstanceId : String
Represents an instance of a performance test within an ALM Test Set. In order to find the test instance id go to: LoadRunner Enterprise Application > Test Lab perspective > Performance Test Set table and look for the ID column
autoTestInstanceID : String
timeslotDurationHours : String
timeslotDurationMinutes : String
postRunAction
- Values: COLLATE, COLLATE_AND_ANALYZE, DO_NOTHING
vudsMode : boolean
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 LoadRunner Enterprise environment.
statusBySLA : boolean
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.
description : String
addRunToTrendReport : String
trendReportId : String
HTTPSProtocol : boolean
proxyOutURL : String
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.
credentialsProxyId : String
retry : String
retryDelay : String
retryOccurrences : String
authenticateWithToken : boolean

From LRE 2021 R1, you can use a token associated with your user for authentication.

If LRE is defined to use SSO, this will be the only way for this plugin to authenticate to LRE.

To use it, have a token issued to your user in LRE.

In Jenkins, create new Jenkins credentials based on the LRE token you received: use the ClientIdKey in the Username and the ClientSecretKey key in the password.

Then use the new Jenkins credentials with this checkbox switched on.

peassOverview

changeClassifications : String (optional)
projects (optional)
- project : String (optional)
timespan : String (optional)
unmeasuredClassifications : String (optional)

activateDTConfiguration

dynatraceProfile : String
configuration : String

createMemoryDump

dynatraceProfile : String
agent : String
host : String
autoPostProcess : boolean (optional)
capturePrimitives : boolean (optional)
captureStrings : boolean (optional)
dogc : boolean (optional)
lockSession : boolean (optional)
type : String (optional)

startSession

dynatraceProfile : String
testCase : String
lockSession : boolean (optional)
recordingOption : String (optional)

stopSession

dynatraceProfile : String

createThreadDump

dynatraceProfile : String
agent : String
host : String
lockSession : boolean (optional)

$class: 'PerformanceAnalysisBuilder'

testjob : String

Specify the data set name that contains the mainframe job that you want to run the performance benchmarking for, for example, TEST.POC.JCLLIB(TESTJOB).

The maximum length is 44 characters.

Ensure that the job is included in the monitoring scope of the MAT Performance Benchmarking plugin by Broadcom.

blazeMeterTest

credentialsId : String (optional)
Select the BlazeMeter credentials to use.
workspaceId : String (optional)
testId : String (optional)
BlazeMeter's plugin for Jenkins allows users to automate load tests from the cloud post build.
Just choose the test you want to run. Let Jenkins start and stop the test and document the results.
After the run, a test report will be generated directly into Jenkins and your BlazeMeter account.
If the test list is empty, you must insert your unique BlazeMeter API key into the Jenkins settings, or create a test in your BlazeMeter account.
abortJob : boolean (optional)
If checked and BlazeMeter test has fails plugin will throw AbortException
additionalTestFiles : String (optional)
Before the test runs these files will be pushed to the selected BlazeMeter test. Existing files with the same name will be replaced. Provide a list of files that are locate in job workspace(relative path, each file on a new line).

Limitations: Supported test types: Taurus, FunctionalApi, JMeter
getJtl : boolean (optional)
Check this box if you need to download JTL report after test will be over.
getJunit : boolean (optional)
Check this box if you need to download junit report after test will be over.
jobApiKey : String (optional)
jtlPath : String (optional)
Here you can define desired location for downloading jtl artifact.
Plugin supports both absolute and relative paths.
Jenkins environment variables will be resolved.
junitPath : String (optional)
Here you can define desired location for downloading junit artifact.
Plugin supports both absolute and relative paths.
Jenkins environment variables will be resolved.
mainTestFile : String (optional)
Before the test runs this file will be pushed to the selected BlazeMeter test and select as executable file. Existing file with the same name will be replaced. Provide a file that is locate in job workspace(relative path).

Limitations: For Taurus and FunctionalApi tests will set 'Test type': JMeter if file has '.jmx' extension and Taurus - for '.yml' and '.yaml' files. Other 'Test types', please, set in the BlazeMeter application. Supported test types: Taurus, FunctionalApi, JMeter
notes : String (optional)
Enter here some notes that you want to attached to test report.
reportLinkName : String (optional)
Report link name that you will see in your build. By default it'll set: "BlazeMeter report: BLAZEMETER_TEST_NAME", where BLAZEMETER_TEST_NAME is a test name from app. By default max report link name length = 35, but you can increase this value using Java System property or Jenkins environment variable "bzm.reportLinkName.length"
serverUrl : String (optional)
sessionProperties : String (optional)
Define jmeter properties for particular session in format key1=value1,key2=value2,key3=value3.
Properties will be pushed to every separate session of master session.

reportPerformanceTest

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
errorCount : long (optional)
sampleCount : long (optional)
testCount : long (optional)

bzt

Execute Taurus with configuration files and options. You can simply specify JMX file to run, or give list of Taurus config files and options to execute.

params : String
alwaysUseVirtualenv : boolean (optional)
bztVersion : String (optional)
generatePerformanceTrend : boolean (optional)
printDebugOutput : boolean (optional)
useBztExitCode : boolean (optional)
useSystemSitePackages : boolean (optional)
virtualEnvCommand : String (optional)
workingDirectory : String (optional)
workspace : String (optional)

$class: 'PhingBuilder'

name : String
buildFile : String

If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.

And you can use environment variables such like ''$WORKSPACE''.
targets : String
Specify a list of Phing targets to be invoked, or leave it empty to invoke the default Phing target specified in the build script.
properties : String
Properties needed by your phing build can be specified here (in the standard properties file format):
```
# comment
name1=value1
name2=value2
```
These are passed to Phing like "-Dname1=value1 -Dname2=value2"
useModuleRoot : boolean
options : String

$class: 'PipelineGenerationStep'

project : String

Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
projectScmType : String

Type of the SCM. Currently only svn and git are supported.
projectScmUrl : String
URL to the project SCM. Without any branch indication.

For example:
- For svn, URL to the root of the project, without trunk or branches.
- For git, URL of the remote.
projectScmCredentials : String

ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
branch : String

SCM branch.
seedProject : String

Project name useable for folders, job names, etc.
seedBranch : String

Branch name useable for folders, job names, etc.
disableDslScript : boolean

If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
scriptDirectory : String

Path to the directory which contains the pipeline script. Defaults to seed if not filled.

plot

group : String
style : String
csvFileName : String
csvSeries (optional)
- file : String
- url : String
- inclusionFlag : String
- exclusionValues : String
- displayTableFlag : boolean
description : String (optional)
exclZero : boolean (optional)
keepRecords : boolean (optional)
logarithmic : boolean (optional)
numBuilds : String (optional)
propertiesSeries (optional)
- file : String
- label : String
title : String (optional)
useDescr : boolean (optional)
xmlSeries (optional)
- file : String
- xpath : String
- nodeType : String
- url : String
yaxis : String (optional)
yaxisMaximum : String (optional)
yaxisMinimum : String (optional)

$class: 'PolarisBuildStep'

createChangeSetFile (optional)

Creates a file at $CHANGE_SET_FILE_PATH (by default, the workspace directory) containing a list of files generated from the Jenkins-provided scm changeset.
Used for Incremental analysis (--incremental) as the file containing the list of changed files for analysis.

Nested Object

buildStatusOnSkip (optional)

The action to take when static analysis is skipped because the changeset contained no files to analyze. Defaults to "Mark the build as Unstable".
- Values: SUCCESS, FAILURE, UNSTABLE

changeSetExclusionPatterns : String (optional)

Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will exclude none.
Examples:

File Name	Pattern	Will be excluded
test.java	*.java	Yes
test.java	*.jpg	No
test.java	test.*	Yes
test.java	test.????	Yes
test.java	test.?????	No

changeSetInclusionPatterns : String (optional)

Specify a comma separated list of filename patterns that you would like to explicitly included Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will include all. Examples:

File Name	Pattern	Will be included
test.java	*.java	Yes
test.java	*.jpg	No
test.java	test.*	Yes
test.java	test.????	Yes
test.java	test.?????	No

polarisArguments : String (optional)

The command line arguments to pass to the CLI
polarisCliName : String (optional)

The CLI installation to execute
waitForIssues (optional)

Check this box to wait for CLI jobs to complete and set the build status based on issues discovered
- buildStatusForIssues (optional)
  
  The build status to set the project to if there are issues
  - Values: SUCCESS, FAILURE, UNSTABLE
- jobTimeoutInMinutes : int (optional)
  
  The maximum number of minutes to wait for jobs started by the Polaris CLI to complete when the Polaris CLI is executed without -w (nonblocking mode). Must be a positive integer, defaults to 30 minutes.

fortiCWPScanner

imageName : String
Name of the image to scan
block : boolean (optional)

$class: 'PortScannerStep'

This plugin performs, detects open ports and supported TLS ciphers and checks cipher strength via https://ciphersuite.info/.

scanDest : String

Scan destination: IP address or host name
repName : String
enableCipherDetection : boolean
If active, detect supported ciphers and check the cipher strength via https://ciphersuite.info/.
timeoutInMs : int

Too high timeout slows down the scan, too small one reduces the reliability of open ports detection. Find your balance :-)
threadNmb : int

Too small threadNmb slows down the scan, too high one increases the load of your system. Find your balance :-)

secureCNVulnerabilityScanner

secureCnAccessKey : String (optional)
The access key of the service account used to communicate with the SecureCN management server.
secureCnSecretKeyId : String (optional)
The secret key of the service account used to communicate with the SecureCN management server. the secret should be store as a jenkins credential of text type.
imageName : String (optional)
The name of the image to scan.
dockerRegistryPasswordId : String (optional)
Username and password for docker registry login. use this if the target image is stored in a private registry. if not, leave blank. the secret should be store as a jenkins credential of username and password type.
highestSeverityAllowed : String (optional)
The highest CVE vulnerability severity allowed in the scan
highestSeverityAllowedDf : String (optional)
The highest severity allowed for docker file benchmarking scan
pushLocalImage : boolean (optional)
If checked, local docker image will be pushed on scan success.
url : String (optional)
The URL of the Securecn management server.

$class: 'PowerShell'

command : String
stopOnError : boolean

Stops script when some step fails. Similar to Shell set -e. Translates to inserting the line '$ErrorActionPreference = "Stop"' into the beginning of your command block. See documentation on ErrorActionPreference.
However, this can break scripts that have advanced parameter blocks, specifically those utilizing '[CmdletBinding()]' in the beginning as this must be the first executable line in a scriptblock, resulting in an 'UnexpectedAttribute' error.
useProfile : boolean

Runs script with default profile or no profile. See documentation.
unstableReturn : int (optional)
If set, the script exit code that will be interpreted as an unstable build result. If the final exit code matches the value, the build results will be set to unstable. The value 0 is ignored and does not make the build unstable to keep the default behaviour consistent.

$class: 'PowerShellBuildStep'

buildStepId : String
defineArgs : boolean
buildStepArgs
- arg : String

$class: 'PreflightBuilder'

clientId : String
(required) Client Id for PreFlight API. You can generate client id and client secret from Account Settings>API under your Preflight account.
clientSecret : String
(required) Client Secret for PreFlight API. You can generate client id and client secret from Account Settings>API under your Preflight account.
testId : String
(optional) Pass the Test Id to run. If test id or group id are not passed all the tests will be run.
groupId : String
(optional) Pass the Group Id to run. If test id or group id are not passed all the tests will be run. You can get it from Test Settings>Groups under your Preflight account.
environmentId : String
(optional) Environment ID for your test group. You can get it from Test Settings>Environments under your Preflight account.
platforms : String
(optional) Platforms and browsers you want to run your PreFlight tests.
- Example usage win-chrome.
- You can pass more than one browser option. Ex. win-chrome,win-firefox
- Platform options : win
- Browser options : chrome, ie, edge, firefox
sizes : String
(optional) Sizes you want to run your PreFlight tests.
- Example usage. (WidthxHeight) 1440x900.
- You can pass more than one size option. Ex. 1920x1080, 1440x900
- Size options : 1920x1080, 1440x900, 1024x768, 480x640
captureScreenshots : boolean
Capture screenshots enables taking screenshots of the each step.
waitResults : boolean
Wait PreFlight test result(s). If you set it as true, your Jenkins build waits your PreFlight test result(s).

$class: 'PrereqBuilder'

projects : String
warningOnly : boolean

probelyScan

targetId : String

ID of the target you want Probely to scan.
authToken : String (optional)

Raw Probely API authentication key.

Please use the credentialsId field instead, unless you understand the security implications of using this mechanism. Passing the API authentication token directly is not advised, unless it is properly secured using a secret storage mechanism, such as HashiCorp Vault.
credentialsId : String (optional)

Credential identifier for the Probely API authentication key.
failThreshold : String (optional)

Mark the build as failed if a vulnerability with the following severity level is found.
stopIfFailed : boolean (optional)

If the build fails because the target is vulnerable, stop scanning for more vulnerabilities.
waitForScan : boolean (optional)

Wait for the scan to complete before proceeding to the next step in the pipeline.

Since a scan can take a long time, the plugin will return as soon as the scan starts. This is enabled by default to make the build faster.
Please note that disabling this option implies that the build step always finishes successfully, even if vulnerabilities are found later on.

Enabling this option allows the plugin to mark the build as failed if it finds any vulnerabilities.

$class: 'ProjectGenerationStep'

projectConfig
- pipelineConfig
  - destructor : boolean
  - authorisations : String
  - branchSCMParameter : boolean
  - branchParameters : String
  - generationExtension : String
  - pipelineGenerationExtension : String
  - disableDslScript : boolean
  - scriptDirectory : String
  - namingStrategy
    - projectFolderPath : String
    - branchFolderPath : String
    - projectSeedName : String
    - projectDestructorName : String
    - branchSeedName : String
    - branchStartName : String
    - branchName : String
    - ignoredBranchPrefixes : String
  - eventStrategy
    - delete : boolean
    - auto : boolean
    - trigger : boolean
    - commit : String
- project : String
- scmType : String
- scmUrl : String
- scmCredentials : String
- triggerIdentifier : String
- triggerType : String
- triggerSecret : String

$class: 'ProjectPrerequisitesInstaller'

protecodesc

credentialsId : String (optional)
BDBA supports both username/password and an API token.
protecodeScGroup : String (optional)
Specify the BDBA Group ID where the artifacts should be uploaded to.
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/ or with Groups API https://protecode-sc.mydomain.com/api/groups/.

Please notice that this value should be a number, not the name or the path to the group.
Value can also be an environment variable containing the group number, e.g $MY_GROUP_ID or ${MY_GROUP_ID}.
convertToSummary : boolean (optional)
The summary can be shown using Summary Display Jenkins Plugin.
The report file name to publish is protecodesc.xml.

If you wish to see only the latest results in the summary, you can run a "shell command" build step before the BDBA build step: "rm -rf reports". You can find the mentioned build step in the list of possible build steps on the build configuration page. Please notice that this action is irreversible.
customHeader : String (optional)
Please specify the custom header in JSON format for fetching a file by URL

This is for the cases where the server from which BDBA must fetch the file requires authentication or similar header values.

For example {"Customheader": "Foobar", "token": "oooooooo1!"}
directoryToScan : String (optional)
Please specify the directory in the workspace you wish to scan.

Alternatively you can specify the URL of the file you wish to scan, BDBA will fetch the file from the given URL

For files in the workarea, if you wish to use an absolute path put '/' at the beginning of the path, this will cause the plugin to not try to find the folder from the build workspace. Please notice that it is possible to upload massive amounts of files if this option is set to absolute path and the 'Include subdirectories' is enabled.

If there are 10 or more files to scan, the plugin will zip them before sending them. You can specify the name for the BDBA scan job in the field "Scan job name (used only for zip)".
Value can also be an environment variable containing the directory/URL, e.g $MY_SCAN_DIR or ${MY_SCAN_DIR}.
dontZipFiles : boolean (optional)
Do not zip files in any situation. Usually the BDBA plugin zips files if there are more than 50, to avoid transfer overhead. This configuration item is ignored if the BDBA instance is Synopsys hosted.
endAfterSendingFiles : boolean (optional)
Whether to end the build phase when the files are sent to BDBA. You can see the links to the results in the console.
failIfVulns : boolean (optional)
Trigger build failure if BDBA finds vulnerabilities from the scanned files. The build will always fail if the connection or api calls to BDBA returned any errors.
includeSubdirectories : boolean (optional)
Also include subdirectories of the directory from which the build attempts to find files to scan.

Please notice that if this is selected, it is possible to accidentally upload massive amounts of files.
pattern : String (optional)
Here you can provide a regular expression to include only certain files. The option is the default java Pattern format: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

Leave blank to include all found files.
protecodeScanName : String (optional)
BDBA jenkins plugin will zip given files if there are 10 or more. This is done to avoid file transfer overhead produced by moving many files. The plugin will still show the results per file.
scanOnlyArtifacts : boolean (optional)
Scan only Jenkins Artifacts produced by earlier steps of the build.
scanTimeout : int (optional)
Timeout for the scan. If this timeout is exceeded the plugin will not try to get further results from BDBA. If a comprehensive timeout for the build is needed, it is suggested to use the Build Timeout Plugin.

provarAutomation

provarAutomationName : String
The version of the Provar Automation CLI to use for the test run.
buildFile : String
The name of the build file. Must end with '.xml'. This task assumes it is contained in the ANT folder of your Project Name directory.
testPlan : String
The name of the test plan. Test plan name is the relative path from the plans folder in Provar.
You can either specify a Test Plan or a Test Folder when deciding which tests to run.
testFolder : String
The name of the test folder. Set to "[Aa]ll" in order to include all tests. Otherwise, specify a relative path from the tests folder in Provar.
Alternatively, consider specifying a Test Plan.
environment : String
The test environment to target for testing. Test environment must exist within project. Default value is the .testproject default environment.
browser
The name of the web browser to run the tests against. Available values: Chrome, Chrome_Headless, Edge, Edge_Legacy, Firefox, IE, Safari
- Values: Chrome_Headless, Chrome, Edge, Edge_Legacy, Firefox, Safari
secretsPassword
The password used to access a Provar Project that has a .secrets file that has been encrypted.
- Type: class hudson.util.Secret
salesforceMetadataCacheSetting
Whether or not to Reuse, Reload, or Refresh the Salesforce Metadata Cache.
- Values: Reuse, Refresh, Reload
resultsPathSetting
How to handle the test results folder.
Increment adds a numeric suffix to the Results folder.
Replace replaces the existing Results folder if it exists.
Fail will fail the test run if there is already a Results folder present.
- Values: Increment, Replace, Fail
projectName : String
The project folder name in Provar. This is the relative path (starting with the Jenkins workspace) of the folder that contains the .testproject file, along with other Provar-related files. Leave blank if the Jenkins Workspace folder is the same as the project folder.

$class: 'ProxyBuilder'

projectName : String

dotnetPublish

dotnet publish compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory. The output includes the following assets:

Intermediate Language (IL) code in an assembly with a dll extension.
A .deps.json file that includes all of the dependencies of the project.
A .runtimeconfig.json file that specifies the shared runtime that the application expects, as well as other configuration options for the runtime (for example, garbage collection type).
The application's dependencies, which are copied from the NuGet cache into the output folder.

The dotnet publish command's output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution. It's the only officially supported way to prepare the application for deployment. Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it. For more information, see Publish .NET Core apps with the .NET Core CLI .

(see also: Microsoft Documentation)

charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
configuration : String (optional)
Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
force : boolean (optional)
Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
framework : String (optional)
Publishes the application for the specified target framework. You must specify the target framework in the project file.
manifest : String (optional)
manifests : Array / List of String (optional)
manifestsString : String (optional)
Specifies one or several target manifests to use to trim the set of packages published with the app. The manifest file is part of the output of the dotnet store command.
noBuild : boolean (optional)
Doesn't build the project before publishing, and does not perform an implicit restore.
noDependencies : boolean (optional)
Ignores project-to-project references and only restores the root project.
noRestore : boolean (optional)
Doesn't execute an implicit restore when running the command.
nologo : boolean (optional)
Doesn't display the startup banner or the copyright message.

Available since: .NET Core SDK 3.0
option : String (optional)
options : Array / List of String (optional)
optionsString : String (optional)
For more information about these options, see the MSBuild Command-Line Reference.

If targets and/or properties are also configured, those will be passed after these options.
outputDirectory : String (optional)
Specifies the path for the output directory.
If not specified, it defaults to [project_file_folder]./bin/[configuration]/[framework]/publish/ for a runtime-dependent executable and cross-platform binaries. It defaults to [project_file_folder]/bin/[configuration]/[framework]/[runtime]/publish/ for a self-contained executable.
In a web project, if the output folder is in the project folder, successive dotnet publish commands result in nested output folders. For example, if the project folder is myproject, and the publish output folder is myproject/publish, and you run dotnet publish twice, the second run puts content files such as .config and .json files in myproject/publish/publish. To avoid nesting publish folders, specify a publish folder that is not directly under the project folder, or exclude the publish folder from the project.
Some behaviour depends on the SDK version:
- .NET Core 3.x SDK and later: If a relative path is specified when publishing a project, the output directory generated is relative to the current working directory, not to the project file location.
  If a relative path is specified when publishing a solution, all output for all projects goes into the specified folder relative to the current working directory. To make publish output go to separate folders for each project, specify a relative path by using the msbuild PublishDir property instead of this option.
- .NET Core 2.x SDK: If a relative path is specified when publishing a project, the output directory generated is relative to the project file location, not to the current working directory.
  If a relative path is specified when publishing a solution, each project's output goes into a separate folder relative to the project file location. If an absolute path is specified when publishing a solution, all publish output for all projects goes into the specified folder.
project : String (optional)
The project or solution (or directory containing a project or solution) to publish. If not specified, the current directory is used.
Note that the use of a solution instead of a project was added in the .NET Core 3.0 SDK.
properties (optional)
- Type: java.util.Map<java.lang.String, java.lang.String>
propertiesString : String (optional)
Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax .
Properties of particular interest to dotnet publish:
- PublishProfile=Properties\PublishProfiles\profile.pubxml: Use a .pubxml to set publish-related properties. See Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment for more information.
- PublishReadyToRun=true: Compiles application assemblies as ReadyToRun (R2R) format. R2R is a form of ahead-of-time (AOT) compilation. For more information, see ReadyToRun images.
  Available since .NET Core 3.0 SDK.
- PublishSingleFile=true: Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used.
  For more information about single-file publishing, see the single-file bundler design document .
  Available since .NET Core 3.0 SDK.
- PublishTrimmed=true: Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable. For more information, see Trim self-contained deployments and executables .
  Available since .NET Core 3.0 SDK.
Note that it is recommended to specify all of these, other than PublishProfile, in a publish profile rather than here.
runtime : String (optional)
Publishes the application for a given runtime. For a list of Runtime Identifiers (RIDs), see the RID catalog. For more information, see .NET Core application publishing and Publish .NET Core apps with the .NET Core CLI.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
selfContained : boolean (optional)
Publishes the .NET Core runtime with your application so the runtime doesn't need to be installed on the target machine. Enabled by default if a runtime identifier is specified and the project is an executable project (not a library project). For more information, see .NET Core application publishing and Publish .NET Core apps with the .NET Core CLI.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean (optional)
If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.

Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).

Available since: .NET Core SDK 2.1
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
unstableIfErrors : boolean (optional)
If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
unstableIfWarnings : boolean (optional)
If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
verbosity : String (optional)
Sets the MSBuild verbosity level.
versionSuffix : String (optional)
Defines the version suffix to replace the asterisk (*) in the version field of the project file.
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

snPublishApp

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be published.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
appScope : String (optional)
Required if application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
appSysId : String (optional)
Required if application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
appVersion : String (optional)
Version under which to store the application. Provide 2 significant numbers separated by '.' eg. 1.0 (the third number will be automatically added with build number, what gives eg. 1.0.106).
If the version number is passed, the publish process uses that version and updates the local application version if different. If the version number is not passed, the publish process uses the current version of the local application.
devNotes : String (optional)
Developer notes to store with the application.
incrementBy : int (optional)
isAppCustomization : boolean (optional)
obtainVersionAutomatically : boolean (optional)
Calculate next application version that will be published. Retrieve it in smart way using API or source control (if SCM is configured for the build). API has the highest priority, then SCM will be used.
The value from ''Application version'' will be ignored.
url : String (optional)
ServiceNow instance url where the application will be published to.

artifactVersion

token : String (optional)
name : String (optional)
description : String (optional)
type : String (optional)
groupId : String (optional)
artifactId : String (optional)
stage : String (optional)
flow : String (optional)
stageDescription : String (optional)
version : String (optional)

$class: 'PublishBuilder'

packageid : String
Enter an ID for the build artifact you want to publish. This must match that specified in the build step.
nugetFeedUrl : String
nugetFeedApiKey
- Type: class hudson.util.Secret
packageVersion : String
Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
sqlChangeAutomationVersionOption
- value
  - Values: Latest, Specific
- specificVersion : String

$class: 'PublishStepBuilder'

packageId : String
nugetFeedUrl : String
nugetFeedUrlApi
- Type: class hudson.util.Secret
packageVersion : String

$class: 'PullRequestCommenter'

comment : String

dotnetNuGetPush

The dotnet nuget push command pushes a package to the server and publishes it. The push command uses server and credential details found in the system's NuGet config file or chain of config files. For more information on config files, see Configuring NuGet Behavior. NuGet's default configuration is obtained by loading %AppData%\NuGet\NuGet.config (Windows) or $HOME/.local/share (Linux/macOS), then loading any nuget.config or .nuget\nuget.config starting from the root of drive and ending in the current directory.

The command pushes an existing package. It doesn't create a package. To create a package, use dotnet pack.

(see also: Microsoft Documentation)

apiKeyId : String (optional)
The API key for the server.
charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
disableBuffering : boolean (optional)
Disables buffering when pushing to an HTTP(S) server to reduce memory usage.
forceEnglishOutput : boolean (optional)
Forces the application to run using an invariant, English-based culture.
noServiceEndpoint : boolean (optional)
Doesn't append "api/v2/package" to the source URL.

Available since: .NET Core SDK 2.1
noSymbols : boolean (optional)
Doesn't push symbols (even if present).
root : String (optional)
Specifies the file path to the package(s) to be pushed.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
skipDuplicate : boolean (optional)
When pushing multiple packages to an HTTP(S) server, treats any 409 Conflict response as a warning so that the push can continue.

Available since: .NET Core SDK 3.1
source : String (optional)
Specifies the server URL. Supported URLs for nuget.org include https://www.nuget.org, https://www.nuget.org/api/v3, and https://www.nuget.org/api/v2/package. For private feeds, replace the host name (for example, %hostname%/api/v3).
This option is required unless DefaultPushSource config value is set in the NuGet config file.
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
symbolApiKeyId : String (optional)
The API key for the symbol server.
symbolSource : String (optional)
Specifies the symbol server URL.
timeout : int (optional)
Specifies the timeout for pushing to a server in seconds. Defaults to 300 seconds (5 minutes). Specifying 0 (zero seconds) applies the default value.
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

artifactVersion

variableName : String
token : String (optional)
name : String (optional)
stage : String (optional)
version : String (optional)

$class: 'PushBuilder'

remoteImageStrategy
- Values: DO_NOT_USE, GENERATE_GIT, FIXED
hubUrls : String
Optional parameter. Multiple hub urls, comma separated. Eg: https://turbo.net, https://stage.turbo.net
When multiple hubs are specified, the image will be pushed to all hubs.
organization : String
Overwrite organization in the following pattern:&ltorganization>/&ltproject>:&ltbranch name>.&ltfirst 6 numbers of current HEAD>.
overwriteOrganization : boolean
remoteImageName : String
Required parameter. Image name in the remote registry.

dateFormat : String

Format can be any date or time pattern. Supported symbols:

y\|Y	Year
M	Month
w	Week in year
W	Week in month
D	Day in year
d	Day in month
F	Day of week in month
E	Day name in week
u	Day number of week (1 = Monday, ..., 7 = Sunday)
H	Hour in day (0-23)
k	Hour in day (1-24)
K	Hour in am/pm (0-11)
h	Hour in am/pm (1-12)

Examples

yyMMddHHmm
YYYY-MM-DD

appendDate : boolean
incrementVersion : boolean
Adds one to the latest image version found in the remote hub.

$class: 'Python'

Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.

command : String

$class: 'PythonBuilder'

pythonName : String
nature : String
command : String
ignoreExitCode : boolean

qualityCloudsScan

credentialsId : String
instanceUrl : String
issuesCountThreshold : int
techDebtThreshold : int
qcThreshold : int
highSeverityThreshold : int

$class: 'QFTestConfigBuilder'

The QF-Test build step. Invokes QF-Test binary during your Jenkins job. If not listed in your PATH variable, the location of the QF-Test binary can be specified explicitly.

The actual test configuration is set via pairs of arguments and suite file fields. The Advanced Test result control button allows to adjust the mapping between the QF-Test result and the Jenkins build result.

All report files that are produced will be stored in an output directory relative to your workspace, whose structure is as follows:

    <LOGDIR>
        ├── html        (HTML report directory)
        ├── junit       (junit report directory)
        └── qrz         (QF-Test runlogs)

The resulting runlogs are automatically declared as Jenkins build artificats and should appear as such on the Jenkins build page. The junit and html reports can be processed further by the junit respectively the publishHTML plugin.

suitefield
- suitename : String
  Path to the suite file(s) to be run. Absolute or relative to the current workspace. Ant-style globbing is supported. A path referencing an entire directory translates to <path to directory>/**/*.qft.
  A suitesfile can also be provided. For this, preprend the file path with the -suitesfile option.
- customParam : String
  Additional arguments to be passed to the QF-Test call. Consult the manual for a complete list of all possible options. This is an optional parameter.
customPath : String (optional)
onTestError : String (optional)
onTestException : String (optional)
onTestFailure : String (optional)
onTestWarning : String (optional)
reportDirectory : String (optional)
Specifies the top level directory for logfiles that are automatically generated by the QF-Test plugin. The given path is relative to the current workspace.
reportGenArgs : String (optional)
Additional arguments to be passed to the final QF-Test call which is generating the report (i.e. QF-Test runs in -genreport mode). Consult the manual for a complete list of all possible options. This is an optional parameter.

reportQualityAudit

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
bugCount : int (optional)
bugScore : Object (optional)
duplicationRate : float (optional)
hotspotCount : int (optional)
hotspotScore : Object (optional)
linesCount : long (optional)
qualityGatePassed : boolean (optional)
testCoverage : float (optional)
vulnerabilityCount : int (optional)
vulnerabilityScore : Object (optional)

$class: 'QualityCenter'

qcClientInstallationName : String
qcQTPAddinInstallationName : String
qcServerURL : String
This must be the URL pointing to the qcbin folder of the Quality Center Web application.
qcLogin : String
qcPass : String
qcDomain : String
qcProject : String
qcTSFolder : String
qcTSName : String
List of test sets (one test set per line) to run.
qcTSLogFile : String
Name of the report that will be generated.

If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME} variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.

You can use all standard environment variables plus:
- ${QC_DOMAIN} for the current Quality Center domain;
- ${QC_PROJECT} for the current Quality Center project;
- ${TS_FOLDER} for the current TestSet folder;
- ${TS_NAME} for the TestSet name.
qcTimeOut : int
Number of seconds before timeout. If left empty, default is 600.
runMode : String
Defines how the test set has to be executed:
- RUN_PLANNED_HOST: The test set will be run on the host defined in Quality Center.
- RUN_REMOTE: The test set will be run on a host specified using the Run Host field.
- RUN_LOCAL: The test set will be run on the machine which performs the build.
runHost : String
If the Run Mode field is set to RUN_REMOTE, use this field to specify the name of the host which is intended to run the test set.

acrQuickTask

azureCredentialsId : String
resourceGroupName : String
The resource group name that the app will be associated with.
registryName : String
The Azure Container Registry name, the built image will be pushed to.
architecture : String (optional)
The OS architecture.
buildArgs (optional)
Set build-time variables as docker build --build-arg.
- key : String
- value : String
- secrecy : boolean
dockerfile : String (optional)
Relative path to the source control management(git path or local directory) for the Dockerfile.
gitPath : String (optional)
Relative path in the git repo's selected branch, which will be used as docker build path. Empty means root path in the git repo.
gitRefspec : String (optional)
gitRepo : String (optional)
Git repo which contains source code and Dockerfile, which will be used to build image. Please use the URL with HTTP(S) protocol instead of SSH protocol Use https://PAT@github.com/user/repo.git for private repo.
imageNames (optional)
After Azure Container Registry finishes building image, it pushes the image to registry with tags provided. Single Built image can be pushed with multiple repositories and tags. If no image name provided, Azure Container Registry **WILL NOT** push any image to registry after building.
- image : String
local : String (optional)
Build docker image from a local directory. This directory will be uploaded to Azure Container Registry. It also will be used as docker build path.
noCache : boolean (optional)
Do not use cache when building the image. Enable the no-cache flag when build as docker build --no-cache
os : String (optional)
The operating system type required for the run.
sourceType : String (optional)
tarball : String (optional)
Files in a compressed archive on a remote web server. e.g.http://remoteserver/myapp.tar.gz
timeout : int (optional)
Maximum duration for a docker build to execute in seconds. Should be in 300 to 28800.
variant : String (optional)
Variant of the CPU.

$class: 'R'

Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.

command : String

$class: 'RAD'

For projects that need to use RAD's headless capabilities (or, even better, BU) as the build system. This causes Hudson to invoke RAD/BU with the given targets and options. Any non-zero exit code causes Hudson to mark the build as a failure.
Hudson supplies some environment variables that can be used from within the build script.
To know more about RAD's headless features, please refer to the RAD 7.0 Infocenter or to the RAD 7.5 Infocenter.

activateProjectWorkspaceVar : boolean
Set this option if you want to get an equivalent of Hudson's WORKSPACE environment variable through the PROJECT_WORKSPACE one.
Wether you set this option or not, be sure to never use the WORKSPACE variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
buildFile : String
Specify the build file to use. If not specified, RAD will use the build.xml one in the project's workspace. The base directory is the workspace.
deleteRadWorkspaceContent : boolean
Set this option if you want the RAD workspace folder to be emptied before RAD is actually run. This will also remove the .metadata folder.
deleteRadWorkspaceMetadata : boolean
Set this option if the .metadata folder of RAD's workspace has to be removed before RAD is actually run.
properties : String
Properties needed by the build can be specified here (in the standard properties file format):
```
        # comment
        name1=value1
        name2=value2
    
```
These are passed to RAD like "-Dname1=value1 -Dname2=value2"
radInstallationName : String
Set the RAD installation to be used to run the build.
radWorkspace : String
Specify the RAD workspace to be used. This workspace must not be the same as the project's workspace. If the workspace doesn't exist, it will be created. If no workspace is specified, a default one will be created, named <project name>-rad-workspace.
The base folder is the project's workspace.
targets : String
Specify a list of targets to be invoked, or leave it empty to invoke the default target specified in the build script. Additionally, you can also use this field to specify other Ant options.

$class: 'RPDCreateInstance'

pack : String
Name of the package from which you want to create the RPD instance.
instanceName : String
Custom name for the RPD instance that you want to create.
customProfile : String

$class: 'RPDDeployInstance'

instanceName : String
Custom name of the RPD instance that you want to deploy.
pack : String
Name of the package containing the RPD instance that you want to deploy.
environment : String
Environment where to deploy the RPD instance.
route : String
Route where to deploy the RPD instance.
customProfile : String
useCustomProfile : boolean

$class: 'RTCGitBuilder'

serverURI : String

The Jazz Repository connection URI for the Rational Team Concert (RTC) server
credentialsId : String

Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
annotateChangeLog : boolean

Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
buildDefinition : String (optional)

The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
jenkinsRootURI : String (optional)
jenkinsRootURIOverride : boolean (optional)

Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
timeout : int (optional)

The timeout period in seconds for Jazz repository requests made during the build.
trackBuildWorkItem : String (optional)

Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
useBuildDefinition : boolean (optional)
useTrackBuildWorkItem : boolean (optional)
useWorkItems : boolean (optional)
workItemUpdateType : String (optional)

rabbitMQPublisher

This build step can be used to publish message to Rabbit-MQ.

rabbitName : String
exchange : String
The name of the exchange.
data : String
Data to send, in raw format, json format or list of key/value.
Can contains environment variables (preferred) and build parameters (eg: ${FOO} or $FOO) which will be resolve before sending the message. Can also use ${BUILD_USER_ID} and ${BUILD_USER_NAME} to retrieve the information's user who launch the job.
conversion : boolean (optional)
if checked, there will be Spring escaping . It is especially important with Json formatting .
- if Checked, the message is "{\"step\":\"end\"}"
- if unchecked, the message is {"step":"end"}
routingKey : String (optional)
An explicit routing key binding the queue to this exchange.
toJson : boolean (optional)
- If check : convert the data to a JSON object, following java nomenclature for field name.
  The data must be a list in the format key=value and the key must start with a letter character
- If uncheck : the raw message without transformation

$class: 'RadarGunBuilder'

radarGunInstance
RadarGun installation to be used
- $class: 'RadarGunCustomInstallation'
  - home : String
- $class: 'RadarGunInstallationWrapper'
  - radarGunName : String
scenarioSource
RadarGun scenario to be executed
- $class: 'FileScenarioSource'
  - scenarioPath : String
- $class: 'TextScenarioSource'
  - scenario : String
nodeSource
List of the nodes where RadarGun will run
- $class: 'FileNodeConfigSource'
  - nodeListPath : String
- $class: 'TextNodeConfigSource'
  - nodes : String
scriptSource
Script which will be used for starting appropriate processes on nodes
- $class: 'BuildInScriptSource'
- $class: 'FileScriptSource'
  - mainPath : String
  - workerPath : String
- $class: 'TextScriptSource'
  - mainScript : String
  - workerScript : String
remoteLoginProgram : String
remoteLogin : String
workspacePath : String
pluginPath : String
pluginConfigPath : String
reporterPath : String

$class: 'Rake'

rakeInstallation : String
rakeFile : String
tasks : String
rakeLibDir : String
rakeWorkingDir : String
silent : boolean
bundleExec : boolean

$class: 'RallyBuild'

preRallyState
- stateName : String
issueString : String
updateOnce : boolean
preComment
- preCommentText : String
preReady
- preReadyState : boolean
changeReady
- issueReady : boolean
createComment
- commentText : String
changeRallyState
- issueRallyState : String
changeDefectRallyState
- defectRallyState : String

rancherRedeploy

credential : String
workload : String
you can find your workload API path in Rancher2.x web UI-->Cluster->Project->Resources->Workloads,
copy the workload link address, eg: http://localhost/p/c-h4hxd:p-dwqfr/workload/deployment:jenkins:jenkins
or click the menu icon and select "View in API", will open in new browser tab. copy that url to here.

since endpoint part has bean set in Credential, you only need specify path from "/p/" or "/project", eg:
/project/c-h4hxd:p-c9j8z/workloads/deployment:default:busybox
or /p/c-h4hxd:p-dwqfr/workload/deployment:jenkins:jenkins
images : String
update image version to your excepted. optional if you use latest as image version or imagePullPolicy="Always"
you can use semicolon(;) to split multiple images, eg:
nginx;nginx:1.0;myteam/myproject:v2.0;docker.io/team/image:v1.0.${BUILD_NUMBER}
this plugin will update all images in this workload by match the name part exactly, and simply set version part as you specified. so you may need Jenkins variables to dynamic generate new version number.
alwaysPull : boolean
set imagePullPolicy to "Always"

rancher

environmentId : String
endpoint : String
credentialId : String
service : String
image : String
confirm : boolean
startFirst : boolean
ports : String
environments : String
timeout : int

ranorex

cmdLineArgs : String (optional)

Allows you to add Ranorex command line arguments. Some of the most important ones include:

Flag	Function
config \| cfg:<config parameter name>=<value>	Set values for configuration parameters.
reportlevel \| rl: Debug\|Info\|Warn\|Error\|Success\|Failure\|<any integer>	Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120
testcase \| tc:<name or guid of test case>	Runs this test case only.
testsuite \| ts:<path to test suite file>	Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>.
module \| mo:<module name or guid>	Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched.
testcaseparam \| tcpa:<name or guid of test case>:<parameter name>=<value>	Creates or overrides values for testcase parameters specified in the test suite.
runlabel \| rul:<custom value>	Sets a custom runlabel for the test run.
testcasedatarange \| tcdr:<name or guid of test case>=<data range>	Sets the data range for a testcase.

rxGlobalParameter : String (optional)
Allows you to create or override values for global parameters set in the test suite. Enter parameters according to the following pattern: "ParameterName=Value" Separate parameters with semicolons or add one parameter per line.
rxJUnitReport : boolean (optional)
rxReportDirectory : String (optional)
Allows you to specify the directory that your report will be saved to. If no path is specified, the location of your Ranorex Test Suite file will be used.
rxReportExtension : String (optional)
rxReportFile : String (optional)
Allows you to specify the file name of the report with the standard placeholders available in the test suite settings. By default, the following pattern is used (%S_%Y%M%D_%T).
rxRunConfiguration : String (optional)
Runs the test suite using one of the run configurations available in the test suite. Enter the exact name of the run configuration you want to use. By default, the run configuration currently selected in the test suite is used. If you want to create or edit run configurations, please use Ranorex Studio or the Ranorex Test Suite Runner.
rxTestRail : boolean (optional)
Reports the test run results to TestRail via API. Requires 'Test Rail User' and 'Test Rail Password'.
rxTestRailPassword : String (optional)
Password or API key for the user specified in 'Test Rail User'.
rxTestRailRID : String (optional)
(Optional) The identifier of an existing test run in TestRail to report test results to. Without this argument a new test run is created.
rxTestRailRunName : String (optional)
(Optional) Creates a new test run in TestRail with the specified name to report test results to. Without this argument the default name is used.
rxTestRailUser : String (optional)
Email used to sign in to TestRail.
rxTestSuiteFilePath : String (optional)
Enter the path to the test suite file (*.rxtst) located in the output folder of your solution.
rxZippedReport : boolean (optional)
Compresses the report and the associated files into a single archive with the .rxzlog extension. The following additional input fields will appear when this option is enabled:
- Compressed report directory
- Compressed report file name
rxZippedReportDirectory : String (optional)
Allows you to specify the directory that your compressed report will be saved to. If no path is specified, the location of your Ranorex Test Suite file will be used.
rxZippedReportFile : String (optional)
Allows you to specify the file name of the compressed report with the standard placeholders available in the test suite settings. If no filename is specified, the same name as the "Ranorex Report File Name" is used.

$class: 'RapidDeployJobPlanRunner'

serverUrl : String
The URL to the RapidDeploy you want to connect to, including the protocol (e.g.: http://192.168.1.1:8090/MidVision).
authenticationToken : String
The authentication token to connect to RapidDeploy. It can be generated by the MidVision encryptor tool.
jobPlan : String
The id of the job plan you want to run.
asynchronousJob : boolean
Check this box to run the RapidDeploy job asynchronously. This will continue to the next Jenkins step immediately once the job request has been made to RapidDeploy. Use this to run jobs in parallel.
showIndividualLogs : boolean
Check this box if you want to see the individual logs from all the deployments included in the RapidDeploy job plan.
showFullLog : boolean
Check this box if you want to see the full log of the RapidDeploy deployment in the Jenkins job log, otherwise you'll see a link to retrieve them from the RapidDeploy server.

$class: 'RapidDeployJobRunner'

serverUrl : String
The URL to the RapidDeploy you want to connect to, including the protocol (e.g.: http://192.168.1.1:8090/MidVision).
authenticationToken : String
The authentication token to connect to RapidDeploy. It can be generated by the MidVision encryptor tool.
project : String
The name of the project you want to deploy.
target : String
The project target to deploy to (i.e.: SERVER.INSTALLATION.CONFIGURATION).
packageName : String
The name of the deployment package to deploy. Leave this field blank to deploy the latest package.
asynchronousJob : boolean
Check this box to run the RapidDeploy job asynchronously. This will continue to the next Jenkins step immediately once the job request has been made to RapidDeploy. Use this to run jobs in parallel.
showFullLog : boolean
Check this box if you want to see the full log of the RapidDeploy deployment in the Jenkins job log, otherwise you'll see a link to retrieve them from the RapidDeploy server.

$class: 'RapidDeployPackageBuilder'

serverUrl : String
The URL to the RapidDeploy you want to connect to, including the protocol (e.g.: http://192.168.1.1:8090/MidVision).
authenticationToken : String
The authentication token to connect to RapidDeploy. It can be generated by the MidVision encryptor tool.
project : String
The name of the project you want to build a deployment package for.
enableCustomPackageName : boolean
packageName : String
The deployment package name. Leave this field blank to create an auto-incremented version package name.
archiveExtension : String
The extension of the deployment package file to generate: jar, war, ear, tar, rar or zip.

$class: 'RawCliBuilder'

changeLogFile : String (optional)
changeLogParameters : String (optional)
commandArguments : String (optional)
contexts : String (optional)
Liquibase contexts to execute under.
credentialsId : String (optional)
installationName : String (optional)
labels : String (optional)
Liquibase labels to execute
liquibasePropertiesPath : String (optional)
A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
password : String (optional)
resourceDirectories : String (optional)
Leave blank for workspace root. May be relative to workspace or an absolute path.
url : String (optional)
example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
username : String (optional)

$class: 'RebaseBuilder'

This works in conjunction with the "This project builds a Subversion feature branch" checkbox above. This build step merges any revisions in the upstream branch, via svn merge, and commits them. This is normally called rebasing in Subversion. Automatic rebasing is useful to keep branches close to the upstream, thereby reducing the risk of integration problem down the road.

You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.

If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.

permalink : String
stopBuildIfMergeFails : boolean
setUnstableIfMergeFails : boolean

$class: 'RebootIOSDevice'

Reboots tethered iOS devices. This can be used to restore devices to a "clean" state after running tests.

url : String
cloudTestServerID : String
Select the server to download iOSAppInstaller.zip from.
additionalOptions : String
If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.

$class: 'ReconfigureBox'

id : String
cloud : String
workspace : String
The workspace in ElasticBox to look for a deployed box to reconfigure.
box : String
Box to look for instances in the selected workspace.
instance : String
variables : String
buildStep : String
buildStepVariables : String

$class: 'ReinstallBox'

cloud : String
workspace : String
The workspace in ElasticBox to look for a box instance to reinstall.
box : String
Box to look for instances in the selected workspace.
instance : String
buildStep : String
Instance deployed by the selected preceding Deploy Box build step will be reinstalled.

$class: 'ReleaseMarker'

releaseName : String
services (optional)
- name : String
- scopedTo (optional)
  - applications
    - name : String
applications (optional)
- name : String
releaseEndTimestamp : String (optional)
releaseStartTimestamp : String (optional)

androidApkMove

If you have already uploaded files to Google Play, whether manually, via the "Upload Android AAB/APK to Google Play" post-build action, or by other means, this build step allows you to change the release track for specific versions.

For example, you can use this to promote an app currently in alpha testing to the beta release track, once you've decided it's ready for a wider audience.

Similarly, once you're ready for release, you can move from beta to a staged rollout, or directly to production.

Note that "downgrading" release tracks, e.g. from production to alpha is not possible.

apkFilesPattern : String (optional)
applicationId : String (optional)
Application ID (i.e. APK package name) of the app being assigned to a new release track. This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
filesPattern : String (optional)
Specifies filenames or patterns matching one or more AAB or APK files from which the version codes should be read, in order to determine which app versions should be re-assigned to a new release track.
Note that these files should have already been uploaded — this build step will not do any uploading; it will only move existing app versions from one release track to another. To upload app files, use the "Upload Android AAB/APK to Google Play" post-build action.
You can use wildcards like "**/build/outputs/*/*-release.apk".
See the 'includes' attribute of Ant's FileSet for the exact format.
Note that multiple entries must be comma-separated.
The base directory is the build's workspace. You can only reference AAB or APK files that are located in your workspace.
If no value is provided, the default is **/build/outputs/**/*.aab, **/build/outputs/**/*.apk. This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
fromVersionCode : boolean (optional)
googleCredentialsId : String (optional)
Specifies which credential to use in order to connect to Google Play.
The selected credential must be a "Google Service Account from private key" — if you have not added one already, refer to the documentation on this plugin's page.
By choosing the "Parameter expression" option, you can also provide a credential at build time, either from an environment variable, or from a build parameter, e.g. the Credentials Parameter type.
But you can use any type of expression, so long as it expands to the name of a "Google Service Account from private key" credential at build time. This field supports substituting environment variables in the form ${SOME_VARIABLE} at build time.
Note that variables in the form $SOME_VARIABLE are not accepted by the Credentials Plugin.
inAppUpdatePriority : String (optional)
Specifies the priority of this app release for the in-app update feature of the Google Play Core Library.
If you don't use this feature, or don't need to set a priority, you can leave this field blank; it will default to 0. Otherwise the value must be a whole number between 0 (lowest priority) and 5 (highest priority).
For more information on using in-app updates, see the documentation:
https://developer.android.com/guide/playcore/in-app-updates This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
releaseName : String (optional)
The release name, used to identify this release in the Google Play Console UI. Not required to be unique among releases. If no value is entered, Google Play will set the release name to the versionName of the app file being moved. This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
rolloutPercent : double (optional)
rolloutPercentage : String (optional)
The percentage of users in the given track to which the uploaded file(s) should be rolled out.
If you enter 100%, the app will be rolled out to all users, and the release will be considered complete, i.e. you will be unable to reduce the rollout percentage for this release.
If you enter 0%, a draft release will be created, meaning that users will not yet see it; the existing file(s) released in the given track, if any, will remain in place.
For more information on staged rollouts, see the Google Play documentation:
https://support.google.com/googleplay/android-developer/answer/6346149 This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
trackName : String (optional)
Specifies the release track to which the given app file(s) will be re-assigned.
You can enter the name of a custom track, or one of the built-in tracks:
- internal
- alpha
- beta
- production
For these tracks, you have the choice of rolling out the uploaded app files to all existing users immediately, or doing a staged rollout so that only a percentage of your existing userbase will be able to download the new version.
For more information on using the internal, alpha, beta or custom testing tracks, see the Google Play documentation:
https://support.google.com/googleplay/android-developer/answer/3131213 This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
versionCodes : String (optional)
This specifies which version codes should be assigned to a new release track.
Note that multiple entries must be comma-separated. This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.

addRelizaRelease

artId : String (optional)
artType : String (optional)
envSuffix : String (optional)
projectId : String (optional)
status : String (optional)
uri : String (optional)
useCommitList : String (optional)
version : String (optional)

submitPrData

baseBranch : String (optional)
closedDate : String (optional)
commit : String (optional)
createdDate : String (optional)
endpoint : String (optional)
envSuffix : String (optional)
mergedDate : String (optional)
number : String (optional)
projectId : String (optional)
state : String (optional)
targetBranch : String (optional)
title : String (optional)
uri : String (optional)
useCommitList : String (optional)

$class: 'RemoteBuildConfiguration'

abortTriggeredJob : boolean (optional)
auth2 (optional)
Using this parameter you can override the authentication used to connect to the selected remote Jenkins.
- Don't Override
  The authentication configured in the (global) settings of the selected 'remote host' is used.
- Token Authentication
  The specified user id and Jenkins API token is used.
- Credentials Authentication
  The specified Jenkins Credentials are used. This can be either user/password or user/API Token.
- No Authentication
  No Authorization header will be sent, independent of the global 'remote host' settings.
- Bearer Authentication
  The bearer token is used.
Note: Jenkins API Tokens are recommended since, if stolen, they allow access only to a specific Jenkins while user and password typically provide access to many systems.
- BearerTokenAuth
  - token (optional)
    - Type: class hudson.util.Secret
- CredentialsAuth
  - credentials : String (optional)
- NoneAuth
- NullAuth
- TokenAuth
  - apiToken (optional)
    - Type: class hudson.util.Secret
  - userName : String (optional)
blockBuildUntilComplete : boolean (optional)
disabled : boolean (optional)
Set this field to disable the job step instead of removing it from job configuration.
enhancedLogging : boolean (optional)

Enable Enhanced Logging
If this option is enabled, the console output of the remote job is also logged.
httpGetReadTimeout : int (optional)
httpPostReadTimeout : int (optional)
job : String (optional)

Remote Job Name or full URL.
The name or URL of the job on the remote Jenkins host which you would like to trigger. If the full job URL is specified the URL of the remote Jenkins host configured above will be ignored.
maxConn : int (optional)
The max concurrent connections to the remote host, default is 1, max is 5. It'll be 5 even if you set it greater than 5. Note: Set this field with caution, too many concurrent requests will not only fail your local jobs,
but also block the remote server.
overrideTrustAllCertificates : boolean (optional)
parameters : String (optional)
parameters2 (optional)
Job Parameters
Parameters which will be used when triggering the remote job.
If no parameters are needed, then just leave this blank.
- Map parameters
  This is the recommended type. It allows you to provide parameters with key/value and supports multi-line parameters.
- String parameters (legacy)
  This type allows to describe parameters within a big string like in versions 3.1.5 and lower. It does not support multi-line parameters.
- File parameters (legacy)
  This type allows to describe parameters within a file like in versions 3.1.5 and lower. It does not support multi-line parameters.
- FileParameters
  - filePath : String (optional)
- MapParameters
  - parameters (optional)
    - name : String (optional)
    - value : String (optional)
- StringParameters
  - parameters : String (optional)
pollInterval : int (optional)
preventRemoteBuildQueue : boolean (optional)
remoteJenkinsName : String (optional)
remoteJenkinsUrl : String (optional)
It is possible to override the Remote Jenkins URL for each Job separately.
shouldNotFailBuild : boolean (optional)

Do Not Fail If Remote Fails
If this option is enabled, the build will not fail even if the remote build fails.
token : String (optional)

Remote Job Token
Security token which is defined on the job of the remote Jenkins host.
If no job token is needed to trigger this job, then just leave it blank
trustAllCertificates : boolean (optional)

Trust all certificates

It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately. Setting this checkbox to 'true' will result in accepting all certificates for the given Job.

If your remote Jenkins host has a self-signed certificate or its certificate is not trusted, you may want to enable this option. It will accept untrusted certificates for the given host.

This is unsafe and should only be used for testing or if you trust the host.
useCrumbCache : boolean (optional)
Set this field to enable cache of the crumb of remote server.
It'll be more efficient for the local job execution & more stable for remote server when massive concurrent jobs are triggered.
This cache will be cleared every 10 minutes.
useJobInfoCache : boolean (optional)
Set this field to enable cache of the job info of remote server.
It'll be more efficient for the local job execution & more stable for remote server when massive concurrent jobs are triggered.
This cache will be cleared every 10 minutes.

crxReplicate

Asynchronously replicate CRX Content Packages from one-or-more configured Adobe Granite repositories to wherever their replication agents may take them. This is probably not the most deterministic way to install packages on publish servers, so prefer using the "Deploy Content Packages" step if possible.

packageIds : String (optional)
Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version".

This field supports parameter tokens.
baseUrls : String (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

Multiple urls can be specified, one per line. All specified packages will be replicated from one server before beginning replications from the next one.

If login credentials for one of the servers are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http://deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:

http://deployer:Password123@localhost:4502

This field supports parameter tokens.
credentialsId : String (optional)
Select the login credentials with which content packages will be replicated from the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
ignoreErrors : boolean (optional)
Check this box to ignore errors during replication such that the build continues after completion of this step.
requestTimeout : long (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
serviceTimeout : long (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
waitDelay : long (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.

acmRepoSync

url : String
credentialsId : String
force : boolean (optional)

$class: 'ReqtifyGenerateReport'

Creation of a report. The plugin will find a .rqtf file in the workspace and make a report. You can choose:

The name of report
The model of report
The template of report

reportArgumentList : Array / List of String
nameReport : String (optional)
modelReport : String (optional)
templateReport : String (optional)

$class: 'RetrieveArtifactsBuildStep'

token : String (optional)
names (optional)
- name : String (optional)
stage : String (optional)
variableName : String (optional)

publishReview

downloadOnly : boolean
installRBTools : boolean

$class: 'ReviewboardApplyPatch'

Should be used with Reviewboard Url Parameter and should be a pre-build step. If auto-apply patch is disabled in plugin configuration, this will invoke the default diff4j patch application. If auto-apply is on (default) - nothing will happen.

$class: 'ReviewboardPollingBuilder'

reviewbotJobName : String
checkBackPeriod : String
reviewbotRepoId : String
restrictByUser : boolean
disableAdvanceNotice : boolean

$class: 'RigorBuilder'

credentialsId : String
Please select a credential of Kind Rigor API Key here.

Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
performanceTestIds : String
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.

If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
failOnSnapshotError : boolean
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
failOnResults : boolean
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
performanceScore : String
Optional

Fail the build if any test reports an overall performance score lower than this value (1-100)
criticalNumber : String
Optional

Fail the build if any test has more than this # of critical first party content defects found.

Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
foundDefectIds : String
Optional

Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.

Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
enforcePerformanceBudgets : boolean
Optional

Fail the build if any test exceeds its performance budgets
totalContentSize : String
totalFoundItems : String
testTimeoutSeconds : String
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).

This value is only used if Fail build based on test results is enabled.

snRollbackApp

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance where the application is installed.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
appScope : String (optional)
Required if application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
appSysId : String (optional)
Required if application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
rollbackAppVersion : String (optional)
Expected rollback version. This version is compared to the version that is included in the last rollback context, if they don't match, the build step fails.
If empty, installed version from previous step will be taken.
url : String (optional)
ServiceNow instance url where the application was installed.

$class: 'RollbackBuilder'

changeLogFile : String (optional)
changeLogParameters : String (optional)
contexts : String (optional)
Liquibase contexts to execute under.
credentialsId : String (optional)
installationName : String (optional)
labels : String (optional)
Liquibase labels to execute
liquibasePropertiesPath : String (optional)
A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
numberOfChangesetsToRollback : String (optional)
password : String (optional)
resourceDirectories : String (optional)
Leave blank for workspace root. May be relative to workspace or an absolute path.
rollbackLastHours : String (optional)
rollbackToDate : String (optional)
rollbackToTag : String (optional)
rollbackType : String (optional)
url : String (optional)
example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
username : String (optional)

snRollbackPlugin

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here).
This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
pluginId : String (optional)
Unique identifier of the plugin. You can locate this identifier on the Plugins page within the card of the desired plugin; identified with the name "ID".
url : String (optional)
ServiceNow instance url. This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.

$class: 'RqmBuilder'

collectionStrategy
Select an operating mode for fetching test cases in RQM. Currently only the operating mode to find test cases based on a Test Suite Execution Record is available
- $class: 'RqmTestSuiteExectionRecordCollectionStrategy'
  - executionRecordName : String
    Specify the name of the test suite excution record to look for.
  - planName : String
    TODO supply a title
    TODO write content
  - projectName : String
    The RQM Project area the test suite execution record is found in.
iterativeTestCaseBuilders : Array / List of Build Step (hudson.tasks.BuildStep)
For each test case found. Execute the buildsteps added here. Injecting environment variables as we go.
preBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
Run this right before the iterative build steps starts executing.
postBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
Run this right after the iterative build steps have been executed.
credentialId : String

$class: 'RubyMotionBuilder'

platform : String
rakeTask : String
outputStyle : String
outputFileName : String
useBundler : boolean
installCocoaPods : boolean
needClean : boolean
outputResult : boolean
deviceName : String
simulatorVersion : String
envVars : String

$class: 'RunApplicationAction'

applicationName : String

Application selection is mandatory

Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
actionName : String

Application Action selection is mandatory
runtimeVariables : String

Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.

runFromAlmBuilder

almServerName : String
almCredentialsScope : String
Select the scope of the credentials used for connecting to the specified ALM Server:
- Job (local) credentials: This option requires to provide the credentials right here at job level.
- System (global) credentials: This option allows the selection of UserName or ClientID from a dropdown list with global credentials.
almUserName : String
almPassword : String
almDomain : String
almProject : String
almTestSets : String
List of test sets to run. Each line contains a path to a test set or a test set folder.
For example: Root\subFolder1\subFolder2\testSetToRun .
In case you want to parameterize the tests please specify the parameters and their values like:
Root\subFolder1\subFolder2\testSetToRun "Parameter1":"&ltstringvalue>",..., "ParameterN":&ltnumbervalue>
Also, for better specification of parameters you may use the "Specify test parameters" section below.
almRunResultsMode : String
almTimeout : String
Number of seconds before timeout. If left empty timeout is unlimited.
almRunMode : String
Defines how the test set is executed:
- Run locally: The test set is run on the machine that performs the build.
- Run remotely: The test set is run on the host defined in the Testing Tool host field.
- Run on planned host: The test set is run on the host defined in ALM.
almRunHost : String
If the Run mode field is set to Run remotely, use this field to specify the name of the host that runs the test set.
almClientID : String
almApiKey : String
isSSOEnabled : boolean
Obtain the Client ID and API key secret from your ALM site administrator.
areParametersEnabled : boolean
specifyParametersModel
- parameterJson : String
isFilterTestsEnabled : boolean (optional)
filterTestsModel (optional)
- blockedCheckbox : boolean
- failedCheckbox : boolean
- notCompletedCheckbox : boolean
- noRunCheckbox : boolean
- passedCheckbox : boolean
- testName : String (optional)
almServerSettingsModel (optional)
- almServerName : String
- almServerUrl : String
- almCredentials
  - almUsername : String
  - almPassword : String
- almSSOCredentials
  - almClientID : String
  - almApiKeySecret : String

runFromCodelessBuilder

runFromFSBuilder

fsTests : String
List of tests or folders that contain tests, to run. Each line should contain a single test, folder, or MTB file.
In case you want to parameterize the tests please specify the parameters and their values like:
&ltTestPath> "Parameter1":"&ltstringvalue>",..., "ParameterN":&ltnumbervalue>
Also, for better specification of parameters you may use the "Specify test parameters" section below.
areParametersEnabled : boolean
specifyParametersModel
- parameterJson : String
fileSystemTestSetModel
- fileSystemTestSet
  File system test set help.
  - tests : String
    List of tests or folders that contain tests, to run. Each line should contain a single test, folder, or MTB file.
  - parallelRunnerEnvironments
    - environment : String
      Environment help string.
    - environmentType : String
summaryDataLogModel
- logVusersStates : boolean
  Display the number of virtual users in each state.
- logErrorCount : boolean
  Display the number of controller errors.
- logTransactionStatistics : boolean
  Display the number of passed transactions, failed transactions and hits per second.
- pollingInterval : String
  The rate at which the messages are displayed (in seconds). Default value is 10 seconds.
scriptRTSSetModel
- scripts
  - scriptName : String
    The script name is found in Controller's Script Information dialog (Percentage Mode scenario) or Group Information dialog (Vuser Group Mode scenario).
  - additionalAttributes
    - name : String
    - value : String
    - description : String
isParallelRunnerEnabled : boolean (optional)
Note: This mode is for UFT GUI test only.With it enabled, you can define multiple tests and the environments to run with.

UFT will run on those environments in parallel(at most 4 environments simultaneously) for each test.

Disabling this option will switch back to the normal view with the tests kept.
uftSettingsModel (optional)
- selectedNode : String (optional)
  Please select the corresponding slave machine setup in the main job configuration.
- numberOfReruns : String (optional)
  Defines the maximum amount of test set reruns.
- cleanupTest : String (optional)
  Test executed before the re-run process of the failed tests.
- onCheckFailedTest : String (optional)
- fsTestType : String (optional)
  Select which test category will run again when build fails. The user can rerun the entire set of tests or only the failed tests from the suite. If just certain tests fail, then only the selected tests will rerun.
- rerunSettingsModels (optional)
  - test : String (optional)
  - checked : boolean (optional)
  - numberOfReruns : int (optional)
  - cleanupTest : String (optional)
analysisTemplate : String (optional)
Apply a template for the build (path to a .tem file). Leave blank in order to use the default template.
authModel (optional)
- mcUserName : String
- mcPassword : String
- mcTenantId : String
- mcExecToken : String
- value : String
controllerPollingInterval : String (optional)
Polling interval for checking the scenario status, in seconds. The default is 30 seconds.
displayController : String (optional)
Display the controller while the scenario is running.
fsAutActions : String (optional)
fsDeviceId : String (optional)
fsDevicesMetrics : String (optional)
fsExtraApps : String (optional)
fsInstrumented : String (optional)
fsJobId : String (optional)
fsLaunchAppName : String (optional)
fsManufacturerAndModel : String (optional)
fsOs : String (optional)
fsReportPath : String (optional)
The directory where the test results will be saved. If this is left empty the default directory will be used.
fsTargetLab : String (optional)
fsTimeout : String (optional)
Timeout value in seconds. If left empty, there is no timeout.
fsUftRunMode : String (optional)
ignoreErrorStrings : String (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%"
mcServerName : String (optional)
The Mobile Center host address.
outEncoding : String (optional)
The encoding charset to be used when printing the text in the Console Output. The field is optional and the default value is UTF-8. The type UTF-16 is equivalent to Unicode.
perScenarioTimeOut : String (optional)
The maximum time allotted for scenario execution, in minutes.
proxySettings (optional)
- fsUseAuthentication : boolean
- fsProxyAddress : String
- fsProxyUserName : String
- fsProxyPassword : String
resultFileNames (optional)
- Type: java.util.Map<java.lang.Long, java.lang.String>
useSSL : boolean (optional)

$class: 'RunInCloudBuilder'

projectId : String

The Bitbar Cloud project in which to start the new test run.
appPath : String
testPath : String
dataPath : String
testRunName : String
scheduler : String
testRunner : String
deviceGroupId : String
language : String
screenshotsDirectory : String
keyValuePairs : String
withAnnotation : String
withoutAnnotation : String
testCasesSelect : String
testCasesValue : String
failBuildIfThisStepFailed : boolean
virusScanTimeout : String
waitForResultsBlock
- testRunStateCheckMethod (optional)
  - Values: HOOK_URL, API_CALL
- downloadScreenshots : boolean (optional)
- forceFinishAfterBreak : boolean (optional)
- hookURL : String (optional)
- resultsPath : String (optional)
- waitForResultsTimeout : int (optional)
testTimeout : String
credentialsId : String
cloudUrl : String
cloudUIUrl : String
frameworkId : long
osType
- Values: IOS, ANDROID, DESKTOP, UNDEFINED

osfBuilderSuiteForSFCCRunJob

hostname : String (optional)
ocCredentialsId : String (optional)
ocVersion : String (optional)
jobName : String (optional)
jobArguments (optional)
- name : String
- value : String
waitForJobToFinish : boolean (optional)

$class: 'RunLoadRunnerScript'

scriptsPath : String

$class: 'RunMatlabBuildBuilder'

tasks : String (optional)
Insert a space-separated list of tasks to run in the Tasks box. If not specified, the action runs the default tasks in buildfile.m as well as all the tasks on which they depend.
Example: test
Example: compile test

Note:
- MATLAB exits with exit code 0 if the tasks run without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the step to fail.
- To use the Run MATLAB Build step, you need MATLAB R2022b or a later release.

$class: 'RunMatlabCommandBuilder'

matlabCommand : String (optional)
Insert the MATLAB commands you want to execute in the Command box. If you need to specify more than one command, use a comma or semicolon to separate the commands.
Example: results = runtests, assertSuccess(results);

If you need to specify several MATLAB commands, consider writing a MATLAB script or function and executing this script or function instead. (To run a script or function, do not specify the file extension.)
Example: myscript

Note:
- The build fails if the execution of any command results in an error.
- If the build uses a MATLAB version prior to R2020a, MATLAB might display non-ASCII characters, specified in the Command box, as garbled text. If you specify non-ASCII characters in your commands, consider running your commands as a .m or .mlx file created in the same locale that MATLAB uses on the build agent

$class: 'RunMatlabTestsBuilder'

coberturaArtifact (optional)

Generate a code coverage report in Cobertura XML format. By default, MATLAB names the artifact cobertura.xml and stores it in the matlabTestArtifacts folder of the project workspace. To override the default artifact name and location, specify a path relative to the project folder in the File path box. If the text box is empty, MATLAB does not generate an artifact.
- coberturaReportFilePath : String
junitArtifact (optional)

Generate a test report in JUnit XML format. By default, MATLAB names the artifact junittestresults.xml and stores it in the matlabTestArtifacts folder of the project workspace. To override the default artifact name and location, specify a path relative to the project folder in the File path box. If the text box is empty, MATLAB does not generate an artifact.
- junitReportFilePath : String
loggingLevel : String (optional)

Maximum verbosity level for logged diagnostics included for the test run.
modelCoverageArtifact (optional)

Generate a model coverage report in Cobertura XML format. This artifact includes coverage results for Simulink® models that are tested using Simulink Test™. By default, MATLAB names the artifact coberturamodelcoverage.xml and stores it in the matlabTestArtifacts folder of the project workspace.

Note: This feature requires a Simulink Coverage™ license and is supported only in MATLAB R2018b or a newer release.
- modelCoverageFilePath : String
outputDetail : String (optional)

Display level for event details output by the test run.
pdfReportArtifact (optional)

Generate a test report in PDF format. By default, MATLAB names the artifact testreport.pdf and stores it in the matlabTestArtifacts folder of the project workspace. To override the default artifact name and location, specify a path relative to the project folder in the File path box. If the text box is empty, MATLAB does not generate an artifact.

Due to Jenkins Content Security Policy rules, the generated report might not open properly from within the Jenkins workspace. Consider copying the report to a location outside the workspace and opening it from there. For more information, see Configuring Jenkins Content Security Policy.

Note: On macOS platforms, this feature is supported in MATLAB R2020b and later.
- pdfReportFilePath : String
selectByFolder (optional)

Specify the location of folders used to select test suite elements, relative to the project root folder. To generate a test suite, the plugin uses only the tests in the specified folders and their subfolders.
Paste the test folder path in the text box. To add more folders, click Add folder.
- testFolderPaths
  - testFolders : String
selectByTag (optional)

Specify the test tag used to select test suite elements. To generate a suite, the plugin uses only the test elements with the specified tag.
- testTag : String
sourceFolder (optional)

Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.

Paste the source folder path in the Folder path box. To add more folders, click Add folder.
- sourceFolderPaths
  - srcFolderPath : String
stmResultsArtifact (optional)

Export Simulink Test™ Manager results in MLDATX format. By default, MATLAB names the artifact simulinktestresults.mldatx and stores it in the matlabTestArtifacts folder of the project workspace. To override the default artifact name and location, specify a path relative to the project folder in the File path box. If the text box is empty, MATLAB does not generate an artifact.

Note: This feature requires a Simulink Test license and is supported only in MATLAB R2019a or a newer release.
- stmResultsFilePath : String
strict : boolean (optional)

Whether to apply strict checks when running the tests. For example, the framework generates a qualification failure if a test issues a warning.
tapArtifact (optional)

Generate a test report in TAP format. By default, MATLAB names the artifact taptestresults.tap and stores it in the matlabTestArtifacts folder of the project workspace. To override the default artifact name and location, specify a path relative to the project folder in the File path box. If the text box is empty, MATLAB does not generate an artifact.
- tapReportFilePath : String
useParallel : boolean (optional)

Whether to run tests in parallel. This feature requires a Parallel Computing Toolbox license, and might not be compatible with other options. If incompatible, testing occurs in serial regardless of the value of this feature.

$class: 'RunPcTestBuildStep'

almPassword : String (optional)
HP ALM user's password. If set, this value overrides the value from Bumblebee Global Configuration.
If empty, value from Bumblebee Global Configuration will be used
almUser : String (optional)
HP ALM user. If set, this value overrides the value from Bumblebee Global Configuration.
If empty, value from Bumblebee Global Configuration will be used
domain : String (optional)
HP ALM Domain.
failIfTaskFails : boolean (optional)
If task shall fail the build in case it fails.
outputDir : String (optional)
Directory where Performance Center reports will be placed. Relative to the workspace root. If it does not exist, it will be created.
pollingInterval : int (optional)
Test status polling interval in seconds.
postRunActionString : String (optional)
Performance Center Post Run Action.
project : String (optional)
HP ALM Project name.
retryCollateAndAnalysisAttempts : int (optional)
Defines how many times it will retry Collate or Analyze phase if they failed, before task completely fails.
retryCollateAndAnalysisFlag : boolean (optional)
retryCollateAndAnalysisInterval : int (optional)
Number of seconds to wait between retry attempts.
retryCount : int (optional)
Number of retry attempts, before task completely fails.
retryInterval : int (optional)
Number of seconds to wait between retry attempts.
retryIntervalMultiplier : double (optional)
Increase factor for retry interval. E.g. if it is set to 2, then each subsequent wait interval between attempts will be twice bigger than the previous one.
testLabPath : String (optional)
Path to a test set in HP ALM TestLab. Must start with Root\, e.g. Root\folder1\testSet1, where Root\folder1 is a path to test lab folder and testSet1 is the name of a test set. Test set will be created if it does not exist.
testPlanPath : String (optional)
Path to a test in HP ALM TestPlan. Must start with Subject\, e.g. Subject\folder1\test1, where Subject\folder1 is a path to test folder and test1 is the name of a test.
timeout : int (optional)
The number of minutes to wait for the Performance Center test to finish. 0 means wait indefinitely.
timeslotDuration : int (optional)
Time Slot Duration in minutes.
vudsMode : boolean (optional)
If true, the test consumes Virtual User Day (VUD) licenses.

runPromotion

artifact : String (optional)
artifactType : String (optional)
keepTargetResources : boolean (optional)
keepTargetRunProfiles : boolean (optional)
plan : String (optional)
promotion : String (optional)
task : String (optional)
workspace : String (optional)

runTask

environment : String (optional)
parameters : String (optional)
task : String (optional)
workspace : String (optional)

$class: 'RunTestSetBuildStep'

domain : String
HP ALM Domain
project : String
HP ALM Project name
runMode : String
Where to run test sets: locally, on scheduled host or remotely
host : String
Host on which test sets will be executed
testSets : String
A list of test set paths to be executed. Each test set starts from a new line. Example: Root\Release\2.0
outputDirPath : String
Path to the directory where to put JUnit-like execution results. Basedir of the fileset is the workspace root. If directory does not exist, it will be created
timeOut : int
The number of minutes to wait for test sets execution. 0 means wait indefinitely

snRunTestSuite

credentialsId : String (optional)
User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be installed.
apiVersion : String (optional)
Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
browserName : String (optional)
Name of the browser to use to run the client test. This value must match what is specified in the scheduled client test runner. For additional information on scheduled client test runners, see Scheduled Client Test Runners.
Valid values:
- Any
- Chrome
- Firefox
- Edge
- IE
- Safari
browserVersion : String (optional)
Starting value of the version of the browser specified in browser_name to use to run the test. For example, if you enter "9", that would enable all 9.x.x.x versions. This value must match what is specified in the scheduled client test runner.
osName : String (optional)
Name of the operating system under which to run the test suite. This value must match what is specified in the scheduled client test runner.
osVersion : String (optional)
Starting value of the version of the operating system under which to run the test suite. For example, if you enter "8", that would enable all 8.x.x.x versions. This value must match what is specified in the scheduled client test. runner.
responseBodyFormat : String (optional)
testSuiteName : String (optional)
Required if Test suite sys_id is not specified. The name of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
testSuiteSysId : String (optional)
Required if Test suite name is not specified. The sys_id of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
url : String (optional)
ServiceNow instance url where the application will be installed.
withResults : boolean (optional)
If the checkbox is checked, then results from ServiceNow will be visible in Output Console, together with the link to the visualization on the NOW platform.

$class: 'RunUftTestBuildStep'

testPath : String
Path to a test folder or test batch file (.mtb) which shall be executed
outputDirPath : String
Path to the directory where to put JUnit-like execution results. Basedir of the fileset is the workspace root. If directory does not exist, it will be created

$class: 'RunscopeBuilder'

triggerEndPoint : String
Enter the Trigger URL for the test that you want to run on this build step. To obtain the Trigger URL for a test, from the list of Runscope API tests, select the desired test. Next, click on Settings on the left navigation pane. On the test settings, locate and copy the Trigger URL and then paste into this field.

If you need to pass any Custom Initial Variables (i.e. baseUrl=https://yourapihere.com&apiKey=abc123) or Reserved Trigger URL Parameters (i.e. runscope_region=eu2), append those to the end of your Trigger URL (followed by a quetion mark) as query string parameters. The full documentation for Trigger URLs can be found here.
accessToken : String
Enter your OAuth Personal Access Token. A personal access token is generated when you create a new Runscope application. This makes it easy to use the API without building a web flow. We suggest that you create a unique application (which generates a personal access token) that is used exclusively for this Runscope/Jenkins integration.

To obtain a new personal access token, create a new Runscope application by visiting this link. For Website and Callback URL values, just enter in any valid URL (i.e. http://localhost). The URLs will not be called. After creating the new application, copy the access token provided into your clipboard then paste the token into this field.
timeout : int
Enter timeout in seconds for test run to complete. After the test is triggered, this plugin will repeatedly poll the Runscope API (approx. every second) for the test run result. If the time it takes to complete the test exceeds this timeout value, this build step will abort and fail.

s3CopyArtifact

projectName : String
buildSelector
- downstream
  - upstreamProjectName : String
    
    Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
    
    Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
    
    Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
    
    AbstractProject based projects:
    
    Freestyle projects
    
    Multi-configuration projects
    
    Maven projects
    
    Non AbstractProject based projects:
    
    Pipeline jobs (aka. Workflow jobs)
  - upstreamBuildNumber : String
    The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
- lastWithArtifacts
- lastCompleted
- $class: 'MultiJobBuildSelector'
- buildParameter
  - parameterName : String
    Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.
    You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
- permalink
  - id : String
- $class: 'PromotedBuildSelector'
  - level : int
- latestSavedBuild
- specific
  - buildNumber : String
    While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
- lastSuccessful
  - stable : boolean (optional)
- upstream
  - allowUpstreamDependencies : boolean (optional)
  - fallbackToLastSuccessful : boolean (optional)
  - upstreamFilterStrategy (optional)
    Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
    - Values: UseGlobalSetting, UseOldest, UseNewest
- workspace
filter : String
excludeFilter : String
target : String
flatten : boolean
optional : boolean

$class: 'SASUnitPlugInBuilder'

This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.

sasunitBatch : String
Please enter the relative path to the batch file to start the SASUnit test framework.
doxygenBatch : String

Please enter the relative path to the executable to create the doxygen report
sasunitVersion : String

Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
createDoxygenDocu : boolean
In addition to SASUnit a Doxygen documentation can be created as well

$class: 'SBuild'

sbuildVersion : String
targets : String
buildFiles : String
options : String

scmSkip

deleteBuild : boolean (optional)
skipPattern : String (optional)

$class: 'SConsBuilderCommand'

sconsName : String
options : String
Specify the scons options.
variables : String
Specify the scons variables.
targets : String
Specify a list of scons targets to be invoked, or leave it empty to invoke the default scons target specified in the scons script.
rootSconsscriptDirectory : String
Root Sconscript directory, i.e -C rootDirectory; this option can be used to use build files in a subdirectory.
commandScript : String
Specify the content of the SCons script. A generated Sconstruct will be generated and inked.

$class: 'SConsBuilderScriptFile'

For projects that use SCons as the build system. This causes Jenkins to invoke SCons with the given targets, variables and options. Any non-zero exit code causes Hudson to mark the build as a failure.
The command synopsis is scons [ options] [ name=val... ] [ targets]
scons searches for a file named SConstruct, Sconstruct, or sconstruct (in that order) in the current directory and reads its configuration from the first file found.

sconsName : String
options : String
Specify the scons options.
variables : String
Specify the scons variables.
targets : String
Specify a list of scons targets to be invoked, or leave it empty to invoke the default scons target specified in the scons script.
rootSconsscriptDirectory : String
Root Sconscript directory, i.e -C rootDirectory; this option can be used to use build files in a subdirectory.
sconsscript : String
If your build requires a custom file -f newSconscript, specify it here. By default, scons searches for a file named SConstruct, Sconstruct, or sconstruct (in that order) in the root directory; this option can be used to use build files with a different name

$class: 'SMABuilder'

validateEnabled : boolean
Indicate whether you would like to perform a test deployment only.
username : String
The Salesforce user that will perform the deployment.
password : String
The password for the user you provided above.
securityToken : String
The security token for the user.

You can leave this field blank if you do not use security tokens in your organization.
serverType : String
The instance type of Salesforce that you are deploying against.
testLevel : String
The test level you wish to perform this deployment at.

- None: No tests will be run during this deployment.
- Relevant: the RunSpecifiedTests level. Jenkins will use the information provided in the Run Test Regex field under the System Configuration section to determine which set of tests need to be run for this particular deployment. A warning will be generated in Jenkins log if no relevant test is found for a particular ApexClass.
- Local: All unit tests are run, excluding those found in managed packages.
- All: All unit tests are run, including those found in managed packages.
prTargetBranch : String

If this job is configured to deploy or validate pull requests, specify what the target branch will be (e.g. "develop").

SMA will use this information to generate the appropriate delta as pull requests must be handled differently.

$class: 'SQLPlusRunnerBuilder'

credentialsId : String
user : String
Inform schema user information (example: SCOTT) or schema user and password (example: SCOTT/TIGER). You can use global variable like ${USER}.
password : String
isSysdba : String
instance : String
Inform instance information (example: ORCL). You can use global variable like ${INSTANCE}.
scriptType : String
script : String
This is the name of SQL script, expected at src/main/resources folder.
Example:
update.sql or sql/update.sql
scriptContent : String
This is a custom SQL script.
Example:

SELECT sysdate from dual;
show user;
customNLSLang : String (optional)
NLS_LANG is an environment variable used to define language, territory and character set properties. Example: AMERICAN_AMERICA.US7ASCII or FRENCH_CANADA.WE8ISO8859P1 Source: ORAFAQ
customOracleHome : String (optional)
Using custom ORACLE_HOME will override global ORACLE_HOME. Leave this field blank to use global ORACLE_HOME. ORACLE_HOME refers to either a directory where the Oracle software is installed or an environment variable pointing to the directory where the Oracle software is installed. Source: ORAFAQ
customSQLPath : String (optional)
SQLPATH contains the name of your directory for your SQL script collection. Example: c:\u01\app\sql_scripts or /oracle/app/sql Source: DBA Oracle
customSQLPlusHome : String (optional)
Using custom SQL*Plus will help find SQL*Plus executable file, this helps if you are working with Jenkins agent machines. Example: C:\Oracle\App\Server\Oracle\bin\sqlplus.exe or /oracle/app/oracle/product/12.1.0/dbhome_1/bin/sqlplus Learn more about distributed builds
customTNSAdmin : String (optional)
Using custom TNS_ADMIN refers to a directory where the Oracle SQL*Net configuration files (like sqlnet.ora and tnsnames.ora) are located. Example: C:\Oracle\App\Server\Oracle\network\admin or /oracle/app/oracle/product/12.1.0/dbhome_1/network/admin Source: ORAFAQ

$class: 'SSHBuilder'

siteName : String
command : String
execEachLine : boolean

Execute each line in the script individually.

By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.

This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.

If unsure, leave this box unchecked.
hideCommand : boolean (optional)

$class: 'SaltAPIBuilder'

authtype : String
clientInterface
- hook
  - post : String
    Publish JSON object as 'post' data, see upstream documentation. . Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - tag : String
    Specify salt event tag for message. The event tag is prefixed with salt/netapi/hook, see upstream documentation. Paramaterized variables should be specified in the format {{VARNAME}}.
- batch
  - function : String
    Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - arguments : String
    Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
    Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
  - batchSize : String
    Specify salt batch size. Example: 10 or 10%
  - batchWait : String
    Optionally specify time to wait between batches of minions.
  - target : String
    Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - targettype : String
- local
  - function : String
    Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - arguments : String
    Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
    Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
  - target : String
    Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - targettype : String
  - blockbuild : boolean (optional)
  - jobPollTime : int (optional)
  - minionTimeout : int (optional)
- subset
  - function : String
    Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - arguments : String
    Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
    Pillar values should be passed in as an argument, with the pillar string surrounded in double or single quotes, and the values single or double quoted: "pillar={artifact: 'somevalue3', repo: 'othervalue:4'}"
  - subset : String
    Execute the routine on a random subset of the targeted minions. Paramaterized variables should be specified in the format {{VARNAME}}.
  - target : String
    Specify salt target as defined in the salt documentation. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - targettype : String
- runner
  - function : String
    Specify salt function such as test.ping or cmd.run. Paramaterized Build variables should be specified in the format {{VARNAME}}.
  - arguments : String
    Specify salt function arguments space separated. Paramaterized Build variables should be specified in the format {{VARNAME}}. Python lists should be quoted: pkgs="[package1, package2]".
  - mods : String
    Specify runner mods value. Used in state.orchestrate function to specify the name of the orchestrate module
    Paramaterized Build variables should be specified in the format {{VARNAME}}
  - pillarvalue : String
    Specify runner pillar value. Used in state.orchestrate functions. Ex: {"key": "value"}
    Paramaterized Build variables should be specified in the format {{VARNAME}}
credentialsId : String
servername : String (optional)
Salt servername. In the form: https://host.domain:8000
The Test Connection process is run from the Jenkins master. If the build is localized to an agent, and the servername is specific to that agent, then Test Connection will likely fail, while the actual build may succeed.
saveEnvVar : boolean (optional)
saveFile : boolean (optional)
skipValidation : boolean (optional)

$class: 'SbtPluginBuilder'

name : String
jvmFlags : String
sbtFlags : String
Add flags to SBT launcher. One recommended (and default) flag is the -Dsbt.log.noformat=true flag which keeps the SBT output clean.
actions : String
subdirPath : String
Subdirectory path relative to workspace to run sbt in.

$class: 'ScanBuilder'

scanURL : String
apiKey
- Type: class hudson.util.Secret
source : String
exclude : String
rule : String
timeout : int
isAbortBuild : boolean
isPrivateScan : boolean
isShowBlockedOnly : boolean
isCreateLog : boolean

$class: 'ScriptBuildStep'

buildStepId : String
defineArgs : boolean
buildStepArgs
- arg : String
tokenized : boolean
Decomposes the given value of each argument into multiple arguments by splitting at whitespaces.

$class: 'ScriptBuilder'

scriptFilePath : String
Required parameter. File path to the build script.
credentialsId : String
Optional parameter. Credentials to a Turbo account which will be used to execute the build script.
hubUrl : String
Optional parameter. The hub server to use. Example: https://turbo.net.
imageName : String
Optional parameter. Name of the image.
vmVersion : String
Optional parameter. The Turbo VM version to run the container with.
containerWorkingDir : String
Optional parameter. Initial working directory inside the container.
mountSettings
- sourceContainer : String
- sourceFolder : String
- targetFolder : String
routeFile : String
Optional parameter. Path to the routing rules file.
noBase : boolean
overwrite : boolean
Overwrite existing image.
diagnostic : boolean
Enable diagnostic logging.

$class: 'SealightsCLIBuildStep'

enabled : boolean
failBuildIfStepFail : boolean

commandMode

Nested Choice of Objects

$class: 'ConfigView'

appName : String
branchName : String
buildName
- $class: 'DefaultBuildName'
- $class: 'EmptyBuildName'
- $class: 'LatestBuildName'
- $class: 'ManualBuildName'
  - insertedBuildName : String
- $class: 'UpstreamBuildName'
  - upstreamProjectName : String
labId : String
buildSessionId : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).

techOptions
- $class: 'DotNetOptions'
  - namespacesIncluded : String
  - namespacesExcluded : String
  - includedFilePatterns : String
  - excludedFilePatterns : String
- $class: 'JavaOptions'
  - packagesIncluded : String
  - packagesExcluded : String

$class: 'EndView'

buildSessionId : String
labId : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
appname	Override default app name coming from build session id
buildname	Override default build name coming from build session id
branchname	Override default branch name coming from build session id

$class: 'ExternalReportView'

report : String
buildSessionId : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
appname	Override default app name coming from build session id
buildname	Override default build name coming from build session id
branchname	Override default branch name coming from build session id

$class: 'PrConfigView'

appName : String
branchName : String
buildName
- $class: 'DefaultBuildName'
- $class: 'EmptyBuildName'
- $class: 'LatestBuildName'
- $class: 'ManualBuildName'
  - insertedBuildName : String
- $class: 'UpstreamBuildName'
  - upstreamProjectName : String
labId : String
buildSessionId : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).

techOptions
- $class: 'DotNetOptions'
  - namespacesIncluded : String
  - namespacesExcluded : String
  - includedFilePatterns : String
  - excludedFilePatterns : String
- $class: 'JavaOptions'
  - packagesIncluded : String
  - packagesExcluded : String
latestCommit : String
pullRequestNumber : String
repoUrl : String
targetBranch : String

$class: 'StartView'

testStage : String
buildSessionId : String
labId : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
appname	Override default app name coming from build session id
buildname	Override default build name coming from build session id
branchname	Override default branch name coming from build session id

$class: 'UploadReportsView'

reportFiles : String
reportsFolders : String
source : String
buildSessionId : String
labId : String

additionalArguments : String

This section allows you to add additional arguments, as key-value pairs.
Example for additional arguments:

server=https://prod-sealights-gw.sealights.co
proxy=http://localhost:8888

Argument name	Description
token	The token provided to you by SeaLights (override the global 'token' value for this build).
tokenfile	A file containing the token provided to you by SeaLights (override the global 'token' value for this build).
proxy	A valid URL to a proxy server.
agentpath	Override the path to SeaLights jar.
javapath	Override the path to the 'java' variable (default is 'java').
filesstorage	A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build).
appname	Override default app name coming from build session id
buildname	Override default build name coming from build session id
branchname	Override default branch name coming from build session id

cliRunner
- Type: class io.sealights.plugins.sealightsjenkins.buildsteps.cli.CLIRunner
logDestination
- Values: CONSOLE, FILE
logFolder : String
logLevel
- Values: OFF, INFO, DEBUG, WARN, ERROR
logFilename : String

$class: 'SeleniumAutoExecBuilder'

serverUrl : String

$class: 'SeleniumBuilderBuilder'

scriptFile : String
parallelSettings
- threadPoolSize : int

$class: 'SemanticVersioningBuilder'

parser : String
Determines which build file parser will be used for the project.
namingStrategy : String
useJenkinsBuildNumber : boolean
If checked the current Jenkins Build Number will be used instead of any value in the build number portion of the version string found in the project file. Defaults to true. Note: The build files are not modified by the plugin.
envVariable : String

$class: 'SendMessageBuildStep'

message : String
filepath : String
recipients
- id : String

sensediaApiDeploy

enviromentName : String
revision : String

sensediaApiJson

apiId : String

sensediaApiQA

revisionNumber : int
destination : boolean
logInterceptor : boolean
resourceOutOfSize : boolean
resourceSize : int

shell

Runs a shell script (defaults to sh , but this is configurable) for building the project. The script will be run with the workspace as the current directory. Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh —, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl ) or control the options that shell uses.

By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.

As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.

command : String

configuredLocalRules (optional)

Array / List of Nested Choice of Objects

retainOnlyVariables

Limit which environment variables are passed to a build step.

Environment variables passed to the build step are filtered, unless listed below.

The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:

If the environment variable originates from Jenkins configuration, such as JOB_URL , it will not be passed to the build step unless specified here.
If the environment variable originates from outside Jenkins, such as PATH , the behavior depends on the option Process environment variables handling : If that option is set to Retain , the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove , the variable will not be passed to the build step.

The following table shows the effect of filtering on an environment variable:

Behavior	Originally defined outside Jenkins	Originally defined inside Jenkins
Process environment variables handling: reset	Variable is reset to original value	Variable is removed
Process environment variables handling: removed	Variable is removed	Variable is removed

processVariablesHandling (optional)
- Values: RESET, REMOVE
retainCharacteristicEnvVars : boolean (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
variables : String (optional)

Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.

unstableReturn : int (optional)
If set, the shell exit code that will be interpreted as an unstable build result. If the exit code matches the value, the build results will be set to 'unstable' and next steps will be continued. On Unix-like it is a value between 0-255. The value 0 is ignored and does not make the build unstable to keep the default behaviour consistent.

$class: 'SideeX'

protocolMenu

The default protocol is "HTTP".

Use "HTTPS (Disable certificate checking)" to disable certificate checking.

Use "HTTPS (Enable certificate checking)" to enable certificate checking.
- $class: 'HTTPItem'
  - baseURL : String
    Your WebService base URL.
- $class: 'HTTPSDisableItem'
  - baseURL : String
    Your WebService base URL.
- $class: 'HTTPSEnableItem'
  - baseURL : String
    Your WebService base URL.
  - caFilePath : String
    Your certificate file path.
stateTime : String
testCaseFilePath : String
Your test case's file path (path to your folder or to your .zip file)

sigma

commandLine : String (optional)

The command line arguments to execute for Rapid Scan Static which override the default analyze command. This allows for any Rapid Scan Static command line options to be specified.

If this field is empty the default command will be:

'sigma analyze --format jenkins'
ignorePolicies : boolean (optional)

Prevents Rapid Scan Static from failing the build based on violated policies.
If selected, then the '--ignore-policies' command line argument will be added to the Rapid Scan Static analyze sub-command.
sigmaToolName : String (optional)

Select the name of the Rapid Scan Static tool installation to execute Rapid Scan Static with this build step.

signAndroidApks

androidHome : String (optional)
Override the path of the Android SDK installation this build step should use to find the zipalign tool. You can also set the ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g., /usr/local/android-sdk.
apksToSign : String (optional)
An Ant-style glob, or multiple comma-separated globs, selecting the APK files relative to the workspace. For example, myApp/build/outputs/apk/myApp-unsigned.apk or **/*-unsigned.apk or app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
archiveSignedApks : boolean (optional)
Check this option to add all signed APKs this build step generates to the build's archived artifacts. If you don't want this step to archive the signed APK artifacts, downstream build steps can access signed APKs in the workspace at paths like SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where myApp-unsigned.apk is a directory named for the input unsigned APK.
archiveUnsignedApks : boolean (optional)
Check this option to add all input unsigned APKs to the build's archived artifacts. These will be the APK files selected with glob pattern(s) of the APKs to Sign setting.
keyAlias : String (optional)
The entry name of the private key/certificate chain you want to use to sign your APK(s). This entry must exist in the key store credentials the Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
keyStoreId : String (optional)
The ID of a certificate credential. This build step expects the referenced certificate credential to be a password-protected PKCS12 file containing a key protected by the same password. See this plugin's script if you need help creating such a key store to add to Jenkins, or Google how to convert your Android release key to a PKCS12 file.
signedApkMapping (optional)
- unsignedApkNameDir
- unsignedApkSibling
skipZipalign : boolean (optional)
Skip the Zipalign step of signing the APK(s). This is primarily for the case of signing debug APKs, for which the zipalign command fails.
zipalignPath : String (optional)
Override the full path of the Android zipalign executable this build step should use to align the target APKs. You can also set the ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g., /opt/android-tools/bin/zipalign

venafiCodeSignWithSignTool

tppName : String
The Venafi Trust Protection Platform (TPP) to use for signing. You can define TPPs under "Manage Jenkins" -> "Configure System" -> "Venafi Code Signing".
fileOrGlob : String
A path or a glob that specifies the file(s) to be signed.
credential
- credentialsId : String
appendSignatures : boolean (optional)
If the target file(s) already have signatures, then append a new signature instead of overwriting the existing signatures.
extraArgs (optional)
This plugin invokes Signtool under the hood. Here you can specify extra custom CLI arguments to pass to Signtool.

These arguments will be appended to the Signtool CLI invocation. If they overlap with any arguments implicitly passed by this plugin, then Signtool will raise an error.
- argument : String
sha1 : String (optional)
The SHA-1 hash of the certificate (inside the TPP) to use for code signing.

Normally you should use 'Signing certificate subject name' instead, but if that name is ambiguous, then use the SHA-1 hash to select a specific signing certificate.

Either a subject name or SHA-1 hash of the signing certificate must be given.
signToolPath : String (optional)
The full path to signtool.exe. If not specified, we assume that it's in PATH.
signatureDigestAlgos (optional)
The digest algorithm(s) to use to creating signatures.

If none specified, 'sha256' is used as the default algorithm. This is very secure, but may not be compatible with older Windows versions. If you need compatibility with older Windows versions, you should specify 'sha1' and 'sha256' (in that order).

When multiple digest algorithms are specified, they are applied in the order specified.
- algorithm : String
subjectName : String (optional)
The Common Name ("Issued to" or "CN") of the certificate (inside the TPP) to use for code signing.

You can obtain a list of Common Names with 'cspconfig listcertificates' and checking what comes after 'CN='.

Either a subject name or SHA-1 hash of the signing certificate must be given.
timestampingServers (optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.

If you specify more than one server, then a random one will be used.

Tip: here are some public timestamping authorities that you can use:
- http://timestamp.digicert.com
- http://timestamp.globalsign.com
- http://timestamp.comodoca.com/authenticode
- http://tsa.starfieldtech.com
- address : String
useMachineConfiguration : boolean (optional)
venafiClientToolsDir : String (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected from the registry. If that fails, we fallback to C:\Program Files\Venafi CodeSign Protect.

venafiVerifyWithSignTool

tppName : String
The Venafi Trust Protection Platform (TPP) that contains the certificate that the signed file(s) were signed by. You can define TPPs under "Manage Jenkins" -> "Configure System" -> "Venafi Code Signing".
fileOrGlob : String
A path or a glob that specifies the file(s) to be verified.
credential
- credentialsId : String
signToolPath : String (optional)
The full path to signtool.exe. If not specified, we assume that it's in PATH.
useMachineConfiguration : boolean (optional)
venafiClientToolsDir : String (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected from the registry. If that fails, we fallback to C:\Program Files\Venafi CodeSign Protect.

$class: 'SilkPerformerBuilder'

projectLoc : String
Specify the location of your project file (.ltp).

Specify the path to your slave's workspace. Usually, this will be a relative path, but under certain conditions, you might want to use an absolute path.
workload : String
Specify the workload that is to be used for the load test. If you omit this setting, the default workload is used.
successCriteria
- userType : String
  This is the user type defined in the active workload.
  
  If you select All, then the filter will be applied to all user types.
- measureCategory : String
  Select the appropriate Measure Category.
- measureType : String
  Depending on the Measure Category, the list of Measure Types varies.
- measureName : String
  For possible values see the console output.
- valueType : String
  Select the appropriate Value Type.
- operatorType : String
  Specify the operator for this criterion
- chosenValue : String
  The value you specify here, will be compared with the actual result.

SimplifyQA

api : String
token
- Type: class hudson.util.Secret

$class: 'SingleConditionalBuilder'

Use run conditions to decide whether a builder should be run.

buildStep : Build Step (hudson.tasks.BuildStep)
condition
- $class: 'AlwaysRun'
- $class: 'And'
  - conditions
    - condition
      Nested Choice of Objects
      $class: 'AlwaysRun'
      
      $class: 'And'
      
      $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
      
      $class: 'BooleanCondition'
      
      token : String
      
      $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
      
      $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
      
      $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
      
      $class: 'NeverRun'
      
      $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
      
      $class: 'Not'
      
      condition
      Nested Choice of Objects
      $class: 'AlwaysRun'
      
      $class: 'And'
      
      $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
      
      $class: 'BooleanCondition'
      
      token : String
      
      $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
      
      $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
      
      $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
      
      $class: 'NeverRun'
      
      $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
      
      $class: 'Not'
      
      $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
      
      $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
      
      $class: 'Or'
      
      conditions
      Array / List of Nested Object
      
      $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
      
      $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
      
      $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
      
      $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
      
      $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
      
      $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
      
      $class: 'Or'
      
      conditions
      Array / List of Nested Object
      
      $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
      
      $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
      
      $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
      
      $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
- $class: 'BatchFileCondition'
  - command : String
    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
    If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
- $class: 'BooleanCondition'
  - token : String
- $class: 'CauseCondition'
  Run if the current build has a specific cause (e.g triggered by SCM or timer).
  - buildCause : String
    The cause why the build was triggered. The following causes are supported:
    
    UserCause - the build was triggered by a manual interaction
    
    SCMTrigger - the build was triggered by a SCM change
    
    TimerTrigger - the build was triggered by a timer
    
    CLICause - the build was triggered by via CLI interface
    
    RemoteCause - the build was triggered via remote interface
    
    UpstreamCause - the build was triggered by an upstream project
    
    The following causes are supported if the XTrigger plugin is installed:
    
    FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
    
    URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
    
    IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
    
    ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
    
    BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
  - exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
- $class: 'DayCondition'
  - useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
  - daySelector
    For which days do you want the build to run?
    
    Weekends
    
    Saturday and Sunday
    
    Weekdays
    
    Not a weekend
    
    Select days
    
    Choose the days for which the build should run
    - $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
    - $class: 'Weekday'
    - $class: 'Weekend'
- $class: 'ExpressionCondition'
  - expression : String
    The regular expression used to match the label - Java regular expression syntax
  - label : String
    The label that will be tested by the regular expression
- $class: 'ExtendedCauseCondition'
  - condition
    - $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
    - $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
  - exclusiveCause : boolean
    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
- $class: 'FileExistsCondition'
  - file : String
  - baseDir
    - $class: 'ArtifactsDir'
    - $class: 'JenkinsHome'
    - $class: 'Workspace'
- $class: 'FilesMatchCondition'
  - includes : String
  - excludes : String
  - baseDir
    - $class: 'ArtifactsDir'
    - $class: 'JenkinsHome'
    - $class: 'Workspace'
- $class: 'LegacyBuildstepCondition'
  - condition : String
  - invert : boolean
- $class: 'NeverRun'
- $class: 'NodeCondition'
  - allowedNodes : Array / List of String
- $class: 'Not'
  - condition
    - $class: 'AlwaysRun'
    - $class: 'And'
      
      conditions
      Array / List of Nested Object
      condition
      Nested Choice of Objects
      $class: 'AlwaysRun'
      
      $class: 'And'
      
      $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
      
      $class: 'BooleanCondition'
      
      token : String
      
      $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
      
      $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
      
      $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
      
      $class: 'NeverRun'
      
      $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
      
      $class: 'Not'
      
      $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
      
      $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
      
      $class: 'Or'
      
      conditions
      Array / List of Nested Object
      
      $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
      
      $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
      
      $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
      
      $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
    - $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
    - $class: 'BooleanCondition'
      
      token : String
    - $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    - $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
    - $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
    - $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
    - $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
    - $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
    - $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
    - $class: 'NeverRun'
    - $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
    - $class: 'Not'
    - $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
    - $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
    - $class: 'Or'
      
      conditions
      Array / List of Nested Object
      condition
      Nested Choice of Objects
      $class: 'AlwaysRun'
      
      $class: 'And'
      
      conditions
      Array / List of Nested Object
      
      $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
      
      $class: 'BooleanCondition'
      
      token : String
      
      $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
      
      $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
      
      $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
      
      $class: 'NeverRun'
      
      $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
      
      $class: 'Not'
      
      $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
      
      $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
      
      $class: 'Or'
      
      $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
      
      $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
      
      $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
      
      $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
    - $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
    - $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
    - $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
    - $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
    - $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
    - $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
- $class: 'NumericalComparisonCondition'
  - lhs : String
  - rhs : String
  - comparator
    - $class: 'EqualTo'
    - $class: 'GreaterThan'
    - $class: 'GreaterThanOrEqualTo'
    - $class: 'LessThan'
    - $class: 'LessThanOrEqualTo'
    - $class: 'NotEqualTo'
- $class: 'OntrackDSLRunCondition'
  - ontrackScriptLocation
    - value : String
    - scriptPath : String
    - scriptText : String
  - sandbox : boolean
    If set, the Ontrack DSL script will run in a Groovy sandbox.
  - injectEnvironment : String
    Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
    For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
    
    ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
  - injectProperties : String
    You can define variables to inject into the script by using a property-like format.
    
    For example, the following text:
    
    BRANCH = 1.0 BUILD = ${VERSION}
    
    would inject the corresponding BRANCH and BUILD variables in the script:
    
    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
    
    In the text:
    
    declare properties using name = value syntax
    
    empty lines are ignored
    
    lines started by # are ignored
    
    patterns like ${VAR} are expanded using VAR from the current environment variables.
  - ontrackLog : boolean
    If set, the connections (request + response) to Ontrack will be logged in the build console output.
- $class: 'Or'
  - conditions
    - condition
      Nested Choice of Objects
      $class: 'AlwaysRun'
      
      $class: 'And'
      
      conditions
      Array / List of Nested Object
      
      $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
      
      $class: 'BooleanCondition'
      
      token : String
      
      $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
      
      $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
      
      $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
      
      $class: 'NeverRun'
      
      $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
      
      $class: 'Not'
      
      condition
      Nested Choice of Objects
      $class: 'AlwaysRun'
      
      $class: 'And'
      
      conditions
      Array / List of Nested Object
      
      $class: 'BatchFileCondition'
      
      command : String
      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.
      If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
      
      $class: 'BooleanCondition'
      
      token : String
      
      $class: 'CauseCondition'
      
      Run if the current build has a specific cause (e.g triggered by SCM or timer).
      
      buildCause : String
      The cause why the build was triggered. The following causes are supported:
      
      UserCause - the build was triggered by a manual interaction
      
      SCMTrigger - the build was triggered by a SCM change
      
      TimerTrigger - the build was triggered by a timer
      
      CLICause - the build was triggered by via CLI interface
      
      RemoteCause - the build was triggered via remote interface
      
      UpstreamCause - the build was triggered by an upstream project
      
      The following causes are supported if the XTrigger plugin is installed:
      
      FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
      
      URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
      
      IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
      
      ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
      
      BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'DayCondition'
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      daySelector
      For which days do you want the build to run?
      
      Weekends
      
      Saturday and Sunday
      
      Weekdays
      
      Not a weekend
      
      Select days
      
      Choose the days for which the build should run
      
      Nested Choice of Objects
      $class: 'SelectDays'
      
      days
      Array / List of Nested Object
      day : int
      
      selected : boolean
      
      $class: 'Weekday'
      
      $class: 'Weekend'
      
      $class: 'ExpressionCondition'
      
      expression : String
      The regular expression used to match the label - Java regular expression syntax
      
      label : String
      The label that will be tested by the regular expression
      
      $class: 'ExtendedCauseCondition'
      
      condition
      Nested Choice of Objects
      $class: 'UpstreamCauseCondition'
      
      projects : String
      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
      
      $class: 'UserBuildCauseCondition'
      
      users : String
      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
      
      exclusiveCause : boolean
      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
      
      $class: 'FileExistsCondition'
      
      file : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'FilesMatchCondition'
      
      includes : String
      
      excludes : String
      
      baseDir
      Nested Choice of Objects
      $class: 'ArtifactsDir'
      
      $class: 'JenkinsHome'
      
      $class: 'Workspace'
      
      $class: 'LegacyBuildstepCondition'
      
      condition : String
      
      invert : boolean
      
      $class: 'NeverRun'
      
      $class: 'NodeCondition'
      
      allowedNodes : Array / List of String
      
      $class: 'Not'
      
      $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
      
      $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
      
      $class: 'Or'
      
      $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
      
      $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
      
      $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
      
      $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
      
      $class: 'NumericalComparisonCondition'
      
      lhs : String
      
      rhs : String
      
      comparator
      Nested Choice of Objects
      $class: 'EqualTo'
      
      $class: 'GreaterThan'
      
      $class: 'GreaterThanOrEqualTo'
      
      $class: 'LessThan'
      
      $class: 'LessThanOrEqualTo'
      
      $class: 'NotEqualTo'
      
      $class: 'OntrackDSLRunCondition'
      
      ontrackScriptLocation
      Nested Object
      value : String
      
      scriptPath : String
      
      scriptText : String
      
      sandbox : boolean
      If set, the Ontrack DSL script will run in a Groovy sandbox.
      
      injectEnvironment : String
      Comma-separated list of environment variable (like BUILD_NUMBER) to bind as variables into the script.
      For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
      
      ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
      
      injectProperties : String
      
      You can define variables to inject into the script by using a property-like format.
      
      For example, the following text:
      
      BRANCH = 1.0 BUILD = ${VERSION}
      
      would inject the corresponding BRANCH and BUILD variables in the script:
      
      ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
      
      In the text:
      
      declare properties using name = value syntax
      
      empty lines are ignored
      
      lines started by # are ignored
      
      patterns like ${VAR} are expanded using VAR from the current environment variables.
      
      ontrackLog : boolean
      If set, the connections (request + response) to Ontrack will be logged in the build console output.
      
      $class: 'Or'
      
      $class: 'ShellCondition'
      
      command : String
      Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
      By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
      
      As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
      
      A non-zero exit value will be treated as a false value
      
      $class: 'StatusCondition'
      
      worstResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      bestResult : String
      The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
      
      $class: 'StringsMatchCondition'
      
      arg1 : String
      
      arg2 : String
      
      ignoreCase : boolean
      Ignore the case of the strings when matching them
      
      $class: 'TextFinderCondition'
      
      fileSet : String
      
      regexp : String
      
      checkConsoleOutput : boolean
      
      $class: 'TimeCondition'
      
      earliest : String
      
      latest : String
      
      useBuildTime : boolean
      Use the build time instead of the the time that the condition is evaluated.
      For long running builds, there can be a considerable difference between these two times.
      
      $class: 'VariableExistsCondition'
      
      variableName : String
      Name of the variable to be checked. Variables in this field will be expanded.
- $class: 'ShellCondition'
  - command : String
    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.
    By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
    
    As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
    
    A non-zero exit value will be treated as a false value
- $class: 'StatusCondition'
  - worstResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
  - bestResult : String
    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
- $class: 'StringsMatchCondition'
  - arg1 : String
  - arg2 : String
  - ignoreCase : boolean
    Ignore the case of the strings when matching them
- $class: 'TextFinderCondition'
  - fileSet : String
  - regexp : String
  - checkConsoleOutput : boolean
- $class: 'TimeCondition'
  - earliest : String
  - latest : String
  - useBuildTime : boolean
    Use the build time instead of the the time that the condition is evaluated.
    For long running builds, there can be a considerable difference between these two times.
- $class: 'VariableExistsCondition'
  - variableName : String
    Name of the variable to be checked. Variables in this field will be expanded.
runner
If the evaluation of a run condition fails, should the build fail, be marked unstable, run the build step ...
A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.
- $class: 'DontRun'
- $class: 'Fail'
- $class: 'Run'
- $class: 'RunUnstable'
- $class: 'Unstable'

skenai

orgId : String
appId : String

$class: 'SkytapBuilder'

action
- $class: 'AddConfigurationToProjectStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - projectID : String
    Unique integer identifier of the project to attach to a template or environment.
  - projectName : String
    Name of the project to which the specified template or environment will be added.
- $class: 'AddTemplateToProjectStep'
  - templateID : String
    Unique integer identifier of a Skytap template.
  - templateFile : String
    Path to a JSON format file of the template.
  - projectID : String
    Unique integer identifier of the project to attach to a template or environment.
  - projectName : String
    Name of the project to which the specified template or environment will be added.
- $class: 'ChangeConfigurationStateStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - targetRunState : String
    Valid states are running, suspended or stopped. Not all state transitions are permitted. Please consult the Skytap documentation for more details.
  - haltOnFailedShutdown : boolean
    If the VM cannot be shutdown gracefully, checking this option will result in it being powered off after several retry attempts.
- $class: 'ChangeContainerStateStep'
  - containerID : String
    Unique integer identifier of a Skytap container.
  - containerFile : String
    Path to a JSON format file of container metadata.
  - targetContainerAction : String
    Valid actions are start, pause, unpause or stop. Not all actions are permitted, depending on the current container run state. Please consult the Skytap documentation for more details.
- $class: 'ChangeVMContainerHostStatus'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - vmID : String
    Unique integer identifier of the VM to modify.
  - vmName : String
    Name of the VM to modify.
  - containerHostStatus : String
    Specify whether the VM should be able to host a container. Valid values are "Enable VM as Host Container" or "Disable VM as Host Container".
- $class: 'ConnectToVPNTunnelStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - configurationNetworkName : String
    Name of the specific network associated with this environment that you wish to connect from.
  - vpnID : String
    A Skytap VPN identifier of the form "vpn-xxxxxx" where xxxxxx is an integer
- $class: 'CreateConfigurationStep'
  - templateID : String
    Unique integer identifier of a Skytap template.
  - templateFile : String
    Path to a JSON format file of the template.
  - configName : String
    Descriptive name for the Skytap environment.
  - configFile : String
    Path to a JSON format file of the environment.
- $class: 'CreateContainerStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - vmID : String
    Unique integer identifier of the VM in which to create the container.
  - vmName : String
    Name of the VM which will host the container. If more than one VM has the same name (not recommended) one will be chosen.
  - containerRegistryName : String
    Name of a container registry from the Skytap container registries resource.
  - repositoryName : String
    Name of the repository in the specified container registry.
  - containerName : String
    Optional name for the container. Restricted to uppercase letters, lowercase letters, numbers, underscores (_), and periods.
    If no name is provided, the container will be named New_Container_[timestamp]
  - containerCommand : String
    Command that will be executed when the container starts.
    If no command is provided, will default to using the command in the image spec (if applicable).
  - exposeAllPorts : boolean
  - containerSaveFilename : String
    Path to the JSON format file where the container metadata will be saved.
- $class: 'CreatePublishURLStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - urlSaveFilename : String
    Path to a file where the Sharing Portal URL will be saved for use in subsequent steps.
  - portalName : String
    The mnemonic name you want to associate with the Sharing Portal
  - permissionOption : String
    Don't Publish: The Sharing Portal URL will not be available to the user in any way.
    
    View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
    
    Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
    
    Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
  - hasPassword
    A password may be included in a Sharing Portal, in which case the password must be supplied by the user upon accessing the Sharing Portal URL.
    - urlPassword
      Type: class hudson.util.Secret
- $class: 'CreatePublishedServiceStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - vmID : String
    Unique integer identifier of the VM for the published service.
  - vmName : String
    Name of the VM for the published service.
  - networkName : String
    Name of the network associated with the environment identified above.
  - portNumber : String
    Port number to publish the service on.
  - publishedServiceFile : String
    Path to the file where the published service URL is saved.
- $class: 'CreateTemplateFromConfigurationStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - templateName : String
    Name of the template being created
  - templateDescription : String
    Description of the purpose and function of the template.
  - templateSaveFilename : String
    Path to the JSON format file where the template will be saved.
- $class: 'DeleteConfigurationStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
- $class: 'DeleteContainerStep'
  - containerID : String
    Unique integer identifier of a container.
  - containerFile : String
    Path to a JSON format file of the container (usually saved from a "Create Container" or "Get Container MetaData" operation).
- $class: 'GetContainerMetaDataStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - vmID : String
    Unique integer identifier of the VM hosting the container.
  - vmName : String
    Name of the VM hosting the container. If more than one VM exists with the same name, one will be chosen.
  - containerName : String
    Name of the container in the specified environment and VM.
  - containerDataFile : String
    Path to a JSON format file of container metadata.
- $class: 'ListPublishedURLForConfigurationStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - urlName : String
    Name of the Published URL for the specified environment
  - urlFile : String
    Full path to a file where the url has been saved.
- $class: 'ListVMPublishedServiceStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - vmID : String
    Unique integer identifier of the VM for the published service.
  - vmName : String
    Name of the VM for the published service.
  - networkName : String
    Name of the network associated with the environment identified above.
  - portNumber : String
    Port number of the published service.
  - publishedServiceFile : String
    Path to the file where the published service URL is saved.
- $class: 'MergeTemplateIntoConfigurationStep'
  - configurationID : String
    Unique integer identifier of a Skytap environment.
  - configurationFile : String
    Path to a JSON format file of the environment.
  - templateID : String
    Unique integer identifier of a Skytap template.
  - templateFile : String
    Path to a JSON format file of the template.
  - configFile : String
    Path to the JSON format file where the Environment info will be saved after the command finishes
- $class: 'NetworkConnectStep'
  - sourceNetworkConfigurationID : String
    Unique identifier of environment that has the source network for the ICNR connection.
  - targetNetworkConfigurationID : String
    Unique identifier of environment that has the target network for the ICNR connection.
  - sourceNetworkConfigurationFile : String
    Full path to a JSON format file of the environment that has the source network for the ICNR connection.
  - targetNetworkConfigurationFile : String
    Full path to a JSON format file of the environment that has the target network for the ICNR connection.
  - sourceNetworkName : String
    Name of the network associated with the source environment identified above.
  - targetNetworkName : String
    Name of the network associated with the target environment identified above.

$class: 'SleepBuilder'

time : long

$class: 'SmartFrogBuilder'

smartFrogName : String
deployHost : String
hosts : String
sfUserHome : String
sfUserHome2 : String
sfUserHome3 : String
sfUserHome4 : String
sfOpts : String
builderId : String
useAltIni : boolean
sfIni : String
sfScriptSource
- $class: 'FileScriptSource'
  - scriptName : String
  - scriptPath : String
- $class: 'StringScriptSource'
  - scriptName : String
  - scriptContent : String

$class: 'SnapshotBuilder'

xStudioPath : String
Path to XStudio.exe on a host machine.
xStudioLicensePath : String
Path to the XStudio license on a host machine.
vagrantBox : String
Name of the Vagrant box to use. Check Atlas service for the list of available boxes.
overwrite : boolean
Abort build if the specified image is available in the remote hub.
preInstallScriptPath : String
Optional parameter. Path to a PowerShell script which should be executed before a snapshot is taken. The script can be used to install applications required by an installer of the application to snapshot.
For example WebEx installer requires Firefox browser. In order to exclude Firefox files from the snapshot it can be installed by a pre-install script.
postSnapshotScriptPath : String
Optional parameter. Path to a PowerShell script which should be executed after a snapshot was taken. The script can be used to disable auto-start of services or change isolation level of registry or file system items.
resourceDirectoryPath : String
Optional parameter. Path to a directory which should be copied to the Vagrant working directory.
For example WebEx snapshot requires extra files to be copied after snapshot was taken.
dependencies : Array / List of String
Optional parameter. Comma separated list of dependencies. Dependencies will be fetched form the hub and added to the output image configuration loaded from the XAPPL file.

Example: "oracle/jre:7.51,python/python:3.41"
snapshotFilesToDelete : Array / List of String
installScriptSettings
- Type: class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettings
startupFileSettings
- Type: class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings

$class: 'SnykStepBuilder'

additionalArguments : String (optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.

Use the standalone double-dash -- to pass arguments to the build tool invoked by the Snyk CLI. For example:
- -- -Pprofile -Dkey=value for Maven projects.
- -- --configuration runtime for Gradle projects.
- -- -Dkey=value for SBT projects.
failOnError : boolean (optional)

Whether the step should fail if Snyk fails to scan the project due to an error. Errors include scenarios like: failing to download Snyk's binaries, improper Jenkins setup, bad configuration and server errors.
failOnIssues : boolean (optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
- if "Fail the build, if severity at or above" is selected, the Jenkins build will fail if Snyk detects issues of provided level or higher.
- if "Let the build continue" is selected, the Jenkins build will continue even if Snyk detects issues in the project.
The corresponding CLI option for severity parameter: --severity-threshold
monitorProjectOnBuild : boolean (optional)

Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
organisation : String (optional)

The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.

The corresponding CLI option for this parameter: --org
projectName : String (optional)

A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.

The corresponding CLI option for this parameter: --project-name
severity : String (optional)
snykInstallation : String (optional)

Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH environment variable during builds.

If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
snykTokenId : String (optional)

This needs to be the ID of an existing "Snyk API Token" credential. The token will be used to authenticate with Snyk.

If you prefer to provide the Snyk API Token another way, such using alternative credential bindings, you'll need to provide a SNYK_TOKEN build environment variable.
targetFile : String (optional)

The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.

The corresponding CLI option for this parameter: --file

addALMOctaneSonarQubeListener

See help information in ALM Octane Help Center

pushCoverage : boolean (optional)
pushVulnerabilities : boolean (optional)
skipWebhookCreation : boolean (optional)
The integration with SonarQube works by using Sonar’s webhook mechanism, and contains several phases:
1. The plugin automatically configures a webhook in Sonar before the job runs (this requires an access token with global 'Administer' permission).
2. When the Sonar analysis is ready, the SonarQube server calls the configured webhook.
3. Results are then submitted to ALM Octane for further analysis (this requires an access token with 'Read' permissions).
If you cannot assign global 'Administer' permissions to the Sonar token (for the first phase), select "Skip webhook creation", and define a webhook manually in the Sonar server (either at the global level or project level) to the following URL: {jenkins_url}/webhooks/notify
sonarServerUrl : String (optional)
sonarToken : String (optional)

reportSonarQubeAudit

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
acceptInvalidCertificate : boolean (optional)
projectKey : String (optional)

$class: 'SonarRunnerBuilder'

additionalArguments : String (optional)
installationName : String (optional)
javaOpts : String (optional)
jdk : String (optional)
project : String (optional)
properties : String (optional)
sonarScannerName : String (optional)
task : String (optional)

$class: 'SoosSCA'

SOOSClientId
- Type: class hudson.util.Secret
SOOSApiKey
- Type: class hudson.util.Secret
projectName : String
onFailure : String
resultMaxWait : String
resultPollingInterval : String
apiBaseURI : String
dirsToExclude : String
filesToExclude : String
commitHash : String
branchName : String
branchURI : String
buildVersion : String
buildURI : String
packageManagers : String

$class: 'SoundsBuildTask'

afterDelayMs : String
soundSource
- selectedSound : String
- value
  - Values: INTERNAL, URL
- soundUrl : String

$class: 'SparkNotifyBuilder'

Spark Notifier Plugin sends messages to spark spaces

Make sure you add the correct bot or user to the spaces

disable : boolean
messageType : String
roomList
To get the Space ID, go to web.ciscospark.com, select the space you want to message and get the ID from the URL.

Example: https://web.ciscospark.com/#/rooms/f2fbc1f0-317c-11e6-8308-f3bee39e57c5
The Space ID would be: f2fbc1f0-317c-11e6-8308-f3bee39e57c5

You can also use the room ID representation acquired from GET https://api.ciscospark.com/v1/rooms

See https://developer.ciscospark.com/endpoint-rooms-get.html for more information
- rName : String
- rId : String
messageContent : String (optional)
Define the message to send to spark space

Environment variable examples:
- $BUILD_URL
- ${BUILD_URL}
- ${env.BUILD_URL}
Commonly used variables:
- ${JOB_NAME}
- ${JOB_URL}
- ${BUILD_NUMBER}
- ${BUILD_URL}
- ${BUILD_DISPLAY_NAME}
- ${BUILD_ID}
- ${BUILD_TAG}
- ${JAVA_HOME}
- ${JAVA_VERSION}
- ${JENKINS_URL}
- ${JENKINS_VERSION}
- ${NODE_LABELS}
- ${NODE_NAME}
- ${PATH}
- ${PWD}
- ${EXECUTOR_NUMBER}
if using SCM or SCM trigger (see the corresponding plugin wiki for additional environment variables):
- ${BRANCH_NAME}
- ${CHANGE_ID}
- ${CHANGE_URL}
- ${CHANGE_TITLE}
- ${CHANGE_AUTHOR}
- ${CHANGE_AUTHOR_DISPLAY_NAME}
- ${CHANGE_AUTHOR_EMAIL}
- ${CHANGE_TARGET}
if using the Environment Injector Plugin:
- ${BUILD_CAUSE}
- ${BUILD_CAUSE_MANUALTRIGGER}
- ${BUILD_CAUSE_SCMTRIGGER}
- ${BUILD_CAUSE_UPSTREAMTRIGGER}
- ${ROOT_BUILD_CAUSE}
All environment variables injected into the build can also be used
credentialsId : String (optional)

split

splitTask : String
splitName : Array / List of String
environmentName : Array / List of String
workspaceName : Array / List of String
trafficTypeName : Array / List of String
splitDefinitions : String
targetlistKey : String
treatmentName : String
splitYAMLFile : String

springBoot

selectedIDs : String (optional)
artifactId : String (optional)
autocomplete : String (optional)
bootVersion : String (optional)
description : String (optional)
groupId : String (optional)
javaVersion : String (optional)
language : String (optional)
packaging : String (optional)
projectName : String (optional)
type : String (optional)

sseBuild

almServerName : String
almProject : String
credentialsId : String
clientType : String
Client type is required for some ALM above 12.60 in authentication.
almDomain : String
runType : String
almEntityId : String
timeslotDuration : String
cdaDetails (optional)
- deploymentAction : String
- deployedEnvironmentName : String
- deprovisioningAction : String
description : String (optional)
environmentConfigurationId : String (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.
postRunAction : String (optional)

stackrox

apiToken : String (optional)
caCertPEM : String (optional)
enableTLSVerification : boolean (optional)
failOnCriticalPluginError : boolean (optional)
failOnPolicyEvalFailure : boolean (optional)
imageNames : String (optional)
portalAddress : String (optional)

osfBuilderSuiteStandaloneSonarLinter

sourcePatterns (optional)
- sourcePattern : String
- excludePatterns
  - excludePattern : String
reportPath : String (optional)

$class: 'StartBox'

cloud : String
workspace : String
The workspace in ElasticBox to look for a deployed box to start.
box : String
Box to look for instances in the selected workspace.
instance : String
buildStep : String
Instance deployed by the selected preceding Deploy Box build step will be started.

startET

Configure and start a preconfigured ECU-TEST installation.

Pipeline usage

Signatures:

startET(String toolName) : void

startET(String toolName, String workspaceDir, String settingsDir, int timeout,
        boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void

ETInstance.start() : void

ETInstance.start(String workspaceDir, String settingsDir, int timeout,
         boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void

ETInstance.start(Map<String, Object> settings) : void

Examples:

startET('ECU-TEST')

def instance = ET.installation('ECU-TEST')
startET installation: instance.installation, workspaceDir: 'C:\\Data'

def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()

def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.start workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true

toolName : String
debugMode : boolean (optional)
installation (optional)
- name : String
- home : String
- properties
  - Type: ? extends hudson.tools.ToolProperty<?>
keepInstance : boolean (optional)
settingsDir : String (optional)
timeout : String (optional)
updateUserLibs : boolean (optional)
workspaceDir : String (optional)

$class: 'StartGrid'

url : String
cloudTestServerID : String
name : String
timeOut : int
The total time SCommand will wait for the grid to reach the CHECKED (Ready) state (Default 600 seconds)

acmStartPipeline

aioProject : String (optional)
pipeline : String (optional)
program : String (optional)

$class: 'StartRSDB'

url : String
cloudTestServerID : String
name : String
timeOut : int
The total time SCommand will wait for the RSDB to reach the CHECKED (Ready) state (Default 1200 seconds)

startTS

Configure and start Tool-Server.

Pipeline usage

Signatures:

startTS(String toolName) : void

startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void

ETInstance.startTS() : void

ETInstance.startTS(String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void

ETInstance.startTS(Map<String, Object> settings) : void

Examples:

startTS('ECU-TEST')

def instance = ET.installation('ECU-TEST')
startTS installation: instance.installation

def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()

def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.startTS toolLibsIniPath: C:\\ToolLibs.ini, tcpPort: 5017, timeout: 60, keepInstance: false

toolName : String
installation (optional)
- name : String
- home : String
- properties
  - Type: ? extends hudson.tools.ToolProperty<?>
keepInstance : boolean (optional)
tcpPort : String (optional)
timeout : String (optional)
toolLibsIni : String (optional)

$class: 'StartTestEnvironment'

url : String
cloudTestServerID : String
name : String
timeOut : int
The total time SCommand will wait for the test environment to reach the CHECKED (Ready) state (Default 1200 seconds)

$class: 'StopBox'

cloud : String
workspace : String
The workspace in ElasticBox to look for a deployed box to stop.
box : String
Box to look for instances in the selected workspace.
instance : String
buildStep : String
Instance deployed by the selected preceding Deploy Box build step will be stopped.

stopET

Shutdown ECU-TEST.

Pipelines usage:

Signatures:

stopET(String toolName) : void

stopET(String toolName, int timeout) : void

ETInstance.stop() : void

ETInstance.stop(int timeout) : void

ETInstance.stop(Map<String, Object> settings) : void

Examples:

stopET('ECU-TEST')

def instance = ET.installation('ECU-TEST')
stopET installation: instance.installation

def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stop()

def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.stop timeout: 60

toolName : String
installation (optional)
- name : String
- home : String
- properties
  - Type: ? extends hudson.tools.ToolProperty<?>
timeout : String (optional)

$class: 'StopGrid'

url : String
cloudTestServerID : String
name : String

$class: 'StopRSDB'

url : String
cloudTestServerID : String
name : String

stopTS

Shutdown Tool-Server.

Pipelines usage:

Signatures:

stopTS(String toolName) : void

stopTS(String toolName, int timeout) : void

ETInstance.stopTS() : void

ETInstance.stopTS(int timeout) : void

ETInstance.stopTS(Map<String, Object> settings) : void

Examples:

stopTS('ECU-TEST')

def instance = ET.installation('ECU-TEST')
stopTS installation: instance.installation

def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stopTS()

def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.stopTS timeout: 60

toolName : String
installation (optional)
- name : String
- home : String
- properties
  - Type: ? extends hudson.tools.ToolProperty<?>
timeout : String (optional)

$class: 'StopTestEnvironment'

url : String
cloudTestServerID : String
name : String

strobeMeasurement

connectionId : String
Required. This field specifies the host connection to use to submit a measurement.
Host connections can be configured in the Jenkins system configuration (Manage Jenkins -> Configure System).
credentialsId : String
Required. The available CES secret token to perform Code Pipeline actions for Rest API call.
requestType : String
Required. What type of request you want for the measurement. Select active if the job is currently running or Queued if the job will be running later.
jobName : String
Required. Name of the job you want to measure.
body : String (optional)
The body of the callback. Can leave blank if no body is needed. For example, a JSON body would be entered like { "key1" : "value1", "key2" : "value2", "key3" : "value3", ... "key10" : "value10" } If you would like to receive the completed profile's ID back as part of the json body, set the value of one of your keys to $$$profileId$$$ like {"profileId" : $$$profileId$$$}
duration : String (optional)
Optional. Estimated minimum measurement time in minutes. Acceptable values 1 to 1440.
emailto : String (optional)
finalAction : String (optional)
Optional. Controls the measurement session when the final dataset has been completed. The value can be either Quit, Stop, or Continue. See the Strobe User Guide for details. NOLIMIT is created from the limit = 1 and Continue.
headers : String (optional)
The HTTP headers of the callback. Should be colon and semicolon separated like for example, k1:v1;k2:v2;k3:v3
hlq : String (optional)
Optional. High Level Qualifier. DSNAME High level qualifier - Temporary dataset prefix.
limit : String (optional)
Optional. Suspends sampling when the target number of samples is reached. Acceptable values 1 to 99. Must be 1 when using Final Action of Continue.
method : String (optional)
Type of HTTP request to make. POST/GET/PUT/DELETE
profileName : String (optional)
Optional. The name of the profile. It defaults to the job name.
samples : String (optional)
Optional. The target number of samples to take during the measurement session. Acceptable values 1000 to 150000.
tags : String (optional)
Optional. Tags to be assigned to profile
transactionId : String (optional)
Optional. May occur up to 5 times. Used for transaction profiling, the tranids are transaction ID masks used to specify the transactions to be measured. Length is limited to 4 characters. You can use a wildcard character (*) after a string of one or more characters in the Detail by Transaction field to measure transactions that meet the specified search criteria. * For Queue the additional elements are available: step � Optional, program � Optional, stringData � Optional
url : String (optional)
URL for the HTTP request. Leave blank if you do not want to do an HTTP callback.

$class: 'StudioToolsBuilder'

name : String
Help file for fields are discovered through a file name convention. This file is help for the "name" field. You can have arbitrary HTML here. You can write this file as a Jelly script if you need a dynamic content (but if you do so, change the extension to .jelly).
operation : String
projectDir : String
outputArchiveFile : String
extendedClassPath : String
overwriteOutput : boolean
TRAPropertyFIle : String

topazSubmitFreeFormJcl

connectionId : String
credentialsId : String
maxConditionCode : String
jcl : String

topazSubmitJclMembers

connectionId : String
credentialsId : String
maxConditionCode : String
jclMember : String

$class: 'SubmitJobStep'

connectionName : String
jobName : String

submitJob

fileToSubmit : String

submitJobSync

fileToSubmit : String

reportSurefireTest

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
surefireReportPath : String (optional)

$class: 'SvChangeModeBuilder'

serverName : String
force : boolean
If set, service will be modified regardless it is locked by another user.
mode
- Values: OFFLINE, SIMULATING, STAND_BY, LEARNING
dataModel
- selectionType
  - Values: BY_NAME, NONE, DEFAULT
- dataModel : String
performanceModel
- selectionType
  - Values: BY_NAME, NONE, OFFLINE, DEFAULT
- performanceModel : String
serviceSelection
- selectionType
  - Values: SERVICE, PROJECT, ALL_DEPLOYED, DEPLOY
- service : String
- projectPath : String
- projectPassword : String

$class: 'SvDeployBuilder'

serverName : String
force : boolean
If set, service will be redeployed regardless it is locked by another user.
service : String
Name or ID of service to be deployed. All services from project are deployed if no service is specified.
projectPath : String
projectPassword : String
firstAgentFallback : boolean
Use first agent of the same type if no agent with id referenced from virtual service exists on target server.

$class: 'SvExportBuilder'

serverName : String
force : boolean
If set, service will be modified regardless it is locked by another user.
targetDirectory : String
Directory where exported services will be written.
cleanTargetDirectory : boolean
If checked, all direct subfolders of target directory containing a project file (*.vproj) will be deleted before export.
serviceSelection
- selectionType
  - Values: SERVICE, PROJECT, ALL_DEPLOYED, DEPLOY
- service : String
- projectPath : String
- projectPassword : String
switchToStandByFirst : boolean
Switch service to Stand-By mode to finish current learning before exporting learned data.
archive : boolean
If set, Export service(s) as project archive(s) (.vproja).

$class: 'SvUndeployBuilder'

serverName : String
continueIfNotDeployed : boolean
Don't fail if any service marked to be undeployed is not deployed on server.
force : boolean
If set, service will be undeployed regardless it is locked by another user.
serviceSelection
- selectionType
  - Values: SERVICE, PROJECT, ALL_DEPLOYED, DEPLOY
- service : String
- projectPath : String
- projectPassword : String

SWEAGLEExport

actionName : String
Give each action a descriptive name to precede the job's output in the console.
mdsName : String
Exact name of pending config data set for which the data should be exported
args : String (optional)
Use comma separated values for exporter variables
exporter : String (optional)
The SWEAGLE exporter to use when retrieving the config data.
fileLocation : String (optional)
Location of file within the Jenkins workspace to save the exported data.
format : String (optional)
Select the supported format of the file to be uploaded.
mapToVariables : String (optional)
Sets a Jenkins Environment variable to value of a configuration data item. One variable on each line. format is colon seperated key value pair VARIABLE:Path.to.node.cdi Example: INTERNAL_IP:PRD.infra.db023.ipInternal
markFailed : boolean (optional)
Mark the build as "Failed" should the data export fail.
showResults : boolean (optional)
Show the results of the API call in the Jenkins job console log.
tag : String (optional)

SWEAGLESnapshot

actionName : String
Give each action a descriptive name to precede the job's output in the console.
mdsName : String
Exact name of pending config data set for which the snapshot should be taken.
description : String (optional)
A description for the snapshot
markFailed : boolean (optional)
Mark the build as "Failed" should the snapshot fail.
showResults : boolean (optional)
Show the results of the API call in the Jenkins job console log. Warning !!! The API results of a snapshot will include the entire Config Data set.
tag : String (optional)
A single string as TAG for that snapshot - cannot contain spaces but can utilize Jenkins variable4s ex "release1.2.${BUILD_ID}"

SWEAGLEUpload

actionName : String
Give each action a descriptive name to precede the job's output in the console.
fileLocation : String
Fullpath of file relatove to the Jenkins workspace using Ant file filter format for selecting multiple files with wildcard. Details here. Examples: myconfig.json *.json subdirectory/*.json
format : String
Select the supported format of the file to be uploaded.
nodePath : String
Enter the path where the data should be uploaded. Separate the nodenames in the path with a comma. In case the nodes do not yet exist, they will be created automatically.
allowDelete : boolean (optional)

Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. If the nodes are included or inherited the nodes and MDIs at points of inclusion will also be deleted unless "Only Parent" is also checked.
autoRecognize : boolean (optional)
description : String (optional)
A description for the snapshot
filenameNodes : boolean (optional)

Create Filename Nodes If checked, nodes will be created for all matching files names in the file location and file data will be placed under file name node.
identifierWords : String (optional)

Identifier Words To make nodes part of an array uniquely identifiable, a comma separated list of 'identifier words' can be added. If no identifierWords are provided, the behavior will default to the identifierWords listed in the find.identity_attributes_discovery.word_list preference
markFailed : boolean (optional)
Mark the build as "Failed" should the data upload fail for any reason.
onlyParent : boolean (optional)

Only Parent This controls if in case the allowDelete flag is set to true if the deletion of nodes and CDIs will only happen at the node itself, or also at any other place where the node is included or in every child node that is inheriting.
showResults : boolean (optional)
Show the results of the API call in the Jenkins job console log.
subDirectories : boolean (optional)

Search Sub-directories If checked sub-directories will also be searched recursively for matching files.
tag : String (optional)
A single string as TAG for that snapshot - cannot contain spaces but can utilize Jenkins variable4s ex "release1.2.${BUILD_ID}"
withSnapshot : boolean (optional)

Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted config data sets by this data upload.

SWEAGLEValidate

actionName : String
Give each action a descriptive name to precede the job's output in the console.
mdsName : String
The exact name of the config data set which should be validated.
errMax : int (optional)
Fail build on validate errors. Set thresholds used to determine if the build should be failed based on the number of validation errors or warnings. Use -1 to ignore either threshold.
markFailed : boolean (optional)
Fail build on validate errors or if the pending data set fails to show up after all the retry attempts have completed.
noPending : boolean (optional)
Fail build if no data is found for the Config Data Set (CDS).
retryCount : int (optional)
Number of retry attempts while waiting for a pending config data set. Combined with with Retry Interval to force a timeout after attempts have completed. Use "-1" for unlimited retries.
retryInterval : int (optional)
Number of seconds between each attempt to find a matching config data set for validation. Combine with with Retry Count to force a timeout after attempts have completed.
showResults : boolean (optional)
Show the results of the API call in the Jenkins job console log.
stored : boolean (optional)
Validate the stored snapshot for the config data set instead of the pending data.
warnMax : int (optional)
Fail build on validate errors. Set thresholds used to determine if the build should be failed based on the number of validation errors or warnings. Use -1 to ignore either threshold.

$class: 'SyncBuilder'

packageid : String
Enter the ID of the NuGet package you built in the build step.
serverName : String
dbName : String
serverAuth
- value : String
- username : String
- password
  - Type: class hudson.util.Secret
encryptConnection : boolean
trustServerCertificate : boolean
options : String
dataOptions : String
filter : String
packageVersion : String
Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
isolationLevel : String
updateScript : boolean
sqlChangeAutomationVersionOption
- value
  - Values: Latest, Specific
- specificVersion : String

$class: 'SyncStepBuilder'

packageId : String
server : String
database : String
authenticationType : String
userName : String
password
- Type: class hudson.util.Secret
compareOptions : String (optional)
filterFile : String (optional)
transactionIsoLvl : String (optional)

$class: 'SysdigBuilder'

name : String
bailOnFail : boolean (optional)
bailOnPluginFail : boolean (optional)
engineCredentialsId : String (optional)
engineurl : String (optional)
engineverify : boolean (optional)
forceScan : boolean (optional)
inlineScanExtraParams : String (optional)
inlineScanning : boolean (optional)
runAsUser : String (optional)

$class: 'SystemGroovy'

Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.

Predefined variables:

build: The current AbstractBuild.
launcher: A Launcher.
listener: A BuildListener.
out: A PrintStream (listener.logger).

source
- $class: 'FileSystemScriptSource'
  - scriptFile : String
- $class: 'StringSystemScriptSource'
  - script
    - script : String
    - sandbox : boolean
      If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    - classpath
      Additional classpath entries accessible from the script.
      
      Array / List of Nested Object
      path : String
      A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
      
      oldPath : String (optional)
      
      shouldBeApproved : boolean (optional)
    - oldScript : String (optional)
bindings : String (optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.

$class: 'TATestRunRegistrationBuildStep'

This step registers new test run with given category and sets the 'dtTestrunID' build variable.

category : String
platform : String

ted

credentialsID : String
repositoryName : String (optional)
The name of the File-AID EX repository, which houses the required EX specifications that are to be executed.
Optional? No
Can be defined in execution Context? No
resultsRepositoryName : String (optional)
The repository where Compare Pro execution results will be stored. Only applicable to comparePro specifications.
Optional? Yes, defaults to the specification repository if not specified.
Can be defined in execution Context? No
selectExecutionTypeRadio : String (optional)
specificationName : String (optional)
The name of the specification that is to be executed. Required if single specification execution is selected.
Optional? No, mandatory if single specification execution is selected.
Can be defined in execution Context? No
specificationType : String (optional)
The type of the specification that is to be executed.
Optional? No, mandatory if single specification execution is selected.
Can be defined in execution Context? No
specificationList : String (optional)
If multiple specifications are to be executed within the same pipeline, with the same configuration. Provide a list of Specification Name and Types each separated by space. For example: SPECA extract SPECB convert SPECC compare
Optional? No, mandatory if multi-specification execution is selected.
Can be defined in execution Context? No
exitOnFailure : boolean (optional)
Flag to denote if it is preferred to stop the continued execution of specifications after a execution failure, in case of multi-specification execution.
Optional? Yes, defaulted to true if not defined.
Can be defined in execution Context? No
executionContext : String (optional)
TThe name of the execution context file. If the file is present at /WorkbenchCLI/EnterpriseData, the name of the file would suffice, if at a different location on the machine supply the full path with the file name. If a value for a certain argument is defined in the context file and is also passed as an argument, the value passed with the command will take precedence. To know which all parameters can be specified via the context file, view the template provided at /WorkbenchCLI/EnterpriseData named executioncontext_template.properties. Multiple execution contexts can be created as required by copying the template.
Optional? Yes, if this is not provided all other mandatory parameters have to be defined on the pipeline definition.
executionTimeout : String (optional)
The execution timeout in seconds. The default if not defined is 20 seconds.
Optional? Yes
Can be defined in execution Context? Yes
defineCES : boolean (optional)
cesURL : String (optional)
The URL for the CES to be used for license validation. It can either be the URL for the cloud CES or a locally installed CES.
Optional? No
Can be defined in execution Context? Yes
useCloudCES : boolean (optional)
Flag to denote if cloud CES should be used.
Optional? No
Can be defined in execution Context? Yes
cloudCustomerNo : String (optional)
The customer number, in case the cloud CES is chosen to be used. Please contact BMC customer support if you need help with this information.
Optional? Required for cloud CES.
Can be defined in execution Context? Yes
cloudSiteID : String (optional)
The Site ID, in case the cloud CES is chosen to be used. Please contact BMC customer support if you need help with this information.
Optional? Required for cloud CES.
Can be defined in execution Context? Yes
defineManager : boolean (optional)
communicationManager : String (optional)
The host name or ip of the machine where the communication manager is running. The File-AID Ex repository containing the specifications that needs to be executed should be configured on this communication manager.
Optional? No
Can be defined in execution Context? Yes
communicationManagerPort : String (optional)
The port on which the communication manager is running. on the specified host.
Optional? No
Can be defined in execution Context? Yes
defineServer : boolean (optional)
executionServer : String (optional)
The host name or ip of the machine which the execution server where the EX specifications should be executed, is installed.
Optional? Required for executing EX specifications.
Can be defined in execution Context? Yes
executionServerPort : String (optional)
The port on which the execution server is running, on the specified host.
Optional? Required for executing EX specifications.
Can be defined in execution Context? Yes
defineHost : boolean (optional)
connectionId : String (optional)
The execution host and port where RDX specifications should be executed.
Optional? Required for executing RDX specifications.
Can be defined in execution Context? Yes
includeCred : boolean (optional)
defineJobcard : boolean (optional)
jclJobcardLine1 : String (optional)
The JCL Jobcard's line 1, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine2 : String (optional)
The JCL Jobcard's line 2, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine3 : String (optional)
The JCL Jobcard's line 3, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine4 : String (optional)
The JCL Jobcard's line 4, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
jclJobcardLine5 : String (optional)
The JCL Jobcard's line 5, applicable only to RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
defineQualifiers : boolean (optional)
datasetHighLevelQualifier : String (optional)
The dataset high level qualifier to be used. Applicable only for RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
temporaryDatasetPrefix : String (optional)
The prefix to be used for temporary datasets. Applicable only for RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
temporaryDatasetSuffix : String (optional)
The suffix to be used for temporary datasets. Applicable only for RDX execution.
Optional? Yes
Can be defined in execution Context? Yes
defineDataprivacyOverride : boolean (optional)
dpOverrideFADEBUG : String (optional)
The data privacy override FADEBUG, that defines the logging information for the File-AID Rules Engine. Only applicable for RDX Extract executions.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAEXPATH : String (optional)
The data privacy override FAEXPATH, that defines the path for File-AID Rules Engine location. Only applicable for RDX Extract executions.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAIPADDR : String (optional)
The data privacy override FAIPADDR, that provides the File-AID Services IP address and execution port.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAJOPTS : String (optional)
The data privacy override FAJOPTS, that defines the Java options for the File-AID Rules Engine.
Optional? Yes
Can be defined in execution Context? Yes
dpOverrideFAJPATH : String (optional)
The data privacy override FAJAPTH, that defines the z/OS UNIX path for the Java Virtual Machine.
Optional? Yes
Can be defined in execution Context? Yes
haltPipelineOnFailure : boolean (optional)
credentialsId : String (optional)
The credentials for the selected execution host.
Optional? Required for executing RDX specifications.
Can be defined in execution Context? No
Note: If keystore or certificate needs to be used, leave this field empty and define the parameters in the execution context. The support for keystore and certificate based authentication via this jenkins plugin will be added in a future version.

$class: 'TagBuilder'

changeLogFile : String (optional)
changeLogParameters : String (optional)
contexts : String (optional)
Liquibase contexts to execute under.
credentialsId : String (optional)
installationName : String (optional)
labels : String (optional)
Liquibase labels to execute
liquibasePropertiesPath : String (optional)
A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
password : String (optional)
resourceDirectories : String (optional)
Leave blank for workspace root. May be relative to workspace or an absolute path.
tag : String (optional)
The tag to apply to the database. If the tag already exists, it will be moved the current datatabase state.

If left empty, an auto-generated tag based on the build number will be applied
url : String (optional)
example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
username : String (optional)

tanaguru

name : String
The name of audit or the scenario audit to be performed.
scenario : String
urlToAudit : String
urlTanaguruWebService : String
The URI to the Tanaguru REST app. By default something like: http://localhost:8080/rest/service
performanceUnstableMark : int
performanceFailedMark : int
proxy_uri : String
proxy_username : String
proxy_password : String

$class: 'TattletaleBuilder'

inputDirectory : String
outputDirectory : String

testcompletetest

suite : String (optional)
accessKeyId : String (optional)
actionOnErrors : String (optional)
actionOnWarnings : String (optional)
commandLineArguments : String (optional)
credentialsId : String (optional)
executorType : String (optional)
executorVersion : String (optional)
generateMHT : boolean (optional)
launchConfig (optional)
- project : String (optional)
- routine : String (optional)
- tags : String (optional)
- test : String (optional)
- unit : String (optional)
- value : String (optional)
launchType : String (optional)
project : String (optional)
publishJUnitReports : boolean (optional)
routine : String (optional)
sessionScreenResolution : String (optional)
tags : String (optional)
test : String (optional)
timeout : String (optional)
unit : String (optional)
useActiveSession : boolean (optional)
useTCService : boolean (optional)
useTimeout : boolean (optional)
userName : String (optional)
userPassword : String (optional)

$class: 'TelegramBotBuilder'

message : String

$class: 'TelerikAppBuilder'

applicationId : String
The unique identifier for your Telerik Platform app, available in the Settings tab. Not to be confused with the application identifier for the application package.
More info
accessToken
A unique access token for building your Telerik Platform app, available in the Settings tab.
More info
- Type: class hudson.util.Secret
configuration : String
buildSettingsiOS
- mobileProvisionIdentifieriOS : String
- codesigningIdentityiOS : String
buildSettingsAndroid
- codesigningIdentityAndroid : String
buildSettingsWP : boolean
Always produces a Telerik-signed package. To run the package on device, you need to install the Telerik Application Enrollment Token (AET) on the device first.

$class: 'TerminateBox'

cloud : String
workspace : String
The workspace in ElasticBox to look for a deployed box to restart.
box : String
Box to look for instances in the selected workspace.
instance : String
buildStep : String
Instance deployed by the selected preceding Deploy Box build step will be terminated.
delete : boolean

cfyTerraform

credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean (optional)
If checked, then printed Cloudify events and logs will include debug-level records.
deploymentId : String (optional)

ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
echoEnvData : boolean (optional)

If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean (optional)
If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
envDataLocation : String (optional)

Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
environmentVariables (optional)
- Type: java.util.Map<java.lang.String, java.lang.String>
environmentVariablesAsString : String (optional)

YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}).
environmentVariablesFile : String (optional)

Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
executable : String (optional)

Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable Cloudify secret will be used.
pluginsDirectory : String (optional)

Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir Cloudify secret will be used.
storageDirectory : String (optional)

Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir Cloudify secret will be used.
templateUrl : String (optional)

URL of the Terraform template. May be a ZIP, tar.gz, or a Git repository.
tenant : String (optional)
variables (optional)
- Type: java.util.Map<java.lang.String, java.lang.Object>
variablesAsString : String (optional)

YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}).
variablesFile : String (optional)

Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.

dotnetTest

The dotnet test command is used to execute unit tests in a given solution. It builds the solution and runs a test host application for each test project in the solution. The test host executes tests in the given project using a test framework, for example: MSTest, NUnit, or xUnit, and reports the success or failure of each test. If all tests are successful, the test runner returns 0 as an exit code; otherwise if any test fails, it returns 1.

For multi-targeted projects, tests are run for each targeted framework. The test host and the unit test framework are packaged as NuGet packages and are restored as ordinary dependencies for the project.

(see also: Microsoft Documentation)

blame : boolean (optional)
Runs the tests in blame mode. This option is helpful in isolating problematic tests that cause the test host to crash. When a crash is detected, it creates an sequence file in TestResults/<Guid>/<Guid>_Sequence.xml that captures the order of tests that were run before the crash.
blameCrash : boolean (optional)
Runs the tests in blame mode and collects a crash dump when the test host exits unexpectedly. This option depends on the version of .NET used, the type of error, and the operating system.
For exceptions in managed code, a dump will be automatically collected on .NET 5.0 and later versions. It will generate a dump for the test host or any child process that also ran on .NET 5.0 and crashed. Crashes in native code will not generate a dump. This option works on Windows, macOS, and Linux.
Crash dumps in native code, or when using .NET Core 3.1 or earlier versions, can only be collected on Windows, by using Procdump. A directory that contains procdump.exe and procdump64.exe must be in the PATH or PROCDUMP_PATH environment variable. Download the tools. Implies --blame.
To collect a crash dump from a native application running on .NET 5.0 or later, the usage of Procdump can be forced by setting the VSTEST_DUMP_FORCEPROCDUMP environment variable to 1.

Available since: .NET 5.0 preview SDK
blameCrashCollectAlways : boolean (optional)
Collects a crash dump on expected as well as unexpected test host exit.

Available since: .NET 5.0 preview SDK
blameCrashDumpType : String (optional)
The type of crash dump to be collected. Implies --blame-crash.

Available since: .NET 5.0 preview SDK
blameHang : boolean (optional)
Run the tests in blame mode and collects a hang dump when a test exceeds the given timeout.

Available since: .NET 5.0 preview SDK
blameHangDumpType : String (optional)
The type of crash dump to be collected. It should be full, mini, or none. When none is specified, the test host is terminated on timeout, but no dump is collected. Implies --blame-hang.

Available since: .NET 5.0 preview SDK
blameHangTimeout : int (optional)
Per-test timeout, in milliseconds, after which a hang dump is triggered and the test host process and all of its child processes are dumped and terminated.
When used together with data driven tests, the timeout behavior depends on the test adapter used. For xUnit and NUnit the timeout is renewed after every test case. For MSTest, the timeout is used for all test cases. This option is supported on Windows with netcoreapp2.1 and later, on Linux with netcoreapp3.1 and later, and on macOS with net5.0 or later. Implies --blame and --blame-hang.

Available since: .NET 5.0 preview SDK
charset : String (optional)
The character set to use for the step's output. If not specified, the charset associated with the build will be used.
collect : String (optional)
Enables a data collector for the test run. For more information, see Monitor and analyze test run.
configuration : String (optional)
Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
continueOnError : boolean (optional)
If this is checked, errors encountered will cause the build status to be set to FAILURE (or UNSTABLE, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
diag : String (optional)
Enables diagnostic mode for the test platform and writes diagnostic messages to the specified file and to files next to it. The process that is logging the messages determines which files are created, such as *.host_<date>.txt for the test host log, and *.datacollector_<date>.txt for the data collector log.
filter : String (optional)
Filters out tests in the current project using the given expression. For more information, see the Filter option details section. For more information and examples on how to use selective unit test filtering, see Running selective unit tests.
framework : String (optional)
Forces the use of dotnet or a .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
listTests : boolean (optional)
List all of the discovered tests in the current project.
logger : String (optional)
Specifies a logger for test results. Unlike MSBuild, dotnet test doesn't accept abbreviations: instead of "console;v=d", use "console;verbosity=detailed".
noBuild : boolean (optional)
Doesn't build the project before packing, and does not perform an implicit restore.
noRestore : boolean (optional)
Doesn't execute an implicit restore when running the command.
nologo : boolean (optional)
Doesn't display the startup banner or the copyright message.

Available since: .NET Core SDK 3.0
option : String (optional)
options : Array / List of String (optional)
optionsString : String (optional)
For more information about these options, see the MSBuild Command-Line Reference.

If targets and/or properties are also configured, those will be passed after these options.
outputDirectory : String (optional)
Directory in which to find the binaries to run. If not specified, the default path is ./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a framework when you specify this option. dotnet test always runs tests from the output directory. You can use AppDomain.BaseDirectory to consume test assets in the output directory.
project : String (optional)
What to test. This can be one of:
- Path to a test project.
- Path to a solution.
- Path to a directory that contains a project or a solution.
- Path to a test project .dll file.
If not specified, it searches for a project or a solution in the current directory.
properties (optional)
- Type: java.util.Map<java.lang.String, java.lang.String>
propertiesString : String (optional)
Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
resultsDirectory : String (optional)
The directory where the test results are going to be placed. If the specified directory doesn't exist, it's created. The default is TestResults in the directory that contains the project file.
runSettings (optional)
- Type: java.util.Map<java.lang.String, java.lang.String>
runSettingsString : String (optional)
Inline RunSettings values, specified in in Java properties syntax.
runtime : String (optional)
The target runtime to test for.
sdk : String (optional)
Name of a .NET SDK to use so that dotnet will be in the path.
If the default is specified, you either need to use the With .NET element (or a withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
settings : String (optional)
The .runsettings file to use for running the tests. Note that the TargetPlatform element (x86|x64) has no effect for dotnet test. To run tests that target x86, install the x86 version of .NET Core. The bitness of the dotnet.exe that is on the path is what will be used for running tests.
showSdkInfo : boolean (optional)
If enabled, dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean (optional)
If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.

Note: If this is not specified, a build that causes such a build server to be started may hang until those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).

Available since: .NET Core SDK 2.1
specificSdkVersion : boolean (optional)
Depending on the platform, the dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.

Note: This will silently overwrite any global.json already present in the current directory.
testAdapterPath : String (optional)
Path to a directory to be searched for additional test adapters. Only .dll files with suffix .TestAdapter.dll are inspected. If not specified, the directory of the test .dll is searched.
unstableIfErrors : boolean (optional)
If this is set and the build completes with errors, the build will be marked as unstable instead of failed, and execution will continue to the next step.
unstableIfWarnings : boolean (optional)
If this is set and the build completes with warnings (but no errors), the build will be marked as unstable instead of successful.
verbosity : String (optional)
Sets the MSBuild verbosity level.
workDirectory : String (optional)
The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).

$class: 'TestBuilder'

packageid : String
Enter the ID of the NuGet package you built in the build step.
tempServer
- value : String
- serverName : String
- dbName : String
- serverAuth
  - value : String
  - username : String
  - password
    - Type: class hudson.util.Secret
- encryptConnection : boolean
- trustServerCertificate : boolean
runTestSet
- value : String
- runOnlyParams : String
generateTestData
- sqlgenPath : String
options : String
dataOptions : String
filter : String
packageVersion : String
Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
sqlChangeAutomationVersionOption
- value
  - Values: Latest, Specific
- specificVersion : String
testSource
- value
  - Values: scaproject, socartifact
- projectPath : String
- packageid : String
- packageVersion : String

$class: 'TestCompositionRunner'

url : String
cloudTestServerID : String
composition : String
The list of compositions to run, separated by newlines.
deleteOldResults
This setting allows you to control the storage consumption on the CloudTest server, by deleting the detailed test results from the server after it reaches a certain age. This does not have any impact on the data stored within Jenkins itself.
- maxDaysOfResults : int
additionalOptions : String
If you need to pass any other command line options to the Scommand utility, specify them here. You can separate options with new lines as well as whitespaces.
thresholds
- transactionname : String
- thresholdname : String
- thresholdvalue : String
- thresholdid : String
generatePlotCSV : boolean
Produces CSV output for each threshold that can be processed by the Plot Plugin to produce graphs of performance metrics across multiple builds.

testFolder

Execute a test folder.

testFile : String
executionConfig (optional)
- timeout : String
- stopOnError : boolean
- checkTestFile : boolean
- recordWarnings : boolean
failFast : boolean (optional)
packageConfig (optional)
- runTest : boolean
- runTraceAnalysis : boolean
- parameters
  Definition of ECU-TEST package parameters consisting of a unique name and a value.
  Numeric value entries will be automatically converted to Numeric type in ECU-TEST.
  For now only Numeric and String types are supported.
  Note: From ECU-TEST Version 2022.3 on, no invalid control characters are recognized anymore! In particular, this means that backslashes in Windows paths need to be escaped (C:\\my\\path instead of C:\my\path), such that 'Backslash - next character' is not interpreted as escape sequence, avoiding an error in ECU-TEST.
  - name : String
  - value : String
- outputParameters
  Definition of ECU-TEST package output parameter consisting of a unique name.
  Defined package output parameters are written to related environment variables after test execution has finished.
  The environment variable has the following syntax: TT_TEST_RETVAL_<VARIABLE NAME>_<INDEX>
  - name : String
projectConfig (optional)
- execInCurrentPkgDir : boolean
- filterExpression : String
- jobExecMode
  - Values: NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTION, TEST_GUIDE_EXECUTION
recursiveScan : boolean (optional)
scanMode (optional)
- Values: PACKAGES_ONLY, PROJECTS_ONLY, PACKAGES_AND_PROJECTS
testConfig (optional)
- tbcFile : String
- tcfFile : String
- forceReload : boolean
- loadOnly : boolean
- keepConfig : boolean
- constants
  Definition of global constants consisting of an unique name and a value. Numeric value entries will be automatically converted to a Python integer literal, or to a Python string literal.
  If the global constant does not exist it is created and saved instantly in the current test configuration.
  - name : String
  - value : String

$class: 'TestLinkBuilder'

testLinkName : String
testProjectName : String
testPlanName : String
platformName : String
buildName : String
customFields : String
testPlanCustomFields : String
executionStatusNotRun : boolean
executionStatusPassed : boolean
executionStatusFailed : boolean
executionStatusBlocked : boolean
singleBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
beforeIteratingAllTestCasesBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
iterativeBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
afterIteratingAllTestCasesBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
transactional : boolean
failedTestsMarkBuildAsFailure : boolean
failIfNoResults : boolean
failOnNotRun : boolean
resultSeekers
- $class: 'JUnitCaseClassNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachJUnitXML : boolean
  - includeNotes : boolean
- $class: 'JUnitCaseNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachJUnitXML : boolean
  - includeNotes : boolean
- $class: 'JUnitMethodNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachJUnitXML : boolean
  - includeNotes : boolean
- $class: 'JUnitSuiteNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachJUnitXML : boolean
  - includeNotes : boolean
- $class: 'TAPFileNameMultiTestPointsResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachTAPStream : boolean
  - attachYAMLishAttachments : boolean
  - includeNotes : boolean
  - compareFullPath : boolean
  - testpointsAsExecutions : boolean
- $class: 'TAPFileNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachTAPStream : boolean
  - attachYAMLishAttachments : boolean
  - includeNotes : boolean
  - compareFullPath : boolean
- $class: 'TestNGClassNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachTestNGXML : boolean
  - markSkippedTestAsBlocked : boolean
  - includeNotes : boolean
- $class: 'TestNGMethodNameDataProviderNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachTestNGXML : boolean
  - markSkippedTestAsBlocked : boolean
  - dataProviderNameKeyCustomField : String
  - includeNotes : boolean
- $class: 'TestNGMethodNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachTestNGXML : boolean
  - markSkippedTestAsBlocked : boolean
  - includeNotes : boolean
- $class: 'TestNGSuiteNameResultSeeker'
  - includePattern : String
  - keyCustomField : String
  - attachTestNGXML : boolean
  - markSkippedTestAsBlocked : boolean
  - includeNotes : boolean

$class: 'TestOdysseyBuilder'

jobId : String
projectId : String
minPassPercentage : String
Minimum Pass Percentage : provide the minimum pass percentage for the build to pass. Percentage is calculated as below : TC Passed * 100 /TC Executed

testPackage

Execute a ECU-TEST package.

testFile : String
executionConfig (optional)
- timeout : String
- stopOnError : boolean
- checkTestFile : boolean
- recordWarnings : boolean
packageConfig (optional)
- runTest : boolean
- runTraceAnalysis : boolean
- parameters
  Definition of ECU-TEST package parameters consisting of a unique name and a value.
  Numeric value entries will be automatically converted to Numeric type in ECU-TEST.
  For now only Numeric and String types are supported.
  Note: From ECU-TEST Version 2022.3 on, no invalid control characters are recognized anymore! In particular, this means that backslashes in Windows paths need to be escaped (C:\\my\\path instead of C:\my\path), such that 'Backslash - next character' is not interpreted as escape sequence, avoiding an error in ECU-TEST.
  - name : String
  - value : String
- outputParameters
  Definition of ECU-TEST package output parameter consisting of a unique name.
  Defined package output parameters are written to related environment variables after test execution has finished.
  The environment variable has the following syntax: TT_TEST_RETVAL_<VARIABLE NAME>_<INDEX>
  - name : String
testConfig (optional)
- tbcFile : String
- tcfFile : String
- forceReload : boolean
- loadOnly : boolean
- keepConfig : boolean
- constants
  Definition of global constants consisting of an unique name and a value. Numeric value entries will be automatically converted to a Python integer literal, or to a Python string literal.
  If the global constant does not exist it is created and saved instantly in the current test configuration.
  - name : String
  - value : String

levo-test-plan

target : String
testPlan : String
levoCredentialsId : String
generateJunitReport : boolean
CLI will output JUnit report file in <WORKPSACE>/levo-reports/junit.xml. Please refer to JUnit plugin documentation for more deatils
extraCLIArgs : String
secretEnvironmentId : String (optional)

testProject

Execute a ECU-TEST project.

testFile : String
executionConfig (optional)
- timeout : String
- stopOnError : boolean
- checkTestFile : boolean
- recordWarnings : boolean
projectConfig (optional)
- execInCurrentPkgDir : boolean
- filterExpression : String
- jobExecMode
  - Values: NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTION, TEST_GUIDE_EXECUTION
testConfig (optional)
- tbcFile : String
- tcfFile : String
- forceReload : boolean
- loadOnly : boolean
- keepConfig : boolean
- constants
  Definition of global constants consisting of an unique name and a value. Numeric value entries will be automatically converted to a Python integer literal, or to a Python string literal.
  If the global constant does not exist it is created and saved instantly in the current test configuration.
  - name : String
  - value : String

lrcRunTest

projectId : String (optional)
Project ID. You can find it in your LoadRunner Cloud URL.

For example: https://loadrunner-cloud.saas.microfocus.com/home/?TENANTID=354274891&projectId=1. Project ID is 1.
testId : String (optional)
Test ID. Navigate to the General page of target load test in LoadRunner Cloud to see the ID.
sendEmail : boolean (optional)
Send email after test run

$class: 'TestRunner'

stack : String
The GitHub repository where the stack is stored, in the form <owner>/<name> (no spaces!).
branch : String
The repository branch to test.
testNames : String
A comma-separated list of test names to run. Leave empty to run all tests.
undeploy : boolean
Whether to terminate the test harness machine after test execution.
apiKey : String
The Stack Hammer API key, copied from the stack settings dialog in the Stack Hammer user interface.

$class: 'TestStepBuilder'

packageId : String
serverType : String
server : String
database : String
authenticationType : String
userName : String
password
- Type: class hudson.util.Secret
runTestMode : String
runTests : String
compareOptions : String (optional)
dgenFile : String (optional)
filterFile : String (optional)
generateTestData : boolean (optional)
transactionIsoLvl : String (optional)

$class: 'TestStudioAPITestBuilder'

Jenkins plugin for execution of Progress Test Studio for API tests.

apiRunnerPath : String (optional)
Full path to Test Studio for API Runner executable.
project : String (optional)
The path to the project folder.
test : String (optional)
Specify test/tests to run, one per line.

Example:
.\CRUD Tests\Get All Users
.\Get User Id By Its Username
startFrom : String (optional)
stopAfter : String (optional)
variable : String (optional)
Specify test parameters in key=value pairs, one pair per line.

Example:
url=http://localhost:5000
user-name="John Smith"
dontSaveContexts : boolean (optional)
testAsUnit : boolean (optional)
If checked Test Studio for API test will be converted to JUnit test, else test will be converted to testsuite and test steps will be converted to JUnit test.

$class: 'TestStudioTestBuilder'

Jenkins plugin for execution of Progress Test Studio tests.

artOfTestRunnerPath : String
Full path to TestStudio Runner executable.
testPath : String
The full path to the .tstest test or .aiilist (test list) to run.
settingsPath : String
The path to a XML file containing the custom params and/or settings for the run.

dateFormat : String

Date and time format used in StartTime and EndTime result fields. If empty default format "yyyy-mm-dd'T'HH:mm:ss" is used.

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
Y	Week year	Year	2009; 09
M/L	Month in year	Month	July; Jul; 07
w	Week in year	Number	27
W	Week in month	Number	2
D	Day in year	Number	189
d	Day in month	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue
u	Day number of week	Number	1
a	Am/pm marker	Text	PM
H	Hour in day (0-23)	Number	0
k	Hour in day (1-24)	Number	24
K	Hour in am/pm (0-11)	Number	0
h	Hour in am/pm (1-12)	Number	12
m	Minute in hour	Number	30
s	Second in minute	Number	55
S	Millisecond	Number	978
z	Time zone	General time zone	Pacific Standard Time; PST; GMT-08:00
Z	Time zone	RFC 822 time zone	-0800
X	Time zone	ISO 8601 time zone	-08; -0800; -08:00

Input string	Pattern
2001.07.04 AD at 12:08:56 PDT	yyyy.MM.dd G 'at' HH:mm:ss z
Wed, Jul 4, '01	EEE, MMM d, ''yy
12:08 PM	h:mm a
12 o'clock PM, Pacific Daylight Time	hh 'o''clock' a, zzzz
0:08 PM, PDT	K:mm a, z
02001.July.04 AD 12:08 PM	yyyyy.MMMM.dd GGG hh:mm aaa
Wed, 4 Jul 2001 12:08:56 -0700	EEE, d MMM yyyy HH:mm:ss Z
010704120856-0700	yyMMddHHmmssZ
2001-07-04T12:08:56.235-0700	yyyy-MM-dd'T'HH:mm:ss.SSSZ
2001-07-04T12:08:56.235-07:00	yyyy-MM-dd'T'HH:mm:ss.SSSXXX
2001-W27-3	YYYY-'W'ww-u

projectRoot : String (optional)
The path to the project root folder.
testAsUnit : boolean (optional)
If checked TestStudio test will be converted to JUnit test, else test steps will be converted.
outputPath : String (optional)

$class: 'TestSwarmBuilder'

testswarmServerUrl : String
jobName : String
userName : String
authToken : String
maxRuns : String
chooseBrowsers : String
pollingIntervalInSecs : String
timeOutPeriodInMins : String
minimumPassing : String
testSuiteList
- testName : String
- testUrl : String
- testCacheCracker : boolean
- disableTest : boolean

testweaver

projectPath : String
experimentName : String
jUnitReportDirectory : String
acceptInconclusiveWatchers : boolean (optional)
exportAsCsvDecimalSeparator : String (optional)
exportAsCsvDirectory : String (optional)
exportAsCsvNoQuote : boolean (optional)
exportAsCsvQuote : String (optional)
exportAsCsvReports : String (optional)
exportAsCsvSeparator : String (optional)
htmlReportDirectory : String (optional)
instrumentView : boolean (optional)
namespacePattern : String (optional)
parameterValues : String (optional)
runScenarioLimit : int (optional)
runTimeLimit : long (optional)
silverParameters : String (optional)

$class: 'TesteinRunBuilder'

targetType : String
targetId : String
Id of the target, that you want to run. Could be found on the target's detail page
downloadReport : boolean
If checked, execution report will be downloaded in format Testein-Report-{runId}.html
downloadLogs : boolean

$class: 'TesteinUploadStepBuilder'

enableJs
- jsFilePath : String
- jsonFilePath : String
enableJar
- jarFilePath : String
overwrite : boolean
If checked, upload will overwrite existing test step. If not checked and test step already exists - an error will be generated

$class: 'TestingBotBuilder'

name : String

$class: 'TestopiaBuilder'

testopiaInstallationName : String
testRunId : int
singleBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
beforeIteratingAllTestCasesBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
iterativeBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
afterIteratingAllTestCasesBuildSteps : Array / List of Build Step (hudson.tasks.BuildStep)
failedTestsMarkBuildAsFailure : boolean
resultSeekers
- $class: 'JUnitCaseClassNameResultSeeker'
  - includePattern : String
- $class: 'JUnitCaseNameResultSeeker'
  - includePattern : String
- $class: 'JUnitMethodNameResultSeeker'
  - includePattern : String
- $class: 'JUnitSuiteNameResultSeeker'
  - includePattern : String
- $class: 'TAPFileNameResultSeeker'
  - includePattern : String
- $class: 'TestNGClassNameResultSeeker'
  - includePattern : String
  - markSkippedTestAsBlocked : boolean
- $class: 'TestNGMethodNameResultSeeker'
  - includePattern : String
  - markSkippedTestAsBlocked : boolean
- $class: 'TestNGSuiteNameResultSeeker'
  - includePattern : String
  - markSkippedTestAsBlocked : boolean

convertTestsToRun

This build step is intended to support execution of automated tests from Micro Focus ALM Octane.
The builder searches for the "testsToRun" parameter which is sent from ALM Octane as part of the execution framework.
Once it is found, its value is converted to the format of the selected testing framework, and injected to the "testsToRunConverted" environment parameter.
Later, the new parameter can be used in the appropriate execution builder.

To use in parameter textboxes, use the following syntax: ${testsToRunConverted}

To use in the scripts, use the following syntax:

Linux shell: $testsToRunConverted
Windows batch command: %testsToRunConverted%
Pipeline script (workflow job): "${params.testsToRunConverted}"

See examples in the tables below:

Framework	Linux shell
Maven Surefire	mvn clean -Dtest=$testsToRunConverted test
Maven Failsafe	mvn clean -Dit.test=$testsToRunConverted verify
Gradle	gradle test $testsToRunConverted
Protractor	protractor conf.js --grep="$testsToRunConverted"
Cucumber-JVM over Maven/ BDD Scenario	mvn clean -Dcucumber.options="$testsToRunConverted" test
JBehave over Maven	mvn clean -Dfeatures="$testsToRunConverted" test

Framework	Windows batch command
Maven Surefire	mvn clean -Dtest=%testsToRunConverted% test
Maven Failsafe	mvn clean -Dit.test=%testsToRunConverted% verify
Gradle	gradle test %testsToRunConverted%
Protractor	protractor conf.js --grep="%testsToRunConverted%"
Cucumber-JVM over Maven/ BDD Scenario	mvn clean -Dcucumber.options="%testsToRunConverted%" test
JBehave over Maven	mvn clean -Dfeatures="%testsToRunConverted%" test

Framework	Pipeline script
Maven Surefire	bat 'mvn clean -Dtest=${params.testsToRunConverted} test'
Maven Failsafe	bat 'mvn clean -Dit.test=${params.testsToRunConverted} verify'
Gradle	bat 'gradle test ${params.testsToRunConverted}'
Protractor	bat(/protractor conf.js --grep="${params.testsToRunConverted}"/)
Cucumber-JVM over Maven/ BDD Scenario	bat(/mvn clean -Dcucumber.options="${params.testsToRunConverted}" test/)
JBehave over Maven	bat(/mvn clean -Dfeatures="${testsToRunConverted}" test/)

Notes/Limitations :

UFT: In order to build a UFT MTBX file, this builder needs to know the test check-out directory. By default this is the job workspace directory. If tests are checked out in another directory, define in the job a String parameter "testsToRunCheckoutDirectory" with the correct directory.
JUnit/TestNG: Supported for JUnit 4.7+, Surefire Plugin 2.19+, Failsafe Plugin 2.12.1+.
Cucumber-JVM over Maven: If your project contains several run classes, specify a run class that will be used, otherwise all run classes will be executed by Cucumber. You can specify test runner by adding: '-Dtest=[runner class name]' to the Maven command
JBehave over Maven: read more about integration with JBehave here

See more help information in ALM Octane Help Center

framework : String
Select the testing framework whose format you want to convert to.
format : String
In the 'Custom conversion format' field, enter json that describes how to convert tests from raw format to the format of your testing framework. After conversion, the result is injected to the "testsToRunConverted" parameter.

Note: Click "Validate" to check the correctness of the inserted configuration.

The following are the components that you can use in the "Custom conversion format" :
- testPattern - describes the pattern for converting single test. All parameters that needs to be replaced be real test data, should start with $, for example $package, $class, $testName, $externalRunId, $myCustomParam. All other characters in the pattern will appear in the final result as is.
- testDelimiter - the delimiter used to separate different tests.
- prefix - a prefix for the whole conversion result.
- suffix - a suffix for the whole conversion result.
- allowDuplication - indicate whether duplications are allowed in final result. Default is true.
- testsToRunConvertedParameter - the parameter name that will contain the conversion result. Default value is "testsToRunConverted".
- replacements - the array of replace methods.
The minimal configuration is:
```
{
    "testPattern": "$package.$class#$testName",
    "testDelimiter": ","
}
    
```
For example:

The testsToRun parameter received 2 tests separated by a semicolon: v1:myPackage1|myClass1|myTest1;myPackage2|myClass2|myTest2
The defined testPattern is: $package.$class#$testName
The defined testDelimiter is: ,
- $package variable will get a value of myPackage1 for the first test and myPackage2 for the second test.
- $class variable will get a value of myClass1 for the first test and myClass2 for the second test.
- $testName variable will get a value of myTest1 for the first test and myTest2 for the second test.
The testsToRunConverted parameter will be equal: myPackage1.myClass1#myTest1,myPackage2.myClass2#myTest2

Optional:
There is a possibility to alter values received from ALM Octane, for example to set lowercase to the testName, replace spaces by '_', and so on.
Here are examples of available replace methods. Each replace method contains "target" property that define what parts of the test pattern are affected by replace method, available values are $package,$class,$testName. Its possible to put several values separated by '|'. The replacements are executed in the order they appear in the 'Custom conversion format' json.
```
"replacements": [
{
    "type": "replaceRegex",
    "target": "$package|$class|$testName",
    "regex": "aaa",
    "replacement": "bbb",
    "description": "Replaces all the sequence of characters matching the regex with a replacement string."
},{
    "type": "replaceRegexFirst",
    "target": "$package|$class|$testName",
    "regex": "aaa",
    "replacement": "bbb",
    "description": "Replaces the first substring that matches the given regex with the given replacement. For example, given regex '@(.*)@.*' , replacement '$1', and test name '@myTag@ my test name' - will replace test name by the content located between @, that is - 'myTag'."
},{
    "type": "replaceString",
    "target": "$package|$class|$testName",
    "string": "xxx",
    "replacement": "yyy",
    "description": "Replaces all occurrences of ‘string’ with ‘replacement’."
},{
    "type": "joinString",
    "target": "$package|$class|$testName",
    "prefix": "xxx",
    "suffix": "yyy",
    "description": "Add prefix and suffix to the test template."
},{
    "type": "toLowerCase",
    "target": "$package|$class|$testName",
    "description": "Convert test template to lower case."
},{
    "type": "toUpperCase",
    "target": "$package|$class|$testName",
    "description": "Convert test template to upper  case."
},{
    "type": "notLatinAndDigitToOctal",
    "target": "$package|$class|$testName",
    "description": "Replaces all non-latin characters and digits ^[a-zA-Z0-9] to their ASCII octal value."
}]
```

$class: 'TestsigmaExecutionBuilder'

apiEndPoint : String
Testsigma Rest API end point.Ex: http://localhost:8080/api/v1
For more info visit Testsigma documentation.
apiKey : String
You can generate Testsigma API key by logging in to Testsigma App and navigating to Configuration-->Api Keys.
For more info visit Testsigma documentation.
testPlanId : String
You can get TestPlan Id by logging in to Testsigma App and navigating to Test Plans-->Test Plan Name-->CI/CD Integrations. For more info visit Testsigma documentation.
maxWaitInMinutes : String
Time in minutes build step waits for the completion of Testsigma Test Plan run. If Test Plan run is taking more time than specified, the build step will exit with a success state. However you can check execution results by logging in to Testsigma App.
For more info visit Testsigma documentation.
reportsFilePath : String
Test execution reports (in Junit Report format) will be copied to given file.
For more info visit Testsigma documentation.

$class: 'TicsAnalyzer'

ticsPath : String
The fully qualified directory where TICS is located, e.g. C:\Program Files\TIOBE\TICS\BuildServer. This directory should contain the TICSQServer executable. You can leave this field empty if these executables can be found on the PATH environment variable of the Jenkins agent user or if you checked the "Install TICS command-line tools" checkbox.
ticsConfiguration : String
Τhe TICS Configuration is a URL pointing to the 'cfg' API endpoint of the TICS Viewer. It is of the following format https://192.168.1.1/tiobeweb/TICS/api/cfg?name=-. This URL contains the name of the TICS Analyzer Configuration or '-' in case of the default configuration. Please ask your TICS Representative to provide you with a valid configuration name.

For TICS installations using the legacy deployment architecture, TICS Configuration points to the configuration directory, e.g. C:\Program Files (x86)\TIOBE\TICS\FileServer\cfg. The TICS configuration directory contains the SERVER.yaml and PROJECTS.yaml configuration files, among others. This setting sets the TICS environment variable before executing TICSQServer. You can leave this field empty if this variable is already set on the Jenkins slave.
projectName : String
The name of the project for which this run should be performed. This project should already exist in the TICS Configuration as you cannot create a new project using this plugin. You can create a new project by using the Build Configuration page of the Viewer or by using TICSMaintenance from the command line. Note that you can use Jenkins environment variables such as $JOB_NAME here.
branchName : String
The name of the branch for which the run should be performed. Although most projects only have one branch (named "trunk", "main", or "master"), you still need to specify the branch name here because more branches might be added later. To find out the branches of a project you can use the Build Configuration page of the TICS Viewer.
branchDirectory : String
The branch directory is the root directory of the source files for the branch. If this setting is provided, the branch directory will be updated prior to each TICSQServer run by invoking TICSMaintenance -branchdir. Note that you can use Jenkins variables (such as $WORKSPACE) here.
environmentVariables : String
A new-line separated list of environment variables that will be set before invoking TICSQServer. Some TICS modules and code checkers might need configuration using environment variables. Note that you can use environment variables such as $WORKSPACE here. Example:
```
TICS_M2_OPTS=-s C:\Tools\apache-maven\conf\settings.xml
TICS_COVERITY_URL=http://localhost:8080
QACBIN=C:/QAC/common/bin
PATH=C:\Tools\bin;$PATH
```
createTmpdir : boolean
tmpdir : String
TICSQServer will create a directory named "ticstmpdir" in this directory. This tmpdir will contain log files useful for debugging problems encountered during the TICSQServer analysis. You can use Jenkins variables here. Example: C:/temp/$JOB_NAME.
extraArguments : String
Extra arguments to pass to the TICSQServer invocation.
calc
Check one or more metrics to have TICSQServer only calculate these metrics (for changed files). If nothing is checked, all metrics will be calculated.
- ABSTRACTINTERPRETATION : boolean
- ACCUCHANGERATE : boolean
- ACCUFIXRATE : boolean
- ACCULINESADDED : boolean
- ACCULINESCHANGED : boolean
- ACCULINESDELETED : boolean
- ALL : boolean
- AVGCYCLOMATICCOMPLEXITY : boolean
- BUILDRELATIONS : boolean
- CHANGEDFILES : boolean
- CHANGERATE : boolean
- CODINGSTANDARD : boolean
- COMPILERWARNING : boolean
- DEADCODE : boolean
- DUPLICATEDCODE : boolean
- ELOC : boolean
- FANOUT : boolean
- FINALIZE : boolean
- FIXRATE : boolean
- GLOC : boolean
- INCLUDERELATIONS : boolean
- INTEGRATIONTESTCOVERAGE : boolean
- LINESADDED : boolean
- LINESCHANGED : boolean
- LINESDELETED : boolean
- LOC : boolean
- MAXCYCLOMATICCOMPLEXITY : boolean
- PREPARE : boolean
- SECURITY : boolean
- SYSTEMTESTCOVERAGE : boolean
- TOTALTESTCOVERAGE : boolean
- UNITTESTCOVERAGE : boolean
recalc
Check one or more metrics to have TICSQServer recalculate these metrics, even for unchanged files. If nothing is checked, TICSQServer does not force recalculation of metrics for unchanged files.
- ABSTRACTINTERPRETATION : boolean
- ACCUCHANGERATE : boolean
- ACCUFIXRATE : boolean
- ACCULINESADDED : boolean
- ACCULINESCHANGED : boolean
- ACCULINESDELETED : boolean
- ALL : boolean
- AVGCYCLOMATICCOMPLEXITY : boolean
- BUILDRELATIONS : boolean
- CHANGEDFILES : boolean
- CHANGERATE : boolean
- CODINGSTANDARD : boolean
- COMPILERWARNING : boolean
- DEADCODE : boolean
- DUPLICATEDCODE : boolean
- ELOC : boolean
- FANOUT : boolean
- FINALIZE : boolean
- FIXRATE : boolean
- GLOC : boolean
- INCLUDERELATIONS : boolean
- INTEGRATIONTESTCOVERAGE : boolean
- LINESADDED : boolean
- LINESCHANGED : boolean
- LINESDELETED : boolean
- LOC : boolean
- MAXCYCLOMATICCOMPLEXITY : boolean
- PREPARE : boolean
- SECURITY : boolean
- SYSTEMTESTCOVERAGE : boolean
- TOTALTESTCOVERAGE : boolean
- UNITTESTCOVERAGE : boolean
installTics : boolean
By enabling this checkbox the TICS command-line tools will be installed. For TICS installations using the legacy deployment architecture, this checkbox should not be used and TICS should be installed manually on the machine that runs this job.
credentialsId : String

runTics

projectName : String
branchName : String
branchDirectory : String (optional)
calc : Array / List of String (optional)
credentialsId : String (optional)
environmentVariables (optional)
- Type: java.util.LinkedHashMap<java.lang.String, java.lang.String>
extraArguments : String (optional)
installTics : boolean (optional)
recalc : Array / List of String (optional)
ticsBin : String (optional)
ticsConfiguration : String (optional)
tmpdir : String (optional)

totaltestUT

connectionId : String
This field specifies the host connection to use to execute on.
Host connections can be configured in the Jenkins system configuration (Manage Jenkins -> Configure System).
credentialsId : String
The available credentials to use for logging onto the host. Alternatively, click Add to add credentials using the Credentials Plugin. Refer to the Jenkins documentation for the Credentials Plugin.
projectFolder : String
The path to the Total Test project folder containing the test scenario or test suite to run.
testSuite : String
A comma separated list of Total Test test scenarios/suites names. On Windows the names are case-insensitive.
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
jcl : String
The name of the JCL file to run the Total Test test scenario or test suite.
ccClearStats : boolean (optional)
Indicates if the Code Coverage repository statistics should be cleared before running the test.
ccDB2 : boolean (optional)
ccPgmType : String (optional)
The type of the program specified on the EXEC statement, in the JCL, for the Total Test step. If PGM=IKJEFT01 was specified, select "Live DB2". When PGM=DFSRRC00 was specified select "Live IMS", otherwise select TotalTest.
ccRepo : String (optional)
The dataset where Total Test will write coverage information. This dataset will later be fed into the Code Coverage reporting system. Members with like systems, names, and compile date and times will automatically be merged together.
ccSystem : String (optional)
A system name for this test. Code Coverage keeps statistics by programs separate by system name. This name can be any-specified name. The name must be 16 characters or less and will be converted to upper-case when the test is run.s. If not specified defaults to the test scenario/suite name.
ccTestId : String (optional)
A test identification to be added to the Code Coverage test. This information can be useful when reviewing test reports from Code Coverage. This test identification can be any-specified string. The test identification must be 16 characters or less and will be converted to upper-case when the test is run. If not specified defaults to the test scenario/suite name.
deleteTemp : boolean (optional)
Delete temporary files after test run. The default is to delete temporary files.
hlq : String (optional)
Optional high level qualifier to be used when allocating datasets.
hostPort : String (optional)
recursive : boolean (optional)
Indicates if the test runner should recursively check for Total Test Unit Test projects. The default is not to recursively check for Total Test Unit Test projects..
useStubs : boolean (optional)
Indicates if stubs should be used when running the test scenario or test suite. The default is to use stubs.

totaltest

environmentId : String
Environment ID of the environment defined in the Total Test repository server or local TotalTestConfiguration directory where tests are executed.
folderPath : String
- Folder path to the test scenario or context file(s) to execute (.xactx or .xaunit)
- A relative path or an empty string will set the folder path relative to the Jenkins workspace directory
- An absolute path can also be used to specify Test folder path
serverUrl : String
This field specifies the CES URL where the Total Test repository server is published on.
The CES URL can be configured in Jenkins system configuration (Manage Jenkins -> Configure System -> BMC Configurations -> Host Connections).
serverCredentialsId : String
The available credentials to use for logging onto CES (used only when using the Total Test repository server). Alternatively, click Add to add credentials using the Credentials Plugin. Refer to the Jenkins documentation for the Credentials Plugin.
connectionId : String
This field specifies the host connection to use to execute on.
Host connections can be configured in the Jenkins system configuration (Manage Jenkins -> Configure System).
credentialsId : String
The available credentials to use for logging onto the host. Alternatively, click Add to add credentials using the Credentials Plugin. Refer to the Jenkins documentation for the Credentials Plugin.
sonarVersion : String (optional)
SonarQube version 5 or 6
logLevel : String (optional)
Set the logging level to be used when executing the test.
accountInfo : String (optional)
Optional job account information.
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
ccThreshold : int (optional)
clearCodeCoverage : boolean (optional)
collectCCRepository : String (optional)
collectCCSystem : String (optional)
collectCCTestID : String (optional)
collectCodeCoverage : boolean (optional)
Select this option to collect Code Coverage information during test execution.
compareJUnits : boolean (optional)
contextVariables : String (optional)
Execution context variable in the format "field1=value1,field2=value2".
createJUnitReport : boolean (optional)
createReport : boolean (optional)
createResult : boolean (optional)
createSonarReport : boolean (optional)
customerId : String (optional)
BMC customer id for use on the BMC cloud license server.
This is required for obtaining a license from the BMC license server.
enterpriseDataHostPort : String (optional)
This field allows you to specify the host and port of the Enterprise Data Communication Manager to connect to. The host and port must be separated by a ':' character.
enterpriseDataWorkspace : String (optional)
The BMC AMI DevX Data Studio Communication Manager's workspace.
haltAtFailure : boolean (optional)
haltPipelineOnFailure : boolean (optional)
jclPath : String (optional)
The path to the JCL file to use when executing '.testscenario' files.
jsonFile : String (optional)
Optional JSON file containing tests to execute.
Use the JSON file field to enter a JSON file containing the tests to execute.
Note: This field is only used for Total Test CLI version 20.04.01 and later
localConfig : boolean (optional)
When selected use the defined local TotalTestConfiguration directory. Otherwise use the Total Test repository server running on the CES server.
localConfigLocation : String (optional)
Optional location of TotalTestConfiguration directory.
programList : String (optional)
Optional comma separated list of tests tests to execute.
Use the Test list field to enter a comma separated list of program names to be tested. Will only include test scenarios that have component under test defined as one of these
Note: This field is only used for Total Test CLI version 20.04.01 and later
recursive : boolean (optional)
Should test scenarios be found recursively in the folder
reportFolder : String (optional)
The folder path containing produced test results vary depending on the Total Test CLI version.
- Total Test CLI version 20.03.01 and later
- Total Test CLI version prior to 20.03.01
Note: This field is only used for Total Test CLI version prior to 20.03.01
selectEnvironmentRadio : String (optional)
selectProgramsOption : boolean (optional)
selectProgramsRadio : String (optional)
siteId : String (optional)
BMC customer's site id for use on the BMC cloud license server.
This is required for obtaining a license from the BMC license server.
sourceFolder : String (optional)
Optional file path to a folder that contains source code of tested programs.
Default is COBOL.
It is only used to set the source path.
stopIfTestFailsOrThresholdReached : boolean (optional)
Stop if test fails or threshold is reached (default is true)
uploadToServer : boolean (optional)
useEnterpriseData : boolean (optional)
useScenarios : boolean (optional)
Should .scenarios files be used instead of .context files

$class: 'ToxBuilder'

toxIni : String
recreate : boolean
toxenvPattern : String

tptExecute

The "Execute TPT test cases" build step can run in two modes.

Just execute the tests within this Job. The given values will be used to create a command that will be executed. This command could be typed into the command line and would work.
Use this Job as a Master. In this mode the TPT RMI API is used to read the test cases that must be executed. For every test case a slave job is started and parameters are provided that can be used by the "Execute TPT tests slave" build step. The slaves copy their reults back to the master and the master will aggregate the test results.

The master mode can be activated and configured by clicking on the "Advanced" button.

exePaths : String
executionConfiguration
- tptFile : String
- configuration : String
- id : String
- enableTest : boolean (optional)
- reportDir : String (optional)
- testSet : String (optional)
- testdataDir : String (optional)
- timeout : long (optional)
arguments : String (optional)
enableJunit : boolean (optional)
isTptMaster : boolean (optional)
jUnitLogLevel (optional)
- Values: NONE, ERROR, WARNING, INFO, ALL
jUnitreport : String (optional)
slaveJob : String (optional)
slaveJobCount : String (optional)
slaveJobTries : String (optional)
tptBindingName : String (optional)
tptPort : String (optional)
tptStartUpWaitTime : String (optional)

tptAgent

This build step expects to be executed in a job started by an "Execute TPT test cases" build step in master mode. The master job will provide some parameters used by this build step. It will execute excatly one test case and copies the result back to the master node. To execute a single test case the build step uses the TPT RMI API. The Job should be only run once on every Computer. You can achive that e.g. by Throttle Concurrent Builds Plugin

exePaths : String
arguments : String (optional)
tptBindingName : String (optional)
tptPort : String (optional)
tptStartUpWaitTime : String (optional)

tricentisCI

newTricentisClientPath : String
newEndpoint : String
configurationFilePath : String (optional)

Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.

If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
endpoint : String (optional)

Specify the address of the webservice. This component triggers the test execution.

If you execute your tests via Tosca Remote Service, the endpoint needs to point to the TOSCARemoteExecutionService (e.g. http://servername:8732/TOSCARemoteExecutionService/).

If you execute your tests via Tosca Distributed Execution, the endpoint needs to point to the Manager Service of the Tosca Distribution Server (e.g. http://servername:8732/DistributionServerService/ManagerService.svc).
testEvents : String (optional)

Input the TestEvents that you want to execute, separated by semicolons. You can identify the TestEvents with their name or their system ID.

This field is optional. It can only be used if you execute your tests via Tosca Distributed Execution.

If you use this setting, leave the Configuration File setting of this page empty. Otherwise, this build step fails.
tricentisClientPath : String (optional)

Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.

If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.

$class: 'TriggerBuilder'

configs
- projects : String
  A comma separated list of projects to build
- block
  When activating this option, triggered builds will be run synchronously. The result of the current build step or the current build can then be controlled using the three following options:
  - Fail this build step if the triggered build is worse than or equal to: This option takes precedence over the two following ones if its value is not never. In that case, the result of the current build step (that is, success or failure) is based on the result of the triggered builds. If the condition defined for at least one of the triggered build is met, then the build step will be considered as failed.
  - Mark this build as failed if the triggered build is worse than or equal to: This option takes precedence over the next one if its value is not set to never. In that case, the current build will be considered as failed based on the result of the triggered builds and the value of the option.
  - Mark this build as unstable if the triggered build is worse than or equal to: This option is taken into account if its value is not never. In that case, the build will be considered as unstable based on the result of the triggered builds and the value of this option.
  With this option enabled the builds for the projects triggered are available as Env variables for future build steps:
  - LAST_TRIGGERED_JOB_NAME: "Last project started"
  - TRIGGERED_JOB_NAMES: "Comma separated list of all triggered projects"
  - TRIGGERED_BUILD_NUMBER_<project name>: "Last build number triggered"
  - TRIGGERED_BUILD_NUMBERS_<project name>: "Comma separated list of build numbers triggered"
  - TRIGGERED_BUILD_RESULT_<project name>: "Last triggered build result of project"
  - TRIGGERED_BUILD_RESULT_<project name>_RUN_<build number>: "Result of triggered build for build number"
  - TRIGGERED_BUILD_RUN_COUNT_<project name>: "Number of builds triggered for the project"
  All Project names have characters other than a-zA-Z and 0-9 are replaced by "_" (multiple characters are condensed into a single "_").
  - buildStepFailureThreshold : String
  - unstableThreshold : String
  - failureThreshold : String
- configFactories
  - $class: 'AllNodesBuildParameterFactory'
    Trigger the specified project on every node that's capable of running a build — those that are online and have non-zero executors configured.
  - $class: 'AllNodesForLabelBuildParameterFactory'
    This parameter factory defines where the target job should be executed. For each node matching the label a LabelParameter is generated, therefore the target job(s) are triggered for each node with the given label.
    If the label does not match any node then exactly one parameter will be generated having the entered label as parameter.
    - name : String
      The name of the parameter to set. If there already is a label parameter on the target node, then this name should be the same.
    - nodeLabel : String
      
      The Label for which the parameters should be generated. For each Node matching the Label a NodeLabelParameter is generated. If no Node matches the Label then the job(s) are triggered with the unaltered Label - the job will therefore just stay in the build queue.
      
      The label can be static or a token to be expanded by the token macro plugin.
    - ignoreOfflineNodes : boolean
  - $class: 'BinaryFileParameterFactory'
    Look for files that match the specified pattern in the current build, then for each of them trigger a build of the specified project(s) by passing that file as a file parameter.
    This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
    
    This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
    - parameterName : String
    - filePattern : String
      A GLOB pattern (such as 'foo/**/*.zip') relative to the workspace of this job, which specifies files that are passed to child projects.
    - noFilesFoundAction
      Values: SKIP, NOPARMS, FAIL
  - $class: 'CounterBuildParameterFactory'
    This Parameter Factory generates a sequence of numbers as parameters. More precisely, for each number from From to To with step size Step the Parameters section is evaluated replacing $COUNT with the current number.
    For each different number a build of the project(s) is triggered. If the sequence is empty no builds will be triggered.
    - from : String
      From where to count. Build variables will be replaced.
    - to : String
      Count up to including. Build variables will be replaced.
    - step : String
      Increment to use. Build variables will be replaced.
    - paramExpr : String
      KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
      The expression $COUNT or ${COUNT} will be replaced with the current count.
    - validationFail
      This option determines the behaviour to take if the from,to and step values do not form a valid combination. One that gives a finite number of combinations.
      The actions that can be taken are:
      
      Fail the build step This will fail the buildstep with a RuntimeException. (This is the default, and occured in older versions)
      
      Don't trigger these projects This will cause the projects not to be triggered at all for this configuration.
      
      Skip these parameters This will allow the projects to be triggered without these parameters.
      
      Values: FAIL, SKIP, NOPARMS
  - $class: 'CounterGeneratorParameterFactory'
    This ParameterFactory generates a sequence of numbers as parameters. More precisely, for each number from From to To with step size Step the Parameters section is evaluated replacing $COUNT with the current number.
    For each different number a build of the project(s) is triggered. If the sequence is empty no builds will be triggered.
    - from : String
      From where to count. Generator variables will be replaced.
    - to : String
      Count up to including. Generator variables will be replaced.
    - step : String
      Increment to use. Generator variables will be replaced.
    - paramExpr : String
      KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current generator parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
      The expression $COUNT or ${COUNT} will be replaced with the current count.
    - validationFail
      This option determines the behaviour to take if the from,to and step values do not form a valid combination. One that gives a finite number of combinations.
      The actions that can be taken are:
      
      Fail the build step This will fail the buildstep with an RuntimeException. (This is the default, and occured in older versions)
      
      Don't trigger these projects This will cause the projects not to be triggered at all for this configuration.
      
      Skip these parameters This will allow the projects to be triggered without these parameters.
      
      Values: FAIL, SKIP, NOPARMS
  - $class: 'FileBuildParameterFactory'
    This Parameter Factory generates parameters based on the contents of the files found.
    For each different file found a build of the project(s) is triggered.
    - filePattern : String
      File wildcard pattern for for finding parameter list files. For example 'Param*.txt' would generate a new configuration for each file that matches the pattern and use the properties defined in each file.
    - encoding : String
      Specify the encoding of contents of the files. If not specified, default encoding of the platform is used.
    - noFilesFoundAction
      This option determines the behaviour to take if no files are found that match the pattern.
      The actions that can be taken are:
      
      Don't trigger these projects This will cause the projects not to be triggered at all for this configuration.
      
      Skip these parameters This will allow the projects to be triggered without these parameters. (This is the default, and occured in older versions)
      
      Fail the build step This will fail the buildstep with a RuntimeException.
      
      Values: SKIP, NOPARMS, FAIL
  - $class: 'FileGeneratorParameterFactory'
    This ParameterFactory generates parameters based on the contents of the files found.
    For each different file found a build of the project(s) is triggered.
    - filePattern : String
      File wildcard pattern for for finding parameter list files. For example 'Param*.txt' would generate a new configuration for each file that matches the pattern and use the properties defined in each file.
    - noFilesFoundAction
      This option determines the behaviour to take if no files are found that match the pattern.
      The actions that can be taken are:
      
      Don't trigger these projects This will cause the projects not to be triggered at all for this configuration.
      
      Skip these parameters This will allow the projects to be triggered without these parameters. (This is the default, and occured in older versions)
      
      Fail the build step This will fail the buildstep with an RuntimeException.
      
      Values: SKIP, NOPARMS, FAIL
  - $class: 'MultipleBinaryFileParameterFactory'
    - parametersList
      Type: class org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBinding
    - noFilesFoundAction
      Values: SKIP, NOPARMS, FAIL
  - $class: 'NodeListBuildParameterFactory'
    This parameter factory defines where the target job should be executed. For each node in the given list, a job is triggered.
    - name : String
      The name of the parameter to set. If there already is a node parameter on the target node, then this name should be the same.
    - nodeListString : String
      A comma separated list of nodes to execute the job on. The list can be static or contain tokens to be expanded by the token macro plugin
- configs
  - $class: 'BooleanParameters'
    - configs
      This passes Boolean parameters to the downstream jobs
      
      Array / List of Nested Object
      name : String
      
      value : boolean
  - $class: 'CurrentBuildParameters'
  - $class: 'FileBuildParameters'
    - propertiesFile : String
      Comma separated list of absolute or relative paths to file(s) that contains the parameters for the new project. Relative paths are originated from the workspace. The file should have KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
    - encoding : String
      Specify the encoding of contents of the files. If not specified, default encoding of the platform is used.
    - failTriggerOnMissing : boolean
      When enabled blocks the triggering of the downstream jobs if any of the files are not found in the workspace.
    - useMatrixChild : boolean
      Use files in workspaces of child builds (that is, builds for each axes combination). This works only when used in publishers of multi-configuration projects. Ignored when used in builders.
    - combinationFilter : String
      Write groovy expression to filter child builds whose files to use. If not specified, uses all children. See Combination Filter of Configuration Matrix for details of groovy expression.
    - onlyExactRuns : boolean
      Use child builds that is triggered exactly by the parent build. This affects the behavior when you triggered only some of combinations using plugins, you removed some values from axes, and so on.
    - textParamValueOnNewLine : boolean
      When enabled properties containing newline character(s) are propagated as TextParameterValue which is a specialized StringParameterValue commonly used for handling multi-line strings in Jenkins. When disabled (default) all properties are propagated as StringParameterValue.
      TextParameterValue and StringParameterValue are typically rendered differently by Jenkins and plugins such as the Rebuild plugin.
  - $class: 'GeneratorCurrentParameters'
  - $class: 'GitRevisionBuildParameters'
    This "parameter" passes the SHA1 commit ID that was built by this project into the specified job, and thereby causes the specified job to check out the exact same commit. This is useful to chain multiple activities in a sequence that acts on the same commit in different ways.
    - combineQueuedCommits : boolean
      This checkbox cause the all revisions to be be ignored apart from the last one if a build is already in the queue.
      Does not combine entries with builds of manually started downstream job that are queued. (Ones that do no have a git hash attached to them)
      Warning: There is no consideration for multiple branches, or any other behaviour, it is your responsibility to make sure that the hashes provided come from the same branch.
  - $class: 'MatrixSubsetBuildParameters'
    - filter : String
      Specifies the Groovy filter expression that restricts the subset of the combinations that the downstream project will run.
      See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
      
      What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
      
      Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
  - $class: 'NodeLabelBuildParameter'
    - name : String
      This parameter type defines where the target job should be executed, the value must match either a label or a node name - otherwise the job will just stay in the queue. The NodeLabel parameter passed to the target job, does not have to exist on the target job (but if the target has one defined, it should match the name). This way it is possible to trigger jobs on different nodes then they are actually configured.
    - nodeLabel : String
      The node can be static or a token to be expanded by the token macro plugin.
  - $class: 'NodeParameters'
  - $class: 'PredefinedBuildParameters'
    - properties : String
      KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
    - textParamValueOnNewLine : boolean
      When enabled properties containing newline character(s) are propagated as TextParameterValue which is a specialized StringParameterValue commonly used for handling multi-line strings in Jenkins. When disabled (default) all properties are propagated as StringParameterValue.
      TextParameterValue and StringParameterValue are typically rendered differently by Jenkins and plugins such as the Rebuild plugin.
  - $class: 'PredefinedGeneratorParameters'
    - properties : String
      KEY=value pairs, one per line (Java properties file format). Backslashes are used for escaping, so use "\\" for a single backslash.
      Current build parameters and/or environment variables can be used in form: ${PARAM} or $PARAM.
  - $class: 'SubversionRevisionBuildParameters'
    This parameter passes the Subversion revisions that were used in this build to the downstream builds.
    - includeUpstreamParameters : boolean
      This option passes through the subversion parameters that were passed into this build from upstream builds, so that they can be used on downstream projects.

$class: 'TwitterPublisher'

tokenCredentialsID : String
The credentials specifying the token for accessing Twitter.
consumerCredentialsID : String
The credentials specifying the consumer for accessing Twitter.
tweetText : String
The text of the Tweet to publish. Variables can be specified using the ${variablename} syntax.
The plugin prevents the tweet from being published when a tweet with the same description already exists.

UiPathAssets

assetsAction
- AutoVersion
- CurrentVersion
- DeleteAssets
- DeployAssets
- Dynamically
  - jobsCount : int
  - user : String
    The name of the user. This feature is available only on modern folders. This should be a machine user, not an orchestrator user. For local users, the format should be MachineName\\UserName".
  - machine : String
    The name of the machine. This feature is available only on modern folders.
- ExternalApp
  - accountForApp : String
    Specify the Cloud Orchestrator account name.
  - applicationId : String
    Specify the confidential external application id. Learn more about how to add an external application by following the steps outlined here.
  - applicationSecret : String
    Specify the confidential external application secret.
  - applicationScope : String
    Specify the confidential external application scope(s). It is mandatory to use only Application Scope(s).
  - identityUrl : String
- CustomVersion
  - version : String
- NonProduction
- Robot
  - robotsIds : String
- Test
- TestProject
  - testProjectPath : String
    Specify the location of a test project to be deployed in Orchestrator and executed as part of a transient test set.
  - environments : String
    Specify the environment onto which the package will be deployed as a process. For the project and environment with existing processes, the processes will be updated to use the latest project version. Required when using a classic folder, otherwise not applicable.
- TestSet
  - testSet : String
    Specify the test set name of a pre-existing test set on the Orchestrator which will be executed. If the test set does not belong to the default folder (organization unit) it must be prefixed with the folder name, e.g. AccountingTeam\\TestSet
- Token
  - credentialsId : String
    Specify the refresh token using which to authenticate to the Cloud Orchestrator instance. Learn more about how to generate this token by following the steps outlined here.
  - accountName : String
    Specify the Cloud Orchestrator account name.
- Unattended
- UserPass
  - credentialsId : String
orchestratorAddress : String
Specify the address of the Orchestrator instance onto which the assets will be deployed or updated.
orchestratorTenant : String
Specify the Orchestrator tenant onto which the assets will be deployed or updated.
folderName : String
Specify the folder where assets will deploy or update.
credentials
- AutoVersion
- CurrentVersion
- DeleteAssets
- DeployAssets
- Dynamically
  - jobsCount : int
  - user : String
    The name of the user. This feature is available only on modern folders. This should be a machine user, not an orchestrator user. For local users, the format should be MachineName\\UserName".
  - machine : String
    The name of the machine. This feature is available only on modern folders.
- ExternalApp
  - accountForApp : String
    Specify the Cloud Orchestrator account name.
  - applicationId : String
    Specify the confidential external application id. Learn more about how to add an external application by following the steps outlined here.
  - applicationSecret : String
    Specify the confidential external application secret.
  - applicationScope : String
    Specify the confidential external application scope(s). It is mandatory to use only Application Scope(s).
  - identityUrl : String
- CustomVersion
  - version : String
- NonProduction
- Robot
  - robotsIds : String
- Test
- TestProject
  - testProjectPath : String
    Specify the location of a test project to be deployed in Orchestrator and executed as part of a transient test set.
  - environments : String
    Specify the environment onto which the package will be deployed as a process. For the project and environment with existing processes, the processes will be updated to use the latest project version. Required when using a classic folder, otherwise not applicable.
- TestSet
  - testSet : String
    Specify the test set name of a pre-existing test set on the Orchestrator which will be executed. If the test set does not belong to the default folder (organization unit) it must be prefixed with the folder name, e.g. AccountingTeam\\TestSet
- Token
  - credentialsId : String
    Specify the refresh token using which to authenticate to the Cloud Orchestrator instance. Learn more about how to generate this token by following the steps outlined here.
  - accountName : String
    Specify the Cloud Orchestrator account name.
- Unattended
- UserPass
  - credentialsId : String
filePath : String
Specify the path for the csv files used to describe the assets that will be deployed or updated. Please use the following file format:
```
 name,type,value
```
```
 asset_1_name,text,asset_value   # we can have comments
```
```
 asset_2_name,integer,123
```
```
 asset_3_name,boolean,false 
```
```
 asset_4_name,credential,"username::password"
```
For the update, the type column isn't used, so it can be empty but still present.
traceLevel
The trace logging level. One of the following values: None, Critical, Error, Warning, Information, Verbose. (default None)
- Values: None, Critical, Error, Warning, Information, Verbose

UiPathInstallPlatform

traceLevel
- Values: None, Critical, Error, Warning, Information, Verbose
cliNupkgPath : String (optional)
cliVersion : String (optional)
forceInstall : boolean (optional)

UiPathPack

version
- AutoVersion
- CurrentVersion
- DeleteAssets
- DeployAssets
- Dynamically
  - jobsCount : int
  - user : String
    The name of the user. This feature is available only on modern folders. This should be a machine user, not an orchestrator user. For local users, the format should be MachineName\\UserName".
  - machine : String
    The name of the machine. This feature is available only on modern folders.
- ExternalApp
  - accountForApp : String
    Specify the Cloud Orchestrator account name.
  - applicationId : String
    Specify the confidential external application id. Learn more about how to add an external application by following the steps outlined here.
  - applicationSecret : String
    Specify the confidential external application secret.
  - applicationScope : String
    Specify the confidential external application scope(s). It is mandatory to use only Application Scope(s).
  - identityUrl : String
- CustomVersion
  - version : String
- NonProduction
- Robot
  - robotsIds : String
- Test
- TestProject
  - testProjectPath : String
    Specify the location of a test project to be deployed in Orchestrator and executed as part of a transient test set.
  - environments : String
    Specify the environment onto which the package will be deployed as a process. For the project and environment with existing processes, the processes will be updated to use the latest project version. Required when using a classic folder, otherwise not applicable.
- TestSet
  - testSet : String
    Specify the test set name of a pre-existing test set on the Orchestrator which will be executed. If the test set does not belong to the default folder (organization unit) it must be prefixed with the folder name, e.g. AccountingTeam\\TestSet
- Token
  - credentialsId : String
    Specify the refresh token using which to authenticate to the Cloud Orchestrator instance. Learn more about how to generate this token by following the steps outlined here.
  - accountName : String
    Specify the Cloud Orchestrator account name.
- Unattended
- UserPass
  - credentialsId : String
projectJsonPath : String
The location of the project(s) to be packaged. It can be a direct path to a project.json file or a directory with one or multiple projects. In the latter case, each level one project is packaged individually
outputPath : String
Specify the location where you want to output the NuGet package(s). The paths are local to the workspace of the build.
traceLevel
The trace logging level. One of the following values: None, Critical, Error, Warning, Information, Verbose. (default None)
- Values: None, Critical, Error, Warning, Information, Verbose
credentials (optional)
- AutoVersion
- CurrentVersion
- DeleteAssets
- DeployAssets
- Dynamically
  - jobsCount : int
  - user : String
    The name of the user. This feature is available only on modern folders. This should be a machine user, not an orchestrator user. For local users, the format should be MachineName\\UserName".
  - machine : String
    The name of the machine. This feature is available only on modern folders.
- ExternalApp
  - accountForApp : String
    Specify the Cloud Orchestrator account name.
  - applicationId : String
    Specify the confidential external application id. Learn more about how to add an external application by following the steps outlined here.
  - applicationSecret : String
    Specify the confidential external application secret.
  - applicationScope : String
    Specify the confidential external application scope(s). It is mandatory to use only Application Scope(s).
  - identityUrl : String
- CustomVersion
  - version : String
- NonProduction
- Robot
  - robotsIds : String
- Test
- TestProject
  - testProjectPath : String
    Specify the location of a test project to be deployed in Orchestrator and executed as part of a transient test set.
  - environments : String
    Specify the environment onto which the package will be deployed as a process. For the project and environment with existing processes, the processes will be updated to use the latest project version. Required when using a classic folder, otherwise not applicable.
- TestSet
  - testSet : String
    Specify the test set name of a pre-existing test set on the Orchestrator which will be executed. If the test set does not belong to the default folder (organization unit) it must be prefixed with the folder name, e.g. AccountingTeam\\TestSet
- Token
  - credentialsId : String
    Specify the refresh token using which to authenticate to the Cloud Orchestrator instance. Learn more about how to generate this token by following the steps outlined here.
  - accountName : String
    Specify the Cloud Orchestrator account name.
- Unattended
- UserPass
  - credentialsId : String
orchestratorAddress : String (optional)
Specify the address of the Orchestrator instance from which library dependencies should be restored.
orchestratorTenant : String (optional)
Specify the tenant of the Orchestrator instance from which library dependencies should be restored.
outputType : String (optional)
Force the output to a specific type.
runWorkflowAnalysis : boolean (optional)
Run the workflow analysis before packing and fail in case of errors. (default false)
useOrchestrator : boolean (optional)

$class: 'UnicornValidationBuilder'

unicornUrl : String
siteUrl : String
maxErrorsForStable : String
maxWarningsForStable : String
maxErrorsForUnstable : String
maxWarningsForUnstable : String

$class: 'UninstallBuilder'

packageId : String
failOnUninstallFailure : boolean

reportUnitTest

applicationName : String (optional)
applicationVersion : String (optional)
applicationComponent : String (optional)
testCoverage : float (optional)
testsFailed : int (optional)
testsIgnored : int (optional)
testsPassed : int (optional)

$class: 'Unity3dBuilder'

For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.

unity3dName : String
argLine : String
The full command line that comes after the executable. Typically something like:
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics] or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe or
-quit -batchmode -buildOSXPlayer path/to/your/build.app

If this value isn't set, the globalArgLine is used.

Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.

If the specified command line contains no -projectpath argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.

If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log".

See the official Editor command line arguments documentation.
unstableReturnCodes : String

unshelve

shelf : String
resolve : String
tidy : boolean
ignoreEmpty : boolean

$class: 'UpdateBox'

cloud : String
workspace : String
The workspace in ElasticBox.
box : String
The box in the selected workspace to update.
variables : String

azureVMSSUpdateInstances

azureCredentialsId : String
The Azure Service Principal credentials used to communicate with the Azure services. Check the following documentation for more information about the service principal:
- Use portal to create an Azure Active Directory application and service principal that can access resources
resourceGroup : String
The resource group name that the Virtual Machine Scale Set is associated with.
name : String
The Azure Virtual Machine Scale Set name.
instanceIds : String
Instance IDs to be updated, separated by ','.

$class: 'UpdatePriority'

prefix : String
Input the relevant project and item id here. Example: P1#I10 (P1 - Project number, I10 - Item number). You can update priority of up to 10 items across projects at a time. Example: P1#I10, P#I11, P#I12, P2#I13
priority : String
Enter a valid priority name as mentioned in Zoho Sprints. The following operation will not reflect if you enter an invalid priority name.

$class: 'UpdateProjectBuilder'

$class: 'UpdateReleaseStage'

releasePrefix : String
Enter the release details. Example: P2#R10
stage : String
Mention the stage to which you want to update your release.

$class: 'UpdateStatus'

prefix : String
Input the relevant project and item id here. Example: P1#I10 (P1 - Project number, I10 - Item number). You can update status of up to 10 items across projects at a time. Example: P1#I10, P#I11, P#I12, P2#I13
status : String
Enter a valid status name as mentioned in Zoho Sprints. The following operation will not reflect if you enter an invalid status name. (Or) Enter $STATUS_PARAM to fetch all the status on the sprint board.

updraftPublish

url : String
Insert the Url, which can be found as part of the "CURL" statement in the Application Overview of the desired application on Updraft.
path : String

$class: 'UploadAppBuildStep'

applicationLocation : String
keystoreInfo
- keystoreLocation : String
- keystorePassword : String
- keyAlias : String
- keyPassword : String
extraArguments
- touchId : boolean
- camera : boolean
- allowResign : boolean
- uuid : String
  Profile to use once installing an iOS Application
- uniqueName : String

$class: 'UploadAppBuilder'

mcServerName : String
The Mobile Center host address.
authModel
- mcUserName : String
- mcPassword : String
- mcTenantId : String
- mcExecToken : String
- value : String
proxySettings
- fsUseAuthentication : boolean
- fsProxyAddress : String
- fsProxyUserName : String
- fsProxyPassword : String
applicationPaths
- mcAppPath : String

uploadCloudifyBlueprint

Use this step to upload a blueprint to Cloudify Manager.

Two paramters are mandatory:

Blueprint ID
Main blueprint file name

In addition, exactly one of the following parameters is mandatory:

Blueprint archive path
Blueprint archive URL
Blueprint's root directory

If you provide a blueprint's root directory, then the entire directory contents are packaged into a blueprint archive.

archivePath : String (optional)
Path (relative to the workspace root) of the blueprint archive.
archiveUrl : String (optional)
URL of the blueprint archive.
blueprintId : String (optional)
ID to assign to the uploaded blueprint.
credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
mainFileName : String (optional)
Name of the YAML file containing the main entry point to the blueprint.
rootDirectory : String (optional)
Directory where the blueprint is located.
tenant : String (optional)

Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

$class: 'UploadBuild'

tenantId : String
id : String
name : String
versionName : String
revision : String
requestor : String
status : String
One of start, in_progress, success, or failure.
startTime : String
endTime : String
appName : String
appId : String
appExtId : String
debug : boolean
fatal : boolean
Fail build on failed upload (rather than just making build unstable).

upload-sonic

apiKey : String
Sonic Auth Token.
scanDir : String
Sonic scans the directory of the installation package, the default is the current project space directory, for example, fill in build, the scan directory is: ${WORKSPACE}/build
projectId : String (optional)
Sonic Project.
suiteId : String (optional)
Run testsuite after uploading.
wildcard : String (optional)
file wildcard (default: **/*.apk,**/*.ipa).

upload-pgyer-v2

click to get the documents

apiKey : String
To be safe, the field needs to be encrypted, so it looks that long.
(Required) API Key, used to identify the identity of the API caller,
if not specified, each interface needs to contain this parameter.
For the same pgyer registered users, this value is fixed.
Click to get pgyer api_key
scanDir : String
(Required) need to upload ipa or apk file base dir path!
The default is ${WORKSPACE}, It means the path of the current project!
It is using ant's DirectoryScanner class, click to see DirectoryScanner class
It is equivalent to the parameters of the basedir method in the DirectoryScanner class! click to see basedir method
wildcard : String
(Required) need to upload ipa or apk file name, Support wildcards,
like this: **/Test?/*.apk
It is using ant's DirectoryScanner class, click to see DirectoryScanner class
It is equivalent to the parameters of the includes method in the DirectoryScanner class! click to see includes method
buildType : String
(Optional) App Type is android or ios
buildInstallType : String
(Optional)Type of Install, this value is (1,2,3).
1:Public,
2:Password,
3:Restrict.
The default is Public!
buildPassword : String
To be safe, the field needs to be encrypted, so it looks that long.
(Optional) Setting App installation password.
If you do not want to set a password, please pass on an empty string or do not pass anything.
buildUpdateDescription : String
(Optional) Version updated description, please pass on an empty string or do not pass anything.
buildChannelShortcut : String
(Optional) The download short link of the specified channel that needs to be updated.
Only one channel can be specified, string type, such as: abcd.
qrcodePath : String
envVarsPath : String

$class: 'UploadDeployment'

id : String
tenantId : String
name : String
result : String
One of start, in_progress, success, or failure.
initiator : String
versionName : String
versionExtId : String
type : String
environmentId : String
environmentName : String
description : String
startTime : String
endTime : String
appName : String
appId : String
appExtId : String
debug : boolean
fatal : boolean
Fail build on failed upload (rather than just making build unstable).

$class: 'UploadJUnitTestResult'

properties
- Type: java.util.Map<java.lang.String, java.lang.String>

$class: 'UploadMetricsFile'

tenantId : String
name : String
filePath : String
testSetName : String
environment : String
combineTestSuites : boolean
fatal : boolean
Fail build on failed test upload (rather than just making build unstable).
debug : boolean
pluginType : String
dataFormat : String
recordName : String
metricDefinitionId : String
metricsRecordUrl : String
description : String
executionDate : String
Time of execution that produced test results. Should be in Epoch milliseconds. Defaults to current time.
buildId : String
buildUrl : String
appId : String
appName : String
appExtId : String

uploadProgetPackage

Creates and uploads a universal ProGet package to your ProGet server.

feedName : String
The feed in ProGet to upload the package to
groupName : String
The package you wish to upload your package to.
A string of no more than fifty characters:
- numbers (0-9)
- upper and lower-case letters (a-Z)
- dashes (-)
- periods (.)
- forward-slashes (/)
- and underscores (_)
- may not start or end with a forward-slash
e.g. an/example/group
packageName : String
The package you wish to upload your package to.
A string of no more than fifty characters:
- numbers (0-9)
- upper and lower-case letters (a-Z)
- dashes (-)
- periods (.)
- and underscores (_)
e.g. mypackage
version : String
A string representing a Semantic Version; this plug-in will not do any validation that the version is correct, however ProGet will return an error and the task will fail if the version number is not correctly formatted.
artifacts : String
You can use wildcards like 'module/dist/**/*.zip'. See [the includes attribute of Ant fileset](http://ant.apache.org/manual/Types/fileset.html) for the exact format.
- Multiple patterns can be specified by placing a comma (,) between them
- The base directory is the workspace. You can only archive files that are located in your workspace
- Will fail the build if no files are found
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
- filter must start with '['
- wildcards are not supported
- filter can span a several folders
- invalid filters are ignored
- can be used with multiple filesets
Examples:
- "[build]/sample/one.txt" would add the folder and file "sample/one.txt" to the package
- "[build/sample]/two.txt" would add the file "one.txt" to the package
- "build/[sample]/three.txt" would be ignored
- "[**]/four.txt" would be ignored
- "[one]/one.txt, [two]/two.txt" would add one.txt and two.txt to the package
caseSensitive : boolean (optional)
Artifact archiver uses Ant org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.

This option can be used to disable case sensitivity. When it's unchecked, pattern "**/*.HPI" will match any *.hpi files, or pattern "**/cAsEsEnSiTiVe.jar" will match a file called caseSensitive.jar.
defaultExcludes : boolean (optional)
dependencies : String (optional)
An array of strings, each consisting of a package identification string; this string is formatted as follows:
- �group�:�package-name�
- �group�:�package-name�:�version�
When the version is not specified, the latest is used.
description : String (optional)
A string containing any number of charters; these will be formatted as Markdown in the ProGet UI
excludes : String (optional)
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be archived even if it matches the mask specified in 'files to package' section.
icon : String (optional)
A string of an absolute url pointing to an image to be displayed in the ProGet UI (at both 64px and 128px); if package:// is used as the protocol, ProGet will search within the package and serve that image instead
metadata : String (optional)
Custom metadata in 'key = value' pairs, each key/value pair must be on it's own line so for more than one entry you will need to expand the entry field. Each key must be unique. Each value must be no more than 50 characters.
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
title : String (optional)
An optional title for your package
A string of no more than fifty characters

uploadCloudifyBlueprint

Use this step to upload a plugin to Cloudify Manager.

credentialsId : String (optional)

The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
outputLocation : String (optional)
Location where the plugin information, in JSON format, will be stored.
tenant : String (optional)

Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
wagonLocation : String (optional)
URL of the Wagon file.
yamlLocation : String (optional)
URL of the plugin.yaml file of the plugin.

$class: 'UpmergeBuilder'

commitUsername : String
User name in format: "Foo Bar ". Required.

uTesterUrlListTask

initialUrl : String
A list of URLs (one per line) to check.
urlsWhiteList : String
A list of URLs (one per line) to whitelist.
rulesList
A list of JSON rules to evaluate.
- rule : String
complianceMinimum : float
The minimum compliance level needed to pass (if multiple data results exist this will check each).
allowSimultaneousLogins : boolean
loginFlowJson : String
useRunner : boolean
fetchResponseTimeout : int
The number of seconds to wait for a response from the User1st API before failing (default of 120).

useMango

useSlaveNodes : String
Select this option to run tests in parallel across labelled nodes. Nodes need to have a Windows OS with useMango installed.

If this option is not selected or the Label Expression is empty, tests will be executed on the Jenkins master node only. This assumes the master has a Windows OS with useMango installed.

Tip: For running useMango tests, we recommend adding the label 'usemango' to all your useMango Windows slave nodes.
nodeLabel : String
projectId : String
The name of your useMango project containing the tests to be executed (Note: This field is mandatory).
tags : String
Execute tests with these given project tags. Separate the tags with a comma, e.g. Tag1,Tag2 (Note: This field is not mandatory. Leaving it empty will include all the tests in the project).
testName : String
Execute tests with a given name (regular expressions supported). If a folder name is specified only matching tests within this folder will be used (Note: This field is not mandatory. Leaving it empty will include all tests).
testStatus : String
Execute tests with a specific status (Note: This field is not mandatory. Leaving it empty will include tests with all statuses).
assignedTo : String
Execute tests assigned to a specific user (Note: This field is not mandatory. Leaving it empty will include tests from all users).

vb6

projectFile : String
compileConstants : String (optional)
Tells Visual Basic which values to use for conditional compilation constants when making an .EXE or ActiveX component with the /make switch. Separate multiple constants with colons. Example: Conditional=1:AnotherConditional=0:More=1
outDir : String (optional)
Specifies a directory path to place all output files in when using /make. This path must already exist.

vCommander

action
- $class: 'VCommanderRequestNewServiceAction'
  - payload : String
    When you lookup a service that exists in the Commander Service Catalog, the request configured for that service is displayed in this field as a JSON payload. For some service requests you may edit configuration parameters. If you edit a service request's configuration parameters, you must use valid values for each configuration parameter and proper JSON formatting. Parameter validation is not performed.
    
    You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
  - sync : boolean
    Commander actions may take a few minutes to complete. If you want Jenkins to wait for the service to complete (that is, perform the action synchronously), you can add timeout and checking intervals in the current build step. You can also add them in a separate, following wait step.
  - timeout : long
  - polling : long
- $class: 'VCommanderRunWorkflowAction'
  - targetType : String
    Select the target type to run the workflow on. The target type and name must be a unique in Commander.
    
    You may also use environment variables in the text. Variables must resolve to valid target types. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
  - targetName : String
    Enter the name of the target to run the workflow on. The target type and name must be a unique in Commander.
    
    You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
  - workflowName : String
  - sync : boolean
    Commander actions may take a few minutes to complete. If you want Jenkins to wait for the action to complete (that is, perform the action synchronously), you can add timeout and checking intervals in the current build step or you add them a separate wait step.
  - timeout : long
  - polling : long
- $class: 'VCommanderWaitForRequestNewServiceAction'
  - requestId : String
    If you want the build job to wait for the completion of a service request, enter the service request's ID. Typically the wait will be for an asynchronous request made earlier in the same build. In that case, the build step will generate the environment variable VCOMMANDER_REQUESTED_SERVICE_ID, which can be used here.
    
    You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
  - timeout : long
  - polling : long
- $class: 'VCommanderWaitForRunWorkflowAction'
  - taskId : String
    If you want the build job to wait for the completion of a command workflow task, enter that task's ID. Typically the wait will be for an asynchronous command workflow task made earlier in the same build. In that case, the build step will generate the environment variable VCOMMANDER_WORKFLOW_TASK_ID, which can be used here.
    
    You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
  - timeout : long
  - polling : long

$class: 'VMGRAPI'

vAPIUrl : String
Verisium Manager expose a REST API interface for API. The REST API is a dedicated process for serving remote http requests - vAPI.
The vAPI process is served automatically by the Verisium Manager Server process, and as such you need to supply the following url:
https://[VMANAGER_HOST:VMANAGER_PORT]/vmgr/vapi
vAPIUser : String
In case of a secure mode, the userId (vAPI User) will be shown as the user who perform the operation within Verisium Manager tool.
In case of open mode, the default userid that will be used is "vapi".
vAPIPassword : String
In case of a secure mode, the vAPI Secret Key is needed
vAPI Secret Key can be set for each vAPI process. Please contact vAPI documentation for further info.
vAPIInput : String
vJsonInputFile : String
In case of a need in dynamically change the jSON input for the API per job, the pre-job should place into the workspace directory a file with the relevant jSON string to be sent to the vAPI.
The input file should be place into the working directory. In case this field is empty, The file name need to be: ${BUILD_NUMBER}.${BUILD_ID}.vapi.input
Please fill this field only in case, you want to hard code the input file name, to be consist across all builds.
deleteInputFile : boolean
authRequired : boolean
Verisium Manager vAPI can operate in one of two modes:
Secured by user/secret key
Open

apiType : String

dynamicUserId : boolean

In case of a need in dynamically selecting the user name per job, the pre-job should place into the workspace directory a file with single line that contains the userid to be used.
The file name should be: ${BUILD_NUMBER}.${BUILD_ID}.user.input"
The job will pick the userid which is in the file, and connect to vAPI using this userid and the vAPI secret key.

apiUrl : String

This is the acctual URL of the API
Example:

/severe_messages /count

/severe_messages /get

/sessions /count

/sessions /launch

/sessions /get

/runs /compact

/runs /update

Please see the full API list at http://[vAPI HOST]:[vAPI PORT]/vmgr/rest/$docs

Please note that the output of the API call will get saved as jSON format into the workspace at ${BUILD_NUMBER}.${BUILD_ID}.vapi.output

--project	The name of the Jenkins job
--scan	The build workspace
--format	XML

User Handbook

Tutorials

Resources

Build Steps from Json Plugin

step([$class: 'BuildStepsFromJsonBuilder']): Build Steps from Json

Warning:

Warning:

Test ID

Automatch URL

Tag

Project

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token

Generate your Access Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

Warning:

Warning:

Test ID

Automatch URL

Tag

Project

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token

Generate your Access Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

Pattern Syntax

Analyze changed files only

Diff file list

Using Git

Manual

How to import tests from YAML files saved in the Git repository

How to create a test from YAML input

Pattern Syntax

Analyze changed files only

Diff file list

Using Git

Manual

How to import tests from YAML files saved in the Git repository

How to create a test from YAML input

`step([$class: 'BuildStepsFromJsonBuilder'])`: Build Steps from Json