Índice

Objetivo

O objetivo deste guia é descrever o desenvolvimento, publicação e visualização de relatórios no Fluig, para facilitar a compreensão será detalhado um exemplo de relatório de usuários.

Ambiente de Desenvolvimento

Objetivo

El propósito de esta guía es describir el desarrollo, la publicación y la visualización de informes en TOTVS Fluig Plataforma,y para facilitar su comprensión se detallará un ejemplo de informe de usuario.

Entorno de desarrollo

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

O TOTVS Fluig utiliza o Plataforma utilizar BIRT como motor de execução ejecución de relatóriosinformes, por esse motivo para o desenvolvimento de relatórios deve-se utilizar o padrão e a metodologia do BIRT.eso para el desarrollo de informes se debe utilizar el estándar y la metodología de BIRT.

Se recomienda el uso de Recomenda-se o uso do BIRT Report Designer para o desenvolvimento el desarrollo de relatórios informes para o Fluig. O BIRT pode ser integrado ao Studio ou Eclipse (já instalados para utilização do Fluig Studio, conforme Guia de Instalação BIRT puede integrarse a Studio o Eclipse (ya instalado para utilizar Fluig Studio, según la Guía de Instalación Fluig Studio), basta sólo debe instalar o el plugin do de BIRT. Para isso é necessário realizar acessar a opção Ajuda P ara ello es necesario acceder a la opción Ayuda -> Instalar Novo Nuevo Software e seguir os procedimentos a seguir y seguir los siguientes procedimientos: 

1. Work with: Selecionar  Seleccionar Indigo.
2. Busca: Após listar as opções do BIRT, digitar Birt no campo de busca.
3. Búsqueda: Después de enumerar las opciones de BIRT, ingresar Birt en el campo de búsqueda.
4. Marcar la casilla de selección de Marcar a caixa de seleção de Business Intelligence, Reporting and Charting.
5. Em seguida, acionar AvançarA continuación, presionar Avanzar.

O BIRT Report Designer conta com várias funcionalidades que auxiliam no desenvolvimento de relatórios. Entre elas destacam-se: cuenta con varias funcionalidades que ayudan en el desarrollo de informes. Entre ellas se destacan: el ajuste de layout, configuração la configuración de acesso a dados e formatação do relatório.

Segurança Ambiente SaaS

acceso a datos y el formateo de informe.

Seguridad Entorno SaaS

En caso de ejecución de Fluig en entorno SaaS, no se recomienda el uso de informes, ya que se pueden crear informes que devuelvan información de otras empresas a través de la consulta JPQL o Dataset. Para garantizar la no ejecución, se debe definir el valor true para la variable SaaS ubicada en: Em caso de execução do Fluig 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%\jboss-as-7.2.0.Final\standalone\configuration\standalone.xml. ExEj:

<simple name="java:global/webdesk/SaaS" value="true"/>

Conexão direta com o banco de dados

É possível publicar relatórios que se comunicam diretamente com o banco de dados.

Conexión directa a la base de datos

Se pueden publicar informes que se comuniquen directamente con la base de datos.

Utilice en su informe las siguientes configuraciones prestando atención a los valores de las propiedades 'odaDriveClass' y Utilize em seu relatório as configurações abaixo atentando para os valores das propriedades 'odaDriveClass' e 'odaURL'.

Para fazer conexão direta com banco de dados SQLServer é preciso utilizar o seguinte padrãoPara realizar una conexión directa con la base de datos SQLServer es necesario utilizar el siguiente estándar:

<property name="odaDriverClass">com.microsoft.sqlserver.jdbc.SQLServerDriver</property> 
<property name="odaURL">jdbc:sqlserver://IP:1433;databaseName=DATABASE</property>

Para fazer conexão direta com banco de dados MySQL é preciso utilizar o seguinte padrãoPara realizar una conexión directa con la base de datosMySQL es necesario utilizar el siguiente estándar:

<property name="odaDriverClass">com.mysql.jdbc.Driver</property> 
<property name="odaURL">jdbc:mysql://IP:3306/databaseName=DATABASE</property>

Desenvolvendo um relatório de Usuários

Desarrollo de un informe de Usuarios

A través de BIRT Report Designer se pueden crear varios informes para Fluig, acceder a datos de la base de datos del producto a través de la Através do BIRT Report Designer é possível criar vários relatórios para o Fluig, acessar dados do banco de dados do produto via consulta JPA, JDBC. É possível acessar os dados de outros produtos por conexão Es posible acceder a los datos de otros productos por conexión JDBC, Web Service ou arquivos o archivos XML.

Para facilitar a compreensão a respeito do desenvolvimento de relatórios para o Fluig, será demonstrado um exemplo de criação de relatórios. A seguir os passos necessários para a criação do relatório de usuários, sendo este com dados providos do Fluig através da consulta via dataset. O fonte do exemplo citado pode ser baixado a partir do seguinte la comprensión sobre el desarrollo de informes para Fluig, se mostrará un ejemplo de creación de informes. A continuación se detallan los pasos necesarios para la creación de informe de usuarios, contando con datos proporcionados por Fluig por medio de consultas a través de dataset. La fuente del ejemplo citado se puede descargar desde el siguiente link:

Colleague Report.zip

Criando um novo projeto e um novo relatório

Creación de un nuevo proyecto y un nuevo informe

Abra la herramienta en la que se instaló el plugin de Abra a ferramenta na qual instalou o plugin do BIRT Report Designer para acompanhar o passo a passo, no exemplo iremos utilizar o seguir el paso a paso, en este ejemplo vamos a utilizar Fluig Studio.

• No projeto En el proyecto Fluig previamente criado, clique com o botão direito do mouse na pasta reports, e em seguida em Novo -> Relatório Fluig.Em seguida basta informar o Nome do Relatório e clicar em Concluircreado, haga clic en el botón derecho del mouse en la carpeta reports, y a continuación en Nuevo -> Informe Fluig.
• Luego, sólo debe informar el Nombre del informe y hacer clic en Finalizar.

Figura 1 - Criação de relatório no projeto Creación de informe en el proyecto Fluig.

Configurando o acesso aos dados

Configuración de acceso a los datos

Un Data Source es el mecanismo que almacena los datos de conexión con la fuente de datos, por ejemplo, configuraciones Um Data Source é mecanismo que guarda os dados de conexão com a fonte de dados, por exemplo, configurações JDBC, Web Service, entre outrosotros. No caso desse relatório será utilizado o acesso aos dados via linguagem JavaScript.En el caso de este informe se utilizará el acceso a los datos a través de Javascript.

Siga los siguientes pasosAcompanhe os passos a seguir:

Incluindo parâmetros no Relatório

Inclusión de parámetros en el informe

Es posible incluir parámetros en el informe que se solicita al usuario antes de su renderización, ayudando al filtro de consulta de datos generando un informe específico. Siga los siguientes pasosÉ 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. Siga os passos a seguir:

TAG's

O TOTVS Fluig disponibiliza Plataforma ofrece TAG’s de substituição que auxiliam no desenvolvimento e na segurança da geração das informações do relatório, são elasreemplazo que ayudan al desarrollo y la seguridad de la generación de información del informe, estas son:

• ${WKCompany}: substitui a variável pelo código da empresa autenticada no Fluigsustituye a la variable por el código de la empresa autenticada en TOTVS Fluig Plataforma.
• ${WKUser}: substitui a variável pelo código do usuário autenticado no Fluig.

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 Fluig.

Populando o Data Set

sustituye a la variable por el código del usuario autenticado en TOTVS Fluig Plataforma.

Las TAG’s son útiles en los casos de información que sólo deben generarse sobre la empresa en la cual el usuario está autenticado, o en informes que muestran sólo información sobre el usuario autenticado en TOTVS Fluig Plataforma.

Completar el Data Set

En el ejemplo que se presenta en este documento se completará el informe a través de datos proporcionados por consultas JPA ingresando a la base de TOTVS Fluig Plataforma, pero se pueden utilizar otros recursos para completar el No exemplo apresentado neste documento será populado o relatório através de dados providos de consultas JPA acessando o banco do Fluig, porém é possível utilizar outros recursos para popular o Data Set: XML, Web Service e y JDBC.

O BIRT renderiza o relatório através da execução de seus eventos, são muitos os eventos disponibilizados pelo BIRT, nesse exemplo serão utilizadosel informe a través de la ejecución de sus eventos, son muchos los eventos proporcionados por BIRT, en este ejemplo se utilizarán:

• initialize:primeiro evento disparado pelo  primer evento activado por BIRT, é recomendado se recomienda utilizar esse este evento para importação de importar bibliotecas e inicialização de variáveisinicializar variables;
• beforeOpen: evento disparado activado, antes do de BIRT abrir a conexão com a fonte de dados la conexión con la fuente de datos (Data Source);
• fetch: evento disparado pelo BIRT depois da busca de cada registro no Data Set e activado por BIRT después de buscar cada registro en el Data Set y antes de aplicar os los filtros e y los campos calculados.

Através dos eventos é possível desenvolver a A través de los eventos se puede desarrollar la lógica de consulta e geração de dados através da linguagem de programação JavaScript , além disso é possível fazer uso de vários recursos e bibliotecas da linguagem Java™. y generación de datos a través del lenguaje de programación JavaScript, también es posible utilizar varios recursos y bibliotecas del lenguaje Java ™.

importPackage(Packages.com.datasul.technology.webdesk.dataset.service);
importPackage(Packages.com.datasul.technology.webdesk.dataset);
importPackage(Packages.com.datasul.technology.webdesk.search.controller);
importPackage(Packages.java.util);
var count = 0;
var dataset = null;

try{
	var factory = DatasetFactory.getInstance(${WKCompany});
	var constraints = new Array();	
	var sortingFields = new Array();
	var i = 0;		
	 
	//Filtra somentesólo por pelala matriculamatrícula dodel colaborador informado
	if(params["Matricula"].value != null && params["Matricula"].value != "*") {		
		constraints[i] = factory.createConstraint("colleaguePK.colleagueId", params["Matricula"].value, params["Matricula"].value, ConstraintType.MUST);
		i++;
	}
	
	//Filtra ativosactivos si casoestá selecionadoseleccionada
	if(params["paramEnable"].value != null && params["paramEnable"].value != "*"){
		constraints[i] = factory.createConstraint("active", params["paramEnable"].value, params["paramEnable"].value, ConstraintType.MUST);
		i++;
	}
	
	//Ordena según conformela seleçãoselección
	if(params["paramSort"].value != null && params["paramSort"].value != "*"){
		sortingFields[0] = params["paramSort"].value;
	}	
	
	//Dataset
	dataset = factory.getDataset("colleague", null, constraints, sortingFields);
	
}catch (e) {
}finally {
}

if (dataset != null) {
	if (count <	dataset.rowsCount){
		//montainstala oel objeto de dala linhalínea
		row["colleagueId"] = dataset.getValue(count, "colleaguePK.colleagueId");
		row["login"] = dataset.getValue(count, "login");
		row["colleagueName"] = dataset.getValue(count, "colleagueName");
		row["mail"] = dataset.getValue(count, "mail");
		
		if(dataset.getValue(count, "active") == true){
			row["active"] = "SimSí";
		}else{
			row["active"] = "NãoNo";
		}
		
		//AtualizaActualiza oel contador  
		count++;
		return true;
	}
	return false;
}

...

Obtención de datos por conexión JDBC

Uma Una forma alternativa de obtenção obtención de dados para criação de relatórios é a utilização datos para crear informes es el uso de JDBC. É necessário criar um Data Source que se conecte com o banco de dados, nele serão armazenados os dados para conexão, via JDBC, ao banco de dadosEs necesario crear un Data Source que se conecte a la base de datos, en él se almacenarán los datos para la conexión, a través de JDBC a la base de datos.

SELECT vol_fisic.CD_VOL_FISIC,
         vol_fisic.COD_EMPRESA,
         vol_fisic.NOM_DIR_FISIC,
         vol_fisic.ID_TIP_VOL_FISIC
FROM vol_fisic
WHERE vol_fisic.COD_EMPRESA = ${WKCompany}

Formatando a visualização do Relatório

Formatear la visualización del informe

Se requiere la inclusión de los componentes de renderización del informe. Haga clic en la pestaña Layout para visualizar la página del informe que está en blanco y, a continuación, seleccione la pestaña Palette como muestra la É necessária a inclusão dos componentes de renderização do relatório. Clique na aba Layout para visualizar a página do relatório que está em branco e em seguida selecione a aba Palette conforme a figura 21.

Figura 21 – Relatório em brancoInforme en blanco.

Na aba Pallets é possível incluir vários componentes de visualização e renderização de dados entre eles destacam-seEn la pestaña Pallets se pueden incluir varios componentes de visualización y renderización de datos entre ellos se encuentran:

• Label: Texto curto e corto y estático.
• Text: Texto longo é possível formatá-lo com largo se puede formatear con TAG’s HTML.
• Dynamic Text: Texto dinâmico provido do dinámico proveniente del Data Set.
• Image: Inclusão Inclusión de imagensimágenes.
• Grid: Formatador Formateador de dados em datos en Grid.
• Table: Tabela Tabla de dadosdatos.
• Chart: Gráficos de pizzatorta, linhalínea, tubo, etc.

<br>
<a href="http://www.fluig.com/">http://www.fluig.com/</a>
<br><b>E-mail:</b> <a href="mailto:[email protected]">[email protected]</a>
<br><b>Telefone:</b> 0800 882 9191
<br>

...

Renderización de datos del Data Set

Selecione a aba Seleccione la pestaña Data Explorer e expanda o colleagueDataSet criado anteriormente e em seguida arraste cada item do Data Set para a coluna Detail Row da tabela criada anteriormente conforme  y abra colleagueDataSet creado anteriormente y, a continuación arrastre cada ítem del Data Set a la columna Detail Row de la tabla creada anteriormente, como muestra la figura 27. 

Figura 27 - Data Set.

Publicando Relatórios

Publicação

Publicación de Informes

Publicación

Al completar el desarrollo del informe, es necesario realizar la exportación del mismo para la navegación de documentos TOTVS Fluig PlataformaApós a conclusão do desenvolvimento do relatório, é necessário realizar a exportação do mesmo para a navegação de documentos Fluig.

...

Visualizador de

...

Informes

Después de completar la publicación, para poder verla, haga clic en el informe en la carpeta en el cual se hizo la publicación en TOTVS Fluig Plataforma.

Una nueva ventana se abrirá, para iniciar la ejecución del informe de colaboradores desarrollado previamente, se necesita la inclusión de parámetros, defina sus valores y a continuación haga clic en el botón OK 

Após concluir a publicação, para visualizá-lo, clique sobre o relatório na pasta onde foi feita a publicação no Fluig.

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.

Figura 32 – Parâmetros do relatório.

33 – Informe de Usuarios– Resultado.

El informe deberá mostrar todos los usuarios registrados en TOTVS Fluig Plataforma para la empresa en la cual el usuario O relatório deverá mostrar todos os usuários cadastrados no Fluig para a empresa em que o usuário está autenticado.

Figura 33 – Relatório de Usuários– Resultado.

...

Opciones del visualizador

A ferramenta de visualização de relatório do fluig possui várias La herramienta de visualización de informe de Fluig posee varias funcionalidades:

• Verificar Indice: Caso o relatório desenvolvido possua índice é possível listá-lo.
• Executar relatório: Permite que o relatório seja executado novamente.
• Exportar dados: Exporta os dados gerados do relatório em arquivo, permitindo selecionar as colunas desejadas e o separador de dados.
• Si el informe desarrollado posee índice es posible ponerlo en la lista.
• Ejecutar informe: Permite que el informe se ejecute nuevamente.
• Exportar datos: Exporta los datos generados del informe en archivo, permitiendo seleccionar las columnas deseadas y el separador de datos.
• Exportar informe: Convierte los datos del informe en diferentes formatos de archivosExportar relatório: Converte os dados do relatório em diferentes formatos de arquivos: Microsoft® Excel®, PostScript®, PDF, Microsoft® Word e Microsoft® Power Point®, permite também a seleção también la selección de páginas que serão exportadasse exportarán.
• Imprimir relatórioinforme: Imprime relatório selecionando as impressoras instaladas no computador do usuário autenticado e permite imprimir em formato PDF ou informe seleccionando las impresoras instaladas en el ordenador del usuario autenticado y le permite imprimir en formato DF o HTML.
• Imprimir relatório no informe en el servidor:Imprime relatório a partir das impressoras instaladas no servidor do  Imprime informe desde las impresoras instaladas en el servidor de Fluig.
• Navegação Navegación de páginas: permite a navegação navegar entre as las páginas do relatóriodel informe.

Image RemovedImage Added

Figura 34 – Funcionalidades do de visualizador de relatóriosinformes.

...

Funciones de

...

Agregación

O Fluig suporta através soporta a través de consultas JPA e seu banco de dados, o uso de funções de agregação, tais comoy su base de datos, el uso de las funciones de agregación, como por ejemplo: AVG, SUM, COUNT, MAX e y MIN. Permite também también utilizar agrupamentosagrupaciones: GROUP BY e y HAVING

...

Tabla de entidades

A tabela abaixo La siguiente tabla hace referencia a relação la relación entre o el código de dataset, a entidade la entidad de persistência JPA utilizada nas persistencia JPA usada en las consultas, e a respectiva tabela no banco de dados. As colunas das entidades de persistência são as mesmas apresentadas no y la tabla correspondiente a la base de datos. Las columnas de las entidades de persistencia son las mismas presentadas en dataset.

Exemplo de Utilização

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 oel valor dode Count
rowMap.get("d.publisherId");

//Busca oel Código dodel documento
rowMap.get("count(d.documentPK.documentId)");

...

...

...

importPackage(Packages.com.datasul.technology.webdesk.dataset.service);

importPackage(Packages.com.datasul.technology.webdesk.dataset);

importPackage(Packages.com.datasul.technology.webdesk.search.controller);

Retornando dados do formulário

Devolución de datos del formulario

A través de la clase DatasetFactory es posible buscar datos de formularios, incluir filtros y ordenar. Ejemplo de usoAtravés da classe DatasetFactory é possível buscar dados de formulários, incluir filtros e ordenação. Exemplo de utilização:

//MontaInstala aslas constraints para consulta
var factory = DatasetFactory.getInstance(${WKCompany});

//Filtra Clientes de 1 a 5
var c1 = factory.createConstraint("cod_cli", "1", "5",ConstraintType.MUST);
var constraints = new Array(c1);

//Ordena oel resultado por peloel nomenombre dodel Cliente
var sortingFields = new Array("name_cli");
dataset = factory.getDataset("cad_cli", null, constraints, sortingFields);

O exemplo acima invoca o método getDataset passando alguns argumentos extras como parâmetros:

• Nome do Dataset: Nome do serviço de dados do formulário;
• Campos: Retorna apenas os campos recebidos no array informado. Caso null, retorna todos os campos.
• Constraints: Vetor com as condições de busca do Dataset. Em cada condição de busca (constraint) deve-se informar o nome do campo do formulário que será filtrado, a faixa de valores inicial e final, e o tipo de Constraint. Os tipos podem ser:

El ejemplo anterior invoca el método getDataSet pasando algunos argumentos adicionales como parámetros:

• Nombre del Dataset: Nombre del servicio de datos del formulario;
• Campos: Devuelve sólo los campos recibidos en el array informado. Si es null, devuelve todos los campos.
• Constraints: Vector con las condiciones de búsqueda de Dataset. En cada condición de búsqueda (constraint) se debe informar el nombre del campo del formulario que se filtrará, el rango de valores inicial y final y el tipo de Constraint. Los tipos pueden ser:

• • MUST: Indica que todos los registros del Dataset deben satisfacer esta condición.
  • SHOULD: Indica que los registros del Dataset pueden o no satisfacer esta condición. Este tipo es más común cuando se necesita que un mismo campo tenga valores A o B (donde cada uno será una
• MUST: Indica que todos os registros do Dataset devem satisfazer a esta condição.
SHOULD: Indica que os registros do Dataset podem ou não atender à condição. Este tipo é mais comum quando se necessita que um mesmo campo tenha valores A ou B (onde cada um será uma
• • constraint SHOULD).
  • MUST_NOT:
indica que nenhum dos registros pode satisfazer a condição.Ordenação: Vetor com a
• •  indica que ninguno de los registros puede satisfacer la condición.
  • Orden: Vetor con la lista de campos que
será utilizada para ordenação dos registros no
• • se utilizará para ordenar los registros en el Dataset.

O fonte do exemplo citado acima pode ser baixado a partir do seguinte La fuente del ejemplo citado anteriormente se puede bajar del siguiente link:

Customer CardIndex.zip

Busca Búsqueda de dados datos de Formulário com Formulario con filtro por datafecha

Para realizar consultas via a través de Dataset com con filtros do del tipo DataFecha, é necessário antes salvar o campo da ficha no formato es necesario antes guardar el campo de la ficha en el formato aaaa/mm/dd (anoaño/mêsmes/diadía)  para que seja possível se pueda realizar la búsqueda a busca via través de Dataset.

Exemplo Ejemplo de consulta:

//MontaInstala aslas 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 oel resultado por peloel nomenombre dodel Cliente
var sortingFields = new Array("name_cli");
dataset = factory.getDataset("cad_cli", null, constraints, sortingFields);

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.

Apache is a trademark of The Apache Software Foundation.

Firefox and Mozilla are registered trademarks of the Mozilla Foundation.

JavaScript is a trademark of Oracle Corporation.

Microsoft, Active Directory, Excel, Internet Explorer, Outlook, PowerPoint, SQL Server, Windows and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

MySQL is a trademark of Oracle Corporation and/or its affiliates.

Oracle, Java and OpenOffice.org are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Progress and OpenEdge are trademarks or registered trademarks of Progress Software Corporation or one of its subsidiaries or affiliates in the U.S. and other countries.

Red Hat and JBoss are registered trademarks of Red Hat, Inc. in the United States and other countries.

Any other third party trademarks are the property of their respective owners.

...