# Relatório Customizado
# Introdução
- Para customizar relatórios, não será necessário criar uma tela. A opção de baixar o arquivo fonte para customização já estará disponível nas telas atualizadas dos sistemas Teknisa.
Atenção!
Caso a tela de relatório utilizada não possuir os botões de Baixar e Upload, entre em contato com os responsáveis pelo produto utilizado.
- Para realizar a edição, serão necessárias configurações no ambiente e download da IDE específica para esse fim.
Nota
Caso já possua um ambiente configurado para alteração dos relatórios, não há a necessidade de seguir os passos Tomcat e IDE.
# Tomcat
- Responsável por gerar os relatórios no seu ambiente.
- Para agilizar a configuração, autentique no DockerHub da Teknisa e baixe a imagem
birt
.
sudo docker login -u teknisa -p teknisa2020 dockerhub.teknisa.com
sudo docker pull dockerhub.teknisa.com/birt
- Exemplo de comando para criação do container:
sudo docker run --restart=always -d --name birt -p 9191:9191 -v /seu/diretorio:/var/www/teknisa -v /seu/diretorio/u01:/u01 -it dockerhub.teknisa.com/birt
- Altere o
/seu/diretorio
no comando de acordo com sua pasta de trabalho. - O container já vem pré configurado para ler relatórios a partir da pasta
/var/www/teknisa
. Mapeie a sua pasta de trabalho apontando para esse diretório a fim de facilitar o uso e a leitura dos relatórios. - Parâmetros:
- --restart=always: Para o container já ser iniciado assim que o serviço do docker iniciar;
- --name: Nome a ser utilizado para acessar o container. Nesse exemplo utilizamos
birt
; - -v: Diretórios para serem compartilhados com o seu Container Birt;
- -p: Mapear portas do container para serem utilizadas externamente;
- O mapeamento da porta 9191 do container é obrigatório para utilização do Birt viewer. Nesse exemplo, utilizamos 9191 também fora do container, mas caso queira alterar é possível. Basta informar, por exemplo, 8585:9191 no mapeamento.
Nota
É possível utilizar o Tomcat a partir do XAMPP (opens new window). Caso opte por essa opção, será necessário também baixar o Birt Report Runtime (opens new window) (birt-viewer) para visualizar os relatórios.
# IDE
- A edição de relatórios é realizada através do Birt RCP.
- Baixe a versão do birt-rcp-report-designer aqui (opens new window) de acordo com seu sistema operacional.
- Baixe a versão 8 do Java JDK aqui (opens new window), necessária para a execução do editor.
- Será preciso logar em uma conta oracle para realizar o download.
- Crie uma variável de ambiente em seu sistema chamada JAVA_HOME, apontando para o diretório de instalação do seu JDK.
- Por padrão, em ambiente windows, geralmente é
C:\Program Files\Java\jdk1.8.0_202
.
- Por padrão, em ambiente windows, geralmente é
Nota
É possível utilizar o Eclipse nas versões Luna (opens new window) e Neon (opens new window) para edição. Essas versões também são compatíveis com os relatórios da Teknisa. Baixe o Eclipse IDE for Java and Report Developers caso opte por essa opção.
Atenção!
Versões do Eclipse diferentes das citadas acima não são compatíveis!
# Baixando o relatório
- Para fazer o download do arquivo fonte do relatório, selecione o desejado e clique no botão Baixar Arquivo do Relatório (.rptdesign).
- Um arquivo será baixado em seu ambiente. Utilize o IDE configurado no passo anterior para abrir o relatório para edição.
# Regras
- Só será possível utilizar os mesmos parâmetros do relatório base que foi baixado.
- Só será permitido utilizar comandos
SELECT
para consultas. - Comandos SQL não permitidos:
CREATE
,ALTER
,DROP
,TRUNCATE
,INSERT
,UPDATE
,GRANT
,REVOKE
,COMMIT
.
# Upload do relatório
- Após finalizar as customizações, clique no botão Upload Relatório Customizado.
- Selecione o Relatório Base utilizado.
- Caso selecione um relatório da Teknisa, a opção Operação será assinalada obrigatoriamente como
Criar Novo
. - Caso selecione um relatório customizado, informe a opção desejada:
Criar Novo
ouAtualizar
.
- Caso selecione um relatório da Teknisa, a opção Operação será assinalada obrigatoriamente como
- Informe um Nome para seu relatório. Será utilizado na lista disponível na tela.
- O prefixo
Customizado |
será inserido automaticamente para facilitar a distinção. Exemplo:- Nome informado: Demonstrativo Operacional.
- Nome mostrado na lista: Customizado | Demonstrativo Operacional.
- O prefixo
- Selecione o arquivo customizado e faça o upload.
Nota
- Após todo o processo realizado, selecione seu novo relatório na lista, informe os parâmetros e utilize o botão Gerar Relatório para visualizar e/ou baixar seu arquivo.
- Faça o mesmo processo para criar novos relatórios.