Criar dashboards do LookML

Os dashboards do LookML são criados por desenvolvedores do LookML e armazenados como arquivos com controle de versão. Por padrão, eles aparecem na pasta Dashboards do LookML da instância do Looker.

Para comparar e contrastar dashboards do LookML e dashboards definidos pelo usuário, consulte a página de documentação Comparar dashboards definidos pelo usuário e do LookML.

Para criar um dashboard do LookML, você precisa ter as seguintes permissões do Looker:

• see_lookml_dashboards
• develop

Além disso, você precisa ter acesso aos modelos do LookML para todos os dados que quiser usar no dashboard.

Como criar um arquivo de dashboard do LookML

Para criar um dashboard do LookML, comece criando um arquivo de dashboard, que tem a extensão .dashboard.lookml (embora a parte .lookml da extensão seja silenciosa no ambiente de desenvolvimento integrado). As etapas para fazer isso são as seguintes:

1. Ative o modo de desenvolvimento.
2. No menu Desenvolver, acesse seu projeto.
3. Selecione o ícone de adição Adicionar arquivo ou pasta na parte de cima do painel do navegador de arquivos no IDE do Looker para criar um arquivo de dashboard do LookML fora das pastas de projeto atuais. Ou clique no menu de três pontos Opções de pasta para criar o arquivo dentro da pasta. Clique em Criar dashboard para criar o arquivo do dashboard.

1. Uma janela Criar arquivo vai aparecer. Nela, nomeie o arquivo do dashboard no campo de texto e selecione o botão Criar.

Como editar arquivos de dashboard do LookML

Ao criar um arquivo de dashboard do LookML, o Looker pré-preenche o arquivo com vários parâmetros básicos de dashboard, que implementam configurações para todo o dashboard. Ele também pré-preenche o arquivo com vários parâmetros de elementos de dashboard de exemplo, que são agrupados no parâmetro de dashboard elements e que definem a função e a aparência dos blocos, textos e botões do dashboard. Um arquivo .dashboard.lookml recém-criado contém um LookML de dashboard semelhante a este:

- dashboard: order_analysis
  title: Order Analysis
  layout: newspaper
  preferred_viewer: dashboards-next
  tile_size: 100

  filters:

  elements:
    - name: hello_world
      type: looker_column

Você pode editar o arquivo do dashboard no IDE, desde que esteja no Modo de Desenvolvimento.

Você tem várias opções para criar seu dashboard:

• Criação manual:você pode criar um dashboard manualmente usando parâmetros de dashboard e parâmetros de elementos do dashboard.
• Copiar um painel definido pelo usuário:você pode criar uma cópia de um painel definido pelo usuário excluindo o LookML de painel pré-preenchido do arquivo, copiando o LookML de painel de um painel definido pelo usuário e colando-o no arquivo do painel.
• Copiar o LookML de dashboard de elementos: você pode copiar o LookML de dashboard de uma análise ou de um Look e colá-lo no arquivo do dashboard.

Ao criar um dashboard, tenha em mente as práticas recomendadas para a construção de dashboards. Encontre informações e recomendações sobre como criar dashboards de bom desempenho na página Práticas recomendadas: Considerações ao criar dashboards do Looker de bom desempenho.

Como adicionar uma visualização a um dashboard do LookML

A maneira mais fácil de adicionar uma visualização a um dashboard do LookML é usar a página Análise para criar uma consulta que você quer transformar em um elemento de dashboard:

1. Depois de criar a consulta e a visualização que você quer adicionar a um dashboard, clique no menu de engrenagem Ações de análise da análise.

2. Selecione Acessar o LookML para expor o LookML.

   

3. Uma janela Acessar o LookML aparece. Com a opção Dashboard selecionada na janela, selecione todo o LookML e copie-o.

   

Em seguida, cole o LookML no arquivo LookML do dashboard. Ao editar o arquivo LookML do dashboard, faça o seguinte:

• Verifique se você está no Modo de Desenvolvimento para poder editar o arquivo do dashboard.
• Cole o LookML no parâmetro elements do dashboard.
• Use o recuo correto ao colar o LookML no arquivo do dashboard. Se possível, combine o recuo com os elementos já existentes no arquivo do dashboard.

Se quiser, ajuste os parâmetros do LookML usando os parâmetros descritos nas páginas de documentação de cada tipo de elemento.

Como adicionar filtros

Depois de salvar os elementos do dashboard no arquivo do dashboard, talvez você queira adicionar filtros, que permitem que os leitores do dashboard filtrem alguns ou todos os elementos em um dashboard. Os filtros podem ser úteis por vários motivos, por exemplo:

• Ajustar o período mostrado
• Ajustar a categoria dos produtos específica, o tipo de cliente etc. mostrado
• Fornecer um recurso de "pesquisa" para um cliente

Crie o tipo de filtro que você quer. Os dois tipos são:

• Filtros codificados nos elementos do dashboard, que os leitores do dashboard não podem mudar
• Filtros de dashboard, que os leitores do dashboard podem mudar

Filtros codificados nos elementos do dashboard

Os filtros codificados nos elementos do dashboard, que os usuários não podem mudar, geralmente são criados automaticamente na etapa de cópia do LookML para uma visualização ou para um dashboard. Em um dashboard do LookML, esses filtros usam o filters parâmetro de elemento de dashboard e têm esta aparência:

- name: element_name
  # lots of other element parameters here
  filters:
    dimension_or_measure_name: 'looker filter expression'

Filtros do painel

Os filtros de dashboard permitem que os leitores refinem interativamente os dados mostrados nos elementos do dashboard. Para criar um filtro de dashboard, siga estas etapas:

1. Crie o filtro de dashboard usando o filters parâmetro no arquivo de dashboard do LookML.
2. Aplique o filtro a elementos de dashboard individuais usando o listen parâmetro.

Como criar um filtro de dashboard

O parâmetro filters permite criar vários tipos de filtros interativos para seu dashboard.

Para criar um filtro de dashboard com que os usuários possam interagir, adicione um parâmetro filters ao arquivo do dashboard. Por exemplo, o exemplo de código a seguir cria um dashboard do LookML que tem os filtros date e category_name:

- dashboard: dashboard_name
  title: Dashboard Title
  layout: newspaper
  filters:
  - name: date
    title: 'Date Range'
    type: date_filter
    default_value: 30 days

  - name: category_name
    type: field_filter
    model: ecommerce
    explore: product
    field: category.name

O código no exemplo anterior cria os seguintes filtros:

• date: um filtro de data que permite que os usuários selecionem um período. O valor padrão é definido como os últimos 30 dias.
• category_name: um filtro de campo que permite que os usuários filtrem por categoria dos produtos. Esse filtro gera dinamicamente opções com base no campo category.name no modelo do LookML especificado (ecommerce) e na análise (product).

Observação: apenas filtros com type: field_filter usam os explore e field parâmetros. Se você incluir os parâmetros explore e field com qualquer outro tipo de filtro, vai receber erros de validação do LookML.

Como aplicar um filtro de dashboard a elementos de dashboard

Depois de criar um filtro de dashboard, você pode aplicá-lo a elementos de dashboard individuais usando o parâmetro listen. O uso do parâmetro listen dessa forma permite que os elementos vinculados sejam atualizados dinamicamente com base na seleção do usuário no filtro.

Observação: O parâmetro listen é compatível com todos os tipos de elementos, exceto type: text e type: button.

Por exemplo, considere o seguinte código LookML de amostra para um elemento de gráfico de área:

- name: approved_orders_by_day
  type: looker_area
  model: ecommerce
  explore: orders
  dimensions: [orders.created_date]
  measures: [orders.count]
  filters:
    orders.status: 'approved'

O gráfico approved_orders_by_day mostra a contagem de pedidos aprovados por dia, já que a consulta é baseada na dimensão orders_created_date e na métrica orders.count e tem um filtro aplicado, orders.status: 'approved'. Esse filtro é fixo no elemento e não pode ser modificado pelos leitores do dashboard.

Para permitir que os usuários filtrem o gráfico approved_orders_by_day usando o filtro date e o filtro category_name do exemplo anterior, adicione o parâmetro listen ao elemento do dashboard.

- name: approved_orders_by_day
  type: looker_area
  model: ecommerce
  explore: orders
  dimensions: [orders.created_date]
  measures: [orders.count]
  filters:
    orders.status: 'approved'
  listen:
    category_name: category.name
    date: orders.created_date

Quando um leitor do dashboard interage com o filtro category_name ou o filtro date, o gráfico approved_orders_by_day é atualizado automaticamente para refletir os resultados filtrados.

O parâmetro listen usa a sintaxe filter_name: field_name. No exemplo anterior, category_name e date são os nomes dos filtros, e category.name e orders.created_date são os campos que serão usados para permitir que os leitores do dashboard forneçam entrada para o filtro.

Um filtro de dashboard pode ser aplicado a qualquer campo (do mesmo tipo de dados) em qualquer elemento. Por exemplo, um elemento pode aplicar a entrada de um usuário à data de criação do pedido (date: orders.created_date), enquanto outro a aplica à data de envio do pedido (date: orders.ship_date):

- name: element_one
  # lots of other element parameters here
  listen:
    date: orders.created_date

- name: element_two
  # lots of other element parameters here
  listen:
    date: orders.ship_date

Observação: para elementos de dashboard que usam o parâmetro merged_queries, cada consulta de origem pode ouvir um ou mais filtros de dashboard. É possível definir a lógica de filtro para cada consulta de origem de forma independente, independentemente do número de consultas de origem no elemento de resultados mesclados. Se uma consulta não tiver um parâmetro listen, ela não será afetada por nenhum filtro de dashboard.

Como incluir o arquivo do dashboard em um modelo

Para que o dashboard fique visível na visualização no Modo de Desenvolvimento ou na produção, ele precisa ser incluído no arquivo modelo em que o dashboard é baseado usando uma instrução include.

É uma prática comum incluir todos os dashboards do LookML em um modelo usando um caractere curinga:

include: "*.dashboard.lookml"

ou, se os dashboards do LookML aparecerem em uma pasta no ambiente de desenvolvimento integrado, use o caminho para o local deles

 include: "/path/*.dashboard.lookml"

Você também pode incluir um dashboard específico especificando o nome do arquivo:

include: "my_dashboard.dashboard.lookml"

Como salvar, visualizar e publicar o dashboard do LookML

Para visualizar o dashboard:

1. Salve o arquivo .dashboard.lookml clicando no botão Salvar alterações no canto superior direito do arquivo.
2. Inclua o dashboard no arquivo modelo relevante e salve as alterações nesse arquivo.
3. No arquivo .dashboard.lookml que você quer visualizar, clique na seta para baixo Ver ações do arquivo e selecione Visualizar dashboard.

Você pode fazer mais mudanças no arquivo .dashboard.lookml, salvá-las e visualizar o dashboard novamente.

Quando estiver satisfeito com o dashboard, você poderá publicá-lo na produção, o que permite que outros usuários com as permissões corretas o vejam. O método para publicar o dashboard é o mesmo que para publicar outras mudanças no LookML na sua instância e depende das configurações de controle de versão da instância do Looker.

Pasta de dashboards do LookML

Depois de publicados, os dashboards do LookML são salvos na pasta Dashboards do LookML por padrão. A pasta Dashboards do LookML está localizada na pasta Pastas na navegação à esquerda. A pasta Dashboards do LookML é diferente de outras pastas de algumas maneiras:

• É necessário incluir um dashboard do LookML em pelo menos um arquivo de modelo para que ele apareça na pasta Dashboards do LookML.
• Para ver a pasta Dashboards do LookML, os usuários precisam ter a permissão see_lookml_dashboards.
• Para ver os dashboards na pasta Dashboards do LookML, os usuários precisam ter acesso ao modelo do LookML que inclui o dashboard.
• Para ver qualquer bloco em um dashboard do LookML, os leitores do dashboard precisam ter acesso ao modelo do LookML em que o bloco é baseado.
• Para editar um dashboard na pasta Dashboards do LookML, você precisa ter a permissão develop no modelo que inclui o dashboard do LookML.
• Para Analisar daqui em qualquer bloco em um dashboard, os leitores do dashboard precisam ter a permissão explore para o modelo em que o bloco é baseado.
• Não é possível criar uma pasta dentro da pasta Dashboards do LookML.
• No modo de produção, a lista da pasta Dashboards do LookML é paginada (30 dashboards por página). No modo de desenvolvimento, todos os dashboards do LookML estão em uma única página.
• Cada dashboard do LookML é classificado na pasta Dashboards do LookML de acordo com o nome do dashboard do LookML definido no código do dashboard do LookML, em vez do título do dashboard do LookML. Como resultado, os dashboards podem não aparecer classificados em ordem alfabética por título.

Como mover dashboards do LookML para fora da pasta de dashboards do LookML

Se você tiver as permissões see_lookml_dashboards e develop do Looker, bem como acesso ao modelo do LookML em que um dashboard do LookML está incluído, poderá mover um dashboard do LookML para qualquer pasta em que você tenha o nível de acesso Gerenciar acesso, editar.

Há duas maneiras de mover o dashboard:

• Na pasta Dashboards do LookML , selecione o dashboard a ser movido, clique no botão Mover na parte de cima da seção de dashboards e selecione a pasta para a qual você quer mover o dashboard. Consulte a página de documentação Organizar e gerenciar conteúdo para mais informações.
• Na pasta Dashboards do LookML , clique no menu de três pontos do dashboard, selecione Mover no menu e selecione a pasta para a qual você quer mover o dashboard.

Se você estiver no modo de desenvolvimento, não será possível mover dashboards do LookML para fora da pasta Dashboards do LookML. Em vez disso, você pode usar a opção Importar para copiar o dashboard do LookML como um painel definido pelo usuário para outra pasta.

Uma pasta que contém dashboards definidos pelo usuário e dashboards do LookML mostra os dashboards do LookML em uma seção Dashboard do LookML. Na seção Dashboard do LookML, você pode mover um dashboard do LookML para outra pasta ou fixar um dashboard do LookML em um quadro. No entanto, ao contrário dos painéis definidos pelo usuário, os painéis do LookML não podem ser renomeados ou movidos para a lixeira de uma pasta.

Se o valor de um parâmetro dashboard de um dashboard do LookML for alterado, o dashboard do LookML será movido automaticamente de volta para a pasta Dashboards do LookML.

Como visualizar o LookML de um dashboard do LookML

Se você tiver a permissão see_lookml, poderá navegar até o LookML do dashboard de um dashboard do LookML selecionando Acessar o LookML no menu de três pontos Ações do dashboard:

Quando você seleciona Acessar o LookML, o Looker navega até o arquivo de dashboard em que o dashboard do LookML está definido.

Como estender um dashboard do LookML

Depois de criar um dashboard do LookML, você pode estender o dashboard. Isso permite criar um segundo dashboard com base no original, possivelmente adicionando ou substituindo algumas configurações. Em seguida, se você mudar o primeiro dashboard, o segundo vai herdar essas mudanças automaticamente (a menos que sejam substituídas no segundo dashboard). Consulte a página de documentação Reutilizar código com extensões para mais informações.

Como melhorar a performance do dashboard usando o reconhecimento agregado

Os desenvolvedores do LookML podem melhorar a performance do dashboard do LookML usando o reconhecimento agregado. Com o reconhecimento agregado, os desenvolvedores podem criar tabelas agregadas nos parâmetros explore do LookML, que podem otimizar consultas para um ou mais blocos em um dashboard.

Depois de criar e visualizar um dashboard do LookML, você pode usar a opção Acessar o LookML da tabela de agregação no menu de três pontos Ações do dashboard, que fica visível se você tiver a permissão see_lookml.

Para mais informações, consulte a página de documentação do parâmetro aggregate_table.

Observação: encontre outras informações e recomendações sobre como criar dashboards de bom desempenho na página Práticas recomendadas: considerações ao criar dashboards do Looker de bom desempenho.