Gerador de relatórios

Índice

Cadastro de relatórios

REPORTS.CAD_REPORTS

Descrição

Este recurso é destinado a usuários avançados que conhecem a estrutura de dados do sistema e que desejam disponibilizar relatórios customizados baseados em queries SQL e que não necessitam de leiautes sofisticados.
Os relatórios podem ser gerados em diversos formatos:

O relatório pode ser montado usando macros ([key] onde key é nome), sendo que essas macros obtém seus valores na sessão, preferências de usuário ou preferências nessa ordem. P.ex.: select .... where usuario_id = [USER_ID]

Uma vez que o relatório foi montado e testado, ele pode:

Observações:

Caso seja apresentada uma mensagem de "alerta", o cadastro do relatório será considerado válido, podendo ser executado normalmente.
Estas mensagens indicam somente que foi realizada uma tentativa de identificar e validar um elemento de banco de dados (tabela ou coluna) ou parâmetro a ser utilizado no relatório.
P.ex.:
Atenção
A query informada não é válida: ERROR: syntax error at or near "$"
Existe um parâmetro com $ para macro substituição, p.ex. ${estabelecimento} para preenchimento da consulta com o nome do estabelecimento informado na tela de pesquisa do relatório.
Atenção
A query informada não é válida: ERROR: syntax error at or near "["
Existe um parâmetro utilizando um elemento de substituição com valores obtidos por elementos como p.ex. [USER_ID] para preenchimento da consulta com o campo de id do usuário logado.


Dicas úteis

Ver também:

Campos:

Nome (código) dado para identificar o relatório. Este código será o código que poderá ser usado nas interfaces de definição das funções de acesso, menu ou agendador de tarefas.
Título dado para o relatório. É com esse nome que os demais usuários irão localizar os relatórios disponíveis. Também é o título que é apresentado no relatório.
A descrição do relatório tem como objetivo esclarecer o seu conteúdo e incluir orientações sobre a sua utilização para os usuários.
Esta descrição pode ser apresentada na tela onde o relatório é impresso marcando a opção "Apresentar descrição".
Define se a descrição informada será apresentada na execução do relatório.
Define quem poderá executar o relatório.
  • Público - A interface pode ser acessada livremente (mesmo usários não logados no sistema).
  • Usuário - Qualquer usuário logado no sistema tem acesso aos recursos da interface
  • Restrito - O acesso é restrito a usuários específicos.
  • Exige credencial - É um tipo especial de política de acesso que pede as credenciais do usuário no momento da operação.
Código (SQL) que faz a pesquisa dos dados que serão formatados conforme as definições do relatório.
Quando informado, indica que o relatório deve ser realizado em uma conexão diferente da padrão.
As opções apresentadas são as conexões disponíbilizadas através dos parâmetros de configuração da base de dados. Para maiores informações, veja Como configurar parâmetros de conexões a bancos de dados?.
Nome do fonte a ser utilizado para o relatório. Ex: Arial, Helvética, etc.
Tamanho do fonte de base.
Cor a ser utilizada nos textos de base.
Cor de fundo para o cabeçalho das colunas.
Orientação da página.
  • Paisagem
  • Retrato
Tamanho da página. Valores aceitos são A4, LETTER, etc.
Margem superior da página em mm.
Margem inferior da página em mm.
Margem esquerda em mm.
Margem direita em mm.
Conteúdo a ser apresentado no lado esquerdo do cabeçalho das páginas. Aceita vários macros:
  • ${company} - Nome da empresa.
  • ${title} - Título do relatório
  • ${date} - Data atual
  • ${time} - Hora atual
  • ${page} - Página
  • ${pages} - Número total de páginas
  • ${globalName} - Código do relatório
  • ${version} - Versão do sistema
  • ${user} - Usuário
Caso não informado, o sistema assume o seguinte padrão: 
${company}
${title}
Conteúdo a ser apresentado no lado direito do cabeçalho das páginas. Aceita as mesmas macros que são aceitas no canto esquerdo.
Nome do fonte para o cabeçalho
Tamanho do fonte para o cabeçalho
Máscara de numeração das páginas. Ex: 000, ###.
Conteúdo a ser apresentado no lado esquerdo do rodapé das páginas. Aceita as mesmas macros que são aceitas no canto superior esquerdo.
Conteúdo a ser apresentado no lado direito do rodapé das páginas. Aceita as mesmas macros que são aceitas no canto superior esquerdo.
Nome do fonte a ser utilizado no rodapé.
Tamanho do fonte a ser utilizado no rodapé.
Representação de todo o relatório no formato json.

Operações

Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação [b:Listar].
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Topo

Listar

Apresenta uma lista com os registros que atendem aos filtros informados.
A lista possui diversos recursos práticos e importantes para o usuário:
Público
Usuário
Restrito
Exige credencial
Topo

Novo

Permite criar novos registros no sistema. Ao ser executado, o sistema apresenta um formulário com todos os campos do registro que deverão ser preenchidos. Quando todos os campos desejados estiverem preenchidos, clique em [b:Salvar].
Comportamento:Topo

Alterar

A partir da tela de consulta de um registro, esta operação permite alterar os dados do mesmo.
O sistema abre um formulário com os campos editáveis. Após alterar os campos, o usuário deverá clicar em [b:Salvar].
Comportamento:Topo

Excluir

Exclui o registro selecionado. A exclusão do registro pode ser disparada a partir da tela de consulta e/ou de manutenção do mesmo.
O registro somente será excluído se todas as condições necessárias forem encontradas, gerando um erro, caso alguma destas condições não estiver sendo atendida.
Comportamento:Topo

Pesquisa simples (SEARCH)

Campos utilizados para pesquisa genérica
Topo

JSON

Permite incluir um relatório pela representação JSON do mesmo.
Topo

teste

Teste
Topo

Executar

Executa relatório delegando função para outro block ("ProReport2").

Dúvidas frequentes

  • Como agendar relatórios para serem executados automaticamente em um determinado horário?

    • Configurações

    REPORTS.CAD_REPORTS.REPORT_VERSION

    Versão de execução dos relatórios

    Indica a versão de execução dos relatórios a partir da ação "Executar" da interface.

    As opções disponíveis são:

    • 0 - PRO_REPORTS
    • 2 - PRO_REPORT2
    Caso não configurado, o sistema assume a versão 2.

    Tipo: TEXT

    Regras

    Calcular JSON

    Monta a representação JSON de todo o relatório.
    Eventos que disparam esta regra:
    • Antes de apresentar uma tela formulário "Alterar"

    Excluir interface

    Após excluir o registro da operação, também é necessário excluir o registro de interface relacionado ao mesmo.
    Eventos que disparam esta regra:
    • Depois de excluir formulário "Excluir"

    Excluir preferências

    Exclui todas as preferências relacionadas ao relatório quando:
    • O relatório for excluído.
    • O nome do relatório for alterado.
    Eventos que disparam esta regra:
    • Depois de alterar formulário "Alterar"
    • Depois de excluir formulário "Excluir"

    Importar JSON

    Inclui (cadastra) um relatório a partir das informações de JSON informadas. Permite obter um relatório de uma base para configuração facilitada em outra base.

    Importar parâmetros do JSON

    Importa os parâmetros do relatório conforme estão registrados no JSON.

    Ler operação do JSON

    Busca os dados da entidade base a partir do JSON.

    Ler preferências

    Verifica as preferências relacionadas ao relatório.
    Eventos que disparam esta regra:
    • Antes de apresentar uma tela formulário "Alterar"

    Popular bases de dados

    Popula as conexões disponíveis para utilizar o relatório em conexões diferentes da conexão padrão.
    O campo de base de dados não será apresentado caso não existam outras conexões.
    Eventos que disparam esta regra:
    • Antes de apresentar uma tela formulário "Alterar"
    • Antes de apresentar uma tela formulário "Novo"

    Salvar colunas

    Atualiza os dados da entidade PARAMETROS_OPERACOES com as colunas do relatório a partir do meta data da query (select).
    Eventos que disparam esta regra:
    • Depois de alterar formulário "Alterar"
    • Depois de inserir formulário "Novo"

    Salvar preferências

    Salva (registra) as preferências relacionadas ao relatório.
    Eventos que disparam esta regra:
    • Depois de alterar formulário "Alterar"
    • Depois de inserir formulário "Novo"