Interpret your data model holistically: Model Documenter

[hackcrr]

Introduction to model documents

model document is an external tool for power BI that is open source from GitHub. We can quickly generate a series of statistics for our reports.

Use of model document

Open the github link below:

document tools 

 

Using the MSI installation package, install it in your computer. Then reopen Power BI desktop, and we can discover it in external tools:

Open the report that needs to generate a document, then click on it, wait for a while, it will automatically generate a PBIX file and open it. As shown in the figure below:

Described in the documentation

The documentation page consists of:

1.Info

2.PQ Parameters

3.Tables

4.Partitions and policies

5.Columns

6.Calculation groups

7.Field parameters

8.Measures

9.Relationships

10.Security

 info page

The information page shows basic information about the data model, such as the schema and level it can use, as well as when it was created and last updated. You can find out more about the data model by viewing the report here. The name of the model is displayed at the top of the page. If you're running directly from Power BI Desktop, you might see a complex code (GUID). But if you're running from a model in the Power BI service through the Analysis Services connector, you'll see the name of the data model.

PQ Parameters

In the Parameters section, you'll see the current settings for each parameter, whether it's required, and the types of values accepted. If there is a list of optional values, these options will not be displayed directly on the interface.

For referenced queries, all queries created in Power Query but not loaded into the data model are listed here, and their M-language expressions are displayed.

Tables

The table page summarizes the details of all the tables in the data model, such as the storage mode (import, direct query, or dual mode), the number of rows, and the number of partitions. It also explains how the table was created, whether it was refreshed via DAX, M, or incrementally.

When you hover over a table, a tooltip will appear showing the status of the table, when it was last refreshed, and when it was modified. Once you've selected a table, you can click different buttons to view section details, measures, or all columns. This makes it easier for users to manage and understand the details of each form more efficiently.

Columns

The Columns page provides an overview of all the columns in the data model, including information such as the table to which they belong, the number of different values (cardinality) for each column, collation, and formatted strings. If the column was created with DAX, it will also be labeled accordingly.

When you hover over a column, a tooltip will appear showing the data type of the column, the expression (if it is a calculated column), and the description of the column. This design allows users to quickly grasp the basic properties and definitions of columns, which is convenient for data model maintenance and optimization.

Calculation groups

In the model documentation, all calculation groups are presented on a dedicated page, rather than simply being listed in a tabular overview. This page not only lists all calculation groups, but also displays the calculation items, descriptions, and expressions under each calculation group in detail.

When you select a calculated item, its detailed expression is displayed on the right side of the page. This helps users understand the functionality of each compute group and compute item in more intuitively and detailed, making it easier to manage complex calculations in the data model more effectively.

field parameters

When using field parameters, there is now a dedicated page that displays the parameters with a description of the parameters and the number of items they contain. When you select a specific field parameter, its detailed expression is displayed on the right side of the page.

This layout makes the management of field parameters more intuitive, and at the same time, it is convenient for users to quickly consult and understand the role and structure of each parameter, which improves the transparency and maintainability of the data model.

Measures

The Metrics page shows the details of all DAX measures in the data model, including the table to which the measure belongs, the metric name, and the description, if any. This layout helps users quickly locate and understand the function of each measure and its place in the data model, improving the efficiency of data analysis and reporting.

Relationships

The relationship view summarizes all the relationships in the data model. Inactive relationships are displayed in gray font, while other relationships are displayed normally. Relationships that can cause uncertainty or limitations in the data model if the cross-filtering direction is set to Bidirectional or if there is a many-to-many relationship are highlighted in red. The cardinality of all relationships is listed at the top of the page, and a visual overview of all relationships in the model is provided at the bottom. This helps users to clearly understand the relational structure of the data model.

Security

The Security page displays all the security roles that are applied to the data model. You'll see the DAX expression used to filter the table, as well as the tables that are affected by this. In addition, a description of the character is displayed.