Sviluppo di una visualizzazione personalizzata per Looker Marketplace

Questa pagina descrive come creare un tipo di visualizzazione personalizzata che può essere aggiunto a Looker Marketplace e a cui possono accedere altri utenti di Looker. Puoi anche creare una visualizzazione personalizzata direttamente nel tuo progetto senza renderla disponibile ad altri clienti Looker.

Tieni presente che devi essere un membro della rete di partner Looker o un cliente Looker per inviare contenuti a Looker Marketplace.

Looker Marketplace è una posizione centralizzata in cui puoi trovare, eseguire il deployment e gestire molti tipi di contenuti Looker, come Looker BlocksTM, applicazioni, visualizzazioni e altri plug-in.

Con la funzionalità Marketplace di Looker abilitata, i clienti Looker possono installare i plug-in di Looker Marketplace, che includono tipi di visualizzazione da aggiungere alla relativa libreria nativa. Le visualizzazioni installate tramite il Marketplace sono supportate dal team di Looker.

Per sviluppare una visualizzazione personalizzata e renderla disponibile per tutti i clienti Looker tramite Looker Marketplace, segui questi passaggi:

  1. Sviluppa una visualizzazione.
  2. Crea un progetto Looker per la visualizzazione.
  3. Esegui il push del progetto Looker in un repository Git.
  4. Testa la funzionalità della visualizzazione.
  5. Invia la visualizzazione a Looker.

Sviluppo di un tipo di visualizzazione

Identifica un tipo di visualizzazione che vuoi sviluppare. Verifica che questa visualizzazione non sia già elencata nel Marketplace o come visualizzazione nativa di Looker.

Sviluppa la tua visualizzazione personalizzata in JavaScript utilizzando l'API Looker View con il tuo ambiente JavaScript.

Creazione di un progetto Looker per la visualizzazione

Crea un progetto Looker per rappresentare la tua visualizzazione personalizzata. Il progetto deve contenere i seguenti file:

  • File LICENSE: elenca le licenze con cui viene distribuita la visualizzazione, utilizzando il testo
    "Questa visualizzazione di Looker è distribuita con la seguente licenza:...".

  • File README.md: fornisce una descrizione della visualizzazione, il suo funzionamento e qualsiasi informazione aggiuntiva.

  • File JavaScript (.js): contiene una versione ridotta del codice JavaScript che hai utilizzato per produrre la visualizzazione. Con Marketplace, i file JS sono inclusi nel progetto, il che consente un controllo delle versioni e una gestione dei pacchetti adeguati.

  • File manifest (manifest.lkml): specifica un id (un identificatore univoco) e un label (mostrati nell'interfaccia utente di Looker per questa visualizzazione). Ad esempio:

    constant: vis_id {
        value: "default_id"
        export: override_optional
    }
    constant: vis_label {
        value: "default_label"
        export: override_optional
    }
    visualization: {
        id: "@{vis_id}"
        label: "@{vis_label}"
        file: "my_local.js"
        sri_hash: "my_sri_hash"
        dependencies: []
    }
  • File elenco (marketplace.json): consente di configurare la scheda del Marketplace per la visualizzazione personalizzata e include un'etichetta relativa alla modalità di visualizzazione della pagina nel Marketplace, la posizione dello image_uri, uno slogan che descrive il caso d'uso della visualizzazione e definisce anche le costanti dei campi del marketplace inseriti dagli utenti durante l'installazione. Ad esempio:
{
  "label": "Gauge Visualization",
  "category_label": "plug-ins",
  "branding": {
    "image_uri": "https://marketplace-api.looker.com/visualization-screenshots/gauge_icon.png",
    "tagline": "Use the Gauge visualization to display a measure and progress to a goal."
  },
   "constants": {
        "vis_label": {
            "label": "Visualization Label",
            "description": "This label will appear in the visualization selector in the Looker Explore UI."
        },
        "vis_id": {
            "label": "Visualization Id",
            "description": "This must be a unique ID across all visualizations.",
            "value_constraint": "visualization"
        }
    }
}

Trasferimento del progetto a Git

Ospita la tua visualizzazione LookML in un repository GitHub accessibile pubblicamente. Se hai creato la visualizzazione in un progetto Looker, segui questi passaggi per eseguirne il push in un nuovo repository:

  1. Crea un repository GitHub accessibile pubblicamente.
  2. Imposta l'URL del repository di progetto Looker sull'URL del repository GitHub.
  3. Segui le istruzioni Git in Looker per convalidare, eseguire il commit e il deployment del codice in produzione.

Test della funzionalità di visualizzazione

Testa la nuova visualizzazione applicandola a un'esplorazione o a un aspetto appropriati sulla tua istanza di Looker:

  1. Vai al Look o Esplora.
  2. Se ti trovi in un look, fai clic su Modifica per modificare il look.
  3. Fai clic sul menu con tre puntini nel menu Tipo di visualizzazione per aprire l'elenco a discesa delle visualizzazioni.
  4. Seleziona la visualizzazione personalizzata.
  5. Fai clic su Salva per salvare la modifica al Look. Tieni presente qualsiasi dashboard che potrebbe essere interessata da questa modifica.

Looker richiede queste funzioni nelle visualizzazioni disponibili da Looker Marketplace:

Funzione Obbligatoria
Supporto per la visualizzazione in dettaglio Sì
Possibilità di ereditare le tavolozze dei colori di Looker Sì
Reattività alle dimensioni del browser e dello schermo Sì
Famiglia di caratteri coerente: font-family: Helvetica, Arial, sans-serif Sì
Dimensionamento carattere Sì
Possibilità di attivare/disattivare le etichette dei valori e le etichette dell'asse nel riquadro di configurazione della visualizzazione. Sì
Visualizzazione dei dati sottoposti a pivot Sì (se applicabile)
Aggiornamenti della visualizzazione basati sull'interattività degli utenti utilizzando la funzione updateAsync o is update function Sì
Cancella i messaggi di errore (ad esempio, Questa visualizzazione richiede una dimensione e due misure) Sì
Tutte le opzioni nel riquadro di configurazione della visualizzazione apportano una modifica apparente alla visualizzazione Sì
Utilizzare la formattazione value del campo per impostazione predefinita Sì (se applicabile)
Viene restituito un errore quando una query non restituisce risultati Sì

Inviare la visualizzazione per la revisione

Quando la visualizzazione è pronta per essere inviata, segui le istruzioni sull'invio di contenuti a Looker Marketplace per creare la relativa documentazione di supporto, inviala al team di Looker per la revisione e pubblicala su Looker Marketplace.