O dicionário de dados do Looker é diferente do bloco do dicionário de dados.
Para aproveitar ao máximo a funcionalidade da extensão do dicionário de dados do Looker, os administradores devem atualizar o aplicativo do dicionário de dados do Looker para a versão 2.0.0 ou posterior.
O dicionário de dados do Looker é uma extensão, um aplicativo da Web criado usando componentes do Looker, desenvolvido usando o framework de extensão do Looker e implantado por meio do Looker Marketplace.
A extensão Looker Data Dictionary oferece uma interface dedicada e centralizada para pesquisar em todos os campos e descrições do Looker. Use essa extensão para:
- Oferecer um diretório pesquisável para todas as métricas e descrições para que os usuários identifiquem a dimensão ou medida apropriada para análise
- Facilite a identificação e localização de métricas exclusivas para partes interessadas externas.
- Faça a auditoria de modelos LookML para avaliar se convenções de nomenclatura consistentes são seguidas, se há campos redundantes ou se os campos são anotados com descrições
- Adicionar e compartilhar comentários sobre campos específicos (se o aplicativo Looker Data Dictionary estiver na versão 2.0.0 ou posterior)
Para que os usuários acessem e usem o dicionário de dados do Looker, administradores do Looker precisam:
- Ative os recursos apropriados.
- Instale a extensão do Looker Data Dictionary.
- Conceda permissões de acesso ao dicionário de dados do Looker (em inglês).
Quando a extensão estiver disponível para os usuários, você vai poder fazer o seguinte:
Como instalar o dicionário de dados do Looker
Antes de instalar o dicionário de dados do Looker do Marketplace, os administradores do Looker precisam ativar estes recursos:
- Marketplace: para acessar o Looker Marketplace (ativado por padrão)
- Extension Framework: para implantar extensões desenvolvidas com o framework de extensão do Looker (ativado por padrão).
Para instalar aplicativos e ferramentas, como extensões, do Marketplace, você precisa ter as permissões develop, manage_models e deploy.
Consulte a documentação Como usar o Looker Marketplace para ver instruções sobre como instalar uma ferramenta do Looker Marketplace. Para garantir que você tenha a versão mais atualizada do dicionário de dados, acesse o Looker Marketplace, clique em Gerenciar e, depois, no botão Atualizar ao lado da extensão.
Como conceder permissões para acessar o dicionário de dados do Looker
Depois que o dicionário de dados do Looker for instalado, um modelo chamado data-dictionary será adicionado automaticamente à lista de modelos disponíveis nas páginas Novo conjunto de modelos e Editar conjunto de modelos, que pode ser acessado na página Papéis no painel Administrador.
Os administradores do Looker precisam conceder aos usuários permissões explore ou develop para acessar o modelo data-dictionary e todos os modelos que precisam explorar no dicionário de dados. Consulte a página de documentação Como definir permissões para extensões do Looker se quiser ver informações sobre como conceder permissões a usuários para acessar e usar extensões.
Como conceder permissões para interagir com comentários do campo
Os comentários de campo oferecem aos usuários a capacidade de adicionar contexto às definições do campo sem precisar atualizar o LookML. Por padrão, todos os usuários com acesso à extensão de dicionário de dados poderão ver todos os comentários e adicionar, editar e excluir seus próprios comentários.
Se quiser, os administradores do Looker podem gerenciar a interação dos usuários com a funcionalidade de comentário de campo criando grupos de usuários específicos na página Grupos do painel Administrador e atribuindo usuários a esses grupos. Consulte a página de documentação Grupos para mais informações sobre como atribuir usuários a grupos.
Os administradores do Looker precisam criar esses grupos com os nomes predefinidos, conforme mostrado abaixo.
Os grupos de usuários precisam ser criados com os nomes predefinidos mostrados na tabela abaixo. A tabela também mostra os privilégios predefinidos que os usuários atribuídos a cada grupo terão.
Se um usuário não pertencer a nenhum desses grupos, o padrão será writer. Se um usuário estiver atribuído a vários grupos (sem incluir marketplace_data_dictionary_comments_disabled), o privilégio mais elevado dele terá precedência.
As mudanças feitas em um grupo de comentários, como adicionar ou remover um usuário, feitas na página Grupos do painel Administrador entrarão em vigor após uma atualização forçada da página do dicionário de dados ou após um clique do usuário e retornar à página do dicionário de dados.
Como navegar para o dicionário de dados do Looker
Você pode acessar o dicionário de dados na lista de aplicativos e extensões instalados, na barra lateral esquerda.
Como visualizar metadados do modelo com o dicionário de dados do Looker
No dicionário de dados do Looker, os usuários com permissões explore em um modelo podem selecionar este modelo e visualizar os metadados dele, incluindo os próprios explores e a lista de campos de cada recurso, agrupada por visualização. O dicionário de dados do Looker exibe as explorações do modelo selecionado na barra lateral esquerda e as visualizações e os campos da área selecionada na parte principal da página.
Os usuários podem recolher a barra lateral clicando no ícone <.
O dicionário de dados do Looker mostra:
- O nome do modelo selecionado
- A lista de explorações contidas no modelo selecionado
- A opção "Explorar" selecionada
- Campo de texto para filtrar os campos em "Explorar"
- Filtros rápidos para restringir campos exibidos com base nas características selecionadas
- Nome da visualização.
- Metadados sobre cada campo. Selecione quais metadados são exibidos clicando no botão Opções de exibição. Veja todo o conjunto de metadados do campo no field profiler.
- Linhas com metadados de cada campo em uma determinada visualização
- Navegação até a guia "Explorar" na IU do Looker
Como selecionar um modelo e explorar
O menu suspenso Selecionar um modelo lista todos os modelos em que um usuário tem permissões explore. Ao escolher um modelo no menu suspenso Selecionar um modelo, a barra lateral esquerda será preenchida com uma lista dos exploradores desse modelo.
Você também pode pesquisar o modelo selecionado para uma exploração específica digitando na caixa de pesquisa Search Model. A lista "Explorar" vai filtrar para mostrar apenas os resultados que correspondem aos seus termos de pesquisa.
Clique no nome de uma exploração para ver os campos agrupados por visualização exibidos na parte principal da página.
Você também pode clicar no botão Explorar no canto superior direito para acessar a página Explorar no Looker.
Como filtrar campos em uma exploração
Para filtrar os campos exibidos, insira texto na caixa Filtrar campos nesta área Explorar para corresponder à lista de Rótulos ou Descrição dos campos.
Você também pode selecionar atributos de metadados específicos para filtrar, como, por exemplo, se o campo:
- Tem uma descrição
- É uma dimensão ou uma medida.
- Tem tags
- Tem os tipos string, number, date, zipcode, count, sum, average, list ou uncitationd
Como visualizar metadados de campo
O dicionário de dados do Looker exibe os metadados para os campos de um Explorar, agrupados por visualização:
- Campo do campo: nome do campo de acordo com o parâmetro
labeldo campo - Categoria: a categoria do campo como dimensão ou medida.
- Descrição: a descrição do campo de acordo com o parâmetro
descriptiondele. - LookML Name: o nome do campo na sintaxe
view_name.field_name - Tipo: o tipo dos campos é string, número, data, zipcode, contagem, sum, average, list ou uncitationd, de acordo com o parâmetro
typedo campo - SQL: a expressão SQL que faz referência a esse campo
- Tags: as tags LookML associadas a esse campo.
Como personalizar metadados exibidos
Para especificar quais metadados são exibidos para cada campo, clique no botão View Options no canto superior direito e marque ou desmarque as caixas dos metadados que você quer ver:
Usar comentários no campo
Se uma instância já tiver o Marketplace, os administradores precisarão garantir que a extensão de dicionário de dados esteja na versão 2.0.0 ou posterior para usar comentários no campo.
Os desenvolvedores do LookML geralmente incluem mais informações ou explicações sobre os campos de um modelo no parâmetro description no nível do campo. No entanto, essas descrições nem sempre são significativas ou úteis para todos os usuários. Com comentários no nível do campo, os usuários podem adicionar contexto a um campo específico. Esses comentários podem ser vistos por outros usuários, mas não afetam o LookML subjacente do modelo.
Os administradores precisam permitir que os usuários interajam com comentários, adicionando-os a grupos específicos na página Grupos do painel Administrador. Por padrão, todos os usuários com acesso à extensão de dicionário de dados podem ver todos os comentários e adicionar, editar e excluir seus próprios comentários.
Adicionar um comentário de campo
Para adicionar um comentário a um campo, siga estas etapas:
- Passe o cursor sobre a linha do campo para ver um ícone + (se não houver comentários de campo) ou um ícone de bloco de notas (se um campo já tiver comentários). Clique no ícone para abrir a guia Comentários do painel do criador de perfil do campo.
- Clique no botão Adicionar comentário.
- Digite seu comentário e clique no botão Comentário para salvar sua entrada. Clique em Cancel para fechar o criador de perfil do campo. Para expandir a caixa de comentários, clique e arraste no canto inferior direito.
Depois de adicionado, o comentário aparece na guia Comentários do criador de perfil do campo e pode ser visível para outros usuários.
Como visualizar comentários de campo
Quando um campo inclui comentários, um ícone de bloco de notas aparece com a quantidade de comentários nesse campo. Clique no ícone de bloco de notas para ver os comentários do campo listados na guia Comentários do criador de perfil do campo.
O número de comentários nesse campo também é indicado entre parênteses na guia Comentários. Cada entrada de comentário mostra as seguintes informações:
- Nome do usuário que fez o comentário
- Carimbo de data/hora que mostra quando o comentário foi adicionado
- Visualização do comentário
Editar ou excluir um comentário de campo
Você pode editar ou excluir seus próprios comentários de campo:
- Clique no ícone de bloco de notas do campo.
- Na guia Comentários, localize e passe o cursor sobre o comentário que você quer editar ou excluir.
- Clique no menu de três pontos e selecione Editar comentário para editar o comentário ou Excluir comentário para excluir o comentário. Se você estiver excluindo o comentário, confirme sua intenção.
- Se você estiver editando o comentário, clique em Salvar depois de fazer as mudanças.
Compartilhar um comentário de campo
O URL da guia Comentários de cada campo é exclusivo e pode ser copiado e compartilhado com outros usuários que tenham acesso a esse modelo no dicionário de dados do Looker.
Como usar o criador de perfil do campo
Clicar em uma linha de campo específica abre um painel do criador de perfil à direita da página que exibe todo o conjunto de metadados do campo, as opções para visualizar os valores de dimensão numérica e os botões para acessar o ambiente de desenvolvimento integrado do Looker ou a página Explorar:
Se você estiver usando a versão 2.0.0 ou posterior da extensão do dicionário de dados do Looker, o criador de perfil do campo será aberto por padrão para a guia Detalhes.
Em Distribuição, clique em Calcular para mostrar uma visualização de um gráfico de colunas que mostra a distribuição dos valores de contagem das dimensões numéricas em uma vista com uma medida que tem type: count. A seção Distribuição também exibe os valores mínimo, máximo e médio da série de dimensões numéricas.
Em Valores, clique em Calcular para mostrar uma visualização dos valores de contagem das dimensões numéricas em uma vista com uma medida que tem type: count. Clique no botão Explorar mais para abrir a IU do recurso Explorar com a dimensão numérica e a medida de contagem pré-selecionadas no seletor de campo.
Clique em Acessar LookML para abrir o arquivo de visualização do projeto LookML associado ao modelo selecionado no Looker IDE.
Clique no botão Explorar com campo para abrir a página Explorar com esse campo selecionado automaticamente no seletor de campo.