Relatórios Formatados

 Módulo: Configurações > Avançado

O iReport é a ferramenta utilizada no sistema para a impressão de relatórios personalizados e rápidos. Ou seja, são os componentes de impressão e de geração de PDF desta ferramenta, que são utilizados na impressão dos relatórios.

Além disso, é uma ferramenta gratuita, escrita em Java e que não pode ser acessada pela WEB, ou seja, é uma ferramenta "Desktop" que deve ser instalada no computador para utilização; ela possui muitos recursos de desenhos de relatórios e de gráficos.

A atualização desta ferramenta poderá ser feita através do site JasperForge.org que é uma fonte de informação a respeito do iReport.

Nota: existem recursos avançados que poderão ser utilizados, que estão disponíveis nos tutoriais do iReport, disponibilizados no site JasperForge.org. Pelos tutoriais, pode-se aprender como utilizar estes recursos avançados para elaborar um relatório e importá-lo para o Sankhya-Om.

O plugin para iReport da Sankhya, permite que o usuário crie, visualize e edite relatórios, sem a necessidade de acessar o SankhyaOm no navegador, no entanto, não será funcional para clientes com contratos posteriores à 02/2023, já que o método de login à API não considera o novo formato com o Gateway que utiliza o Bearer Token.

Observação: caso o usuário receba este erro, faça o download do relatório no iReport e depois importe-o para o Sankhya.

Clique em iReport para saber mais

A tela de Relatórios Formatados permite a criação e visualização de informações a partir de todas as movimentações da empresa, podendo estas serem personalizadas de acordo com a necessidade do usuário.

Painel de Filtros

Botão de Filtros: Permite a criação de filtros personalizados;

Código: Tela de Pesquisa com o código dos relatórios criados para filtro;

Nome Contendo: Ao informar um texto, o sistema buscará pelo Nome do Relatório, trechos que contenham o texto informado.

Nome do arquivo contendo: O sistema buscará o nome do arquivo na Aba Arquivos do relatório Formatado.

Categoria: Este campo possui a opção de "Marcar/Desmarcar todos", na qual pode-se buscar pelo relatório desejado através de sua categoria; este campo é alimentado de acordo com o preenchimento do campo "Categoria" na grade a direita.

Para filtrar as informações de maneira rápida, pode-se ainda fazer uso do botão , localizado à frente de cada campo na grade a direita.

Nota: ao realizar a criação de um filtro, o sistema conta com um recurso disponibilizado pelo botão "Desprezar não informados"; aplicando o filtro, pode-se ter situações em que não é necessário preencher todos os seus dados; neste caso, o referido botão, insere parâmetros padrão no lugar dos parâmetros não informados pelo usuário (esta inserção é um comportamento interno do sistema). Em um filtro que conta com o campo "Cód. Empresa" por exemplo, caso este não seja informado na aplicação do filtro, o sistema irá preenchê-lo com o valor padrão zero.

Saiba como enviar relatórios por e-mail clicando na opção, Conhecendo o Sankhya-W/Envio de Relatórios por Email.

[voltar ao topo]

Incluindo um Novo Relatório

Ao incluir um novo relatório nesta tela, este poderá ser inserido no conceito do Sankhya Place. Para isso, é necessário habilitar a marcação "Permitir instalar Sankhya Place?" da tela Usuários, aba Segurança, e, em seguida, ao clicar no botão para a inclusão de um relatório, será apresentado o pop-up "Buscar soluções no Sankhya Store" com as soluções disponíveis no Sankhya Place. 

Desse modo, defina o pacote que deseja efetuar o download e verifique se a solução é gratuita ou paga. A saber:

Soluções gratuitas

Caso você queira instalar uma solução gratuita, basta clicar em "Instalar" e aceitar os termos de uso da loja de soluções. 

 
Obtenha mais informações sobre o termo de uso, por meio do link
 Termos e Condições da Loja de Soluções. 

Soluções pagas  

Nota: o sistema irá apresentar soluções pagas apenas se o parâmetro "Habilitar Sankhya ID?-HABILITAACCOUNT" estiver ligado. 

Antes de iniciarmos a instalação do pacote pago, é importante ressaltarmos que o usuário responsável pela aquisição do respectivo pacote deverá realizar o login com o Sankhya ID. Através desse usuário o sistema identificará quem é o parceiro/CNPJ responsável por essa aquisição.

Desse modo, é de extrema importância atentar-se aos usuários que terão permissão para executar o download de pacotes no Place. Para tal, acesse a tela Usuários, aba Segurança e verifique a configuração da marcação "Permite instalar pacote Sankhya Place?".

Agora, para realizar o download da solução, clique em "Instalar", assim, será apresentado um pop-up com as informações do pedido. Para concluir a compra é necessário aceitar as seguintes condições:

“Estou ciente que ao confirmar, o pacote será imediatamente instalado no sistema e será gerado uma fatura no valor de R$ XX,XX para minha empresa.”

“Estou ciente e de acordo com os termos de uso da loja de soluções.”

Clicando em "Sim, confirmar", a aquisição/download é realizada e será disparado um BI para o mesmo e-mail cadastrado para recebimento de boletos de cobrança mensal de uso do sistema Sankhya. Nesse e-mail serão enviados o boleto e NFS-e referentes ao valor do pacote adquirido. O boleto, em sua maioria, é gerado com o vencimento até 7 dias após a data do download do pacote.

Caso você queira realizar a inserção de um novo registro fora deste contexto, clique no botão "Cadastrar Relatório" do pop-up.

[voltar ao topo]

Painel Principal

Alternando a grade onde são exibidos os relatórios, para o "Modo formulário", realiza-se o cadastro de um novo relatório. 

Código: Campo de preenchimento automático.

Descrição: Preencha este campo, com o nome para identificação do relatório.

Última alteração e Usuário: Esses campos são de preenchimento automático, e têm o objetivo de monitorar as alterações realizadas.

Tela/Instância: Informe aqui, a tela que está relacionada ao relatório. Ao lado deste campo tem-se um botão de filtro para definição de quando o relatório será apresentado.

Através deste botão, deve-se "filtrar" qual tela terá vínculo ao relatório formatado, ou seja, qual poderá receber a opção de impressão do relatório formatado. A elaboração do filtro é estabelecida conforme a tela/instância que foi especificada neste cadastro. O filtro se baseia nos campos contidos nesta tela/instância. Este filtro também não utiliza "variáveis", ou seja, seus critérios são sempre fixos, pré-estabelecidos.

Por exemplo, para utilização do relatório formatado na Central de Vendas, deve-se informar no campo "Tela/Instância" o "CabeçalhoNota". É necessário também indicar o Tipo de Movimento ao qual o relatório corresponde, já a Central pode referenciar notas, pedidos, ou devoluções, tanto de compras, quanto de vendas, até mesmo as movimentações internas. Sendo assim, basta informar no "Filtro" o campo "Tipo de Movimento", comparando com o tipo desejado (venda, compra, etc). 

Através deste filtro existente junto ao campo Tela/Instância no cadastro dos relatórios formatados, não só as telas que são personalizáveis poderão conter a opção para imprimir os relatórios formatados, a Central de Vendas, assim como os Portais também poderão receber essa personalização.

Para mais detalhes de como a opção "Relatórios Formatados" se apresenta nas telas personalizáveis do sistema (desde que configuradas), acesse o link Relatórios Formatados e Conhecendo  Sankhya-Om - Dicas e Facilitadores.  Para apresentação na Central de Vendas acesse o link Impressão nos Portais.

Id da tela: Esta opção é utilizada para relacionar o atual relatório formatado com sua respectiva tela, onde será utilizado para impressão.

Observação: quando for vinculado um relatório ao ID de um dashboard criado por meio da tela Construção de Dashboards, ao abrir este, o relatório estará disponível para visualização no botão "Exportar grade" localizado no canto superior direito.

Relatório Dependente: Se houver necessidade de vincular outro modelo de Relatório Formatado a este, informe neste campo o código do relatório dependente. É utilizado, por exemplo, para que, no envio de Notas Fiscais por e-mail, seja enviado também o boleto, ou qualquer outro relatório relacionado ao faturamento.

Formato da impressão: Esta opção permite que se escolha como o relatório será impresso. Tem-se as seguintes opções:

• Excel (.xlsx);
• PDF;
• Word (.docx).

Importante: o sistema por meio da rotina de virtualização força páginas nos relatórios e então os imprime página à página. Trata-se de uma forma de proteção ao sistema, gerar um grande relatório sem essa virtualização pode travar e derrubar o servidor.

Caso seja necessária a impressão sem a paginação, pode-se adicionar a propriedade de relatório "ignore.virtualization" como "true" e o sistema não virtualizará e gerará tudo em uma só página. Abaixo tem-se as duas maneiras de adicionar a propriedade:

• Adicionar a linha <property name="ignore.virtualization" value="true"/> logo abaixo da linha <property name="ireport.y" value="0"/> no relátorio;
• Através do IReport executar a inserção da propriedade.

Por padrão relatórios gerados pelo agendamento não possuem a virtualização, fato este que é aconselhável coloca-los para serem executados em momentos de menor uso do sistema. Deste modo, não será necessário utilizar a propriedade acima mencionada.

Fonte de Dados: Através desta opção, defina qual o banco de dados que será acessado para execução dos relatórios formatados.

[voltar ao topo]

Aba Arquivos

Nesta aba, deverão ser adicionados os modelos de relatório formatado. Através dos botões da barra de ferramentas da grade, pode-se adicionar, remover e realizar o download dos arquivos adicionados. Depois que um modelo é adicionado, este será apresentado na grade.

Observação: será permitido adicionar apenas arquivos nos formatos ".jrxml" e ".zpl".

Nota: quando você comprar uma solução pelo Place e esta for protegida, não será possível duplicar, excluir, adicionar e realizar o download dos registros.

[voltar ao topo]

Botões do Menu

Além dos recursos padrões (inclusão, exclusão, confirmação, cancelamento, recarregamento de tela, duplicação de informações e visualização de relatório), esta tela apresenta o botão  "Agendar Relatório". Através dele, pode-se criar agendamentos para o envio dos relatórios para o e-mail de parceiros definidos.

Ao clicar no botão, o sistema abrirá uma janela com todos os agendamentos na qual pode-se visualizar o horário local e do servidor e ainda incluir e excluir agendamentos.

O botão "Executar" localizado no alto do pop-up, é o responsável por executar o agendamento de forma manual, ou seja, ao ser acionado, o agendamento correspondente à linha selecionada, é imediatamente executado.

Incluindo um agendamento

Clique no botão  para "Adicionar agendamento", depois, preencha o campo "Descrição".

Depois de preenchida a Descrição, ao clicar no botão , serão apresentadas as seguintes informações:

"É possível personalisar o email enviado através de um arquivo de um modelo de impressão. Existem duas opções:

* Colocar o caminho do arquivo no Repositório de Arquivos. Ex.: Repo://pasta/arquivo.html.’

* Colocar apenas o nome do arquivo. Assim este arquivo deve ser colocado na pasta indicada pelo parâmetro SERVDIRMOD. Valor atual: C:\"

Para utilização da primeira opção descrita, é necessário que seja salvo o arquivo de modelo na tela Repositório de Arquivos, após hospedar o arquivo, ainda no repositório, clique no botão "Propriedades" para visualizar o caminho do arquivo no Repositório:

Esse caminho deverá ser copiado por completo para o campo "Arquivo de Modelo de e-mail" da tela de agendamento de envio de relatórios.

• A primeira linha do arquivo de modelo deverá conter apenas a tag: "*** SIADE ***";
• A segunda linha deverá conter o Assunto do email (sem tags HTML);
• O restante do conteúdo do arquivo será o corpo do email (pode conter tags HTML);
• As variáveis suportadas para utilização no modelo são as seguintes:

&nurfe - número do agendamento;

&seqage - sequência do agendamento;

&dhrel - data e hora de geração do relatório;

&descrel - descrição do relatório;

&descage - descrição do agendamento;

&nomedest - nome do destinatário;

&nomearquivo - nome do arquivo do relatório (arquivo que está anexado ao e-mail);

&formato - formato do relatório (PDF ou XLS).

• As funções suportadas são as de manipulação de modelos de impressão(PDES) e funções de manipulação de string.
• O arquivo de imagem deve ser colocado na pasta configurada pelo parâmetro 'SERVDIRMOD'. Exemplo: Considerando-se um arquivo de imagem com o nome "logo.jpg", no modelo ficará da seguinte forma:

<img src="&img-embutida:logo.jpg" alt="Sankhya" />

• O arquivo de modelo é associado ao agendamento, no primeiro passo do wizard. Caso o modelo não seja informado, será enviado o e-mail padrão.
• Abaixo pode-se observar um exemplo de configuração de arquivo; neste modelo nota-se a variável &descrel, que refere-se à descrição do relatório e pode ser usada no Assunto do email ou no Corpo do email, como visto abaixo:

Exemplo: (modelo.html):

*** SIADE ***

Email de exemplo (Relatório: &descrel)

<b>Olá,</b>

<p>Este é um email de exemplo para demonstrar como o arquivo <i>modelo.html</i> deve ser escrito.</p>

<p><font color=1100EE><b>Obrigado pela atenção!!!</b></font></p>

A informação a ser inserida no campo "Usuário responsável" se refere ao usuário encarregado do envio do relatório/documento por e-mail, onde este será notificado caso a mensagem não seja enviada por algum erro de conexão ou mesmo, e-mail inválido.

Efetuando a marcação "Editar mensagem manualmente", será possível personalizar a mensagem que será encaminhada via e-mail, além disso, serão abertos no próprio pop-up os campos para inserção do assunto e edição da mensagem, sendo esta última no formato html.

Em seguida, defina o Horário para Envio:

Feito isso, defina o destinatário (parceiros) que irão receber o relatório:

Nesta etapa, pode-se selecionar a opção "Usar lista variável de destinatários e parâmetros". Com essa opção, pode-se especificar, através de uma query, um comportamento personalizado para envio de relatórios.

Nota: para evitar ambiguidades, a identificação dos destinatários é realizada pelo nome do destinatário seguido de seu e-mail. O e-mail só é exibido se o mesmo estiver informado na tela de destinatários.

Na etapa seguinte, a janela que se abre tem um painel dividido em duas abas. Na aba "Consulta SQL" especifique a query que ira influenciar no comportamento do envio dos relatórios. Neste espaço, através da query mencionada, pode-se selecionar vários destinatários para envio do e-mail, onde estes deverão ser separados pelo caractere "vírgula (,)"; isso fará com que o e-mail seja enviado para todos os destinatários informados.

O botão "Validar Consulta" é utilizado para verificar se o que foi informado no quadro é uma instrução válida.

Utilizando uma instrução SQL, pode-se personalizar um comportamento para que o sistema gere relatórios das vendas realizadas por determinados parceiros, e os enviar para os endereços eletrônicos destes.

Caso a consulta não retorne valor para este campo, o sistema necessitará da informação do campo "Email" que o envio possa ser realizado. Os demais campos são úteis para montar o relatório enviado para o e-mail.

Na aba "Campos Obrigatórios" constam os campos que a query obrigatoriamente deve consultar, a fim de fazer com que o sistema busque estas informações no banco de dados. Os campos "CODCON" e Email são fundamentais em todos os agendamentos deste tipo, pois são estas informações utilizadas pelo sistema para enviar os e-mails. O campo CODCON corresponde ao "Código do Destinatário" da tela "BI Móvel > Cadastro > Destinatários".  

Se a opção "Usar lista variável de destinatários e parâmetros" na terceira etapa do agendamento, estiver desmarcada, selecione um destinatário para o envio do relatório, e serão exigidos os valores de parâmetros. Dessa forma, a imagem abaixo apresenta a última etapa do agendamento, onde os campos dos parâmetros exigidos são apresentados para preenchimento.

Esses parâmetros variam de acordo com o relatório. Definidos os valores dos parâmetros necessários para gerar o relatório, clique em "Concluir".

Realizados os procedimentos acima, o agendamento cadastrado será apresentado em modo grade juntamente com os demais já cadastrados, e o usuário irá receber o relatório por e-mail conforme agendado. Por fim, clique em "Fechar".

Ao clicar no botão "Duplicar", o sistema duplicará o registro (agendamento) referente a linha em foco na grade, duplicando assim todas as informações; para alterar alguma informação basta dar um duplo clique na linha que se deseja alterar e percorrer as etapas alterando o que for necessário.

Observação: caso haja um agendamento com 5 destinatários na tela de Relatórios Formatados e ocorrer um erro, por exemplo, no terceiro destinatário, o erro será exibido também nos dois relatórios seguintes. Isso irá impedir que esses relatórios sejam processados e forneçam um feedback ao usuário. Contudo, ao processar o agendamento pelo Controle de Jobs, os relatórios subsequentes serão processados mesmo que haja erros anteriores.

[voltar ao topo]

Botão Outras Opções

Ao acionar a opção "Adicionar lançador", será aberto um pop-up, nele informe a "Descrição", ou seja, a identificação literal para o lançador e a "Pasta de destino" que se refere ao diretório do menu ao qual abrigará o lançador de um determinado item;

Conclua a operação, através do botão "Concluir", ou cancele acionando o botão "Cancelar".

A opção "Localizar lançador", apresenta a listagem de todos os lançadores que apontam para o item que corresponde ao item atual de navegação. Por exemplo, se determinado usuário estiver navegando entre relatórios personalizados, ao acionar esta opção, será aberta uma lista de todos os lançadores que correspondem ao item "Relatório" atual de navegação. Nesta tela, além de visualizar os lançadores para um item, pode-se excluir um lançador do item e/ou alterar sua descrição.

Alterando a descrição de um lançador

Para alterar a "Descrição" de um lançador, selecione-o na grade. Ao preencher o campo Descrição, serão habilitados automaticamente os botões "Salvar" e "Cancelar", dessa forma o modo "Alteração de Descrição" será ativado.

Ao pressionar o botão Salvar, será confirmada a alteração da descrição. 

Caso seja selecionado o botão Cancelar, o modo Alteração de descrição será desabilitado, voltando para o estado normal da tela.

Ao clicar duas vezes em algum item da grade, você será redirecionado para o lançador, executando assim, a sua função.

O botão "Fechar", na parte inferior da tela, confirma o fechamento.

Observação: sempre que selecionado um lançador na Grade, o campo Descrição sofrerá alterações, exibindo assim, a sua descrição.

O botão "Excluir", estará disponível sempre que houver um lançador selecionado na grade, assim ao pressioná-lo, será aberta uma mensagem de alerta para confirmação da exclusão.

[voltar ao topo]

Impressão de relatórios formatados em telas adicionais de acordo com a linha posicionada

Na tela Construtor de telas, elabore uma tela adicional. Assim, o sistema criará uma nova tela, conforme o usuário entra na impressão de boletos, Portal de Vendas, Produtos, etc).

Em seguida, crie um arquivo JRXML, isto é , um arquivo contendo as configurações (neste caso dos relatórios) que deseja-se vincular à determinada rotina. Nele pode-se ter configurações de código de barra, o select envolvido para a demonstração nos relatórios, os campos que serão demonstrados no relatório, etc.

Feito isto, crie um Relatório formatado, na qual pode-se vincular um relatório previamente formatado (no caso o jrxml) a uma tela do sistema (que no caso vamos vincular à nova tela criada no Construtor de Telas).

Adicione também, o arquivo jrxml na aba "Arquivos", ou seja, vincule o relatório ao JRXML criado, para que este seja usado em qualquer tela do sistema.

Ainda nesta mesma tela, defina a "Tela/Instância" adicional. Neste exemplo, será vinculada a tela criada inicialmente, para poder utilizar o relatório formatado criado nos passos anteriores.

Caso tenha-se uma tela onde a mesma possua um grid, pode-se realizar a impressão apenas do item que está posicionado no grid. Para isso, realize a configuração do arquivo JRXML de acordo com as chaves (PK) das tabelas que está utilizando para apresentar os dados no grid. Considere o exemplo:

EQU.SEQUENCIA = $P{PK_SEQUENCIA}

AND EQU.MATRICULA = FUN.MATRICULA

AND EQU.CODPARC = FUN.CODPARC

As chaves da tabela TGFEQU são: SEQUENCIA, MATRICULA e CODPARC onde a SEQUENCIA é a PK ( Primary Key ).

Para que o relatório formatado imprima exatamente a linha selecionada na grade das telas adicionais, quando o campo for a PK, deverá obrigatoriamente passar a configuração = $P{PK_+NOMECAMPO}.

Exemplo:

TGFCAB

CAB.NUNOTA = $P{PK_NUNOTA}

TGFFIN

FIN.NUFIN = $P{PK_NUFIN}

TGFPRO

PRO.CODPROD = $P{PK_CODPROD}

Observação: selecionando diversos itens na grade dos Portais, ao extrair o relatório formatado, o sistema irá considerar todos os registros selecionados e gerar um único arquivo para impressão. 

[voltar ao topo]

Geração de grandes relatórios

Ao realizar uma consulta, utilizando-se de poucos filtros, em grandes bancos de dados, pode-se obter como resultado, grandes relatórios. O tamanho destes documentos, podem consumir toda a memória principal (RAM) disponível, ou até mesmo fazer com que o Sankhya-Om perca sua conexão.

Na geração de um grande relatório através desta tela, é permitido ao sistema, utilizar a virtualização do "JasperReports" (JasperReports é o framework utilizado no Sankhya-Om para geração dos relatórios em PDF e Excel(XLSX)), para que o processo de geração seja feito em memória secundária (HD), não consumindo assim, toda a memória principal (RAM) disponível.

Caso seja necessária a configuração para geração de um relatório com grandes quantidades de informação, esta deve ser realizada por um consultor Sankhya.

[voltar ao topo]