The task first identifies all of the outgoing change sets for all of the components defined to the specified workspace. It then finds all of the work items linked to each of those change sets, and finally, retrieves the IDs for all the work items found which are returned as a comma-separated list in the specified property.

By default, the outgoing change sets are identified by comparing the workspace to the current deliver flow target, presumably the target stream for the change sets. The outgoing change sets can also be derived from the default deliver flow target instead of the "current" deliver flow target. Individual components can be excluded from the change set search by specifying which components to exclude by name. Finally, the task can require a work item link for each change set, causing the build to fail if one is missing.

Attributes

The task supports Team Build Attributes, Build Extensions Debugging Attributes, Build Extensions General Attributes, as well as, its own task specific attributes. Click on a link for more information on the common attributes.

The following table describes the task specific attributes for the task:

Task Specific Attributes
Attribute Description Required
current Specify true to use current deliver flow target to identify change sets. Specify false to use default deliver flow target to identify change sets. The default is true. No
exclude Specify a comma-separated list of component names to exclude from the change set search. No
property The name of the Ant property in which to return the comma-separated work item ID list. No
required Specify true to require a work be linked to each change set. Specify false to ignore change sets without linked work items. If true, and a change set without a linked work item is encountered, the build will be failed. The default is false. No
workspaceUUID The UUID of the workspace which contains the change sets. The value of this attribute is typically ${team.scm.workspaceUUID} because the property is built-in when using the Jazz Build Engine. Yes

Notes

Examples

Find all work items linked to the workspace change sets 

<target name="main">
  
  <xt:getchangesetworkitems
    repositoryAddress="${repositoryAddress}"
    userId="${userId}"
    password="${password}"
    workspaceUUID="${workspaceUUID}"
    property="workItems"
  />
  <echo>${workItems}</echo>
  
</target>

Log: 

  [echo] 7