The task is used to rename folder metadata across all components and projects in a workspace. By default, all components in the workspace are included in the folder search process. Exclude and include attributes can be specified to customize which components to use, and thereby, which folders will be processed. 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 rename, nest RemoteFolderMetadataRenameRule elements within the task.

This task is not dependent on an Eclipse^® environment. It can be executed in a Jazz Build Engine or any build environment that has access to the System Definition toolkit. Additionally this task does not require the specified workspace be loaded. This task will use SCM facilities to find and access the files and their properties. Any changes that are made are stored in a change set associated with the workspace that is checked in and ready for review and delivery.

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
exclude	A list of component names to exclude from the process. By default, all components in the workspace are included. This list is used to identify components that are defined to the workspace, but that should not be included when searching for folders to process. The exclude attribute is optional. Both the exclude and include attributes can be specified on a build to identify which components to process when searching for folders. Multiple components may be specified as a comma separated list.	No
importAsis	Specify `true` to bypass property value translation. Valid values are `true` and `false`. The default is `false`. This attribute is the complimentary attribute to the exportAsis attribute. When the exportAsis attribute is set to `true`, property values are exported in their internal format. When the importAsis attribute is set to `true`, property values are imported using their internal format. If property values were exported in their internal format, they must be imported in their internal format. The value for any property that represents an EWM^® item is normally that item’s UUID. When exporting and importing to the same system, using the UUID is more efficient, but less readable. When exporting on one system and importing on another, the UUID will not be usable and the value must be converted to a textual name of the item. The default behavior of an export is to translate the UUID property value into the textual name of the item. If that behavior is overridden, the importAsis attribute must be set to `true` to correctly import the value.	No
include	A list of component names to include in the process. By default, all components in the workspace are included. This list is used to identify specific components that are defined to the workspace, that should be included when searching for folders to process. The include attribute is optional. Both the exclude and include attributes can be specified on a build to identify which components to process when searching for folders. Multiple components may be specified as a comma separated list.	No
preview	Specify `true` to preview what folder metadata would be processed. The default is `false`; when a folder is found, the folder metadata will be processed.	No
projectArea	The name of the EWM project area where Enterprise Extensions system definitions are defined. System definition data is required to translate any property value that references an Enterprise Extensions system definition, for instance, a language definition associated with a source file. Note: The projectArea attribute is not required if one of the workspace default accept target, current accept target, default deliver target, or current deliver target is a stream defined in the same project area as the Enterprise Extensions system definitions.	No
workspaceName	Specify the name of the workspace that contains the folders to be processed. Note: A workspace must be specified by the workspaceName attribute, the workspaceUUID attribute, or the `team.scm.workspaceUUID` build property. If a workspace is not identified by one of these three methods, the build will fail.	No
workspaceUUID	Specify the UUID of the workspace that contains the folders to be processed. The default value for this attribute is the value of the `team.scm.workspaceUUID` build property. Note: A workspace must be specified by the workspaceName attribute, the workspaceUUID attribute, or the `team.scm.workspaceUUID` build property. If a workspace is not identified by one of these three methods, the build will fail.	No
zOSsrc	Specify `true` to limit the folders processed to Enterprise Extensions folder items; the zFolders in the zOSsrc directory. Specify `false` to process all folders in all project directories. The default is `true`.	No

RemoteFolderMetadataRenameRule Element

The RemoteFolderMetadataRenameRule element is specified within the element. Each RemoteFolderMetadataRenameRule element identifies a folder to process and a property to rename. At least one RemoteFolderMetadataRenameRule element is required. The following table describes the valid RemoteFolderMetadataRenameRule attribute values:

RemoteFolderMetadataRenameRule Element Attributes

Attribute Description Required

match

Specify a regular expression for the folder name that is the target of this rule. This expression is used to match the folder path string "zOSsrc/zFolder" when zOSsrc is true and "projectName/path/folder" when zOSsrc is false.

A simple form of the regular expression path string is supported for each zOSsrc setting. When zOSsrc is true, the simple form uses a folder path string omitting zOSsrc: "zFolder". When zOSsrc is false, the simple form uses a folder path string omitting the project name: "path/folder".

For example, when zOSsrc is true, you would code one of the following:

Regex form:	Value to specify:
Simple	`COBOL`
Simple qualified	`^COBOL$`
Standard	`zOSsrc/COBOL`
Standard qualified	`^zOSsrc/COBOL$`

When zOSsrc is false, you would code one of the following:

Regex form:	Value to specify:
Simple	`zOSsrc/COBOL` or `src`
Simple qualified	`^zOSsrc/COBOL$` or `^src$`
Standard	`project\.name/zOSsrc/COBOL` or `com\.ibm\.team\.enterprise\.zos\.build/src`
Standard qualified	`^project\.name/zOSsrc/COBOL$` or `^com\.ibm\.team\.enterprise\.zos\.build/src$`

When the rule is processed the match text will be converted to the standard qualified form regardless of the method chosen to specify the regular expression. The simple and unqualified alternatives are provided for convenience and downward compatibility.

Yes

name The name of the folder metadata property you want to rename when the regular expression matches the folder name. Yes

projectName The name of the project for which this rule applies. This attribute can be used to limit the scope of a rule to a specific project within a component. By default, rules apply to all projects in a component when zOSsrc is true. When zOSsrc is false, the project name can be specified as part of the match pattern. No

rename The new name of the folder metadata property. Yes

value The value of the folder metadata property. A value is optional. If a value is specified, the current property value and the specified value must match for the property to be renamed. If a value is not specified, the property is renamed if found. No

Notes

The generic RemoteFolderMetadataRule element is equivalent to the RemoteFolderMetadataRenameRule element and may be used in its place.
The default behavior is to perform a folder search for all components defined to the workspace.
A property value can be specified to selectively rename properties with the specified value.

Examples

Rename a property for a folder:

<!-- Folder Metadata Rename -->
<target name="folder" description="Folder Metadata Rename">
  
  <xt:
    repositoryAddress="${repositoryAddress}"
    userId="${userId}"
    password="${password}"
    workspaceName="IMS14.Service.Workspace.djreilly"
    >
    
    <xt:Rule match="^ASM$" name="package.folder.fmid" value="01" rename="old.folder.fmid"/>
    
  </xt:>
  
</target>

Example log:

folder:
[xt:] RemoteFolderMetadataRename task starting
[xt:] RemoteFolderMetadataRename rule matched: "package.folder.fmid" property renamed for folder "ASM"
[xt:] RemoteFolderMetadataRename task complete

getTaskNameHdr()

Attributes

RemoteFolderMetadataRenameRule Element

Notes

Examples