Gerador de relatórios

Índice

Interfaces dos sistemas

REPORTS.MAN_INTERFACES_SISTEMAS

Campos:

Nome global utilizado para identificar o componente de interface. Quando for uma interface customizada (cadastrada diretamente no ambiente de produção), seu nome será automaticamente precedido pela palavra "CUSTOM.".

Para interfaces bundled, o nome é sempre precedido pela identificação do módulo a que ele participa.
Ex:
  • APPREF.CAD_PEDIDO
  • PROJET.TIPOS_ATIVIDADES
  • RTPREF.CFG_INTERFACES_SISTEMAS
  • RTAUTH.PRO_LOGIN
Título original da interface conforme o idioma de desenvolvimento.
Ex:
  • Cadastro de pedidos
  • Tipos de atividades
  • Configurações das interfaces
  • Login
Separa os registros quanto à sua origem.
  • Bundled - A interface faz parte do pacote oficial do sistema.
  • Custom - A interface foi criada no ambiente de produção.
  • Depreciada - A interface se refere a um relatório ou rotina custom cadastradas da forma antiga e que deverão ser migradas para a nova versão.
Texto livre para descrever a interface.
Nome global da entidade base com a qual esta interface está associada. Esta informação é útil em diversas situações:
  • Identificação de quais relatórios (RECORD_REPORT) podem ser emitidos a partir de uma interface
  • Quais scripts podem ser disparados em um determinado evento de entidade
  • Definir a entidade para interface CRUD customizada
Atenção
Esse atributo será substituído pelo atributo ENTIDADE_BASE_ID (FK)
Estereótipo do bloco de interface.
  • Bloco de interação - Estereótipo utilizado para interfaces que possuem um padrão genérico de interação com o usuário. Exemplo CRUD. Pode conter N operações livres.
  • Rotina - Trata-se de uma rotina que pode ser disparada em algum evento, no contexto de alguma interface ou diretamente por um item de menu.
  • Relatório (lista) - Geração de uma saída (normalmente um arquivo PDF) a partir de um conjunto de filtros opcionais. Normalmente composto por uma operação QUERY e outra REPORT.
  • Relatório (objeto) - Geração de uma saída (normalmente um arquivo PDF) a partir de um registro específico (entidade e ID). Esse tipo de relatório, normalmente é composto de apenas uma operação (RECORD_REPORT) com implementação Jasper ou outro Script Engine. Opcionalmente pode ter uma operação QUERY para identificar o registro desejado e informar parâmetros adicionais utilizados no relatório.
  • Etiqueta - A interface é um relatório que gera etiquetas. O tamanho das etiquetas é apresentado em atributos específicos.
Nome do mecanismo utilizado para executar a interface.
  • Nativo - O bloco de interface é executado através do mecanismo padrão para execução de blocos compilados em classes nativas pertencentes ao class-loader do sistema (normalmente Java). O mecanismo de execução do sistema irá buscar uma classe que implementa a interface ServiceModel. Caso não seja informada o nome da classe, o sistema irá buscar conforme as convenções de nomes configuradas.
  • Jasper - O bloco é executado através do runtime Jasper Reports. O sistema irá buscar pelo arquivo JASPER ou JRXML indicados no registro ou através da convenção de nomes configurada.
  • SQL - O bloco é executado utilizando um SQL base e opcionalmente uma entidade. Muito utilizado para gerar relatórios baseados em SQL puro. Este tipo de mecanismo substitui o antigo PRO_REPORTS.
    O bloco é basicamente definido por uma operação de QUERY e uma de LIST, mas na sua execução, ele injeta também as operações de REPORT (pdf), EXPORT, SHEET e CHART.
  • Script - O bloco é executado através de um script engine. Este tipo de mecanismo substitui as antigas operações custom.
    O bloco será composto basicamente por uma operação CUSTOM_ACTION que poderá ser com ou sem campos.
  • Formulário PDF - Este mecanismo pode ser utilizado apenas no estereótipo "Relatório (objeto)". Exige um arquivo PDF que contenha um formulário que será preenchido com os valores de variáveis obtidas através de um script.
Script associado à execução do relatório ou rotina especialmente utilizado quando o mecanismo for "Script".
No mecanismo JASPER e SQL, esse script é opcional e pode ser executado para gerar bindings utilizados no mecanismo.
Arquivo relacionado à interface. No caso de relatórios Jasper, por exemplo, deverá ser o JRXML.
DEPRECIADO - Ver estereótipo.

Indica se o registro refere-se a uma User Interface, um Tipo de Atividade, etc.
  • User Interface - O registro se refere a uma interface do sistema.
  • Relatório - A interface é um relatório executável pela PRO_REPORTS.
  • Implementação Custom - A interface representa um script de implementação customizadas.
  • Jasper Reports - A interface mapeia um relatório do tipo Jasper Reports.
  • Pesquisa genérica - Interfaces de pesquisa genérica possuem um formulário com um ou mais parâmetros e vários scripts que produzem um resultado a partir dos parâmetros informados.
  • Política de acesso para atividades - O registro é utilizado para definir a política de acesso para tipos de atividades.

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?.
Comportamento:Topo

Consultar

A consulta de um registro é realizada quando o usuário clica no primeiro link de um dos registros resultantes a operação [b:Listar]. A tela apresenta as informações detalhadas do registro, bem como as ações que o usuário pode disparar a partir dele (alterar, excluir, cancelar, etc.).
APPREF.CAD_PEDIDO
Cadastro de pedidos
Bundled
Bloco de interação
Nativo
User Interface
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].
Topo

Popular

Popula os relatórios cadastrados em arquivos distribuídos junto com o sistema.
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:
APPREF.CAD_PEDIDOCadastro de pedidosBundledBloco de interaçãoNativo
PROJET.TIPOS_ATIVIDADESTipos de atividadesCustomRotinaJasper
RTPREF.CFG_INTERFACES_SISTEMASConfigurações das interfacesDepreciadaRelatório (lista)SQL
RTAUTH.PRO_LOGINLoginBundledRelatório (objeto)Script