Parameter name,required.

Default agent server name,Not required.

The name (and label) displayed to the user when selecting settings prior to running a build.

Select the type of the artifact repository.

• Sonatype Nexus 3
• JFrog Artifactory 7 / Cloud

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/

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

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

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.

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.

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.

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.

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.

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

Check to allow multiple entries to be selectable.

The number of results to be displayed on the parameter view. The number must be between 1 and 100.

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)?)?)/.+

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.

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

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
        

The name of the parameter.

This value is used for display purposes only - it is not exposed as an environment variable.

The BuildMaster application to obtain the releases for.

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

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

Parameter Description.

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

Select the file format, such as YAML file or JSON file.

Select HTTP_HTTPS, URI, please fill in the URL address.
Select FILE_PATH, URI, please fill in the file path.

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

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

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.

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.

Mandatory — Name of the ClearCase UCM PVOB.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

The default credentials to use.

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.

The name this parameter will be referred to as during any builds.

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

Choices delimited with new line letters like:

choice1
choice2
choice3

Filter choices with input value. It works just like suggestion.

Restrict input values to be a value in choices.

The top most value will be the default value if not specified.

The name of the parameter.

The path of the directory containing the file system objects. If path is not allowed in manage/configure section or no object can be found you will receive an error message as value.

Only one value can be pre-selected as default when the value is contained in object list. (Multi select default is not supported for now!)

Objects in "Path" can be filtered: ALL, DIRECTORY, FILE, SYMLINK.

The regular expression matching the file system objects to be excluded in parameter selection. (Will be ignored if empty) See Standard Java regular expression.

The regular expression matching the file system objects to be included in parameter selection. (Will be ignored if empty) See Standard Java regular expression.

If true, the list of the parameter values will be sorted by last modified file attribute. Default order is sort by parameter value.

If true, the list of the parameter values will be sorted in reverse order.

If true, the path will be concatenated with the selected value.

The type of the file system objects that will be filtered from path.

Strip whitespace from the beginning and end of the string.

The name of the parameter.

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

This value is returned when the list is empty or if an error occurs while retrieving data.

Name of branch to look in. Used only if listing revisions.

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"

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.

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.

Which value is selected, after loaded parameters.
If you choose 'default', but default value is not present on the list, nothing is selected.

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

When this option is enabled will show a text field.
Parameter is filtered on the fly.

A description that will be shown to the user later.

Specify the number of items the list will display. A value of 0 will display as a DropDown list.

When this option is selected the user must select an option or an error will be thrown(default values are ignored)

Strip whitespace from the beginning and end of the string.

The name of the parameter
These parameters are exposed to build as environment variables.

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

Regular expression to filter image tag e.g. v(\d+\.)*\d+ for tags like v23.3.2

A Docker V2 API registry where to locate images and tags.
You can change the default value in Jenkins Configuration Page.

Credential (username with password) to authenticate against the registry

A description that will be shown to the user later.

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

Specify if Certificate validation will be performed

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.

This field allows you to select, how whitespaces at the start/end of the parameter should be handled, when a build is started:

1. Trim all leading/trailing whitespace from the entered value.
2. Keep the whitespace intact, exactly as the user entered it.
3. 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.

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.

Strip whitespace from the beginning and end of the string.

Strip whitespace from the beginning and end of the string.

Strip whitespace from the beginning and end of the string.

The name to be displayed on the build parameters page.

The JDK that will be used if the user does not specify one.

The JDKs that can be chosen from on the build parameters page.

The description to be shown on the build parameters page.

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.

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

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

(EXAMPLE-100)

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

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 ('_').

The description for the JsonEditor parameter.

Extra options for the JsonEditor form. See options for details.

The scheme for the JsonEditor form. See json-schema-support for details.

The initial values for the JsonEditor form. This value should be valid against the schema.
Leave empty to use the defaults from the schema.

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

The name of the parameter.

Specify the Git repository URL.

This value is returned when list is empty.

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.

When this option is enabled will show a text field.
Parameter is filtered on the fly.

When this option is enabled will show a text field.
Parameter is filtered on the fly.

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

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

Specify a regular expression which will be used to filter the branches which are actually displayed when triggering a new build.

Specify the number of items the list will display. A value of 0 will display as a DropDown list.

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.

Specify a regular expression which will be used to filter the tags which are actually displayed when triggering a new build.

For features such as SVN polling a default value is required. If job will only be started manually, this field is not necessary.

The maximum number of tags to display in the dropdown. Any non-number value will default to all.

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.

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.

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.

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

Specify a regular expression which will be used to filter the versions which are actually displayed when triggering a new build.

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.

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.

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.

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.

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.

Name of the parameter displayed in forms.

Description that is displayed as a help for users running a parameterized build, as to what the parameter is used for.

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

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

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.

Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.

Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.

Filter the list to exclude packages which have been uploaded to the server, but which are not installed.

Filter the list to exclude packages whose metadata have been modified after upload to the server, e.g. which need to be re-wrapped.

Set the number of visible items displayed when multiselect is enabled. The default is 10.

Specify a full-text search query to filter the list of packages, such as "Adobe".

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.

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.

Inserts a section header below the horizontal rule. Can be empty.

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.

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.

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.

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.

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.

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

Strip whitespace from the beginning and end of the string.

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.

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.

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.

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.

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

The name of the parameter
These parameters are exposed to build as environment variables.

The URL address for to the REST endpoint.

e.g. List GitLab repository releases https://gitlab.example.com/api/v4/projects/:id/releases

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.

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

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

A description that will be shown to the user later.

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.

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)

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.

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

Strip whitespace from the beginning and end of the string.

User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be published.

ServiceNow instance url where the application will be published to.

User name and password defined in global credentials (credentials ID is required here) used for the instance where the application will be installed.

ServiceNow instance url where the application will be installed.

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.

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.

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

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.

Time in milliseconds between one and another progress check set up for all build steps of ServiceNow.
Leave it empty to use default value.

Strip whitespace from the beginning and end of the string.

The name of the parameter.

Strip whitespace from the beginning and end of the 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).

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.

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.

Setting Field Separator property.
Field Separator - the character that will separate between the fields in the tests tree.

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

Setting Multiplicity Field property.
Multiplicity Field - the field that will be set to the amount of times the test should run.

Strip whitespace from the beginning and end of the string.

The name of the parameter

These parameters are exposed to build as environment variables.

Specifies the default value of the field, which allows the user to save typing the actual value.

Standard Java regular expression that will be used to validate the entered string parameter value.

This message is displayed to the user if they enter a value that does not match the configured regular expression.

A description that will be shown to the user later.

This message is displayed to the user if they enter a value that is not a syntactical correct YAML

The name of the parameter.

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.

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.

If specified, this adds a currentProject entry to the groovy script context. The entry's value is set to the specified Jenkins project.

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.

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.

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.

Absolute path (specified without using environment variables).

Inserts this value between selections when the parameter is a multi-select.

The default when empty is ','

The name of the parameter.

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.

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.

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.

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.

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.

Absolute path (specified without using environment variables).

Inserts this value between selections when the parameter is a multi-select.

The default when empty is ','