Integração_iReports

Visão Geral 

O iReports é uma ferramenta que utiliza a biblioteca JasperReports, http://jasperreports.sourceforge.net/, para a construção de relatórios através de uma interface gráfica.

Tanto o iReports e JasperReports foram desenvolvidos usando a plataforma Java, e possuem licença open source.

O iReports possibilita a criação de relatórios completos, utilizando gráficos, agrupamentos, sub-relatórios e integrando-se à plataforma Microsiga Protheus®.

Requisitos para Instalação

Requisitos para o servidor:

  1. Microsiga Protheus® versão 11 instalado e configurado.
  2. Serviço de Web-Service configurado e ativo.

Requisitos para o desenvolvedor:

  1. iReport versão 5.5.0
  2. Java versão JDK 1.7.0
  3. Drivers JDBC para acesso ao Banco de Dados

Requisitos para o cliente:

  1. Microsiga Protheus® versão 11.
    Instalado e configurado, com acesso ao Web-Service.
  2. Java versão JDK 1.7.0
    Instalado e com o programa java.exe acessível, para execução do relatório.

Configuração do Wizard

Preparação do Servidor:

Após a instalação do Microsiga Protheus® 11, no ambiente Configurador (SIGACFG) acesse o menu Cadastros / iReports Config. / Wizard iReports.

Será iniciado o Wizard de Configuração do iReports no Microsiga Protheus® para inserção dos parâmetros necessários.

Inserção do Relatório no Menu

  1. Acesse a funcionalidade de cadastro de menus no ambiente Configurador.
  2. Crie um item de menu, informando os campos necessários. Porém, atente-se ao fato de que no campo Tipo deverá conter Relatórios iReports e no campo Programadeverá conter o nome do relatório iReports, excetuando-se a sua extensão.

Preencha a Tela de Configuração do Item, informando:

Em Descrição: ireports 5.5.0 para todos os idiomas.

Tipo: Relatório iReport

Programa: REPORT3522

Status: Habilitado

Acessando o Relatório iReports

  1. Acesse o ambiente em que foi adicionado o menu do relatório iReports e selecione-o.
  2. Caso seja a primeira vez que o usuário final acesse um relatório iReports, será realizado download de alguns arquivos necessários à visualização do relatório.
  3. Em seguida, será aberto o relatório iReports em uma nova janela. 

Regras para Criação de Relatórios

Existem algumas regras de integração com o Protheus® .


Definição do nome das tabelas:

As tabelas devem ser referenciadas na query através de parâmetros. Isto deve ser feito criando um parâmetro que identifica a tabela. O nome do parâmetro deve identificar a família da tabela.

Por exemplo, caso deseje usar a tabela de clientes SA1, o primeiro passo é a criação de um parâmetro:

-> Para criar um parâmetro vá no Report Inspector, clique com o botão direito do mouse na opção "Adicionar parameter".

-> Depois de criado, o nome do parâmetro deve ser mudado para o mesmo da família, no caso SA1.

Não é necessário colocar a filial, apenas o nome da família.

A descrição do parâmetro deve obrigatoriamente ser Tabela, ou Table, que identifica que este é um parâmetro de tabela.

O nome do parâmetro deve identificar a família da tabela, neste caso SA1.

Na query do relatório, o parâmetro deve ser usado com a substituição do nome da tabela pelo parâmetro.


Tratamento dos campos excluídos:

Para tratamento dos registros excluídos, é necessária a criação de uma variável DELETED e ela deve possuir a seguinte configuração:

Tratamento do campo de Filial:

O tratamento do campo de filial também é feito com a criação de uma variável, com a seguinte configuração:

Uso de perguntas no relatório:

No momento da execução do relatório, é possível fazer o uso das perguntas cadastradas no sistema.

Para fazer uso destas características, devem ser observadas algumas regras:

a. As perguntas cadastradas no sistema devem ter o mesmo nome do relatório.
Exemplo: Para um relatório que se chame REP001, deve ser criado um grupo de perguntas com o mesmo nome no sistema.

b. O nome do grupo de perguntas junto com a ordem das perguntas deve ser usado como identificador na query do relatório.

Exemplo: REP001-01 REP001 Identifica grupo de pergunta, 01 identifica a primeira pergunta do grupo. Deve ser usado o hífen como separador entre o grupo de pergunta e a ordem.


Uso de Expressão de filtro:

Se necessário filtrar o resultado da query, o iReports disponibiliza um assistente para expressão de filtro. Pode ser criado qualquer expressão de filtro desde que ela retorne um tipo java.lang.Boolean.


Uso de imagens nos relatórios:

Se necessário utilizar imagens nos relatórios, algumas indicações importantes devem ser seguidas:

a. As formas homologadas para uso de imagens são:

b. As extensões de imagens homologadas são:

A Integração Ireport X Protheus não dá suporte para imagens vindas via URL.

Parâmetros

Nome do banco de dados usado pelo iReport.

Exemplo: ERPDADOS


Porta de conexão do banco de dados, pode ser deixado em branco para uso da porta padrão.

Exemplo: 2040


Endereço do bando de dados para uso do iReport.

Exemplo: 127.0.0.1


URL do web-service que responderá às requisições.

Exemplo: localhost/ws


Usuário a ser utilizado na autenticação no servidor

Exemplo: sa


Senha a ser utilizada na autenticação no servidor

Exemplo: sa

Estes parâmetros são gravados automaticamente na Configuração do Wizard do iReports.