Utiliser l'extension Dictionnaire de données Looker

Le dictionnaire de données Looker est une extension (une application Web créée à l'aide de composants Looker) développée à l'aide du framework d'extension Looker et déployée via le Marketplace Looker.

L'extension Looker Data Dictionary fournit une interface dédiée et centralisée pour rechercher tous vos champs et descriptions Looker. Utilisez cette extension pour effectuer les tâches suivantes :

  • Fournir un répertoire consultable pour toutes les métriques et descriptions afin que les utilisateurs puissent identifier la dimension ou la mesure appropriée pour l'analyse.
  • Permettre aux parties prenantes externes d'identifier et de trouver plus facilement les métriques uniques
  • Auditez les modèles LookML pour évaluer si des conventions de dénomination cohérentes sont suivies, s'il existe des champs redondants ou si les champs sont annotés avec des descriptions.
  • Ajoutez et partagez des commentaires sur des champs spécifiques (si votre application Looker Data Dictionary est en version 2.0.0 ou ultérieure). Pour vérifier que vous disposez de la version la plus récente du dictionnaire de données, accédez à la place de marché Looker, sélectionnez Gérer, puis cliquez sur le bouton Mettre à jour à côté de l'extension.

Workflow du dictionnaire de données

Pour que les utilisateurs puissent accéder au dictionnaire de données Looker et l'utiliser, un administrateur Looker doit procéder comme suit :

  1. Activez les fonctionnalités appropriées.
  2. Installez l'extension Looker Data Dictionary.
  3. Accorder des autorisations pour accéder au dictionnaire de données Looker

Une fois l'extension disponible pour les utilisateurs, vous pouvez effectuer les actions suivantes :

  1. Accédez à l'extension Looker Data Dictionary.
  2. Affichez les métadonnées de votre modèle.

Avant de commencer

Avant d'installer le dictionnaire de données Looker depuis le Marketplace, un administrateur Looker doit activer les fonctionnalités suivantes :

  • Marketplace : pour accéder au Marketplace Looker (activé par défaut)
  • Framework d'extension : pour déployer des extensions développées à l'aide du framework d'extension Looker (activé par défaut)

Pour installer des applications et des outils (comme des extensions) depuis Looker Marketplace, vous devez disposer des autorisations develop, manage_models et deploy.

Installer le dictionnaire de données Looker

Consultez la documentation Utiliser Looker Marketplace pour obtenir des instructions sur l'installation d'un outil depuis Looker Marketplace. Une fois le dictionnaire de données installé, un administrateur Looker doit accorder aux utilisateurs les autorisations nécessaires pour effectuer les tâches suivantes :

Accorder des autorisations pour accéder à l'extension Dictionnaire de données Looker

Une fois le dictionnaire de données Looker installé, un modèle appelé data-dictionary est automatiquement ajouté à la liste des modèles disponibles sur les pages Nouvel ensemble de modèles et Modifier l'ensemble de modèles, accessibles depuis la page Rôles du panneau Admin.

Un administrateur Looker doit accorder aux utilisateurs les autorisations explore ou develop pour accéder au modèle data-dictionary et à tous les modèles qu'ils doivent explorer dans le dictionnaire de données. Pour savoir comment accorder aux utilisateurs l'autorisation d'accéder aux extensions et de les utiliser, consultez la page de documentation Définir les autorisations pour les extensions Looker.

Accorder des autorisations pour interagir avec les commentaires de champ

Les commentaires de champ permettent aux utilisateurs d'ajouter du contexte aux définitions de champ sans avoir à mettre à jour le code LookML. Par défaut, tous les utilisateurs ayant accès à l'extension Dictionnaire de données peuvent voir tous les commentaires, et ajouter, modifier et supprimer leurs propres commentaires.

Un administrateur Looker peut gérer la façon dont les utilisateurs interagissent avec la fonctionnalité de commentaires sur les champs en créant des groupes d'utilisateurs spécifiques sur la page Groupes du panneau Admin et en y ajoutant des utilisateurs. Consultez la page de documentation Groupes pour savoir comment attribuer des utilisateurs à des groupes.

Les groupes d'utilisateurs doivent être créés avec les noms prédéfinis indiqués dans la colonne "Nom du groupe" du tableau suivant. Le tableau indique également les droits prédéfinis dont disposeront les utilisateurs attribués à chaque groupe.

Nom du groupe Droits
marketplace_data_dictionary_comments_disabled Les utilisateurs ne peuvent pas voir les commentaires ni interagir avec eux. Toutes les fonctionnalités de commentaires sont désactivées. Les droits de ce groupe prévalent toujours sur ceux des autres groupes. Tout utilisateur inclus dans le groupe disabled ne pourra pas voir les commentaires ni en ajouter, même s'il appartient également à un autre groupe disposant de droits plus élevés.
marketplace_data_dictionary_comments_reader L'utilisateur peut voir les commentaires existants, mais ne peut pas en ajouter.
marketplace_data_dictionary_comments_writer Les utilisateurs peuvent voir tous les commentaires, en ajouter et modifier ou supprimer les leurs. Il s'agit du niveau d'accès par défaut.
marketplace_data_dictionary_comments_manager Les utilisateurs peuvent voir tous les commentaires, en ajouter, et les modifier ou les supprimer.

Si un utilisateur n'appartient à aucun de ces groupes, il sera défini par défaut sur writer. Si un utilisateur est attribué à plusieurs groupes (à l'exception de marketplace_data_dictionary_comments_disabled), son niveau d'accès le plus élevé prévaut.

Vous pouvez accéder au dictionnaire de données à partir de la liste des applications et extensions installées dans la barre latérale de gauche.

Afficher les métadonnées du modèle avec le dictionnaire de données Looker

Dans le dictionnaire de données Looker, les utilisateurs disposant des autorisations explore sur un modèle peuvent sélectionner ce modèle et afficher ses métadonnées, y compris ses explorations et la liste des champs de chaque exploration, regroupés par vue. Le dictionnaire de données Looker affiche les explorations du modèle sélectionné dans la barre latérale de gauche, ainsi que les vues et les champs de l'exploration sélectionnée dans la partie principale de la page.

Les utilisateurs peuvent réduire la barre latérale en sélectionnant l'icône <.

Le dictionnaire de données Looker affiche les informations suivantes :

  1. Nom du modèle sélectionné
  2. Liste des explorations contenues dans le modèle sélectionné
  3. L'exploration sélectionnée
  4. Champ de texte permettant de filtrer les champs d'une exploration
  5. Filtres rapides permettant de limiter les champs affichés en fonction des caractéristiques sélectionnées
  6. Nom de la vue
  7. Métadonnées de chaque champ. Sélectionnez les métadonnées à afficher en cliquant sur le bouton Options d'affichage. Consultez l'ensemble des métadonnées du champ dans le profiler de champ.
  8. Lignes contenant les métadonnées de chaque champ d'une vue donnée
  9. Accéder à l'exploration dans l'interface utilisateur Looker

Sélectionner un modèle et une exploration

La liste déroulante Sélectionner un modèle affiche tous les modèles pour lesquels un utilisateur dispose des autorisations explore. Lorsque vous choisissez un modèle dans le menu déroulant Sélectionner un modèle, la barre latérale de gauche affiche la liste des explorations de ce modèle.

Vous pouvez également rechercher une exploration spécifique dans le modèle sélectionné en saisissant son nom dans le champ de recherche Rechercher dans le modèle. La liste des Explorations est filtrée pour n'afficher que les résultats correspondant à vos termes de recherche.

Sélectionnez le nom d'une exploration pour afficher ses champs, regroupés par vue, dans la partie principale de la page.

Vous pouvez également sélectionner le bouton Explorer en haut à droite pour accéder directement à la page Explorer dans Looker.

Filtrer des champs dans une exploration

Vous pouvez filtrer les champs affichés en saisissant du texte dans la zone Filtrer les champs dans cet Explore pour le faire correspondre au libellé du champ ou à la description de la liste des champs.

Vous pouvez également sélectionner des attributs de métadonnées spécifiques sur lesquels filtrer, par exemple si le champ :

Afficher les métadonnées des champs

Le dictionnaire de données Looker affiche les métadonnées des champs d'une exploration, regroupées par vue :

Personnaliser les métadonnées affichées

Vous pouvez spécifier les métadonnées à afficher pour chaque champ en sélectionnant le bouton Afficher les options en haut à droite, puis en cochant ou décochant les cases correspondant aux métadonnées que vous souhaitez afficher.

Utiliser les commentaires de champ

Les développeurs LookML incluent souvent des informations ou des explications supplémentaires sur les champs d'un modèle dans le paramètre description au niveau du champ. Toutefois, ces descriptions ne sont pas toujours pertinentes ni utiles pour tous les utilisateurs. Les commentaires au niveau des champs permettent aux utilisateurs d'ajouter du contexte à un champ spécifique. Les autres utilisateurs peuvent voir ces commentaires, mais ils n'affectent pas le LookML sous-jacent du modèle.

Un administrateur Looker doit autoriser les utilisateurs à interagir avec les commentaires en les ajoutant à des groupes spécifiques sur la page Groupes du panneau Admin. Par défaut, tous les utilisateurs ayant accès à l'extension Data Dictionary peuvent afficher tous les commentaires, et ajouter, modifier et supprimer leurs propres commentaires.

Ajouter un commentaire à un champ

Pour ajouter un commentaire à un champ :

  1. Pointez sur la ligne du champ pour afficher une icône + (s'il n'y a pas de commentaires existants) ou une icône de bloc-notes (si le champ contient des commentaires). Cliquez sur l'icône pour ouvrir l'onglet Commentaires du panneau du profileur de champ.
  2. Cliquez sur le bouton Ajouter un commentaire.
  3. Saisissez votre commentaire, puis sélectionnez le bouton Commenter pour l'enregistrer. Cliquez sur Annuler pour fermer le profileur de champ. Vous pouvez développer la zone de commentaire en sélectionnant et en faisant glisser le coin inférieur droit.

Une fois un commentaire ajouté, il apparaît dans l'onglet Commentaires du profileur de champ et est visible par les autres utilisateurs.

Afficher les commentaires sur les champs

Lorsqu'un champ inclut des commentaires, une icône de bloc-notes s'affiche avec le nombre de commentaires associés à ce champ. Cliquez sur l'icône en forme de bloc-notes pour afficher les commentaires du champ dans l'onglet Commentaires du profileur de champ.

Le nombre de commentaires sur ce champ est également indiqué entre parenthèses dans l'onglet Commentaires. Chaque entrée de commentaire affiche les informations suivantes :

  • Nom du commentateur
  • Code temporel indiquant la date d'ajout du commentaire
  • Aperçu du commentaire

Modifier ou supprimer un commentaire de champ

Pour modifier ou supprimer vos propres commentaires sur des champs :

  1. Sélectionnez l'icône en forme de bloc-notes du champ.
  2. Dans l'onglet Commentaires, recherchez le commentaire que vous souhaitez modifier ou supprimer, puis pointez dessus.
  3. Cliquez sur le menu à trois points, puis sélectionnez Modifier le commentaire ou Supprimer le commentaire. Si vous supprimez le commentaire, confirmez votre intention.
  4. Si vous modifiez votre commentaire, sélectionnez Enregistrer une fois les modifications effectuées.

Partager un commentaire de champ

L'URL de l'onglet Commentaires de chaque champ est unique. Vous pouvez la copier et la partager avec d'autres utilisateurs ayant accès à ce modèle dans le dictionnaire de données Looker.

Utiliser le profileur de champ

Cliquez sur la ligne d'un champ spécifique pour ouvrir un panneau de profilage de champ qui affiche l'ensemble des métadonnées du champ, des options pour prévisualiser les valeurs de dimension numériques et des boutons pour accéder à l'IDE Looker ou à la page Explorer.

Si vous utilisez la version 2.0.0 ou ultérieure de l'extension Dictionnaire de données Looker, le profileur de champ s'ouvre par défaut sur l'onglet Détails.

Dans la section Distribution, sélectionnez Calculer pour afficher un aperçu d'un graphique à barres représentant la distribution des valeurs de nombre pour les dimensions numériques dans une vue avec une mesure qui a type: count. La section Distribution affichera également les valeurs minimale, maximale et moyenne de la série de dimensions numériques.

Sous Valeurs, sélectionnez Calculer pour afficher un aperçu des valeurs de nombre pour les dimensions numériques dans une vue avec une mesure qui comporte type: count. Sélectionnez le bouton Explorer plus pour ouvrir l'UI Explorer avec la dimension numérique et la mesure du nombre présélectionnées dans le sélecteur de champ.

Sélectionnez Accéder à LookML pour ouvrir le fichier de vue du projet LookML associé au modèle sélectionné dans l'IDE Looker.

Sélectionnez le bouton Explorer avec le champ pour ouvrir la page Explorer avec ce champ automatiquement sélectionné dans le sélecteur de champ.