Usar a extensão do dicionário de dados do Looker

O dicionário de dados do Looker é uma extensão, uma aplicação Web criada com componentes do Looker, desenvolvida através da framework de extensão do Looker e implementada através do mercado do Looker.

A extensão Looker Data Dictionary oferece uma interface dedicada e centralizada para pesquisar todos os seus campos e descrições do Looker. Use esta extensão para realizar as seguintes tarefas:

  • Fornecer um diretório pesquisável para todas as métricas e descrições para os utilizadores identificarem a dimensão ou a medida adequada para análise.
  • Permitir que as partes interessadas externas identifiquem e localizem métricas únicas.
  • Audite os modelos LookML para avaliar se são seguidas convenções de nomenclatura consistentes, se existem campos redundantes ou se os campos estão anotados com descrições.
  • Adicionar e partilhar comentários sobre campos específicos (se a sua aplicação do dicionário de dados do Looker estiver na versão 2.0.0 ou posterior). Pode verificar se tem a versão mais atualizada do dicionário de dados acedendo ao Looker Marketplace, selecionando Gerir e, de seguida, o botão Atualizar junto à extensão.

Fluxo de trabalho do dicionário de dados

Para que os utilizadores acedam e usem o dicionário de dados do Looker, um administrador do Looker tem de seguir estes passos:

  1. Ative as funcionalidades adequadas.
  2. Instale a extensão do dicionário de dados do Looker.
  3. Conceda autorizações para aceder ao dicionário de dados do Looker.

Quando a extensão estiver disponível para os utilizadores, pode fazer o seguinte:

  1. Navegue para a extensão dicionário de dados do Looker.
  2. Veja os metadados do seu modelo.

Antes de começar

Antes de instalar o dicionário de dados do Looker a partir do Marketplace, um administrador do Looker tem de ativar estas funcionalidades:

  • Marketplace: para aceder ao Looker Marketplace (ativado por predefinição)
  • Framework de extensões: para implementar extensões desenvolvidas com o framework de extensões do Looker (ativado por predefinição)

A instalação de aplicações e ferramentas, como extensões, a partir do mercado do Looker requer que tenha as develop, manage_models e deploy autorizações.

Instalar o dicionário de dados do Looker

Consulte a documentação Usar o Looker Marketplace para obter instruções sobre como instalar uma ferramenta a partir do Looker Marketplace. Após a instalação do dicionário de dados, um administrador do Looker tem de conceder autorizações aos utilizadores para realizarem as seguintes tarefas:

Conceder autorizações para aceder à extensão do dicionário de dados do Looker

Após a instalação do dicionário de dados do Looker, é adicionado automaticamente um modelo denominado data-dictionary à lista de modelos disponíveis nas páginas Novo conjunto de modelos e Editar conjunto de modelos, acessíveis a partir da página Funções no painel Administração.

Um administrador do Looker tem de conceder aos utilizadores explore ou develop autorizações para acederem ao modelo data-dictionary e a quaisquer modelos que precisem de explorar no dicionário de dados. Consulte a página de documentação Definir autorizações para extensões do Looker para ver informações sobre como conceder autorizações aos utilizadores para acederem e usarem extensões.

Conceder autorizações para interagir com comentários de campos

Os comentários de campos permitem aos utilizadores adicionar contexto às definições de campos sem ter de atualizar o LookML. Por predefinição, todos os utilizadores com acesso à extensão do dicionário de dados podem ver todos os comentários, bem como adicionar, editar e eliminar os seus próprios comentários.

Um administrador do Looker pode gerir a forma como os utilizadores interagem com a funcionalidade de comentários de campos criando grupos de utilizadores específicos na página Grupos do painel Administração e atribuindo utilizadores a esses grupos. Consulte a página de documentação Grupos para mais informações sobre como atribuir utilizadores a grupos.

Os grupos de utilizadores têm de ser criados com os nomes predefinidos apresentados na coluna Nome do grupo da tabela seguinte. A tabela também mostra os privilégios predefinidos que os utilizadores atribuídos a cada grupo vão ter.

Nome do grupo Privilégios
marketplace_data_dictionary_comments_disabled Os utilizadores não podem ver nem interagir de outra forma com comentários. Todas as capacidades de comentários estão desativadas. Os privilégios deste grupo têm sempre precedência sobre os de outros grupos. Qualquer utilizador incluído no grupo disabled não pode ver nem fazer comentários, mesmo que também pertença a outro grupo com privilégios mais elevados.
marketplace_data_dictionary_comments_reader O utilizador pode ver os comentários existentes, mas não pode adicionar nenhum.
marketplace_data_dictionary_comments_writer Os utilizadores podem ver todos os comentários, adicionar novos comentários e editar/eliminar os seus próprios comentários. Este é o privilégio predefinido.
marketplace_data_dictionary_comments_manager Os utilizadores podem ver todos os comentários, adicionar novos comentários e editar/eliminar todos os comentários.

Se um utilizador não pertencer a nenhum destes grupos, a predefinição é writer. Se um utilizador for atribuído a vários grupos (não incluindo marketplace_data_dictionary_comments_disabled), o respetivo privilégio mais elevado tem precedência.

Pode navegar para o dicionário de dados a partir da lista de aplicações e extensões instaladas na barra lateral esquerda.

Ver metadados do modelo com o dicionário de dados do Looker

No dicionário de dados do Looker, os utilizadores com autorizações explore num modelo podem selecionar este modelo e ver os respetivos metadados, incluindo os respetivos Explores e a lista de campos de cada Explore, agrupados por vista. O dicionário de dados do Looker apresenta os Explorar do modelo selecionado na barra lateral esquerda e as vistas e os campos do Explorar selecionado na parte principal da página.

Os utilizadores podem reduzir a barra lateral selecionando o ícone <.

O dicionário de dados do Looker mostra as seguintes informações:

  1. O nome do modelo selecionado
  2. A lista de explorações contidas no modelo selecionado
  3. A opção Explorar selecionada
  4. Um campo de texto para filtrar os campos numa exploração
  5. Filtros rápidos para restringir os campos apresentados com base nas caraterísticas selecionadas
  6. O nome da vista
  7. Metadados sobre cada campo. Selecione os metadados apresentados selecionando o botão Opções de visualização. Veja o conjunto completo de metadados do campo no perfilador de campos.
  8. Linhas que contêm metadados para cada campo numa determinada vista
  9. Navegação para a opção Explorar na IU do Looker

Selecionar um modelo e uma opção Explorar

O menu pendente Selecionar um modelo apresenta todos os modelos para os quais um utilizador tem autorizações explore. Quando escolhe um modelo no menu pendente Selecionar um modelo, a barra lateral esquerda é preenchida com uma lista das explorações desse modelo.

Também pode pesquisar um modelo específico no Explorar escrevendo na caixa de pesquisa Pesquisar modelo. A lista de Explorações é filtrada para apresentar apenas os resultados que correspondem aos seus termos de pesquisa.

Selecione o nome de uma exploração para ver os respetivos campos, agrupados por vista, apresentados na parte principal da página.

Também pode selecionar o botão Explorar no canto superior direito para aceder diretamente à página Explorar no Looker.

Filtrar campos numa exploração

Pode filtrar os campos apresentados escrevendo texto na caixa Filtrar campos nesta análise detalhada para corresponder à Etiqueta do campo ou à Descrição da lista de campos.

Também pode selecionar atributos de metadados específicos para filtrar, como se o campo:

Visualizar metadados de campos

O dicionário de dados do Looker apresenta os metadados dos campos de uma exploração, agrupados por vista:

Personalizar os metadados apresentados

Pode especificar os metadados apresentados para cada campo selecionando o botão Opções de visualização no canto superior direito e selecionando ou desmarcando as caixas dos metadados que quer ver.

Usar comentários de campos

Os programadores de LookML incluem frequentemente informações ou explicações adicionais sobre os campos de um modelo no parâmetro description ao nível do campo. No entanto, estas descrições nem sempre são significativas ou úteis para todos os utilizadores. Com os comentários ao nível do campo, os utilizadores podem adicionar contexto a um campo específico. Estes comentários são visíveis para outros utilizadores, mas não afetam o LookML subjacente do modelo.

Um administrador do Looker tem de conceder aos utilizadores a capacidade de interagir com os comentários, adicionando-os a grupos específicos na página Grupos do painel Administração. Por predefinição, todos os utilizadores com acesso à extensão do dicionário de dados podem ver todos os comentários e adicionar, editar e eliminar os seus próprios comentários.

Adicionar um comentário de campo

Para adicionar um comentário a um campo:

  1. Passe o cursor do rato sobre a linha do campo para revelar um ícone + (se não existirem comentários de campo) ou um ícone de bloco de notas (se um campo tiver comentários). Clique no ícone para abrir o separador Comentários do painel do perfilador de campos.
  2. Clique no botão Adicionar comentário.
  3. Escreva o seu comentário e selecione o botão Comentar para guardar a entrada. Clique em Cancelar para fechar o perfilador de campos. Pode expandir a caixa de comentários selecionando e arrastando o canto inferior direito.

Depois de adicionar um comentário, este aparece no separador Comentários do perfilador de campos e é visível para outros utilizadores.

Ver comentários de campos

Quando um campo inclui comentários, é apresentado um ícone de bloco de notas com o número de comentários existentes nesse campo. Clique no ícone de bloco de notas para ver os comentários do campo apresentados no separador Comentários do criador de perfis de campos.

O número de comentários nesse campo também é indicado entre parênteses no separador Comentários. Cada entrada de comentário mostra as seguintes informações:

  • O nome do autor do comentário
  • A indicação de tempo que mostra quando o comentário foi adicionado
  • Uma pré-visualização do comentário

Editar ou eliminar um comentário de campo

Para editar ou eliminar os seus próprios comentários de campo:

  1. Selecione o ícone de bloco de notas do campo.
  2. No separador Comentários, localize e passe o cursor do rato sobre o comentário que quer editar ou eliminar.
  3. Clique no menu de três pontos e selecione Editar comentário para editar o comentário ou Eliminar comentário para eliminar o comentário. Se estiver a eliminar o comentário, confirme a sua intenção.
  4. Se estiver a editar o seu comentário, selecione Guardar depois de fazer as alterações.

Partilhar um comentário de campo

O URL do separador Comentários de cada campo é único e pode ser copiado e partilhado com outros utilizadores que tenham acesso a esse modelo no dicionário de dados do Looker.

Usar o criador de perfis de campos

Clique numa linha de campo específica para abrir um painel de criação de perfis de campos que apresenta o conjunto completo de metadados do campo, opções para pré-visualizar valores de dimensões numéricas e botões para navegar para o IDE do Looker ou para a página Explorar.

Se estiver a usar a versão 2.0.0 ou posterior da extensão Looker Data Dictionary, o criador de perfis de campos é aberto por predefinição no separador Detalhes.

Na secção Distribuição, selecione Calcular para mostrar uma pré-visualização de um gráfico de colunas que representa a distribuição dos valores de contagem para dimensões numéricas numa vista com uma medida que tenha type: count. A secção Distribuição também apresenta 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é-visualização dos valores de contagem para dimensões numéricas numa vista com uma medida que tenha type: count. Selecione o botão Explorar mais para abrir a IU Explorar com a dimensão numérica e a medida de contagem pré-selecionadas no selecionador de campos.

Selecione Ir para LookML para abrir o ficheiro de vista do projeto LookML associado ao modelo selecionado no IDE do Looker.

Selecione o botão Explorar com campo para abrir a página Explorar com esse campo selecionado automaticamente no seletor de campos.