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
      java.lang.TypeNotPresentException: Type org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint not present
  • ACXScanBuilder
    • ncScanType : String
    • ncWebsiteId : String
    • ncProfileId : String
    • ncDoNotFail : boolean (optional)
    • ncReportType : String (optional)
    • acxServerURL : String (optional)
    • credentialsId : String (optional)
    • ncAbortScan : boolean (optional)
    • ncApiToken : Object (optional)
    • ncConfirmed : boolean (optional)
    • ncIgnoreFalsePositive : boolean (optional)
    • ncIgnoreRiskAccepted : boolean (optional)
    • ncSeverity : String (optional)
    • ncStopScan : boolean (optional)
    • pHost : String (optional)
    • pPassword : String (optional)
    • pPort : String (optional)
    • pUser : String (optional)
    • useProxy : 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
      Array / List of Nested Object
      • 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, CA_WEST_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, US_ISO_EAST_1, US_ISOB_EAST_1, US_ISO_WEST_1, IL_CENTRAL_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
        Array / List of Nested Choice of Objects
        • $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
        Array / List of Nested Choice of Objects
        • $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: 'AddFeedStatus'
    • projectNumber : String
    • feed : String
  • $class: 'AddItemComment'
    • projectNumber : String
    • sprintNumber : String
    • itemNumber : String
    • note : String
  • $class: 'AddReleaseComment'
    • projectNumber : String
    • releaseNumber : String
    • note : String
  • $class: 'AddSprintComment'
    • projectNumber : String
    • sprintNumber : String
    • note : String
  • $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
  • $class: 'AddWorkItem'
    • projectNumber : String
    • sprintNumber : String
    • name : String
    • description : String
    • status : String
    • type : String
    • priority : String
    • duration : String
    • assignee : String
    • startdate : String
    • enddate : String
    • customFields : String
  • advinstBuilder
    • advinstRunType : String
    • aipProjectPath : String
      Path of the Advanced Installer project file (.AIP). It can be either an absolute path or relative to the workspace directory. You can use build variables through the syntax ${VAR} or $VAR.
    • aipProjectBuild : String
      The build name to be executed. If this field is empty, all the builds from the project are performed. You can use build variables through the syntax ${VAR} or $VAR.
    • aipProjectOutputFolder : String

      Folder where the result package should be created. It can be either an absolute path or relative to the workspace directory. If this field id empty the folder configured in the AIP project will be used. You can use build variables through the syntax ${VAR} or $VAR.

      This option is available only when a build name is specified.

    • aipProjectOutputName : String

      The result package name.If this field id empty the name configured in the AIP project will be used. You can use build variables through the syntax ${VAR} or $VAR.

      This option is available only when a build name is specified.

    • advinstExtraCommands : String
      Additional commands to be executed. It supports all the edit commands supports in an Advanced Installer Commands file. You can use build variables through the syntax ${VAR} or $VAR. E.g. SetVersion x.x.x
    • aipProjectNoDigitalSignature : boolean
      This option allows you to skip the digital signature phase of the build.
    • installName : String (optional)
      Select one of the configured Advanced Installer launchers.
  • 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)
  • Amazon Inspector
    • archivePath : String
    • artifactPath : String
    • archiveType : String
    • sbomgenPath : String
    • osArch : boolean
    • iamRole : String
    • awsRegion : String
    • credentialId : String

      Used inside the plugin to pull the password from Jenkins' credential store. Only required if the image being scanned is located in a private repository requiring credentials to access.

    • awsProfileName : String
    • awsCredentialId : String

      Optional. Allows you to specify AWS credentials explicitly instead of having them be pulled from your system. If this option is omitted, AWS credentials will be obtained via the default provider chain.

      Credentials must be added to the credential store as the "AWS Credentials" type.

      For more info: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default

    • sbomgenMethod : String
    • sbomgenSource : String
    • isThresholdEnabled : boolean

      Specifies whether scanned vulnerabilities exceeding a value will cause a build failure.

    • thresholdEquals : boolean
    • countCritical : int
    • countHigh : int
    • countMedium : int
    • countLow : int
    • oidcCredentialId : String
  • $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.
    • anchoreui : String (optional)
      Anchore Enterprise UI URL: The URL of the Anchore Enterprise dashboard. If this is set then links to the Anchore Enterprise UI will be displayed in the Anchore report seen within Jenkins.
    • annotations (optional)
      Array / List of Nested Object
      • key : String
      • value : String
    • autoSubscribeTagUpdates : boolean (optional)
      If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Enterprise 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 to wait for the Anchore Enterprise operation to complete. Time between attempts is determined by the Retry Interval setting.
    • engineRetryInterval : String (optional)
      Interval between polling attempts (in seconds) for the Anchore Enterprise.
    • engineaccount : String (optional)
      Anchore Enterprise account
    • engineurl : String (optional)
      Anchore Enterprise URL
    • engineverify : boolean (optional)
    • excludeFromBaseImage : boolean (optional)
      If selected or set to 'true', any match in the Policy or Vulnerability results where Inherited From Base == true will be excluded from the final results tables. This will NOT affect the final policy evaluation status, but will remove inherited vulnerabilities from the final results. This is useful for filtering out inherited vulnerabilities from the final results, as they are not actionable for the image being scanned. However, it is important to note that inherited vulnerabilities are still important to understand the full risk profile of the image. Default value: 'false'
    • forceAnalyze : boolean (optional)
      If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Enterprise to force analyze the image. Default value: 'false'
    • policyBundleId : String (optional)
      ID of the policy bundle on Anchore Enterprise to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Enterprise 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
      Nested Choice of Objects
      • $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)
      Array / List of Nested Object
      • 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.
    • vaultTmpPath : String (optional)
      Insert the path where to store temporary generated vault password files, ssh keys, etc... Default is in workspace.
  • 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
      Nested Choice of Objects
      • $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.
    • checkMode : boolean (optional)
      Run ansible with check mode enabled. This will not make any changes on the remote system (--check)
    • 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)
      Array / List of Nested Object
      • 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.
    • vaultTmpPath : String (optional)
      Insert the path where to store temporary generated vault password files, ssh keys, etc... Default is in workspace.
  • $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 : boolean (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.
    • vaultTmpPath : String (optional)
      Insert the path where to store temporary generated vault password files, ssh keys, etc... Default is in workspace.
  • 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
      Nested Choice of Objects
      • 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)
      • software_composition_analysis
        • target : String
        • hasOptions : boolean
        • rescan : boolean
        • scanId : String
      • static_analyzer
        • target : String
        • hasOptions : boolean
        • rescan : boolean
        • scanId : String
        • hasOptionsUploadDirect : boolean (optional)
        • includeSCAGenerateIRX : String (optional)
        • includeSCAUploadDirect : String (optional)
        • openSourceOnly : boolean (optional)
        • scanMethod : String (optional)
        • scanSpeed : String (optional)
        • sourceCodeOnly : boolean (optional)
    • name : String
    • type : String
    • application : String
    • credentials : String
    • email : boolean (optional)
    • failBuild : boolean (optional)
    • failBuildNonCompliance : boolean (optional)
    • failureConditions (optional)
      Array / List of Nested Object
      • failureType : String
      • threshold : int
    • intervention : boolean (optional)
    • personalScan : 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)
    • contact : String (optional)
    • description : String (optional)
    • email : boolean (optional)
    • exploreData : String (optional)
    • failBuild : boolean (optional)
    • failureConditions (optional)
      Array / List of Nested Object
      • 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
  • AppdomeBuilder
    • token
      • Type: class hudson.util.Secret
    • teamId : String
    • platform
      Nested Choice of Objects
      • 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)
    • secondOutput (optional)
      Nested Object
      • item : String
    • buildToTest (optional)
      Nested Object
      • selectedVendor : String (optional)
    • buildWithLogs : boolean (optional)
    • outputLocation : String (optional)
  • AppdomeValidator
    • token
      • Type: class hudson.util.Secret
    • appPath : String
    • outputLocation : String (optional)
  • appKnoxScanner
    • credentialsId : String
      Select the Appknox Access Token. Ensure the Access Token matches with the Access Token given while configuring Appknox Access Token in the credentials.
    • filePath : String
      Specify the build file name or absolute path of the application's binary (APK/IPA) file for the scan. E.g. app-debug.apk, app/build/apk/app-debug.apk
    • riskThreshold : String
      Select the risk threshold for the scan. Options are LOW, MEDIUM, HIGH, and CRITICAL.
    • region : String
  • 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 }
      Array / List of Nested Object
      • 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
      Nested Object
      • 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
      Nested Object
      • filename : String
        Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
    • format : String
  • aribot
    • credentialsID : String (optional)
    • name : String (optional)
  • $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
      Array / List of Nested Object
      • 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: '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.
      Nested Object
      • failon : String
    • analysisSrv
      Nested Object
      • a3c : String
      • cmode : boolean
      • srvurl : String
      • user : String
      • pwd : 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
      Nested Object
      • 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
        Array / List of Nested Object
        • 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.
      Array / List of Nested Object
      • 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
      Array / List of Nested Object
      • 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)
      Nested Choice of Objects
      • 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.

        Nested Object
        • 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.

        Nested Object
        • 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.

        Nested Object
        • username : String
        • password : String
    • continueOnError : boolean
    • failOnError : boolean
    • alwaysPublishFromMaster : boolean
    • masterNodeName : String
    • paramPublish
      Nested Object
      • 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.

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

        • keepFilePermissions : boolean (optional)

          Keep local file permissions of transferred files.

          Changes file permissions of the file after transferring to the local one.

          NB: only POSIX file permissions support is implemented.

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

        Nested Object
        • 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.

        Nested Object
        • 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.

        Nested Object
        • 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
      Nested Object
      • 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
      Nested Choice of Objects
      • $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
      Nested Choice of Objects
      • $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.
      Nested Object
      • projectName : String
      • projectUsers : String
      • projectGroups : String
    • createJenkinsJobs (optional)
      Check this if you want to use the bitbucket post commit external hook to call.
      Nested Object
      • ciServer : String
    • projectName : String (optional)
      Input name of the Bitbucket project.
  • $class: 'BladeBuilder'
    • blades
      Array / List of Nested Choice of Objects
      • $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
      Array / List of Nested Object
      • lib : String
    • cfaSldsLibs
      Array / List of Nested Object
      • sldsname : String
      • sldsver : String
      • sldsunit : String
      • sldsvolser : String
    • cfaDliLibs
      Array / List of Nested Object
      • dliname : String
      • dliver : String
      • dliunit : String
      • dlivolser : String
    • cfaJobnames
      Array / List of Nested Object
      • jobname : String
    • cfaReconSets
      Array / List of Nested Object
      • 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
      Array / List of Nested Object
      • 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
      Nested Object
      • value : String
      • startDate : String
      • startlogSeq : String
    • stop
      Nested Object
      • value : String
      • stopDate : String
      • stoplogSeq : String
    • tz
      Nested Object
      • 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.
  • $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
      Nested Object
      • pipelineConfig
        Nested Object
        • 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
      Nested Object
      • 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
      Nested Object
      • value : String
      • serverName : String
      • dbName : String
      • serverAuth
        Nested Object
        • 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
      Nested Object
      • dlmDashboardHost : String
      • dlmDashboardPort : String
    • sqlChangeAutomationVersionOption
      Nested Object
      • 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
      Nested Choice of Objects
      • $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
      Array / List of Nested Choice of Objects
      • $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
      Nested Object
      • vars
        Array / List of Nested Object
        • Variable : String
        • Value : String
  • $class: 'CIMessageBuilder'
    • providerData (optional)
      Nested Choice of Objects
      • 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)
      Nested Choice of Objects
      • 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)
    • 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.
      Nested Object
      • 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}.
      Nested Object
      • list (optional)
        Array / List of Nested Object
        • key : String
        • value : String
    • postExecute (optional)
      Optional post execution action. To perform any post action, provide action name along with the need parameters.
      Nested Object
      • action : String
      • params : String
    • request (optional)
      Select this to run a pre-defined Suite configured on the Continuous Testing Manager.
      Nested Object
      • name : String
    • waitConfig (optional)
      Optional execution request wait configuration. Both the polling interval and maximum run time must be specified in seconds.
      Nested Object
      • 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
      Array / List of Nested Object
      • 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)
      Array / List of Nested Object
      • hostName : String
    • emailAddresses (optional)
      Array / List of Nested Object
      • address : String
    • expirationWindow : int (optional)
      Number of hours before certificate expiry to request a new certificate.
    • ipAddresses (optional)
      Array / List of Nested Object
      • 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
      Array / List of Nested Object
      • configName : String
      • verbose : boolean
      • transfers
        Array / List of Nested Object
        • 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
        Nested Object
        • retries : int
        • retryDelay : long
      • label
        Nested Object
        • label : String
    • continueOnError : boolean
    • failOnError : boolean
    • alwaysPublishFromMaster : boolean
    • masterNodeName : String
    • paramPublish
      Nested Object
      • 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
      Nested Object
      • credentialsId : String
      • request
        Nested Choice of Objects
        • 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)
        Nested Choice of Objects
        • 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)
        Nested Object
        • 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)
      Nested Object
      • appName : String (optional)
      • appPath : String (optional)
      • buildpack : String (optional)
      • command : String (optional)
      • domain : String (optional)
      • envVars (optional)
        Array / List of Nested Object
        • key : String
        • value : String
      • hostname : String (optional)
      • instances : String (optional)
      • manifestFile : String (optional)
      • memory : String (optional)
      • noRoute : String (optional)
      • servicesNames (optional)
        Array / List of Nested Object
        • name : String
      • stack : String (optional)
      • timeout : String (optional)
      • value : String (optional)
    • pluginTimeout : String (optional)
    • selfSigned : String (optional)
    • servicesToCreate (optional)
      Array / List of Nested Object
      • 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)
      Array / List of Nested Object
      • 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.
      Array / List of Nested Object
      • 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
      Array / List of Nested Object
      • 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
      Nested Choice of Objects
      • $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)
      Array / List of Nested Object
      • 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
  • $class: 'CodeScanBuildStep'
    • orgID : String
      The Google Cloud organization ID which owns the resources under modification.
    • scanFileName : String
      The absolute name of the Terraform plan file (json format) to be scanned. If file path relative to workspace directory is "/xyz/mainplan.json", please input "mainplan.json". This tool scans the workspace directory and it's subdirectories for the file if the Scan File Path field below is empty. ..
    • filePath : String
    • scanTimeOut : int
      The time after which the scan is terminated. Based on Plugin Failure Config build status would be determined.
    • failSilentlyOnPluginFailure : boolean
      Configuration for determining build status when plugin execution fails.
    • ignoreAssetViolation : boolean
    • assetViolationConfigs
      Threshold configuration for various violation severity types reported during the scan. This threshold is used to evaluate Build Fail Condition for corresponding Severity type.
      Array / List of Nested Choice of Objects
      • $class: 'CriticalSeverityConfig'
        • count : int (optional)
          How many critical severity errors must exist before the build fails.
      • $class: 'HighSeverityConfig'
        • count : int (optional)
          How many high severity errors must exist before the build fails.
      • $class: 'LowSeverityConfig'
        • count : int (optional)
          How many low severity errors must exist before the build fails.
      • $class: 'MediumSeverityConfig'
        • count : int (optional)
          How many medium severity errors must exist before the build fails.
    • configAggregator
      The aggregator for the build fail conditions. If set to AND, all conditions must be true for the build to fail. If set to OR, only one of the conditions must be true for the build to fail.
      • Values: AND, OR
  • 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
      Array / List of Nested Object
      • value : String
      • name : String
  • CodeThreatScan
    • ctServer : String
    • project_name : String
    • fileName : String
    • credentialsId : String
    • organization_name : String
    • condition : String (optional)
    • maxNumberOfCritical : int (optional)
    • maxNumberOfHigh : int (optional)
    • policyName : String (optional)
    • scaMaxNumberOfCritical : int (optional)
    • scaMaxNumberOfHigh : int (optional)
    • weaknessIs : String (optional)
  • $class: 'CodefreshPipelineBuilder'
    • selectPipeline
      Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
      Nested Object
      • cfPipeline : String
      • cfBranch : String
    • setCFVars
      Nested Object
      • vars
        Array / List of Nested Object
        • 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: 'CompleteSprint'
    • projectNumber : String
    • sprintNumber : String
  • $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
          java.lang.TypeNotPresentException: Type org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint not present
      • ACXScanBuilder
        • ncScanType : String
        • ncWebsiteId : String
        • ncProfileId : String
        • ncDoNotFail : boolean (optional)
        • ncReportType : String (optional)
        • acxServerURL : String (optional)
        • credentialsId : String (optional)
        • ncAbortScan : boolean (optional)
        • ncApiToken : Object (optional)
        • ncConfirmed : boolean (optional)
        • ncIgnoreFalsePositive : boolean (optional)
        • ncIgnoreRiskAccepted : boolean (optional)
        • ncSeverity : String (optional)
        • ncStopScan : boolean (optional)
        • pHost : String (optional)
        • pPassword : String (optional)
        • pPort : String (optional)
        • pUser : String (optional)
        • useProxy : 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
          Array / List of Nested Object
          • 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, CA_WEST_1, ME_CENTRAL_1, ME_SOUTH_1, AF_SOUTH_1, US_ISO_EAST_1, US_ISOB_EAST_1, US_ISO_WEST_1, IL_CENTRAL_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
            Array / List of Nested Choice of Objects
            • $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
            Array / List of Nested Choice of Objects
            • $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: 'AddFeedStatus'
        • projectNumber : String
        • feed : String
      • $class: 'AddItemComment'
        • projectNumber : String
        • sprintNumber : String
        • itemNumber : String
        • note : String
      • $class: 'AddReleaseComment'
        • projectNumber : String
        • releaseNumber : String
        • note : String
      • $class: 'AddSprintComment'
        • projectNumber : String
        • sprintNumber : String
        • note : String
      • $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
      • $class: 'AddWorkItem'
        • projectNumber : String
        • sprintNumber : String
        • name : String
        • description : String
        • status : String
        • type : String
        • priority : String
        • duration : String
        • assignee : String
        • startdate : String
        • enddate : String
        • customFields : String
      • advinstBuilder
        • advinstRunType : String
        • aipProjectPath : String
          Path of the Advanced Installer project file (.AIP). It can be either an absolute path or relative to the workspace directory. You can use build variables through the syntax ${VAR} or $VAR.
        • aipProjectBuild : String
          The build name to be executed. If this field is empty, all the builds from the project are performed. You can use build variables through the syntax ${VAR} or $VAR.
        • aipProjectOutputFolder : String

          Folder where the result package should be created. It can be either an absolute path or relative to the workspace directory. If this field id empty the folder configured in the AIP project will be used. You can use build variables through the syntax ${VAR} or $VAR.

          This option is available only when a build name is specified.

        • aipProjectOutputName : String

          The result package name.If this field id empty the name configured in the AIP project will be used. You can use build variables through the syntax ${VAR} or $VAR.

          This option is available only when a build name is specified.

        • advinstExtraCommands : String
          Additional commands to be executed. It supports all the edit commands supports in an Advanced Installer Commands file. You can use build variables through the syntax ${VAR} or $VAR. E.g. SetVersion x.x.x
        • aipProjectNoDigitalSignature : boolean
          This option allows you to skip the digital signature phase of the build.
        • installName : String (optional)
          Select one of the configured Advanced Installer launchers.
      • 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)
      • Amazon Inspector
        • archivePath : String
        • artifactPath : String
        • archiveType : String
        • sbomgenPath : String
        • osArch : boolean
        • iamRole : String
        • awsRegion : String
        • credentialId : String

          Used inside the plugin to pull the password from Jenkins' credential store. Only required if the image being scanned is located in a private repository requiring credentials to access.

        • awsProfileName : String
        • awsCredentialId : String

          Optional. Allows you to specify AWS credentials explicitly instead of having them be pulled from your system. If this option is omitted, AWS credentials will be obtained via the default provider chain.

          Credentials must be added to the credential store as the "AWS Credentials" type.

          For more info: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default

        • sbomgenMethod : String
        • sbomgenSource : String
        • isThresholdEnabled : boolean

          Specifies whether scanned vulnerabilities exceeding a value will cause a build failure.

        • thresholdEquals : boolean
        • countCritical : int
        • countHigh : int
        • countMedium : int
        • countLow : int
        • oidcCredentialId : String
      • $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.
        • anchoreui : String (optional)
          Anchore Enterprise UI URL: The URL of the Anchore Enterprise dashboard. If this is set then links to the Anchore Enterprise UI will be displayed in the Anchore report seen within Jenkins.
        • annotations (optional)
          Array / List of Nested Object
          • key : String
          • value : String
        • autoSubscribeTagUpdates : boolean (optional)
          If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Enterprise 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 to wait for the Anchore Enterprise operation to complete. Time between attempts is determined by the Retry Interval setting.
        • engineRetryInterval : String (optional)
          Interval between polling attempts (in seconds) for the Anchore Enterprise.
        • engineaccount : String (optional)
          Anchore Enterprise account
        • engineurl : String (optional)
          Anchore Enterprise URL
        • engineverify : boolean (optional)
        • excludeFromBaseImage : boolean (optional)
          If selected or set to 'true', any match in the Policy or Vulnerability results where Inherited From Base == true will be excluded from the final results tables. This will NOT affect the final policy evaluation status, but will remove inherited vulnerabilities from the final results. This is useful for filtering out inherited vulnerabilities from the final results, as they are not actionable for the image being scanned. However, it is important to note that inherited vulnerabilities are still important to understand the full risk profile of the image. Default value: 'false'
        • forceAnalyze : boolean (optional)
          If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Enterprise to force analyze the image. Default value: 'false'
        • policyBundleId : String (optional)
          ID of the policy bundle on Anchore Enterprise to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Enterprise 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
          Nested Choice of Objects
          • $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)
          Array / List of Nested Object
          • 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.
        • vaultTmpPath : String (optional)
          Insert the path where to store temporary generated vault password files, ssh keys, etc... Default is in workspace.
      • 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
          Nested Choice of Objects
          • $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.
        • checkMode : boolean (optional)
          Run ansible with check mode enabled. This will not make any changes on the remote system (--check)
        • 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)
          Array / List of Nested Object
          • 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.
        • vaultTmpPath : String (optional)
          Insert the path where to store temporary generated vault password files, ssh keys, etc... Default is in workspace.
      • $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 : boolean (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.
        • vaultTmpPath : String (optional)
          Insert the path where to store temporary generated vault password files, ssh keys, etc... Default is in workspace.
      • 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
          Nested Choice of Objects
          • 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)
          • software_composition_analysis
            • target : String
            • hasOptions : boolean
            • rescan : boolean
            • scanId : String
          • static_analyzer
            • target : String
            • hasOptions : boolean
            • rescan : boolean
            • scanId : String
            • hasOptionsUploadDirect : boolean (optional)
            • includeSCAGenerateIRX : String (optional)
            • includeSCAUploadDirect : String (optional)
            • openSourceOnly : boolean (optional)
            • scanMethod : String (optional)
            • scanSpeed : String (optional)
            • sourceCodeOnly : boolean (optional)
        • name : String
        • type : String
        • application : String
        • credentials : String
        • email : boolean (optional)
        • failBuild : boolean (optional)
        • failBuildNonCompliance : boolean (optional)
        • failureConditions (optional)
          Array / List of Nested Object
          • failureType : String
          • threshold : int
        • intervention : boolean (optional)
        • personalScan : 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)
        • contact : String (optional)
        • description : String (optional)
        • email : boolean (optional)
        • exploreData : String (optional)
        • failBuild : boolean (optional)
        • failureConditions (optional)
          Array / List of Nested Object
          • 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
      • AppdomeBuilder
        • token
          • Type: class hudson.util.Secret
        • teamId : String
        • platform
          Nested Choice of Objects
          • 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)
        • secondOutput (optional)
          Nested Object
          • item : String
        • buildToTest (optional)
          Nested Object
          • selectedVendor : String (optional)
        • buildWithLogs : boolean (optional)
        • outputLocation : String (optional)
      • AppdomeValidator
        • token
          • Type: class hudson.util.Secret
        • appPath : String
        • outputLocation : String (optional)
      • appKnoxScanner
        • credentialsId : String
          Select the Appknox Access Token. Ensure the Access Token matches with the Access Token given while configuring Appknox Access Token in the credentials.
        • filePath : String
          Specify the build file name or absolute path of the application's binary (APK/IPA) file for the scan. E.g. app-debug.apk, app/build/apk/app-debug.apk
        • riskThreshold : String
          Select the risk threshold for the scan. Options are LOW, MEDIUM, HIGH, and CRITICAL.
        • region : String
      • 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 }
          Array / List of Nested Object
          • 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
          Nested Object
          • 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
          Nested Object
          • filename : String
            Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
        • format : String
      • aribot
        • credentialsID : String (optional)
        • name : String (optional)
      • $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
          Array / List of Nested Object
          • 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: '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.
          Nested Object
          • failon : String
        • analysisSrv
          Nested Object
          • a3c : String
          • cmode : boolean
          • srvurl : String
          • user : String
          • pwd : 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
          Nested Object
          • 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
            Array / List of Nested Object
            • 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.
          Array / List of Nested Object
          • 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
          Array / List of Nested Object
          • 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)
          Nested Choice of Objects
          • 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.

            Nested Object
            • 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.

            Nested Object
            • 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.

            Nested Object
            • username : String
            • password : String
        • continueOnError : boolean
        • failOnError : boolean
        • alwaysPublishFromMaster : boolean
        • masterNodeName : String
        • paramPublish
          Nested Object
          • 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.

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

            • keepFilePermissions : boolean (optional)

              Keep local file permissions of transferred files.

              Changes file permissions of the file after transferring to the local one.

              NB: only POSIX file permissions support is implemented.

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

            Nested Object
            • 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.

            Nested Object
            • 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.

            Nested Object
            • 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
          Nested Object
          • 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
          Nested Choice of Objects
          • $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
          Nested Choice of Objects
          • $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.
          Nested Object
          • projectName : String
          • projectUsers : String
          • projectGroups : String
        • createJenkinsJobs (optional)
          Check this if you want to use the bitbucket post commit external hook to call.
          Nested Object
          • ciServer : String
        • projectName : String (optional)
          Input name of the Bitbucket project.
      • $class: 'BladeBuilder'
        • blades
          Array / List of Nested Choice of Objects
          • $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
          Array / List of Nested Object
          • lib : String
        • cfaSldsLibs
          Array / List of Nested Object
          • sldsname : String
          • sldsver : String
          • sldsunit : String
          • sldsvolser : String
        • cfaDliLibs
          Array / List of Nested Object
          • dliname : String
          • dliver : String
          • dliunit : String
          • dlivolser : String
        • cfaJobnames
          Array / List of Nested Object
          • jobname : String
        • cfaReconSets
          Array / List of Nested Object
          • 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
          Array / List of Nested Object
          • 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
          Nested Object
          • value : String
          • startDate : String
          • startlogSeq : String
        • stop
          Nested Object
          • value : String
          • stopDate : String
          • stoplogSeq : String
        • tz
          Nested Object
          • 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.
      • $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
          Nested Object
          • pipelineConfig
            Nested Object
            • 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
          Nested Object
          • 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
          Nested Object
          • value : String
          • serverName : String
          • dbName : String
          • serverAuth
            Nested Object
            • 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
          Nested Object
          • dlmDashboardHost : String
          • dlmDashboardPort : String
        • sqlChangeAutomationVersionOption
          Nested Object
          • 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
          Nested Choice of Objects
          • $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
          Array / List of Nested Choice of Objects
          • $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
          Nested Object
          • vars
            Array / List of Nested Object
            • Variable : String
            • Value : String
      • $class: 'CIMessageBuilder'
        • providerData (optional)
          Nested Choice of Objects
          • 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)
          Nested Choice of Objects
          • 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)
        • 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.
          Nested Object
          • 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}.
          Nested Object
          • list (optional)
            Array / List of Nested Object
            • key : String
            • value : String
        • postExecute (optional)
          Optional post execution action. To perform any post action, provide action name along with the need parameters.
          Nested Object
          • action : String
          • params : String
        • request (optional)
          Select this to run a pre-defined Suite configured on the Continuous Testing Manager.
          Nested Object
          • name : String
        • waitConfig (optional)
          Optional execution request wait configuration. Both the polling interval and maximum run time must be specified in seconds.
          Nested Object
          • 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
          Array / List of Nested Object
          • 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)
          Array / List of Nested Object
          • hostName : String
        • emailAddresses (optional)
          Array / List of Nested Object
          • address : String
        • expirationWindow : int (optional)
          Number of hours before certificate expiry to request a new certificate.
        • ipAddresses (optional)
          Array / List of Nested Object
          • 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
          Array / List of Nested Object
          • configName : String
          • verbose : boolean
          • transfers
            Array / List of Nested Object
            • 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
            Nested Object
            • retries : int
            • retryDelay : long
          • label
            Nested Object
            • label : String
        • continueOnError : boolean
        • failOnError : boolean
        • alwaysPublishFromMaster : boolean
        • masterNodeName : String
        • paramPublish
          Nested Object
          • 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
          Nested Object
          • credentialsId : String
          • request
            Nested Choice of Objects
            • 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)
            Nested Choice of Objects
            • 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)
            Nested Object
            • 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)
          Nested Object
          • appName : String (optional)
          • appPath : String (optional)
          • buildpack : String (optional)
          • command : String (optional)
          • domain : String (optional)
          • envVars (optional)
            Array / List of Nested Object
            • key : String
            • value : String
          • hostname : String (optional)
          • instances : String (optional)
          • manifestFile : String (optional)
          • memory : String (optional)
          • noRoute : String (optional)
          • servicesNames (optional)
            Array / List of Nested Object
            • name : String
          • stack : String (optional)
          • timeout : String (optional)
          • value : String (optional)
        • pluginTimeout : String (optional)
        • selfSigned : String (optional)
        • servicesToCreate (optional)
          Array / List of Nested Object
          • 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)
          Array / List of Nested Object
          • 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.
          Array / List of Nested Object
          • 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
          Array / List of Nested Object
          • 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
          Nested Choice of Objects
          • $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)
          Array / List of Nested Object
          • 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
      • $class: 'CodeScanBuildStep'
        • orgID : String
          The Google Cloud organization ID which owns the resources under modification.
        • scanFileName : String
          The absolute name of the Terraform plan file (json format) to be scanned. If file path relative to workspace directory is "/xyz/mainplan.json", please input "mainplan.json". This tool scans the workspace directory and it's subdirectories for the file if the Scan File Path field below is empty. ..
        • filePath : String
        • scanTimeOut : int
          The time after which the scan is terminated. Based on Plugin Failure Config build status would be determined.
        • failSilentlyOnPluginFailure : boolean
          Configuration for determining build status when plugin execution fails.
        • ignoreAssetViolation : boolean
        • assetViolationConfigs
          Threshold configuration for various violation severity types reported during the scan. This threshold is used to evaluate Build Fail Condition for corresponding Severity type.
          Array / List of Nested Choice of Objects
          • $class: 'CriticalSeverityConfig'
            • count : int (optional)
              How many critical severity errors must exist before the build fails.
          • $class: 'HighSeverityConfig'
            • count : int (optional)
              How many high severity errors must exist before the build fails.
          • $class: 'LowSeverityConfig'
            • count : int (optional)
              How many low severity errors must exist before the build fails.
          • $class: 'MediumSeverityConfig'
            • count : int (optional)
              How many medium severity errors must exist before the build fails.
        • configAggregator
          The aggregator for the build fail conditions. If set to AND, all conditions must be true for the build to fail. If set to OR, only one of the conditions must be true for the build to fail.
          • Values: AND, OR
      • 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
          Array / List of Nested Object
          • value : String
          • name : String
      • CodeThreatScan
        • ctServer : String
        • project_name : String
        • fileName : String
        • credentialsId : String
        • organization_name : String
        • condition : String (optional)
        • maxNumberOfCritical : int (optional)
        • maxNumberOfHigh : int (optional)
        • policyName : String (optional)
        • scaMaxNumberOfCritical : int (optional)
        • scaMaxNumberOfHigh : int (optional)
        • weaknessIs : String (optional)
      • $class: 'CodefreshPipelineBuilder'
        • selectPipeline
          Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
          Nested Object
          • cfPipeline : String
          • cfBranch : String
        • setCFVars
          Nested Object
          • vars
            Array / List of Nested Object
            • 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: 'CompleteSprint'
        • projectNumber : String
        • sprintNumber : String
      • $class: 'CompoundBuilder'
      • $class: 'ConditionalBuilder'
        • runCondition
          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.
        • 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.

          Nested Choice of Objects
          • $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
          Array / List of Nested Object
          • 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
          Array / List of Nested Choice of Objects
          • $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)
          Array / List of Nested Choice of Objects
          • 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)
          Array / List of Nested Choice of Objects
          • 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)
          Array / List of Nested Object
          • filePath : String
            A relative or absolute file path
          • fileEncoding : String
          • configs
            Array / List of Nested Object
            • 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.

          • lineSeparator : String (optional)
      • $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.
          Nested Choice of Objects
          • 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.
          Nested Object
          • 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
          Array / List of Nested Object
          • name : String
          • claimName : String
        • params
          Array / List of Nested Object
          • 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: 'CreateFileBuilder'
        • textFilePath : String
          Path where the text file has to be created, including file extension. Variables can be used in ${VAR} format.
        • textFileContent : String
          Content of the file. Variables can be used in ${VAR} format.
        • fileOption : String
          Insert at start of file: Content will be inserted at start of file if it exists. Append to end of file: Content will be appended to end of file if it exists. Overwrite file: Whether the file must be overwritten if it already exists. In any case, a new file will be created if the file doesn't exist.
        • useWorkspace : boolean
          Enable this to create file in the workspace directory.
      • $class: 'CreateFingerprint'

        Create Fingerprints of specified files during a build process

        • targets : String
      • $class: 'CreateRelease'
        • projectNumber : String
        • name : String
        • goal : String
        • stage : String
        • owners : String
        • startdate : String
        • enddate : String
        • customFields : String
      • $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.

      • $class: 'CreateSprint'
        • projectNumber : String
        • name : String
        • description : String
        • scrummaster : String
        • users : String
        • duration : String
        • startdate : String
        • enddate : String
        • customFields : String
      • 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.

        • skipImageUpload : boolean (optional)
          Skip image upload

          Select this option only if the image is already uploaded to CrowdStrike as part of a previous step in your build pipeline. When selected, the plugin retrieves an image scan report but does not upload the image to CrowdStrike for assessment.

        • 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)
        • projectRetentionRate : int (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
        • scaReportFormat (optional)
          • Values: PDF, XML, CSV, JSON, cyclonedxjson, cyclonedxxml
        • 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.
        • generateScaReport : boolean (optional)
          Downloads a 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
          For SAST scan Mno is required, by default it is not supported in 9.6 SAST server.
        • enableProjectPolicyEnforcementSCA : 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 CxSCA
          
        • thresholdSettings : String (optional)
        • vulnerabilityThresholdResult : String (optional)
        • exceptionOnThresholdError : boolean (optional)
          Choose if build should throw "Threshold exceeded" exception and stop the scan in case when result of scan vulnerabilities exceeds threshold. Default is False.
        • 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.)
        • projectLevelCustomFields : String (optional)
          Add project level custom fields and its value. Example: field1:value1,field2:value2.(Note that the feature works with 9.4 version SAST onwards.)
        • dependencyScanConfig (optional)
          Nested Object
          • SASTUserName : String (optional)
          • dependencyScanExcludeFolders : String (optional)
          • dependencyScanPatterns : String (optional)
          • dependencyScannerType (optional)
            • Values: OSA, SCA
          • enableScaResolver (optional)
            • Values: SCA_RESOLVER, MANIFEST
          • fsaVariables : String (optional)
          • generateScaReport : boolean (optional)
          • globalScaResolverAddParameters : String (optional)
          • isExploitablePath : boolean (optional)
          • isExploitablePathByScaResolver : boolean (optional)
          • isGlobalExploitablePathByScaResolver : 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)
          • scaProjectCustomTags : String (optional)
          • scaResolverAddParameters : String (optional)
          • scaSASTProjectFullPath : String (optional)
          • scaSASTProjectID : String (optional)
          • scaSastServerUrl : String (optional)
          • scaScanCustomTags : 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
        • overrideGlobalRetentionRate : boolean (optional)
        • overrideProjectSetting : boolean (optional)
          When selected, preset & engine configuration value selected in the pipeline will be saved on the CxSAST project.
        • thisBuildIncremental : boolean (optional)
      • greet
        • authToken (optional)
          Cyber Chief Auth Token.
          • Type: class hudson.util.Secret
        • apiUrl : String (optional)
          Cyber Chief Automated Test Endpoint.
        • apiName : String (optional)
          Your API Name set in Workspace Admin in Cyber Chief.
        • raiderName : String (optional)
        • regions : Array / List of String (optional)
          Select Select for the Raider Scanner to run.
        • frameworks : Array / List of String (optional)
          Select Framework for Raider Scanner.
        • services : Array / List of String (optional)
          Select AWS Services for the Raider Scanner.
        • scanType : String (optional)
          Cyber Chief Scan Type. Choose either of these: Web App Scan, Bolt API Security, Raider CPSM
        • testScope : String (optional)
          Cyber Chief Test Scope. Choose either of these: reconnaissance, attack, infiltration
        • failOnHighVulns : boolean (optional)
        • failOnHighMediumVulns : 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)
          Array / List of Nested Object
          • includePattern : String
        • excludePatterns (optional)
          Array / List of Nested Object
          • 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.