Query Builder - Modo Avançado
Introdução
O modo avançado da ferramenta do Query Builder permite a criação de relatórios a partir de dados em SQL. Selecionando essa opção, o usuário poderá inserir apenas o SQL para realizar buscas.
Caminho: Menu Ferramentas > Ferramentas > Query Builder
O acesso à ferramenta exige permissão específica. Para saber como habilitá-la, acesse: Habilitar acesso ao Query Builder
O Modo Avançado concede acesso amplo ao banco de dados, o que o torna uma funcionalidade crítica do sistema. Para mitigar os riscos associados à execução direta de SQL, o acesso a esse modo está condicionado à Autenticação de Dois Fatores (2FA), com as seguintes regras:
- Visibilidade: O botão de alternância para o Modo Avançado só é exibido para usuários com 2FA ativo na sessão.
- Execução de consultas: Antes de executar qualquer consulta em Modo Avançado, o sistema valida (via front-end e back-end) se o usuário possui 2FA ativo. Caso contrário, a execução é bloqueada.
- Permissão de grupos: Ao conceder a permissão "Acesso ao modo avançado" a um grupo de usuários, o sistema verifica se a obrigatoriedade de 2FA do grupo está configurada como "Sim".
Se não estiver, o sistema bloqueia a ação e exibe a mensagem: "O Modo Avançado do Query Builder só pode ser utilizado quando a obrigatoriedade da autenticação de dois fatores está habilitada." Da mesma forma, não é possível remover a obrigatoriedade de 2FA de um grupo que já possui o Modo Avançado liberado.
Exceções:
- Modo Normal: Usuários sem 2FA podem utilizar o Modo Normal normalmente, sem qualquer bloqueio.
- Usuários API: As validações de 2FA não se aplicam a acessos realizados via API. Nesses casos, a rota da API é sempre validada por mecanismo próprio, independentemente do 2FA.
Entrega de Valor
- Maior Flexibilidade
- Controle sobre consultas realizadas
- Maior autonomia para o usuário
Contextualizando o SQL
O SQL é a linguagem que usamos para nos comunicar com bancos de dados. É como um conjunto de comandos que nos permite pedir, adicionar, mudar e apagar informações que estão guardadas de forma organizada. Tecnologicamente, é a Linguagem de Consulta Estruturada, padronizada para gerenciar bancos de dados relacionais.
No Query Builder os dados em SQL serão utilizados apenas para consultas e não terão impacto no banco de dados.
Exemplo de SQL:
SELECT
cliente_contrato.id AS cliente_contrato_id,
cliente_contrato_cliente.razao AS cliente_contrato_cliente_razao,
cliente_contrato_vd_contratos.nome AS cliente_contrato_vd_contratos_nome,
DATE_FORMAT(cliente_contrato.data_ativacao, %d/%m/%Y) AS cliente_contrato_data_ativacao,
DATE_FORMAT(cliente_contrato.data_expiracao, %d/%m/%Y) AS cliente_contrato_data_expiracao,
DATE_FORMAT(cliente_contrato.data_renovacao, %d/%m/%Y) AS cliente_contrato_data_renovacao,
cliente_contrato.status AS cliente_contrato_status
FROM cliente_contrato
LEFT JOIN cliente AS cliente_contrato_cliente
ON cliente_contrato.id_cliente = cliente_contrato_cliente.id
LEFT JOIN vd_contratos AS cliente_contrato_vd_contratos
ON cliente_contrato.id_vd_contrato = cliente_contrato_vd_contratos.id
WHERE cliente_contrato.status = 'A';Funcionalidades Principais
- Conexão de relatórios criados a partir do Modo Avançado com a Looker Studio;
- Visualização em ordem alfabética de visões salvas e campo de busca;
- Exportação dos relatórios em CSV e PDF;
- Importar e exportar visões criadas (formato .js).
Funcionamento da Ferramenta
A Ferramenta de Modo Avançado funcionará da seguinte forma:
- Usuários com as permissões adequadas poderão acessar o Query Builder através do seguinte caminho: Menu Ferramentas → Ferramentas → Query Builder.
- Na tela do Query Builder, o usuário deverá clicar no botão Modo Avançado.
- Será exibida uma interface com duas janelas, enquanto o menu lateral esquerdo será ocultado, proporcionando um ambiente mais adequado para o preenchimento de comandos SQL.
- O usuário poderá inserir sua consulta SQL e, em seguida, selecionar as opções de pré-visualização ou visualização completa para verificar o relatório gerado.
- Após gerar o relatório, será possível salvá-lo clicando no ícone de Salvar.
- Além disso, o relatório poderá ser exportado nos formatos CSV ou PDF.
- Para retornar ao modo padrão, basta clicar no botão Modo Padrão.
O Query Builder permite exportar e importar visões (estruturas de consulta salvas), facilitando a replicação de relatórios entre diferentes bases do sistema.
- Exportar Visão: Salva a configuração atual em um arquivo local.
- Importar Visão: Carrega uma configuração previamente exportada.
Acesso: Menu Ferramentas > Ferramentas > Query Builder > ícone de três pontos (⋯) ao lado dos botões de salvar/editar.
Fluxo de Processo
Caso de Uso
Um usuário do sistema gera um relatório em uma base do IXC Provedor e necessita que outro colaborador reproduza esse mesmo relatório em outro sistema do IXC. Como explicar detalhadamente o passo a passo para o colega pode representar um desafio e há o risco de perda de informações ao tentar replicar o relatório, a melhor abordagem é que o usuário que criou o relatório gere o código SQL correspondente, copie-o e envie para o colega. Dessa forma, o colega pode utilizá-lo no Modo Avançado para reproduzir o relatório de maneira rápida e eficiente, otimizando o tempo de ambos os envolvidos.
Material de Apoio
Disponibilizamos como material de apoio guias detalhados contendo o passo a passo para a geração de relatórios, bem como os respectivos scripts SQL para utilização.
- Contratos Inadimplentes por vendedor
- Consumo e plano de velocidade de login
- Contrato do cliente com plano de venda e contato E muito mais!
Considerações Finais
O Modo Avançado do Query Builder permite inserir comandos SQL para maior controle e precisão nos relatórios. As consultas são apenas para visualização, não modificam o banco, garantindo segurança. Use o material de apoio e compartilhe SQL com colegas para melhorar eficiência e colaboração.