Relatórios

Os relatórios são criados na ferramenta Jaspersoft e incorporados ao sistema utilizando os campos e opções disponíveis na XPlatform. Para o correto funcionamento, é necessário que eles sejam criados seguindo as diretrizes:

• Os parâmetros utilizados devem ser de tipos padrão do Java: Number, String, Boolean, java.sql.Date, java.sql.Timestamp, java.util.List, java.util.Map (no caso do MAP, somente será utilizado para criar relatórios via parâmetros);
• Parâmetros que estiverem com a opção "Is for prompting" são obrigatórios e sempre devem ser informados durante sua geração;
• A fonte de dados padrão para apresentar os dados dos serviços é JDBC, tambem é possível criar um relatório sem uma fonte de dados, somente repassando parâmetros e fazendo a geração do relatório em cima dessas informações, porém para isso é necessário configurar o Jaspersoft;
• O arquivo deve ser da extensão .jrxml ou .zip, quando existirem imagens e/ou scripts java.

Depois que o modelo for criado no Jaspersoft Studio e na XPlatform, lembre-se de definir as permissões de acesso a ele, indicando quais usuários poderão executar/visualizar o relatório.

Após a criação do relatório no Jaspersoft Studio, publique-o na XPlatform.

Antes de fazer upload de um relatório na plataforma, crie o relatório utilizando o JasperReport previamente e defina parâmetros para esse relatório:

1. Acesse Tecnologia > Customização > Relatórios > Novo Relatório;
2. Preencha os parâmetros para criação de um relatório normalmente;
3. Faça o upload do arquivo de relatório criado anteriormente. Uma lista de parâmetros definidos dentro do arquivo de relatório será exibida na seção Informações do Arquivo > Parâmetros;
4. Escolha qualquer um dos parâmetros existentes, vá à coluna Serviço para Pesquisa e clique em Adicionar/+;
5. Escolha o domínio ou o serviço de destino que será responsável por retornar a lista de valores para o parâmetro em questão (poderá ser utilizado qualquer domínio/serviço existente);
6. Escolha a primitiva que será utilizada para retornar os valores. Apenas serão exibidas as primitivas que retornam os valores no formato correto. Desse modo, todas sintaticamente são válidas, sendo necessário escolher a que possui a semântica correta, por exemplo, uma que retorne a lista de empresas de fato, e não a lista de produtos;
7. Clique em Salvar.

Crie relatórios utilizando campos customizados, aplicando filtros e utilizando os campos como parâmetros:

1. Baixe e configure a biblioteca senior-jasperreports-functions-X.X.X.jar;
2. Crie o relatório conforme a necessidade:
   1. Acesse o Jaspersoft Studio, em File > New > Jasper report;;
   2. Selecione Blank A4 Landscape e clique em Next e novamente em Next;
   3. Selecione Teiid - Database JDBC Connection e clique em Next;
   4. Acesse Table, selecione a tabela desejada e clique em Next;
   5. Em Fields, selecione todos os campos e clique no botão Add;
   6. Clique em Next e depois em Finish.

3. Extraia o campo customizado utilizando a função disponível em CustomFields. Estes métodos recebem como parâmetro o valor do campo customizado (XML) e o nome da coluna que deseja-se extrair;
4. Utilize a variável do relatório e o campo expressão para extrair a informação e exibir no relatório;
   
   Exemplo:

   CustomFields.getInteger("<xml><ext><codigoNcm>123</codigoNcm></ext>", "codigoNcm") == 123

5. Inclua a variável no documento e salve o projeto do Jaspersoft Studio;

6. Por fim, publique o relatório para a execução na plataforma.

Crie um menu para acessar a tela do relatório:

1. Acesse Tecnologia > Customização > Novo Relatório;
2. Em Menus do relatório, clique em Novo;
3. Determine o local em que ele será exibido:
   • No menu principal: permite selecionar somente menus agrupadores;
   • No contexto de uma tela: não é possível selecionar menus que são agrupadores de submenus.
   Exemplo:

   • No menu principal: Tecnologia > Customização > Relatório principal
   • No contexto de uma tela: Tecnologia > Customização > Módulos > Relatório principal
4. Informe em Rótulo o nome deste menu;
5. Selecione um menu que ele será apresentado. Quando não for possível selecionar um dos menus ao local determinado anteriormente, um ícone de acesso negado será exibido;
6. Clique em Adicionar.

Alguns recursos são de grande ajuda para o manuseio dos relatórios, como, por exemplo, a criação de tags para facilitar a busca, quando existir uma grande quantidade de relatórios no ambiente. Outra opção é disponibilizar o relatório por apenas um período pré-determinado de dias e escolher um bom local para que ele seja visualizado, lembrando que o nome informado na sua criação é o que será exibido, e não o nome do arquivo em si.

1. Acesse Tecnologia > Customização > Relatórios > Novo Relatório;
2. Clique em Criar Relatório, informe o nome e anexo o modelo de relatório. Demais campos são de preenchimento opcional;
3. Clique em Salvar.

Caso o relatório seja formado por vários arquivos, estes arquivos devem ser adicionados a um arquivo compactado (.zip). É importante que o nome do arquivo compactado (.zip) seja igual ao nome do arquivo de relatório (.jrxml). Quando o relatório for formado apenas por um arquivo, ele pode ser adicionado normalmente, apenas o arquivo com a extensão .jrxml.

Para agendar um relatório, primeiramente, são necessárias as permissões de editar e visualizar para o recurso res://senior.com.br/platform/scheduler/job. Após garantir a permissão, prossiga com o agendamento:

1. Acesse Tecnologia > Customização > Relatório > Relatórios;
2. Selecione um relatório e clique em Ações > Detalhes;
3. Clique no botão Agendar relatório;
4. Se o relatório possuir parâmetros, eles deverão ser preenchidos. Informe o formato e para quem enviar. O usuário será redirecionado para a tela de agendamento, onde todos os campos necessários para o relatório já estarão preenchidos;
5. Preencha a seção Execução, escolhendo a data de início, periodicidade, horário entre outros.

1. Acesse o relatório pelo menu onde foi disponibilizado ou por Tecnologia > Customização > Relatórios;
2. Selecione o relatório que deseja imprimir ou faça a pesquisa pelo relatório criado;
3. Clique em Visualizar. Serão exibidos os parâmetros do relatório;
4. Verifique os parâmetros de Lookup e, se desejar, faça a sua edição. A lista do Lookup obedece a abrangência do usuário em questão. Portanto, só serão exibidos os valores que o usuário tenha permissão;
5. Escolha se o relatório será enviado para alguém;
6. Clique em Visualizar Relatório e aguarde a notificação de que o relatório está pronto.

1. Acesse Tecnologia > Customização > Relatórios;
2. Visualize uma lista com todos os relatórios já criados para os domínios e serviços existentes;
3. Clique em Ações, na opção Detalhes, do relatório que deseja editar;
4. Conforme sua permissão, faça a edição das informações.