Introduzione al framework delle estensioni Looker

Il framework dell'estensione Looker presto utilizzerà un nuovo meccanismo di caricamento. Il nuovo caricatore potrebbe causare errori quando vengono caricate le estensioni esistenti. Per istruzioni su come testare le estensioni con il nuovo caricatore prima dell'attivazione ufficiale negli ambienti Looker, consulta l'articolo Testing the new extension framework loader nel Centro assistenza Looker.

Il framework dell'estensione di Looker è un framework di sviluppo che riduce in modo significativo lo sforzo e la complessità di creazione di applicazioni e strumenti di dati JavaScript personalizzati, come:

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

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

Perché utilizzare il framework delle estensioni?

Alcune parti della creazione di applicazioni web sono facili e divertenti, mentre altre sono ovviamente più lunghe e non esattamente divertenti. Il framework delle estensioni ti aiuta a semplificare molte di queste attività non ancora divertenti.

Il framework di estensioni 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 delle estensioni da Looker, che consente di gestire i seguenti tipi di funzioni, tra cui:

Funzionalità del framework delle estensioni

Il framework dell'estensione Looker include le seguenti funzionalità:

  • L'SDK dell'estensione Looker, che fornisce funzioni per l'accesso all'API pubblica Looker e per interagire all'interno dell'ambiente Looker.
  • Componenti di Looker, una libreria di componenti predefiniti di React UI che puoi utilizzare nelle estensioni.
  • L'SDK Embed, una libreria che puoi utilizzare per incorporare dashboard, Look ed Esplorazioni nell'estensione. Per vedere il codice di esempio, consulta l'estensione del lavello da cucina. Puoi anche utilizzare l'SDK Embed per incorporare l'estensione in applicazioni di terze parti. I cookie devono essere attivati nel browser quando incorpora esplorazioni, visualizzazioni o dashboard in un'estensione.
  • L'utilità create-looker-extension, che crea un'estensione di base che include tutti i file delle estensioni e le dipendenze necessari, e che puoi utilizzare come punto di partenza per la creazione.
  • Il nostro repository Esempi di framework di estensioni Looker, che include modelli ed estensioni di esempio per aiutarti a iniziare rapidamente.
  • Possibilità di accedere agli endpoint API di terze parti e aggiungere dati di terze parti alla tua estensione.

  • La possibilità di creare estensioni a schermo intero all'interno di Looker. Le estensioni a schermo intero possono essere utilizzate per le applicazioni della piattaforma interna o esterna.

    In un'estensione a schermo intero, puoi impedire a un insieme di utenti di passare ad altre parti di Looker dalla tua estensione aggiungendo 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.

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

Requisiti del framework per le estensioni

Per sviluppare utilizzando il framework delle estensioni Looker:

- Avrai bisogno delle autorizzazioni di sviluppatore LookML per la tua istanza.

Per poter 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:

  • Il file del modello LookML richiede un parametro connection che rimandi a una connessione del database valida nell'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 dei diritti per l'estensione. I diritti definiscono le risorse Looker a cui l'estensione può accedere. L'estensione non sarà in grado di accedere a una risorsa di Looker a meno che la risorsa 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"
    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 estensioni di Looker

Il modo più semplice per iniziare è generare una nuova estensione starter a partire da un modello, quindi personalizzare e aggiungere funzionalità allo starter. Ciò garantisce che tutte le configurazioni e la pacchettizzazione siano corrette, il che può essere difficile da fare a mano. Per istruzioni su come creare un nuovo progetto Looker per la tua estensione e generare un'estensione iniziale, consulta la pagina Introduzione alla creazione di un'estensione di Looker.

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

Una volta creata un'estensione semplice e verificato che tutto funzioni, puoi iniziare ad aggiungere ulteriori funzionalità e personalizzazioni.

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

  • Visita il sito Componenti UI Looker per utilizzare la nostra libreria di componenti per uno sviluppo rapido dell'interfaccia utente e del layout.

  • Il modello Looker per l'estensione Kitchensink è un'estensione che fornisce esempi di molte funzionalità delle estensioni. 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.