Relationship_Documentor 1.2.2

.NET Framework 4.5.2 This package targets .NET Framework 4.5.2. The package is compatible with this framework or higher. 
dotnet add package Relationship_Documentor --version 1.2.2
                    


                    

                
NuGet\Install-Package Relationship_Documentor -Version 1.2.2
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="Relationship_Documentor" Version="1.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Relationship_Documentor" Version="1.2.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Relationship_Documentor" />
                    


                            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 Relationship_Documentor --version 1.2.2
                    


                    

                
#r "nuget: Relationship_Documentor, 1.2.2"
#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 Relationship_Documentor@1.2.2
#: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=Relationship_Documentor&version=1.2.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Relationship_Documentor&version=1.2.2
                    


                            Install as a Cake Tool

Relationship Documentor for XrmToolBox

A powerful XrmToolBox plugin for documenting and exporting Microsoft Dynamics 365 / Dataverse entity relationships with solution-aware filtering and Excel export capabilities.

Plugin Screenshot

🌟 Features

Multi-Table Selection

  • Select multiple tables simultaneously for comparison
  • Persistent selection state across filter operations
  • "Selected Tables" panel shows all checked tables
  • Filter tables by display name or logical name

Solution-Aware Filtering

  • Load tables from default solution or specific solution
  • Solution picker dialog for easy selection
  • Relationship filtering based on solution components
  • Remembers last selected solution

Comprehensive Relationship Documentation

  • 1:N Relationships - One-to-Many with full cascade behaviors
  • N:1 Relationships - Many-to-One with referential constraints
  • N:N Relationships - Many-to-Many with intersect entities
  • Complete metadata including Delete, Assign, Share, Unshare, Reparent, and Rollup View configurations

Excel Export with Sanitization

  • Export selected tables or all tables
  • Automatic sheet name sanitization (handles invalid characters)
  • Smart truncation for names exceeding Excel's 31-character limit
  • Display Name (logical_name) format for clarity
  • One tab per table with all relationship types combined
  • Professional formatting with proper column headers

User Experience

  • Nested tab structure for easy navigation
  • Real-time filtering without losing selections
  • About dialog with developer contact information
  • Comprehensive error logging to XrmToolBox logs
  • Settings persistence across sessions

📥 Installation

  1. Open XrmToolBox
  2. Click "Tool Library" or "Plugins Store"
  3. Search for "Relationship Documentor"
  4. Click "Install"

Manual Installation

  1. Download the latest release from Releases
  2. Extract Relationship.Documentor.dll
  3. Copy to %AppData%\MscrmTools\XrmToolBox\Plugins\
  4. Restart XrmToolBox

🚀 Usage

Basic Workflow

  1. Connect to your Dynamics 365 environment
  2. Load Tables - Choose default solution or specific solution
  3. Select Tables - Check the tables you want to document
  4. Show Relationships - Click to load relationship data
  5. Export - Export selected tables or all tables to Excel

Tips

  • Use the filter box to quickly find tables
  • Check multiple tables to compare relationships side-by-side
  • The Selected Tables panel shows what's currently selected
  • Use "Check All" or "Uncheck All Selected" for bulk operations
  • Export creates one Excel sheet per table with all relationships combined

📊 Export Format

Excel Structure

Each table generates one sheet with the following columns:

  • Relationship Type (1:N, N:1, or N:N)
  • Relationship Name (Schema name)
  • Related Table (Target entity)
  • Attribute (Lookup/Referencing attribute)
  • Cascade Behaviors (Delete, Assign, Share, Unshare, Reparent, Merge, Rollup View)
  • Is Customizable
  • Is Managed

Sheet Names

  • Format: Display Name (logical_name)
  • Automatically truncated if > 31 characters
  • Invalid characters replaced with underscore
  • Example: Account (account), Sales Order (salesorder)

🛠️ Technical Details

Requirements

  • XrmToolBox 1.2023.12.68 or later
  • .NET Framework 4.6.2 or later
  • Microsoft Office / Excel (for export viewing)

Dependencies

  • Microsoft.CrmSdk.CoreAssemblies (9.0.2.56)
  • Microsoft.Office.Interop.Excel

Logging

All operations are logged to XrmToolBox log files:

  • Location: %AppData%\MscrmTools\XrmToolBox\Logs\
  • Levels: Info, Warning, Error
  • Full exception stack traces for debugging

🐛 Known Issues

None currently. Please report issues on the Issues page.

📝 Changelog

See CHANGELOG.md for version history.

👨‍💻 Author

Kamaldeep Singh

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Built with XrmToolBox
  • Thanks to the Dynamics 365 community for feedback and support

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

⭐ If you find this tool helpful, please star the repository!

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.2.2 1,584 2/20/2026

v1.2.2
- Package metadata fix
v1.2.1
- Package metadata fix
v1.2.0
- Fixed UI hang when selecting/deselecting 100s of tables
- Show Relationships loads in single background worker
- Progress status bar updates during all operations
- UI improvements: Search label, separator, status bar

v1.0.0
- Initial release
- Load tables from organization or solution
- View 1:N, N:1, N:N relationships
- Export to Excel