Cadastrar consultas — todos os tipos

Visão geral

No menu a tela se chama Consultas (rota /rotinas). Cada item é uma rotina: define de onde extrair dados e como publicá-los (grade, link externo, exportação).

Há 10 tipos de rotina. Escolha o tipo → a tela mostra os campos corretos.

Pré-requisitos

• Conexão cadastrada (ou armazenamento, no tipo Armazenamento; ou recurso Fabric no tipo Fabric).
• Token de usuário (para montar links e executar).
• Usuário não admin precisa de permissão de Acesso à rotina no perfil.

Como acessar

Consultas → Novo (ou editar na grade).

Ações da lista / da rotina

Ação	Resultado
Novo / Editar / Excluir	Cadastro
Abrir Dados	Executa e mostra grade
Links	Link externo e/ou cURL
Configuração JSON	Modela o retorno (se domínio habilitar)
Exportar	Gera arquivos (se domínio habilitar)

Campos sempre presentes

Campo	Obrigatório	Descrição
Token Rotina	—	Gerado automaticamente; só leitura
Rotina	Sim	Nome da consulta
Tipo	Sim	Um dos 10 tipos
Token Usuário	Sim	Usado na execução e nos links
Habilita Token Url	Não	Libera o link externo autenticado
Habilita Token Header	Não	Libera o cURL com token no header

Tipos suportados

#	Tipo	Origem	Conteúdo principal
1	URL	Conexão HTTP	Url, método, header, retorno JSON
2	API	Conexão HTTP	Url, método, header, body, combinação objeto
3	SAP	Conexão SAP	Body (POST)
4	SQL	Conexão SQL	Script SQL
5	NoSQL	Conexão MongoDB	Query Json
6	SOAP	Endpoint SOAP	Operação, Url Soap, body, retorno XML
7	Armazenamento	Armazenamento	Query Json
8	AWS Athena	Conexão Athena	Script SQL
9	Datalake	Conexão engine	Script SQL
10	Fabric	Conexão Fabric + Recurso	Script SQL

Cadastro por tipo

1. URL

1. Tipo URL → escolha Conexão
2. Método Http, Url, Header, Retorno Json
3. Token usuário + flags → Salvar → Abrir Dados

2. API

1. Tipo API → Conexão
2. Método Http, Url, Header
3. Tipo Body Http e Body (se preenchido, deve ser JSON válido)
4. Opcional: Habilita Combinação Objeto
5. Retorno Json, token e flags → Salvar → Abrir Dados

3. SAP

1. Tipo SAP → conexão SAP
2. Preencha o Body (método tratado como POST)
3. Token → Salvar → Abrir Dados

4. SQL

1. Tipo SQL → conexão SQL (obrigatória)
2. Cole o Script SQL
3. Token → Salvar → Abrir Dados

5. NoSQL

1. Tipo NoSQL → conexão MongoDB (obrigatória)
2. Informe a Query Json
3. Token → Salvar → Abrir Dados

6. SOAP

1. Tipo SOAP
2. Operação Soap, Url Soap, Body, Retorno XML
3. Token → Salvar → Abrir Dados

7. Armazenamento

1. Tipo Armazenamento → escolha o Armazenamento
2. Query Json
3. Token → Salvar → Abrir Dados
   Links de automação podem incluir limite de linhas (maxrows).

8. AWS Athena

1. Tipo AWS Athena → conexão Athena (obrigatória)
2. Script SQL
3. Token → Salvar → Abrir Dados

9. Datalake

1. Tipo Datalake → conexão Databricks/engine (obrigatória)
2. Script SQL
3. Token → Salvar → Abrir Dados

10. Fabric

1. Tipo Fabric → conexão Fabric (obrigatória)
2. Selecione o Recurso do conector
3. Script SQL (obrigatório)
4. Token → Salvar → Abrir Dados
   Se a conexão tiver rota, a Url da rotina pode ser preenchida automaticamente.

Executar (Abrir Dados)

A ação Abrir Dados fica disponível quando o método é GET/POST ou o tipo é SAP/SQL/NoSQL/SOAP/Armazenamento/Athena/Datalake/Fabric.

1. Clique em Abrir Dados e confirme.
2. A grade carrega o resultado (incluindo visualização SAP quando aplicável).

A execução autenticada usa o fluxo interno da plataforma conforme o tipo da rotina.

Links externos e cURL

No diálogo de links:

Campo	Quem edita	Quando aparece
Complementos Link	Administrador	Sempre no diálogo (edição admin)
Link Externo	—	Com Habilita Token Url
cURL	—	Com Habilita Token Header

O consumo externo combina o identificador (token) da rotina com o token de usuário.

Configuração JSON do retorno

Se o domínio tiver Configuração JSON ligada, abra a configuração da consulta:

Aba	Função
Schema	Estrutura
Remover / Selecionar / Renomear	Campos do payload
Ordenar	Ordenação
Filtrar	Condições E/Ou
Agrupar	Agregações
Schema Final	Resultado

Exportação

Se o domínio tiver Configuração Exportação ligada:

1. Abra a exportação da consulta.
2. Escolha o tipo de arquivo e rode Exportar.
3. Em Arquivos Exportados, baixe, veja logs ou exclua.

Permissões

Perfil	Comportamento
Administrador	Vê rotinas do contexto do sistema/empresa
Comum	Só rotinas com Acesso no perfil

Erros comuns

Problema	Causa típica
Não salva	Campos obrigatórios vazios; body API inválido
Abrir Dados sem resultado	Conexão inválida, SQL/query errada, permissão
Link externo falha	Token usuário inválido/expirado ou flag Url desligada
Sem Config JSON / Exportar	Flags desligadas no Domínio

Boas práticas

1. Nomeie consultas pelo negócio (Pedidos_Diarios), não só pelo tipo técnico.
2. Teste com Abrir Dados antes de agendar.
3. Restrinja permissões de perfil em consultas sensíveis.
4. Use Configuração JSON para publicar só as colunas necessárias.

Veja também

• Cadastrar conexões
• Cadastrar armazenamento
• Agendamentos
• API e tokens