Overview
This article explains how to use the Include Document Metadata feature to migrate custom metadata columns and their associated values for files being migrated to SharePoint Online or OneDrive for Business.
By default, CloudM Migrate transfers standard file information. Enabling this feature allows for a richer migration, preserving custom metadata fields that you have configured in your source environment.
How to Enable Custom Metadata Migration
To include custom document metadata in your migration, you must enable the specific setting in your project configuration.
- In your CloudM Migrate batch configuration, navigate to the Configuration step.
- Select the Destination tab.
- In the SharePoint online category, toggle the setting Include Document Metadata.
Note: This setting is turned off by default.
What is Migrated?
Understanding what is migrated by default versus what this feature enables is key to a successful migration.
Default Metadata (Always Migrated)
When migrating to SharePoint or OneDrive, the following standard metadata fields are always migrated, regardless of whether 'Include Document Metadata' is enabled:
- Title
- Description
- Created (Date and Time)
- Modified (Date and Time)
- Author (Original Creator)
- Editor (Last Modifier)
Custom Metadata (Requires Feature to be Enabled)
When you enable the Include Document Metadata setting, CloudM Migrate will also migrate custom metadata columns that you have created.
Supported Custom Column Types
We currently support the migration of the most common column types:
- Single line of text
- Multiple lines of text
- Number (including currency, integer, and decimal)
- Yes/No (Boolean)
- Date and Time
For these supported columns, CloudM Migrate transfers both the column itself (name and description) and the corresponding value for each document.
Limitations and Unsupported Settings
Only the column types listed above are supported. Additionally, complex column settings are not migrated and will be reset to their SharePoint defaults in the destination. This includes, but is not limited to:
- Default Value
- Enforce Unique Values
- Column Validation
- Calculated fields
Post-Migration: Viewing Your Custom Metadata
After the migration is complete, the migrated custom metadata columns are hidden by default in the SharePoint Online / OneDrive user interface.
To make them visible, you must manually add them to a library view.
- Navigate to the Document Library in SharePoint or OneDrive.
- Click on any existing column header to open the dropdown menu.
- Select Column settings, then click Show/hide columns.
- In the pane that appears, check the boxes next to your custom columns that you wish to display.
- Click Apply.
Technical Requirements
The migration of site metadata is only supported when using the default API settings within CloudM Migrate. For clarity, these are:
- Source Data Export: Microsoft CSOM API
- Destination Data Import: SharePoint Migration API
No changes are required to your project's API settings to use this feature, as these are the standard, recommended APIs.
Reporting & Licensing
Each custom metadata column migrated for a site or user is counted as a single ‘SiteMetadata’ item.
These items are logged alongside document and mail statistics and are visible in the migration summary report after a migration cycle has been completed. This helps you track the volume of metadata being processed.