Personnalisation des blocs Marketplace Looker

Looker BlocksTM sont des modèles de données prédéfinis pour les modèles analytiques et les sources de données courants. Cette page explique comment les développeurs peuvent personnaliser les blocs Looker installés à partir de Marketplace Looker. La place de marché Looker est un emplacement centralisé qui vous 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 dans Looker Marketplace, ainsi que sur les autres méthodes de personnalisation des blocs, consultez la page de documentation sur les blocs Looker.

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

Pour que vous puissiez installer et utiliser certains blocs à partir de Marketplace Looker, votre administrateur Looker doit activer les fonctionnalités suivantes:

  • Si vous installez votre bloc via Looker Marketplace, votre administrateur Looker doit activer la fonctionnalité Marketplace.
  • Si le bloc en question contient un paramètre local_dependency, votre administrateur Looker doit également activer la fonctionnalité d'importation de projets en local 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 à partir de Marketplace.

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

Accéder au code LookML d'un bloc Marketplace

Les blocs basés sur des projets utilisant des filtres sont installés depuis Marketplace sous la forme d'un projet CONFIG modifiable unique qui importe à distance le projet CORE, qui contient l'ensemble du code LookML et des paramètres constants.

Une fois qu'un bloc est installé depuis Marketplace, vous pouvez accéder à son projet depuis le menu Develop (Développer) en cliquant sur son nom dans la liste des projets. Le nom d'un bloc de filtres de place de marché est généralement précédé de 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 code LookML défini dans les fichiers CORE en lecture seule du bloc comme référence lorsque vous personnalisez les fichiers CONFIG 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 de fichiers

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

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 permet d'éviter les conflits de modèles entre plusieurs installations de blocs.
manifest.lkml Modifiable pour les utilisateurs disposant d'autorisations develop Décrit le projet et ses dépendances externes. Contient l'ID de 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 dans le fichier manifeste qui gère l'importation à distance du projet CORE. Fournit la fiche, la version et les informations de modèle spécifiques associées à l'installation. Contient des informations sur les constantes configurées lors de l'installation (et qui peuvent être mises à jour à l'aide de l'option Gérer dans l'interface utilisateur de Marketplace).
refinements.lkml Modifiable pour les utilisateurs disposant d'autorisations develop Permet aux développeurs d'affiner les vues et les explorations définies dans les fichiers de projet CORE importés.

Personnalisation d'un bloc Marketplace

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

Si vous disposez des autorisations develop, vous pouvez personnaliser le code LookML dans le fichier refinements.lkml du projet CONFIG 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 améliorations LookML dans d'autres projets LookML est possible dans le fichier refinements.lkml du bloc. La combinaison du raffinement et du code LookML d'origine se comporte comme s'il s'agissait du code LookML d'origine de l'objet.

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

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

Personnalisation du fichier d'affinements

Si vous disposez des autorisations develop, vous pouvez ajouter du code LookML personnalisé au projet CONFIG afin de combiner des données supplémentaires ou de modifier le modèle analytique de base du bloc. Vous pouvez créer de nouvelles vues et les joindre à des explorations existantes, définir de nouveaux champs ou redéfinir des champs existants, ou appliquer des étiquettes selon vos besoins 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.

Supposons, par exemple, que vous ayez installé un bloc et que son fichier refinements.lkml contienne:

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 nommé aircraft, afin qu'il apparaisse dans l'UI avec le libellé Avion simplifié:

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 les modèles à partir du projet CORE.

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

Personnaliser un fichier manifeste modifiable

Dans les blocs qui utilisent des filtres, les projets CORE et CONFIG comportent tous deux des fichiers manifestes. Toutefois, seul le fichier manifeste du projet CONFIG peut être modifié.

Vous pouvez modifier le fichier CONFIG manifest.lkml pour ajouter des paramètres de projet à ceux qui apparaissent déjà dans le fichier manifeste du projet CORE. Par exemple, vous pouvez ajouter un local_dependency pour join 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é Ateliers d'importation de projets en local.

Mettre à jour les valeurs des constantes

Les constants du bloc sont définies dans le fichier manifeste du projet CORE importé. Le remplacement de la valeur d'une constante, si autorisé, doit être effectué dans l'interface utilisateur de Marketplace lors de la configuration ou en mettant à jour le bloc. Pour modifier 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 Marketplace Looker, 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 des blocs s'ouvre.
  4. Apportez les modifications nécessaires aux valeurs constantes.
  5. Cliquez sur Mettre à jour pour fermer la fenêtre de configuration du bloc et mettre à jour le bloc avec vos modifications.

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

Préserver les personnalisations d'un bloc de place de marché qui utilise des extensions

Certains des blocs disponibles dans Marketplace Looker étaient composés de projets qui utilisent la fonction LookML extends. Looker convertit tous les blocs Marketplace pour les instances sur Looker 21.8 ou version ultérieure en une structure de projet qui utilise des améliorations LookML et supprimera la prise en charge des blocs basés sur des extends.

Looker vous recommande d'installer la version basée sur les raffinements des blocs Marketplace présents sur votre instance lorsque ces blocs deviennent disponibles, afin de remplacer les blocs créés avec des extensions. Bien que ce processus de remplacement soit simple : vous pouvez installer le nouveau bloc (affinages) à partir de la liste du bloc Marketplace Looker et désinstaller le bloc d'origine (qui étend) sur la page Gérer de la place de marché Looker. Toutefois, les personnalisations apportées au bloc créé avec des extensions ne seront pas conservées. De plus, Looker ne transférera aucun contenu ni aucune fonction Looker basés sur ce contenu (tableaux de bord, explorations, envois de contenu programmés, alertes) du bloc d'origine vers le nouveau bloc.

Cette section explique comment conserver les personnalisations apportées à un bloc créé avec des projets utilisant des extensions dont la réplication à partir de zéro serait difficile ou chronophage.

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

  1. Mettre à jour le projet CONFIG du bloc d'origine pour préparer la migration
  2. Installer la nouvelle version du bloc depuis Looker Marketplace
  3. Transférez les personnalisations dans le nouveau bloc "Place de marché"
  4. Recréer le contenu Looker en fonction du bloc d'origine
  5. Désinstaller la version du bloc qui a été compilée 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 dans un bloc créé avec des extensions afin que vous puissiez copier les personnalisations du bloc dans une nouvelle version du bloc basée sur les améliorations. Un bloc basé sur un projet qui utilise des extensions est installé à partir de Marketplace en tant que projet CORE en lecture seule et projet CONFIG modifiable.

  1. Accédez au projet CONFIG du bloc à partir de la section Develop (Développer) de l'une des manières suivantes:

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

    Les noms de projet CONFIG se terminent généralement par _config, tandis que le nom du projet CORE n'a 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 des explore.
    3. Ajoutez + au nom des explore.

    L'exemple de fichier de modèle précédent ressemblerait à ceci:


    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 étape ultérieure.

Installer le nouveau bloc Marketplace

Un bloc basé sur un projet qui utilise des filtres est installé à partir de Marketplace sous la forme d'un projet LookML unique et modifiable qui importe à distance le projet contenant tout le code LookML et les paramètres constants.

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

Transfert des personnalisations vers le nouveau bloc de place de marché

Cette section explique comment transférer les mises à jour que vous avez effectuées dans le bloc d'origine (étendu) vers le nouveau bloc (raffinements).

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

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

    Le nom d'un bloc de filtres de place de marché est généralement précédé de 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 (étendu). Veillez à conserver toutes les instructions include qui se trouvent déjà dans le fichier de filtres.

Recréer le contenu Looker en fonction du bloc d'origine

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

Vous devez recréer ces alertes ou ces envois planifiés dans les tableaux de bord LookML du nouveau bloc (affinages). Les administrateurs et utilisateurs Looker disposant des autorisations appropriées pour les planifications et les alertes peuvent utiliser les pages Alertes et programmations de la section "Administration" pour rechercher les noms des tableaux de bord du bloc (étendu), puis créer des alertes ou des envois planifiés selon les besoins dans les tableaux de bord correspondants du bloc (affinages).

Si nécessaire, vous devez également modifier tout autre contenu Looker faisant référence aux explorations ou aux tableaux de bord LookML du bloc d'origine (développé) de sorte qu'il pointe vers le nouveau bloc (raffinements).

Désinstallation du bloc d'origine

Pour désinstaller la version du bloc qui a été compilée avec des extensions:

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

  2. Dans Marketplace Looker, 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 (qui étend). Vous pouvez différencier la liste de blocage des extensions de la liste des blocs de filtres en examinant les numéros de version. Le bloc d'extensions sera une version majeure derrière le bloc de filtres. Par exemple, le bloc d'extensions peut être de version 1.0.4 et le bloc de filtres peut être de version 2.0.0.

Une fois le bloc désinstallé, la liste de blocs d'origine (étend) disparaît du panneau de navigation de gauche de l'instance Looker, ses explorations sont supprimées de la section Explore (Explorer), ses tableaux de bord LookML disparaissent du dossier LookML dashboard (tableaux de bord LookML) et toutes les alertes ou envois planifiés basés sur les tableaux de bord LookML du bloc sont désactivés ou échouent, respectivement.

Résoudre les problèmes de blocage

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

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

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

  2. Dans Marketplace Looker, 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 Update configurations (Mettre à jour les configurations), vérifiez que le bloc est correctement configuré. Après avoir effectué les modifications, cliquez sur Mettre à jour pour les enregistrer et fermer la fenêtre de configuration des blocages.