Home

TOTVS | Plataformas e tecnologias

Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Índice
maxLevel4
outlinetrue
exclude.*ndice
stylenone

 

Objetivo

 

O objetivo deste documento é descrever o desenvolvimento, publicação e visualização de relatórios no TOTVS | ECM, para facilitar a compreensão será detalhado um exemplo de relatório de colaboradores.

...

Ambiente de Desenvolvimento

 

Para o desenvolvimento de relatórios é necessário possuir o Java™ JDK/JRE superior a 1.6. Endereço para download: http://java.sun.com/javase/downloads/index.jsp.

...

O BIRT Report Designer conta com várias funcionalidades que auxiliam no desenvolvimento de relatórios. Entre elas destacam-se: ajuste de layout, configuração de acesso a dados e formatação do relatório.

 

Segurança Ambiente SaaS

 

Em caso de execução do TOTVS | ECM em ambiente SaaS, não é recomendado o uso de relatórios, pois é possível criar relatórios que retornem informações de outras empresas via consulta JPQL ou Dataset. Para garantir a não execução, é necessário definir o valor “true” para a variável “SaaS” localizada em: %JBOSS_HOME%\server\default\deploy\wdk-service.xml.

...

Desenvolvendo um relatório de colaborados

 

Através do BIRT Report Designer é possível criar vários relatórios para o TOTVS | ECM, acessar dados do banco de dados do produto via consulta JPA, JDBC. É possível acessar os dados de outros produtos por conexão JDBC, Web Service ou arquivos XML.

...

Deck of Cards
id4

 

É possível incluir parâmetros no relatório a serem solicitados para o usuário antes da sua renderização, auxiliando no filtro de consulta aos dados gerando um relatório específico.

 

Card
id4
labelPasso 1

 

Selecione a aba Data Explorer, em seguida clique com o botão direito do mouse no item Report Parameters, selecione a opção New Parameter conforme a figura 9.

 

Figura 9 – Parâmentros do Relatório.

Card
id4
labelPasso 2

 

A figura 10 ilustra a janela de inclusão de parâmetros.

 

Figura 10 – Configuração de parâmetros.

 

Ao abrir a janela New Parameter inclua os seguintes parâmetros:

Matrícula

  • Name: Matrículo;
  • promptText: Matrícula do Colaborador ou "*" para mostrar todos;
  • Data type: String;
  • Display type: Text Box;
  • Is Requered: true.

Mostrar usuários

  • Name: paramEnable;
  • Prompt text: Mostrar usuários;
  • Data type: String;
  • Display type: List Box;
  • Is Requered: true.

 

Selection Values

ValueDisplay Text
*Todos
trueAtivos
falseInativos


Ordenar por

  • Name: paramSort;
  • Prompt text: Order por;
  • Data type String;
  • Display type: List Box;


Selection Values

ValueDisplay Text
c.colleaguePK.colleagueIdMatrícula
c.colleagueNameNome
c.loginLogin


 

TAG's

 

O TOTVS | ECM disponibiliza TAG’s de substituição que auxiliam no desenvolvimento e na segurança da geração das informações do relatório, são elas:

...

As TAG’s são úteis em casos de informações que só devem ser geradas a respeito da empresa em que o usuário está autenticado, ou em relatórios que mostrem somente informações a respeito do usuário autenticado no TOTVS | ECM.


Populando o DataSet

 

No exemplo apresentado neste documento será populado o relatório através de dados providos de consultas JPA acessando o banco do TOTVS | ECM, porém é possível utilizar outros recursos para popular o Data Set: XML, Web Service e JDBC.

...

Deck of Cards
id11

 

Após concluir a publicação, para visualizá-lo, clique sobre ele no GED do TOTVS | ECM.

 

Card
id11
labelPasso 1

 

Uma nova janela deverá abrir, para iniciar a execução do relatório de colaboradores desenvolvido anteriormente é necessária a inclusão de parâmetros, defina os seus valores e em seguida clique no botão OK conforme a figura 32.

 

Figura 32 – Parâmetros do relatório.

Card
id11
labelPasso 2

 

O relatório deverá mostrar todos os colaboradores cadastrados no TOTVS | ECM para a empresa em que o usuário está autenticado, conforme figura 33.

 

Figura 33 – Relatório de Colaboradores – Resultado.

 

Opções do visualizador

 

A ferramenta de visualização de relatório do TOTVS | ECM possui várias funcionalidades:

...

JPA - Funções de Agregação

 

Funções de agregação

 

O TOTVS | ECM suporta através de consultas JPA e seu banco de dados, o uso de funções de agregação, tais como: AVG, SUM, COUNT, MAX e MIN. Permite também utilizar agrupamentos: GROUP BY e HAVING.

...

As colunas das entidades de persistência são as mesmas apresentadas no dataset.

 

 

Exemplo de utilização

 

Bloco de código
importPackage(Packages.com.datasul.technology.webdesk.dataset.service); importPackage(Packages.java.util); var qd = null; var rs = null; var rowMap = null; var sqlJpa = ""; qd = new QueryDelegate(); sqlJpa = "SELECT count(d.documentPK.documentId), d.publisherId from Document d WHERE d.documentPK.companyId = ${WKCompany} GROUP BY d.publisherId"; rs = qd.getResultQuery(sqlJpa); var rowMap = rs.get(0); //Busca o valor do Count rowMap.get("d.publisherId"); //Busca o Codigo do documento
rowMap.get("count(d.documentPK.documentId)");

...

Acessando dados de Fichários

 

Importando bibliotecas

 

A partir da classe DatasetFactory é possível acessar dados de fichários publicados no TOTVS | ECM.
Para popular um relatório através de dados de fichários é necessário a importação das seguintes bibliotecas:

...

Retornando dados do fichário

 

Através da classe DatasetFactory é possível buscar dados de fichários, incluir filtros e ordenação. Exemplo de utilização:

...

Busca de dados de fichário dom filtro de data

 

Para realizar consultas via Dataset com filtros do tipo Data, é necessário antes salvar o campo da ficha no formato aaaa/mm/dd (ano/mês/dia) para que seja possível realizar a busca via Dataset.
Exemplo de consulta:

Bloco de código
// Monta as constraints para consulta var factory = DatasetFactory.getInstance(${WKCompany}); //Filtra Clientes de 1 a 5 var c1 = factory.createConstraint("campo_data", "2010/01/25", "2010/05/02", ConstraintType.MUST); var constraints = new Array(c1); //Ordena o resultado pelo nome do Cliente var sortingFields = new Array("name_cli"); dataset = factory.getDataset("cad_cli", null, constraints, sortingFields);

 

Third Party Trademarks

 

Adobe, Flash, Flex, Flex Builder, PostScript and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.

...