The task is used to clear items from a cache element in the Build Cache. This task is an external mechanism to control elements created in the build cache by other applications. The item types currently supported by this task are:

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
The task does not currently support task-specific attributes.

Build Cache Type Elements

One or more Build Cache Type elements must be specified within the element. Build Cache Type elements are used to identify which cache element to clear of cached items. At least one Build Cache Type element is required. The following are the supported Build Cache Type elements:

  1. buildCacheBuildMap
  2. buildCacheWorkspace

The following table describes the valid Build Cache Type element attributes and their options. Some attributes are only valid for certain Build Cache Types; these attributes are identified by a numeric superscript identifier referencing the above ordered list.

Build Cache Type Element 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. If this attribute is specified, it will override any repository address specified on the task. If this attribute is not specified, the repository address specified on the task will be used. No
buildResultUUID[1] The UUID of the build result. The value of this attribute is typically ${buildResultUUID} because the property is built-in when using the Jazz Build Engine. This attribute is used to identify the build result that is associated with cache element in the Build Cache. Yes

Notes

Examples

Clear all cached workspace items associated with the repository identified by ${repositoryAddress}: 

<target name="main">
    
    <xt:buildCacheClear>
        <xt:buildCacheWorkspace repositoryAddress="${repositoryAddress}"/>
    </xt:buildCacheClear>
    
</target>