framework de extensões do Looker

Observação :a partir do Looker 22.20, para resolver possíveis violações da Política de Segurança de Conteúdo (CSP), existe um novo mecanismo de carregamento aprimorado para o framework de extensão do Looker. Para mais informações, consulte a página de documentação Configurações de administrador: framework da extensão.

A biblioteca de extensão do Looker é uma estrutura de desenvolvimento que reduz significativamente o esforço e a complexidade da criação de aplicativos e ferramentas de dados JavaScript personalizados, como:

• Aplicativos de plataforma internos para sua empresa
• Plataformas externas para seus clientes, como portais para aplicativos incorporados do Google Analytics criados com dados no Looker
• Ferramentas internas segmentadas
• Aplicativos para incorporação em aplicativos externos

Os exemplos atuais de extensões do Looker que estão disponíveis no Looker Marketplace incluem o Dicionário de Dados e o Diagrama do Looker.

Por que usar a estrutura de extensão?

Algumas partes da criação de aplicativos da Web são fáceis e divertidas, enquanto outras obviamente são mais demoradas e não exatamente divertidas. A estrutura de extensão ajuda a simplificar muitas dessas tarefas não tão divertidas.

A estrutura de extensão cuida de alguns dos aspectos mais tediosos da criação de um aplicativo da web para que você possa se concentrar em iniciar o desenvolvimento imediatamente. Os aplicativos e ferramentas personalizados criados com o framework de extensão podem ser acessados no Looker, permitindo que ele realize os seguintes tipos de funções, como:

• Authentication: permite que você use as opções de autenticação existentes do Looker para login (como login de senha, LDAP, SAML e OpenID Connect).
• Gerenciamento de permissões e controle de acesso.
• Acesso à API: permite usar outros recursos comuns para desenvolvedores, como endpoints de API de terceiros, no Looker.

Recursos do framework de extensão

O framework de extensão do Looker inclui os seguintes recursos:

• O SDK da extensão do Looker, que fornece funções para acesso à API pública do Looker e para interação no ambiente do Looker.
• Looker components, uma biblioteca de componentes de IU do React pré-criados que você pode usar em suas extensões.
• O SDK incorporado, uma biblioteca que você pode usar para incorporar painéis, visuais e explorações à sua extensão. Consulte o exemplo de código da extensão de coletor da cozinha. Você também pode usar o SDK incorporado para incorporar sua extensão em aplicativos de terceiros. Os cookies precisam estar ativados no navegador quando você incorpora Explorar, Aparências ou painéis em uma extensão.
• O utilitário create-looker-extension, que cria uma extensão básica que inclui todos os arquivos de extensão e dependências necessários. Você pode usá-los como ponto de partida.
• Nosso repositório de exemplos de estruturas de extensão do Looker, que inclui modelos e exemplos de extensões para ajudar você a dar os primeiros passos rapidamente.
• A capacidade de acessar endpoints de API de terceiros e adicionar dados de terceiros à extensão.

• A capacidade de criar extensões de tela cheia no Looker. As extensões de tela cheia podem ser usadas para aplicativos de plataforma internos ou externos.

  Em uma extensão de tela cheia, você pode adicionar usuários a um grupo "Somente extensões" para impedir que um conjunto de usuários navegue para outras partes do Looker. Também é possível remover a barra de navegação do Looker substituindo /extensions por /spartan no URL da extensão.

• A capacidade de configurar uma chave de acesso para sua extensão de modo que os usuários precisem digitá-la para executá-la. Isso é útil se você quiser cobrar pela extensão, mas use as permissões padrão do Looker para bloquear o acesso a quem não tem acesso a ela.

Requisitos do framework de extensão

Para desenvolver usando o framework de extensão do Looker:

• Você precisará de permissões de desenvolvedor do LookML para sua instância.
• Seu administrador do Looker precisa ativar o recurso Extension Framework.
• Recomendamos que você esteja familiarizado com JavaScript ou TypeScript.
• Recomendamos o desenvolvimento em React, embora haja um SDK de extensão para JavaScript bruto.

Para serem executadas no Looker, todas as extensões, independentemente da função, precisam incluir os seguintes elementos:

• Um projeto LookML que:

  • Inclui um arquivo de modelo
  • Inclui um arquivo de manifesto do projeto.
  • está conectado a um repositório Git;

• O arquivo de modelo do LookML precisa de um parâmetro connection que aponte para uma conexão de banco de dados válida na instância.

• O arquivo de manifesto do projeto requer um parâmetro application. O parâmetro application dá à extensão um rótulo, informa ao Looker onde encontrar a extensão JavaScript e fornece uma lista de direitos para a extensão. Os direitos definem os recursos do Looker que a extensão pode acessar. A extensão só poderá acessar um recurso do Looker se ele estiver listado nos direitos. Veja a seguir um exemplo de arquivo de manifesto do projeto com um parâmetro application:

  project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    entitlements: {
      local_storage: no
      navigation: no
      new_window: no
      new_window_external_urls: []
      use_form_submit: yes
      use_embeds: no
      use_downloads: no
      core_api_methods: []
      external_api_urls: []
      oauth2_urls: []
      scoped_user_attributes: []
      global_user_attributes: []
    }
  }

Para detalhes, consulte a página de documentação do parâmetro application.

Primeiros passos no desenvolvimento com o framework de extensão do Looker

A maneira mais fácil de começar é gerar primeiro uma nova extensão inicial a partir de um modelo e, em seguida, personalizar e adicionar funcionalidades a esse inicializador. Isso garante que todas as configurações e pacotes estejam corretas, o que pode ser difícil de fazer manualmente. Consulte a página de documentação Como criar uma extensão do Looker para ver instruções sobre como criar um novo projeto do Looker para sua extensão e gerar uma extensão inicial.

Para modelos mais personalizados ou avançados, navegue pelo repositório de exemplos de framework da extensão do Looker. Qualquer extensão nesse repositório pode ser clonada e adaptada como um ponto de partida para seu projeto.

Depois de criar uma extensão simples e verificar que tudo está funcionando, você pode começar a adicionar funcionalidades e personalizações adicionais:

• Veja uma lista de casos de uso comuns com exemplos de código na página de documentação Exemplos de códigos de framework da extensão do Looker.

• Consulte o site Componentes de IU do Looker (link em inglês) para usar nossa biblioteca de componentes e desenvolver rapidamente UI e o layout.

• O Looker Extension Kitchensink Template é uma extensão que fornece exemplos de diversas funcionalidades. Você pode usar este modelo como uma enciclopédia ou um guia de referência, mas não como um ponto de partida ou um modelo real. Recomendamos que você use nosso gerador de extensões ou clone um dos exemplos mais simples para começar.