framework d'extension Looker

Le framework d'extension Looker réduit considérablement les efforts et la complexité liés à la création d'applications et d'outils de données JavaScript personnalisés. Exemples:

  • Applications de plate-forme interne pour votre entreprise
  • Plates-formes externes pour vos clients, telles que des portails client pour les applications d'analyse intégrées créées à l'aide de données dans Looker
  • Outils internes ciblés
  • Applications d'intégration dans des applications externes

Les extensions Looker actuellement disponibles sur Looker Marketplace incluent le diction de données Looker et le diagramme LookML.

Pourquoi utiliser le framework d'extension ?

Certains aspects de la création d'applications Web sont simples et amusants, tandis que d'autres sont évidemment plus chronophages et moins amusants. Le framework d'extension vous aide à simplifier un grand nombre de ces tâches moins amusantes.

Le framework d'extension se charge de certains des aspects les plus fastidieux de la création d'une application Web, ce qui vous permet de vous concentrer immédiatement sur le développement. Les applications et outils personnalisés créés avec le framework d'extension sont accessibles depuis Looker et permettent à Looker de gérer les types de fonctions suivants:

Fonctionnalités du framework d'extension

Le framework de l'extension Looker inclut les fonctionnalités suivantes:

  • Le SDK de l'extension Looker, qui fournit des fonctions permettant d'accéder à l'API publique Looker et d'interagir avec l'environnement Looker.
  • Composants Looker, une bibliothèque de composants d'interface utilisateur React prédéfinis que vous pouvez utiliser dans vos extensions.
  • Le SDK Embed, une bibliothèque que vous pouvez utiliser pour intégrer des tableaux de bord, des styles et des explorations dans votre extension. Consultez l'extension du récepteur de la cuisine pour obtenir un exemple de code. Vous pouvez également utiliser le SDK Embed pour intégrer votre extension dans des applications tierces. Les cookies doivent être activés dans le navigateur lorsque vous intégrez des explorations, des styles ou des tableaux de bord à une extension.
  • L'utilitaire create-looker-extension, qui crée une extension de base qui inclut tous les fichiers et dépendances d'extension nécessaires, et que vous pouvez utiliser comme point de départ.
  • Notre dépôt contenant les exemples de frameworks d'extensions Looker comprend des modèles et des exemples d'extensions pour vous aider à démarrer rapidement.
  • Vous pouvez accéder aux points de terminaison de l'API tierce et ajouter des données tierces à votre extension.

  • La possibilité de créer des extensions plein écran dans Looker Les extensions plein écran peuvent être utilisées pour les applications de plate-forme interne ou externe.

    Dans une extension en plein écran, vous pouvez empêcher certains utilisateurs d'accéder à d'autres parties de Looker à partir de votre extension en ajoutant des utilisateurs à un groupe d'utilisateurs Extensions uniquement. Vous pouvez également supprimer la barre de navigation Looker en remplaçant /extensions par /spartan dans l'URL de l'extension.

  • Possibilité de configurer une clé d'accès pour votre extension afin que les utilisateurs doivent saisir une clé pour l'exécuter. Cela peut être utile si vous souhaitez facturer votre extension, mais que vous devez utiliser les autorisations Looker standards pour octroyer l'accès à des personnes qui ne devraient jamais pouvoir accéder à une extension.

Exigences relatives au framework des extensions

Pour développer à l'aide du framework de l'extension Looker:

  • Vous devez disposer des autorisations LookML pour les développeurs sur votre instance.
  • Votre administrateur Looker doit activer la fonctionnalité Extension Framework.
  • Nous vous conseillons de vous familiariser avec JavaScript ou TypeScript.
  • Nous recommandons le développement dans React, bien qu'il existe un SDK d'extension pour le code JavaScript brut.

Pour pouvoir s'exécuter dans Looker, toutes les extensions, quelle que soit leur fonction, doivent inclure les éléments suivants dans Looker:

  • Un projet LookML qui:

  • Le fichier de modèle LookML nécessite un paramètre connection qui pointe vers une connexion de base de données valide sur votre instance.

  • Le fichier manifeste du projet nécessite un paramètre application. Le paramètre application attribue un libellé à l'extension, indique à Looker où trouver le JavaScript de l'extension et fournit une liste de droits d'accès pour l'extension. Les droits d'accès définissent les ressources Looker auxquelles l'extension peut accéder. L'extension ne pourra pas accéder à une ressource Looker, sauf si cette ressource est répertoriée dans les droits d'accès. Voici un exemple de fichier manifeste de projet avec un paramètre application:

  project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    entitlements: {
      local_storage: no
      navigation: no
      new_window: no
      new_window_external_urls: []
      use_form_submit: yes
      use_embeds: no
      use_downloads: no
      core_api_methods: []
      external_api_urls: []
      oauth2_urls: []
      scoped_user_attributes: []
      global_user_attributes: []
    }
  }

Pour en savoir plus, consultez la page de documentation sur le paramètre application.

Premiers pas avec le framework d'extension Looker

Le moyen le plus simple consiste à générer d'abord une nouvelle extension de démarrage à partir d'un modèle, puis à personnaliser et ajouter une fonctionnalité à ce déclencheur. Cela garantit que la configuration et le packaging sont corrects, ce qui peut s'avérer difficile à effectuer à la main. Consultez la page Créer une extension Looker pour savoir comment créer un projet Looker pour votre extension et générer une extension de démarrage.

Pour utiliser des modèles plus personnalisés ou avancés, vous pouvez parcourir le dépôt d'exemples du framework de l'extension Looker. Vous pouvez cloner et remanier toute extension de ce dépôt comme point de départ de votre projet.

Une fois que vous avez créé une extension simple et vérifié que tout fonctionne, vous pouvez ajouter des fonctionnalités et des personnalisations supplémentaires:

  • Vous trouverez une liste de cas d'utilisation courants avec des exemples de code sur la page de documentation Exemples de code du framework de l'extension Looker.

  • Consultez le site Composants de l'interface utilisateur Looker pour utiliser notre bibliothèque de composants et développer rapidement l'interface utilisateur et la mise en page.

  • Le modèle Looker Kitchensink d'extension est une extension qui fournit des exemples d'une grande variété de fonctionnalités d'extensions. Vous pouvez utiliser ce modèle comme encyclopédie ou guide de référence, mais pas comme point de départ ni comme modèle. Nous vous recommandons d'utiliser notre générateur d'extensions ou de cloner l'un des exemples les plus simples pour commencer.