Reports

This accelerator contains multiple report flows to support your migration process.

Flows

Container structure report

The accelerator creates an Excel report that captures the container structure. It splits the hierarchy into configurable levels (default is 8) and provides the following columns:

• Xillio ID: A generated id based on objects metadata.
• Source ID: Id of the source container.
• Source Name: System name of the source container.
• Source Path: Full path of the container structure.
• Source Type: System name of the content type.
• Source Type Display: Display name of the content type.
• Level1 – LevelN: Represent the first N levels of the container hierarchy, where N is set by maxLevels.
• Remainder levels: Contains any additional levels beyond the configured N.
• Document counts: Number of documents within the container.

Settings

mongoConnection

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

reportPath

Path to the Excel file.

sheetName

Name of the sheet.

maxLevels

Number of hierarchical levels to return as separate columns. Default is 8, configurable as needed.

Content Types Count

The accelerator creates an Excel report that captures the number of content types. By default, it provides the following columns:

• Kind: Kind of the content.
• Content type system name: System name of the content type.
• Content type display name: Display name of the content type.
• Count: The number of the content type.

Settings

mongoConnection

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

reportPath

Path to the Excel file.

sheetName

Name of the sheet.

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 (source.contentType.systemName).
• Content type display name: Content type (source.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	source.properties.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	source.properties.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 source.properties.

This can be configured using the additionalPropertiesPaths setting.

Only objects located under source.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	source.properties.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.

Content Type Fields SPO

The accelerator creates an Excel report that captures all content types, including all fields, for each document library. The following columns are provided:

• Site URL: Site URL of the document library.
• Library URL: Library URL of the document library.
• Content Type: Display name of the content type.
• Field systemName: System name of a metadata field.
• Field displayName: Display name of a metadata field.
• Field type: Type of value used for the metadata field.

For example:

Site URL	Library URL	Content Type	Field systemName	Field displayName	Field type
https://company.sharepoint.com/xill4	https://company.sharepoint.com/xill4/Documents	Folder	FileLeafRef	Name	unknownFutureValue
https://company.sharepoint.com/xill4	https://company.sharepoint.com/xill4/Documents	Folder	Title	Title	text
https://company.sharepoint.com/xill4	https://company.sharepoint.com/xill4/Documents	Document	FolderChildCount	Folder Child Count	lookup
https://company.sharepoint.com/xill5	https://company.sharepoint.com/xill5/Documents	CustomType	Title	Title	text

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.

Content Types SPO

The accelerator creates an Excel report that lists the content types configured per library. By default, it provides the following columns:

• Site URL: Site URL of the document library.
• Library URL: Library URL of the document library.
• Content Type: Display name of the content type.

Settings

mongoConnection

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

reportPath

Path to the Excel file.

sheetName

Name of the sheet.

Transformation

The accelerator creates an Excel report with the transformation result. It provides the following columns:

• Migration Origin: migration.origin.
• Source ID: The id of the object in the source system.
• Source Name: The name of the object in the source system.
• Source Path: The location of the object in the source system.
• Kind: The content store schema.
• Version Series ID: The id that represents the complete set of versions.
• Current version: Indicates if the version is the current version.
• Major Version: The major version number.
• Minor Version: The minor version number.
• Source Creator: The creator display or system name of the object in the source system.
• Source Created Date: The creation date of the object in the source system.
• Source Modifier: The modifier display or system name of the object in the source system.
• Source Last Modified: The modification date of the object in the source system.
• Source Content Type: The content type display or system name of the object in the source system.
• Target Content Type: The content type display or system name of the object after transformation.
• Target Name: The name of the object after transformation.
• Target Path: The location of the object after transformation.
• Target ID: The id of the object after transformation.
• Target Creator: The creator display or system name of the object after transformation.
• Target Modifier: The modifier display or system name of the object after transformation.

In addition, it adds all target.properties fields as additional headers unless the customHeaders flow variable has been specified.

For example:

Migration Origin	Source ID	Source Name	Source Path	Kind	Version Series ID	Current version	Major Version	Minor Version	Source Creator	Source Created Date	Source Modifier	Source Last Modified	Source Content Type	Target Content Type	Target Name	Target Path	Target ID	Target Creator	Target Modifier	ApproverSingle	Business Units	Document Purpose	IsDone	Partial Source Path	Price	Reviewed	Source	RetentionLabel
Alfresco	workspace://SpacesStore/36f734ac-7b44-4998-84f7-4a69f78f6d02;2.0	Arches National Park - delicate arch v2.jpg	/Sites/xill4/documentLibrary/source e2e/Arches National Park - delicate arch v2.bmp	RECORD	workspace://SpacesStore/36f734ac-7b44-4998-84f7-4a69f78f6d02	FALSE	2	0	admin	13/03/2023	admin	13/03/2023	cmis:document	Xillio Document	Arches National Park - delicate arch v2.jpg	https://company.sharepoint.com/sites/demo/Gedeelde documenten/Arches National Park - delicate arch v2.jpg	8fef8e92-f47a-a8a1-0bfd-41ab426ab156	demo@sharepoint.com	demo@sharepoint.com		IT	/DMT/Document Purpose/Analysis, Data, Research	No	1 line	5678	0	Alfresco	Microsoft Information Protected
Alfresco	workspace://SpacesStore/3427fb94-1f21-4947-8008-ff4e2cf5e614;1.0	account``=%.txt	/Sites/xill4/documentLibrary/source e2e/account``=%.txt	RECORD	workspace://SpacesStore/3427fb94-1f21-4947-8008-ff4e2cf5e614	TRUE	1	0	admin	19/01/2023	admin	19/01/2023	cmis:document	Xillio Document	account``=%.txt	https://company.sharepoint.com/sites/demo/Gedeelde documenten/account``=%.txt	644a2ff0-1926-f6ed-7a21-4946d4e29022	demo@sharepoint.com	demo@sharepoint.com	demo@sharepoint.com	R&D,Finance	/DMT/Document Purpose/Finance ＆ Budgeting,/DMT/Document Purpose/Analysis, Data, Research	Yes,No,Maybe	line 1,line 2,line 3	1234	1	Alfresco
Alfresco	workspace://SpacesStore/bc3ec5ad-dd9e-4d83-b17d-b7dcf9a2d980;1.0	shoes_awesome_cambridgeshire.svc	/Sites/xill4/documentLibrary/source e2e/shoes_awesome_cambridgeshire.svc	RECORD	workspace://SpacesStore/bc3ec5ad-dd9e-4d83-b17d-b7dcf9a2d980	TRUE	1	0	admin	19/01/2023	admin	19/01/2023	cmis:document	Xillio Document	shoes_awesome_cambridgeshire.svc	https://company.sharepoint.com/sites/demo/Xill4 document sets/Document Set/shoes_awesome_cambridgeshire.svc	d7166f95-39bb-0a34-e531-0d7077ec14bd	demo@sharepoint.com	demo@sharepoint.com			/DMT/Document Purpose/Finance ＆ Budgeting					Alfresco

Settings

mongoConnection

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

mongoConnectionTarget

The Mongo connection string to connect to containing the exported SharePoint Online objects. Only used when targetIsSPO is set to true.

reportPath

Path to the Excel file.

sheetName

Name of the sheet.

targetIsSPO

Specifies if the target system is SharePoint Online. If set to true it will use the configured mongoConnectionTarget to retrieve the display names of the metadata fields. If set to false, the system name of the metadata field is used instead.

customHeaders

An object containing additional headers with the content store path of the property. When specifying an empty object, all properties in target.properties are added as headers.

Example:

{
    "Department" : "target.properties.department", 
    "Batch" : "migration.flags.batch"
}

Migration Reconciliation

The accelerator creates an Excel report with migration statistics that can be used to do reconciliation. It provides the following columns:

• Metric: Definition of the calculated statistics.
• Record: Count of records for metric.
• Container: Count of containers for metric.
• Total: Count of records+containers for metric.

For example:

Metric	Record	Container	Total
Total items	21	5	26
Migrated Successfully	17	3	20
Current Versions (records)	16		16
Non-Current Versions (records)	2		2
Failed to Migrate	1	1	2
Failed Reason: Already exists		1	1
Failed Reason: Unspecified	1		1
Excluded From Migration	3	1	4
Current Versions (records)	2		2
Non-Current Versions (records)	1		1
Excluded Reason: Out of scope	1	1	2
Excluded Reason: Unspecified	2		2

Settings

mongoConnection

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

reportPath

Path to the Excel file.

sheetName

Name of the sheet.

filterField

A content store field used for filtering the statistics.

Example: migration.origin

filterValues

An array of values to filter on specified filterField. When an empty array is provided, statistics are calculated on all objects.

Example: ["Alfresco"]