Condivisione di dati tramite un hub azioni

Oltre a caricare contenuti nelle destinazioni integrate di Looker, puoi utilizzare le azioni, denominate anche integrazioni, per inviare contenuti a servizi di terze parti integrati con Looker tramite un server hub azioni.

Questa pagina illustra le opzioni per creare azioni personalizzate che puoi richiedere aggiungere all'hub azioni di Looker o al tuo server hub azioni privato. In questa pagina viene inoltre descritto come avviare un server hub azioni locale per testare le tue azioni personalizzate o eseguire un server hub azioni privato.

Per iniziare a utilizzare le azioni, puoi:

Dopo aver aggiunto l'azione all'hub delle azioni, un amministratore di Looker può enable l'azione per l'invio di contenuti di Looker a questi servizi.

Puoi anche configurare più hub azioni se vuoi utilizzare le integrazioni di Looker tramite l'hub azioni di Looker e ospitare azioni private o personalizzate. Le azioni relative a ciascun hub azioni vengono visualizzate nella pagina Azioni del riquadro Amministrazione.

Hub azioni di Looker

Looker ospita e fornisce Looker Action Hub, un server stateless che implementa l'API Action di Looker ed espone azioni popolari. Tutti i dati inviati dagli utenti mediante un'azione verranno elaborati temporaneamente sul server Action Hub di Looker anziché nell'istanza di Looker.

Looker è già integrato con diversi servizi. Per informazioni su come attivare questi servizi esistenti, consulta la pagina della documentazione Impostazioni amministratore - Azioni.

Requisiti dell'Action Hub di Looker

L'hub azioni di Looker deve essere in grado di inviare e ricevere richieste API nei seguenti modi:

Se il deployment di Looker non può soddisfare queste richieste o se la funzionalità Lista consentita IP è abilitata nell'istanza di Looker, valuta la possibilità di configurare un server hub azioni locale per pubblicare integrazioni Looker private o azioni personalizzate. Gli amministratori di istanze ospitate dal cliente possono anche eseguire il deployment di un server di azioni locale specifico per OAuth e azioni di streaming.

Richieste dall'istanza Looker alla rete di Action Hub di Looker

Le richieste a actions.looker.com vengono risolte in un indirizzo IP dinamico. Le richieste in uscita dall'istanza di Looker devono poter raggiungere i seguenti endpoint:

actions.looker.com/
actions.looker.com/actions/<name>/execute
actions.looker.com/actions/<name>/form

dove name è il nome programmatico dell'azione.

Richieste dal browser dell'utente Looker alla rete dell'hub azioni di Looker

Il browser dell'utente di Looker deve essere in grado di effettuare richieste ai seguenti endpoint dell'hub azioni di Looker (per OAuth):

actions.looker.com/actions/<name>/oauth

dove name è il nome programmatico dell'azione.

Richieste dalla rete Action Hub di Looker all'istanza di Looker

L'hub azioni di Looker deve effettuare richieste all'istanza di Looker per azioni che supportano risultati in streaming o che utilizzano OAuth.

Un'azione di inserimento flussi consente all'azione di consumare query che restituiscono Tutti i risultati. Le azioni abilitate per OAuth utilizzano l'autenticazione per utente tramite i flussi OAuth 2.0. Le azioni OAuth devono archiviare le credenziali utente nell'istanza di Looker di origine poiché l'hub azioni di Looker è stateless e multi-tenant e non archivierà credenziali specifiche dell'utente di alcun tipo.

Le richieste dall'hub azioni di Looker a un'istanza di Looker hanno il seguente formato:

GET <host_looker_url>/downloads/<random_40_char_token>
POST <host_looker_url>/action_hub_state/<random_40_char_token>

Questi URL vengono generati nell'istanza di Looker, prima di essere inviati all'hub azioni di Looker. Per questo motivo, l'hub azioni di Looker deve essere in grado di risolvere <host_looker_url> in un indirizzo IP e di effettuare richieste nella rete in cui risiede l'istanza di Looker.

L'hub azioni di Looker ha indirizzi IP in uscita statici da cui provengono sempre le richieste: 35.153.89.114, 104.196.138.163 e 35.169.42.87. Gli amministratori delle istanze ospitate da Looker che hanno abilitato la lista consentita IP devono aggiungere questi indirizzi IP per utilizzare le azioni che supportano i risultati trasmessi in streaming o utilizzano OAuth.

Considerazioni sulle istanze ospitate dal cliente

Per utilizzare le integrazioni di Looker, l'hub azioni di Looker deve essere in grado di comunicare con l'istanza di Looker e soddisfare questi requisiti. Questo non è sempre possibile con le istanze Looker ospitate dal cliente, per vari motivi. Se la comunicazione bidirezionale tra l'hub azioni di Looker e l'istanza di Looker non è possibile, quest'ultimo potrebbe presentare comportamenti imprevisti o indesiderati, come query sospese o azioni non disponibili.

Per risolvere il potenziale problema di mancata comunicazione dell'hub azioni di Looker con l'istanza di Looker, gli amministratori di Looker possono implementare una delle soluzioni mostrate più avanti in questa pagina. La soluzione o combinazione di soluzioni appropriate dipende dall'architettura dell'istanza di Looker:

  • Se l'istanza ospitata dal cliente non è risolvibile dall'Action Hub di Looker, ovvero non può ricevere richieste dall'istanza di Looker, gli amministratori di Looker possono contattare un esperto delle vendite di Google Cloud per attivare la funzionalità della licenza public_host_url. Questa funzionalità di licenza mostra l'opzione di avvio --public-host-url, che consente agli amministratori di specificare un nome host <public_host_url> risolvibile diverso dall'istanza <host_looker_url>. public_host_url sostituisce il nome host per alcuni URL di callback specifici di Looker Action Hub e indirizza questi URL di callback tramite un proxy inverso che ha public_host_url come nome risolvibile pubblicamente. Questo proxy inverso accetta le richieste solo da indirizzi IP in uscita statici per l'hub azioni di Looker. Gli amministratori di Looker che utilizzano questo metodo devono aggiungere alla lista consentita gli indirizzi IP in uscita da cui l'hub azioni di Looker invia richieste all'istanza di Looker: 35.153.89.114, 104.196.138.163 e 35.169.42.87.

  • Se l'URL dell'istanza ospitata dal cliente è risolvibile dall'istanza di Looker, ma l'hub azioni di Looker non può inviare richieste all'istanza di Looker, gli utenti potrebbero non essere in grado di configurare o utilizzare azioni che supportino i risultati di flussi o che utilizzano OAuth. Per risolvere questo problema, gli amministratori di Looker devono aggiungere alla lista consentita gli indirizzi IP in uscita da cui l'hub azioni di Looker invia richieste all'istanza di Looker: 35.153.89.114, 104.196.138.163 e 35.169.42.87.

  • Se nessuna delle soluzioni indicate sopra è appropriata per l'architettura dell'istanza di Looker, gli amministratori di Looker possono eseguire il deployment di un hub azioni ospitato dal cliente per tutte le azioni o solo per quelle che supportano i risultati in streaming o utilizzano OAuth.

  • Per eseguire il deployment di un hub azioni ospitato dal cliente, devi assicurarti che il file JAR sia ospitato su un server pubblico in modo che l'hub azioni di Looker possa comunicare con questo. Tuttavia, questa soluzione non è consigliata.

Inoltre, le azioni OAuth e di inserimento di flussi potrebbero non essere utilizzabili su un'istanza Looker ospitata dal cliente se l'istanza utilizza un certificato SSL emesso da un'autorità di certificazione (CA) non presente in questo elenco di certificati radice.

Creazione di un'azione personalizzata

Questa sezione descrive i passaggi da seguire per scrivere e testare un'azione personalizzata utilizzando il codice sorgente dell'hub azioni di Looker. Per visualizzare esempi di codice funzionali, controlla le azioni esistenti nel repository looker-open-source/actions in GitHub.

Per creare un'azione personalizzata:

  1. Configurazione di un repository di sviluppo
  2. Scrivere l'azione
  3. Verificare l'azione
  4. Pubblicazione e attivazione dell'azione nell'hub azioni di Looker o sul tuo server hub azioni privato.

Come per qualsiasi azione, potrebbe essere necessario configurare i modelli LookML con parametri specifici prima di poter utilizzare l'azione per inviare i dati.

Configurazione di un repository di sviluppo

Looker Action Hub è un server Node.js scritto in TypeScript, un piccolo livello superiore al moderno codice JavaScript che aggiunge informazioni sul tipo per individuare gli errori di programmazione. Se hai familiarità con JavaScript, la maggior parte del linguaggio TypeScript dovrebbe esserti familiare.

L'esecuzione di Looker Action Hub richiede il seguente software:

  • Node.js
  • Gestore delle versioni dei nodi (NVM, per selezionare la versione di Node.js adeguata)
  • Yarn (per gestire le dipendenze)

Una volta installato il software richiesto, puoi configurare l'ambiente di sviluppo. L'esempio seguente utilizza Git.

  1. Clona il repository looker-open-source/actions localmente:

    git clone git@github.com:looker-open-source/actions.git

  2. Crea una directory con il nome dell'azione nella directory actions/src/actions. Ad esempio:

    mkdir actions/src/actions/my_action

  3. Inizia a completare la directory con i file necessari per eseguire l'azione. Consulta il repository GitHub di azioni per una struttura di file di esempio.

Looker consiglia di aggiungere anche quanto segue:

  • Un file README per spiegare lo scopo e i mezzi di autenticazione per l'azione
  • Un'icona PNG da visualizzare nell'hub azioni di Looker (o nell'hub di azioni privato sulla tua istanza Looker) e nelle finestre di consegna dei dati di Looker.
  • I file per i test che vuoi eseguire sul codice di azione, poiché sono diversi dal test dell'azione.

Scrivere un'azione

Un requisito di progettazione per il server Looker Action Hub è che rimanga completamente stateless, per cui non è consentito archiviare qualsiasi informazione nell'applicazione o nel servizio di azione. Tutte le informazioni necessarie per completare l'azione devono essere fornite nelle chiamate di richiesta del file di azione.

I contenuti esatti del file delle azioni variano a seconda del servizio, del tipo o del livello a cui opera l'azione e dei dati o dei formati di visualizzazione che devono essere specificati. L'azione può anche essere configurata per i flussi di autorizzazione OAuth 2.0.

I file di azione si basano sul metodo API /execute. Le richieste API Looker vengono passate con DataActionRequest ogni volta che un utente esegue l'azione in Looker. L'oggetto DataActionRequest contiene tutti i dati e i metadati necessari per eseguire l'azione. È disponibile anche un metodo /form, che può essere utilizzato per raccogliere ulteriori informazioni dall'utente prima che esegua l'azione. I campi specificati in /form verranno visualizzati nel popup Invia o Pianifica quando gli utenti selezionano l'azione come destinazione per l'invio dei dati.

Quando scrivi il file delle azioni, includi almeno i seguenti parametri contrassegnati come Obbligatorio nella definizione dell'azione:

Parametro Obbligatorio Descrizione Tipo di dati
name Sì Un nome univoco per l'azione. Deve essere univoco in tutte le azioni nell'hub azioni di Looker. string
url Sì Un URL assoluto dell'endpoint /execute per questa azione. string
label Sì Un'etichetta leggibile per l'azione. string
supportedActionTypes Sì Un elenco dei tipi di azioni supportati dall'azione. I valori validi sono "cell", "query" e "dashboard". string
formURL No Un URL assoluto dell'endpoint /form per questa azione. string
description No Descrizione dell'azione. string
params No Array di parameters per l'azione. Includi nome, etichetta e descrizione in formato stringa per ogni parametro. Questi sono i campi che vengono visualizzati nella pagina di attivazione dell'azione nel riquadro Amministrazione. Per gestire il modo in cui gli utenti possono inviare dati a una destinazione di azione, puoi specificare un attributo utente per il quale l'utente deve avere un valore definito. parameters
supportedFormats No Un elenco dei formati di dati supportati dall'azione. I valori validi sono "txt", "csv", "inline_json", "json" e "json_detail", "json_detail_lite_stream", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", and "wysiwyg_png". string
supportedFormattings No Un elenco di opzioni di formattazione supportate dall'azione. I valori validi sono "formatted" e "unformatted". string
supportedVisualizationFormattings No Un elenco di opzioni di formattazione di visualizzazione supportate dall'azione. I valori validi sono "apply" e "noapply". string
iconName No Un URI dati che rappresenta un'immagine icona per l'azione. string
requiredFields No Un elenco di descrizioni dei campi obbligatori con cui è compatibile questa azione. Se l'elenco contiene più voci, l'azione richiede più di un campo. RequiredField
supportedDownloadSettings No Un valore booleano che determina se all'azione verrà inviato un URL di download utilizzabile una sola volta per facilitare lo streaming illimitato di dati. Il parametro viene impostato dal parametro usesStreaming, che è un valore booleano true/false. Se usesStreaming = true, allora supportedDownloadSettings = url. Se usesStreaming = false, allora supportedDownloadSettings = push. Booleano
usesOAuth No Un valore booleano che determina se l'azione è un'azione OAuth. Questa operazione determinerà se all'azione verrà inviato un link monouso per poter impostare state per un utente specifico per questa azione. Booleano
usesStreaming No Un valore booleano che determina se l'azione supporta i risultati delle query in streaming. Seleziona la colonna Utilizza flussi di dati (Sì/No) nell'elenco dei servizi integrati. Le azioni che trasmettono risultati in streaming possono richiedere la configurazione di un server hub azioni locale. Per ulteriori informazioni, consulta la pagina Configurare un hub di azioni locale per azioni che utilizzano OAuth o flussi di dati per ulteriori informazioni. Booleano
minimumSupportedVersion No La versione minima di Looker in cui l'azione verrà visualizzata nell'elenco dell'hub azioni del riquadro Amministrazione. string

Gli esempi di azioni dell'hub azioni di Looker sono disponibili su GitHub come riferimento.

Tipi di azioni supportati

Looker supporta tre tipi di azioni, come specificato nel parametro supportedActionTypes dell'azione: query, cella e dashboard.

  • Un'azione a livello di query: è un'azione che invia un'intera query. L'azione di segmento, ad esempio, è un'azione a livello di query.
  • Un'azione a livello di cella: un'azione a livello di cella invia il valore di una singola cella specifica in una tabella di dati. Questo tipo di azione è diverso dalle azioni sui dati, che possono essere definite per dimensioni o misure utilizzando il parametro action. Per inviare informazioni da una cella specifica all'interno di una tabella, Looker utilizza i tag per mappare le azioni alle celle corrispondenti. Le azioni devono specificare quali tag supportano in requiredFields. Per mappare azioni e campi, i campi in LookML devono specificare a quali tag sono mappati con il parametro tags di LookML. Ad esempio, l'azione Twilio Message utilizza un tag phone per consentire agli sviluppatori LookML di controllare su quali campi del numero di telefono verrà visualizzata l'azione Twilio.
  • Un'azione a livello di dashboard:un'azione a livello di dashboard supporta l'invio dell'immagine di una dashboard. Ad esempio, l'azione SendGrid invia le immagini della dashboard via email.

Aggiungere attributi utente alle azioni personalizzate

Per le azioni personalizzate, puoi aggiungere attributi utente nel parametro params del file di azioni. Se il parametro è obbligatorio, per ogni utente deve essere definito un valore per questo attributo nel proprio account utente o per un gruppo di utenti a cui appartiene, oltre all'autorizzazione send_to_integration, per visualizzare l'azione come opzione di destinazione quando si inviano o pianificano contenuti.

Per aggiungere un attributo utente all'azione:

  1. Un amministratore di Looker potrebbe dover creare l'attributo utente corrispondente a user_attribute_param, se non esiste già.
  2. Definisci un valore valido per l'attributo utente per gli utenti o i gruppi di utenti che devono pubblicare contenuti nella destinazione dell'azione. Questi utenti devono disporre anche delle autorizzazioni send_to_integration.
  3. Il parametro params rappresenta i campi del modulo che un amministratore di Looker deve configurare nella pagina di abilitazione dell'azione dall'elenco Azioni nel riquadro Amministrazione. Nel parametro params del file di azioni, includi quanto segue:
  params = [{
    description: "A description of the param.",
    label: "A label for the param.",
    name: "action_param_name",
    user_attribute_name: "user_attribute_name",
    required: true,
    sensitive: true,
  }]

dove user_attribute_name è l'attributo utente definito nel campo Nome della pagina Attributi utente della sezione Utenti del pannello Amministrazione, required: true indica che un utente deve avere definito un valore valido e non null per quell'attributo per vedere l'azione quando vengono inviati i dati, mentre sensitive: true indica che l'attributo utente è criptato e non viene mai visualizzato nella UI di Looker una volta inserito. Puoi specificare più sottoparametri di attributi utente.

  1. Esegui il deployment degli aggiornamenti nel server hub azioni.
    • Se aggiungi una nuova azione, un amministratore di Looker dovrà abilitarla facendo clic sul pulsante Attiva accanto all'azione nella pagina Azioni del riquadro Amministrazione.
    • Se stai aggiornando un'azione esistente, aggiorna l'elenco delle azioni facendo clic sul pulsante Aggiorna. Quindi, fai clic sul pulsante Impostazioni.
  2. Nella pagina di abilitazione/impostazioni delle azioni, un amministratore di Looker deve configurare i campi del modulo dell'azione in modo da estrarre informazioni dall'attributo utente facendo clic sull'icona dell'attributo utente a destra del campo appropriato e selezionando l'attributo utente desiderato.

Parametri requiredField nelle azioni a livello di cella

Per le azioni a livello di cella, puoi configurare i campi LookML del tuo modello in modo da fornire dati a quella destinazione dell'azione specificando i tag supportati dall'azione nel parametro requiredFields del file delle azioni.

Parametro Obbligatorio Descrizione Tipo di dati
tag No Se presente, corrisponde a un campo con questo tag. string
any_tag No Se presente, sostituisce tag e corrisponde a un campo che contiene uno dei tag forniti. string
all_tags No Se presente, sostituisce tag e corrisponde a un campo con tutti i tag forniti. string

Formati di dati supportati

La classe DataActionRequest definisce il formato di invio dei dati disponibile per l'utilizzo dell'azione. Per le azioni a livello di query, la richiesta conterrà un allegato che può essere in diversi formati. L'azione può specificare uno o più supportedFormats o consentire all'utente di scegliere il formato specificando tutti i formati possibili. Per le azioni a livello di cella, il valore della cella sarà presente su DataActionRequest.

Configurare un'azione per OAuth

Puoi configurare l'azione in modo che gli utenti possano eseguire l'autenticazione con OAuth. Anche se l'hub azioni di Looker deve rimanere stateless, puoi applicare uno stato tramite una richiesta di modulo dall'API Looker Action.

Flusso OAuth dell'azione Looker

Per le azioni nell'hub azioni di Looker, puoi estendere un OAuthAction anziché un Hub.Action per impostare un valore booleano che indichi quali metodi OAuth sono necessari per autenticare un utente in un'azione. Per ogni azione abilitata per OAuth o attivata dallo stato, Looker archivia uno stato per utente e per azione, in modo che ogni combinazione di azione e utente abbia un evento OAuth indipendente.

Il flusso per la creazione di azioni in genere prevede una richiesta /form seguita da una richiesta /execute. Per OAuth, la richiesta /form deve avere un metodo per determinare se l'utente è autenticato all'interno del servizio di destinazione. Se l'utente è già autenticato, l'azione dovrebbe restituire un valore /form normale, in base ai requisiti richiesti dalla richiesta /execute. Se l'utente non è autenticato, l'azione restituisce un link che inizializza un flusso OAuth.

Salvataggio dello stato con l'URL OAuth in corso...

Looker invierà una richiesta POST HTTP con un corpo vuoto all'endpoint ActionList. Se l'azione restituisce uses_oauth: true nella sua definizione, riceverà un state_url una tantum in ogni richiesta /form da Looker. L'state_url è un URL speciale monouso che imposta lo stato di un utente per una determinata azione.

Se l'utente non viene autenticato con l'endpoint, il /form restituito dovrebbe contenere un form_field di tipo oauth_link che rimanda all'endpoint /oauth di un'azione. state_url deve essere criptato e salvato come parametro state nel campo oauth_url restituito. Ad esempio:

{
        "name": "login",
        "type": "oauth_link",
        "label": "Log in",
        "description": "OAuth Link",
        "oauth_url": "ACTIONHUB_URL/actions/my_action/oauth?state=encrypted_state_url"
}

In questo esempio, l'endpoint /oauth reindirizza l'utente al server di autenticazione. L'endpoint /oauth crea il reindirizzamento nel metodo oauthUrl(...) su un'azione OAuth, come mostrato nell'URL OauthUrl della casella personale.

Il parametro state contenente il valore criptato state_url deve essere passato all'hub azioni di Looker.

Salvataggio dello stato con l'URI di reindirizzamento dell'hub delle azioni in corso...

Nell'endpoint /oauth viene creato anche un redirect_uri per l'hub delle azioni, che viene trasmesso al metodo oauthUrl(...) dell'azione. Questo redirect_uri è nel formato /actions/src/actions/my_maction/oauth_redirect ed è l'endpoint utilizzato se l'autenticazione restituisce un risultato.

Questo endpoint chiamerà il metodo oauthFetchInfo(...), che dovrebbe essere implementato dal metodo OauthAction per estrarre le informazioni necessarie e tentare di ricevere o salvare qualsiasi stato o auth ricevuto dal server di autenticazione.

L'state decripta il state_url criptato e lo utilizza per POSTARE state di nuovo a Looker. La volta successiva che un utente invia una richiesta a questa azione, lo stato appena salvato verrà inviato all'hub azioni di Looker.

Aggiunta dei file delle azioni al repository dell'hub azioni di Looker

Dopo aver scritto il file delle azioni, nel repository dell'hub azioni di Looker:

  1. Aggiungi il file delle azioni (ad esempio, my_action.ts) a actions/src/actions/index.ts.

    import "./my_action/my_action.ts"

  2. Aggiungi eventuali requisiti del pacchetto Node.js utilizzati per la scrittura dell'azione. Ad esempio:

    yarn add aws-sdk
yarn add express

  3. Installa le dipendenze Node.js del server hub azioni di Looker.

    yarn install

  4. Esegui tutti i test che hai scritto.

yarn test

Test di un'azione

Per il test completo, puoi provare a eseguire l'azione sulla tua istanza Looker ospitando un server hub azioni privato. Questo server deve trovarsi sulla rete internet pubblica con un certificato SSL valido e deve essere in grado di avviare e ricevere connessioni o richieste HTTPS da e verso Looker. Per questo, puoi utilizzare una piattaforma basata su cloud come Heroku, come mostrato nell'esempio seguente. In alternativa, puoi utilizzare qualsiasi piattaforma che soddisfi i requisiti sopra indicati.

Configurazione di un server hub azioni locale

In questo esempio, eseguiremo l'azione che abbiamo sviluppato nel repository GitHub di looker-open-source/actions/src/actions ed eseguiremo il commit del codice in un nuovo ramo Git. Ti consigliamo di lavorare sulle funzionalità utilizzando rami per poter monitorare facilmente il codice e, se vuoi, creare facilmente un PR con Looker.

  1. Per iniziare, crea il tuo ramo, quindi organizza e esegui il commit del tuo lavoro. Ad esempio:

    git checkout -b my-branch-name
git add file-names
git commit -m commit-message

  2. Per questo esempio, per eseguire il push di un ramo a Heroku, configura il tuo repository Git con Heroku come opzione remota nella riga di comando:

    heroku login
heroku create
git push heroku

  3. Heroku restituirà l'URL pubblico che ora ospita l'hub delle azioni. Visita l'URL o esegui heroku logs per verificare che l'hub azioni sia in esecuzione. Se dimentichi l'URL pubblico, puoi eseguire il comando seguente nella riga di comando:

    heroku info -s | grep web_url

    Heroku restituirà il tuo URL pubblico. Ad esempio: https://my-heroku-action-server-1234.herokuapp.com

  4. Nella riga di comando, imposta l'URL di base dell'hub delle azioni:

    heroku config:set ACTION_HUB_BASE_URL="https://my-heroku-action-server-1234.herokuapp.com"

  5. Imposta l'etichetta dell'hub delle azioni:

    heroku config:set ACTION_HUB_LABEL="Your Action Hub"

  6. Looker utilizza un token di autorizzazione per connettersi all'hub delle azioni. Genera il token nella riga di comando:

    heroku run yarn generate-api-key

    Se non utilizzi Heroku, come in questo esempio, utilizza:

    yarn generate-api-key

    Heroku ti restituirà il token di autorizzazione. Ad esempio: Authorization: Token token="abcdefg123456789"

  7. Imposta il secret dell'hub delle azioni utilizzando la chiave segreta:

    heroku config:set ACTION_HUB_SECRET="abcdefg123456789"

    Le implementazioni ospitate dal cliente potrebbero richiedere la configurazione di variabili di ambiente aggiuntive non documentate qui.

  8. Per aggiungere l'azione all'istanza Looker locale, vai ad Amministrazione > Azioni.

    • Nella parte inferiore dell'elenco delle azioni, fai clic su Aggiungi hub azioni.
    • Inserisci l'URL dell'Action Hub e, facoltativamente, una chiave secret.
    • Individua l'azione nell'elenco Azioni nel menu Amministratore di Looker.
    • Fai clic su Abilita.

Se la tua azione richiede la trasmissione di tipi specifici di dati da Looker, assicurati di configurare tutti i modelli in modo da includere il parametro tags appropriato.

Ora puoi iniziare a testare la tua azione.

Test delle azioni a livello di dashboard e di query

Nell'istanza di Looker, configura il modello LookML con i tag, se necessario. Crea e salva un Look. Nel Look salvato, fai clic nel menu in alto a destra e seleziona Invia con la tua azione come destinazione. Se hai un modulo per la consegna, Looker lo visualizzerà nella finestra Inviato.

Fai clic su Send Test (Invia test) per inviare i dati. Lo stato dell'azione verrà visualizzato nella Cronologia scheduler nel riquadro Amministrazione. Se si verifica un errore nell'azione, questo verrà visualizzato nel riquadro Amministrazione e Looker invierà un'email con il messaggio di errore all'utente che ha inviato l'azione.

Test delle azioni a livello di cella

Configura un campo LookML con i tag appropriati per l'azione. Nell'istanza di Looker, esegui una query che includa quel campo. Individua il campo nella tabella dei dati. Fai clic su … nella cella e seleziona … dal menu a discesa. Se ricevi errori, dovrai eseguire un aggiornamento completo della tabella dei dati dopo averli corretti.

Pubblicazione e attivazione di un'azione personalizzata

Sono disponibili due opzioni di pubblicazione per le azioni personalizzate:

Una volta pubblicata l'azione, puoi attivarla dalla pagina Azioni nel riquadro Amministrazione.

Pubblicazione nell'hub delle azioni di Looker

Questo approccio è il più semplice e funziona per qualsiasi azione che vuoi rendere disponibile a chiunque utilizzi Looker.

Dopo che l'azione è stata testata, puoi inviare un PR al repository looker-open-source/actions in GitHub.

  1. Inserisci questo comando:

    git push <your fork> <your development branch>

  2. Crea la richiesta di pull con il repository looker-open-source/actions come destinazione.

  3. Compila il modulo di invio di Looker Marketplace e Action Hub. Per saperne di più sui requisiti del modulo, vedi Inviare contenuti a Looker Marketplace.

    Looker esaminerà il tuo codice di azione. Ci riserviamo il diritto di rifiutare il tuo PR, ma possiamo aiutarti a risolvere eventuali problemi e offrirti suggerimenti per migliorarti. Quindi uniamo il codice nel repository looker-open-source/actions e ne eseguiamo il deployment in actions.looker.com. Una volta eseguito il deployment, il codice sarà disponibile per tutti i clienti di Looker.

  4. Abilita l'azione nella tua istanza di Looker in modo che appaia come opzione per l'invio dei dati.

Pubblicazione su un server hub azioni privato

Se disponi di azioni personalizzate private per la tua azienda o il tuo caso d'uso, non devi aggiungerle al repository looker-open-source/actions. Crea invece un hub delle azioni private utilizzando lo stesso framework Node.js che hai utilizzato per testare l'azione.

Puoi configurare il server hub delle azioni interno sulla tua infrastruttura o utilizzando una piattaforma applicativa basata su cloud (il nostro esempio utilizzava Heroku). Non dimenticare di fork dell'hub azioni di Looker al server hub azioni privato prima del deployment.

Configurazione di un modello LookML da utilizzare con un'azione

Sia per le azioni personalizzate che per quelle disponibili nell'hub azioni di Looker, devi identificare i campi di dati pertinenti utilizzando il parametro tags nel modello LookML. La pagina Azioni nel riquadro Amministrazione fornisce informazioni sui tag eventualmente richiesti per il servizio.

Ad esempio, un'integrazione Twilio Send Message invia un messaggio a un elenco di numeri di telefono. Nella pagina Azioni del riquadro Amministrazione, l'integrazione mostra il sottotitolo "L'azione può essere utilizzata con le query in cui è presente un campo denominato phone".

Ciò significa che il servizio Twilio Send Message richiede una query che includa un campo per il numero di telefono e che utilizzi il parametro tags per identificare quale campo della query contiene numeri di telefono. Puoi identificare un campo del numero di telefono in LookML specificando tags: ["phone"] per quel campo. Il LookML per un campo del numero di telefono potrebbe avere il seguente aspetto:

dimension: phone {
  tags: ["phone"]
  type: string
  sql: ${TABLE}.phone ;;
}

Un'integrazione che non richiede tag mostrerà il sottotitolo "L'azione può essere utilizzata con qualsiasi query" nella pagina Azioni del riquadro Amministrazione.

Assicurati di identificare tutti i campi obbligatori nel modello LookML con il parametro tags, in modo che gli utenti possano utilizzare il servizio per inviare dati.

Passaggi successivi

Scopri come caricare i contenuti di un Look, un'esplorazione o una dashboard a un servizio integrato.