Como mudar o menu "Explorar" e o seletor de campo

Você pode usar vários parâmetros do LookML para tornar as Análises mais fáceis de usar. Para isso, basta alterar a forma como os campos aparecem na interface do usuário sem alterar o LookML subjacente. Nesta página, você encontra uma visão geral dos parâmetros do LookML que modificam a aparência do menu Explorar do Looker e do seletor de campo.

No Looker, seus usuários podem conferir as Análises listadas no menu Análise. Em uma Análise, os usuários podem usar o seletor de campo para escolher quais campos (dimensões e medidas) vão ser usados para consultar os dados.

As Análises estão listadas no menu “Análise”, abaixo do nome do modelo a que pertencem. O seletor de campo em uma Análise mostra uma lista expansível de visualizações contendo campos que podem ser adicionados à sua consulta.

Esta página lista cada parâmetro usado com frequência com um link para sua página de referência completa, uma breve descrição de sua função e uma imagem do que ele faz.

Para dicas e sugestões sobre como criar uma Análise fácil de usar, consulte a página Prática recomendada: criar uma experiência positiva para os usuários do Looker.

Confira o nome e o menu

Esta seção descreve o comportamento padrão do nome e da aparência de uma Análise no menu Explorar e, em seguida, descreve os parâmetros do LookML que permitem mudar esse comportamento:

Comportamento padrão do menu "Explorar"

Nomes de modelos

Por padrão, o menu Análise é organizado por nomes de modelos, que são determinados pelo nome de cada arquivo de modelo. O menu Explorar mostra uma versão formatada do nome do modelo, com sublinhados alterados para espaços e cada palavra em maiúscula. Abaixo de cada nome de modelo, há uma lista de Análises definidas no arquivo de modelo.

Conferir nomes

O nome de cada Análise no menu é baseado no parâmetro explore correspondente no arquivo de modelo. Assim como nos nomes dos modelos, os nomes da Análise são formatados no menu para que os sublinhados sejam alterados para espaços e cada palavra fique em maiúscula. Esse nome também aparece como o título da Análise no painel do seletor de campo.

No exemplo a seguir, a Análise order_items é definida no arquivo de modelo e_commerce_model.model:


explore: order_items {
  join: orders {
    type: left_outer
    sql_on: ${order_items.order_id} = ${orders.id} ;;
    relationship: many_to_one
  }
}

A Análise order_items aparece como Order Items no menu "Análise" e no seletor de campo.

Menu "Explorar": Seletor de campo:

A opção "Order Items" aparece na lista de Análises no menu "Análise". O rótulo "Order Items" aparece no canto superior esquerdo do painel do seletor de campo.

Para mais informações sobre arquivos de modelo, consulte a página de documentação Noções básicas sobre arquivos de modelo e visualização. Para saber mais sobre como definir Análises, consulte a página de documentação do parâmetro explore.

label (modelo)

O parâmetro label de um modelo renomeia o modelo no menu Explorar sem alterar a referência a ele no LookML. Os URLs de análise, o ambiente de desenvolvimento integrado do Looker e o SQL Runner ainda refletem o nome real do modelo. A maneira como o modelo é referenciado nas configurações do LookML e do administrador permanece inalterada.

Por padrão, o modelo market_research.model aparece como Pesquisa de mercado no menu "Explorar".

É possível usar o parâmetro label para renomear o modelo no menu "Explorar". Por exemplo, adicione o código label: "Marketing R&D" ao arquivo de modelo market_research.model:


label: "Marketing R&D"

Neste exemplo, o Looker mostra o nome do modelo da seguinte maneira no menu "Explorar":

O modelo Pesquisa de mercado tem o rótulo P&D de marketing no menu "Explorar".

label (Explorar)

O parâmetro label de uma Análise renomeia uma Análise no menu Explorar e na página "Explorar" sem mudar a referência a ela no LookML.

Se o parâmetro label não for usado, o nome da Análise será exibido de acordo com o comportamento padrão.

Uma Análise com o rótulo "Informações do item do pedido" no menu "Explorar" e no seletor de campo.

group_label (Explorar)

O parâmetro group_label de uma Análise muda a organização padrão do menu Análise. Em vez de listar cada Análise sob o nome do modelo, group_label permite que você defina um título personalizado para listar uma ou mais Análises.

Neste exemplo, as Análises de Clientes, Inventário, Itens do pedido e Dados do usuário estão listados no rótulo de grupo Consultas da loja on-line:

Análises listadas no rótulo do grupo "Consultas da loja on-line" no menu "Explorar".

description (Explorar)

O parâmetro description de uma Análise permite adicionar uma descrição à UI para que os usuários possam acessar mais informações ao criar relatórios.

Para conferir a descrição, os usuários podem passar o cursor sobre o ícone de informações, ao lado do nome da opção "Explorar", na parte de cima do seletor de campo. O ícone de informações também aparece na lista suspensa de "Análises". Se você não adicionar explicitamente uma descrição a uma Análise, nenhuma descrição será exibida.

hidden (Explorar)

O parâmetro hidden de uma Análise oculta essa guia do menu Explorar. Por padrão, hidden fica desativado, e a opção "Explorar" será exibida. O hidden não oculta o LookML nem impede o acesso a uma Análise pelo URL. O hidden não é um recurso de segurança, mas um recurso de apresentação.

Por exemplo, adicionar o código hidden: yes do LookML ao LookML da Análise inventory no exemplo a seguir oculta a Análise Inventário do menu Explorar:


explore: inventory {
  hidden: yes

  join: order_facts {
    view_label: "Orders"
    relationship: many_to_one
    sql_on: ${order_facts.order_id} = ${order_items.order_id} ;;
  }
}

Seletor de campo

Esta seção descreve o comportamento padrão do seletor de campo e, em seguida, descreve os parâmetros do LookML que permitem alterar esse comportamento.

Mude a forma como os nomes das visualizações aparecem no seletor de campo com:

Mude como os nomes de campos individuais aparecem no seletor de campo com:

Mude a forma como os campos são organizados no seletor com:

Comportamento padrão do seletor de campo

Por padrão, o seletor de campo é organizado por cabeçalhos que correspondem às visualizações especificadas pelo parâmetro view do LookML. Os campos de cada visualização são agrupados no seletor de campo. O tipo de campo (dimensão, grupo de dimensões, medida, campo de filtro e campo de parâmetro) determina onde o campo é exibido na vista. A menos que o parâmetro label seja usado para mudar o nome de exibição, o seletor de campo vai mostrar uma versão formatada da visualização do LookML ou do nome do campo, com sublinhados alterados para espaços e cada palavra em maiúscula.

No exemplo a seguir, o Looker mostra a visualização accounts como Contas no seletor de campo, que é o comportamento padrão:


view: accounts {
  sql_table_name: accounts ;;
}

O exemplo a seguir mostra como os nomes de uma dimensão, um grupo de dimensões e uma medida são exibidos por padrão. A mesma formatação será aplicada aos nomes dos campos de filtro e de parâmetro.


dimension: account_number {
  primary_key: yes
  type: number
  sql: ${TABLE}.account_number ;;
}

dimension: name {
  type: string
  sql: ${TABLE}.name ;;
}

dimension_group: created {
  type: time
  timeframes: [raw, time, date, week, month, quarter, year]
  sql: ${TABLE}.created_date ;;
}

measure: average_annual_revenue {
  type: average
  sql: ${annual_revenue} ;;
  value_format_name: custom_amount_value_format
}

Neste exemplo, o seletor de campo mostra os nomes de campo padrão Número da conta, Nome, Data de criação e Receita anual média para as dimensões account_number e name, o grupo de dimensões created e a medição average_annual_revenue, respectivamente.

Se você mudar o nome de um campo, o seletor vai se adaptar ao novo nome, mas talvez você queira adicionar um parâmetro alias com o nome antigo do campo. Esse parâmetro fornece nomes alternativos para um campo que pode aparecer no URL de uma consulta. Isso pode ser útil nos casos em que os nomes dos campos em um modelo mudam, mas algumas pessoas compartilharam links para os dados e você quer manter esses URLs pré-existentes funcionando.

view_label (Explorar)

O parâmetro view_label de uma Análise muda a forma como o grupo de campos da visualização base é rotulado no seletor de campo sem mudar a forma como ela e os campos são referenciados no LookML.

Por exemplo, se você mesclar uma visualização order_facts a uma Análise chamada order_items, poderá usar o parâmetro view_label para definir o rótulo que o Looker mostra para a visualização order_facts no seletor de campo da seguinte maneira:

explore: order_items {
  label: "Order Items"
  join: order_facts {
    view_label: "Orders and more"
    relationship: many_to_one
    sql_on: ${order_facts.order_id} = ${order_items.order_id} ;;
  }
}

Neste exemplo, a visualização order_facts aparece como Orders and more no seletor de campo da análise Order Items.

view_label (participar)

O parâmetro view_label de uma mesclagem permite agrupar campos de uma visualização com o nome de outra no seletor de campo. Se você não adicionar explicitamente um view_label a uma mesclagem, o view_label usará o nome da mesclagem por padrão.

Por exemplo, você junta a visualização products à Análise product_facts:


explore: product_facts {
  join: products {
    type: left_outer
    sql_on: ${product_facts.product_id} = ${products.id} ;;
    relationship: many_to_one
  }
}

Neste exemplo, como um rótulo de visualização não está especificado, os campos da visualização products são agrupados no rótulo de visualização Produtos no seletor de campo, separados da visualização Fatos do produto:

Por padrão, os campos da visualização do produto são agrupados no rótulo da visualização do produto.

É possível usar o parâmetro view_label para adicionar um rótulo de visualização à visualização products mesclada, como no exemplo a seguir:


explore: product_facts {
  join: products {
    view_label: "Product Facts"
    type: left_outer
    sql_on: ${product_facts.product_id} = ${products.id} ;;
    relationship: many_to_one
  }
}

Isso agrupa os campos da visualização products abaixo do rótulo de visualização Informações sobre o produto no seletor de campo:

Os campos da visualização do produto são agrupados no rótulo dessa visualização.

label (visualização)

O parâmetro label de uma visualização muda a forma como ela é rotulada no seletor de campo sem alterar a referência a ela no LookML. Se não for especificado, o rótulo será padronizado com o nome da visualização. Ao contrário de view_label (Análise) e view_label (Join), esse parâmetro afeta todas as Análises que usam a visualização.

Por exemplo, é possível usar o parâmetro label para especificar um rótulo para a visualização inventory_items da seguinte maneira:


view: inventory_items {
  label: "Items in Inventory"
  sql_table_name: inventory_items ;;
}

Neste exemplo, o seletor de campo exibe o rótulo Itens no inventário para a visualização inventory_items, em vez do rótulo padrão Itens do inventário.

description (campo)

É possível adicionar um description a qualquer campo. Para conexões do BigQuery, se você gerar um projeto do LookML usando seu banco de dados, o Looker vai preencher automaticamente as descrições dos campos com as descrições dos metadados da coluna do BigQuery, se houver.

O usuário pode ver essa descrição em vários lugares. O Looker mostra a descrição quando o usuário seleciona o ícone de informações à direita do nome do campo no seletor de campo.

Além disso, o Looker também mostra a descrição quando o usuário passa o cursor sobre o nome da coluna em uma visualização de tabela ou gráfico de tabela em uma Análise, um dashboard ou um Look.

hidden (campo)

Por padrão, os campos especificados em uma visualização são exibidos no seletor de campo. O parâmetro hidden oculta um campo no seletor.

Os campos ocultos ainda poderão ser acessados na UI se forem adicionados manualmente ao URL e vão aparecer em algumas janelas do Looker. Portanto, pense no hidden como uma forma de manter o seletor de campo limpo, e não como um recurso de segurança.

Por exemplo, adicionar o código do LookML hidden: yes ao LookML da dimensão product_id no exemplo a seguir oculta a dimensão ID do produto do seletor de campo:


dimension: product_id {
  hidden: yes
  type: number
  sql: ${TABLE}.product_id ;;
}

fields (campo)

O parâmetro fields permite especificar quais campos da visualização base e das mesclagens de uma Análise são expostos no seletor de campo. Se você não usar o parâmetro fields, o Looker vai expor todos os campos.

Para especificar os campos que você quer exibir no seletor, use uma lista de campos ou conjuntos separados por vírgulas. Para especificar os campos que você quer ocultar do seletor, use o conjunto ALL_FIELDS* com uma lista separada por vírgulas dos campos ou conjuntos a serem excluídos, com um hífen (-) antes de cada um.

Por exemplo, é possível usar o código do LookML a seguir para exibir apenas uma seleção de campos da Análise aircraft no seletor de campo:


explore: aircraft {
  fields: [
    aircraft.aircraft_model_code,
    aircraft.aircraft_engine_code,
    aircraft.count,
    aircraft.city,
    aircraft.country,
    aircraft.zip,
   ]
}

Neste exemplo, Aircraft mostra apenas as dimensões Aircraft Model Code, Aircraft Engine Code, City, Country e Zip e a medida Count no seletor de campo;

label (campo)

O parâmetro label de um campo permite mudar como o nome de um campo vai aparecer no seletor sem alterar como ele é referenciado no LookML. Se nenhum rótulo for especificado, o rótulo será o padrão do campo.

Por exemplo, é possível usar o parâmetro label para definir um rótulo para a dimensão cost da seguinte maneira:


dimension: cost {
  label: "price"
  type: number
  sql: ${TABLE}.cost ;;
}

Neste exemplo, a dimensão Custo tem o rótulo preço no seletor de campo.

view_label (campo)

O parâmetro view_label de um campo permite mudar o nome da visualização em que o campo é listado no seletor sem mudar a forma como ele é referenciado no LookML. Se nenhum rótulo for especificado, o campo será exibido abaixo do rótulo da visualização em que foi definido.

Por exemplo, é possível usar o parâmetro view_label da seguinte maneira para especificar um rótulo de visualização para a dimensão cost:


dimension: cost {
  view_label: "Cost Information"
  type: number
  sql: ${TABLE}.cost ;;
}

Neste exemplo, o Looker mostra a dimensão Custo no rótulo da visualização Informações de custo no seletor de campo.

group_label (campo)

O parâmetro group_label permite combinar campos em uma lista suspensa comum em uma visualização no seletor de campo.

Neste exemplo, o grupo Informações de frete inclui os campos Cidade para envio, País para envio e Estado do envio:

O grupo de informações de frete no seletor de campo de uma Análise.

group_item_label (campo)

Quando os campos aparecem sob um marcador de grupo, talvez não seja necessário mostrar os nomes completos ou os rótulos no seletor de campo. No exemplo mostrado anteriormente para group_label (campo), o rótulo do grupo já indica que os campos pertencem ao frete. Nesses casos, você pode adicionar o parâmetro group_item_label a cada um dos campos agrupados para mudar a aparência deles no marcador do grupo.

Neste exemplo, o grupo Informações de frete inclui os campos Cidade, País e Estado:

O grupo de informações de frete no seletor de campo de uma Análise.