Personnaliser les blocs de Marketplace Looker

Looker BlocksTM est des modèles de données prédéfinis pour les modèles et sources de données analytiques courants. Cette page explique comment les développeurs peuvent personnaliser les blocs Looker installés à partir de Looker Marketplace. Looker Marketplace est un emplacement centralisé qui permet de rechercher, de déployer et de gérer de nombreux types de contenus Looker, tels que des applications, des visualisations et des plug-ins.

Pour en savoir plus sur tous les blocs Looker disponibles, y compris sur les blocs qui ne sont pas actuellement disponibles sur Looker Marketplace, ainsi que sur les autres méthodes de personnalisation des blocs, consultez la page de documentation Blocs Looker.

Conditions requises pour installer et gérer des blocs Looker depuis Looker Marketplace

Pour que vous puissiez installer et utiliser des blocs depuis Looker Marketplace, votre administrateur Looker doit activer les fonctionnalités suivantes:

  • Si vous installez votre blocage via Looker Marketplace, votre administrateur Looker doit activer la fonctionnalité Marketplace.
  • Si le bloc en particulier contient un paramètre local_dependency, votre administrateur Looker doit également activer la fonctionnalité Local Project Import Labs. Ces blocs contiennent un paramètre local_dependency:

    • Analyse du marketing digital
    • Analyses des ventes
    • Analyse d'audience Internet

Les utilisateurs doivent disposer des autorisations develop, manage_models et deploy pour installer et gérer des packages depuis Marketplace.

Consultez la page de documentation Looker Marketplace pour en savoir plus sur l'installation et la gestion des blocs Looker à partir de Looker Marketplace.

Accéder à LookML pour un bloc Marketplace

Les blocs basés sur des projets qui utilisent des filtres sont installés sur Marketplace en tant que projet CONFIG unique et modifiable qui importe à distance le projet CORE, qui contient tout le code LookML et des paramètres constants.

Une fois qu'un blocage est installé depuis Marketplace, vous pouvez accéder à son projet à partir du menu Develop (Développer) en cliquant sur le nom du projet dans la liste des projets. Le nom du bloc de filtres de la place de marché est généralement précédé du préfixe marketplace_, suivi de l'ID de la fiche.

Bien que vous ne puissiez pas modifier directement le projet CORE en lecture seule d'un bloc, vous pouvez utiliser le LookML défini dans les fichiers CORE en lecture seule du bloc lorsque vous personnalisez les fichiers de configuration du bloc. Pour afficher les fichiers CORE du bloc, accédez aux fichiers de projet du bloc dans l'IDE et développez le répertoire imported_projects dans l'explorateur de fichiers IDE.

Bloquer la structure des fichiers

Lorsque vous installez un bloc conçu pour des filtres, ces fichiers sont créés automatiquement dans la partie CONFIG du projet de blocage:

Nom de fichier Accéder Fonction
<model_name>.model.lkml Lecture seule pour tous les utilisateurs Fichier de modèle virtuel lié à l'installation du bloc ; gère l'importation de tous les modèles à partir du projet CORE du bloc. Lorsqu'un bloc est désinstallé ou mis à jour, le ou les fichiers de modèle associés sont supprimés, ce qui évite les conflits de modèles entre plusieurs installations de blocs.
manifest.lkml Modifiable pour les utilisateurs avec des autorisations develop Décrit le projet et ses dépendances externes. Contient l'ID de la fiche Marketplace pour l'installation du bloc et facilite l'importation à distance des fichiers de projet CORE du bloc via le mot clé marketplace.
marketplace_lock.lkml Lecture seule pour tous les utilisateurs Contient une référence au mot clé marketplace_ref issu du fichier manifeste qui gère l'importation à distance du projet CORE. Fournit les informations relatives à la fiche, à la version et au modèle associées à l'installation. Contient des informations sur les constantes configurées lors de l'installation (et pouvant être mises à jour à l'aide de l'option Gérer dans l'interface utilisateur de Marketplace).
refinements.lkml Modifiable pour les utilisateurs avec des autorisations develop Permet aux développeurs d'affiner les vues et les explorations définies dans les fichiers de projet CORE importés.

Personnaliser un blocage Marketplace

Activez le mode de développement pour personnaliser les fichiers modifiables du bloc.

Si vous disposez des autorisations develop, vous pouvez personnaliser LookML dans le fichier refinements.lkml du projet de configuration du bloc. Vous pouvez affiner les vues et les explorations déjà définies dans le projet CORE du bloc, ou même ajouter de nouvelles vues et explorations qui ne sont pas déjà définies dans le projet CORE. Tout ce qui est possible avec les filtres LookML dans d'autres projets LookML est possible dans le fichier refinements.lkml du bloc. La combinaison du raffinement et du LookML d'origine se comporte comme s'il s'agissait du LookML d'origine de l'objet.

Vous pouvez également modifier le fichier manifest.lkml du projet CONFIG pour spécifier les dépendances à capturer pour ce bloc.

Vous n'êtes pas obligé de modifier ces fichiers pour obtenir les personnalisations de votre choix. Vous pouvez également créer des fichiers dans le projet CONFIG. Veillez à include tous les nouveaux fichiers dans le fichier refinements.lkml.

Personnaliser le fichier de filtres

Si vous disposez des autorisations develop, vous pouvez ajouter LookML personnalisé au projet CONFIG pour combiner des données supplémentaires ou modifier le modèle analytique principal du bloc. Vous pouvez créer des vues et les associer à des explorations existantes, définir de nouveaux champs ou redéfinir des champs existants, ou appliquer des libellés si nécessaire afin de créer un modèle pour l'analyse que vous souhaitez fournir. Si vous avez créé des fichiers dans le projet CONFIG, vous devez les include dans le fichier de filtres.

Par exemple, supposons que vous ayez installé un bloc et que son fichier refinements.lkml contienne le code suivant:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

listing_id est la valeur du paramètre listing du fichier manifest.lkml.

Vous pouvez utiliser des filtres pour ajouter une dimension à une vue appelée flights:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

view: +flights {
  dimension: air_carrier {
    type: string
    sql: ${TABLE}.air_carrier ;;
  }
}

Vous pouvez également appliquer un libellé à une exploration appelée aircraft afin qu'il s'affiche dans l'interface utilisateur sous la forme d'avions simplifiés:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

explore: +aircraft {
  label: "Aircraft Simplified"
}

Le fichier refinements.lkml est inclus automatiquement dans le fichier de modèle "virtuel" du bloc, qui importe essentiellement les modèles à partir du projet CORE.

Consultez la documentation sur les filtres LookML pour en savoir plus sur ce sujet avancé.

Personnaliser le fichier manifeste modifiable

Dans les blocs qui utilisent des filtres, les projets CORE et CONFIG contiennent tous deux des fichiers manifestes. Toutefois, seul le fichier manifeste du projet CONFIG est modifiable.

Vous pouvez modifier le fichier CONFIG manifest.lkml pour ajouter des paramètres de projet à ceux qui figurent déjà dans le fichier manifeste du projet CORE. Par exemple, vous pouvez ajouter un local_dependency pour joindre votre bloc à un autre bloc de la même instance Looker.

Pour que vous puissiez utiliser ou créer un bloc contenant un paramètre local_dependency, un administrateur Looker doit d'abord activer la fonctionnalité Local Project Import Labs

Mettre à jour des valeurs pour les constantes

Les constantes du bloc sont définies dans le fichier manifeste du projet CORE importé. Le cas échéant, vous devez remplacer la valeur d'une constante dans l'interface utilisateur de Marketplace pendant la configuration ou en mettant à jour le bloc. Pour mettre à jour un blocage, les utilisateurs doivent disposer des autorisations develop, manage_models et deploy.

Pour remplacer la valeur d'une constante en mettant à jour un bloc:

  1. Dans Looker Marketplace, accédez au bloc que vous souhaitez mettre à jour.
  2. Cliquez sur le bouton Gérer.
  3. À côté du nom du bloc que vous souhaitez mettre à jour, cliquez sur l'icône en forme de roue dentée. La fenêtre de configuration de bloc s'ouvre.
  4. Modifiez les valeurs constantes si nécessaire.
  5. Cliquez sur Mettre à jour pour fermer la fenêtre de configuration du bloc et appliquer les modifications au bloc.

Vos modifications sont répercutées dans le fichier marketplace_lock.lkml en lecture seule de votre projet installé.

Conserver les personnalisations à partir d'un bloc Marketplace qui utilise les extensions

Certains blocs disponibles dans Looker Marketplace étaient composés de projets utilisant des extensions LookML. Looker convertit tous les blocages de place de marché pour les instances sur Looker 21.8 ou version ultérieure en une structure de projet utilisant des filtres LookML et ne prendra plus en charge les blocages basés sur des extensions.

Looker vous recommande d'installer la version des filtres des blocs Marketplace que vous avez sur votre instance à mesure que ces blocs deviennent disponibles, en remplaçant les blocs créés par des extensions. Bien que ce processus de remplacement soit simple, vous pouvez installer le nouveau bloc (filtres) à partir de la liste de blocage Looker Marketplace et désinstaller le bloc (extension) d'origine sur la page Gérer de Looker Marketplace. Il ne conservera aucune des personnalisations susceptibles d'avoir été effectuées sur le bloc créé avec des extensions. Looker ne transférera pas non plus le contenu ni les fonctions Looker basés sur ce contenu (tableaux de bord, explorations, diffusions programmées, alertes) du bloc d'origine vers le nouveau bloc.

Cette section explique comment conserver les personnalisations apportées à un bloc créé avec des projets qui utilisent des extensions qui seraient autrement difficiles ou chronophages à répliquer.

Pour conserver les personnalisations de votre blocage, un utilisateur pouvant installer et gérer des packages depuis Marketplace doit:

  1. Mettez à jour le projet CONFIG du bloc d'origine pour préparer la migration
  2. Installer la nouvelle version du bloc à partir de Looker Marketplace
  3. Transférer les personnalisations vers le nouveau blocage de Marketplace
  4. Recréer du contenu Looker à partir du bloc d'origine
  5. Désinstaller la version du bloc compilé avec des extensions

Mettre à jour un bloc personnalisé pour préparer la migration

Cette section explique comment mettre à jour les fichiers de projet clés d'un bloc créé avec des extensions afin que vous puissiez copier les personnalisations du bloc dans une nouvelle version du bloc, basée sur des filtres. Un bloc basé sur un projet avec extensions est installé à partir de Marketplace en tant que projet CORE en lecture seule et en tant que projet CONFIG modifiable.

  1. Accédez au projet de configuration du bloc depuis la section Develop de l'une des manières suivantes:

    • Cliquez sur l'option Projets, puis sur le nom du projet.
    • Cliquez sur le nom du projet de configuration du bloc dans la liste des projets.

    Les noms de projets CONFIG se terminent généralement par _config, tandis que le nom du projet CORE ne comporte généralement pas de suffixe.

  2. Ouvrez le fichier de modèle du projet, qui peut se présenter comme suit:


    explore: ga_sessions_config {
      extends: [ga_sessions_core]
      extension: required
      join: user_sales_data {
        sql_on: ${user_sales_data.full_visitor_id} = ${ga_sessions.full_visitor_id} ;;
      }
      join: sales__by__category {
        sql: LEFT JOIN UNNEST(${user_sales_data.sales_by_category}) as sales__by__category;;
      }
    }

    explore: future_input_config {
      extends: [future_input_core]
      extension: required
      join: future_purchase_prediction {
        type: left_outer
        sql_on: ${future_input.full_visitor_id} = ${future_purchase_prediction.full_visitor_id} ;;
        relationship: one_to_one
      }
    }

  1. En mode Développement:

    1. Supprimez l'intégralité des lignes extends et extension.
    2. Supprimez _config des noms explore.
    3. Ajoutez le préfixe + aux noms explore.

    L'exemple de fichier de modèle précédent se présente comme suit:


    explore: +ga_sessions {
      join: user_sales_data {
        sql_on: ${user_sales_data.full_visitor_id} = ${ga_sessions.full_visitor_id} ;;
      }
      join: sales__by__category {
        sql: LEFT JOIN UNNEST(${user_sales_data.sales_by_category}) as sales__by__category;;
      }
    }

    explore: +future_input {
      join: future_purchase_prediction {
        type: left_outer
        sql_on: ${future_input.full_visitor_id} = ${future_purchase_prediction.full_visitor_id} ;;
        relationship: one_to_one
      }
    }

  1. Copiez et conservez le contenu de ce fichier pour une prochaine étape.

Installer le nouveau bloc Marketplace

Un bloc basé sur un projet utilisant des filtres est installé depuis Marketplace en tant que projet LookML unique et modifiable qui importe à distance le projet contenant l'ensemble des paramètres LookML et des paramètres constants.

  1. Sélectionnez l'icône d'achat dans la barre de menu de Looker pour accéder à Marketplace.
  2. Cliquez sur la fiche pour le nouveau bloc de place de marché basée sur les filtres. Ce bloc porte le même nom que le bloc existant qui a été créé avec des extensions.
  3. Cliquez sur Installer pour installer le nouveau bloc. Une fois ce bloc installé, vous verrez deux fiches identiques sur la page Gérer de Looker Marketplace.

Transfert des personnalisations vers le nouveau blocage de Marketplace

Cette section explique comment transférer les mises à jour effectuées vers le bloc d'origine (extensions) dans le nouveau bloc (filtres).

  1. Dans la section Develop (Développer), ouvrez le projet du nouveau bloc de l'une des manières suivantes:

    • Cliquez sur l'option Projets, puis sur le nom du projet.
    • Cliquez sur le nom du projet du bloc dans la liste des projets.

    Le nom du bloc de filtres de la place de marché est généralement précédé du préfixe marketplace_, suivi de l'ID de la fiche.

  2. Dans le fichier refinements.lkml, collez le contenu mis à jour à partir du fichier de modèle du bloc d'origine (extensions). Veillez à conserver toutes les instructions include déjà présentes dans le fichier de filtres.

Recréer du contenu Looker à partir du bloc d'origine

La dernière étape de l'adoption de la version basée sur les filtres d'un bloc Marketplace consiste à désinstaller la version d'origine de ce bloc. Certains blocs basés sur des extensions contiennent des tableaux de bord LookML et des explorations prédéfinis. Si des utilisateurs ont créé des alertes ou des diffusions planifiées basées sur des tableaux de bord LookML définis dans le bloc d'origine (extensions), ces alertes ou planifications seront désactivées ou échoueront, une fois ce bloc désinstallé de Looker Marketplace.

Vous devez recréer ces alertes ou livraisons programmées dans les tableaux de bord LookML du nouveau bloc (filtres). Les administrateurs et les utilisateurs de Looker disposant des autorisations appropriées pour les programmations et les alertes peuvent rechercher les noms des tableaux de bord du bloc (extensions), puis créer des alertes ou des livraisons programmées sur les tableaux de bord correspondants du bloc (extensions) à l'aide des alertes et programmations.

Vous devez également modifier tout autre contenu Looker faisant référence aux tableaux de bord "Explorations" ou "LookML" du bloc d'origine (extensions) afin qu'il pointe vers le nouveau bloc (filtres).

Désinstaller le bloc d'origine

Pour désinstaller la version du bloc compilé avec des extensions:

  1. Sélectionnez l'icône d'achat dans la barre de menu de Looker pour accéder à Marketplace.

  2. Dans Looker Marketplace, sélectionnez Gérer dans le panneau de navigation de gauche pour ouvrir la page Gérer.

  3. Sur la page Gérer, cliquez sur l'icône de la corbeille pour désinstaller le bloc d'origine (extension). Vous pouvez différencier la liste de blocs "Extended" et la liste de blocage des filtres en examinant les numéros de version. Le bloc "extensions" constitue une version majeure derrière le bloc de filtres. Par exemple, le bloc "extensions" peut être la version 1.0.4 et le bloc "Filtres" peut être la version 2.0.0.

Une fois le blocage désinstallé, la liste de blocs d'origine (étendues) disparaît du panneau de navigation de gauche de l'instance Looker, ses explorations disparaissent de la section Explorer, ses tableaux de bord LookML disparaissent du dossier Tableaux de bord LookML, et les alertes ou diffusions planifiées basées sur les tableaux de bord LookML du bloc sont respectivement désactivées ou échouées.

Résoudre un problème de blocage

Si un bloc Marketplace affiche des erreurs, il est possible que votre schéma ne corresponde pas à la structure du blocage.

Vous pouvez également vérifier que les constantes fournies lors de l'installation du bloc, représentant la connexion, la base de données ou le schéma du bloc, ont été correctement définies. Pour ce faire, procédez comme suit:

  1. Sélectionnez l'icône d'achat dans la barre de menu de Looker pour accéder à Marketplace.

  2. Dans Looker Marketplace, sélectionnez Gérer dans le panneau de navigation de gauche pour ouvrir la page Gérer.

  3. Sur la page Gérer, cliquez sur l'icône en forme de roue dentée du bloc pour afficher ses paramètres de configuration.

  4. Dans la fenêtre Mettre à jour les configurations, vérifiez que le bloc est correctement configuré. Après avoir apporté vos modifications, cliquez sur Mettre à jour pour enregistrer vos mises à jour et fermer la fenêtre de configuration du blocage.