Skip to content

Commit 62da189

Browse files
committed
add docs
1 parent d2c654b commit 62da189

File tree

4 files changed

+67
-3
lines changed

4 files changed

+67
-3
lines changed

Guide-XrmToolBox.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Dataverse Configuration Migration Tool For XrmToolBox
2+
3+
This tool is a plugin for [XrmToolBox](https://www.xrmtoolbox.com/) which allows you to create a schema definition file for data export and data import between dataverse environments.
4+
5+
This tool generates the schema definition file in the same format as the official tool from Microsoft: [Configuration Migration Tool](https://learn.microsoft.com/en-us/power-platform/alm/configure-and-deploy-tools)
6+
7+
This tool was created to support more data types that the official tool does.
8+
## ⭐Key Features⭐
9+
✔️ Schema definition file for export/import
10+
11+
### Upcoming features 🔜
12+
🔜 Configuration Data Importation \
13+
🔜 Configuration Data Exportation
14+
15+
>**Note**: Those features are available through the cli tool. More Info [here](https://github.com/dotnetprog/dataverse-configuration-migration-too)
16+
17+
## What's a schema definition file exactly 🤔❓
18+
19+
A Schema definition file is an xml file that contains the definition of entities which contains the fields and the many to many relationships that you'd like to export/import between environments.
20+
21+
## How to use the tool ?
22+
23+
### Prerequisites
24+
- [.Net Framework 4.8 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48)
25+
- [XrmToolBox](https://www.xrmtoolbox.com/)
26+
- version must be atleast 1.2025.7.71
27+
28+
### Getting Started
29+
30+
> Make sure you have installed this package from the tool library in XrmToolBox: `Dataverse.ConfigurationMigrationTool.XrmToolBox`
31+
32+
1. Open XrmToolBox
33+
2. Install `Dataverse.ConfigurationMigrationTool.XrmToolBox` from Tool Library if needed
34+
3. Open Tool : `Dataverse.ConfigurationMigrationTool.XrmToolBox`
35+
4. Connect to an environment
36+
37+
### Create your schema file
38+
39+
![tutorial](./images/ToolTutorial.png "tutorial")
40+
41+
1. Load your solutions
42+
2. Select a solution
43+
3. Select an entity
44+
4. Select the fields and or relationships you want in your schema
45+
5. Click on the right arrow
46+
6. Click on the `Generate Schema File` and choose the location you want to save the file.
47+
48+
> **Note:** You can add more fields and relations from other entities before generating your schema file.
49+
50+
## Disclaimer
51+
52+
Although this tool has the same name as the official configuration migration tool provided by Microsoft, it is not an official tool.
53+
54+
It's a community homemade tool to offer an alternative with more features.
55+
56+
57+

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ This new tool enables you to:
2626
:heavy_check_mark: Many to Many Relationships supported \
2727
:heavy_check_mark: Owner,Team And Business Unit field is now supported. If by Unique Id is not found in target env, it matches by name otherwise it ignores the field. Caching is used to avoid unnecessary calls to dataverse. \
2828
:heavy_check_mark: Supports schemas and data files generated from :
29+
- [Configuration Migration Tool for XrmToolBox](./Guide-XrmToolBox.md)
2930
- [PowerPlatform CLI Export](https://learn.microsoft.com/en-us/power-platform/developer/cli/reference/data#pac-data-export)
3031
- [Configuration Migration tool](https://learn.microsoft.com/en-us/power-platform/admin/create-schema-export-configuration-data)
3132

@@ -111,6 +112,9 @@ You can use these workflows as a starting point for your own CI/CD automation. S
111112

112113
### </> Generating Schema and Data Files </>
113114

115+
🆕 **You can now create your schema definition file from XrmToolBox using** [Configuration Migration Tool for XrmToolBox](./Guide-XrmToolBox.md)🆕
116+
117+
114118
To use the `import` or `export-data` command, you need a schema file and/or a data file. These can be generated from your Dataverse environment using the official Configuration Migration tool. For detailed instructions, refer to the Microsoft documentation:
115119

116120
- [Create a schema and export configuration data](https://learn.microsoft.com/en-us/power-platform/admin/create-schema-export-configuration-data)

images/ToolTutorial.png

65.9 KB
Loading

src/Dataverse.ConfigurationMigrationTool/Dataverse.ConfigurationMigrationTool.XTB.nuspec

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
<version>1.0.0</version>
55
<title>Configuration Migration Tool for XrmToolBox</title>
66
<authors>François Desjardins-Nadeau</authors>
7-
<owners>dotnetprog</owners>
87
<projectUrl>https://github.com/dotnetprog/dataverse-configuration-migration-tool</projectUrl>
9-
<iconUrl>https://github.com/dotnetprog/dataverse-configuration-migration-tool/blob/main/images/configurationmigrationtool_64.png?raw=true</iconUrl>
8+
<icon>docs\images\configurationmigrationtool_64.png</icon>
109
<requireLicenseAcceptance>false</requireLicenseAcceptance>
1110
<summary>Utility tool for migrating configuration data.</summary>
1211
<description>
@@ -17,12 +16,16 @@
1716
https://github.com/dotnetprog/dataverse-configuration-migration-tool/releases/latest
1817
</releaseNotes>
1918
<copyright>Copyright François Desjardins-Nadeau 2025</copyright>
20-
<tags>XrmToolBox Plugins Dataverse ConfigurationMigrationTool data export import</tags>
19+
<tags>XrmToolBox Dataverse ConfigurationMigrationTool data export import</tags>
2120
<dependencies>
2221
<dependency id="XrmToolBox" version="1.2025.7.71" />
2322
</dependencies>
23+
<readme>docs\Guide-XrmToolBox.md</readme>
2424
</metadata>
2525
<files>
26+
<file src="..\..\images\configurationmigrationtool_64.png" target="docs\images\" />
27+
<file src="..\..\images\ToolTutorial.png" target="docs\images\" />
28+
<file src="..\..\Guide-XrmToolBox.md" target="docs\" />
2629
<file src="Dataverse.ConfigurationMigrationTool.XrmToolBox\bin\Release\Dataverse.ConfigurationMigrationTool.XrmToolBox.dll" target="lib\net48\Plugins" />
2730
</files>
2831
</package>

0 commit comments

Comments
 (0)