ÍNDICE
01. VISÃO GERAL
BIRT (Business Intelligence and Reporting Tools) é uma ferramenta para desenvolvimento e execução de relatórios que pode ser realizado com a utilização da IDE Eclipse, com modo design e bibliotecas para runtime em Java. Permite uma comunicação com o Java para gerar os relatórios ou uma comunicação via queries SQL.
Para a utilização com o Datasul está disponível a utilização com o Java, pois teria sua lógica reutilizável e mais flexível a mudanças.
02. INSTALAÇÃO
Para a execução dos relatórios desenvolvidos em BIRT, basta efetuar previamente a instalação do Birt-Runtime, que pode ser realizado o download no link: Project download area | The Eclipse Foundation
Nota
A versão 4.13.0 do BIRT está homologada para instalação e execução na linha Datasul.
CONFLITO ENTRE LIBS
A partir da release 12.1.2307, pode ocorrer conflito entre as bibliotecas do Datasul e BIRT, impactando na execução dos relatórios que utilizam a mesma. Para resolver este problema, eliminar a biblioteca org.apache.commons.logging_vXXX.jar da pasta diretório-tomcat\webapps\birt\WEB-INF\lib. Após sua eliminação, reiniciar o Tomcat.
03. CONFIGURAÇÃO
Os detalhes de configuração estão nesse link CFG - Relatório.
04. URL DE VERIFICAÇÃO DE PARÂMETROS
A URL de teste permite verificar as configurações do servidor, caso a pasta configurada como pasta do BIRT ou de seus relatórios não seja apresentada pode significar algo errado na configuração, ou a pasta não existe ou o usuário que inicia o serviço não tem permissão naquela pasta.
@GET /help
- Response → Retorna algumas configurações de ambiente para facilitar a identificação de alguma possível situação inesperada:
- os: sistema operacional no qual está sendo executado o Servidor Web Java (Tomcat);
- java_home: diretório raiz a instalação da JVM utilizada pelo Servidor Web Java (Tomcat);
- java_version: versão da JVM utilizada pelo Servidor Web Java (Tomcat);
- encoding: encoding utilizado pela JVM;
- separator: separador padrão do sistema operacional '/' ou '\';
- birt_home: diretório contento a raiz da engine do BIRT;
- birt_temp_dir: diretório temporário utilizado pelo BIRT;
- birt_resources: diretório raiz para bibliotecas auxiliares (normalmente /dataul_report/libs/).
- report_home: diretório raiz no qual estão os .rptdesign (normalmente /dataul_report/).
Exemplo TS4THF: http://ServerDTS4THF:1234/totvs-menu/rest/report/help
{ "report_home": "/usr/local/tomcat/datasul-report/", "os": "Linux", "java_home": "/usr/local/openjdk-11", "birt_temp_dir": "/usr/local/tomcat/datasul-report/temp/", "birt_home": "/opt/local/tomcat/birt-runtime-4.6.0/ReportEngine/", "java_version": "11.0.11+9", "encoding": "UTF-8", "separator": "/" }
05. CUSTOMIZAÇÃO
A customização da parte Progress se dá utilizando os pontos de EPC conforme já realizado hoje com o produto.
Quanto ao relatório, é possível criar uma pasta dentro do diretório do relatório em si, com o nome de custom. Este diretório por sua vez deve conter o arquivo .rptdesign customizado com o mesmo nome do relatório original. Durante a execução do relatório o Datasul Report Service procura primeiramente pelo relatório no diretório customizado, caso não exista realiza a execução do relatório padrão. Conforme exemplo abaixo:
Quando for desenvolvido um relatório especifico é recomendado que o mesmo seja disposto dentro da pasta custom para facilitar a identificação e atendimento em caso de alguma situação inesperada.
Quando o relatório possuir a técnica de i18n implementada, será preciso também copiar os arquivo .properties.
Uma das customizações mais solicitadas é a troca da logo impressa nos relatórios, esta alteração é possível de 2 formas.
- Alterando o próprio fonte do relatório (.rptdesign) e alterando o caminho da imagem para a imagem desejada. De preferência a imagem deve estar disponibilizada no diretório do próprio relatório ou no diretório: %TOMCAT_INSTANCE%/datasul-report/images;
- Substituindo o arquivo logo.png, no diretório %TOMCAT_INSTANCE%/datasul-report/images, pela imagem desejada. Para este caso recomenda-se que a imagem tenha as dimensões iguais a padrão: 165 x 160.