buildResultRetriever

Edit online

The buildResultRetriever task retrieves the label, deleteAllowed, and tags values from a build result and adds them to an Ant property that you specify. You can name the Ant property by specifying the value for the task attributes of labelProperty, tagsProperty, and deleteAllowedProperty.

The following table describes buildResultRetriever attributes.

Attribute	Description	Required
buildResultUUID	For the deleteBuildResult task, the UUID of the build result to delete.	Yes
repositoryAddress	Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when the Jazz® Build Engine is used.	Yes
userId	User ID for authentication to the repository. Requires password or passwordFile to be set.	Yes
certificateFile	The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.	No
labelProperty	The Ant property in which to store the label of the build result.	No
deleteAllowedProperty	The Ant property in which to store the delete allowed value (true or false) of the build result.	No
tagsProperty	The Ant property in which to store the tags of the build result.	No
integratedWindows	Whether to use Integrated Windows Authentication	No
kerberos	Whether to use Windows user credentials using Kerberos/SPNeGO.	No
password	Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.	No
passwordFile	The password file to use for authentication to the connection. You can create a suitable password file by invoking the Jazz Build Engine with the `-createPasswordFile` argument. Only one password file can be specified. Either password or passwordFile can be provided, but not both.	No
repositoriesFile	The repositories registry file that contains a list of repositories and their login credentials. You can specify repositoriesFile or certificateFile, but not both. If you specify repositoriesFile, do not specify either password or passwordFile. The repositories file is created and updated through the use of scm login and logout commands.	No
reuseLoginOption	The first time an Ant task logs in to a repository, a connection is not terminated at the end of this task. All subsequent tasks reuse this connection as long as they connect to same repository with same user ID. When a task logs in to a different repository or with a different user ID, the previous connection is terminated and a new connection is created and reused.	No
smartCard	Use of the connected smart card for authentication (`true` or `false`). Requires userId to be set. For more information about smart card authentication, see Connecting to repositories and project areas.	No
verbose	More message output. The default value is `false`.	No

Example

<buildResultRetriever repositoryAddress="${repositoryAddress}"
                            userId="${userId}"
                            password="${password}"
                            buildResultUUID="${buildResultUUID}"
                            labelProperty="testLabel"
                            deleteAllowedProperty="testDeleteAllowed"
                            tagsProperty="testTags"/>