Cómo usar la extensión Diccionario de datos de Looker

El Diccionario de datos de Looker es una extensión, una aplicación web compilada con componentes de Looker, desarrollada con el framework de extensiones de Looker y que se implementa a través de Looker Marketplace.

La extensión del Diccionario de datos de Looker proporciona una interfaz centralizada y dedicada para buscar en todos tus campos y descripciones de Looker. Usa esta extensión para realizar las siguientes tareas:

  • Proporcionar un directorio de búsqueda para todas las métricas y descripciones para que los usuarios identifiquen la dimensión o la medición adecuada para el análisis
  • Permitir que las partes interesadas externas identifiquen y ubiquen métricas únicas
  • Auditar modelos de LookML para evaluar si se siguen convenciones de nomenclatura coherentes, si hay campos redundantes o si los campos están anotados con descripciones
  • Agregar y compartir comentarios sobre campos específicos (si tu aplicación del Diccionario de datos de Looker está en la versión 2.0.0 o posterior) Para verificar que tienes la versión más actualizada del Diccionario de datos, ve a Looker Marketplace, selecciona Administrar y, luego, el botón Actualizar junto a la extensión.

Flujo de trabajo del Diccionario de datos

Para que los usuarios accedan al Diccionario de datos de Looker y lo usen, un administrador de Looker debe realizar los siguientes pasos:

  1. Habilita las funciones adecuadas.
  2. Instala la extensión del Diccionario de datos de Looker.
  3. Otorga permisos para acceder al Diccionario de datos de Looker.

Una vez que la extensión esté disponible para los usuarios, podrás hacer lo siguiente:

  1. Navega a la extensión del Diccionario de datos de Looker.
  2. Consulta los metadatos de tu modelo.

Antes de comenzar

Antes de instalar el Diccionario de datos de Looker desde el Marketplace, un administrador de Looker debe habilitar estas funciones:

  • Marketplace: Para acceder a Looker Marketplace (habilitado de forma predeterminada)
  • Framework de extensiones: Para implementar extensiones desarrolladas con el framework de extensiones de Looker (habilitado de forma predeterminada)

Para instalar aplicaciones y herramientas, como extensiones, desde Looker Marketplace, debes tener los permisos develop, manage_models, y deploy .

Instala el Diccionario de datos de Looker

Consulta la documentación Usa Looker Marketplace para obtener instrucciones sobre cómo instalar una herramienta desde Looker Marketplace. Después de instalar el Diccionario de datos, un administrador de Looker debe otorgar a los usuarios permisos para realizar las siguientes tareas:

Otorga permisos para acceder a la extensión del Diccionario de datos de Looker

Después de instalar el Diccionario de datos de Looker, se agrega automáticamente un modelo llamado data-dictionary a la lista de modelos disponibles en las páginas Nuevo conjunto de modelos y Editar conjunto de modelos, a las que se puede acceder desde la página Roles en el panel Administrador.

Un administrador de Looker debe otorgar a los usuarios explore o develop permisos para acceder al modelo data-dictionary y a cualquier modelo que necesiten explorar en el Diccionario de datos. Consulta la página de documentación Establece permisos para extensiones de Looker para obtener información sobre cómo otorgar permisos a los usuarios para acceder a las extensiones y usarlas.

Otorga permisos para interactuar con los comentarios de los campos

Los comentarios de los campos permiten a los usuarios agregar contexto a las definiciones de los campos sin tener que actualizar LookML. De forma predeterminada, todos los usuarios que tengan acceso a la extensión del diccionario de datos podrán ver todos los comentarios, y agregar, editar y borrar sus propios comentarios.

Un administrador de Looker puede administrar la forma en que los usuarios interactúan con la funcionalidad de comentarios de los campos creando grupos de usuarios específicos en la página Grupos del panel Administrador y asignando usuarios a esos grupos. Consulta la página de documentación Grupos para obtener más información sobre cómo asignar usuarios a grupos.

Los grupos de usuarios deben crearse con los nombres predefinidos que se muestran en la columna Nombre del grupo de la siguiente tabla. La tabla también muestra los privilegios predefinidos que tendrán los usuarios asignados a cada grupo.

Nombre del grupo Privilegios
marketplace_data_dictionary_comments_disabled Los usuarios no pueden ver ni interactuar con ningún comentario; todas las capacidades de comentarios están inhabilitadas. Los privilegios de este grupo siempre tienen prioridad sobre los de otros grupos. Cualquier usuario incluido en el grupo disabled no podrá ver ni hacer comentarios, incluso si también pertenece a otro grupo que tenga privilegios más elevados.
marketplace_data_dictionary_comments_reader El usuario puede ver los comentarios existentes, pero no puede agregar ninguno.
marketplace_data_dictionary_comments_writer Los usuarios pueden ver todos los comentarios, agregar comentarios nuevos y editar o borrar los suyos. Este es el privilegio predeterminado.
marketplace_data_dictionary_comments_manager Los usuarios pueden ver todos los comentarios, agregar comentarios nuevos y editar o borrar todos los comentarios.

Si un usuario no pertenece a ninguno de estos grupos, se establecerá de forma predeterminada en writer. Si un usuario está asignado a varios grupos (sin incluir marketplace_data_dictionary_comments_disabled), tendrá prioridad su privilegio más elevado.

Puedes navegar al Diccionario de datos desde la lista de aplicaciones y extensiones instaladas en la barra lateral izquierda.

Consulta los metadatos del modelo con el Diccionario de datos de Looker

En el Diccionario de datos de Looker, los usuarios con permisos explore en un modelo pueden seleccionar este modelo y ver sus metadatos, incluidas sus exploraciones y la lista de campos de cada exploración, agrupados por vista. El Diccionario de datos de Looker muestra las exploraciones del modelo seleccionado en la barra lateral izquierda y las vistas y los campos de la exploración seleccionada en la parte principal de la página.

Los usuarios pueden contraer la barra lateral seleccionando el ícono <.

El Diccionario de datos de Looker muestra la siguiente información:

  1. El nombre del modelo seleccionado
  2. La lista de exploraciones que contiene el modelo seleccionado
  3. La exploración seleccionada
  4. Un campo de texto para filtrar los campos en una exploración
  5. Filtros rápidos para limitar los campos mostrados según las características seleccionadas
  6. El nombre de la vista
  7. Metadatos sobre cada campo. Para seleccionar los metadatos que se muestran, selecciona el botón Opciones de vista. Consulta el conjunto completo de metadatos del campo en el generador de perfiles de campos.
  8. Filas que contienen metadatos para cada campo en una vista determinada
  9. Navegación a la exploración en la IU de Looker

Selecciona un modelo y una exploración

En la lista desplegable Seleccionar un modelo , se muestran todos los modelos para los que un usuario tiene permisos explore. Cuando elijas un modelo en el menú desplegable Seleccionar un modelo, la barra lateral izquierda se completará con una lista de las exploraciones de ese modelo.

También puedes buscar una exploración específica en el modelo seleccionado escribiendo en el cuadro de búsqueda Buscar modelo. La lista de exploraciones se filtrará para mostrar solo los resultados que coincidan con tus términos de búsqueda.

Selecciona el nombre de una exploración para ver sus campos, agrupados por vista, que se muestran en la parte principal de la página.

También puedes seleccionar el botón Explorar en la esquina superior derecha para ir directamente a la página Explorar en Looker.

Filtra campos en una exploración

Para filtrar los campos mostrados, escribe texto en el cuadro Filtrar campos en esta exploración para que coincida con la etiqueta del campo o la descripción de la lista de campos.

También puedes seleccionar atributos de metadatos específicos para filtrar, por ejemplo, si el campo cumple con lo siguiente:

Consulta los metadatos de los campos

El Diccionario de datos de Looker muestra los metadatos de los campos de una exploración, agrupados por vista:

Personaliza los metadatos mostrados

Para especificar qué metadatos se muestran para cada campo, selecciona el botón Opciones de vista en la esquina superior derecha y marca o desmarca las casillas de los metadatos que deseas ver.

Usa los comentarios de los campos

Los desarrolladores de LookML suelen incluir información o explicaciones adicionales sobre los campos de un modelo en el parámetro description a nivel del campo. Sin embargo, estas descripciones no siempre son significativas ni útiles para todos los usuarios. Con los comentarios a nivel del campo, los usuarios pueden agregar contexto a un campo específico. Otros usuarios pueden ver estos comentarios, pero no afectarán el LookML subyacente del modelo.

Un administrador de Looker debe otorgar a los usuarios la capacidad de interactuar con los comentarios agregándolos a grupos específicos en la página Grupos del panel Administrador. De forma predeterminada, todos los usuarios con acceso a la extensión del diccionario de datos pueden ver todos los comentarios, y agregar, editar y borrar sus propios comentarios.

Agrega un comentario de campo

Para agregar un comentario a un campo, sigue estos pasos:

  1. Coloca el cursor sobre la fila del campo para revelar un ícono + (si no hay comentarios de campo existentes) o un ícono de bloc de notas (si un campo tiene comentarios existentes). Haz clic en el ícono para abrir la pestaña Comentarios del panel del generador de perfiles de campos.
  2. Haz clic en el botón Agregar comentario.
  3. Escribe tu comentario y selecciona el botón Comentar para guardar tu entrada. Haz clic en Cancelar para cerrar el generador de perfiles de campos. Para expandir el cuadro de comentarios, selecciona y arrastra la esquina inferior derecha.

Una vez que se agrega un comentario, aparece en la pestaña Comentarios del generador de perfiles de campos y otros usuarios pueden verlo.

Consulta los comentarios de los campos

Cuando un campo incluye comentarios, aparece un ícono de bloc de notas con la cantidad de comentarios que existen en ese campo. Haz clic en el ícono de bloc de notas para ver los comentarios del campo que aparecen en la pestaña Comentarios del generador de perfiles de campos.

La cantidad de comentarios en ese campo también se indica entre paréntesis en la pestaña Comentarios. Cada entrada de comentario muestra la siguiente información:

  • El nombre del comentarista
  • La marca de tiempo que muestra cuándo se agregó el comentario
  • Una vista previa del comentario

Edita o borra un comentario de campo

Para editar o borrar tus propios comentarios de campo, sigue estos pasos:

  1. Selecciona el ícono de bloc de notas del campo.
  2. En la pestaña Comentarios, busca el comentario que deseas editar o borrar y coloca el cursor sobre él.
  3. Haz clic en el menú de tres puntos y selecciona Editar comentario para editar el comentario o Borrar comentario para borrarlo. Si borras el comentario, confirma tu intención.
  4. Si editas tu comentario, selecciona Guardar una vez que hayas realizado los cambios.

Comparte un comentario de campo

La URL de la pestaña Comentarios de cada campo es única y se puede copiar y compartir con otros usuarios que tengan acceso a ese modelo en el Diccionario de datos de Looker.

Usa el generador de perfiles de campos

Haz clic en una fila de campo específica para abrir un panel del generador de perfiles de campos que muestre el conjunto completo de metadatos del campo, las opciones para obtener una vista previa de los valores de dimensión numéricos y los botones para navegar al IDE de Looker o a la página Explorar.

Si usas la versión 2.0.0 o posterior de la extensión del Diccionario de datos de Looker, el generador de perfiles de campos se abre de forma predeterminada en la pestaña Detalles.

En la sección Distribución, selecciona Calcular para mostrar una vista previa de un gráfico de columnas que representa la distribución de los valores de recuento para las dimensiones numéricas en una vista con una medición que tiene type: count. En la sección Distribución, también se mostrarán los valores mínimos, máximos y promedio de la serie de dimensiones numéricas.

En Valores, selecciona Calcular para mostrar una vista previa de los valores de recuento para las dimensiones numéricas en una vista con una medición que tiene type: count. Selecciona el botón Explorar más para abrir la IU de Explorar con la dimensión numérica y la medición de recuento preseleccionadas en el selector de campos.

Selecciona Ir a LookML para abrir el archivo de vista del proyecto de LookML asociado con el modelo seleccionado en el IDE de Looker.

Selecciona el botón Explorar con el campo para abrir la página Explorar con ese campo seleccionado automáticamente en el selector de campos.