Desenvolvimento de relatórios Jasper Reports

RT.FAQ-78161

PROPOSTA!!!

Ver também:

Desenvolvimento de relatórios

Blocos no Telescope:

Todos os relatórios Jasper, serão registrados no Telescope da mesma forma que é feito em qualquer outro bloco.
Este blocos poderão estar vazios, mas obrigatoriamente terão que ter um nome, título e descrição.
O nome dele iniciar com "REL_".

Quando possível, o binding e os itens também deverão ser incluídos de forma que a documentação do bloco possa ser gerada adequadamente.

Documentação:

Os relatórios serão documentados da mesma forma que os demais blocos de interface.

Bloco: Formado pelo nome do arquivo (sem a extensão).
Descrição: Texto que descreve o relatório e que DEVE:

Indicar o propósito do relatório (para que ele é utilizado). Exemplos: Utilizado para a separação física dos produtos do pedido. Utilizado como divulgação do orçamento que é enviado para o cliente aprovar.
Indicar como o relatório pode ser gerado. Exemplo: Gerado a partir da interface de consulta de um pedido.
Indicar as condições para gerar o relatório (quando existem). Exemplo: Pode ser gerado apenas a partir de pedidos de venda na situação emitido.
Incluir imagens de exemplo do relatório (ver sub-tópico abaixo).

Imagens:

As imagens de exemplo do relatório são importante para visualizar o seu layout. As imagens devem ter largura de 600 pixels para representar uma largura de página normal (tamanho A4). Relatórios que utilizam tamanhos especiais (como etiquetas, por exemplo) podem ter a sua imagem adequada de forma conveniente.

Estas imagens do relatório deverão ser anexadas ao respectivo sistema. Cada imagem deverá começar com o nome do relatório e terminar com "IMG" seguido de um índice. Exemplo:

PEDVEN06.REL_PEDIDO_07_IMG001

Na descrição, devem ser inseridas as partes que são apresentada no relatório, permitindo, por exemplo, concatenar um cabeçalho de página padrão, seguido de um bloco do relatório, seguido de um sub-relatório e de um rodapé de página padrão.

No caso de houver sub-relatórios que são reutilizados em outros relatórios, é conveniente separar a imagem de forma que qualquer alteração no mesmo sub-relatório seja automaticamente visível em todos os relatórios que a utilizam.

Atenção

As imagens devem ser realizadas no sistema de homologação e não podem, sob hipótese alguma, apresentar dados reais de clientes!

Desenvolvimento:

Os relatórios serão desenvolvidos utilizando as ferramentas iReport ou Jasper Studio.

Nomes dos arquivos:

Todos os arquivos JASPER (arquivo .jrxml que contém a definição do relatório e .jasper que contém a versão compilada), deverão ser gravados na pasta "reports" do projeto, obedecendo à seguinte estrutura:

reports/nome-do-sistema/nome-do-relatório.jrxml

Sendo que:

O prefixo "REL_" será suprimido no nome do relatório
Somente utilizar letras minúsculas

Exemplo:
Um relatório definido em PEDREPR01.REL_PEDIDOS_REPRESENTACAO_01 deveria ser gravado no seguinte arquivo:

reports/pedrepr01/pedidos_representaca_01.jrxml

Sub-relatórios:

Cada sub-relatório deverá estar cadastrado no Telescope da mesma forma que o relatório principal.
Quando um sub-relatório é desenvolvido única e exclusivamente para um relatório, seu nome deve começar igual ao nome do relatório principal, adicionando apenas um sufixo que identifique o mesmo.

Exemplo:

PEDREPR01.REL_PEDIDOS_REPRESENTACAO_01_ITENS
reports/pedrepr01/pedidos_representacao_01_itens.jrxml

Variações para o mesmo relatório:

Durante o desenvolvimento, cada "caso de uso" que exige um relatório terá um bloco definido como padrão e todo os desenvolvimento fará referência a este nome global.
Quando existirem outras alternativas para este relatório, será cadastrada uma preferência (em tempo de desenvolvimento ou em tempo de produção) que indicará o nome global das alternativas ao mesmo (uma alternativa por linha). O nome deste preferência, será o nome global do relatório de referência + ".ALTERNATIVES".

Exemplo:

PEDREPR.REL_PEDIDOS_REPRESENTACAO.ALTERNATIVES = 
     PEDREPR.REL_PEDIDOS_REPRESENTACAO
     PEDREPR01.REL_PEDIDOS_REPRESENTACAO_01
     PEDREPR02.REL_PEDIDOS_REPRESENTACAO_02
     PEDVEN06.REL_PEDIDOS_VENDA_06

A não existência desta preferência assume o próprio relatório como única opção.
Note que o relatório de referência pode não fazer parte das opções.
Se um único relatório for apresentado, nenhuma opção será oferecida e a emissão é realizada diretamente através da única opção disponível
A montagem das opções para o usuário seguirão as regras de acesso assim como as demais operações do sistema

Preferências do relatório:

As preferências do bloco são automaticamente passadas para o contexto do Jasper.
O parâmetro "CFG"

Relatórios Jasper customizados:

Relatórios Jasper customizados nos ambientes dos clientes devem ser "cadastrados" no sistema para registro do componente e para que os arquivos utilizados para emissão dos relatórios sejam disponibilizados nos demais servidores em ambientes replicados.
Procedimentos:

Desenvolver o relatório.
Cadastrar o relatório em Cadastro de modelos de documentos.
Anexar o arquivo .JRXML (e opcionalmente o .JASPER) a este cadastro.

Esse cadastro é meramente um registro (pode ser considerado um backup ou cópia de segurança) dos arquivos utilizados para desenvolvimento do relatório, evitando uma possível "perda" destes arquivos e facilitando futuras manutenções do relatório.
Caso ocorram alterações no relatório os arquivos "alterados" devem ser atualizados nesse cadastro para manutenção da versão atualizada do relatório e evitar erros de versionamento do relatório.

Atenção

Para disponibilizar os respectivos relatórios no sistema é preciso executar os procedimentos de upload através da Manutenção de arquivos nos respectivos diretórios/pastas designados para uso de relatórios Jasper pelo sistema (normalmente reports/) em todos os servidores onde o relatório poderá ser executado.