Power BI DocuTIPS II

Sara Alonso B
5 min readFeb 14, 2024

--

Tip 2: Generar autodocumentación del modelo semántico de Power BI con Model Documenter

¡Hola! Ya estoy por aquí de nuevo para seguir con nuestra serie “Power BI DocuTIPS”.

En el anterior post os anunciaba el inicio de esta nueva serie de “tips” para documentar proyectos de Power BI de una forma productiva, eficiente y rápida. Y comenzamos la serie viendo cómo generar descripciones de objetos de un modelo semántico utilizando Azure Open AI. Si te lo has perdido, te recomiendo que le eches un ojo aquí 😊.

Pues bien, hoy vamos a comenzar en el punto donde acabamos en el post anterior, con el objetivo de generar toda la documentación de un modelo semántico de Power BI de forma automática, utilizando la herramienta externa de “Model Documenter”.

También en el anterior post os sugería descargar dicha herramienta. Si aun no la tenéis descargada, os dejo aquí el enlace, pues es necesaria para llevar acabo esta manera de documentar. Por cierto, ¡es gratis! ¡Gracias Data-Marc!

En el post anterior, acabábamos visualizando las descripciones de cada medida, tabla y columna que Azure Open AI generaba por nosotros, tanto en Tabular Editor como en la vista de modelo de Power BI:

NOTA: El requisito esencial de Model Documenter para documentar tu modelo es que tengas cubiertos todos los campos de descripciones. No importa si lo has rellenado tú a mano o hayas utilizado técnicas como la del script de C# para llamar a la API de Azure Open AI.

Pues bien, ahora que ya tenemos todas las descripciones de todos los objetos solo necesitamos generar la documentación de todo el modelo. ¿Cómo?

Vamos a pulsar sobre el icono de la herramienta “Model Documenter”.

Automáticamente se genera, a partir de un archivo .vpax, un nuevo informe de Power BI con todos los metadatos del modelo semático más las descripciones.

¿Qué es un archivo .vpax?

Un archivo .vpax es un archivo de modelo de análisis en Power BI que contiene la definición completa del modelo de datos utilizado para el análisis y visualización de datos en Power BI. Incluye tablas, relaciones, medidas y otras estructuras que facilitan la exploración y análisis de datos.

Este archivo es esencialmente un archivo de copia de seguridad del modelo de datos de Power BI y se puede utilizar para distribuir y compartir el modelo con otros usuarios o para restaurar el modelo en caso de pérdida de datos o necesidad de migración a otro entorno.

Al pulsar sobre el icono se ejecuta el archivo .vpax:

Y automáticamente se abre un nuevo informe con una plantilla predeterminada por Data-Marc con toda la información de los metadatos de nuestro proyecto más sus descripciones.

Informe generado por Model Documenter

Observamos que en el panel de Datos a la derecha, tenemos todos los objetos de nuestro proyecto. Abro, pro ejemplo, la tabla de “_Measures”:

Como veis, tenemos disponibles el recuento de medidas del modelo, las que están ocultas, las que no tienen descripción… Campos con el tipo de dato de la medida, la descripción que le hemos asignado a cada una…

También podemos ver todo con detalle en la vista de modelo:

Y en la parte de abajo, una página para cada objeto de nuestra metadata: parámetros, tablas, particiones, columnas, grupos de cálculo, parámetros de campo, medidas, relaciones y seguridad.

En cada página encontraremos información detallada con las descripciones que les hayamos asignado. Ejemplo: Medidas:

Observamos que cada medida viene con su descripción, y además si pulsamos sobre cada una de ellas, visualizaremos a la derecha la expresión DAX que le corresponde.

Por supuesto es un informe totalmente editable, puedes cambiar el diseño y sobre todo, puedes confeccionarlo de la manera que desees o que desee tu cliente. Ejemplo:

Informe de documentación editado

Aquí he reducido el número de páginas, he dejado solo las que procedían y he unido, por ejemplo, tablas y columnas para hacerlo más sencillo.

Genial. Y ahora algun@ se estará preguntando: ¿Y qué pasa si mi modelo cambia? No es tan extraño que una vez generada la documentación, en algún momento haya que hacer algún cambio. O que, aunque el informe esté en producción, llegue la persona encargada de su mantenimiento pasado un tiempo y aplique los cambios que el cliente le pida.

Pero claro, si la documentación ya está generada, y después hago cambios en el modelo, esos cambios no se aplican a la documentación… ¿Cómo hago entonces? ¿Generar otro informe de Model Documenter desde 0? Claro que no… ¡Lo veremos en el siguiente capítulo!

¿Qué os parece? Os leo en comentarios. ¡Muchas gracias!

--

--