setBuildResult

The setBuildResult task updates the specified build results.

The BuildResultAttribute Elements Elements designate which build result attribute to update and the new value for that attribute.

The following table describes setBuildResult attributes.

Attribute	Description	Required
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
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
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
failOnError	If `true` (default value), the task fails if it encounters an error. If `false`, some errors are ignored and the task is completed.	No
verbose	More message output. The default value is `false`.	No
buildId	The ID for the build that is to be created.	No
buildResultUUID	The UUID of the build result to update. The value of this attribute is typically ${buildResultUUID} because the property is built-in when using the Jazz Build Engine. The ${buildResultUUID} property will be automatically retrieved from the ant environment if this attribute is not specified. This attribute isused to identify the build result to update. Either buildId or buildResultUUID can be provided, but not both.	No

BuildResultAttribute Elements

A BuildReaultAttribute element is specified in the setBuildResult element. Each element identifies a build result attribute value to change. At lease one BuildResultAttribute element is required. The following table describes the valid BuildResultAttribute attribute values.

Attribute	Description	Required
name	Name of the build result attribute	Yes
value	Name value for the build rsult attribute.	Yes

The following table describes the valide build result attributes and the required values for those attributes.

Attribute Name	Required Value	Notes
buidid	Id of a build definition	The build result is assigned to the specified build definition.
deleteAllowed	true false	The build result delete allowed setting is updated to the specified value.
ignoreWarnings	true false	The build result ignore warnings setting is updated to the specified value.
label	Text string to be used as the build result label	The build result label is updated to the specified value.
personalBuild	true false	The build result personal build setting is updated to the specified value.
status	OK INFO WARNING ERROR	The build result status is updated to the specified value.
tags	Text strings to be used as build result tags	The build result tags are updated to the specified value.

Note: Build status cannot be set to a less severe status than its current value. For example, if the status is currently BuildStatus ERROR, it cannot be set to BuildStatus OK. When a result is created, its status is initialized to BuildStatus OK. Throughout a build, as contributions are added to ta result, the result's status might be updated to a more severe status, but not a less severe status.

Example

Set a build result warning regardless of ignore warning setting


<im:setbuildresult
	repositoryAddress="${repositoryAddress}"
	userId="${userId}"
	passwordFile="${passwordFile}"
	buildResultUUID="${buildResultUUID}">

<im:buildresultattribute name="status" value="WARNING"/>
<im:buildresultattribute name="IgnoreWarnings" value="false"/>

</im:setbuildresult>