Introduzione al framework delle estensioni di Looker

Nota: a partire da Looker 22.20, per risolvere le potenziali violazioni dei Criteri di sicurezza del contenuto (CSP), è disponibile un nuovo meccanismo di caricamento migliorato per il framework delle estensioni di Looker. Per saperne di più, consulta la pagina della documentazione Impostazioni amministratore - Framework di estensione.

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

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

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

Perché utilizzare il framework delle estensioni?

Alcune parti della creazione di applicazioni web sono semplici 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 divertenti.

Il framework delle estensioni si occupa di alcuni degli aspetti più noiosi della creazione di un'applicazione web, in modo che tu possa concentrarti immediatamente sullo sviluppo. Le applicazioni e gli strumenti personalizzati creati con il framework dell'estensione sono accessibili da Looker, consentendo a Looker di gestire i seguenti tipi di funzioni, come:

• Autenticazione: consente di utilizzare le opzioni di autenticazione esistenti di Looker per l'accesso (ad esempio accesso tramite password, LDAP, SAML e OpenID Connect).
• Controllo dell'accesso e gestione delle autorizzazioni.
• Accesso API: consente di utilizzare altre risorse comuni per sviluppatori, come gli endpoint API di terze parti, in Looker.

Funzionalità del framework delle estensioni

Il framework delle estensioni Looker include le seguenti funzionalità:

• L'SDK Looker estensioni, che fornisce funzioni per l'accesso alle API pubbliche di Looker e per l'interazione all'interno dell'ambiente Looker.
• Componenti di Looker, una libreria di componenti UI predefiniti di React che puoi utilizzare nelle estensioni.
• Incorpora SDK, una libreria che puoi utilizzare per incorporare dashboard, Look ed esplorazioni nell'estensione. Vedi l'estensione del lavello da cucina per vedere un esempio di codice. Puoi anche utilizzare l'SDK Embed per incorporare l'estensione in applicazioni di terze parti. I cookie devono essere attivati nel browser quando incorpori Explore, Look 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 sviluppare ulteriormente.
• Il nostro repository di esempi di framework di estensioni di Looker, che include modelli ed estensioni di esempio, ti aiuterà a iniziare rapidamente.
• La possibilità di accedere a endpoint di terze parti dell'API e di 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 applicazioni con piattaforme interne o esterne.

  In un'estensione a schermo intero, puoi impedire a un gruppo di utenti di accedere ad altre parti di Looker dall'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.

• La possibilità di configurare una chiave di accesso per l'estensione, in modo che gli utenti debbano inserirla per eseguire l'estensione. Ciò è utile se vuoi richiedere un addebito per l'estensione, ma devi utilizzare le autorizzazioni standard di Looker per consentire l'accesso a chi non dovrebbe mai essere in grado di accedere a un'estensione.

Requisiti del framework delle estensioni

Per sviluppare l'utilizzo del framework delle estensioni di Looker:

• Devi disporre delle autorizzazioni di sviluppatore LookML per l'istanza.
• L'amministratore di Looker deve attivare la funzionalità Extension Framework.
• Ti consigliamo di acquisire familiarità con JavaScript o TypeScript.
• Consigliamo di sviluppare in React, anche se è presente un SDK dell'estensione per JavaScript non elaborato.

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:

  • Include un file modello
  • Include un file manifest del progetto
  • È connesso a un repository Git

• Il file modello LookML richiede un parametro connection che indirizzi a una connessione al database valida sulla tua istanza.

• Il file manifest del progetto richiede un parametro application. Il parametro application assegna all'estensione un'etichetta, 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 può accedere l'estensione. L'estensione non sarà in grado di accedere a una risorsa di Looker se non viene elencata nei diritti. Di seguito è riportato un file manifest del progetto di esempio 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 informazioni dettagliate, consulta la pagina della documentazione relativa al parametro application.

Iniziare a sviluppare con il framework delle estensioni Looker

Il modo più semplice per iniziare è generare innanzitutto una nuova estensione di base a partire da un modello, quindi personalizzare l'estensione e aggiungervi funzionalità. Ciò garantisce che tutte le configurazioni e le confezioni siano corrette, il che può risultare difficile da eseguire a mano. Consulta la pagina della documentazione Introduzione alla creazione di un'estensione Looker per istruzioni su come creare un nuovo progetto Looker per l'estensione e generare un'estensione di avvio.

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

Dopo aver creato un'estensione semplice e verificato che tutto funziona, puoi iniziare ad aggiungere ulteriori funzionalità e personalizzazioni:

• Puoi consultare un elenco di casi d'uso comuni con il codice di esempio nella pagina della documentazione Esempi di codice del framework delle estensioni di Looker.

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

• Il modello Looker Kitchensink è un'estensione che fornisce esempi di una vasta gamma di 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 generatore di estensioni o di clonare uno degli esempi più semplici.