Skip to main content

Clarity (telemetria de uso)

O plugin Clarity (clarity) injeta o script de rastreamento do Microsoft Clarity — ferramenta gratuita de analytics que captura como as pessoas usam um site/sistema (mapas de calor, gravações de sessão, cliques e rolagem) — em todas as páginas do ACCELERO. Ele existe para que a IONGRADE entenda o comportamento de uso da interface; não é um recurso operacional para o cliente final.

Ferramenta interna de telemetria

Este plugin é uma ferramenta interna de analytics/telemetria da IONGRADE. Ele apenas adiciona um trecho de script (a "tag" do Microsoft Clarity) ao <head> das páginas, que envia dados de uso para o serviço externo do Clarity. Não traz funcionalidade operacional ao cliente e só deve ser instalado/configurado pela equipe técnica da IONGRADE.

Disponibilidade

Disponibilizado como plugin (clarity), instalado e habilitado pela equipe técnica da IONGRADE. A tela de configuração serve para colar a tag de rastreamento fornecida pelo painel do Microsoft Clarity.

Compatibilidade

Versão atual do plugin: 0.0.2 — compatível com ACCELERO 2.16.0, 2.16.1, 2.16.2, 2.16.3 e 2.16.4 (conforme manifest.json).

O que o plugin faz​

FuncionalidadeO que acontece no ACCELERO
Injeção do script de trackingO conteúdo configurado em Tag clarity é anexado ao final do <head> de todas as páginas renderizadas, ativando o Microsoft Clarity
Configuração da tagUma tela em Configurações permite colar/editar o trecho de script (a tag) que será injetado
Como funciona internamente

O plugin intercepta a renderização do cabeçalho comum das páginas (common_headers_view), lê o valor de clarityTag da configuração e o concatena ao conteúdo do elemento <head>. Se a tag estiver vazia, nada é injetado e nenhum tracking é ativado.

Configuração​

Caminho de acesso: Configurações > Integrações - Clarity

A tela possui uma única aba (Configurações) com um campo:

CampoDescrição
Tag clarityTrecho de script/HTML do Microsoft Clarity a ser injetado no <head> de todas as páginas. Normalmente é o snippet de instalação fornecido pelo painel do Microsoft Clarity

Botões da tela:

BotãoFunção
VoltarRetorna sem salvar
SalvarPersiste o conteúdo do campo Tag clarity
TODO: Adicionar Screenshot

Tela Configurações > Integrações - Clarity, mostrando a aba Configurações com o campo de texto Tag clarity e os botões Voltar/Salvar.

Onde obter a tag

A tag é gerada no painel do projeto do Microsoft Clarity da IONGRADE. Cole o snippet completo, sem alterações. Como o conteúdo é injetado diretamente no <head>, evite colar qualquer outro código que não seja o script oficial do Clarity.

Onde o script é injetado​

O script é adicionado ao <head> de todas as páginas do ACCELERO (não há seleção de telas específicas). A injeção ocorre em tempo de renderização do cabeçalho comum, de modo que o rastreamento passa a valer para toda a navegação do usuário enquanto o plugin estiver ativo e a tag estiver preenchida.

Para desativar o rastreamento, basta limpar o campo Tag clarity e salvar, ou desinstalar o plugin.

Detalhes técnicos​

  • Configuração armazenada: o plugin cria, via migração, o registro de configuração clarity na tabela configuracoes (inicialmente {} vazio). O único campo persistido é clarityTag.
  • Permissão: salvar a configuração exige permissão de edição de configurações (Configuracao → edit).
  • Pós-instalação: o post_install.php reinicia os serviços e limpa o cache para que o interceptor de cabeçalho passe a valer.
Sem entidades estendidas

O plugin não adiciona campos a entidades (Pessoa, Empresa, etc.), telas operacionais, relatórios ou itens de menu próprios além da entrada de configuração. Sua única função é injetar o script de telemetria.

Boas práticas​

  • Mantenha apenas a tag oficial: o campo injeta conteúdo diretamente no <head>; use somente o snippet do Microsoft Clarity.
  • Ative de forma controlada: por ser telemetria de uso, alinhe a ativação com as políticas de privacidade aplicáveis ao ambiente do cliente.
  • Desative quando não estiver coletando: se a coleta não for mais necessária, limpe a tag ou remova o plugin para parar o envio de dados.

Troubleshooting​

O Clarity não registra sessões​

Possíveis causas:

  • Campo Tag clarity vazio ou com snippet incompleto
  • Cache não recarregado após salvar
  • Plugin recém-instalado sem reinício de serviços

Solução:

  1. Confirme em Configurações > Integrações - Clarity que a tag está preenchida com o snippet completo
  2. Salve novamente e limpe o cache do navegador
  3. Verifique no painel do Microsoft Clarity se as sessões começam a aparecer (pode haver atraso de processamento)

Próximos Passos​