getNextTeamBuildRequest

The getNextTeamBuildRequest task retrieves the next build request for a specified engine and an optional build definition.

The getNextTeamBuildRequest task returns a request UUID, which you can use in any of the following ways:

The table below describes getNextTeamBuildRequest task attributes.

Attribute Description Required

engineId

For the getNextTeamBuildRequest task, the identifier of the build engine for which to retrieve the next build request.

Yes

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

requestUUIDProperty

Stores the UUID of the retrieved build request. It is set only if a request is found.

Yes

userId

User ID to use.

Yes

buildDefinitionId

For the getNextTeamBuildRequest task, specifies a build definition ID to check for pending requests. If the build definition id is not supported by the specified build engine, then a request is not retrieved.

No

buildDefinitionIdProperty

Stores the build definition id of the next build request for the specified engine. It is defined only if a request for the specified engine is retrieved. Does not apply if buildDefinitionId is specified.

No

requestUUIDFile

Path to the file in which to store the UUID of the next build request for the specified build engine. The path can be relative to the base directory of the build file or a full path. The file is formatted as a java.util.Properties format and contains a property with the name specified by the requestUUIDProperty.

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

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

verbose

Specifies more message output. The default is false.

No

Example

<getNextTeamBuildRequest repositoryAddress="${repositoryAddress}"
		                         userId="${userId}"
		                         password="${password}"
		                         engineId="${buildEngineId}"
		                         requestUUIDProperty="requestUUID" />

<fail message="Did not find the next request as expected."
		      unless="requestUUID" />
<echo message="request UUID = ${requestUUID}" />

Feedback

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