Como criar dashboards do LookML

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

Para comparar os dashboards do LookML e os definidos pelo usuário, consulte a página de documentação Comparação dos painéis definidos pelo usuário e do LookML.

Para criar um dashboard do LookML, é preciso 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 tenha a extensão .dashboard.lookml (embora a parte .lookml da extensão fique 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, navegue até seu projeto.
3. Selecione o ícone de adição Adicionar arquivo ou pasta na parte de cima do painel do navegador de arquivos no ambiente de desenvolvimento integrado do Looker para criar um arquivo do dashboard do LookML fora das pastas do projeto. Também é possível clicar 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 será exibida. Na janela, nomeie o arquivo do dashboard no campo de gravação e selecione o botão Criar.

Como editar arquivos do dashboard do LookML

Quando você cria um arquivo de dashboard do LookML, o Looker o preenche com vários parâmetros de painel básicos, que implementam configurações em todo o dashboard. Ele também preenche o arquivo com vários exemplos de parâmetros de elemento do painel, que são agrupados no parâmetro elements do dashboard e definem a função e a aparência dos blocos, do texto e dos botões do painel. Um arquivo .dashboard.lookml recém-criado contém um dashboard do LookML 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

É possível editar o arquivo do dashboard no ambiente de desenvolvimento integrado, desde que você esteja no Modo de Desenvolvimento.

Há várias opções para criar o painel:

• Criação manual:é possível criar um painel manualmente usando parâmetros de painel e parâmetros de elemento do painel.
• Copiar um dashboard definido pelo usuário:exclua o LookML pré-preenchido do dashboard de um dashboard definido pelo usuário, copie o LookML de um dashboard definido pelo usuário e cole-o no arquivo do dashboard pré-preenchido.
• Copiar o LookML do dashboard de elementos:você pode copiar o LookML do dashboard de uma Análise ou de um Look e colar no arquivo do dashboard.

Ao criar um dashboard, lembre-se das práticas recomendadas. Encontre informações e recomendações sobre a criação de dashboards de alta performance na página Considerações ao criar painéis de alta performance no Looker.

Adicionar uma visualização a um dashboard do LookML.

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

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

2. Selecione Obter LookML para expor o LookML.

   

3. Uma janela Get LookML será exibida. Com o Dashboard selecionado na janela, selecione e copie todo o LookML.

   

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

• Verifique se você está no Modo de Desenvolvimento para 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, associe o recuo aos elementos já existentes no arquivo do dashboard.

É possível ajustar os parâmetros do LookML, se quiser, usando os parâmetros descritos nas páginas de documentação de cada tipo de elemento individual.

Adicione filtros

Depois de salvar os elementos do dashboard no arquivo do dashboard, adicione filtros, que permitem que os visualizadores do dashboard filtrem alguns ou todos os elementos de um dashboard. Os filtros podem ser úteis por muitos motivos possíveis, por exemplo:

• Ajustando o período mostrado
• Ajustar a categoria de produto específica, o tipo de cliente etc. que está sendo mostrado.
• Fornecer um recurso do tipo "pesquisa" para um cliente

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

• Filtros que você codifica nos elementos do dashboard que não podem ser alterados pelos usuários do dashboard
• Filtros do painel, que os visualizadores podem alterar

Filtros codificados em elementos do dashboard

Os filtros que você codifica nos elementos do dashboard, que não podem ser alterados pelos usuários, 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 parâmetro de elemento do dashboard filters 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

Com os filtros do painel, os usuários podem refinar de maneira interativa os dados mostrados nos elementos do painel. Para criar um filtro de painel, siga estas etapas:

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

Como criar um filtro de painel

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

Para criar um filtro de painel que permita a interação dos usuários, adicione um parâmetro filters ao arquivo do dashboard. Por exemplo, o exemplo de código a seguir cria um dashboard do LookML com 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 aos usuários selecionar um período. O valor padrão é definido como os últimos 30 dias.
• category_name: um filtro de campo que permite aos usuários filtrar por categoria de produto. Esse filtro gera dinamicamente opções com base no campo category.name no modelo LookML especificado (ecommerce) e na Análise (product).

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

Aplicar um filtro de dashboard aos elementos do dashboard

Depois de criar um filtro de painel, é possível aplicá-lo a elementos individuais do painel usando o parâmetro listen. Usar o parâmetro listen dessa maneira 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 elemento, exceto type: text e type: button.

Por exemplo, considere o seguinte código do 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 se baseia na dimensão orders_created_date e na medição orders.count e tem um filtro aplicado, orders.status: 'approved'. Esse filtro é fixo no elemento e não pode ser modificado pelos leitores do painel.

Para permitir que os usuários filtrem o gráfico approved_orders_by_day usando os filtros date e 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 de painel interage com os filtros category_name ou 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 painel forneçam entradas para o filtro.

Um filtro de painel 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 do painel que usam o parâmetro merged_queries, cada consulta de origem pode detectar um ou mais filtros do painel. É 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, nenhum filtro do painel vai afetar a consulta.

Como incluir o arquivo do dashboard em um modelo

Para que o painel fique visível para visualização no Modo de Desenvolvimento ou na produção, ele precisa ser incluído no arquivo de modelo em que o painel se baseia, 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"

Também é possível incluir um painel específico especificando seu nome de arquivo:

include: "my_dashboard.dashboard.lookml"

Como salvar, visualizar e publicar o dashboard do LookML

Para visualizar o painel:

1. Salve o arquivo .dashboard.lookml clicando no botão Save Changes no canto superior direito do arquivo.
2. Inclua o painel no arquivo de modelo relevante e salve as alterações nesse arquivo.
3. No arquivo .dashboard.lookml que você quer visualizar, clique na seta para baixo no ícone See file actions e selecione View Dashboard.

É possível fazer outras mudanças no arquivo .dashboard.lookml, salvá-las e visualizar o painel novamente.

Quando você estiver satisfeito com o painel, poderá publicá-lo para produção. Assim, outros usuários com as permissões corretas podem vê-lo. O método para publicar o dashboard é o mesmo que 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 Folders no painel de navegação à esquerda. A pasta Dashboards do LookML é exclusiva das outras pastas em alguns aspectos:

• Você precisa incluir um dashboard do LookML em pelo menos um arquivo modelo para que ele apareça na pasta Dashboards do LookML.
• Para conferir a pasta Dashboards do LookML, os usuários precisam ter a permissão see_lookml_dashboards.
• Para conferir os dashboards na pasta Dashboards do LookML, os usuários precisam ter acesso ao modelo do LookML que inclui o dashboard.
• Para conferir um determinado bloco em um dashboard do LookML, os visualizadores precisam ter acesso ao modelo do LookML em que o bloco é baseado.
• Para editar um dashboard na pasta Dashboards do LookML, é preciso ter a permissão develop no modelo que inclui o dashboard do LookML.
• Para Explorar a partir daqui em qualquer bloco dentro de um dashboard, os leitores 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.

Mover dashboards do LookML para fora da pasta de dashboards do LookML

Se você tiver as permissões do Looker see_lookml_dashboards e develop, 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 tenha o nível de acesso Gerenciar acesso, Editar à pasta.

Há duas maneiras de mover o painel:

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

No Modo de Desenvolvimento, não é possível mover os dashboards do LookML para fora da pasta Dashboards do LookML. Em vez disso, use 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 exibe os dashboards do LookML em uma seção Painel do LookML. Na seção Painel do LookML, é possível mover um dashboard do LookML para outra pasta ou fixar um dashboard do LookML em um quadro. No entanto, ao contrário dos dashboards definidos pelo usuário, os dashboards do LookML não podem ser renomeados ou movidos de uma pasta para a lixeira.

Se o valor do 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.

Visualizar o LookML para um dashboard do LookML atual

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

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

Estender um dashboard do LookML

Depois de criar um dashboard do LookML, é possível estendê-lo. Isso permite criar um segundo painel baseado no original, possivelmente adicionando ou substituindo algumas configurações. Então, se você alterar o primeiro painel, o segundo herdará essas alterações automaticamente (a menos que seja substituído no segundo painel). Consulte a página de documentação Reutilizar código com extensões para mais informações.

Como melhorar o desempenho do painel usando reconhecimento agregado

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

Depois de criar e visualizar um dashboard do LookML, use a opção Acessar tabela de agregação do LookML no menu de três pontos Ações do dashboard, que fica visível se você tem 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 a criação de dashboards de performance na página Considerações ao criar painéis de alto desempenho do Looker.