Metadata Documentation using XrmToolBox

Metadata Document Generator: XrmToolBox

Introduction

When working on a Dynamics 365 project, you often need to understand all the entities, fields, and relationships before making changes. Doing this manually can be time-consuming and error prone. The XrmToolBox Metadata Document Generator helps by quickly creating a complete document of your system’s metadata. It saves time, reduces errors, and the generated documents are useful for audits, compliance, and data migration.

Step 1: Install XrmToolBoxn

XrmToolBox is a popular tool used in Dynamics 365 for various purposes like- customizations, data management, and administration tasks. Basically, it provides a collection of tools and plugins that can make our Dynamics 365 work easier and more efficient.

1. Download XrmToolBox from XrmToolBox website and install it in your system.

2. We need to unlock the zip file first and then extract it. To unlock and extract the zip file, right-click on the file, select "Properties," check the "Unblock" checkbox, and click "OK"

3. Ensure you have access to your Dynamics 365 environment.

Follow this blog to know all steps with snapshots XrmToolBox from Scratch

---

Step 2: Install Metadata Document Generator

1.  In the "Tools Library" section, search Metadata Document Generator and click on install button.

2. Go to tool section now and open Metadata Document Generator from the list..

---

Step 3: Connect to Dynamics 365 Environment

1. To establish a new connection, select the "New Connection" option from the Connection Manager pop-up.

2. Choose your Dynamics 365 environment and sign in.

3. Once connected, the tool is ready to load entities.

---

Step 4: Load Entities

After opening the Metadata Document Generator, the first step is to load the metadata from the connected environment. Click on the "Load Entities" button, which retrieves all tables from the connected environment. 

If you want to select entity from a particular solution, then you can click on dropdown option next to Load Entities, which will allow you to select specific tables from one or more solutions

---

Step 5: Configure Document Options

Document Format

The Metadata Document Generator offers two primary output formats: an Excel Workbook and a Word Document

Language

The tool supports generating metadata in various languages, provided those languages are installed within the Dynamics 365 environment. A user can simply select the desired language from a dropdown menu to ensure the output aligns with the target audience.

Generate For Options

The "Generate for" options provide more control over which attributes are included in the final document.

• All attributes: This is the default setting and provides the most comprehensive report, including every field for the selected entities.

• All attributes contained in forms: This filter is valuable for documenting fields that are currently visible and in use on user-facing forms, which is helpful for analyzing the user experience or for on-boarding new team members.  

• All attributes NOT contained in forms: This is a powerful tool for technical debt analysis and system cleanup. By generating a list of unused fields, you can quickly identify redundant or obsolete attributes that can be deprecated.

• Option Sets, Boolean, State and Status attributes: This option allows for a focused report on a system's choice fields, which are fundamental to data consistency and are essential for data governance.   

• Selected attributes: This provides the most precise control, allowing a user to manually select specific attributes for documentation

The "Other Information" Checkboxes

The "Other Information" section provides a series of checkboxes that add critical context to the metadata documentation

• Audit Information - Adds a column indicating if a field is being audited

• Field Level Security Information - Adds a column on Field Level Security settings

• Requirement Level Information - Documents whether a field is required, recommended, or optional

• Valid for Advanced Find Information - Indicates which fields are searchable via Advanced Find

• Attribute Location in Forms - Lists the form, tab, and section where an attribute is located

• Virtual Attributes - Excludes system-generated, read-only attributes from the report

---

Step 6: Generate Document

1. After configuring options, click Generate Document.

2. Save the file in your preferred location.

---

Conclusion

In short, the XrmToolBox Metadata Document Generator makes documenting MS Dynamics 365 simple and reliable. It saves time, reduces errors, and the generated documents are useful for audits, compliance, and data migration. A must-have tool for anyone managing a Dynamics 365 environment.