- Introduction
- Use Cases
- Installation
- Data Import and Data Export Schema Generation
- Export Config File
- Import Config File
- Data Export
- Data Import
The CDS Data Migrator tool provides an easy to use interface that enables you to generate an XML schema file that can be used to export data from one CRM environment and import into another. The tool not only supports the ability to add entity attributes and many-to-many relationships to the schema, but beyond that, it supports the creation of filters and GUID mappings which are stored as JSON file formats.
A major benefit of the CDS Data Migrator is that it has data obfuscation built in. For example, sample production data might contain confidential information such as names, email and GUIDs which should not exist in other environments. When import this data into another environment such as test or UAT then the tool can be configured to scrabble select entity fields during the import. Strings are scrabbled by replacing a value with a new value of the same length but with random characters (A-Z a-z 0-9). Numbers are scrabbled to another random number. If you need to move reference/configuration data from development into other environments such as test, UAT or production then this tool saves time as the configuration would only need to be done once and then can be replicated in other environments seamlessly using the tool. This includes entities such as Calendars, Business Units, Teams, and Organisation Settings.
Below is a table comparing the CDS Data Migrator tool with Microsoft's.
| Feature | MSFT Configuration Migration Tool | CDS Data Migrator |
|---|---|---|
| Supports attributes in schema |  |
|
| Supports many to many relationships in schema | |
|
| Schema Validation | |
 |
| Modification of existing schema | |
|
| Exporting of data from a single environment using schema | |
|
| Error logging on data export / import process | |
|
| Colour coded sorting applied to attributes | |
|
| Apply GUID Mappings included in export / import process | |
|
| Apply Filters included in the export / import process | |
|
| Ability to migrate Teams | |
|
| Ability to migrate Calendars | |
|
| Ability to migrate Business Units | |
|
Before using the CDS Data Migrator, you will need to install XrmToolBox which can be downloaded from here
Once XrmToolBox is installed, launch it and then select the Tool Library through Configuration menu as shown below:
Then search for "CDS Data Migrator", select and Install it:
Once the installation has completed successfully, you will see the CDS Data Migrator listed in the Tools windows as shown below:
Click the data migrator to launch it. You will be prompted for a connection to Dynamics 365 organization as shown below:
Connect to an environment and you will be taken to the Schema Configs page as shown below:
The data migrator adheres to a predefined import export schema and the tool can be used to generate the respective schema for import and export. Note that for each of these, both the JSON and CSV formats are supported.
To generate or modify a schema, please follow the steps below:
-
Select Schema Config from the top ribbon if you are not on this page already.
-
If you have an existing schema, you can click on Load Schema to edit that file. This will pre-select the entities, attributes and relationships stored in that file.
-
Select/unselect the entities, attributes, and relationships to export/import. In this example, we are creating a schema file for Accounts although you can select multiple entities.
-
To save the file, click on Save Schema.
Your schema file will be saved at the specified location. This file will contain all selected entities and their respective selected attributes and relationships.
Below shows an example schema file:
The export config file gives you additional control and features over Microsoft's Configuration Migration Tool. You can understand these options further here.
To create or update an export config:
-
Select Data Export from the top ribbon which will bring you to the below page:
-
If you have an existing export config file, you can click on Load to edit that file. This will pre-input the configs that you had stored in that file.
-
Adjust the fetch and write settings accordingly and ensure you add a schema file.
-
To save the new or updated export config file, click on Save.
Your export configs file will be saved at the specified location.
Below shows an example export config file:
The import config file gives you additional control and features over Microsoft's Configuration Migration Tool. You can understand these options further here.
To create or update an import config:
-
Select Data Import from the top ribbon which will bring you to the below page:
-
If you have an existing import config file, you can click on Load to edit that file. This will pre-input the configs that you had stored in that file.
-
Adjust the fetch and write settings accordingly, including a schema file if importing from CSV.
-
To save the new or updated import config file, click on Save.
Your import configs file will be saved at the specified location.
Below shows an example import config file:
Once all the schema and config files are saved the next step is to export the data from D365.
-
Select Data Export from the ribbon and select format type of JSON or CSV.
-
Select the location to save the data.
-
If you have a saved export config from Export Config File, click Load to open this. Alternatively, adjust these settings now or leave the defaults.
-
Select the Environment if different then verify the location of the schema file.
The Data Export page should look something like this:
- Select Run and the data will be exported to the specified location. You will also see a success message confirming that data export is complete:
The Data is now extracted into a JSON file which you can see an example of below:
In this example 3 Account records have been extracted with the attributes ‘Account Name’, ‘Email Address’ & ‘Account Number’
To import the exported data into an environment, follow the instructions below
-
Select Data Import from the ribbon and select format type of JSON or CSV.
-
Select the location of the source data.
-
If you have a saved import config from Import Config File, click Load to open this. Alternatively, adjust these settings now or leave the defaults.
-
Select the Environment if different then select the location of the schema file (schema is only required for CSV).
The Data Import page should look something like this:
- Select Run and the data will be imported into D365. You will also see a success message confirming that data import is complete:
You will then be able to view your data in D365.
