XrmDataversePlugin.SolutionDocumentor 1.0.7

dotnet add package XrmDataversePlugin.SolutionDocumentor --version 1.0.7
                    
NuGet\Install-Package XrmDataversePlugin.SolutionDocumentor -Version 1.0.7
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XrmDataversePlugin.SolutionDocumentor" Version="1.0.7" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XrmDataversePlugin.SolutionDocumentor" Version="1.0.7" />
                    
Directory.Packages.props
<PackageReference Include="XrmDataversePlugin.SolutionDocumentor" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XrmDataversePlugin.SolutionDocumentor --version 1.0.7
                    
#r "nuget: XrmDataversePlugin.SolutionDocumentor, 1.0.7"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XrmDataversePlugin.SolutionDocumentor@1.0.7
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XrmDataversePlugin.SolutionDocumentor&version=1.0.7
                    
Install as a Cake Addin
#tool nuget:?package=XrmDataversePlugin.SolutionDocumentor&version=1.0.7
                    
Install as a Cake Tool

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

  1. Open XrmToolBox
  2. Go to Tool Library or Plugins Manager
  3. Search for "Solution Documentor"
  4. Click Install

Manual Installation

  1. Download the latest release from the Releases page
  2. Extract XrmDataversePlugin.dll to:
    %APPDATA%\MscrmTools\XrmToolBox\Plugins\
    
  3. Restart XrmToolBox

Usage

  1. Launch XrmToolBox and connect to your Dataverse environment
  2. Open Solution Documentor from the tools list
  3. Select a solution from the dropdown
  4. 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

  1. Go to the 📄 Docs tab
  2. Select what to include (Tables, Option Sets, Roles, Flows)
  3. Click Generate Documentation
  4. 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.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.7 1,151 5/27/2026
1.0.6 118 5/22/2026
1.0.5 120 5/22/2026
1.0.4 110 5/22/2026
1.0.3 121 5/22/2026
1.0.2 131 5/18/2026

v1.0.7: Fixed marketplace compatibility detection by properly declaring XrmToolBoxPackage dependency.