Gerador de Relatórios - iReport
O que é?
O Gerador de Relatórios iReport é uma ferramenta essencial para a criação de relatórios personalizados em diversos formatos, como PDF, XLS e HTML. Com ele, você pode extrair, organizar e apresentar informações de forma estruturada, atendendo a diferentes necessidades de análise e tomada de decisão.
Diferente de editores convencionais, o iReport permite a construção de layouts complexos sem exigir conhecimento avançado em programação. Sua integração com o Uniplus garante compatibilidade total, aproveitando os dados já existentes no sistema para gerar relatórios precisos e dinâmicos.
O iReport 5.6.0 utiliza arquivos no formato .jrxml, compatíveis com a versão Java 7, assegurando estabilidade e confiabilidade nos relatórios gerados.
Como Funciona no Uniplus?
1. Baixando e configurando o recurso
Para baixar o iReport 5.6.0, siga os passos abaixo:
No navegador, pesquise "iReport 5.6.0" e acesse o site jaspersoft.com.
Escolha a versão desejada e realize o download.
Configuração do Java 7
O iReport 5.6.0 é compatível apenas com o Java 7. Se estiver utilizando outra versão, será necessário instalar o Java 7 e configurar o iReport para reconhecê-lo:
Localize a pasta "jre7" dentro da instalação do Java e copie-a para a pasta do iReport.
Acesse a pasta "etc" e abra o arquivo "ireport.conf".
Encontre a linha "jdkhome", remova o caractere "#" e adicione o caminho onde o Java 7 está instalado.
Salve o arquivo.
Após essa configuração, o iReport estará pronto para uso. Para executá-lo, acesse a pasta "bin" e clique em "ireport.exe".
2. Executando o iReport e conectando na base de dados
Antes de iniciar a criação de um relatório, será necessário fazer a configuração da conexão com o banco de dados. Para fazer essa conexão acesse o iReport, clique no botão Connections/Datasources → New e selecione a opção Database JDBC connection.
Name: selecione um nome;
JDBC Driver: selecione a opção “PostgreSQL (org.postgresql.Driver)”;
JDBC URL: troque “localhost” pelo endereço IP onde está armazenado o banco de dados.
Selecione a porta onde está rodando o serviço do postgres e o nome da base de dados, que por padrão é “unico”;
Username: nome de usuário utilizado no banco de dados;
Password: senha utilizada no banco de dados. É uma boa prática não salvar a senha na tela de conexão.
Em seguida clique em “Test” , digite sua senha e a conexão será validada. Clique em “Save"
3. Iniciando um relatório do zero
Para criar um novo relatório, siga os passos abaixo:
Acesse o menu Arquivo → New.
Na tela "New file", selecione o layout desejado.
Informe o nome do relatório e o local onde ele será salvo. O layout escolhido abrirá um novo relatório em branco.
O relatório criado conta com espaços para incluir: título, cabeçalho de página, cabeçalho de coluna, detalhes, rodapé de coluna, rodapé de página e sumário.
Para habilitar a barra de ferramentas, clique em Janela → Redefinir Janelas.
4. Inserindo o comando SQL
Para inserir o comando SQL no relatório, clique no botão "Report Query".
Na tela que será exibida, você poderá montar e editar o comando SQL. Vale ressaltar que, nesta tela, o conteúdo de dados não será retornado. O objetivo é apenas garantir que a estrutura referenciada no SELECT seja reconhecida corretamente.
Certifique-se de inserir o código em uma única linha, sem quebras. Além disso, preste atenção aos espaços entre as palavras, pois esses dois fatores podem gerar erros.
5. Mostrando os campos no relatório
No painel Report Inspector, localizado à esquerda da tela, acesse o grupo Fields, que contém os campos retornados pelo SQL. A partir daí, você pode arrastar os campos para o relatório conforme necessário.
Você pode editar e organizar os campos da maneira que preferir. Recomendamos o uso da fonte "Verdana", pois ela é compatível tanto com o Uniplus Desktop quanto com a versão Web.
Para visualizar o relatório, basta clicar no botão "Preview".
6. Mostrando mais do que campos
Para alterar as cores dos campos, clique no campo desejado e edite-o no menu "Produto - Propriedades".
Também é possível adicionar um contador de páginas. Para fazer isso, vá em "Tools", clique em "Page number" ou "Page X de Y", e arraste a opção para o local desejado no relatório.
7. Inserindo parâmetros
A integração que o Uniplus possui com o iReport dá muita flexibilidade na hora da criação de relatórios personalizados. A lista que consta nesse artigo mostra todos os parâmetros que, se referenciados no iReport, retornarão informações específicas do sistema:
Campo | Parâmetro no iReport |
Checkbox | checkbox |
Combo | combobox |
Representante/vendedor | representante ou vendedor |
Cliente | cliente |
Fornecedor | fornecedor |
Transportadora | transportadora |
Técnico | tecnico |
Usuário | usuario |
Grupo de produtos Pai | grupoproduto_todos |
Grupo de produtos filho | grupoproduto |
Família de produtos | familia |
Produto | produto |
Serviço | servico |
Condição de pagamento | condicaopagamento |
Filial | filial |
Natureza de operação | cfop |
Unidade de medida | unidademedida |
Tipo documento financeiro | tipodocumentofinanceiro ou tipodocumento |
Empresa/filial | empresafilial |
Cidade | cidade |
Estado | estado |
Conta corrente | contacorrente |
Banco | banco |
Tipo de cobrança | tipocobranca |
Região | regiao |
Plano de contas | planoconta |
Tipo de evento de OS | tipoordemservicoevento |
Comissionado | comissionado |
Comprador | comprador |
Fabricante | fabricante |
Motorista | motorista |
Garçom | representante |
Portador | portador |
Entregador | entregador |
Prospect | prospect |
Centro de custo | centrocusto |
Repositor | repositor |
Esses são os parâmetros mapeados no Uniplus. Vamos utilizar como exemplo o parâmetro “Produto” no iReport. Quando um relatório do sistema for importado, ele carregará um combo com todos os produtos disponíveis para filtragem.
Para adicionar um parâmetro no iReport, siga os passos:
Acesse a aba "Parameters".
Clique com o botão direito e selecione "Adicionar Parameter".
Localize o parâmetro desejado conforme a tabela acima.
Defina a "Parameter Class" correspondente.
Em "Description", insira o nome que será exibido na tela.
Com isso, o parâmetro estará criado.
Agora, edite a consulta SQL e adicione o parâmetro, que é identificado pelo prefixo $P
. Arraste-o para a tela de design do relatório, onde ele ficará localizado no canto superior direito.
O Uniplus enviará o ID do produto para o parâmetro “Produto”, e o iReport substituirá esse valor na consulta SQL. Assim, ao clicar em "Preview", o sistema solicitará o ID do produto, e o valor inserido será utilizado no relatório.
Caso deseje listar todos os produtos na consulta SQL, basta envolver o parâmetro entre parênteses ()
.
8. Importando o relatório no Uniplus
Para importar um relatório no Uniplus, siga os passos abaixo:
Acesse Ferramentas → Gerador de Relatórios.
Clique em "Importar jrxml".
Localize o arquivo do relatório salvo, selecione-o e clique em "Abrir". O relatório será exibido na grid.
Para definir onde o relatório será acessado no Uniplus:
Selecione o relatório na grid e clique em "Alterar".
Escolha o menu desejado para disponibilizá-lo no sistema.
Após a importação, o relatório ficará disponível no menu selecionado. Ao abri-lo, os parâmetros configurados serão exibidos e, ao clicar em "Gerar", o relatório será processado e apresentado na tela.
9. Onde conseguir documentação do iReport?
Para a criação de relatórios complexos com parâmetros e componentes avançados, recomendamos a seguinte fonte de consulta:
Jaspersoft Community: oferece documentação detalhada, uma base de conhecimento (wiki) e um fórum onde é possível postar dúvidas e interagir com a comunidade.
10. Configurando parâmetros avançados
É possível utilizar parâmetros independentes, ou seja, que não estejam vinculados a nenhuma tabela do sistema, como os tipos "checkbox" e "combobox".
Vamos tomar como exemplo o checkbox, criando e ativando esse parâmetro.
Ao clicar em "Preview", será possível marcar as opções desejadas e filtrar os produtos que serão exibidos no relatório.
11. Inserindo um grupo de informações no relatório
Para vincular um relatório a um grupo (neste exemplo, o grupo de produtos), siga os passos abaixo:
Abra a consulta SQL e insira o código correspondente para incluir a informação do grupo.
No menu "Fields", o campo do grupo já estará disponível.
Arraste o campo para o relatório, edite conforme necessário e clique em "Preview" para visualizar o resultado.
Se desejar organizar o relatório por grupos:
No canto superior esquerdo da tela, localize "Relatório teste".
Clique com o botão direito e selecione "Add Report Group".
Isso permitirá a adição de agrupamentos, facilitando a organização dos dados no relatório.
12. Modelo de impressão no iReport
No Uniplus, siga os passos abaixo para configurar a impressão no iReport:
Acesse o modelo desejado, selecione-o e clique em "Alterar".
No campo "Tipo de impressão", escolha a opção "Configurando no iReport".
Deve ser criado um parâmetro no IReport com a seguinte configuração:
Nome do parâmetro (Name): idDocumento (importante respeitar letras maiúsculas e minúsculas);
Classe do parâmetro (Parameter Class): java.lang.Long (as demais informações do parâmetro não são necessárias);
Caso o relatório criado possua SubRelatório (SubReport), deve ser criado um parâmetro com a seguinte configuração:
Nome do parâmetro (Name): SUBREPORT_UNIPLUS_ (importante respeitar letras maiúsculas e minúsculas) + descrição que desejar. Por exemplo, SUBREPORT_UNIPLUS_teste ou SUBREPORT_UNIPLUS_parametro (a descrição final após o “_” fica a critério do cliente, porém o nome do parâmetro DEVE iniciar com “SUBREPORT_UNIPLUS_”);
Classe do parâmetro (Parameter Class): net.sf.jasperreports.engine.JasperReport (as demais informações do parâmetro não são necessárias);
O Uniplus irá passar para o relatório o ‘idDocumento. Portanto, esse parâmetro precisa ser utilizado na consulta dos dados dentro do relatório:
Com isso as informações poderão ser usadas no relatório conforme o layout desejado. O relatório deverá ser importado no Uniplus para o modelo de impressão definido.
Segue lista dos modelos de impressão que possuem opção para o tipo “Configurado no iReport” e as tabelas base de onde os dados são extraídos:
Modelos de Ordem de serviço: tabela ordemservico;
Modelos de Pedido de venda: tabela dav;
Modelos de Duplicata: tabela financeiro;
Modelos de Devolução: tabela devolucao;
Modelos de Pedido de compra: tabela pedidocompra;
Modelos de Orçamento: tabela dav;
Modelos de DAV-OS: tabela dav;
Modelos de Pedido de faturamento: tabela dav;
Modelos de Recibo de entrega de equipamento: tabela ordemservico;
Modelos de Laudo técnico: tabela ordemservico;
Modelos de Orçamento de faturamento: tabela dav;
Modelos de Recibo de pagamento: tabela eventofinanceiro;
Modelos de Caso Help Desk: tabela caso;
Modelos de Manifesto de Carga: tabela carga.
Para facilitar a busca de informações do banco de dados, para os modelos de impressão que utilizam como tabela base “dav”, existe a view “davitem_view”. Essa view já traz todas as informações referente aos produtos, clientes, vendedores etc.
Já no modelo de ordem de serviço, existe a view “ordemservicoitem_view”.
Existem também dois modelos de relatório configurados no IReport padrão do sistema. O cliente poderá usá-los como referência ou editá-los da forma que melhor lhe atender. Eles terão que ser importados novamente no sistema. Note, porém, que são apenas relatórios para os modelos de impressão que utilizam a tabela “dav” e “ordemservico”.
Para isso, basta selecionar o modelo de impressão desejado, selecionar o tipo de impressão “Configurado no IReport” e o sistema já carrega o padrão.
Caso o cliente desejar alterar o layout ou acrescentar/remover informações no relatório, basta exportar o arquivo através do botão “Exportar arquivos”.
Caso queira exportar o modelo:
Localize o arquivo dentro do iReport.
O modelo gráfico utilizado no Uniplus será convertido para um formato compatível com o iReport.
Dessa forma, será possível editar o relatório conforme necessário.
Esses mesmos relatórios estão disponíveis neste link. Eles são válidos para builds com numeração 6.11.59 ou anteriores. O conteúdo do arquivo compactado é explicado abaixo:
dav.jrxml – Para os modelos de impressão que utilizam a tabela “dav”;
ordemservico-comfotos.jrxml – Para os modelos de impressão de ordem de serviço;
fotos_os.jrxml – Esse é um SUBREPORT utilizado pelo “ordemservico-comfotos.jrxml”. Caso o cliente realize alteração no relatório “ordemservico-comfotos.jrxml”, para importação no sistema, o arquivo “fotos_os.jrxml” deve estar na mesma pasta.
Caso esteja sendo considerada uma build com numeração 6.11.60 ou mais recente, os modelos neste link funcionarão melhor e trarão a possibilidade de tratar as imagens de produtos.
Observações
|
Saiba mais
Veja as respostas para perguntas comuns sobre as Ferramentas do Uniplus.
_