Pular para o conteúdo principal

Modelo

Onde fica: Exportação › Modelo

Um modelo de exportação é uma consulta gravada com um nome: você escreve uma vez a consulta SQL que escolhe os dados, e depois, sempre que precisar, seleciona o modelo e clica em CSV para baixar o resultado num arquivo que abre em planilha ou pode ser importado em outro sistema. O formato do arquivo (separador, cabeçalho, aspas) vem da Configuração CSV; o modelo define só o conteúdo.

A consulta​

A tela abre com a lista dos modelos já cadastrados, em ordem de nome, com as colunas Código e Nome. Use Filtros para procurar um modelo pelo nome (o filtro já vem pronto para "nome contém"). Veja Listagens e filtros.

Um duplo clique na linha abre o modelo para alteração.

Cadastrar um modelo​

  1. Clique em Incluir (F5). Abre o formulário Novo.
  2. Dê um Nome que diga o que sai no arquivo (ex.: "Clientes com telefone").
  3. Escreva a Consulta SQL.
  4. Clique em Gravar. O sistema confirma e volta para a lista.
  5. Para testar, selecione o modelo na lista e clique em CSV.

Campos principais​

CampoPara que serve
CódigoNúmero do modelo, dado pelo sistema ao gravar. Também aparece no nome do arquivo baixado
NomeComo o modelo aparece na lista. Obrigatório, até 128 caracteres
Consulta SQLA consulta que escolhe os dados do arquivo. Obrigatória, até 8.192 caracteres. Cada coluna do resultado vira uma coluna do CSV, e cada linha do resultado, uma linha do arquivo

Botões e ações​

BotãoO que faz
Incluir (F5)Abre o formulário para um modelo novo
Alterar (F4)Abre o modelo selecionado para editar o nome ou a consulta
Excluir (F7)Exclui o modelo selecionado, depois de pedir confirmação
Atualizar (Alt+F5)Recarrega a lista
CSVRoda a consulta do modelo selecionado e baixa o resultado como export-modelo-<código>.csv

Como a exportação funciona​

  • A consulta roda na hora do clique em CSV, direto no banco de dados da sua base. O arquivo traz sempre os dados atuais.
  • O arquivo segue a Configuração CSV da empresa em que você está: separador, se a primeira linha traz os nomes das colunas e se os textos vêm entre aspas.
  • Quando o arquivo tem cabeçalho, os nomes das colunas são os que a consulta devolve. Para ter títulos legíveis na planilha, dê um apelido a cada coluna na própria consulta (por exemplo, SELECT ... AS nome_cliente).
  • A consulta não tem parâmetros: ela roda exatamente como foi gravada. Para mudar um período ou outro filtro, altere a consulta (ou crie um modelo para cada variação).
  • Não há limite de linhas: sai tudo o que a consulta devolver.

Cuidados com a consulta​

Escreva apenas consultas de leitura

Use só SELECT. O sistema não confere o conteúdo da consulta antes de rodá-la, então um comando que altera ou apaga dados não deve ser gravado num modelo. Deixe a criação e a manutenção dos modelos com quem conhece o banco de dados.

  • O sistema não filtra por empresa sozinho. A consulta enxerga os dados de todas as empresas da base; se o arquivo deve trazer só uma empresa, inclua esse filtro na consulta.
  • Consulta com erro não mostra mensagem. O texto é gravado sem ser testado, e, se a consulta falhar ao rodar, o arquivo baixado vem vazio ou incompleto. Depois de gravar ou alterar um modelo, baixe o CSV e confira o arquivo.
  • Consultas pesadas demoram. Como não há limite de linhas, uma consulta sem filtro sobre muitos dados pode levar tempo e gerar um arquivo grande.

Regras e validações​

  • Nome e Consulta SQL são obrigatórios para gravar.
  • Os modelos não pertencem a uma empresa: ficam disponíveis para todas as empresas da base. Só o formato do arquivo muda conforme a Configuração CSV de cada empresa.
  • Ver a lista exige permissão de consultar modelos de exportação; incluir, alterar e excluir exigem permissão de manter os modelos; o botão CSV exige permissão de exportar.

Veja também​