waitForTeamBuild

The waitForTeamBuild task waits for a build to enter a specified build state.

The table below describes waitForTeamBuild task attributes.

Note: You can only specify either buildResultUUID or requestUUID in any given invocation of a task. The attributes are mutually exclusively.
Attribute Description Required

buildResultUUID

For waitForTeamBuild, the UUID of the build result that is waited on. This is typically specified if the build was started using {@link StartBuildTask}, which returns the build result uuid in the property specified by the resultUUIDProperty attribute.

Yes, if requestUUID is not specified.

repositoryAddress

Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when using the Jazz Build Engine.

Yes

requestUUID

For waitForTeamBuild, the UUID of the build request that is waited on. This is typically specified if the build was requested using {@link RequestBuildTask}, which returns the build request uuid in the property specified by the requestUUIDProperty attribute.

Yes, if buildResultUUID is not specified.

userId

User ID to use.

Yes

buildStateProperty

The property to write the state of the build when the task finishes waiting. It is only set if the build entered one of the specified states to wait for.

No

buildStatusProperty

The property gets assigned the status of the build, where the value is one of OK, INFO, WARNING, or ERROR.

No

failOnError

If true (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

interval

The time between checks to determine if the build is in the required state. The value is in seconds and must be greater than zero and less than or equal to the timeout value. The default is to check every 30 seconds.

No

password

Password for the user ID, a zero-length string by default unless specified.

No

passwordFile

The password file to use for the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. You can only specify one password file.

No

statesToWaitFor

A comma separated list of build state names. Defaults are COMPLETED and INCOMPLETE. Valid values are the following:
  • NOT_STARTED: a requested build has not started. Also referred to as pending.
  • IN_PROGRESS: the build is in progress.
  • COMPLETED: the build completed normally, but can contain errors.
  • CANCELED: the build request is canceled before the build started.
  • INCOMPLETE: the build did not complete normally. Also referred to as abandoned.

No

timeout

The maximum amount of time that the task waits on the build. The value is in seconds and must be greater than zero. The default is to wait forever.

No

verbose

Specifies more message output. The default is false.

No

Example

<waitForTeamBuild repositoryAddress="${repositoryAddress}"
                                   userId="${userId}" 
                                   password="${password}" 
                                   buildResultUUID="${buildResultUUID}"
                                   statesToWaitFor="COMPLETED" 
                                   verbose="true" 
                                   interval="1" 
                                   timeout="30"/>

Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug