Personalizzazione dei blocchi di Looker Marketplace

I Looker Blocks sono modelli di dati predefiniti per pattern di analisi e origini dati comuni. Questa pagina descrive in che modo gli sviluppatori possono personalizzare i Looker Blocks installati da Looker Marketplace. Il Looker Marketplace è una piattaforma centralizzata per trovare, eseguire il deployment e gestire molti tipi di contenuti Looker, come applicazioni, visualizzazioni e plug-in.

Per ulteriori informazioni su tutti i Looker Blocks disponibili e sui metodi alternativi di personalizzazione dei blocchi, consulta la pagina della documentazione relativa ai Looker Blocks.

Requisiti per l'installazione e la gestione dei Looker Blocks da Looker Marketplace

Prima di poter installare e utilizzare alcuni blocchi di Looker Marketplace, tieni presente i seguenti requisiti:

  • Se installi il blocco tramite Looker Marketplace, l'amministratore di Looker deve abilitare la funzionalità Marketplace.
  • Gli utenti devono disporre delle autorizzazioni develop, manage_models e deploy per installare e gestire i pacchetti da Marketplace.
  • Se il blocco specifico contiene un parametro local_dependency, utilizza il processo di importazione del progetto locale. Per informazioni dettagliate sull'importazione dei progetti, consulta la pagina di documentazione Importazione di file da altri progetti. I seguenti blocchi contengono un parametro local_dependency:

    • Analisi di marketing digitale
    • Analisi delle vendite
    • Analisi web

Consulta la pagina della documentazione di Looker Marketplace per informazioni sull'installazione e la gestione dei Looker Blocks da Looker Marketplace.

Accedere al codice LookML per un blocco Marketplace

I blocchi basati su progetti che utilizzano perfezionamenti vengono installati da Marketplace come un unico progetto CONFIG modificabile che importa da remoto il progetto CORE, che contiene tutto il codice LookML e la parametrizzazione costante.

Una volta installato un blocco dal Marketplace, puoi accedere al relativo progetto dal menu Sviluppa facendo clic sul nome del progetto nell'elenco dei progetti. Il nome di un blocco di perfezionamenti di Marketplace è in genere preceduto da marketplace_ seguito dall'ID scheda.

Anche se non puoi modificare direttamente un progetto CORE di sola lettura di un blocco, ti consigliamo di utilizzare il codice LookML definito nei file CORE di sola lettura del blocco come riferimento quando personalizzi i file CONFIG del blocco. Puoi visualizzare i file CORE del blocco andando ai file di progetto del blocco nell'IDE ed espandendo la directory imported_projects nel browser dei file dell'IDE.

Struttura del file di blocco

Quando installi un blocco creato per i perfezionamenti, questi file vengono creati automaticamente nell'ambito della parte CONFIG del progetto del blocco:

Nome del file Accesso Funzione
<model_name>.model.lkml Sola lettura per tutti gli utenti File del modello virtuale collegato all'installazione del blocco; gestisce l'importazione di tutti i modelli dal progetto CORE del blocco. Quando un blocco viene disinstallato o aggiornato, i file o i file del modello associati vengono eliminati, evitando conflitti tra più installazioni di blocchi.
manifest.lkml Modificabile per gli utenti con autorizzazioni develop Descrive il progetto e le relative dipendenze esterne. Contiene l'ID scheda Marketplace per il blocco dell'installazione e facilita l'importazione remota dei file di progetto CORE del blocco tramite la parola chiave marketplace.
marketplace_lock.lkml Sola lettura per tutti gli utenti Contiene un riferimento alla parola chiave marketplace_ref del file manifest che gestisce l'importazione remota del progetto CORE. Fornisce le informazioni specifiche su scheda, versione e modello associate all'installazione. Contiene informazioni sulle costanti configurate durante l'installazione (e che possono essere aggiornate utilizzando l'opzione Gestisci nell'interfaccia utente di Marketplace).
refinements.lkml Modificabile per gli utenti con autorizzazioni develop Consente agli sviluppatori di perfezionare le visualizzazioni e le esplorazioni definite nei file di progetto CORE importati.

Personalizzare un blocco del marketplace

Attiva la modalità di sviluppo per apportare personalizzazioni ai file modificabili del blocco.

Se disponi delle autorizzazioni develop, puoi personalizzare il codice LookML nel file refinements.lkml del progetto CONFIG del blocco. Puoi perfezionare le visualizzazioni e le esplorazioni già definite nel progetto CORE del blocco o persino aggiungere nuove visualizzazioni ed esplorazioni non ancora definite nel progetto CORE. Tutto ciò che è possibile con i miglioramenti LookML in altri progetti LookML è possibile nel file refinements.lkml del blocco. La combinazione del perfezionamento e del codice LookML originale si comporta come se fosse il codice LookML originale dell'oggetto.

Puoi anche apportare modifiche al file manifest.lkml del progetto CONFIG per specificare le dipendenze che devono essere acquisite per quel blocco.

Non sei limitato alla modifica di questi file per ottenere le personalizzazioni che desideri. Puoi anche creare nuovi file nel progetto CONFIG. Assicurati solo di include tutti i nuovi file nel file refinements.lkml.

Personalizzare il file di perfezionamento

Se disponi delle autorizzazioni develop, puoi aggiungere LookML personalizzato al progetto CONFIG per combinare dati aggiuntivi o modificare il modello analitico principale del blocco. Puoi creare nuove visualizzazioni e unirle agli Explore esistenti, definire nuovi campi o ridefinire quelli esistenti oppure applicare etichette in base alle esigenze per creare un modello per l'analisi che vuoi fornire. Se hai creato nuovi file nel progetto CONFIG, devi include nel file di perfezionamento.

Ad esempio, supponiamo di aver installato un blocco e che il relativo file refinements.lkml contenga il seguente codice LookML:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

dove listing_id è il valore del parametro listing del file manifest.lkml.

Puoi utilizzare i perfezionamenti per aggiungere una nuova dimensione a una visualizzazione chiamata flights:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

view: +flights {
  dimension: air_carrier {
    type: string
    sql: ${TABLE}.air_carrier ;;
  }
}

In alternativa, puoi applicare un'etichetta a un'esplorazione chiamata aircraft in modo che venga visualizzata nell'interfaccia utente come Aeromobili semplificati:

include: "//<listing_id>/**/*.view.lkml"
include: "//<listing_id>/**/*.explore.lkml"

explore: +aircraft {
  label: "Aircraft Simplified"
}

Il file refinements.lkml viene incluso automaticamente nel file del modello "virtuale" del blocco, che importa essenzialmente i modelli dal progetto CORE.

Per ulteriori informazioni su questo argomento avanzato, consulta la documentazione sui miglioramenti di LookML.

Personalizzare il file manifest modificabile

Nei blocchi che utilizzano perfezionamenti, sia il progetto CORE che quello CONFIG hanno file manifest; tuttavia, solo il file manifest del progetto CONFIG è modificabile.

Puoi modificare il file CONFIG manifest.lkml per aggiungere parametri del progetto a quelli già presenti nel file manifest del progetto CORE. Ad esempio, puoi aggiungere un local_dependency per unire il tuo blocco a un altro blocco nella stessa istanza Looker.

Aggiornamento dei valori per le costanti

Le costanti del blocco sono definite nel file manifest del progetto CORE importato. L'override del valore di una costante, se consentito, deve essere eseguito nell'interfaccia utente del Marketplace durante la configurazione o aggiornando il blocco. Per aggiornare un blocco, gli utenti devono disporre delle autorizzazioni develop, manage_models e deploy.

Per sostituire il valore di una costante aggiornando un blocco:

  1. In Looker Marketplace, vai al blocco che vuoi aggiornare.
  2. Fai clic sul pulsante Gestisci.
  3. Accanto al nome del blocco da aggiornare, fai clic sull'icona a forma di ingranaggio. Si apre la finestra di configurazione del blocco.
  4. Modifica i valori costanti in base alle esigenze.
  5. Fai clic su Aggiorna per chiudere la finestra di configurazione del blocco e aggiornare il blocco con le modifiche.

Le modifiche vengono applicate al file marketplace_lock.lkml di sola lettura nel progetto installato.

Mantenere le personalizzazioni di un blocco del Marketplace che utilizza extends

Alcuni dei blocchi disponibili in Looker Marketplace sono composti da progetti che utilizzano l'estensione extends di LookML. Looker sta convertendo tutti i blocchi del Marketplace per le istanze su Looker 21.8 o versioni successive in una struttura di progetto che utilizza i miglioramenti di LookML e rimuoverà il supporto per i blocchi basati su extends.

Looker consiglia di installare la versione basata sui perfezionamenti di tutti i blocchi di Marketplace presenti nell'istanza man mano che diventano disponibili, sostituendo i blocchi creati con extends. Sebbene questa procedura di sostituzione sia semplice (puoi installare il nuovo blocco (miglioramenti) dall'elenco dei blocchi di Looker Marketplace e disinstallare il blocco originale (estensioni) nella pagina Gestisci di Looker Marketplace), non verranno conservate le personalizzazioni apportate al blocco creato con extends. Inoltre, Looker non trasferirà dal blocco originale al nuovo blocco alcun contenuto o funzione di Looker basati su questi contenuti, come dashboard, esplorazioni, invii di contenuti programmati e avvisi.

Questa sezione descrive come conservare le personalizzazioni di un blocco creato con progetti che utilizzano extends, altrimenti difficili o dispendiose da replicare da zero.

Per conservare le personalizzazioni del blocco, un utente con la possibilità di installare e gestire i pacchetti dal Marketplace deve eseguire i seguenti passaggi:

  1. Aggiorna il progetto CONFIG del blocco originale per prepararti alla migrazione
  2. Installare la nuova versione del blocco da Looker Marketplace
  3. Trasferire le personalizzazioni al nuovo blocco Marketplace
  4. Ricreare i contenuti di Looker in base al blocco originale
  5. Disinstalla la versione del blocco creata con extends

Aggiornamento di un blocco personalizzato in preparazione alla migrazione

Questa sezione descrive come aggiornare i file di progetto chiave in un blocco creato con extends in modo da poter copiare le personalizzazioni del blocco in una nuova versione del blocco basata sui perfezionamenti. Un blocco basato su un progetto che utilizza extends viene installato da Marketplace come progetto CORE di sola lettura e progetto CONFIG modificabile.

  1. Vai al progetto CONFIG del blocco dalla sezione Sviluppo in uno dei seguenti modi:

    • Fai clic sull'opzione Progetti e poi sul nome del progetto.
    • Fai clic sul nome del progetto CONFIG del blocco nell'elenco dei progetti.

    I nomi dei progetti CONFIG in genere terminano con _config, mentre il nome del progetto CORE in genere non ha un suffisso.

  2. Apri il file del modello del progetto, che potrebbe essere simile a questo:


    explore: ga_sessions_config {
      extends: [ga_sessions_core]
      extension: required
      join: user_sales_data {
        sql_on: ${user_sales_data.full_visitor_id} = ${ga_sessions.full_visitor_id} ;;
      }
      join: sales__by__category {
        sql: LEFT JOIN UNNEST(${user_sales_data.sales_by_category}) as sales__by__category;;
      }
    }

    explore: future_input_config {
      extends: [future_input_core]
      extension: required
      join: future_purchase_prediction {
        type: left_outer
        sql_on: ${future_input.full_visitor_id} = ${future_purchase_prediction.full_visitor_id} ;;
        relationship: one_to_one
      }
    }

  1. In Modalità di sviluppo, segui questi passaggi:

    1. Elimina le intere righe extends e extension.
    2. Elimina _config dai nomi di explore.
    3. Aggiungi + ai nomi di explore.

    L'esempio precedente di file del modello avrebbe il seguente aspetto:


    explore: +ga_sessions {
      join: user_sales_data {
        sql_on: ${user_sales_data.full_visitor_id} = ${ga_sessions.full_visitor_id} ;;
      }
      join: sales__by__category {
        sql: LEFT JOIN UNNEST(${user_sales_data.sales_by_category}) as sales__by__category;;
      }
    }

    explore: +future_input {
      join: future_purchase_prediction {
        type: left_outer
        sql_on: ${future_input.full_visitor_id} = ${future_purchase_prediction.full_visitor_id} ;;
        relationship: one_to_one
      }
    }

  1. Copia e conserva i contenuti di questo file per un passaggio successivo.

Installazione del nuovo blocco Marketplace

Un blocco basato su un progetto che utilizza perfezionamenti viene installato da Marketplace come un singolo progetto LookML modificabile che importa da remoto il progetto contenente tutti i parametri LookML e costanti.

  1. Seleziona l'icona del negozio nella barra dei menu di Looker per andare al Looker Marketplace.
  2. Fai clic sulla scheda del nuovo blocco Marketplace basato sui perfezionamenti. Questo blocco ha lo stesso nome del blocco esistente creato con extends.
  3. Fai clic su Installa per installare il nuovo blocco. Una volta installato questo blocco, vedrai due schede identiche nella pagina Gestisci di Looker Marketplace.

Trasferimento delle personalizzazioni al nuovo blocco del marketplace

Questa sezione descrive come trasferire gli aggiornamenti apportati al blocco originale (estensioni) nel nuovo blocco (miglioramenti).

  1. Nella sezione Sviluppa, apri il progetto del nuovo blocco in uno dei seguenti modi:

    • Fai clic sull'opzione Progetti e poi sul nome del progetto.
    • Fai clic sul nome del progetto del blocco nell'elenco dei progetti.

    Il nome di un blocco di perfezionamenti di Marketplace è in genere preceduto da marketplace_ seguito dall'ID scheda.

  2. Nel file refinements.lkml, incolla i contenuti aggiornati dal file del modello del blocco originale (esteso). Assicurati di conservare tutte le dichiarazioni include già presenti nel file di perfezionamenti.

Ricreare i contenuti di Looker in base al blocco originale

Il passaggio finale per l'adozione della versione basata sui perfezionamenti di un blocco Marketplace consiste nel disinstallare la versione originale basata sulle estensioni del blocco. Alcuni blocchi basati su extends contengono dashboard e esplorazioni LookML predefinite. Se gli utenti hanno creato avvisi o distribuzioni pianificate basati su dashboard LookML definite nel blocco originale (extends), questi avvisi o pianificazioni verranno disattivati o non riusciranno, rispettivamente, una volta disinstallato il blocco da Looker Marketplace.

Devi ricreare questi avvisi o queste distribuzioni pianificate nelle dashboard LookML del nuovo blocco (miglioramenti). Gli amministratori di Looker e gli utenti con le autorizzazioni appropriate per pianificazioni e avvisi possono utilizzare le pagine Avvisi e pianificazioni nella sezione di amministrazione per cercare i nomi delle dashboard del blocco (extends) e poi creare nuovi avvisi o consegne pianificate in base alle esigenze nelle dashboard corrispondenti del blocco (refinements).

Devi anche modificare tutti gli altri contenuti di Looker che fanno riferimento agli Explore o ai prospetti LookML del blocco originale (estensioni) in modo che puntino al nuovo blocco (miglioramenti), se necessario.

Disinstallazione del blocco originale

Per disinstallare la versione del blocco creata con extends:

  1. Seleziona l'icona del negozio nella barra dei menu di Looker per andare al Looker Marketplace.

  2. In Looker Marketplace, seleziona Gestisci nel menu di navigazione a sinistra per aprire la pagina Gestisci.

  3. Nella pagina Gestisci, fai clic sull'icona del cestino per disinstallare il blocco originale (esteso). Puoi distinguere l'elenco dei blocchi estesi dall'elenco dei blocchi dei perfezionamenti esaminando i numeri di versione. Il blocco extends sarà una versione principale precedente al blocco refinements. Ad esempio, il blocco extends potrebbe essere la versione 1.0.4 e il blocco refinements potrebbe essere la versione 2.0.0.

Risoluzione dei problemi relativi a un blocco

Se un blocco Marketplace mostra errori, è possibile che lo schema non corrisponda alla struttura del blocco.

Ti consigliamo inoltre di verificare che le costanti fornite durante l'installazione del blocco, che rappresentano la connessione, il database o lo schema del blocco, siano state definite correttamente. A questo scopo, procedi nel seguente modo:

  1. Seleziona l'icona del negozio nella barra dei menu di Looker per andare al Looker Marketplace.

  2. In Looker Marketplace, seleziona Gestisci nel pannello di navigazione principale per aprire la pagina Gestisci.

  3. Nella pagina Gestisci, fai clic sull'icona a forma di ingranaggio del blocco per visualizzare le impostazioni di configurazione.

  4. Nella finestra Aggiorna configurazioni, verifica che il blocco sia configurato correttamente. Fai clic su Aggiorna dopo aver apportato le modifiche per salvare gli aggiornamenti e chiudere la finestra di configurazione del blocco.