delieverWorkspaceSnapshot

The deliverWorkspaceSnapshot delivers workspace snapshots. You can use this task to deliver the snapshot generated by the build process when automatically accepting incoming change sets as part of the build process. The default deliver flow target for the workspace is used unless overridden by the streamName attribute.

The following table describes deliverWorkspaceSnapshot 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 using the Jazz Build Engine.

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

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

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

verbose

Specifies more message output. The default is false.

No

streamName

The name of the stream for workspace comparisons. The stream name is also used when performing a snapshotBefore/snapshotAfter comparison to locate the snapshots.

No

workspaceUUID

The UUID of the workspace for the build. The value of this attribute is typically ${team.scm.workspaceUUID} because the property is build-in when using the Jazz Build Engine.

Yes

Note:
  • The default deliver flow target for the workspace is used unless overridden by the streamName attribute.
  • If there are not workspace snapshots to deliver, the task ends without error.

Example

<target name="main" description="Deliver Sanpshot">
	<im:deliverworkspacesnapshot
		repositoryAddress="${repositoryAddress}'
		userId="${userId}"
		passwordFile="${passwordFile}"
		workspaceUUID="${team.enterprise.scm.workspaceUUID}"
	/>
</target>

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