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:

  • Send the UUID to the startTeamBuild task to start a build for the request.
  • Send the UUID to the completeTeamBuild task in order to set buildNotNecessary to true. A build might not be necessary if there are no changes in the source since the last build.

The following table contains 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 for authentication to the repository. Requires password or passwordFile to be set.

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

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

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

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. You can only specify one password file. Either password or passwordFile can be provided, but not both.

No

repositoriesFile

The repositories registry file containing a listing 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

Whether to use 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

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}" />

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki