Versões comparadas

Chave

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

...

Classe disponibilizada para a construção do Objeto de Negócio para integração com o TReportsSmart View, sendo possível utilizá-la como um facilitador para geração de relatórios.

...

Informações
titleAnnotation no Objeto de Negócio

Para mais informações sobre o Annotation do objeto de negócio, acessar a documentação completa: TReports Smart View - Annotation no objeto de negócio

...

Informações

Objeto oData

Serão feitos tratamentos internos neste objeto.

Ele possui apenas dois métodos para uso externo, usado em conjunto com os métodos da nova classe, sendo eles:

Método AliasToData() - Método do objeto oData que converte o alias recebido em dados para o TReportsSmart View.

NomeTipoObrigatórioDefaultDescrição
cAliasCaracterX
Workarea que será trabalhada
oFilterObjetoX
Objeto de filtro do TReportsSmart View

Método AppendData() - Método do objeto oData que adiciona um json para o array de dados.

Parâmetros:

NomeTipoObrigatórioDefaultDescrição
jDataJsonX
Json contendo os dados (chave:valor)
Informações

Lembrando que a chave enviada no appendData é o mesmo valor que foi definido como id daquele campo no schema.

Exemplos de uso estarão abaixo nos métodos criados para a classe IntegratedProvider.

Aviso
titleCampos do Tipo Data

Os campos do tipo data deverão ser formatados no formato UTC aaaa-mm-ddThh:mm:ssZ. É possível realizar essa conversão utilizando a função FwTimeStamp(6, dData).

Exemplo: FwTimeStamp(6, StoD((cAlias)→B1_UREV))

Documentação: https://tdn.totvs.com.br/display/framework/FWTimeStamp

...

Informações

Objeto oFilter

Serão feitos tratamentos internos neste objeto.

Ele possui métodos para uso externo, usados em conjunto com o método getData do objeto de negócios

Método hasFilter() - Método do objeto oFilter que indica a existência de filtros (O TReports Smart View permite filtrar os dados)

Retorno: Logical Indica a presença de filtros

Sintaxe: oFilter:hasFilter() → logical

Método hasFields() - Método do objeto oFilter que indica se existem campos de retorno (O TReports Smart View permite retornar uma quantidade de campos menor que o objeto de negócios possui, filtrando assim os campos, não os dados)

Retorno: Logical Indica a presença de campos de retorno

Sintaxe: oFilter:hasFields() → logical

Método getAdvplExpression() - Método do objeto oFilter que retorna os filtros no formato ADVPL

Retorno: character Filtro de dados no formato ADVPL

Sintaxe: oFilter:getAdvplExpression() → character

Método getSQLExpression() - Método do objeto oFilter que retorna os filtros no formato SQL

Retorno: character Filtro de dados no formato SQL

Sintaxe: oFilter:getSQLExpression() → character

Método getFields() - Método do objeto oFilter que retorna um array contendo os campos que foram solicitados (Mesma lógica do hasFields)

Retorno: array Campos que devem ser retornados

Sintaxe: oFilter:getFields() → array

Método getRawFilter() - Método do objeto oFilter que retorna um JSON com o filtro solicitado pelo TReports Smart View em seu formato original, é com base nele que as expressões SQL e ADVPL são geradas (Mesma lógica do hasFilter)

Retorno: json JSON com o filtro solicitado pelo TReportsSmart View

Sintaxe: oFilter:getRawFilter() → json

Método getParameters() - Método do objeto oFilter que retorna os parâmetros nativos do Objeto de Negócio.

Retorno: json  Json com os parâmetros

Sintaxe: oFilter:getParameters() → json

Observação: Método só disponível na LIB 20230626 ou superior

...

Aviso
titleFiltros
Os filtros serão setados na interface do novo TReportsSmart View

Exemplos de criação da nova classe:

...

Com os métodos documentados a seguir será possível adicionar o LookUp dos campos na interface do TReportsSmart View. Esse lookup será utilizado quando o usuário criar um filtro/parâmetro através dos campos do objeto de negócio, seu uso é opcional.

...

Label - Label de exibição do Lookup. (Nome amigável que será apresentado na interface do TReportsSmart View)

Método self:setIsCBoxLookup()

...

Desc - Descrição do LookUp (Nome amigável que será apresentado na interface do TReportsSmart View)

Método self:setIsLookup()

...