Comprendre les autres fichiers du projet

Un projet Looker comprend un ou plusieurs fichiers de modèle, un ou plusieurs fichiers de vue, et éventuellement les types de fichiers suivants:

Vous trouverez une présentation détaillée des fichiers de modèle et de vue sur la page de présentation des fichiers de modèle et de vue. Les autres types de fichiers sont décrits dans les sections ci-dessous.

Pour savoir comment accéder aux fichiers d'un projet, consultez la page Accéder aux informations du projet et les modifier.

Les fichiers de projet sont organisés par vos développeurs Looker à l'aide de dossiers dans l'IDE.

Fichiers du tableau de bord

Looker accepte deux types de tableaux de bord:

  • Les tableaux de bord définis par l'utilisateur, qui peuvent être créés par des utilisateurs non développeurs sans utiliser LookML. Pour en savoir plus, consultez la page Créer des tableaux de bord définis par l'utilisateur.
  • Tableaux de bord LookML, qui sont stockés en tant que fichiers associés à un projet et dont les versions sont contrôlées.

Si votre projet contient des tableaux de bord LookML, ils seront définis dans des fichiers de tableaux de bord dédiés dans l'IDE.

Pour en savoir plus sur les tableaux de bord LookML, consultez la page Créer des tableaux de bord LookML.

Fichiers de document

Les fichiers de documents Looker vous permettent d'écrire de la documentation ou d'autres notes sur votre modèle de données Looker à l'aide de Markdown, une version aromatisée de GitHub. Cela peut aider vos utilisateurs à se familiariser avec Looker.

Créer des fichiers de document

Pour ajouter un document à votre projet:

Après avoir créé un fichier, vous pouvez le modifier en cliquant sur Modifier en haut à droite. Vous pouvez ensuite prévisualiser vos modifications en cliquant sur Preview (Prévisualiser), ou les enregistrer en cliquant sur Save (Enregistrer).

Afficher le document en dehors de l'IDE

Pour consulter un document en dehors de l'IDE, pour profiter des fonctionnalités de navigation décrites ci-dessous, choisissez l'option Afficher le document dans le menu déroulant en haut à gauche:

Vous pouvez distribuer l'URL de la page obtenue à d'autres utilisateurs afin qu'ils n'aient pas à parcourir la section pour les développeurs de Looker pour y accéder.

Ajouter une structure de navigation à votre document

Vous pouvez ajouter une barre latérale à vos fichiers de document afin que les utilisateurs puissent facilement voir la structure des informations et naviguer entre les documents:

Pour ajouter la barre latérale à un document, créez une section de navigation à partir de la première ligne du document. Indiquez le début et la fin de la section de navigation à l'aide de trois tirets (---).

Vous pouvez utiliser les paramètres suivants dans la section de navigation:

Au minimum, vous pouvez utiliser navigation: true sur un document pour ajouter la barre latérale de navigation à ce document. Voici comment cela se présente dans un fichier Markdown:

Cela ajoute au document une barre latérale de navigation contenant des liens vers toutes les pages de documentation du projet. Si vous n'incluez que navigation: true dans un document, la barre latérale de ce document répertorie toutes les pages de documentation du projet par ordre alphabétique.

Vous pouvez également constater que l'organisation par nom alphabétique n'est pas la solution idéale ou si vous ne souhaitez pas que certains documents soient affichés dans la barre de navigation d'une page:

Si vous souhaitez modifier l'ordre des fichiers dans la barre latérale de navigation d'un document ou si vous souhaitez afficher uniquement un sous-ensemble de vos documents dans la barre latérale, vous pouvez utiliser ce format:

---
navigation:
  - document_one
  - document_two
  - document_three
  - document_four
---

Ainsi, la page affiche uniquement les fichiers qui vous intéressent, dans un ordre plus pertinent:

title

Par défaut, la barre latérale affiche l'en-tête du document (si le document commence par un titre) ou le nom du fichier s'il ne contient pas de titre. Vous pouvez ajouter un paramètre title en haut d'un document pour modifier l'affichage du document dans les barres latérales de navigation:

---
title: New Title for Users
---

Ce titre sera utilisé comme texte du lien dans la barre latérale de navigation de tous les documents, sauf si vous spécifiez un label différent dans la section de navigation d'un document.

label

Si vous souhaitez modifier la manière dont une page est répertoriée dans la barre latérale de navigation d'un document, vous pouvez utiliser les paramètres document et label comme suit:

---
navigation:
  - document_one
  - document: document_two
    label: Customized Label for Document Two
  - document_three
  - document_four
---

Pour utiliser le paramètre label, vous devez ajouter document: avant le nom du fichier de document, comme indiqué dans l'exemple précédent. Si vous n'utilisez pas de label pour un document, n'incluez pas document: avant le nom du fichier.

La valeur label définit la manière dont un document est affiché dans la barre latérale de navigation du document, même si le document auquel il fait référence possède son propre paramètre title.

L'exemple précédent se présente comme suit dans la barre latérale du document:

section

Si vous souhaitez diviser la barre latérale de navigation en sections, vous pouvez utiliser le paramètre section comme suit:

---
navigation:
  - document_one
  - document_two
  - section: My Section Name
  - document_three
  - document_four
---

Le paramètre section ajoute un saut de section et un titre à la barre latérale:

Le titre n'est pas un lien en lui-même. Il ne fait référence à aucun de vos fichiers de documentation.

Fichiers de données

Les fichiers de données sont des fichiers JSON avec l'extension .json, .topojson ou .geojson.

Le paramètre map_layer vous permet d'utiliser un fichier JSON en tant que carte personnalisée, qui peut ensuite être utilisé pour tracer vos données dans Looker:

Vous utilisez ensuite le paramètre map_layer_name avec une dimension afin de pouvoir associer une valeur de données (telle que "Paris") à une zone géographique sur votre carte personnalisée.

Vous pouvez modifier un fichier JSON dans l'IDE LookML, puis cliquer sur Enregistrer. Pour le débogage, vous pouvez choisir Afficher le fichier brut afin d'afficher le fichier au format brut. Si vous disposez de l'extension appropriée pour afficher JSON dans votre navigateur, vous pouvez également afficher le fichier au format Analysé:

Ajouter des fichiers de données

Pour ajouter un fichier JSON à votre projet, utilisez la fonctionnalité glisser-déposer pour importer le fichier depuis votre ordinateur (consultez la section Importer des fichiers de la page de documentation Travailler avec des dossiers dans l'IDE).

Fichiers manifestes d'un projet

Votre projet peut contenir un fichier manifeste de projet, utilisé pour les tâches suivantes:

La localisation de modèles n'est actuellement pas compatible avec l'importation de projets.

Chaque projet ne peut avoir qu'un seul fichier manifeste. Il doit être nommé manifest.lkml et situé à la racine de la structure de répertoires de votre projet et dans votre dépôt Git.

Créer un fichier manifeste

Pour ajouter un fichier manifeste de projet à votre projet, utilisez l'option Create Project Manifest (Créer un fichier manifeste de projet) dans le menu + en haut de l'explorateur de fichiers IDE Looker (consultez la section Créer des fichiers sur la page Utiliser des dossiers de l'IDE pour en savoir plus). Un fichier manifest.lkml est alors créé à la racine de la structure de répertoires de votre projet. Ne déplacez pas le fichier manifeste, car il doit être stocké à la racine de votre structure de répertoires.

L'option Créer un fichier manifeste de projet n'est disponible que via l'icône + en haut de l'explorateur de fichiers dans l'IDE Looker. Cette option n'est pas disponible dans les menus, car le fichier manifeste doit se trouver à la racine de la structure de répertoires de votre projet.

De plus, l'option Créer un fichier manifeste de projet n'est disponible que si votre projet ne comporte pas encore de fichier manifeste, car il ne peut en contenir qu'un seul.

Fichiers de verrouillage du fichier manifeste

Les fichiers de verrouillage du fichier manifeste sont créés automatiquement lorsqu'une dépendance à distance est ajoutée au fichier manifeste du projet. Looker utilise le fichier de verrouillage du fichier manifeste pour suivre la version du ou des projets distants spécifiés dans le fichier manifeste:

Les développeurs Looker n'ont pas besoin de créer ni de modifier un fichier manifeste de verrouillage, car ceux-ci sont gérés automatiquement par Looker.

Pour en savoir plus, consultez la page Importer des fichiers à partir d'autres projets.

Fichiers de paramètres régionaux

Si vous localisez votre modèle de données, vous devez créer des fichiers de chaînes de paramètres régionaux pour chaque paramètre régional à inclure, y compris vos paramètres régionaux par défaut (par exemple, souvent en anglais aux États-Unis).

Les fichiers de chaînes de paramètres régionaux répertorient les paires clé-valeur pour chaque libellé et description que vous localisez dans votre modèle. Le fichier de chaînes correspondant à chaque langue doit fournir une traduction pour chaque libellé ou description. Pour en savoir plus sur la création de fichiers de chaînes de paramètres régionaux, consultez la page Localiser votre modèle LookML.

Création de fichiers de chaînes de paramètres régionaux

Si vous créez des fichiers de chaînes de paramètres régionaux pour localiser votre modèle et que vous souhaitez également tirer parti de la localisation native de l'UI de Looker, vous devez nommer vos fichiers de chaînes à l'aide de codes de paramètres régionaux spécifiques, disponibles dans la section "Paramètres régionaux" de la page de documentation Utilisateurs.

Pour créer un fichier de chaînes de paramètres régionaux dans votre projet:

Explorer les fichiers

Les explorations sont généralement définies dans un fichier de modèle. Toutefois, vous avez parfois besoin d'un fichier Explorer distinct pour une table dérivée, ou pour étendre ou affiner une exploration à plusieurs modèles.

Les fichiers de type "Exploration" sont associés à l'extension .explore.lkml.

Créer des fichiers Explorer

Pour créer un fichier Explorer dans votre projet:

Lorsque vous créez des fichiers Explorer:

  • Assurez-vous d'utiliser l'extension de fichier .explore.lkml
  • Une fois le fichier créé dans votre projet, veillez à utiliser le paramètre include pour le rendre disponible afin de le référencer dans d'autres fichiers de votre projet. Les fichiers Explorer peuvent être inclus dans les vues, dans les modèles et dans d'autres fichiers Explorer.
  • Une fois que vous avez créé un fichier Explorer, vous pouvez afficher les objets et y accéder à l'aide du navigateur d'objets dans l'IDE Looker.

Fichiers de test de données

Votre projet peut disposer de fichiers de test de données permettant de vérifier la logique de votre modèle LookML. Les tests de données peuvent être contenus dans des fichiers de modèle ou dans des fichiers de vue, mais si vos développeurs souhaitent utiliser les mêmes tests de données sur plusieurs modèles différents, il peut être utile de conserver les tests de données dans leur propre fichier dédié.

Créer des fichiers de test de données

Pour créer un fichier de test de données dans votre projet:

Lors de la création de fichiers de test de données:

  • Les fichiers de test de données portent l'extension .lkml.
  • Une fois le fichier créé dans votre projet, veillez à utiliser le paramètre include pour le rendre disponible afin de le référencer dans d'autres fichiers de votre projet. Les fichiers Explorer peuvent être inclus dans les vues, dans les modèles et dans d'autres fichiers Explorer.

Fichiers de suggestions

Votre projet peut contenir des fichiers utilisés pour les affinages LookML. Les suggestions LookML peuvent être contenues dans des modèles, des fichiers de vue ou d'exploration, ou dans leur propre fichier dédié.

Création de fichiers de suggestions

Pour créer un fichier de suggestions dans votre projet:

Lors de la création de fichiers de filtres:

  • Les fichiers de filtre comportent l'extension .lkml.
  • Une fois que vous avez créé les filtres dans votre projet, assurez-vous d'utiliser le paramètre include pour que votre nouveau fichier puisse être référencé dans d'autres fichiers de votre projet.

Autres fichiers

De nombreux éléments LookML peuvent être hébergés dans différents fichiers de votre projet ou dans des fichiers dédiés. Par exemple, les tests de données peuvent être hébergés dans des fichiers de modèle, des fichiers de vue ou leurs propres fichiers .lkml dédiés.

Créer des fichiers génériques LookML

Pour créer un fichier LookML générique dans votre projet:

Une fois le fichier créé, veillez à utiliser le paramètre include pour le rendre disponible afin de le référencer dans d'autres fichiers de votre projet.