Utiliser le dictionnaire de données Looker

Le dictionnaire de données Looker est différent du bloc de dictionnaire de données.

Pour profiter de toutes les fonctionnalités de l'extension Looker Data Dictionary, les administrateurs doivent mettre à jour l'application Looker Data Dictionary vers la version 2.0.0 ou une version ultérieure.

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

L'extension Looker Data Dictionary fournit une interface dédiée et centralisée pour effectuer une recherche dans tous vos champs et descriptions Looker. Utilisez cette extension pour:

  • fournir un annuaire consultable de toutes les métriques et descriptions afin que les utilisateurs puissent identifier la dimension ou la mesure appropriée pour l'analyse ;
  • Permettre aux partenaires externes d'identifier et de localiser facilement des mesures uniques
  • Auditez les modèles LookML afin d'évaluer si des conventions d'attribution de noms cohérentes sont respectées, s'il existe des champs redondants ou si des champs sont annotés avec des descriptions.
  • Ajouter et partager des commentaires sur des champs spécifiques (si votre application Looker Data Dictionary est sur la version 2.0.0 ou une version ultérieure)

Pour que les utilisateurs puissent accéder au dictionnaire de données Looker et l'utiliser, les administrateurs Looker doivent:

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

Une fois que l'extension est disponible pour les utilisateurs, vous pouvez:

  1. Accédez au dictionnaire de données Looker.
  2. Affichez les métadonnées de votre modèle.

Installer le dictionnaire de données Looker

Avant d'installer le dictionnaire de données Looker à partir de Marketplace, les administrateurs Looker doivent activer les fonctionnalités suivantes:

  • Marketplace: pour accéder à Marketplace Looker (activé par défaut)
  • Extension Framework: permet de 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 (tels que des extensions) à partir de Marketplace, vous devez disposer des autorisations develop, manage_models et deploy.

Consultez la documentation Utiliser Marketplace Looker pour savoir comment installer un outil à partir de Marketplace Looker. Pour vous assurer de toujours disposer de la version la plus récente du dictionnaire de données, accédez à Marketplace Looker, sélectionnez Manage (Gérer), puis le bouton Update (Mettre à jour) à côté de l'extension.

Accorder des autorisations d'accès au 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 Administration.

Les administrateurs Looker doivent accorder aux utilisateurs les autorisations explore ou develop pour accéder au modèle data-dictionary et aux modèles qu'ils doivent explorer dans le dictionnaire de données. Consultez la page de documentation Définir des autorisations pour les extensions Looker pour savoir comment accorder aux utilisateurs des autorisations d'accès aux extensions et de les utiliser.

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 du dictionnaire de données peuvent voir tous les commentaires, et ajouter, modifier et supprimer leurs propres commentaires.

S'ils le souhaitent, les administrateurs Looker peuvent gérer la façon dont les utilisateurs interagissent avec la fonctionnalité de commentaires de champ en créant des groupes d'utilisateurs spécifiques sur la page Groupes du panneau Admin et en attribuant des utilisateurs à ces groupes. Consultez la page de documentation Groupes pour savoir comment attribuer des utilisateurs à des groupes.

Les administrateurs Looker doivent créer ces groupes avec les noms prédéfinis, comme indiqué ci-dessous.

Les groupes d'utilisateurs doivent être créés avec les noms prédéfinis indiqués dans le tableau ci-dessous. Le tableau présente également les droits prédéfinis dont disposent les utilisateurs pour chaque groupe.

Nom du groupe Droits
marketplace_data_dictionary_comments_disabled Les utilisateurs ne peuvent ni voir les commentaires, ni interagir avec eux d'une autre manière, et toutes les fonctionnalités de commentaire sont désactivées. Les droits de ce groupe prévalent toujours sur ceux des autres groupes. Les utilisateurs inclus dans le groupe disabled n'ont pas accès à la fonctionnalité de commentaire, même s'ils appartiennent également à un autre groupe disposant de droits plus élevés.
marketplace_data_dictionary_comments_reader L'utilisateur peut consulter les commentaires existants, mais ne peut pas en ajouter.
marketplace_data_dictionary_comments_writer Les utilisateurs peuvent afficher tous les commentaires, en ajouter, et modifier/supprimer les leurs. Il s'agit du droit par défaut.
marketplace_data_dictionary_comments_manager Les utilisateurs peuvent voir tous les commentaires, en ajouter et modifier/supprimer tous les commentaires.

Si un utilisateur n'appartient à aucun de ces groupes, le groupe est writer par défaut. Si un utilisateur est affecté à plusieurs groupes (à l'exception de marketplace_data_dictionary_comments_disabled), ses droits les plus élevés prévalent.

Les modifications apportées à un groupe de commentaires (ajout ou suppression d'un utilisateur, par exemple) effectuées via la page Groupes du panneau Administration prennent effet après une actualisation forcée de la page "Dictionnaire de données" ou lorsque l'utilisateur sélectionne une autre option, puis revient à la page "Dictionnaire de données".

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

Afficher les métadonnées de 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 model et afficher ses métadonnées, y compris ses explorations et la liste de champs de chaque exploration, regroupées par vue. Le dictionnaire de données Looker affiche les explorations du modèle sélectionné dans la barre latérale 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 indique:

  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. Des filtres rapides pour affiner les champs affichés en fonction des caractéristiques sélectionnées
  6. Nom de la vue
  7. Métadonnées sur 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 profileur de champ.
  8. Lignes contenant des métadonnées pour chaque champ d'une vue donnée
  9. Navigation vers l'exploration dans l'interface utilisateur Looker

Sélectionner un modèle et une exploration

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

Vous pouvez également rechercher le modèle sélectionné pour une exploration spécifique en saisissant son nom dans le champ de recherche Rechercher un 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.

Filtrage des champs dans une exploration

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

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

Afficher les métadonnées d'un champ

Le dictionnaire de données Looker affiche les métadonnées des champs d'une exploration, regroupés 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 Options d'affichage dans l'angle supérieur droit, puis en cochant ou décochant les cases des métadonnées que vous souhaitez afficher.

Utiliser des commentaires de champ

Si une instance dispose déjà de Marketplace, les administrateurs doivent s'assurer que l'extension Data Dictionary est en version 2.0.0 ou ultérieure afin d'utiliser les commentaires au niveau du 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. Cependant, ces descriptions ne sont pas toujours pertinentes ou utiles pour tous les utilisateurs. Grâce aux commentaires au niveau du champ, les utilisateurs peuvent ajouter du contexte à un champ spécifique. Ces commentaires sont visibles par les autres utilisateurs, mais n'ont aucune incidence sur le code LookML sous-jacent du modèle.

Les administrateurs doivent autoriser les utilisateurs à interagir avec les commentaires en les ajoutant à des groupes spécifiques depuis la page Groupes du panneau Admin. Par défaut, tous les utilisateurs ayant accès à l'extension du dictionnaire de données peuvent afficher tous les commentaires et ajouter, modifier et supprimer leurs propres commentaires.

Ajouter un commentaire de champ

Pour ajouter un commentaire à un champ:

  1. Pointez sur la ligne du champ pour afficher une icône + (s'il n'existe pas de commentaires dans le champ) ou une icône de bloc-notes (si un champ comporte déjà 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 enregistrer votre entrée. Cliquez sur Annuler pour fermer le profileur de champs. Vous pouvez développer la zone de commentaire en sélectionnant l'angle inférieur droit et en le faisant glisser.

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

Affichage des commentaires sur le champ

Lorsqu'un champ contient des commentaires, une icône Bloc-notes apparaît avec le nombre de commentaires présents dans ce champ. Cliquez sur l'icône de bloc-notes pour afficher les commentaires du champ dans l'onglet Comments (Commentaires) du profileur de champs.

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

  • Nom de l'auteur du commentaire
  • Code temporel indiquant la date d'ajout du commentaire
  • Un aperçu du commentaire

Modification ou suppression d'un commentaire de champ

Pour modifier ou supprimer vos propres commentaires de champ:

  1. Sélectionnez l'icône 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 pour modifier le commentaire ou Supprimer le commentaire pour le supprimer. Si vous supprimez le commentaire, confirmez votre choix.
  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 pour chaque champ est unique et peut être copiée et partagée avec d'autres utilisateurs ayant accès à ce modèle dans le dictionnaire de données Looker.

Utiliser le profileur de champs

Cliquez sur une ligne spécifique pour ouvrir un panneau de profileur de champ à droite de la page. Celui-ci affiche l'ensemble des métadonnées du champ, des options permettant de prévisualiser les valeurs de dimension numériques, ainsi que des boutons permettant d'accéder à l'IDE Looker ou à la page Explorer.

Si vous utilisez la version 2.0.0 ou une version ultérieure de l'extension Looker Data Dictionary, le profileur de champs s'ouvre par défaut sur l'onglet Details (Détails).

Dans la section Distribution, sélectionnez Calculate (Calculer) pour afficher un aperçu d'un graphique à colonnes représentant la distribution des valeurs de nombre pour les dimensions numériques dans une vue dont la mesure contient type: count. La section Distribution affiche é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 décompte pour les dimensions numériques dans une vue dont la mesure contient type: count. Cliquez sur le bouton Explorer plus pour ouvrir l'interface utilisateur d'exploration. La dimension numérique et la mesure de comptage sont présélectionnées dans le sélecteur de champs.

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

Cliquez sur le bouton Explore with Field (Explorer avec un champ) pour ouvrir la page Explore (Explorer) où ce champ est automatiquement sélectionné dans le sélecteur de champs.