Introduzione al framework delle estensioni Looker

Nota: a partire da Looker 22.20, per risolvere le potenziali violazioni dei Criteri di sicurezza del contenuto (CSP), esiste un nuovo meccanismo di caricamento avanzato per il framework dell'estensione di Looker. Per ulteriori informazioni, consulta la pagina della documentazione Impostazioni amministratore - framework di estensione.

Il framework di estensione Looker è un framework di sviluppo che riduce in modo significativo gli sforzi e la complessità della creazione di applicazioni e strumenti di dati JavaScript personalizzati, ad esempio:

• Applicazioni della piattaforma interna per la tua azienda
• Piattaforme esterne per i tuoi clienti, ad esempio portali per le applicazioni Analytics incorporate create con i 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 di dati di Looker e lo schema di LookML.

Perché usare il framework delle estensioni?

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 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 sull'avvio immediato dello sviluppo. È possibile accedere alle applicazioni e agli strumenti personalizzati creati con il framework delle estensioni dall'interno di Looker, consentendo a Looker di gestire i seguenti tipi di funzioni, ad esempio:

• Authentication: consente di utilizzare le opzioni di autenticazione esistenti di Looker per l'accesso (come password login e 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 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 con l'ambiente Looker.
• Componenti di Looker: una libreria di componenti dell'interfaccia utente predefinita di React che puoi utilizzare nelle estensioni.
• L'SDK per l'incorporamento, una libreria che puoi utilizzare per incorporare dashboard, Look ed esplorazioni nell'estensione. Vedi l'estensione del lavello della cucina per 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 e le dipendenze dell'estensione necessari e che puoi utilizzare come punto di partenza per creare da zero.
• Il nostro repository Esempi di framework di estensioni Looker, che include modelli ed estensioni di esempio per aiutarti a iniziare rapidamente.
• La possibilità di accedere a endpoint di 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 su piattaforme interne o esterne.

  In un'estensione a schermo intero, puoi impedire a un gruppo di utenti di raggiungere 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.

• La possibilità di configurare una chiave di accesso per la tua estensione in modo che gli utenti debbano inserire una chiave per eseguire l'estensione. Questa operazione è utile se vuoi addebitare il costo dell'estensione, ma devi utilizzare le autorizzazioni standard di Looker per impedire l'accesso a coloro che non devono mai poter accedere a un'estensione.

Requisiti del framework delle estensioni

Per sviluppare utilizzando il framework di estensione Looker:

• Devi disporre delle autorizzazioni di sviluppatore LookML per l'istanza.
• L'amministratore di Looker deve attivare la funzionalità Framework delle estensioni.
• Consigliamo di acquisire familiarità con JavaScript o TypeScript.
• Consigliamo di sviluppare in React, anche se esiste un SDK per le estensioni per JavaScript non elaborato.

Per poter eseguire l'esecuzione 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 del modello LookML richiede un parametro connection che indirizzi a una connessione al database valida per la tua istanza.

• Il file manifest del progetto richiede un parametro application. Il parametro application assegna all'estensione un'etichetta, indica a Looker dove trovare l'estensione JavaScript, e fornisce un elenco di diritti per l'estensione. I diritti definiscono le risorse Looker a cui può accedere l'estensione. L'estensione non potrà accedere a una risorsa di Looker se non è presente nei diritti. Di seguito è riportato un file manifest di 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 di estensione Looker

Il modo più semplice per iniziare è generare prima una nuova estensione di base da un modello, poi personalizzare e aggiungere funzionalità a quel modello. Ciò garantisce che la configurazione e la confezione siano corrette, ma ciò può essere difficile da svolgere a mano. Per istruzioni su come creare un nuovo progetto Looker per l'estensione e generare un'estensione di avvio, consulta la pagina Introduzione alla creazione di un'estensione Looker.

Per modelli più personalizzati o avanzati, puoi sfogliare il repository esempi di framework delle estensioni 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 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 di framework del framework Looker.

• Fai riferimento al sito Componenti dell'interfaccia utente di Looker per utilizzare la nostra libreria di componenti al fine di accelerare lo sviluppo di layout e UI.

• Il modello Kit di dissipatori da cucina di Looker è 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 dei seguenti esempi più semplici.