requestPackage

The requestPackage task requests a package to be created for a specified packaging definition. There must be an active engine supporting the build definition for a successful request to occur.

The following table contains requestPackage task attributes.

Attribute Description Required

buildDefinitionId

For requestPackage task, the package definition id, such as test.pkg to request a package creation.

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

deletePropertiesFile

Path to a properties file. This properties file specifies properties that should be omitted when the build is run. The properties are assumed to exist in the build definition. The path can be a relative path from the base directory of the build file or a full path.

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

overridePropertiesFile

Path to a properties file. This properties file can add new properties or override existing properties in the build definition. The path can be a relative path from the base directory of the build file or a full path.

No

packageImpacted

If true, the indirect outputs from the work item change sets, such as linked load modules or bound programs, are included in the package contents. This attribute only applies if packageType=workitem. Default is true.

No

packageType

  • shiplist (default): package based on the ship list rules defined in the package definition
  • workitem: package based on the work items specified.

No

packageWorkItems

A semicolon-separated list of work item numbers to be packaged. For example, 1;3;9.

No

packageWorkItemUUIDs

A semicolon-separated list of work item UUIDs to be packaged. For example, _foCQICVGEeOHfOSnPPJHVA;_oqvgoCSfEeOFz9UXwxp0Kw. This attribute can be specified as an alternative to attribute packageWorkItems, but both attributes cannot be specified in the same request.

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

requestUUIDProperty

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

No

resultUUIDProperty

Property to store the UUID of the build result.

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

timestamp

Package ship list contents which are newer than timestamp. For example, 20130901-1430405555 = September 1st, 2013, at 2:30:40.5555 PM.

No

verbose

More message output. The default value is false.

No

Example

<taskdef name="requestPackage" classname="com.ibm.team.enterprise.packaging.taskdefs.RequestPackagingBuildTask" />
<requestPackage buildDefinitionId="PackageDef1" repositoryAddress="https://example.com:9443/ccm" userId="RELENG" passwordFile="/u/RELENG/private/rtcPasswordFile.txt" resultUUIDProperty="rtc.buildResultUUID" packageType="workitem" packageWorkItems="1;2;3" packageImpacted="true" />