framework di estensione Looker

Il framework di estensione di Looker è un framework di sviluppo che riduce notevolmente lo sforzo e la complessità della creazione di applicazioni e strumenti per dati JavaScript personalizzati, come ad esempio:

  • Applicazioni della piattaforma interna per la tua azienda
  • Piattaforme esterne per i tuoi clienti, ad esempio portali per clienti per applicazioni di analisi incorporate create con dati in Looker
  • Strumenti interni mirati
  • Applicazioni per l'incorporamento in applicazioni esterne

Gli esempi attuali di estensioni di Looker disponibili su Looker Marketplace includono il dizionario dei dati di Looker e il diagramma LookML.

Perché utilizzare il framework di estensione?

Alcune parti della creazione di applicazioni web sono facili e divertenti, mentre altre sono ovviamente più dispendiose in termini di tempo e non proprio divertenti. Il framework di estensione consente di semplificare molte di queste attività poco divertenti.

Il framework di estensione si occupa di alcuni degli aspetti più noiosi della creazione di un'applicazione web, in modo che tu possa concentrarti su come iniziare subito lo sviluppo. Da Looker è possibile accedere ad applicazioni e strumenti personalizzati creati con il framework di estensione, consentendo a Looker di gestire i seguenti tipi di funzioni, ad esempio:

Funzionalità del framework di estensione

Il framework di estensione di Looker include le seguenti funzionalità:

  • L'SDK dell'estensione Looker, che fornisce funzioni per l'accesso all'API pubblica di Looker e per l'interazione all'interno dell'ambiente Looker.
  • Componenti di Looker, una raccolta di componenti dell'interfaccia utente React predefiniti che puoi utilizzare nelle tue estensioni.
  • L'SDK Embed, una libreria che puoi utilizzare per incorporare dashboard, Look ed esplorazioni nella tua estensione. Consulta l'estensione lavello della cucina per un codice di esempio. Puoi anche utilizzare l'SDK Embed per incorporare l'estensione in applicazioni di terze parti. I cookie devono essere attivati nel browser quando incorpori esplorazioni, look o dashboard in un'estensione.
  • L'utilità create-looker-extension, che crea un'estensione di base che include tutti i file e le dipendenze dell'estensione necessari, che puoi utilizzare come punto di partenza per la creazione.
  • Il nostro repository esempi di framework di estensioni di Looker, che include modelli ed estensioni di esempio per aiutarti a iniziare rapidamente.
  • La possibilità di accedere agli endpoint API di terze parti e di aggiungere dati di terze parti alla tua estensione.

  • La possibilità di creare estensioni a schermo intero in Looker. Le estensioni a schermo intero possono essere utilizzate per applicazioni di piattaforme interne o esterne.

    In un'estensione a schermo intero, puoi aggiungere utenti a un gruppo di utenti Solo estensioni per impedire a un insieme di utenti di accedere ad altre parti di Looker. Puoi anche rimuovere la barra di navigazione di Looker sostituendo /extensions con /spartan nell'URL dell'estensione.

  • La possibilità di configurare una chiave di accesso per la tua estensione in modo che gli utenti debbano inserirne una per eseguire l'estensione. Questo è utile se vuoi far pagare l'estensione, ma devi utilizzare le autorizzazioni Looker standard per limitare l'accesso a coloro che non dovrebbero mai essere in grado di accedere a un'estensione.

  • A partire da Looker 24.0, le estensioni possono essere sviluppate per essere eseguite in un riquadro nelle dashboard. Le estensioni che supportano l'esecuzione come riquadro o visualizzazione possono essere aggiunte mentre la dashboard è in modalità di modifica o salvate in una dashboard come visualizzazione di un'esplorazione. Le estensioni possono anche essere configurate come riquadri nelle dashboard di LookML.

Requisiti del framework di estensione

Per sviluppare utilizzando il framework di estensione di Looker:

Per poter essere eseguita in Looker, ogni estensione, indipendentemente dalla sua funzione, deve includere i seguenti elementi:

  • Un progetto LookML che:

  • Il file del modello LookML richiede un parametro connection che rimandi a una connessione al database valida sull'istanza.

  • Il file manifest del progetto richiede un parametro application. Il parametro application assegna un'etichetta all'estensione, indica a Looker dove trovare il codice JavaScript dell'estensione e fornisce un elenco di diritti per l'estensione. I diritti definiscono le risorse di Looker a cui può accedere l'estensione. L'estensione non potrà accedere a una risorsa Looker, a meno che questa non sia elencata nei diritti.

    Di seguito è riportato un esempio di file manifest del progetto con un parametro application:

      project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    mount_points: {
      standalone: no
    }
    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: []
    }
  }

    Per maggiori dettagli, consulta la pagina della documentazione relativa al parametro application.

Iniziare a sviluppare con il framework di estensione di Looker

Il modo più semplice per iniziare è generare innanzitutto una nuova estensione iniziale da un modello, quindi personalizzare e aggiungere funzionalità al comando iniziale. In questo modo, avrai la certezza che tutta la configurazione e l'imballaggio siano corretti, il che può essere difficile da fare manualmente. Per istruzioni su come creare un nuovo progetto Looker per l'estensione e generare un'estensione iniziale, consulta la pagina della documentazione Creazione di un'estensione Looker.

Per modelli più personalizzati o avanzati, puoi consultare il repository di esempi di Looker Extension Framework. Qualsiasi estensione all'interno del repository può essere clonata e riutilizzata come punto di partenza per il tuo progetto.

Dopo aver creato una semplice estensione e aver verificato che tutto funzioni, puoi iniziare ad aggiungere funzionalità e personalizzazioni aggiuntive:

  • Puoi visualizzare un elenco di casi d'uso comuni con codice di esempio nella pagina della documentazione Esempi di codice del framework di estensione di Looker.

  • Consulta il sito Componenti UI di Looker per utilizzare la nostra libreria di componenti per lo sviluppo rapido di UI e layout.

  • Looker Extension Kitchensink Template è un'estensione che fornisce esempi di una grande varietà di funzionalità di estensione. Puoi utilizzare questo modello come enciclopedia o guida di riferimento, ma non come punto di partenza o modello effettivo. Per iniziare, ti consigliamo di utilizzare il nostro generatore di estensioni o di clonare uno degli esempi più semplici.

  • Sono disponibili anche esempi di estensioni che possono essere utilizzate come riquadri della dashboard. L'estensione di visualizzazione delle schede mostra come creare una visualizzazione personalizzata utilizzando il framework di estensioni. L'estensione SDK riquadro mostra i metodi API disponibili specifici per le estensioni dei riquadri.