Índice

Objetivo

...

Este guia tem o objetivo de apresentar o conceito de Dataset, suas possíveis parametrizações e sua importância na plataforma fluig.

Pré-requisitos

...

Para que se tenha uma compreensão completa destas informações, alguns conhecimentos são considerados pré-requisitos, entre eles:

• Visão geral sobre o fluig
• Visão geral sobre integração de sistemas

Datasets

...

O

...

fluig é

...

uma plataforma que permite disponibilizar informações provindas de várias fontes de dados através de formas variadas de apresentação

...

, dependendo da necessidade de cada cliente

...

. Esse recurso é atendido pelo componente Dataset, que padroniza o acesso às informações, independente da origem dos dados. É possível apresentar ou processar informações referentes a

...

:

• dados da própria plataforma (como usuários, grupos, papéis, tarefas, etc.)

...

• ;
• dados criados pelo usuário mas gerenciados

...

• pela plataforma (dados de formulários)

...

• ;
• dados externos (como entidades de um ERP)

...

• ;
• valores

...

• fixos (como uma lista de estados ou unidades de medida).

O Fluig possui o componente Dataset que permite padronizar o acesso às informações, independente da origem dos dados, ou seja, é possível acessar informações provenientes de vários locais, como aplicativos externos, banco de dados ou mesmo das próprias funcionalidades do Fluig através de um mesmo componente. Isto significa que, uma vez que um Dataset esteja disponível no sistema, ele poderá ser invocado de qualquer parte do sistema e de forma consistente, independente da sua origem.

Um Dataset disponibiliza operações que

...

viabilizam sua consulta como: consultar quais são as colunas disponíveis

...

, quantos registros foram retornados na consulta, os valores de cada campo

...

, e

...

filtrar os valores de retorno.

O diagrama abaixo apresenta um modelo conceitual sobre os Datasets.

 Image Added

Tipos de Datasets

...

Existem três tipos de

...

datasets gerenciados pela plataforma: internos, simples e avançados:

• Internos: permitem acessar dados das entidades do próprio

...

• fluig, como usuários, grupos, processos ou tarefas, por exemplo

...

• , ou dados existentes em formulários publicados no fluig. 

  Painel
  Acesse aqui para conhecer detalhes dos datasets internos.

• Simples: realizam consulta em dados provindos de API, de forma simplificada e sem codificação, por isso podem ser utilizados em uma grande gama de situações, por exemplo: extração de dados de um serviço externo (via WebServices, por exemplo). A plataforma pode gerar a integração sem qualquer tipo de codificação, sendo necessário apenas informar o endereço e o método do Webservice que contém as informações. 

  Painel
  Acesse aqui para saber como construir facilmente um dataset simples.

• Avançados:  é uma forma de customização do dataset simples, permitindo navegar nos dados retornados por meio de uma codificação em JavaScript. Por exemplo:

...

• definição de uma lista de valores fixos (como estados de um país)

...

• .

  Painel
  Acesse aqui para saber como codificar um dataset avançado.

Ainda que os

...

Datasets possam ter origens distintas, não existe qualquer diferença sob a perspectiva do componente que

...

realizará consultas neste Dataset. Esta característica representa um grande benefício para os usuários, uma vez que a fonte dos Datasets pode ser alterada sem que isto represente retrabalho nos pontos onde ele é utilizado.

...

Exemplificando

...

Para entender melhor, considere um processo workflow que precise trabalhar com uma lista de centros de custo. Em um primeiro momento, pode-se trabalhar com um Dataset

...

simples que monte, de forma fixa, os registros referentes a cada um dos centros de custo necessários para

...

este processo.

Uma vez que codificar a lista se torne pouco flexível (devido

...

a alterações

...

frequentes nos dados), é possível

...

definir que a fonte de dados seja baseada em um Dataset de formulário, desde que se observe o nome dos campos do Dataset, não haverá qualquer impacto sobre o processo workflow.

Em um terceiro momento, pode-se optar por

...

mudar o Dataset novamente

...

,

...

desta vez extraindo os centros de custo do ERP do cliente. Novamente não haverá impacto para o processo workflow (ou para os demais pontos que utilizem o Dataset), desde que se

...

mantenha a estrutura do Dataset inalterada.

Âncora
consultando consultando

Consultando dados

...

A consulta aos dados retornados pelo Dataset pode ser feita pelo fluig Studio ou pela própria plataforma (via painel de controle ou widget).

Via Painel de Controle

A partir da atualização 1.6.2, o administrador do sistema pode consultar o que o Dataset está retornando, acessando Painel de Controle > Datasets, localizando o Dataset desejado, e acionando Mais ações > Consultar. Os dados retornados serão apresentados de forma semelhante à janela abaixo.

Image Added

Via Widget

Pelo fluig, através da widget Listar registros de datasets, 

Visualizando Datasets

...

é possível consultar os Datasets disponíveis bem como visualizar o seu conteúdo. Com isto é possível verificar quais os campos disponíveis, tanto para filtros quanto para acesso

...

. Através desta widget, visualizações de datasets podem ser publicadas em páginas ou comunidades.

...

Image Removed

Via fluig Studio

Para conhecer a consulta de datasets via fluig Studio, acesse a página de Visualização de DatasetsNeste exemplo, é possível visualizar os campos disponíveis (conta, titulo, natureza e tipo) e os registros retornados pelo Dataset. Note que estas informações são essenciais para o uso dos Datasets, principalmente quando há necessidade de restringir os dados que queremos acessar.

Acessando um Dataset

...

Vários pontos do Fluig fluig podem fazer uso dos Datasets. Dependendo do local onde o Dataset é utilizado, podem ocorrer variações na forma de acessá-lo ou de manuseá-lo.

Via pontos de customização

Quando um Dataset é acessado via um ponto de customização como eventos globais, eventos de processos, eventos de definição de formulário ou mesmo em outros Datasets, isto é feito através de chamadas JavaScript que serão executadas no lado servidor.

O exemplo abaixo apresenta um exemplo simples de chamada a um Dataset:

function doTest1() {
	var dataset = DatasetFactory.getDataset("group", null, null, null);
	return dataset.rowsCount;
}

No exemplo acima, o código JavaScript faz o acesso ao Dataset "group", que é um Dataset interno do sistema, e retorna a quantidade de linhas disponíveis (rowsCount). O objeto DatasetFactory é a "porta de entrada" para o acesso a qualquer Dataset. Além de permitir a carga de um Dataset, ela também permite navegar entre todos os Datasets disponíveis no sistema.

Construindo um Dataset Customizado

Um Dataset é construído a partir de um código JavaScript. Uma vez que o próprio Dataset é criado a partir de um código JavaScript, é possível fazer chamadas a outros Datasets, chamadas à serviços externos ou apenas criar o Dataset a partir de valores codificados.

No exemplo Abaixo é criado um Dataset cujo os campos e valores estão fixos no código:

 function createDataset(fields, constraints, sortFields) {
	var dataset = DatasetBuilder.newDataset();
	  
	//Cria as colunas
	dataset.addColumn("Sigla");
	dataset.addColumn("Estado");
	dataset.addColumn("Capital");
	dataset.addColumn("Area");
	 
	//Cria os registros
	dataset.addRow(new Array("AM", "Amazonas", "Manaus", 1570746));
	dataset.addRow(new Array("PA", "Pará", "Belém", 1247690));
	dataset.addRow(new Array("MT", "Mato Grosso", "Cuiabá", 903358));
	dataset.addRow(new Array("TO", "Tocantins", "Palmas", 277621));
	dataset.addRow(new Array("PI", "Piauí", "Teresina", 251529));
	
	return dataset;
}

Para criar um novo Dataset, é utilizado o método DatasetBuilder.newDataset(). A partir do objeto criado é possível adicionar as colunas desejadas (método addColumn) bem como adicionar linhas (método addRow).

Note que a função JavaScript createDataset, que cria o Dataset, recebe como parâmetros os campos, as constraints e a ordem dos campos. Cabe ao desenvolvedor utilizar estes valores na lógica de implementação do Dataset Customizado. Caso seja desconsiderado algum destes campos, o engine que gerencia os Datasets não fará os filtros.

Dataset customizado de definição de formulário "pai-filho"

Para acessar informações de um "pai-filho" de uma definição de formulário pode ser utilizado o WebService "ECMDatasetService" (do próprio Fluig), um Dataset customizado (Exemplo 1), ou ainda um evento de processo ou definição de formulário (Exemplo 2). 

function createDataset(fields, constraints, sortFields) {
	
	//Cria as colunas
	var dataset = DatasetBuilder.newDataset();
	dataset.addColumn("NumFormulario");
	dataset.addColumn("Id");
	dataset.addColumn("Peca");
	dataset.addColumn("Quantidade");
	
	//Cria a constraint para buscar os formulários ativos
	var cst = DatasetFactory.createConstraint("card_is_active_boolean_is", true, true, ConstraintType.MUST);
	var constraints = new Array(cst);
	
	var datasetPrincipal = DatasetFactory.getDataset("dsExemploPaiFilho", null, constraints, null);
	
	for (var i = 0; i < datasetPrincipal.rowsCount; i++) {
		var documentId = datasetPrincipal.getValue(i, "DocumentId");
		var documentVersion = datasetPrincipal.getValue(i, "documentVersion_number_is");
		
		//Cria as constraints para buscar os campos filhos, passando o tablename, número da formulário e versão
		var c1 = DatasetFactory.createConstraint("tablename", "tabelaPecas" ,"tabelaPecas", ConstraintType.MUST);
		var c2 = DatasetFactory.createConstraint("metadata#id", documentId, documentId, ConstraintType.MUST);
		var c3 = DatasetFactory.createConstraint("metadata#version", documentVersion, documentVersion, ConstraintType.MUST);
		var constraintsFilhos = new Array(c1, c2, c3);

		//Busca o dataset
		var datasetFilhos = DatasetFactory.getDataset("dsExemploPaiFilho", null, constraintsFilhos, null);

		for (var j = 0; j < datasetFilhos.rowsCount; j++) {
			//Adiciona os valores nas colunas respectivamente.
			dataset.addRow(new Array(
					documentId,
					datasetFilhos.getValue(j, "wdk_sequence_id"), 
					datasetFilhos.getValue(j, "peca"),  
					datasetFilhos.getValue(j, "qtde")));
		}
	}
	
	return dataset;
}

 function()

Utilizando um dos modelos de Dataset acima, é possível recuperar os valores "filhos" dos formulários ativos, ou seja, a última versão criada. Existem alguns parâmetros obrigatórios que devem ser passados através de constraints, onde o valor inicial e final devem ser iguais. A forma de recuperar esses valores é opcional. Segue abaixo a nomenclatura obrigatória de cada parâmetro:

<table border="1" tablename="tabelaProduto" addbuttonlabel="Adicionar Produto">
	<!-- Campos Filhos -->
</table>

Também é possível exibir a ordem dos campos filhos, para isso deve-se utilizar o campo wdk_sequence_id, sendo que este não poderá ser utilizado como nome de algum campo do formulário.

Guia de Referência de Datasets

Dataset Factory

Dataset

Third Party Trademarks

JavaScript is a trademark of Oracle Corporation.

Para saber mais sobre as formas de acesso ao dataset, consulte a documentação Acessando Datasets.

Os Datasets de fontes externas também podem ser sincronizados, para reduzir o número de acessos a serviços de dados e tráfego de informações. Para saber como funciona a sincronização, consulte Sincronização de Datasets.

Importar e Exportar Datasets

...

A plataforma possibilita exportar um dataset do ambiente de teste/homologação para posteriormente importá-lo no servidor de produção. A partir da atualização 1.6.5, esse recurso está disponível pela tela de Datasets, no Painel de Controle. Nas atualizações anteriores, a importação e exportação de datasets ocorria apenas pelo fluig Studio.

Para saber mais

...

...