The task is used to generate a file metadata report across all components and projects in a workspace. By default, all components in the workspace are included in the file search process. Exclude and include attributes can be specified to customize which components to use, and thereby, which files will be processed. File metadata is stored in Jazz Source Control Management (SCM) as properties or name-value pairs. To designate which files to process and what properties to include in the report, nest RemoteFileMetadataReportRule 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 files 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 files. 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 files 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 files. Multiple components may be specified as a comma separated list.	No
preview	Specify `true` to preview what file metadata would be processed. The default is `false`; when a file is found, the file 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
reportFile	The name of the report file to create. The value of this attribute is typically "report.txt". Both reportFile and reportFolder are required.	Yes
reportFolder	The path to the report file to create. This is a location in the build engine’s file system where the report file will be written. Both reportFile and reportFolder are required.	Yes
workspaceName	Specify the name of the workspace that contains the files 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 files 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 files processed to Enterprise Extensions file items; the zFiles residing in zFolders in the zOSsrc directory. Specify `false` to process all files in all project directories. The default is `true`.	No

RemoteFileMetadataReportRule Element

The RemoteFileMetadataReportRule element is specified within the element. Each RemoteFileMetadataReportRule element identifies a file to process and a property to include in the report. At least one RemoteFileMetadataReportRule element is required. The following table describes the valid RemoteFileMetadataReportRule attribute values:

RemoteFileMetadataReportRule Element Attributes

Attribute Description Required

match

Specify a regular expression for the file name that is the target of this rule. This expression is used to match the file path string "zOSsrc/zFolder/zFile" when zOSsrc is true and "projectName/path/file" 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 file path string omitting zOSsrc: "zFolder/zFile". When zOSsrc is false, the simple form uses a file path string omitting the project name: "path/file".

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

Regex form:	Value to specify:
Simple	`COBOL/MYCOBOL\.cbl`
Simple qualified	`^COBOL/MYCOBOL\.cbl$`
Standard	`zOSsrc/COBOL/MYCOBOL\.cbl`
Standard qualified	`^zOSsrc/COBOL/MYCOBOL\.cbl$`

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

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

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 file metadata property you want included in the report when the regular expression matches the file name. If a name is not specified, all properties will be included in the report. No

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

value The value of the file 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 included in the report. If a value is not specified, the property is included in the report if found. If value is specified, name is required. If a name is omitted, the value will be ignored. No

Notes

The generic RemoteFileMetadataRule element is equivalent to the RemoteFileMetadataReportRule element and may be used in its place.
The default behavior is to perform a file search for all components defined to the workspace.

Examples

Create a file metadata report for all files, in all projects, in all components that are defined to the workspace:

<!-- File Metadata Report -->
<target name="main" description="File Metadata Report">
  
  <xt:
    repositoryAddress="${repositoryAddress}"
    userId="${userId}"
    password="${password}"
    workspaceName="IMS14.Service.Workspace.djreilly"
    reportFile="report.txt"
    reportFolder="C:\temp"
    >
    
    <xt:Rule match=".*"/>
    
  </xt:>
  
</target>

Example log:

main:
[xt:] RemoteFileMetadataReport task starting
[xt:] RemoteFileMetadataReport rule matched: "null" property report for file "BPEAQHT0.asm"

...

[xt:] RemoteFileMetadataReport rule matched: "null" property report for file "CSLSCMSG.macsrc"
[xt:] RemoteFileMetadataReport rule matched: "null" property report for file "CSLSACH0.clst"
[xt:] RemoteFileMetadataReport rule matched: "null" property report for file "CSLSACL0.clst"
[xt:] RemoteFileMetadataReport task complete

Example:

getTaskNameHdr()

Attributes

RemoteFileMetadataReportRule Element

Notes

Examples