folderMetadatadelete
The folderMetadatadelete task deletes folder metadata.
Folder metadata is stored in Jazz source control management as properties or name value pairs. To designate which folders to process and what properties to delete, nest folderMetadataDeleteRule elements in the folderMetadataDelete task.
The following table describes folderMetadataDelete attributes.
Attribute | Description | Required |
---|---|---|
clean |
Specify |
No |
projectRoot |
Root directory of the zComponent project. The default is the location where the Ant script that runs the fileMetadataDelete task is located. |
No |
verbose |
More message output. The default value is |
No |
folderMetadataDeleteRule Elements
The folderMetadataDeleteRule element is specified in the folderMetadataDelete element. Each folderMetadataDeleteRule element identifies a folder to process and a property to create or update. At least one folderMetadtaDeleteRule element is required.
The following table describes the valid folderMetadtaDeleteRule element attributes.
Attribute | Description | Default | Required |
---|---|---|---|
match |
The regular expression to match against the zFolder name/zFile
name string. For example, you can specify |
None |
Yes |
name |
The name of the folder metadata property you want to modify when the regular expression matches the zFolder name string. |
None |
Yes |
value |
The value of the folder metadata property you want to specify. Empty strings are allowed an do not result in a property being deleted. If a value is not specified, the property value will default to an empty string. |
None |
No |
- This task must be run in an eclipse environment.
- A property value can be specified to selectively delete properties with the specified value.
- If the
clean="true"
attribute is specified and a matched folder has no properties, no action is taken. - To delete all folder properties, specify the
clean="true"
attribute and a non-blank value for name in the folderMetadataDeleteRule. For example:<im:fodermetadatadelete clean="true"> <im:foldermetadatadeleterule match="^ASM$" name="all"/> </im:foldermetadatadelete>
Example
<!-- Folder Metadata Delete -->
<target name="folder" description="Folder Metadata Delete">
<im:foldermetadatadelete>
<im:foldermetadatadeleterule match="ASM$" name="package.folder.fmid" value="01"/>
</im:foldermetadatadelete>
</target>