The task is used to create or update folder metadata. Folder metadata is stored in Jazz Source Control Management (SCM) as properties or name-value pairs. To designate which folders to process and what properties to create, nest FolderMetadataRule elements within the task element.
The following table describes the task specific attributes for the task:
| Task Specific Attributes | ||
| Attribute | Description | Required |
| clean |
Specify true to discard all current folder properties. Valid values are true and false. The default is false.
|
No |
| projectRoot | Root directory of the zComponent project. The default is the location where the Ant script executing the task is located. | No |
| verbose |
Specifies more message output. Valid values are true and false. The default is false.
|
No |
The FolderMetadataRule element is specified within the element. Each FolderMetadataRule element identifies a folder to process and a property to create or update. At least one FolderMetadataRule element is required. The following table describes the valid FolderMetadataRule attribute values:
| FolderMetadataRule Element Attributes | ||
| Attribute | Description | Required |
| match |
The regular expression to match against the string "zFolder_name". For example: match="COBOL" for the folder "COBOL".
|
Yes |
| name | The name of the folder metadata property you want to modify when the regular expression matches the folder name. | Yes |
| value | The value of the folder metadata property. Empty strings are allowed and do not result in a property being deleted. If a value is not specified, the property value will default to an empty string. | No |
<!-- Folder Metadata Define -->
<target name="folder" description="Folder Metadata Define">
<xt:folderMetadata>
<xt:folderMetadataRule match="^ASM$" name="package.folder.fmid" value="01"/>
</xt:folderMetadata>
</target>