O dicionário de dados do Looker é diferente do bloco de dicionário de dados.
Para aproveitar todas as funcionalidades da extensão do Dicionário de dados do Looker, os administradores precisam atualizar o aplicativo do Dicionário de dados do Looker para a versão 2.0.0 ou mais recente.
O dicionário de dados do Looker é uma extensão, um aplicativo da Web criado com componentes do Looker, desenvolvido com o framework de extensão do Looker e implantado no Marketplace do Looker.
A extensão do dicionário de dados do Looker oferece uma interface dedicada e centralizada para pesquisar todos os campos e descrições do Looker. Use essa extensão para realizar estas tarefas: * Fornecer um diretório pesquisável para todas as métricas e descrições para que os usuários identifiquem a dimensão ou métrica adequada para a análise. * Facilitar a identificação e localização de métricas únicas pelas partes interessadas externas. * Audite os modelos do LookML para avaliar se as convenções de nomenclatura consistentes foram seguidas, se há campos redundantes ou se os campos são anotados com descrições. * Adicione e compartilhe comentários sobre campos específicos se o aplicativo de dicionário de dados do Looker estiver na versão 2.0.0 ou mais recente.
Para que os usuários acessem e usem o dicionário de dados do Looker, os administradores do Looker precisam seguir estas etapas:
- Ative os recursos adequados.
- Instale a extensão do dicionário de dados do Looker.
- Conceda permissões para acessar o dicionário de dados do Looker.
Quando a extensão estiver disponível para os usuários, você poderá fazer o seguinte:
Como instalar o dicionário de dados do Looker
Antes de instalar o dicionário de dados do Looker no Marketplace, os administradores do Looker precisam ativar estes recursos:
- Marketplace: para acessar o Looker Marketplace (ativado por padrão).
- Framework de extensões: para implantar extensões desenvolvidas usando o framework de extensões do Looker (ativado por padrão)
Para instalar aplicativos e ferramentas do Marketplace, como extensões, você precisa ter as permissões develop, manage_models e deploy.
Consulte a documentação Como usar o Marketplace do Looker para instruções sobre como instalar uma ferramenta do Marketplace do Looker. Para garantir que você sempre tenha a versão mais atualizada do dicionário de dados, acesse o Marketplace do Looker, selecione Gerenciar e clique no botão Atualizar ao lado da extensão.
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 podem ser acessadas na página Papéis no painel Administrador.
Os administradores do Looker precisam conceder aos usuários as permissões explore ou develop para acessar o modelo data-dictionary e todos os modelos que eles precisam analisar no dicionário de dados. Consulte a página de documentação Como definir permissões para extensões do Looker para mais informações sobre como conceder permissões aos usuários para acessar e usar extensões.
Como conceder permissões para interagir com os comentários de campo
Os comentários de campo oferecem aos usuários a capacidade de adicionar contexto às definições de campo sem precisar atualizar o LookML. Por padrão, todos os usuários que têm acesso à extensão do dicionário de dados podem ver todos os comentários e adicionar, editar e excluir os próprios comentários.
Se quiserem, os administradores do Looker podem gerenciar a interação dos usuários com a funcionalidade de comentários de campo criando grupos de usuários específicos na página Groups do painel Admin 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 grupos de usuários precisam ser criados com os nomes predefinidos mostrados na coluna "Nome do grupo" da tabela a seguir. A tabela também mostra os privilégios predefinidos que os usuários atribuídos a cada grupo vão ter.
Se um usuário não pertencer a nenhum desses grupos, o padrão será writer. Se um usuário for atribuído a vários grupos (não incluindo marketplace_data_dictionary_comments_disabled), o privilégio mais elevado dele terá precedência.
As alterações em um grupo de comentários, como a adição ou remoção de um usuário, que são feitas na página Grupos no painel Administrador entram em vigor após uma atualização forçada da página "Dicionário de dados" ou depois que o usuário seleciona outra opção e retorna à página "Dicionário de dados".
Como navegar até 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 conferir 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 esse modelo e conferir os metadados dele, incluindo as Análises e a lista de campos de cada uma delas, agrupadas por visualização. O dicionário de dados do Looker mostra as Análises do modelo selecionado na barra lateral esquerda e as visualizações e campos da Análise selecionada na parte principal da página.
Os usuários podem recolher a barra lateral selecionando o ícone <.
O dicionário de dados do Looker mostra as seguintes informações:
- O nome do modelo selecionado
- Lista de Análises contidas no modelo selecionado
- A Análise selecionada
- Um campo de texto para filtrar os campos em uma Análise detalhada
- Filtros rápidos para restringir os campos exibidos com base nas características selecionadas
- O nome da visualização
- Metadados sobre cada campo. Selecione quais metadados serão exibidos clicando no botão Opções de visualização. Confira todo o conjunto de metadados do campo no criador de perfil de campo.
- Linhas contendo metadados de cada campo em uma determinada visualização
- Navegação até a seção "Explorar" na interface do Looker
Como selecionar um modelo e uma Análise
A lista suspensa Selecionar um modelo lista todos os modelos para os quais um usuário tem permissões explore. Ao escolher um modelo no menu suspenso Selecionar um modelo, a barra lateral esquerda vai ser preenchida com uma lista das Análises desse modelo.
Você também pode pesquisar um Análise detalhada específico no modelo selecionado digitando na caixa de pesquisa Pesquisar modelo. A lista de Análises é filtrada para mostrar apenas os resultados que correspondem aos termos de pesquisa.
Selecione o nome de uma Análise para ver os campos dela, agrupados por visualização, exibidos na parte principal da página.
Selecione o botão Explorar no canto superior direito para acessar a página Explorar no Looker.
Como filtrar campos em uma Análise detalhada
Filtre os campos exibidos digitando texto na caixa Filtrar campos nesta Análise para fazer correspondência com a lista de campos Rótulo do campo ou Descrição.
Também é possível selecionar atributos de metadados específicos para filtrar, como se o campo:
- Tem uma descrição
- É uma dimensão ou uma medida.
- Tem tags
- Tem o tipo string, número, data, CEP, contagem, soma, média, lista ou sem aspas
Como visualizar metadados de campo
O dicionário de dados do Looker mostra os metadados dos campos de uma análise, agrupados por visualização:
- Rótulo do campo: o nome do campo de acordo com o parâmetro
label - Categoria: a categoria do campo como uma dimensão ou uma medida
- Descrição: a descrição do campo de acordo com o parâmetro
description. - Nome do LookML: o nome do campo na sintaxe
view_name.field_name - Tipo: o tipo de campo como string, number, date, zipcode, count, sum, average, list ou sem aspas 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 em cada campo, selecione o botão Opções de visualização no canto superior direito e marque ou desmarque as caixas dos metadados que você quer ver.
Usar os comentários do campo
Se uma instância já tiver o Marketplace, os administradores precisam garantir que a extensão do dicionário de dados esteja na versão 2.0.0 ou mais recente para usar os comentários no nível do campo.
Os desenvolvedores do LookML geralmente incluem informações ou explicações adicionais 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 em nível de campo, os usuários podem adicionar contexto a um campo específico. Esses comentários ficam visíveis para outros usuários, mas não afetam o LookML subjacente do modelo.
Os administradores precisam conceder aos usuários a capacidade de interagir com os 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 do dicionário de dados podem acessar todos os comentários e adicionar, editar e excluir os próprios comentários.
Adicionando um comentário no campo
Para adicionar um comentário a um campo:
- Passe o cursor sobre a linha do campo para revelar um ícone + (se não houver comentários) ou um ícone de bloco de notas (se houver comentários). Clique no ícone para abrir a guia Comments do painel do criador de perfil de campo.
- Clique no botão Adicionar comentário.
- Digite seu comentário e selecione o botão Comentário para salvar a entrada. Clique em Cancel para fechar o criador de perfil de campo. Para expandir a caixa de comentários, selecione e arraste o canto inferior direito.
Depois que um comentário é adicionado, ele aparece na guia Comentários do perfil de campo e fica 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 o número de comentários que existem nesse campo. Clique no ícone de bloco de notas para conferir os comentários do campo listados na guia Comentários do perfilador de 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:
- O nome do usuário que fez o comentário
- O carimbo de data/hora que mostra quando o comentário foi adicionado
- Uma prévia do comentário
Como editar ou excluir um comentário de campo
Para editar ou excluir seus próprios comentários no campo:
- Selecione o ícone do 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 for excluir o comentário, confirme sua intenção.
- Se você estiver editando o comentário, selecione Salvar depois de fazer as alterações.
Como 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 ao modelo no dicionário de dados do Looker.
Como usar o criador de perfil de campo
Clique em uma linha de campo específica para abrir um painel de análise de campo que mostra o conjunto completo de metadados do campo, opções para visualizar valores de dimensão numérica e botões para navegar até o IDE do Looker ou a página Explorar.
Se você estiver usando a versão 2.0.0 ou mais recente da extensão do Dicionário de Dados do Looker, o criador de perfil de campo vai abrir por padrão na guia Detalhes.
Na seção Distribuição, selecione 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 visualização com uma medida que tem type: count. A seção Distribuição também mostra os valores mínimo, máximo e médio da série de dimensões numéricas.
Em Valores, selecione Calcular para mostrar uma prévia dos valores de contagem das dimensões numéricas em uma visualização com uma métrica que tem type: count. Selecione o botão Veja mais para abrir a interface com a dimensão numérica e a medição de contagem pré-selecionadas no seletor de campo.
Selecione Go to LookML para abrir o arquivo de visualização do projeto do LookML associado ao modelo selecionado no ambiente de desenvolvimento integrado do Looker.
Selecione o botão Analisar com campo para abrir a página Análise com esse campo selecionado automaticamente no seletor.