Metadata Fields

This flow generates an Excel file reporting the following information about the (top-level) metadata fields of RECORD and CONTAINER objects present in the Content Store:

• Kind: Object type: RECORD or CONTAINER.
• Content type system name: Content type (<sourceOrTarget>.contentType.systemName).
• Content type display name: Content type (<sourceOrTarget>.contentType.displayName).
• Total Objects: Total number of objects of that kind and content type.
• Field Name: Name of a metadata field present in those objects.
• Field Path: Full path of the field in the Content Store.
• Field Occurs: Number of objects that contain the field.
• Field Filled: Number of objects where the field is set to a value.
• Field Empty: Number of objects where the field is empty.
• Max Length: Longest string length of values for the field (0 if the field is not a string).
• Sample objectId: _id of an object containing the field.
• Sample hierarchy: Hierarchy of the object in the Content Store.
• Sample Value: Example value for the field from the object with ObjectId. If the field is a nested object, the value will display as [object Object].

For example:

Kind	Content type system name	Content type display name	Total objects	Field name	Field path	Field occurs	Field filled	Field empty	Max length	Sample objectId	Sample Value
RECORD	File	File	40	mapping	migration.mapping	40	40	0	0	78f888fef625a261...	[object Object]
RECORD	File	File	40	rootId	source.properties.rootId	40	40	0	36	78f888fef625a261...	ec25fead-229c-4cac-b279-02ad115993f2
RECORD	File	File	40	rootHierarchy	source.properties.rootHierarchy	40	40	0	49	78f888fef625a261...	/sites/demo-site/Shared%20Documents
CONTAINER	Folder	Folder	4	mapping	migration.mapping	4	4	0	0	39e578b6acabb210...	[object Object]
CONTAINER	Folder	Folder	4	rootId	source.properties.rootId	4	4	0	36	39e578b6acabb210...	ec25fead-229c-4cac-b279-02ad115993f2
CONTAINER	Folder	Folder	4	rootHierarchy	source.properties.rootHierarchy	4	4	0	49	39e578b6acabb210...	/sites/demo-site/Shared%20Documents

note

The field that the metadata items are extracted from depends on the source:

Source	Property
Alfresco	source.properties.succinctProperties
OpenText	source.properties.categories.<subcategory>
Any other source	source.properties

---

Additional Property Locations

In addition to the default metadata fields, users can optionally include metadata fields from additional objects located under <sourceOrTarget>.properties.

This can be configured using the additionalPropertiesPaths setting.

Only objects located under <sourceOrTarget>.properties are supported.

When additionalPropertiesPaths is configured with one or more paths, only the metadata fields found under the specified paths are included in the report. In this case, the default metadata fields are not included.

If additionalPropertiesPaths is an empty array, only the default metadata fields are included.

Example

- Without additionalPropertiesPaths set (empty array):

The report includes only the default metadata fields, such as:

Kind	Content type system name	Content type display name	Total objects	Field name	Field path	Field occurs	Field filled	Field empty	Max length	Sample objectId	Sample Value
RECORD	File	File	40	mapping	migration.mapping	40	40	0	0	78f888fef625a261...	[object Object]
RECORD	File	File	40	rootId	source.properties.rootId	40	40	0	36	78f888fef625a261...	ec25fead-229c-4cac-b279-02ad115993f2

- With additionalPropertiesPaths set to

["source.properties.objectProperties", "source.properties.test"]

The report will include only fields located under the specified paths. Default metadata fields are not included.

Kind	Content type system name	Content type display name	Total objects	Field name	Field path	Field occurs	Field filled	Field empty	Max length	Sample objectId	Sample Value
RECORD	File	File	40	objectProperties_name	source.properties.objectProperties.name	40	40	0	1	78f888fef625a261...	file.pdf
RECORD	File	File	40	test_Customer Department	source.properties.test.Customer Department	40	40	0	1	78f888fef625a261...	65

Settings

mongoConnection

The Mongo connection string including the database name to connect to.

reportPath

Path to save the Excel file containing the report to.

sheetName

Name of the sheet for the report in the Excel file.

additionalPropertiesPaths

Optional list of additional property paths to include in the report.

sourceOrTarget

Specifies whether the metadata fields are extracted from source or target.

Allowed values:

• source

• target