Este guia tem o objetivo de apresentar uma introdução para a codificação dos datasets avançados no TOTVS Fluig Plataforma.
# Pré-requisitos
---
Para que se tenha uma compreensão completa destas informações, alguns conhecimentos são considerados pré-requisitos, entre eles:
- Conhecimento sobre o[Desenvolvimento de Datasets](../Desenvolvimento de Datasets.md)
- Visão geral sobre codificação JavaScript
Atenção!
A partir das atualizações **1.6.5 Liquid**, **1.7.0 Lake** e **1.7.1 Crystal Lake**, os *select* passados por *constraint* em dataset serão bloqueados pelo serviço.Orientamos a leitura da documentação[Datasets acessando banco de dados externo](Datasets acessando banco de dados externo.md)que contém um exemplo da correta utilização do procedimento.
# Criação de dataset avançado
---
Um dataset avançado é capaz de acessar outros datasets, realizar chamadas a serviços externos ou pode conter valores fixos, codificados conforme a necessidade. Ele é construído a partir de um código-fonte em JavaScript, que pode ser editado na interface disponível no Painel de Controle ou pelo Fluig Studio.
Atenção
Para que um usuário que não é administrador da empresa possa construir datasets via Fluig Studio é necessário que ele possua a permissão "Configurar Datasets". Esta permissão pode ser concedida pelo administrador através do item [Permissões](https://tdn.totvs.com/pages/viewpage.action?pageId=234455792) disponível no Painel de Controle da plataforma.
A partir da **atualização 1.6.5**, os administradores do sistema conseguem editar o código fonte do Dataset pela plataforma, acessando a opção "Editar em modo avançado", na tela de Datasets no Painel de Controle.
A seguir serão apresentados alguns exemplos para codificação do dataset avançado.
Para criar um novo Dataset, é utilizado o método**DatasetBuilder.newDataset()**. Utilizando o objeto retornado por este método é 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 para consulta, recebe como parâmetros os campos, as constraints e a ordenação. Cabe ao desenvolvedor utilizar estes valores na lógica de implementação do Dataset avançado. Caso seja desconsiderado algum desdes campos, os filtros não serão aplicados. Os parâmetros "**fields**" e "**sortFields**" são**arrays**de String, que possuem, respectivamente, os nomes dos campos que serão retornados e os nomes dos campos utilizados para ordenação. Já o parâmetro "**constraints**" é um array de objetos do tipo**Constraint**, onde cada objeto deste array possui as seguintes propriedades:
| Propriedade | Descrição |
| --- | --- |
| fieldName | Nome do campo |
| initialValue | Valor inicial para filtro neste campo |
| finalValue | Valor final para filtro neste campo |
| contraintType | Tipo do filtro deste campo, podendo ter os valores abaixo: **MUST**: O valor informado **precisa** estar nos resultados **SHOULD**: O valor informado **pode** estar ou não nos resultados **MUST\_NOT**: O valor informado **não pode** estar nos resultados |
Atenção!
As constraints podem ser utilizadas apenas para Datasets internos. Datasets avançados não aceitam constraints, pelo fato de os dados serem externos, não sendo possível aplicar o filtro em sua origem. Para Datasetsavançadoso tratamento de filtros deve ser feito na codificação do Dataset, manipulando o objeto retornado e retirando as informações desnecessárias.
Para acessar estas propriedades e analisar os valores de cada item, pode-se utilizar um laço de repetição, conforme implementação abaixo:
varvalidation=DatasetFactory.getDataset(dataset,null,filter,null);//Realiza a chamada do dataset
if(validation.rowsCount==1){//Se tiver uma linha quer dizer que o usuário logado faz parte do grupo/papel informado
//Esse retorno é só para informar que passou da validação, mas aqui dentro ficaria o codigo que o usuário tem permissão de acesso.
newDataset.addColumn("SUCCESS");
newDataset.addRow(["ok"]);
}else{
//Esse retorno é só para informar que o usuário não faz parte do grupo/papel.
newDataset.addColumn("ERROR");
newDataset.addRow(["sem permissão"]);
}
}catch(e){
newDataset.addColumn("ERROR");
newDataset.addRow(["chamada incorreta"]);
returnnewDataset;
}
returnnewDataset;
}
```
Atenção!
Alguns datasets retornam dados sensíveis, por isso, é altamente recomendado que apenas os usuários responsáveis tenham acesso a esses dados.
## Utilizando zoom composto em Dataset avançado
---
Através do uso de Datasets avançados é possível realizar uma série de buscas compostas.
No exemplo abaixo, utilizando o método createDataset foi desenvolvida uma busca constituída por mais de um campo da tabela, que recebe o valor informado no campo zoom e em seguida retorna o dataset avançado com os registros encontrados em ambos ou em um único campo da busca. Caso não seja informado nenhum valor, serão retornados todos os registros encontrados no banco.
Em seguida é apresentado a implementação do zoom para tratar os retornos gerados pela busca composta.
**Exemplo 1**
```
<script>
$(function(ready){
var myTable = FLUIGC.datatable('#target', {
dataRequest: {
url: '/api/public/ecm/dataset/search',
options: {
contentType:'application/json',
dataType: 'json',
method: 'POST',
data: JSON.stringify({
'datasetId' : 'DatasetTeste'
}),
crossDomain: true,
cache: false
},
root: '',
limit:10,
},
renderContent: ['colleagueName'],
multiSelect: false,
search: {
enabled: true,
},
scroll: {
target: '#target',
enabled: true
}
});
});
</script>
```
**Exemplo 1**
```
<input
type="zoom"
id = "c7_total"
name="c7_total"
data-zoom="{
'displayKey':'colleagueName',
'datasetId':'DatasetTeste',
'limit': '0',
'fields':[{
'field':'colleagueName',
'label':'Nome',
'standard':'true'
}
]
}"
/>
<div id="target"></div>
```
## Dataset avançado 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", um Dataset avançado (Exemplo 1), ou ainda um evento de processo ou definição de formulário(Exemplo 2).
Utilizando um dos modelos acima, é possível recuperar os valores "filhos" dos formulários ativos, ou seja, da ú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:
| Parâmetro | Descrição |
| --- | --- |
| tablename | Atributo utilizado para nomear cada **tabela** filha do HTML. Exemplo: ``` <table border="1" tablename="tabelaPecas" addbuttonlabel="Adicionar Peça"> <!-- Campos Filhos --> </table> ``` |
| metadata#id | Número do formulário. |
| metadata#version | Número da versão do formulário |
| userSecurityId | Código do usuário que será validada a permissão no formulário Observação Esse parâmetro não será validado na Visualização de Datasets, visto que nessa opção é um exemplo de visualização dos dados. |
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
| Retorno | Método e Descrição |
| --- | --- |
| SearchConstraint | `createConstraint(java.lang.Stringfield, java.lang.StringinitialValue, java.lang.StringfinalValue, ConstraintTypetype)` Cria uma nova constraint para a seleção de registros do Dataset. |
| java.util.List<java.lang.String> | `getAvailableDatasets()` Retorna uma lista de todos os Datasets disponíveis no sistema. |
| DefaultDataset | `getDataset(java.lang.Stringname, java.lang.String[]fields, SearchConstraint[]constraints, java.lang.String[]order)` Carrega os dados de um Dataset. |
## Dataset
| Retorno | Método e Descrição |
| --- | --- |
| void | `addColumn(java.lang.StringcolName)` Adiciona uma coluna ao Dataset. |
| void | `addRow(java.lang.Object[]values)` Adiciona uma linha ao Dataset. |
| java.lang.String | `getColumnName(intcolNum)` Retorna o nome de uma coluna do Dataset. |
| java.lang.String[] | `getColumnsName()` Retorna um array com os nomes das colunas do Dataset. |
| int | `getColumnsCount()` Retorna a quantidade de colunas de um Dataset. |
| java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Object>> | `getMap()` Retorna os valores do Dataset na forma de uma lista contendo mapas, onde cada registro do Dataset corresponde a um mapa com o nome da coluna como chave. |
| int | `getRowsCount()` Retorna a quantidade de linhas disponíveis no Dataset. |
| DefaultDataset | `getSubDataset(java.lang.Stringfield, java.lang.Objectvalue)` Retorna um subconjunto dos dados do Dataset, na forma de um novo Dataset. |
| java.lang.Object | `getValue(introw, intcol)` Retorna o valor armazenado no Dataset, na linha e coluna passadas por parâmetro. |
| java.lang.Object | `getValue(introw, java.lang.StringcolName)` Retorna o valor armazenado no Dataset, na linha passada e campo passados por parâmetro. |
| java.lang.Object[][] | `getValues()` Retorna todos os valores de um Dataset, na forma de um array bidimensional. |
| java.sql.ResultSet | `toResultSet()` Retorna um ResultSet contendo os dados do Dataset. |
Dica!
Se tiver dúvidas sobre o desenvolvimento de datasets avançados, não deixe de consultar o nosso **[fórum para DEVs](https://forum.totvs.io/).**
