framework di estensione Looker

Il framework di estensione Looker è un framework di sviluppo che riduce notevolmente l'impegno e la complessità della creazione di strumenti e applicazioni di dati JavaScript personalizzati, ad esempio:

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

Gli esempi attuali di estensioni di Looker disponibili su Looker Marketplace includono Looker Data Dictionary e LookML Diagram.

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 esattamente divertenti. Il framework di estensione ti aiuta a semplificare molte di queste attività non così 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 sull'avvio immediato dello sviluppo. È possibile accedere alle applicazioni e agli strumenti personalizzati creati con il framework di estensione da Looker, consentendo a Looker di gestire i seguenti tipi di funzioni, ad esempio:

Funzionalità del framework di estensione

Il framework di estensione Looker include le seguenti funzionalità:

  • L'SDK di estensione di 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 libreria 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 Explore nella tua estensione. Per il codice di esempio, consulta l'estensione Kitchen Sink. Puoi anche utilizzare l'SDK Embed per incorporare l'estensione in applicazioni di terze parti. Quando incorpori Explore, Look o dashboard in un'estensione, i cookie devono essere abilitati nel browser.
  • L'utilità create-looker-extension, che crea un'estensione di base che include tutti i file e le dipendenze necessari per l'estensione e che puoi utilizzare come punto di partenza per la creazione.
  • Il nostro repository di esempi del framework di estensione Looker, che include modelli ed estensioni di esempio per aiutarti a iniziare rapidamente.
  • La possibilità di accedere agli endpoint API di terze parti e aggiungere dati di terze parti all'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 impedire a un gruppo di utenti di navigare in altre parti di Looker dalla tua estensione aggiungendo gli utenti a un gruppo di utenti Solo estensioni. 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 l'estensione in modo che gli utenti debbano inserire una chiave per eseguire l'estensione. Questa opzione è utile se vuoi addebitare un costo per l'estensione, ma devi utilizzare le autorizzazioni standard di Looker per limitare l'accesso a chi non dovrebbe mai poter accedere a un'estensione.

  • A partire da Looker 24.0, le estensioni possono essere sviluppate per essere eseguite in un riquadro delle 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 da un'esplorazione. Le estensioni possono anche essere configurate come riquadri nelle dashboard LookML.

Requisiti del framework di estensione

Per sviluppare utilizzando il framework di estensione Looker:

Per essere eseguita all'interno di Looker, ogni estensione, indipendentemente dalla sua funzione, deve includere i seguenti elementi all'interno di Looker:

  • Un progetto LookML che soddisfi questi requisiti:

  • Il file del modello LookML deve avere un connection parametro che rimanda a una connessione al database valida nella tua istanza.

  • Il file manifest del progetto richiede un application parametro. 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 l'estensione può accedere. L'estensione non potrà accedere a una risorsa di Looker a meno che 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 i dettagli, consulta la pagina della documentazione del parametro application.

Inizia a sviluppare con il framework di estensione Looker

Il modo più semplice per iniziare è generare prima una nuova estensione di base da un modello, quindi personalizzare e aggiungere funzionalità a questa estensione di base. In questo modo, la configurazione e il packaging sono corretti, cosa che può essere difficile da fare manualmente. Per istruzioni su come creare un nuovo progetto Looker per l'estensione e generare un'estensione di base, consulta la pagina della documentazione Creazione di un'estensione di Looker.

Per modelli più personalizzati o avanzati, puoi sfogliare il repository di esempi del framework di estensione Looker. Qualsiasi estensione in questo repository può essere clonata e riutilizzata come punto di partenza per il tuo progetto.

Dopo aver creato un'estensione di base e 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 React e JavaScript del framework di estensione.

  • Fai riferimento al sito dei componenti dell'interfaccia utente di Looker per utilizzare la nostra libreria di componenti per lo sviluppo rapido dell'interfaccia utente e del layout.

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

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