remoteFolderMetadataReport

The remoteFolderMetadtaReport task generates a folder 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 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 as properties or name value pairs. To designate which folders to process and what properties to report, nest remoteFolderMetadataReportRule elements in the remoteFolderMetadataReport task.

The following table describes the remoteFolderMetadataReport 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 using the Jazz Build Engine.

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. You can only specify one password file. Either password or passwordFile can be provided, but not both.

No

smartCard

Whether to use 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 (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

verbose

Specifies more message output. The default 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

reportFolder

The name of the report file folder. This is the location for the report file. A fully qualified path is 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

remoteFolderMetadataReportRule Elements

A remoteFolderMetadataReportRule element is specified in the remoteFolderMetadataReport element. Each remoteFolderMetadataReportRule element identifies a folder to process and a property to rename. At least one remoteFolderMetadataReportRule element is required.

The following table describes the valid remoteFolderMetadataReportRule attribute values.

Attribute Description Default Required

match

The regular expression to match against the string (zFolder name) (zFile name). For example, DOBOL/source.cbl.

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 string (zFolder name).

None

No

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 can be run in an eclipse environment or in a Jazz Build Engine environment.
  • The default behavior is to perform a folder 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="remote" description="Folder Metadata Report">

<im:remotefoldermetadatareport
	repositoryAddress="${repositoryAddress}"
	userId="${repositoryUserId}"
	password="${repositoryPassword}"
	workspaceUUID="${team.scm.workspaceUUID}"
	reportFolder="report.txt"
	reportFolder="C:\temp"
	>

	<im:remoteFolderMetadataReportrule match=".*"/>
</im:remotefoldermetadatareport>

</target>

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki