remoteFileMetadataReport

The remoteFileMetadtaReport task generates a file metadata across all components and projects in a workspace and is compatible with the Jazz Build Engine environment.

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 as properties or name value pairs. To designate which files to process and what properties to report, nest remoteFileMetadataReportRule elements in the remoteFileMetadataReport task.

The following table describes the remoteFileMetadataReport 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 the Jazz® Build Engine is used.

Yes

userId

User ID for authentication to the repository. Requires password or passwordFile to be set.

Yes

certificateFile

The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.

No

password

Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.

No

passwordFile

The password file to use for authentication to the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. Only one password file can be specified. Either password or passwordFile can be provided, but not both.

No

smartCard

Use of the connected smart card for authentication (true or false). Requires userId to be set. For more information about smart card authentication, see Connecting to repositories and project areas.

No

failOnError

If true (default value), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

verbose

More message output. The default value is false.

No

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 can be specified as s comma separated list.

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 be 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 can be specified as a comma separated list.

No

reportFile

The name of the report file. If a reportFile is specified, the build definition report will be written to the file. If omitted, the build definition report will be written to the build log.

Yes

workspaceUUID

The UUID of the workspace for the build. The value of this attribute is typically ${team.scm.workspaceUUID} because the property is build-in when using the Jazz Build Engine.

Yes

remoteFileMetadataReportRule Elements

A remoteFileMetadataReportRule element is specified in the remoteFileMetadataReport element. Each remoteFileMetadataReportRule element identifies a file to process and a property to rename. At least one remoteFileMetadataReportRule element is required.

The following table describes the valid remoteFileMetadataReportRule attribute values.

Attribute Description Default Required

match

The regular expression to match against the zFolder name/zFile name string. For example, you can specify match=".*/source\.cbl" for the COBOL/source.cbl file.

None

Yes

projectName

The name of an SCM project for which this rule applies. This attribute can be used to limit the scope of a rule to a specific project. By default, rules apply to all projects.

None

No

name

The name of the file metadata property to be deleted when the regular expression matches the zFolder name/zFile name string.

None

Yes

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 deleted. If no value is specified, the property is deleted if it is found.

None

No

Note:
  • This task must be run in an eclipse environment.
  • The default behavior is to perform a file search for all components defined to the workspace.

Example

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="remote" description="File Metadata Report">

<im:remotefilemetadatareport
	repositoryAddress="${repositoryAddress}"
	userId="${repositoryUserId}"
	password="${repositoryPassword}"
	workspaceUUID="${workspace.uuid}"
	reportFile="report.txt"
	reportFolder="C:\temp"
	>

	<im:remoteFileMetadataReportrule match=".*/*.*"/>
</im:remotefilemetadatareport>

</target>