globalFolderMetadataReport

Edit online

The globalFolderMetadtaReport task generates a folder metadata report 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 a Jazz source control management as properties or name value pairs. To designate which folders to process and what properties to include in the report, nest globalFolderMetadataReportRule elements in the globalFolderMetadataReport task.

The following table describes the globalFolderMetadataReport 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 to created. The value of this attribute is typically "report.txt". Both reportFile and reportFolder are required.	Yes
reportFolder	The path to the report file to created. This is a location in the build engine's file system where the reportFile will be written. Both reportFile and reportFolder are required.	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

globaleFolderMetadataReportRule Elements

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

The following table describes the valid globalFolderMetadataReportRule 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 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

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 folder metadata report for all folders, in all projects, in all components that are defined to the workspace


<!-- Folder Metadata Report -->
<target name="folder" description="Folder Metadata Report">

<im:getworkspaceuuid
	repositoryAddress="${repositoryAddress}"
	userId="${repositoryUserId}"
	password="${repositoryPassword}"
	property="workspace.uuid"
	workspaceName="IMS14.Service.Workspace.djreilly"
/>

<im:globalfoldermetadatareport
	repositoryAddress="${repositoryAddress}"
	userId="${repositoryUserid}"
	password="${repositoryPassword}"
	workspaceUUI="${workspace.uuid}"
	reportFile¡¨report.txt¨
	reportFolder="C:\temp"
	>
	<im:globalfoldermetadatareportrule match=".*/*.*"/>
</im:globalfoldermetadatareport>

</target>