Pipeline: Input Step

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

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

Table of Contents

Pipeline: Input Step
- input: Wait for interactive input

Pipeline: Input Step

View this plugin on the Plugins site

`input`: Wait for interactive input

This step pauses Pipeline execution and allows the user to interact and control the flow of the build. Only a basic "proceed" or "abort" option is provided in the stage view.

You can optionally request information back, hence the name of the step. The parameter entry screen can be accessed via a link at the bottom of the build console log or via link in the sidebar for a build.

message : String
This parameter gives a prompt which will be shown to a human:
```
    Ready to go?
    Proceed or Abort
    
```
If you click "Proceed" the build will proceed to the next step, if you click "Abort" the build will be aborted.
id : String (optional)
Every input step has an unique identifier. It is used in the generated URL to proceed or abort.

A specific identifier could be used, for example, to mechanically respond to the input from some external process/tool.
ok : String (optional)

parameters (optional)

Request that the submitter specify one or more parameter values when approving. If just one parameter is listed, its value will become the value of the input step. If multiple parameters are listed, the return value will be a map keyed by the parameter names. If parameters are not requested, the step returns nothing if approved.

On the parameter entry screen you are able to enter values for parameters that are defined in this field.

Array / List of Nested Choice of Objects

agentParameter
- name : String
  Parameter name,required.
- defaultValue : String (optional)
  Default agent server name,Not required.
- description : String (optional)
$class: 'AppDetectorParamaterDefinition'
- name : String
- appName : String
- defaultValue : String
- description : String (optional)

$class: 'ArtifactRepoParamDefinition'

Define an artifact repository from which to pull information and make it available as build parameters.

name : String
The name (and label) displayed to the user when selecting settings prior to running a build.
serverType : String
Select the type of the artifact repository.
- Sonatype Nexus 3
- JFrog Artifactory 7 / Cloud
serverUrl : String
Define the URL of the repository instance.
Example URLs
- Artifactory OSS - http://localhost:8082/artifactory/
- Artifactory Cloud - https://tenant.jfrog.io/artifactory/
- Nexus - http://localhost:8081/
credentialsId : String

Select the credentials to use to connect to the artifact repository instance.

Please be aware that currently only username/password credentials are supported.
ignoreCertificate : boolean

When checked the HTTP connection will ignore invalid certificates while trying to connect to the repository instance. This is useful when using an internal service with self-signed certificates.

Use this feature with caution as it can introduce potential security risks.
proxy

When checked it allows to define an HTTP proxy to be used for the outgoing connections.
Please note that when this option is unchecked but a global proxy is defined the connection will make use of the global proxy settings. If both the local and global proxy settings are set the local proxy settings take precedence.
- proxyProtocol : String
- proxyHost : String
- proxyPort : String
- proxyCredentialsId : String
paramType : String

Select the type of information to display as a build parameter.
Artifact Path displays the name of deployed artifacts and makes the full path available.
Artifact Version displays the version of deployed artifacts.
Repositories displays all available artifact repositories.
artifactName : String
Define a name pattern for the artifact to be found. An asterisk (*) can be used as a wildcard.
Unfortunately the REST APIs do not allow for more powerful filter possibilities in regards to the artifact name. If more advanced filter possibilities are required please refer to the Filter Regex option within the Display Options section below.
repoName : String
Allows to define a repository name. Only artifacts that exist in this repository will be listed in the result set.
The REST API of Nexus only allows to define a single repository. To harmonize the UI it was decided to limit the possibility to define repositories for Artifactory to a single entry as well.

versionRegex : String

This field allows to define a Java capturing groups to extract version information from the full artifact path. In a nutshell define a regex and define a part of a string as a group by surrounding it with ( ) brackets to define a group. The first outer group found is used to extract the version information. Following is an example for a Maven artifact with the regex .+/(\d+\.\d+(\.\d+((-CANDIDATE)?-SNAPSHOT)?)?)/.+.

Path	Version
http://localhost:8081/maven-releases/org/example/test/1.0/test-1.0.jar	1.0
http://localhost:8081/maven-releases/org/example/test/1.0.5/test-1.0.5.jar	1.0.5
http://localhost:8081/maven-releases/org/example/test/1.0.5-CANDIDATE-SNAPSHOT/test-1.0.5-CANDIDATE-SNAPSHOT.jar	1.0.5-CANDIDATE-SNAPSHOT

repoType : Array / List of String
formatType : Array / List of String
multiSelection : boolean
Check to allow multiple entries to be selectable.
resultsCount : String
The number of results to be displayed on the parameter view. The number must be between 1 and 100.
filterRegex : String

This allows to filter the results returned from the repository before displaying it to the user for selection. Any entry matching the regular expression will be displayed.
To display all entries either leave the field empty or use the regular expression .+.

A typical regex for Maven-based artifacts would for example look like .+/(\d+\.\d+(\.\d+(-SNAPSHOT)?)?)/.+
sortOrder : String
selectEntry : String
This option allows to define whether the first or last or any entry matching a regex should get preselected automatically. When regex is selected and the display option is a single value selection (e.g. dropdown, radio button) then the first entry matching the regex wins.
selectRegex : String
Define a regex to match any of the entries.

Please note that when a regex matches multiple entries but the display style is set to either radio button or dropdown then only the first match wins as those types do not allow for multiple entries to be selected. Furthermore, the regex is always checked against the full path and not just the displayed value.

Example:

Displayed Value: artifact-1.0.0-SNAPSHOT.jar
Full Path: http://localhost:8081/foo/bar/com.example.group/artifact/artifact-1.0.0-SNAPSHOT.jar
submitValue : String
By default the plugin will not only submit the label but also some hidden value containing the path of the item represented by the label. Sometimes however one only wants to get the value visible in the label. This option will allow you to choose what information will get passed along to the build script.
- Label + Path (default) - This will send both the label and the hidden path to the build pipeline. Both information are split by a ; (semi-colon).
- Label Only - This will only send the visible label text to the build pipeline.
- Path Only - This will only send a non-visible path of the artifact/repository to the build pipeline.
Example
```
Label + Path  = commons-lang3-3.12.0.jar;http://localhost:8082/repository/.../commons/commons-lang3/3.12.0/commons-lang3-3.12.0.jar
Label Only    = commons-lang3-3.12.0.jar
Path Only     = http://localhost:8082/repository/.../commons/commons-lang3/3.12.0/commons-lang3-3.12.0.jar
        
```
description : String (optional)

base64File
Simple file parameter compatible with Pipeline. Transmits file contents as an environment variable in Base64 encoding, so it is best used with fairly small files. Example usage from Declarative Pipeline:
```
pipeline {
  agent any
  parameters {
    base64File 'FILE'
  }
  stages {
    stage('Example') {
      steps {
        sh 'echo $FILE | base64 -d > config.yaml'
      }
    }
  }
}
```
- name : String
  The name of the parameter. Depending on the type of parameter, this may or may not be bound as an environment variable during the build.
  
  If a local filename was given, an environment variable paramname_FILENAME will also be set. If the build is triggered via the CLI, the variable will not be set.
- description : String (optional)
booleanParam
- name : String
- defaultValue : boolean (optional)
- description : String (optional)
buildMasterRelease
Defines a parameter where users can pick an active release from a BuildMaster application. The following environment variables will be injected into the build job:
- BUILDMASTER_APPLICATION_ID
- BUILDMASTER_APPLICATION_NAME
- BUILDMASTER_RELEASE_NUMBER
- BUILDMASTER_LATEST_BUILD_NUMBER
- BUILDMASTER_NEXT_BUILD_NUMBER
When used within pipeline script the applicationId parameter can contain either the id or name of a BuildMaster application.
```
parameters {
  buildMasterRelease applicationId: 'TestApplication', description: '', name: 'BuildMaster Release'
}
```
- name : String
  
  The name of the parameter.
  
  This value is used for display purposes only - it is not exposed as an environment variable.
- applicationId : String
  The BuildMaster application to obtain the releases for.
- showApplicationId : boolean
  Allows a user to select both the Application and Release at build time.
  Triggering a build from an external source
  As the two fields are still presented to Jenkins as a single parameter, a slightly different approach is required to to pass in both the application id and release number from other jobs or via a build api request. This is supported by separating the two values using the pipe character '|'. The applicationId is optional, can contain either an Id or applicaton name, and is only supported if this field is checked.
  
  Examples
  
  ReleaseNumber: 0.0.0
  
  ApplicationId and ReleaseNumber: 1|0.0.0
  
  ApplicationName and ReleaseNumber: BuildMaster%20Application|0.0.0
- description : String (optional)
buildSelector
Defines a parameter that specifies how a Copy Artifact build step should select which build to copy from. Note that this parameter type is easier to use when starting the build from a browser; to specify a value via direct HTTP POST or the CLI, valid XML must be given.

Be aware that this string value is encoded selector configuration, and not compatible with different plugin versions.
- name : String
- defaultSelector
  - 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
- description : String (optional)
reactiveChoice
- name : String
- randomName : String
- script
  - groovyScript
    Use a Groovy script to define the parameter.
    
    The Script will be evaluated first, and if it fails (e.g. throws an exception), the Fallback Script will be used as a fallback.
    
    This script integrates with Script Security plugin to allow regular Jenkins users to configure this parameter, while limiting what they can do for security.
    
    If this script is used for any of the HTML choice types of an Active Choices Reactive Reference Parameter, the resulting HTML output will be sanitized to remove everything but basic formatting, like script tags, unless the script runs outside the sandbox. This mode requires approval from a Jenkins administrator to prevent cross-site scripting (HTML) and arbitrary code execution (Groovy).
    
    script
    Nested Object
    script : String
    
    sandbox : boolean
    If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    
    classpath
    Additional classpath entries accessible from the script.
    
    Array / List of Nested Object
    path : String
    A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
    
    oldPath : String (optional)
    
    shouldBeApproved : boolean (optional)
    
    oldScript : String (optional)
    
    fallbackScript
    Nested Object
    script : String
    
    sandbox : boolean
    If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    
    classpath
    Additional classpath entries accessible from the script.
    
    Array / List of Nested Object
    path : String
    A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
    
    oldPath : String (optional)
    
    shouldBeApproved : boolean (optional)
    
    oldScript : String (optional)
  - scriptlerScript
    scriptlerBuilder
    Nested Object
    Execute a scriptler script with a job, this allows the automation of many administration tasks or to provide prepared scripts for privileged users.
    Select the script you want to execute during the build. The scripts available are the ones marked by the admin as 'allow for users with RunScripts permission'.
    The parameters can be passed via job params or by creating these in this builder config.
    
    builderId : String
    
    scriptId : String
    
    propagateParams : boolean
    
    parameters
    Array / List of Nested Object
    name : String
    
    value : String
    
    isSandboxed : boolean
    
    parameters (optional)
    Type: java.util.Map<java.lang.String, java.lang.String>
    
    scriptlerScriptId : String (optional)
- choiceType : String
- referencedParameters : String
- filterable : boolean
- filterLength : int
- description : String (optional)
checkboxParameter
- name : String
  The parameter name, which can be used to read the selected value in the build script. Multiple selected values are separated by ",", such as: value1, value2, value3...
- pipelineSubmitContent : String
- description : String (optional)
  Parameter Description.
- protocol (optional)
  Use Protocol: HTTP_HTTPS, FILE_PATH, FILE_PATH stands for file system path, HTTP_HTTPS refers to HTTP or HTTPS protocol.
  If you choose HTTP_HTTPS, please fill in the URL of the file in the URI, for example: https://raw.githubusercontent.com/sunweisheng/Jenkins/master/xxx.yaml
  If you choose FILE_PATH, please fill in the file path in the URI such as: /opt/xxx.yaml or C:\xxx.yaml
  - Values: HTTP_HTTPS, FILE_PATH
- format (optional)
  Select the file format, such as YAML file or JSON file.
  - Values: YAML, JSON, Empty
- uri : String (optional)
  Select HTTP_HTTPS, URI, please fill in the URL address.
  Select FILE_PATH, URI, please fill in the file path.
- displayNodePath : String (optional)
  Specify the node path used for the check box display content (this format is common to different formats), the root in the file is represented by "//", and the nodes are separated by "/", such as YAML file content:
  
  CheckboxParameter:
  - key: key-1
  value: value-1
  - key: key-2
  value: value-2
  - key: key-3
  value: value-3
  
  Display node path:
  //CheckboxParameter/key
  Value node path:
  //CheckboxParameter/value
  Then, there will be three check boxes, of which the display contents of the check boxes are: key-1, key-2, key-3, and the values obtained after checking the check boxes are: value-1, value-2 , Value-3
- valueNodePath : String (optional)
  Specify the node path used for the check box selection value (this path format is common to different formats). The root in the file is represented by "//", and the nodes are separated by "/", such as the content of the YAML file:
  
  CheckboxParameter:
  - key: key-1
  value: value-1
  - key: key-2
  value: value-2
  - key: key-3
  value: value-3
  
  Display node path:
  //CheckboxParameter/key
  Value node path:
  //CheckboxParameter/value
  Then, there will be three check boxes, of which the display contents of the check boxes are: key-1, key-2, key-3, and the values obtained after checking the check boxes are: value-1, value-2 , Value-3
- useInput : boolean (optional)
  Ignore the URI setting of the remote file acquisition or the local file URI setting, and use the input file content as the file content to be read.
- submitContent : String (optional)
  After selecting the "Use only the input as the document content" check box, you can directly enter the YAML format or JSON format content of the configuration check box. The content format is set by the "document format" option, and the URI will be ignored after directly entering the configuration content Settings.
activeChoice
- name : String
- randomName : String
- script
  - groovyScript
    Use a Groovy script to define the parameter.
    
    The Script will be evaluated first, and if it fails (e.g. throws an exception), the Fallback Script will be used as a fallback.
    
    This script integrates with Script Security plugin to allow regular Jenkins users to configure this parameter, while limiting what they can do for security.
    
    If this script is used for any of the HTML choice types of an Active Choices Reactive Reference Parameter, the resulting HTML output will be sanitized to remove everything but basic formatting, like script tags, unless the script runs outside the sandbox. This mode requires approval from a Jenkins administrator to prevent cross-site scripting (HTML) and arbitrary code execution (Groovy).
    
    script
    Nested Object
    script : String
    
    sandbox : boolean
    If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    
    classpath
    Additional classpath entries accessible from the script.
    
    Array / List of Nested Object
    path : String
    A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
    
    oldPath : String (optional)
    
    shouldBeApproved : boolean (optional)
    
    oldScript : String (optional)
    
    fallbackScript
    Nested Object
    script : String
    
    sandbox : boolean
    If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    
    classpath
    Additional classpath entries accessible from the script.
    
    Array / List of Nested Object
    path : String
    A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
    
    oldPath : String (optional)
    
    shouldBeApproved : boolean (optional)
    
    oldScript : String (optional)
  - scriptlerScript
    scriptlerBuilder
    Nested Object
    Execute a scriptler script with a job, this allows the automation of many administration tasks or to provide prepared scripts for privileged users.
    Select the script you want to execute during the build. The scripts available are the ones marked by the admin as 'allow for users with RunScripts permission'.
    The parameters can be passed via job params or by creating these in this builder config.
    
    builderId : String
    
    scriptId : String
    
    propagateParams : boolean
    
    parameters
    Array / List of Nested Object
    name : String
    
    value : String
    
    isSandboxed : boolean
    
    parameters (optional)
    Type: java.util.Map<java.lang.String, java.lang.String>
    
    scriptlerScriptId : String (optional)
- choiceType : String
- filterable : boolean
- filterLength : int
- description : String (optional)
choice
- name : String
- description : String (optional)
- choices : Object (optional)
$class: 'ClearCaseUcmBaselineParameterDefinition'
When used, this parameter will display a field at build-time so that the user is able to select the ClearCase UCM baseline from which to download the content to be worked with by this project.
To use this parameter, you MUST also set the SCM to be the ClearCase UCM baseline one, otherwise the build will fail.
The name of the selected ClearCase UCM baseline is available through the CLEARCASE_BASELINE environment variable.
- pvob : String
  Mandatory — Name of the ClearCase UCM PVOB.
- component : String
  Mandatory — Name of the ClearCase UCM component which owns the ClearCase UCM baseline to download at build-time.
  At build-time, the user will be able to select one of the ClearCase UCM baselines defined for this component.
- promotionLevel : String
  Optional — Promotion level of the ClearCase UCM baseline to be downloaded at build-time.
  If no promotion level is set (blank field), then the user will be presented with all the ClearCase UCM baselines belonging to the ClearCase UCM component defined above. If a promotion level is set, then, at build-time, the user will be presented with only the ClearCase UCM baselines which have been promoted to the specified level.
- stream : String
  Optional — Stream of the ClearCase UCM baseline to be downloaded at build-time.
  If no stream is set (blank field), then the user will be presented with all the ClearCase UCM baselines belonging to the ClearCase UCM component defined above. If a stream is set, then, at build-time, the user will be presented with only the ClearCase UCM baselines which have been defined on this stream.
- restrictions : String
  Optional — List of folders (one folder per line) to be actually downloaded from ClearCase.
  For this field to be taken into account, you need to check the Use snapshot view field.
  If no restrictions are defined, then all the data for the selected ClearCase UCM baseline will be downloaded. If restrictions are defined, then only these folders will be downloaded.
  For each folder to download, don't forget to prefix them with the VOB name and the component root dir (usually identical to the component name) this folder belongs to. For example, if you want to download the folder 05_impl/0_src which is in the fa4_web component of the fa4 VOB, set the value to /fa/fa4_web/05_impl/0_src.
- viewName : String
  Mandatory — Name of the ClearCase UCM view which will be created to download the content of the baseline selected at build-time.
  You can use several variables within the view name, such as:
  
  CLEARCASE_BASELINE, which is replaced with the name of the ClearCase UCM baseline which is selected at build-time;
  
  JOB_NAME, which is replaced with the name of the job;
  
  USER_NAME, which is replaced with the name of the user running Hudson.
  
  The ClearCase UCM view is available as two environment variables:
  
  The name of the ClearCase UCM view is available as CLEARCASE_VIEWNAME;
  
  The absolute path to the ClearCase UCM view is available as CLEARCASE_VIEWPATH.
- mkviewOptionalParam : String
  Optional — If your build requires additional cleartool arguments when creating a view using mkview, specify them here.
  Note that all other arguments (that is, -snapshot —if applicable— and -tag ${CLEARCASE_VIEWNAME} will be appended before these additional arguments.
  For documentation on the mkview command, take a look at the ClearCase 7.0 Information Center.
- snapshotView : boolean
- useUpdate : boolean
  Check this option to avoid recreating the Clearcase UCM view each time a build is triggered and the baseline has changed. Instead, the view config spec will be updated so that only files that have changed are loaded.
- forceRmview : boolean
  Check this option to force the recreation of the ClearCase UCM view each time a build is triggered. If this option is not set and if the baseline which is selected when a new build is triggered is the same as for the previous build, then the ClearCase UCM view won't be recreated.
  This setting can be overriden at run-time.
- excludeElementCheckedout : boolean
  Check this option to exclude the element * CHECKEDOUT rule from the config spec.
  Note that the element * CHECKEDOUT rule is mandatory when using snapshot views.
- moreRecentThan : String
  Optional — Use this field to display, when triggering a new build, only the ClearCase UCM baselines which are more recent than a given number of years, or months, or weeks, or days.
  Examples: 1 year, 6 months, 1 week, 10 days
- uuid : String
- description : String (optional)
$class: 'CloudSelectorParameter'
- description : String (optional)
credentials
Defines a credentials parameter, which you can use during a build.
For security reasons, the credential is NOT directly exposed, the ID of the credential is exposed.
However, the selected credential is available through variable substitution in some other parts of the configuration. The string value will be the ID of the credential. A supporting plugin can thus use the ID to retrieve the selected credential and expose it to the build in an appropriate way.
- name : String
- defaultValue : String
  The default credentials to use.
- credentialType : String
- required : boolean
  When this option is selected, the credentials selection drop down will not provide the empty selection as one of the options. This will not prevent a build without a value if there are no credentials available, for example if the job does not have access to any credentials of the correct type or there is no default value and the user starting the build either does not have any credentials of the correct type in their personal credentials store or they do not have permissions on the job to use credentials from their personal store.
- description : String (optional)
$class: 'CvsTagsParamDefinition'
- name : String
  The name this parameter will be referred to as during any builds.
- cvsRoot : String
- passwordRequired : boolean
- password : String
- moduleName : String
  The name of the item to retrieve a list of symbolic names for. This could be a module root (e.g. moduleName), subdirectory (e.g. moduleName/sub/directory/) or individual file (e.g. moduleName/sub/directory/file.name).
- description : String (optional)
$class: 'DateParameterDefinition'
- name : String
- dateFormat : String
  This is the Java date format. Like 'yyyyMMdd'.
- defaultValue : String
  You can create a 'default value' in one of two forms.
  1. Java LocalDate or LocalDateTime code style
  - LocalDate.now();
  - LocalDate.now().plusDays(1);
  - LocalDate.now().plusDays(1).plusYears(2);
  - LocalDate.now().minusDays(5).minusMonths(3).minusYears(2);
  - LocalDateTime.now()
  - LocalDateTime.now().minusHours(5).plusMinutes(10).minusSeconds(20);
  - LocalDateTime.now().minusDays(5).plusYears(5).plusSeconds(50);
  2. LocalDate String (This case should match the format of 'dateFormat')
  - 20170501
  - 2017-05-01
- description : String (optional)
$class: 'DeployMetaDataParameterDefinition'
A deployment meta data parameter allows you to specify environment and build version to deploy that will be used in "Collect deploy metadata" plugin.
- name : String
- environmentKey : String
- buildVersion : String
- applicationName : String
- description : String (optional)
activeChoiceHtml
- name : String
- randomName : String
- script
  - groovyScript
    Use a Groovy script to define the parameter.
    
    The Script will be evaluated first, and if it fails (e.g. throws an exception), the Fallback Script will be used as a fallback.
    
    This script integrates with Script Security plugin to allow regular Jenkins users to configure this parameter, while limiting what they can do for security.
    
    If this script is used for any of the HTML choice types of an Active Choices Reactive Reference Parameter, the resulting HTML output will be sanitized to remove everything but basic formatting, like script tags, unless the script runs outside the sandbox. This mode requires approval from a Jenkins administrator to prevent cross-site scripting (HTML) and arbitrary code execution (Groovy).
    
    script
    Nested Object
    script : String
    
    sandbox : boolean
    If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    
    classpath
    Additional classpath entries accessible from the script.
    
    Array / List of Nested Object
    path : String
    A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
    
    oldPath : String (optional)
    
    shouldBeApproved : boolean (optional)
    
    oldScript : String (optional)
    
    fallbackScript
    Nested Object
    script : String
    
    sandbox : boolean
    If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.
    
    classpath
    Additional classpath entries accessible from the script.
    
    Array / List of Nested Object
    path : String
    A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.
    
    oldPath : String (optional)
    
    shouldBeApproved : boolean (optional)
    
    oldScript : String (optional)
  - scriptlerScript
    scriptlerBuilder
    Nested Object
    Execute a scriptler script with a job, this allows the automation of many administration tasks or to provide prepared scripts for privileged users.
    Select the script you want to execute during the build. The scripts available are the ones marked by the admin as 'allow for users with RunScripts permission'.
    The parameters can be passed via job params or by creating these in this builder config.
    
    builderId : String
    
    scriptId : String
    
    propagateParams : boolean
    
    parameters
    Array / List of Nested Object
    name : String
    
    value : String
    
    isSandboxed : boolean
    
    parameters (optional)
    Type: java.util.Map<java.lang.String, java.lang.String>
    
    scriptlerScriptId : String (optional)
- choiceType : String
- referencedParameters : String
- omitValueField : boolean
- description : String (optional)
editableChoice
Display choices but allows inputting any values even not in choices. Works just like suggestion.

To use in pipeline:
```
editableChoice(
  name: 'PARAM1',
  choices: ['Apple', 'Grape', 'Orange'],
  // belows are optional paramters
  defaultValue: 'Grape',
  restrict: true,
  filterConfig: filterConfig(
    prefix: true,
    caseInsensitive: true,
  ),
)
```
- name : String
- choices : Array / List of String (optional)
- choicesWithText : String (optional)
  Choices delimited with new line letters like:
  choice1 choice2 choice3
- defaultValue : String (optional)
- description : String (optional)
- filterConfig (optional)
  Filter choices with input value. It works just like suggestion.
  - caseInsensitive : boolean (optional)
  - prefix : boolean (optional)
    Display values when their prefix matches the input. Otherwise, display values when they contains the input.
    
    Example:
    
    Choices
    
    apple orange grape
    
    Current input
    
    ap
    
    values displayed when "Filter only with prefix" is enabled
    
    apple
    
    values displayed when "Filter only with prefix" is disabled
    
    apple grape
- restrict : boolean (optional)
  Restrict input values to be a value in choices.
- withDefaultValue (optional)
  The top most value will be the default value if not specified.
  - defaultValue : String
$class: 'ExtensibleChoiceParameterDefinition'
file
- name : String
- description : String (optional)
$class: 'GeneratorChoiceParameterDefinition'
- name : String
- choices : String
- description : String (optional)
$class: 'GeneratorKeyValueParameterDefinition'
- name : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
gitParameter
When used, this parameter will present at build-time a choice to select a Git tag (or revision number) which set a parameter for parametrized build.

Be aware that git does not allow us get additional information (like author/commmit date) from a remote URL this plugin will silently clone the project when your workspace is empty. This may take a long time when we have a slow connection and/or the checkout is big.

Often the parameter defined in the "Name" field is used to specify the branch of the git checkout.
- name : String
  The name of the parameter.
- type : String
  The type of the list of parameters:
  
  Tag - list of all commit tags in repository - returns Tag Name
  
  Branch - list of all branch in repository - returns Branch Name
  
  Revision - list of all revision sha1 in repository followed by its author and date - returns Tag SHA1
- defaultValue : String
  This value is returned when the list is empty or if an error occurs while retrieving data.
- branch : String
  Name of branch to look in. Used only if listing revisions.
- branchFilter : String
  Regex used to filter displayed branches. If blank, the filter will default to ".*".
  Remote branches will be listed with the remote name first. E.g., "origin/master"
- tagFilter : String
  This parameter is used to get tag from git.
  If is blank, parameter is set to "*".
  Properly is executed command: git ls-remote -t <repository> "*" or git ls-remote -t <repository> "$tagFilter".
  git-ls-remote documentation.
- sortMode
  Select how to sort the downloaded parameters. Only applies to a branch or a tag.
  
  none
  
  ascending smart
  
  descending smart
  
  ascending
  
  descending
  
  When smart sorting is chosen, the compare treats a sequence of digits as a single character.
  - Values: NONE, ASCENDING_SMART, DESCENDING_SMART, ASCENDING, DESCENDING
- selectedValue
  Which value is selected, after loaded parameters.
  If you choose 'default', but default value is not present on the list, nothing is selected.
  - Values: NONE, TOP, DEFAULT
- useRepository : String
  If in the task are defined multiple repositories, this option specifies which the repository is taken into account on getting data.
  If the option is not defined, is taken a first defined repository.
  This option is a regular expression, which is compared to the 'Repository URL'.
- quickFilterEnabled : boolean
  When this option is enabled will show a text field.
  Parameter is filtered on the fly.
- description : String (optional)
  A description that will be shown to the user later.
- listSize : String (optional)
  Specify the number of items the list will display. A value of 0 will display as a DropDown list.
- requiredParameter : boolean (optional)
  When this option is selected the user must select an option or an error will be thrown(default values are ignored)
$class: 'GlobalVariableStringParameterDefinition'
- name : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
imageTag
This parameter lets the user specity image tag to be used at the start of each build.
- name : String
  The name of the parameter
  These parameters are exposed to build as environment variables.
- image : String
  Full Image name for tags to be listed. One Docker Hub offical most used image (e.g ubuntu) are usualy in library namespace: library/ubuntu
- filter : String
  Regular expression to filter image tag e.g. v(\d+\.)*\d+ for tags like v23.3.2
- registry : String
  A Docker V2 API registry where to locate images and tags.
  You can change the default value in Jenkins Configuration Page.
- credentialId : String
  Credential (username with password) to authenticate against the registry
- description : String (optional)
  A description that will be shown to the user later.
- defaultTag : String (optional)
  Specify a tag value that should get preselected selected as default (e.g.: v1.0 for the image myImage:v1.0)
  NOTE: the defaultTag will get string compared to the fetched tags and if no equal exists will get ignored
- tagOrder (optional)
  
  Allows the user to alter the ordering of the ImageTags in the build parameter.
  
  Natural Ordering ... same Ordering as the tags had in prior versions
  Reverse Natural Ordering ... the reversed original ordering
  Descending Versions ... attempts to pars the tags to a version and order them descending
  Ascending Versions ... attempts to pars the tags to a version and order them ascending
  
  WARNING:
  Careful with Versioned sorting, this works best with semver or maven version compliant ImageTags, but won't work at all under certain circumstances!
  The conversion from tags to versions can fail in certain cases and cause the sorting to fail, which will result in an empty selection list.
  In such a case the user will get notified about a parameter misconfiguration.
  - Values: NATURAL, REV_NATURAL, DSC_VERSION, ASC_VERSION
- verifySsl : boolean (optional)
  Specify if Certificate validation will be performed
$class: 'InheritableStringParameterDefinition'
- name : String
- inheritanceMode : String
  This field selects, how this parameter is altered, when a child project overrides its value. For example, you may provide a variable "A" here with the value "Foo", while a child also defines "A", but with the value "Bar".
  The mode that you select here will influence the final value of the parameter, when you build the child:
  
  If you select "Overwritable", the build will just get the value "Bar"
  
  If you select "Extensible", the build will get the value "FooBar" (or "Foo Bar", depending on the "Whitespace Mode" below)
  
  If you select "Fixed", then the build will fail, since this project prohibited changing the value.
  
  Do note, that this field only has an effect on the child parameter — not the other way around. In other words, this mode decides what will happen in the future, not what happens "now" to the current or earlier overrides.
- mustHaveDefaultValue : boolean
- mustBeAssigned : boolean
- whitespaceMode : String
  This field allows you to select, how whitespaces at the start/end of the parameter should be handled, when a build is started:
  
  Trim all leading/trailing whitespace from the entered value.
  
  Keep the whitespace intact, exactly as the user entered it.
  
  Keep the whitespace, but make sure that at least a single space is added to the front of the value, in case it extends a parameter with the same name from a parent.
  
  Select the first option, if you know the parameter should not have leading or trailing spaces.
  Select the third option, if you are constructing a parameter that is used in flag- or command-construction. For example Compiler Flags.
  Otherwise, or if in doubt, just select the second option.
  Do note that, if trimming is selected, this has an effect on both the default value used for automatically started builds, as well as user-initiated builds where the user had a chance to alter the parameter value.
- isHidden : boolean
  If this is checked, the parameter will be hidden behind an "advanced" button on the screen for starting a build. For sanity's sake, you should set this for all mandatory variables that are rarely changed.
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'InheritableStringParameterReferenceDefinition'
- name : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'JFrogPipelinesParameter'
- name : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'JavaParameterDefinition'
This parameter lets the user specify JDK to be used at the star of each build.
- name : String
  The name to be displayed on the build parameters page.
- defaultJDK : String
  The JDK that will be used if the user does not specify one.
- allowedJDKs : Array / List of String
  The JDKs that can be chosen from on the build parameters page.
- description : String (optional)
  The description to be shown on the build parameters page.
$class: 'JiraIssueParameterDefinition'
- name : String
- jiraIssueFilter : String
  Specify the JQL search on Jira instance. For a build, Jenkins will run this query, populate a drop-down list box, then ask the user to select one.
- description : String (optional)
- altSummaryFields : String (optional)
  
  Optionally, specify a comma-delimited list of fields to use instead of the issue summary as the title in the dropdown. Fields will be concatenated with spaces.
  
  Example:
  Field1,Field2
$class: 'JiraVersionParameterDefinition'
- name : String
- jiraProjectKey : String
  
  Specify the project key. A project key is the all capitals part before the issue number in Jira.
  
  (EXAMPLE-100)
- jiraReleasePattern : String
  
  Specify a regular expression which release names have to match to be listed. Leave this blank to match all issues.
  
  Example:
  v[0-9]+([.][0-9]+)+ will match v1.0.1, v123, v12.0.1
- jiraShowReleased : String
- jiraShowArchived : String
- description : String (optional)
jsonEditor
- name : String
  The name of the JsonEditor parameter. This name must be unique within a set of parameters added to a single choice (InputStep). The name must start with a Latin alphabet character and may contain 1-63 more Latin alphabet characters, Latin digits, hyphens ('-'), or underscores ('_').
- description : String (optional)
  The description for the JsonEditor parameter.
- options : String (optional)
  Extra options for the JsonEditor form. See options for details.
- schema : String (optional)
  The scheme for the JsonEditor form. See json-schema-support for details.
- startval : String (optional)
  The initial values for the JsonEditor form. This value should be valid against the schema.
$class: 'LabelParameterDefinition'
- name : String
- defaultValue : String
- allNodesMatchingLabel : boolean
- nodeEligibility
  Defines how selected offline nodes should be handled.
  
  All Nodes - trigger the job on all selected nodes, regardless of their online/offline state
  
  Ignore Offline Nodes - trigger the job only on nodes being online and having an executor
  
  Ignore Temp Offline Nodes - trigger the job on all selected nodes except on the ones currently manually marked as offline
  - $class: 'AllNodeEligibility'
  - $class: 'IgnoreOfflineNodeEligibility'
  - $class: 'IgnoreTempOfflineNodeEligibility'
- triggerIfResult : String
- description : String (optional)
listGitBranches
When used, this parameter will display a field at build-time so that user is able to select a git branch or tag as a parameter for parametrized build..

Note that this plugin is specifically designed for pipeline jobs that do not configure SCM but still want to see remote repository branches or tags before build begins.

The plugin is highly motivated by Git Parameter Plugin.

But unlike Git Parameter Plugin, this plugin will not change working space at all at build-time
- name : String
  The name of the parameter.
- remoteURL : String
  Specify the Git repository URL.
- credentialsId : String
- defaultValue : String
  This value is returned when list is empty.
- sortMode
  Select how to sort the downloaded parameters. Only applies to a branch or a tag.
  
  none
  
  ascending smart
  
  descending smart
  
  ascending
  
  descending
  
  When smart sorting is chosen, the compare treats a sequence of digits as a single character.
  - Values: NONE, ASCENDING_SMART, DESCENDING_SMART, ASCENDING, DESCENDING
- selectedValue
  When this option is enabled will show a text field.
  Parameter is filtered on the fly.
  - Values: NONE, TOP, DEFAULT
- quickFilterEnabled : boolean
  When this option is enabled will show a text field.
  Parameter is filtered on the fly.
- type : String
  The type of the list of parameters:
  
  Tag - list of all commit tags in repository - returns Tag Name
  
  Branch - list of all branch in repository - returns Branch Name
- tagFilter : String
  This parameter is used to get tag from git.
  If is blank, parameter is set to "*".
  Properly is executed command: git tag -l "*" or git tag -l "$tagFilter".
- branchFilter : String
  Specify a regular expression which will be used to filter the branches which are actually displayed when triggering a new build.
- listSize : String
  Specify the number of items the list will display. A value of 0 will display as a DropDown list.
- description : String (optional)
$class: 'ListSubversionTagsParameterDefinition'
When used, this parameter will display a field at build-time so that the user is able to select a Subversion tag from which to create the working copy for this project.
Once the two fields Name and Repository URL are set, you must
1. ensure the job uses Subversion and
2. set the Repository URL field of Subversion by concatenating the two fields of this parameter.
For instance, if Name is set to SVN_TAG and Repository URL is set to https://svn.jenkins-ci.org/tags, then Subversion's Repository URL must be set to https://svn.jenkins-ci.org/tags/$SVN_TAG.
Notice that you can set the Repository URL field to a Subversion repository root rather than just pointing to a tags dir (ie, you can set it to https://svn.jenkins-ci.org rather than https://svn.jenkins-ci.org/tags). In that case, if this repository root contains the trunk, branches and tags folders, then the dropdown will allow the user to pick the trunk, or a branch, or a tag.
- name : String
- tagsDir : String
  Specify the Subversion repository URL which contains the tags to be listed when triggering a new build.
  You can also specify the root of a Subversion repository: If this root contains the trunk, branches and tags folders, then the dropdown will display trunk, all the branches and all the tags. If the root does not contain these three folders, then all its subfolders are listed in the dropdown.
  
  When you enter the URL, Jenkins automatically checks if it can connect to it. If access requires authentication, you'll be prompted for the necessary credential. If you already have a working credential but would like to change it for some other reasons, you can manage credentials and specify a different credential.
- credentialsId : String
- tagsFilter : String
  Specify a regular expression which will be used to filter the tags which are actually displayed when triggering a new build.
- defaultValue : String
  For features such as SVN polling a default value is required. If job will only be started manually, this field is not necessary.
- maxTags : String
  The maximum number of tags to display in the dropdown. Any non-number value will default to all.
- reverseByDate : boolean
  Check this option so that tags are sorted from the newest to the oldest.
  If this option is checked, the Sort Z to A one won't be taken into account.
- reverseByName : boolean
  Check this option so that tags are displayed in reverse order (sorted Z to A).
  Notice that if Sort newest first is checked, this option won't be taken into account.
- description : String (optional)
$class: 'MatrixCombinationsParameterDefinition'
- name : String
- defaultCombinationFilter : String
  
  A Groovy expression to specify which combinations are checked by default. They are also combinations which is built in a scheduled build. If not specified, the combination filter of this multi-configuration project is used. Also see help of the combination filter.
  
  Note that you cannot enable combinations which disabled by the combination filter of the project.
- shortcutList
  Links to check a set of combinations. Combinations to check are calculated with the last build in the build page or with the build to rebuild in the rebuild page (when Rebuild plugin is installed).
  - $class: 'All'
    Check all enable combinations.
  - $class: 'CombinationFilterShortcut'
    Decide combinations to check with a combinations filter.
    
    name : String
    The name displayed as the shortcut link.
    
    combinationFilter : String
    A Groovy expression to decide combinations to check.
  - $class: 'None'
    Uncheck all combinations.
  - $class: 'PreviousShortcut'
    Check combinations built in the previous build.
  - $class: 'ResultShortcut'
    Check combinations with specific results in the previous build.
    
    name : String
    The name displayed as the shortcut link.
    
    exact : boolean
    Only checks child builds running exactly in the previous build.
    
    resultsToCheck : Array / List of String
    Results of child builds to check.
- description : String (optional)
mavenMetadataVersions
This parameter allows the resolution of maven artifact versions by contacting the repository and reading the maven-metadata.xml.
If you named your parameter "MY_JAR" and have configured all values correctly. Then the following parameters will be set for the build step:
- MY_JAR_VERSION - the version you selected in the dropdown or that was selected as part of an automated build
- MY_JAR_ARTIFACT_URL - the full URL to the actual artifact selected. You can use something like "wget" to download that artifact and do something with it.
- MY_JAR_GROUP_ID - echoes back your configuration
- MY_JAR_ARTIFACT_ID - echoes back your configuration
- MY_JAR_CLASSIFIER - echoes back your configuration
- MY_JAR_PACKAGING - echoes back your configuration
- name : String
- repoBaseUrl : String
- groupId : String
- artifactId : String
- packaging : String
- classifier : String
- versionFilter : String
  Specify a regular expression which will be used to filter the versions which are actually displayed when triggering a new build.
- sortOrder : String
- defaultValue : String
  For features such as SVN polling a default value is required. If job will only be started manually, this field is not necessary.
  There are 4 special default values which will be evaluated at runtime:
  
  FIRST - will evaluate to the first item in the drop-down that would have been presented had the build been executed manually.
  
  LAST - will evaluate to the last item in the drop-down that would have been presented had the build been executed manually.
  
  RELEASE - will evaluate to the version marked as RELEASE in the repository metadata for the configured artifact. The versionFilter even if defined is ignored for this default value.
  
  LATEST - will evaluate to the version marked as LATEST in the repository metadata for the configured artifact. The versionFilter even if defined is ignored for this default value.
- maxVersions : String
  The maximum number of versions to display in the drop-down. Any non-number value as well as 0 or negative values will default to all.
- currentArtifactInfoUrl : String
  The URL where an information resource about the currently used artifact can be requested. If the URL is provided and valid, the information will be displayed next to the drop-down. Otherwise not artifact information will be displayed.
- currentArtifactInfoLabel : String
  An informational label that will be displayed in front of the aritfact information. When no label is specified, the default label Currently used artifact will be displayed. Any label will only be displayed when a valid Current Artifact Info URL is configured.
- currentArtifactInfoPattern : String
  A pattern that describes the part of the artifact information resources' content to be displayed:
  When no pattern is specified, the whole content will be displayed.
  
  When a standard pattern is specified, only its first match in the content will be displayed.
  
  When a pattern with a capturing group is specified, only the first group of its first match in the content will be displayed.
- credentialsId : String
- description : String (optional)
multiselect
- name : String
  Name of the parameter displayed in forms.
- description : String (optional)
  Description that is displayed as a help for users running a parameterized build, as to what the parameter is used for.
- decisionTree (optional)
  - itemList (optional)
    - label : String (optional)
    - value : String (optional)
    - children (optional)
      Array / List of Nested Object
  - variableDescriptions (optional)
    - label : String (optional)
    - variableName : String (optional)
- format (optional)
  - Values: CSV
$class: 'NetstormTestParameterDefinition'
- name : String
- keyword : String
- description : String (optional)
$class: 'NodeParameterDefinition'
- name : String
- defaultSlaves : Array / List of String
- allowedSlaves : Array / List of String
- triggerIfResult : String
- nodeEligibility
  Defines how selected offline nodes should be handled.
  
  All Nodes - trigger the job on all selected nodes, regardless of their online/offline state
  
  Ignore Offline Nodes - trigger the job only on nodes being online and having an executor
  
  Ignore Temp Offline Nodes - trigger the job on all selected nodes except on the ones currently manually marked as offline
  - $class: 'AllNodeEligibility'
  - $class: 'IgnoreOfflineNodeEligibility'
  - $class: 'IgnoreTempOfflineNodeEligibility'
- description : String (optional)
ontrackChoiceParam
Gets a list of parameter value to choose from, using the execution of a Ontrack DSL script.

The script is expected to return a list of objects (a single object will be converted into a singleton list) and the parameter value of each item will be extracted from this object using the property defined in the Value property field.
- name : String
- dsl : String
- sandbox : boolean
- valueProperty : String
- injectProperties : String
- description : String (optional)
ontrackMultiChoiceParam
Gets a list of parameter value to choose from, using the execution of a Ontrack DSL script.

The script is expected to return a list of objects (a single object will be converted into a singleton list) and the parameter value of each item will be extracted from this object using the property defined in the Value property field.
- name : String
- dsl : String
- sandbox : boolean
- valueProperty : String
- injectProperties : String
- description : String (optional)
ontrackSingleParam
Gets a parameter value from the execution of a Ontrack DSL script.

The script is expected to return a single object and the value of the parameter will be extracted from this object using the property defined in the Value property field.
- name : String
- dsl : String
- sandbox : boolean
- valueProperty : String
- injectProperties : String
- description : String (optional)
$class: 'PackageChoiceParameterDefinition'
List Content Packages available for download from a configured Adobe CRX repository.
- name : String
- baseUrl : String
  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
- credentialsId : String
  Select the login credentials with which content packages will be listed from the CRX server.
  
  [Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.
  
  Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- requestTimeout : long
  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
  Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- multiselect : boolean
- excludeNotInstalled : boolean
  Filter the list to exclude packages which have been uploaded to the server, but which are not installed.
- excludeModified : boolean
  Filter the list to exclude packages whose metadata have been modified after upload to the server, e.g. which need to be re-wrapped.
- visibleItemCount : long
  Set the number of visible items displayed when multiselect is enabled. The default is 10.
- query : String
  Specify a full-text search query to filter the list of packages, such as "Adobe".
- packageIdFilter : String
  Specify a package ID filter to match against the list of packages returned from the configured Granite server.
  
  A Package ID consists of the group, the name, and the version of a package, separated by colons (':').
  
  Package ID filters must follow one of three patterns:
  
  group:name:version
  
  group:name
  
  name
  
  Each segment in the filter may be either ommitted or replaced with an asterisk ('*') to represent a wildcard.
- value : String
- description : String (optional)
$class: 'PackageParameterDefinition'
- name : String
- rep : String
- pkg : String
- description : String (optional)
separator
Inserts a visual separator for build parameters: horizontal rule (<hr/> element) with an optional "Section Header" below it.
- name : String
- separatorStyle : String
  Defines a custom CSS style for the Separator (i.e. the <hr/> tag). If empty, "Global separator style" is used, as configured by an administrator in Jenkins global configuaration.
- sectionHeader : String
  Inserts a section header below the horizontal rule. Can be empty.
- sectionHeaderStyle : String
  Defines a custom CSS style for the Section Header. If empty, "Global section header style" is used, as configured by an administrator in Jenkins global configuaration.
- description : String (optional)
$class: 'PatchParameterDefinition'
Accepts a patch file to be submitted. This patch will be applied to the workspace after the source code is checked out, then the build will proceed.
- description : String (optional)
persistentBoolean
- name : String
- defaultValue : boolean
- successfulOnly : boolean
- description : String (optional)
persistentChoice
- name : String
- description : String (optional)
- choices : Object (optional)
- successfulOnly : boolean (optional)
$class: 'PersistentPackageParameterDefinition'
- name : String
- useAwsKeys : boolean
  
  If you need to access the repository outside of the repository, you will need grant access to the S3 bucket.
  
  When accessing it from within AWS, it's probable that the server itself provides the necessary access rights.
  
  When accessing it from outside, you need to provide a key pair. These are set up in the AWS admin console. If you don't have access, please ask operations to create a new key pair with access to the specified bucket.
- awsAccessKeyId : String
  
  This is the AWS secret key setup in the AWS console. It will resemble the form: ‘AAAAAAAAAA2AAA2AAAAA’
  
  If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.
- awsSecretAccessKey : String
  
  This is the AWS secret key setup in the AWS console. It will resemble the form: ‘XxXXXxx/1ZZz1zZZZ11zzZ1zz/YyYyYyyYyyyyYY’
  
  If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.
- bucketName : String
  
  This should be set to a valid bucket name that you can access using the key value pair, or if within AWS, that the server has access to.
  
  Ensure that the bucket specified contains the repo. It might sound obvious, but I just wanted to point that out.
- repoPath : String
  
  This is the path to the actual repo containing the artifacts, relative to the AWS S3 bucket.
  
  For example, given the S3 bucket ‘vhols-common-test-yumrepo’, the path to the locations-public-api repo is repos/locations-public-api
- repositoryType : String
- description : String (optional)
persistentString
- name : String
- defaultValue : String
- successfulOnly : boolean
- trim : boolean
  Strip whitespace from the beginning and end of the string.
- description : String (optional)
persistentText
- name : String
- defaultValue : String
- successfulOnly : boolean
- description : String (optional)
$class: 'PersistentYumParameterDefinition'
- name : String
- useAwsKeys : boolean
  
  If you need to access the repository outside of the repository, you will need grant access to the S3 bucket.
  
  When accessing it from within AWS, it's probable that the server itself provides the necessary access rights.
  
  When accessing it from outside, you need to provide a key pair. These are set up in the AWS admin console. If you don't have access, please ask operations to create a new key pair with access to the specified bucket.
- awsAccessKeyId : String
  
  This is the AWS secret key setup in the AWS console. It will resemble the form: ‘AAAAAAAAAA2AAA2AAAAA’
  
  If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.
- awsSecretAccessKey : String
  
  This is the AWS secret key setup in the AWS console. It will resemble the form: ‘XxXXXxx/1ZZz1zZZZ11zzZ1zz/YyYyYyyYyyyyYY’
  
  If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.
- bucketName : String
  
  This should be set to a valid bucket name that you can access using the key value pair, or if within AWS, that the server has access to.
  
  Ensure that the bucket specified contains the repo. It might sound obvious, but I just wanted to point that out.
- repoPath : String
  
  This is the path to the actual repo containing the artifacts, relative to the AWS S3 bucket.
  
  For example, given the S3 bucket ‘vhols-common-test-yumrepo’, the path to the locations-public-api repo is repos/locations-public-api
- description : String (optional)
$class: 'PromotedBuildParameterDefinition'
- name : String
- jobName : String
- process : String
- description : String (optional)
$class: 'PromotionLevelParameter'
Defines a parameter selected from the configured promotion levels. Note that the parameter provided to builds has the numeric value of the promotion level, i.e. its index in the list below, starting with one.
If used with the Copy Artifact plugin to copy artifacts of a particular promotion level, the name of the parameter should be COPY_PROMOTION_LEVEL.
- name : String
- defaultLevel : int
- description : String (optional)
$class: 'RandomStringParameterDefinition'
- name : String
- failedValidationMessage : String
- description : String (optional)
RESTList
- name : String
  The name of the parameter
  These parameters are exposed to build as environment variables.
- restEndpoint : String
  The URL address for to the REST endpoint.
  
  e.g. List GitLab repository releases https://gitlab.example.com/api/v4/projects/:id/releases
- credentialId : String
  Depending on the authentication requirement for the REST/Web endpoint there are three supported methods:
  
  `NONE` if there is no authentication requirement simply don't select any _Credential ID_
  
  `BASIC` if this authentication type is required, then simply select any Username and Password credential in the _Credential ID_ field
  
  `BEARER` if this authentication type is required, then simply select any Secret Text credential in the _Credential ID_ field
  
  NOTE: The Authentication header will be build and added based on the type of the selected credential type.
- mimeType
  The MIME type that gets requested from the REST endpoint (i.e. Accepts: application/json)
  
  NOTE This setting also define which kind of Value Expression gets applied to select the values in the end.
  
  APPLICATION_JSON - Json-Path syntax is expected in the Value Expression
  
  APPLICATION_XML - xPath syntax is expected in the Value Expression
  - Values: APPLICATION_JSON, APPLICATION_XML
- valueExpression : String
  The Value Expression dictates how the values get pares out of the REST response.
  Depending on the selected MIME type the syntax expects is either Json-Path or xPath:
  
  Json-Path Syntax Cheatsheet Playground
  
  xPath Syntax Cheatsheet Playground
- description : String (optional)
  A description that will be shown to the user later.
- displayExpression : String (optional)
  The Display Expression dictates how the values get displayed based on the object parsed from value expression.
  Depending on the selected MIME type the syntax expects is either Json-Path or xPath:
  
  Json-Path Syntax Cheatsheet Playground
  
  xPath UNSUPPORTED Due to the limitation of the XML parser.
- cacheTime : int (optional)
  Allows the user to cache values returned from a HTTP endpoint.
  The unit of this value is MINUTES. If the value is set to 0, a web request is forced.
  NOTE: The cache can globally hold up to 50 MiB per default, which should be enough for most use-cases.
  (The maximum size of the cache can be adjusted in the global Jenkins settings)
- defaultValue : String (optional)
  The Default Value allows the user to predetermine the value selected for this parameter.
  NOTE This has to be the exact same value as the value to be preselected, because it gets string compared.
- filter : String (optional)
  A simple regex filter applied on the values list generated by the Value Expression
  This filter is useful for longer value lists (e.g. version lists) to filter for only relevant values.
- valueOrder (optional)
  This setting provides tha ability to sort the received values from the endpoint set above.
  Can be useful if your endpoint returns a lot of values and does not return them in order nor provides the option to.
  
  NONE - Do not apply any post ordering on the received values
  
  ASC - "Ascending" order gets applied on the received values
  
  DSC - "Descending" order gets applied on the received values
  - Values: NONE, ASC, DSC, REV
$class: 'ReviewboardParameterDefinition'
Accepts a patch url or number of review request. This patch will be applied to the workspace after the source code is checked out, then the build will proceed.
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'RunFilterParameter'
run
- name : String
- projectName : String
- filter
  - Values: ALL, STABLE, SUCCESSFUL, COMPLETED
- description : String (optional)
$class: 'RunSelectorParameter'
$class: 'SauceParameterDefinition'
- description : String (optional)
$class: 'ScriptSelectionTaskDefinition'
- name : String
- path : String
- arrayCheckBox
  - name : String
  - variableName : String
  - check : boolean
  - type : String
  - parent : String
- testDelimSymbol : String
- nodeDelimSymbol : String
- countDelimiterSymbol : int
- delimiter : String
- defaultValue : String
- description : String (optional)
snParam
- credentialsForPublishedApp : String
  User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be published.
- instanceForPublishedAppUrl : String
  ServiceNow instance url where the application will be published to.
- credentialsForInstalledApp : String
  User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be installed.
- instanceForInstalledAppUrl : String
  ServiceNow instance url where the application will be installed.
- sysId : String
  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.
- appScope : String
  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.
- publishedAppVersion : String
  Version number of published application (that will be also installed if appropriate build step will be used). Do not fill the field up if you want to get the number automatically (depends on the build step 'Publish application').
- rollbackAppVersion : String
  Version number of the application used by the step 'Roll back application'.
  Do not fill this field up if the version should be obtained automatically.
- batchRollbackId : String
- progressCheckInterval : int
  Time in milliseconds between one and another progress check set up for all build steps of ServiceNow.
  Leave it empty to use default value.
- description : String (optional)
$class: 'SpringBootLibrariesListParameterDefinition'
- springBootVersion : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'StashBranchParameterDefinition'
- name : String
  The name of the parameter.
- repository : String
- defaultValue : String
- description : String (optional)
- branchNameRegex : String (optional)
- tagNameRegex : String (optional)
stashedFile
File parameter compatible with Pipeline but using the stash system, better suited to large files. The file will be saved to a stash named like the parameter containing one entry, also named like the parameter. Example usage from Declarative Pipeline:
```
pipeline {
  agent any
  parameters {
    stashedFile 'assets.zip'
  }
  stages {
    stage('Example') {
      steps {
        unstash 'assets.zip'
        sh 'unzip assets.zip'
      }
    }
  }
}
 
```
- name : String
  The name of the parameter. Depending on the type of parameter, this may or may not be bound as an environment variable during the build.
  
  If a local filename was given, an environment variable paramname_FILENAME will also be set. If the build is triggered via the CLI, the variable will not be set.
- description : String (optional)
string
- name : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'TestExecuter'
This plugin allows you to choose specific tests you want to run.
First, you need to specify the name of the environment variable in which you want your selected tests to be saved in (after build the selected tests will be in this environment variable as a JSON array).
Second, you need to enter the properties file path. This file will contain all your tests and maybe some extra fields for the plugin (more details about the properties file are in the appropriate help field).
After that, your tests will be shown in a tree diagram, allowing you to select some of them.
- name : String
  Enter the name of the environment variable in which you want your selected tests to be saved in (after build the selected tests will be in this environment variable as a JSON array).
- propertiesFilePath : String
  
  The properties file you enter must have a property called tests.
  
  The tests property value is a JSON array that contains a JSON object for each test.
  In each test object you need to specify it's attributes by a key/value pairs.
  
  The following properties will allow you to select specific fields which have a special meaning:
  
  1. enableField - the name of the field that will imply if the test is enabled or not.
  if the value in the specified field, for some test(s), will be false then the test will not be shown at all.
  
  2. groupBy - the field that the plugin will group the tests by.
  if 2 tests have the same value in this field, they will be in the same group.
  
  3. showFields - the field(s) that will be shown in the tests tree.
  
  4. multiplicityField - the field that will be set to the amount of times the test should run.
  
  5. fieldSeparator - the character that will separate between the fields in the tests tree.
  
  Each property must be defined either in the properties file or in the override section bellow.
  If you want to change the properties you defined In the file, you can override them in the section bellow.
  
  This is an example for a properties file which contains all above properties:
  
  tests=[{"enabled":true,"owner":"shushu","testgroup":"A","testcase":"single"},{"enabled":false,"owner":"shushu","testgroup":"B","setuptype":"basic","testcase":"triple"}]
  
  enableField=enabled
  
  groupBy=testgroup
  
  fieldSeparator=.
  
  showFields=testsuite,testcase
  
  multiplicityField=multiplicity
- enableField
  Setting Enable Field property.
  Enable Field - the name of the field that will imply if the test is enabled or not. If the value in the specified field, for some test(s), will be false then the test will not be shown at all.
  - text : String
- groupBy
  Setting Group By property.
  Group By - the field that the plugin will group the tests by. If 2 tests have the same value in this field, they will be in the same group.
  - text : String
- fieldSeparator
  Setting Field Separator property.
  Field Separator - the character that will separate between the fields in the tests tree.
  - text : String
- showFields
  Setting Show Fields property.
  Show Fields - the field(s) that will be shown in the tests tree.
  If you click on "Show/Hide Available Fields" button then next to each available field appears (howManyTestsHasThisField/amountOfTests).
  - text : String
- multiplicityField
  Setting Multiplicity Field property.
  Multiplicity Field - the field that will be set to the amount of times the test should run.
  - text : String
- description : String (optional)
text
- name : String
- defaultValue : String (optional)
- description : String (optional)
- trim : boolean (optional)
  Strip whitespace from the beginning and end of the string.
$class: 'ToolVersionParameterDefinition'
- toolName : String
- description : String (optional)
$class: 'VBoxParameterDefinition'
Build parameter with virtual node names. Parameter name is exported to the build from virtual node names joined by node name delimiter.
- name : String
- nodeDelimiter : String
- description : String (optional)
email
- name : String
- defaultValue : String
- domain : String
- externalEmail : boolean
- description : String (optional)
validatingString
Defines a simple text parameter, where users can enter a string value, which you can use during a build, either as an environment variable, or through variable substitution in some other parts of the configuration.
Additionally, this parameter supports a regular expression based validation of the user entered parameter to ensure it meets the build's requirements.
- name : String
  The name of the parameter
  These parameters are exposed to build as environment variables.
- defaultValue : String
  Specifies the default value of the field, which allows the user to save typing the actual value.
- regex : String
  
  Standard Java regular expression that will be used to validate the entered string parameter value.
- failedValidationMessage : String
  
  This message is displayed to the user if they enter a value that does not match the configured regular expression.
- description : String (optional)
  A description that will be shown to the user later.
validatingYamlParameter
- name : String
- defaultValue : String
- failedValidationMessage : String
  
  This message is displayed to the user if they enter a value that is not a syntactical correct YAML
- description : String (optional)
$class: 'VersionParameterDefinition'
Defines a build parameter for the selecting a version of the artifact to use at job runtime.
- name : String
- groupId : String
- artifactId : String
- description : String (optional)
- includeReleases : boolean (optional)
- includeSnapshots : boolean (optional)
- limit : String (optional)
- oldestFirst : boolean (optional)
- repositoryId : String (optional)
- useLatest : boolean (optional)
- useRelease : boolean (optional)
hidden
- name : String
- defaultValue : String
- description : String (optional)
$class: 'WReadonlyStringParameterDefinition'
- name : String
- defaultValue : String
- description : String (optional)
$class: 'WReadonlyTextParameterDefinition'
- name : String
- defaultValue : String
- description : String (optional)
extendedChoice
This parameter adds various types of choice fields to the Pipeline Input Step.
- name : String
  The name of the parameter.
- type : String
  The type of parameter:
  
  Single Select: user chooses a single selection from a drop down menu, populated by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)
  
  Multi Select: a user can choose multiple selections from a multi-line box, populated by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)
  
  Check Boxes: user can check off zero or more check boxes, labeled by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)
  
  Multi-Level Single Select: user chooses a selection from a drop down, and then a another drop down appears with selections that depend on the first value, and upon second selection a third drop down may appear depending on the first two selections, and so on.
  
  The property file is a tab delimited file, with levels defined in columns and choices defined in rows. For example, to have a 2 level selection where you first select a country and then a city, you could specify a file such as the following:
  
  Country City United States San Francisco United States Chicago Mexico Mexico City Mexico Cancun
  This would result in a first drop down with the options "Select a country...", "United States", and "Mexico" (the initial selection is "Select a country...", which serves as a label for the drop down). After the user selects a country, a "City" drop down would appear. If United States was chosen first, then San Francisco and Chicago would be options, but if Mexico was selected then instead Mexico City and Cancun would be options.
  
  The columns that should represent levels must be specified in the value field. For example "Country,City" could be valid values.
  
  Note that default values are not supported for multi-level selects.
  
  Multi-Level Multi Select: same as single select, but after all levels are chosen, a button appears to "Select another..." and an additional multi-level selection is presented.
- value : String
  Comma separated list of values for the single select or multi-select box.
  
  This field can be left blank if the comma separated values need to be picked up from a properties file (set via 'Property File' and 'Property Key').
  
  This value has different meaning for multi-level select -- see the parameter type help for more info.
- projectName : String
  If specified, this adds a currentProject entry to the groovy script context. The entry's value is set to the specified Jenkins project.
- propertyFile : String
  The properties file is a collection of key,value pairs of the form key=value1,value2,...
  
  Properties may reference other properties. For example:
  prop1=a,b,c,d,e
  prop2=${prop1},f,g,h
  The properties file can be placed anywhere on the file-system that Jenkins can access.
  
  This property file has different meaning for multi-level select -- see the parameter type help for more info.
- groovyScript : String
- groovyScriptFile : String
- bindings : String
- groovyClasspath : String
- propertyKey : String
  The property of the property file to use.
  
  For example, if the property file was the following:
  prop1=a,b,c,d,e
  prop2=1,2,3,4
  Then you could specify the property as either prop1 or prop2.
- defaultValue : String
  Initial selection of the single-select or mult-select box.
  
  In case of the multi-select box, default value can be a comma separated string.
- defaultPropertyFile : String
  Absolute path (specified without using environment variables).
- defaultGroovyScript : String
- defaultGroovyScriptFile : String
- defaultBindings : String
- defaultGroovyClasspath : String
- defaultPropertyKey : String
- descriptionPropertyValue : String
- descriptionPropertyFile : String
- descriptionGroovyScript : String
- descriptionGroovyScriptFile : String
- descriptionBindings : String
- descriptionGroovyClasspath : String
- descriptionPropertyKey : String
- javascriptFile : String
- javascript : String
- saveJSONParameterToFile : boolean
- quoteValue : boolean
- visibleItemCount : int
- multiSelectDelimiter : String
  
  Inserts this value between selections when the parameter is a multi-select.
  
  The default when empty is ','
- description : String (optional)
$class: 'com.michelin.cio.hudson.plugins.passwordparam.PasswordParameterDefinition'
- name : String
- description : String (optional)
$class: 'com.moded.extendedchoiceparameter.ExtendedChoiceParameterDefinition'
- name : String
  The name of the parameter.
- type : String
  The type of parameter:
  
  Single Select: user chooses a single selection from a drop down menu, populated by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)
  
  Multi Select: a user can choose multiple selections from a multi-line box, populated by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)
  
  Check Boxes: user can check off zero or more check boxes, labeled by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)
  
  Multi-Level Single Select: user chooses a selection from a drop down, and then a another drop down appears with selections that depend on the first value, and upon second selection a third drop down may appear depending on the first two selections, and so on.
  
  The property file is a tab delimited file, with levels defined in columns and choices defined in rows. For example, to have a 2 level selection where you first select a country and then a city, you could specify a file such as the following:
  
  Country City United States San Francisco United States Chicago Mexico Mexico City Mexico Cancun
  This would result in a first drop down with the options "Select a country...", "United States", and "Mexico" (the initial selection is "Select a country...", which serves as a label for the drop down). After the user selects a country, a "City" drop down would appear. If United States was chosen first, then San Francisco and Chicago would be options, but if Mexico was selected then instead Mexico City and Cancun would be options.
  
  The columns that should represent levels must be specified in the value field. For example "Country,City" could be valid values.
  
  Note that default values are not supported for multi-level selects.
  
  Multi-Level Multi Select: same as single select, but after all levels are chosen, a button appears to "Select another..." and an additional multi-level selection is presented.
- value : String
  Comma separated list of values for the single select or multi-select box.
  
  This field can be left blank if the comma separated values need to be picked up from a properties file (set via 'Property File' and 'Property Key').
  
  This value has different meaning for multi-level select -- see the parameter type help for more info.
- propertyFile : String
  The properties file is a collection of key,value pairs of the form key=value1,value2,...
  
  Property files may reference other properties. For example:
  prop1=a,b,c,d,e
  prop2=${prop1},f,g,h
  The properties file can be placed anywhere on the file-system that Jenkins can access.
  
  This property file has different meaning for multi-level select -- see the parameter type help for more info.
- propertyKey : String
  The property of the property file to use.
  
  For example, if the property file was the following:
  prop1=a,b,c,d,e
  prop2=1,2,3,4
  Then you could specify the property as either prop1 or prop2.
- defaultValue : String
  Initial selection of the single-select or mult-select box.
  
  In case of the multi-select box, default value can be a comma separated string.
- defaultPropertyFile : String
  Absolute path (specified without using environment variables).
- defaultPropertyKey : String
- quoteValue : boolean
- visibleItemCount : int
- multiSelectDelimiter : String
  
  Inserts this value between selections when the parameter is a multi-select.
  
  The default when empty is ','
- bindFieldName : String
- svnPath : boolean
- svnUrl : String
- svnUserName : String
- svnPassword : String
- projectName : String
- roleBasedFilter : boolean
- description : String (optional)
password
Pass a password to your build. The password entered here is made available to the build in plain text as an environment variable like a string parameter would be. The value will be stored encrypted on the Jenkins controller, similar to passwords in Jenkins configuration.
- name : String
- defaultValueAsSecret
  - Type: class hudson.util.Secret
- description : String (optional)

submitter : String (optional)
User IDs and/or external group names of person or people permitted to respond to the input, separated by ','. Spaces will be trimmed. This means that "alice, bob, blah " is the same as "alice,bob,blah".
Note: Jenkins administrators are able to respond to the input regardless of the value of this parameter.
submitterParameter : String (optional)
If specified, this is the name of the return value that will contain the ID of the user that approves this input. The return value will be handled in a fashion similar to the parameters value.

Was this page helpful?

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

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

See existing feedback here.

User Handbook

Tutorials

Resources

Pipeline: Input Step

`input`: Wait for interactive input

Example

User Handbook

Tutorials

Resources

Pipeline: Input Step

input: Wait for interactive input

Example

`input`: Wait for interactive input