O dicionário de dados do Looker é diferente do bloco do dicionário de dados.
Para aproveitar a funcionalidade completa da extensão Dicionário de dados do Looker, os administradores precisam atualizar o aplicativo 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 em todos os campos e descrições do Looker. Use a extensão para:
- Disponibilize um diretório pesquisável com 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 por partes interessadas externas
- Audite modelos do LookML para avaliar se convenções de nomenclatura consistentes são seguidas, se há campos redundantes ou se os campos estão anotados com descrições
- Adicione e compartilhe comentários sobre campos específicos (se o aplicativo do dicionário de dados do Looker estiver na versão 2.0.0 ou posterior)
Para que os usuários acessem e usem o dicionário de dados do Looker, os administradores do Looker precisam:
- Ative os recursos apropriados.
- 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á:
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 Marketplace do Looker (ativado por padrão)
- Extension Framework: para implantar extensões desenvolvidas usando o framework de extensão do Looker (ativado por padrão)
Para instalar aplicativos e ferramentas, como extensões, no Marketplace, você precisa ter as permissões develop, manage_models e deploy.
Consulte a documentação Como usar o Marketplace do Looker para consultar instruções sobre como instalar uma ferramenta. Para garantir que você sempre tenha a versão mais atualizada do dicionário de dados, acesse o Marketplace do Looker, selecione Gerenciar e o 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 podem ser acessadas na página Papéis no painel Administrador.
Os administradores do Looker precisam conceder aos usuários explore ou develop permissões para acessar o modelo data-dictionary e todos os modelos que precisem analisar no dicionário de dados. Consulte a página de documentação Como definir permissões para extensões do Looker se quiser informações sobre como conceder aos usuários permissões para acessar e usar extensões.
Como conceder permissões para interagir com comentários no 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 poderão ver todos os comentários e adicionar, editar e excluir os próprios comentários.
Se quiserem, os administradores do Looker podem gerenciar como os usuários interagem com a funcionalidade de comentários em campo. Para isso, eles podem criar grupos de usuários específicos na página Grupos do painel Administrador e atribuir usuários a eles. 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 devem 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 o usuário não pertencer a nenhum desses grupos, ele será padronizado como writer. Se um usuário estiver atribuído a vários grupos (exceto marketplace_data_dictionary_comments_disabled), o privilégio mais elevado dele terá precedência.
Alterações em um grupo de comentários, como a adição ou remoção de um usuário, feitas na página Grupos no painel Administrador entrarão em vigor após uma atualização forçada da página "Dicionário de dados" ou depois que o usuário selecionar outra opção e retornar à página "Dicionário de dados".
Como acessar o dicionário de dados do Looker
Você pode navegar até o Dicionário de dados na lista de aplicativos e extensões instalados na barra lateral esquerda.
Como visualizar metadados de 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 model 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 os campos correspondentes 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:
- O nome do modelo selecionado
- A lista de Análises no modelo selecionado
- A Análise selecionada
- Um campo de texto para filtrar os campos em um Explore
- 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 ao clicar no botão View Options. Veja todo o conjunto de metadados do campo no field Profiler.
- Linhas contendo metadados para cada campo em uma determinada visualização
- Navegação para "Explorar" na interface do Looker
Como selecionar um modelo e uma Análise
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 de Análises desse modelo.
Também é possível pesquisar o modelo selecionado para um Explore específico digitando na caixa de pesquisa Pesquisar modelo. A lista de Análises será filtrada para exibir apenas os resultados que correspondem aos seus termos de pesquisa.
Selecione o nome de uma Análise para ver os campos, agrupados por visualização, exibidos na parte principal da página.
Você também pode selecionar o botão Explorar no canto superior direito para acessar diretamente a página Explorar no Looker.
Como filtrar campos em um Explore
É possível filtrar os campos exibidos digitando texto na caixa Filtrar campos neste Explore para que ele corresponda à lista de campos Rótulo do campo ou Descrição.
Também é possível selecionar atributos de metadados específicos para filtrar, por exemplo, se o campo:
- Tem uma descrição
- É uma dimensão ou uma medida
- Tem tags
- Tipo: string, number, date, zipcode, count, sum, average, list 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 do 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.
Personalizar os metadados exibidos
Para especificar quais metadados são exibidos em cada campo, selecione o botão View Options no canto superior direito e marque ou desmarque as caixas dos metadados que você quer visualizar.
Como usar comentários do campo
Se uma instância já tiver o Marketplace, os administradores precisarão verificar se a extensão do dicionário de dados está na versão 2.0.0 ou posterior para usar os comentários no nível do 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 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 permitir que os usuários interajam 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 ver todos os comentários e adicionar, editar e excluir os próprios comentários.
Como adicionar 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 no campo) ou um ícone de bloco de notas (se um campo tiver comentários). Clique no ícone para abrir a guia Comments do painel "field Profiler".
- Clique no botão Adicionar comentário.
- Digite seu comentário e selecione o botão Comentar para salvar. Clique em Cancel para fechar o criador de perfil de campo. Você pode expandir a caixa de comentário selecionando e arrastando o canto inferior direito.
Depois que um comentário é adicionado, ele aparece na guia Comments do campo de criação de perfil e é visível para outros usuários.
Como visualizar os comentários do campo
Quando um campo inclui comentários, um ícone de bloco de notas aparece com o número de comentários existentes nesse campo. Clique no ícone do bloco de notas para ver os comentários do campo listados na guia Comments do criador de perfil 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
- A marcação de tempo que aparece quando o comentário foi adicionado
- Uma visualização do comentário
Editar ou excluir um comentário de campo
Para editar ou excluir seus próprios comentários do 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 um comentário, selecione Salvar depois de fazer as alterações.
Como compartilhar um comentário de campo
O URL da guia Comments de cada campo é exclusivo e pode ser copiado e compartilhado com outros usuários que têm acesso a esse modelo no dicionário de dados do Looker.
Como usar o criador de perfil de campo
Quando você clica em uma linha de campo específica, um painel do criador de perfil de campo é aberto à direita da página, com todo o conjunto de metadados do campo, opções para visualizar valores de dimensões numéricas e botões para navegar até o ambiente de desenvolvimento integrado 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 será aberto por padrão na guia Detalhes.
Na seção Distribuição, selecione Calcular para mostrar a visualização de um gráfico de colunas que descreve a distribuição dos valores de contagem para 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ão numérica.
Em Valores, selecione Calcular para mostrar uma prévia dos valores de contagem das dimensões numéricas em uma visualização com uma medida que tenha type: count. Clique no botão Explorar mais para abrir a interface com a dimensão numérica e a medida de contagem pré-selecionadas no seletor de campo.
Selecione Ir para 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 Explorar com campo para abrir a página Explorar com o campo selecionado automaticamente no seletor.