XrmDataversePlugin.SolutionDocumentor
1.0.7
dotnet add package XrmDataversePlugin.SolutionDocumentor --version 1.0.7
NuGet\Install-Package XrmDataversePlugin.SolutionDocumentor -Version 1.0.7
<PackageReference Include="XrmDataversePlugin.SolutionDocumentor" Version="1.0.7" />
<PackageVersion Include="XrmDataversePlugin.SolutionDocumentor" Version="1.0.7" />
<PackageReference Include="XrmDataversePlugin.SolutionDocumentor" />
paket add XrmDataversePlugin.SolutionDocumentor --version 1.0.7
#r "nuget: XrmDataversePlugin.SolutionDocumentor, 1.0.7"
#:package XrmDataversePlugin.SolutionDocumentor@1.0.7
#addin nuget:?package=XrmDataversePlugin.SolutionDocumentor&version=1.0.7
#tool nuget:?package=XrmDataversePlugin.SolutionDocumentor&version=1.0.7
Solution Documentor
A powerful XrmToolBox plugin for visualizing and documenting Microsoft Dataverse solutions.
Features
- 📊 Entity Relationship Diagrams (ERD): Generate interactive ERDs from your Dataverse solutions
- 📝 Solution Documentation: Generate comprehensive markdown documentation including:
- Tables & Columns
- Option Sets
- Security Roles
- Power Automate Flows
- 🔍 Option Sets Browser: Browse and explore option sets in your solution
- 🔐 Security Roles Viewer: Visualize security role permissions
- 🌊 Flow Explorer: Document and view Power Automate flows
Installation
From XrmToolBox Plugin Store
- Open XrmToolBox
- Go to Tool Library or Plugins Manager
- Search for "Solution Documentor"
- Click Install
Manual Installation
- Download the latest release from the Releases page
- Extract
XrmDataversePlugin.dllto:%APPDATA%\MscrmTools\XrmToolBox\Plugins\ - Restart XrmToolBox
Usage
- Launch XrmToolBox and connect to your Dataverse environment
- Open Solution Documentor from the tools list
- Select a solution from the dropdown
- Choose what you want to generate:
- ERD Tab: Select entities and generate visual diagrams
- Option Sets Tab: Browse option sets
- Security Roles Tab: View role permissions
- Flows Tab: Explore Power Automate flows
- 📄 Docs Tab: Generate full solution documentation
Generating Documentation
- Go to the 📄 Docs tab
- Select what to include (Tables, Option Sets, Roles, Flows)
- Click Generate Documentation
- Click 💾 Save .md to save the markdown file
Requirements
- XrmToolBox (latest version recommended)
- Microsoft Dataverse / Dynamics 365 CE environment
- .NET Framework 4.8+
Built With
- .NET Framework 4.8
- Microsoft WebView2
- XrmToolBox SDK
- Microsoft.Xrm.Sdk
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
Nate Halliwell
Powered by your friends at Pragmatic Works
Acknowledgments
- Built for the XrmToolBox community
- Inspired by the need for better Dataverse solution documentation
Support
If you encounter any issues or have suggestions, please open an issue.
Made with ❤️ for the Dynamics 365 community
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET Framework | net452 is compatible. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.8
- XrmToolBoxPackage (>= 1.2025.10.74)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
v1.0.7: Fixed marketplace compatibility detection by properly declaring XrmToolBoxPackage dependency.