DataSet

O DataSet é um objeto que contém definições de consulta a dados, critérios de seleção, variáveis possíveis e formatação de retorno.

Um DataSet contém os seguintes atributos:

Atributo	Descrição
id (string)	Identificação única do dataSet.
sql (string)	Comando sql de consulta aos dados.
dsConn (string)	Opcionalmente pode-se indicar uma outra conexão de dados.
var (object)	Conjunto de variáveis, no formato key/value, sendo que os valores podem ser constantes do sistema (como usuário, login, etc), valores padrões e ou dinâmicos (substituídos em tempo de execução.
rowFormat (object)	Conjunto de templates, que são usados para formatar cada linha de resultado de dados, conforme combinação do campo tag_ (retornado na consulta) e template criado.
rowFormat[..].tag	Tag de identificação do template, link feito para cada linha do resultado do sql.
rowFormat[..].html	Código html do template.
rowFormat[..].html_sep	Separador de linhas de resultado do template.

ID

O id é gerado automaticamente com o valor de timestamp (YYYYMMDDHHMMSS) do momento da criação do mesmo.

Pode ser alterado, mas deve-se alterar todas as referências eventualmente já criadas. Existem referências em objetos filhos (como var e dataSetRow) e eventuais portlets, que usam a referência ao id para retornar dados no próprio código html.

dsConn

Nome da conexão a ser usada na consulta. A conexão deverá ser criada na lista de parametros de conexão.

SQL

Comando sql a ser executado no banco de dados.

Funções e procedures podem ser executadas, levando em consideração a sintaxe de cada banco de dados utilizado.

O retorno poderá ser formatado diretamente pelo código sql ou utilizando templates especificados no dataSetRow. Ao menos um rowFormat deverá existir para formatação dos dados. O link é realizado pelo campo tag_, que deve existir no comando sql.

Exemplo:

sql

select 'tag' as tag_, border_seq, dsku, mvol_available 
from forder_item

Dados

tag_	border_seq	dsku	mvol_available
tag	1	7801	10
tag	1	7802	15
tag	2	7801	20
tag	2	7803	25

rowFormat

Atributo	Valor
tag (string)	tag
html (string)	{'#border_seq#','#dsku#', #mvol_available# }
html_sep (string)	,

Retorno do dataSet

{'1','7801',10},{'1','7802',15},{'2','7801',20},{'2','7803',25}