Aviso
Ler documentação sobre o serviço que utilizará essa classe: TReports Smart View - Protheus como Fonte de Dados Nativa

Aviso
Recomendado utilizar a integração em ambiente com dicionário no banco de dados

Aviso
Classe deverá ser utilizada com a linguagem TL++

Índice

maxLevel	1
exclude	Índice

Objetivo e Vantagens do Objeto de Negócio em TLPP

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

...

Utilização de funções advpl para recuperar os dados dos campos
Contextualização de Grupo de Empresa/Filial a partir das funções RetSqlName e xFilial
Utilização de querys elaboradas para recuperar dados em várias tabelas
Paginação das requisições para busca de dados, melhorando a performance e sendo possível carregar uma massa de dados maior
Facilitador para preenchimento de filtros na criação do relatório a partir do lookup nos campos
Tratamento para Dados Protegidos

Utilização da classe IntegratedProvider

A nova classe criada em TL++ possui Namespace e Annotation que deverá ser herdado no novo fonte.

...

Informações

title	Annotation no Objeto de Negócio

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

Métodos

New()

Método de instância da classe.

...

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 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 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 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 TReports

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

...

GetSchema()

Retorna a Estrutura de dados.

Exemplos de uso:

Bloco de código
method getSchema() as object class SEDTReportsBusinessObject self:aliasToSchema("SED") //Alias utilizado para retorno dos dados return self:oSchema

...

Sintaxe: GetSchema() → objeto self:oSchema

...

GetData()

Retorna o Objeto de dados.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
nPage	Numérico		Página atual	Número da página atual
oFilter	Objeto			Objeto do Filtro

Exemplos de uso:

Bloco de código

method getData(nPage as numeric, oFilter as object) as object class SEDTReportsBusinessObject
	// Objeto de filtro nulo pois o recurso não se encontra ativo
	self:aliasToData("SED", oFilter)
return self:oData

...

Sintaxe: GetData() → objeto self:oData

...

SetDisplayName()

Define o nome do relatório.

Exemplo de uso:

Bloco de código
SetDisplayName("Naturezas")

Sintaxe: SetDisplayName(<cTexto>) → nil

...

GetDisplayName()

Retorna o nome do relatório.

Sintaxe: GetDisplayName() → self:cTexto

...

AppendArea()

Adiciona uma área a qual o relatório pertence.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cArea	Caracter	X		Nome da área do relatório

Exemplo de uso:

Bloco de código
AppendArea("Financeiro")

Sintaxe: AppendArea(<cArea>) → nil

...

GetAreas()

Retorna a área que os relatórios pertencem.

Sintaxe: GetAreas() → self:aArray

...

SetDescription()

Define a descrição do relatório.

Sintaxe: SetDescription(<cTexto>) → nil

...

GetDescription()

Retorna a descrição do relatório.

...

Informações
Método disponível a partir da LIB Label 20231505

...

SetPergunte()

Indica o Pergunte (SX1) do relatório.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cPergunte	Caractere	X		Código do pergunte no SX1

Exemplo de uso:

Bloco de código
method new() as object class SRA2TReportsBusinessObject _Super:new() self:setDisplayName("Funcionários") self:setPergunte("GPER140") //Indica o pergunte que será utilizado no relatório return self

...

Informações

title	Pergunte

Todos os MV_PAR virão maiúsculos no retorno. Ex: MV_PAR01, MV_PAR02

...

SetCanFilter()

Indica se o campo pode ser filtrado.

Informações
Método disponível a partir da LIB Label 20230626

Parâmetros:

Nome

Tipo

Obrigatório

Default

Descrição

cId

Caractere

X

Id da propriedade

Obs.: Se foi utilizado o método aliasToSchema o Id da propriedade é o nome do campo na tabela, ex. A1_NOME

lCanFilter

Lógico

X

Indica se o campo pode ser filtrado

Exemplo de uso:

Bloco de código

method getSchema() as object class BA3TReportsBusinessObject
	self:aliasToSchema("BA3" , {"BA3_DATBLO", "BA3_CODINT", "BA3_MATRIC"})
 	self:setCanFilter("BA3_MATRIC", .F.) //Setando o campo enviado pelo aliasToSchema como não filtrável
return self

Sintaxe: setCanFilter(<cId>, <lCanFilter>) → nil

...

SetPropDisplayName()

Seta o displayName da propriedade.

Informações
Método disponível a partir da LIB Label 20230626

Parâmetros:

Nome

Tipo

Obrigatório

Default

Descrição

cId

Caractere

X

Id da propriedade

Obs.: Se foi utilizado o método aliasToSchema o Id da propriedade é o nome do campo na tabela, ex. A1_NOME

cDisplayName

Caractere

X

Nome de exibição

Exemplo de uso:

Bloco de código

method getSchema() as object class BA3TReportsBusinessObject  
	self:aliasToSchema("BA3" , {"BA3_DATBLO", "BA3_CODINT", "BA3_MATRIC", "BA3_VERCON"})
	self:setPropDisplayName("BA3_VERCON", "Versão (BA3)") //Mudando o displayName da propriedade de BA3_VERCON para Versão (BA3)
return self

Sintaxe: setPropDisplayName(<cId>, <cDisplayName>) → nil

...

Implementação do LookUp nos Filtros de campos

Informações
Disponível a partir da LIB Label 20220321

Com os métodos documentados a seguir será possível adicionar o LookUp dos campos na interface do TReports. 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.

Padrão Key-Label

Key - Chave do LookUp (Valor que será procurado na tabela do schema)

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

Método self:setIsCBoxLookup()

Indica no objeto Schema que o LookUp será do tipo Key-Value (combobox).

Informações
Método deverá ser utilizado no new() da nova classe criada, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
lKeyLabel	Lógico	X	.F.	Indica que o filtro lookup será do tipo key-label
lX3	Lógico		.F.	Indica que utilizará o SX3 para recuperar os valores do key-label dos campos

Exemplo de uso:

Bloco de código
self:setIsCBoxLookup(.T., .T.)

...

Aviso

title	Atenção

Ao utilizar o parâmetro lX3 como .T. todos os campos da classe passará pela aplicação do lookup de acordo com a SX3, caso o número de campos seja grande a performance poderá ser afetada.

...

Método self:oSchema:setComboValues()

Indica os valores dos combos dos schemas da nova classe.

Informações
Método deverá ser utilizado no getSchema() após a criação dos campos da nova classe, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cField	Caracter	X		Campo que receberá o LookUp Key-Label
cComboValues	Caracter	X		Valores do key-label (Formato igual ao combobox da SX3, ex.: "D MG 01=Filial BH" separado por ; caso tenha mais de uma opção)
lIsRequired	Lógico		.F.	Indica que é obrigatório o preenchimento do campo.

Utilização com o método addProperty() documentado acima

Exemplo de uso:

Bloco de código
self:oSchema:addProperty("Filial", "Filial", "string", "Filial", "B1_FILIAL", "D MG 01=Filial BH; D MG 02=Filial Uberaba", .F.)

Exemplos completos com LookUp Key-Label:

Bloco de código

title	Exemplo 1 - LookUp Key-Label
collapse	true

#include "msobject.ch"
#include "protheus.ch"
#include "totvs.framework.treports.integratedprovider.th"
 
namespace custom.materiais

@totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGACOM", tables="SB1", name="Materiais", country="ALL", initialRelease="12.1.2210")  
class SB1TReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider
    public method new() as object
    public method getDisplayName() as character
    public method getDescription() as character
    public method getData() as object
    public method getSchema() as object
endclass
 
method new() class SB1TReportsBusinessObject
_Super:new()
self:appendArea("Materiais")
self:setIsCBoxLookup(.T., .T.)
return self
 
method getDisplayName() as character class SB1TReportsBusinessObject
return "Produtos"
 
method getDescription() as character class SB1TReportsBusinessObject
return "Produtos do Protheus"
 
method getData(nPage as numeric, oFilter as object) as object class SB1TReportsBusinessObject
local cQuery as character
local cAlias as character
 
cQuery := "SELECT B1_FILIAL, B1_COD, B1_DESC, B1_TIPO, B1_UM, B1_UREV, B1_FILIAL, B1_PRV1 FROM " + RetSQLName("SB1") + " WHERE D_E_L_E_T_ = ' '"
 
//Os filtros serão setados na interface do novo TReports
if oFilter:hasFilter()
    cQuery += " AND " + oFilter:getSQLExpression()
endif
 
cAlias := MPSysOpenQuery(cQuery)
 
while !(cAlias)->(Eof())
    cDate := FwTimeStamp(6, StoD((cAlias)->B1_UREV))
    self:appendData({"Filial": (cAlias)->B1_FILIAL,; 
            "Codigo": (cAlias)->B1_COD,; 
            "Descricao": (cAlias)->B1_DESC,;
            "Tipo": (cAlias)->B1_TIPO, ;
            "Unidade": (cAlias)->B1_UM, ;
            "Revisao": cDate ,;
            "Preco": (cAlias)->B1_PRV1})
    (cAlias)->(DBSkip())
enddo
 
(cAlias)->(DBCloseArea()) 
 
return self:oData
 
method getSchema() as object class SB1TReportsBusinessObject
local cComboFil as character

cComboFil := "D MG 01=Filial BH; D MG 02=Filial Uberaba"

self:addProperty("Filial", "Filial", "string", "Filial", "B1_FILIAL", cComboFil,.F.)
self:addProperty("Codigo", "Codigo", "string", "Codigo", "B1_COD")
self:addProperty("Descricao", "Descricao", "string", "Descricao","B1_DESC")
self:addProperty("Tipo", "Tipo", "string", "Tipo","B1_TIPO")
self:addProperty("Unidade", "Unidade de medida", "string", "Unidade","B1_UM") 
self:addProperty("Revisao", "Revisao", "date", "revisao","B1_UREV") 
self:addProperty("Data", "Data", "date", "Data","B1_UREV")
self:addProperty("Preco", "Preço", "number", "Preço","B1_PRV1")
return self:oSchema

...

Exemplo do Key-Label na interface:

Padrão LookUp

ID - Chave do LookUp (Valor que será procurado na tabela do schema)

...

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

Método self:setIsLookup()

Indica no objeto Schema que o LookUp será do tipo padrão LookUp.

Informações
Método deverá ser utilizado no new() da nova classe criada, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
lIsLookUp	Lógico	X	.F.	Indica que o filtro será do tipo padrão lookup

Exemplo de uso:

Bloco de código
self:setIsLookup(.T.)

Sintaxe: self:SetIsLookUp(<lIsLookUp>) → nil

...

Método self:oSchema:setDescriptor()

Indica a descrição para o LookUp (padrão lookup).
(depreciado - a partir da lib 20230515 utilizar o array aDescriptor nos métodos SetLookupQuery e SetLookupVal)

Informações
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Default	Descrição
cId	Caracter	ID	Indica o cabeçalho de exibição da chave do lookup
cProd	Caracter	Código	Indica o cabeçalho de exibição do código do lookup (Mesmo conteúdo do ID)
cDesc	Caracter	Descrição	Indica o cabeçalho de exibição da descrição do lookup

Exemplo de uso:

Bloco de código
self:setDescriptor("Código","Código do Produto", "Descrição do Produto")

Sintaxe: self:oSchema:setDescriptor(<cId>, <cProd>, <cDesc>) → nil

...

Método self:oSchema:setLookUpVal()

Indica os valores para o LookUp (padrão lookup)

Informações
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cField	Caracter	X		Indica o campo que será setado a consulta
aStruct	Array	X		Indica a estrutura que será utilizada no Lookup Exemplo da estrutura: aStruct[1][1]:"ATF0510001" aStruct[1][2]:"ATFA036 EMISSAO DE NOTA EM LOT" aStruct[2][1]:"0003" aStruct[2][2]:"PRODUTO PADRAO"
lIsRequired	Lógico		.F.	Indica que é obrigatório o preenchimento do campo
aDescriptor	array		Titulo do campo de acordo com SX3	array com as descrições de cada campo, na ordem do dados passados (a partir da lib 20230515)
nFieldReturn	numérico		1	numero da coluna que deverá retornar na consulta (a partir da lib 20230515)

Exemplo de uso:

Bloco de código
self:setLookUpVal(cField, aStruct, lIsRequired)

Sintaxe: self:setLookUpVal(<cField>, <aStruct>, <lIsRequired>) → nil

...

Método self:oSchema:setX5Struct()

Indica os valores para o LookUp (padrão lookup) a partir da SX5.

Informações
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cField	Caracter	X		Indica o campo que será setado a consulta
cTable	Caracter	X		Indica a tabela da SX5 que será utilizada para buscar a estrutura do lookup
lIsRequired	Lógico		.F.	Indica que é obrigatório o preenchimento do campo

Exemplo de uso:

Bloco de código
self:setX5Struct(cField, cTable, lIsRequired)

Sintaxe: self:setX5Struct(<cField>, <cTable>, <lIsRequired>) → nil

...

Método self:oSchema:setLookUpQuery()

Indica os valores para o LookUp (padrão lookup) a partir de uma query.

Informações
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cField	Caracter	X		Campo que será setado a consulta
aFields	Array	X		Indica os campos da estrutura da consulta (chave-descrição). Exemplo: aFields[1]:"ED_CODIGO" aFields[2]:"ED_DESCRIC" ou (a partir da lib 20230515) aFields[1] := {"CAMPO","TIPO", SIZE, DECIMAL} Caso seja passado um vetor simples apenas com o nome dos campos os dados adicionais serão procurados na SX3
cQuery	Caracter	X		Indica a tabela da SX5 que será utilizada para buscar a estrutura do lookup
lIsRequired	Lógico		.F.	Indica que é obrigatório o preenchimento do campo
aDescriptor	array		Titulo do campo de acordo com SX3	array com as descrições de cada campo, na ordem do dados passados (a partir da lib 20230515)
cFieldReturn	Caracter		Primeiro campo do aFields	coluna que deverá retornar na consulta (a partir da lib 20230515)
cOrder	Caracter		Primeiro campo do aFields	clausula a ser utilizada no order by do select (a partir da lib 20230515)

Exemplo de uso:

Bloco de código
self:setLookUpQuery(cField, aFields, cQuery, lIsRequired)

Sintaxe: self:setLookUpQuery(<cField>, <aFields>, <cQuery>, <lIsRequired>) → nil

Exemplos completos com padrão LookUp:

Bloco de código

title	Exemplo 1 - padrão LookUp - Valores setados manualmente
collapse	true

#include "msobject.ch"
#include "protheus.ch"
#include "totvs.framework.treports.integratedprovider.th"
 
namespace custom.materiais.produtos.integratedprovider.lookup
 
@totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGACOM", tables="SB1", name="Produtos do Protheus", country="ALL", initialRelease="12.1.2210")
class SB1TReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider
    public method new() as object
    public method getDisplayName() as character
    public method getDescription() as character
    public method getData() as object
    public method getSchema() as object
endclass
 
method new() class SB1TReportsBusinessObject
_Super:new()
self:appendArea("Compras")
self:setIsLookUp(.T.)
return self
 
method getDisplayName() as character class SB1TReportsBusinessObject
return "Produtos"
 
method getDescription() as character class SB1TReportsBusinessObject
return "Produtos do Protheus"
 
method getData(nPage as numeric, oFilter as object) as object class SB1TReportsBusinessObject
local cQuery as character
local cAlias as character
 
cQuery := "SELECT B1_FILIAL, B1_COD, B1_DESC, B1_TIPO, B1_UM, B1_UREV FROM " + RetSQLName("SB1") + " WHERE D_E_L_E_T_ = ' '"
 
//Os filtros serão setados na interface do novo TReports
if oFilter:hasFilter()
    cQuery += " AND " + oFilter:getSQLExpression()
endif
 
cAlias := MPSysOpenQuery(cQuery)

while !(cAlias)->(Eof())
    cDate := FwTimeStamp(6, StoD((cAlias)->B1_UREV))
    self:appendData({"Filial": (cAlias)->B1_FILIAL,; 
            "Codigo": (cAlias)->B1_COD,; 
            "Descricao": (cAlias)->B1_DESC,;
            "Tipo": (cAlias)->B1_TIPO, ;
            "Unidade": (cAlias)->B1_UM, ;
            "Revisao": cDate})
    (cAlias)->(DBSkip())
enddo
 
(cAlias)->(DBCloseArea()) 
 
return self:oData
 
method getSchema() as object class SB1TReportsBusinessObject
local cField as character
local aStruct as array
local lIsRequired as logical
Local aDescriptor as array
Local nFieldReturn as numeric

//Seta a descrição da consulta
self:setDescriptor("Código","Código do Produto", "Descrição")

cComboFil := "D MG 01=Filial BH; D MG 02=Filial Uberaba; D RJ 01 =Filial RJ"

self:aliasToSchema("SB1", {"B1_FILIAL", "B1_COD"})
self:addProperty("Descricao", "Descricao", "string", "Descricao","B1_DESC")
self:addProperty("Tipo", "Tipo", "string", "Tipo","B1_TIPO")
self:addProperty("Unidade", "Unidade de medida", "string", "Unidade","B1_UM") 
self:addProperty("Revisao", "Revisao", "date", "revisao","B1_UREV") 
self:addProperty("Camp Log", "Camp Log", "boolean", "Camp Lógico","B1_LOGI")

cField := "B1_COD"
aStruct := {}
aAdd(aStruct, {"ATF0510001", "ATFA036 EMISSAO DE NOTA EM LOT"})
aAdd(aStruct, {"0003","PRODUTO PADRAO"})
aAdd(aStruct, {"EST00000000000000000000001GGGR","'PRODTO ESTOQUE GRADE EAI INTE"})
lIsRequired := .F.
aDescriptor := {"Codigo","Descrição"}
nFieldReturn := 1
//Seta os valores para o Lookup
self:setLookUpVal(cField, aStruct, lIsRequired, aDescriptor, nFieldReturn)

return self:oSchema

...

Exemplo do padrão LookUp na interface:

Log para os Filtros do

...

Smart View

Foi criada a chave fw-treports-debug para mandar mensagens para o console e ajudar a identificar erros relacionados aos filtros enviados ao TReportsSmart View.

O log de debug somente é ativado pela chave no environment: fw-treports-debug=1

Paginação no Objeto de Negócio

Aviso
Funcionalidade disponível a partir da LIB Label 20220613

...

Com isso o desenvolvedor consegue indicar quantos itens serão enviados ao TReports Smart View por requisição.

Informações

title	Atenção

A paginação mexe diretamente com a performance de como os dados serão buscados via API, se a fonte de dados carrega 100 itens por requisição e uma tabela possui 6.000 registros, ele irá fazer a requisição 60 vezes. Se eu seto o pageSize como 1000, ele irá fazer a requisição 6 vezes porém com um intervalo maior entre as requisições, isso deverá ser visto de acordo com a necessidade de cada área/produto em relação ao objeto de negócio que será construído com essa fonte de dados nativa.

Método self:setPageSize()

Seta a quantidade de itens por página.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
nPageSize	Númerico	X	100	Indica a quantidade de itens por requisição

Exemplo de uso:

Bloco de código
self:setPagesize(nPageSize)

Sintaxe: self:setPagesize(<nPageSize>) → nil

...

Método self:getPageSize()

Retorna a quantidade de itens por requisição.

Exemplo de uso:

Bloco de código
self:getPagesize()

Sintaxe: self:getPagesize() → self:nPageSize

...

Método self:setQuery()

Seta a query do objeto de negócio.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cQuery	Caracter	X		Indica a query do objeto de negócio

Observações:

Se não forem enviados todos os campos (Exemplo: SELECT * FROM) deverá ser usado o ID #QueryFields# e os campos setados serão aqueles recuperados do método getSchema().
É possível escrever a query e setar o where dela posteriormente com o método self:setWhere(), para isso deverá ser utilizado o ID #QueryWhere# após o Where da query.

Exemplo de uso:

Bloco de código
cQuery := "SELECT * FROM " + RetSQLName("SB1") + " WHERE B1_FILIAL = '"+ FWxFilial('SB1') +"' AND D_E_L_E_T_ = ' ' self:setQuery(cQuery)

...

Sintaxe: self:setQuery(<cQuery>) → nil

...

Método self:setWhere()

Seta o where da query.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cWhere	Caracter	X		Indica o where da query

Exemplo de uso:

Bloco de código
self:setWhere("B1_FILIAL = '"+ FWxFilial('SB1') +"' AND D_E_L_E_T_ = ' '")

Sintaxe: self:setWhere(<cWhere>) → nil

...

Método self:setOrder()

Seta o campo de ordenação da query.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cOrder	Caracter	X	Primeiro campo indicado no método getSchema()	Indica o campo de ordenação

Exemplo de uso:

Bloco de código
self:setOrder("B1_FILIAL = '"+ FWxFilial('SB1') +"' AND D_E_L_E_T_ = ' '")

Sintaxe: self:setOrder(<cOrder>) → nil

...

Método self:setHasNext()

Seta se terá próxima página.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
lHasNext	Lógico	X	.F.	Indica se terá próxima página

Exemplo de uso:

Bloco de código
self:setHasNext(.T.)

Sintaxe: self:setHasNext(<lHasNext>) → nil

Exemplos completos de Objetos de Negócios em TLPP

Bloco de código

title	Exemplo completo - Query - Paginação automática
collapse	true

#include "msobject.ch"
#include "totvs.framework.treports.integratedprovider.th"
 
namespace custom.materiais.produtos.integratedprovider

@totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGACOM", tables="SB1", name="Materiais", country="ALL", initialRelease="12.1.2210")
class SB1TReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider
    public method new() as object
    public method getData() as object
    public method getSchema() as object
endclass
 
method new() class SB1TReportsBusinessObject
_Super:new()
//Define a Área
self:appendArea("Compras")

//Define o nome do Objeto de Negócio
self:setDisplayName("Produtos")

//Define a descrição do Objeto de Negócio
self:setDescription("Produtos do Protheus")

return self

method getData() as object class SB1TReportsBusinessObject
local cQuery as character

//Define a quantidade máxima por página (Default 100)
self:setPageSize(200)

//Define a query do Objeto de Negócio
cQuery := "SELECT #QueryFields# FROM " + RetSQLName("SB1") +  " WHERE #QueryWhere#"
self:setQuery(cQuery)

//Define o campo de ordenação da query
self:setOrder("B1_COD")

//Define o where da query
self:setWhere("B1_FILIAL = '"+ FWxFilial('SB1') +"' AND D_E_L_E_T_ = ' '") 

return self:oData
 
method getSchema() as object class SB1TReportsBusinessObject

self:addProperty("Filial", "Filial", "string", "Filial", "B1_FILIAL")
self:addProperty("Codigo", "Codigo", "string", "Código", "B1_COD")
self:addProperty("Descricao", "Descricao", "string", "Descricao","B1_DESC")
self:addProperty("Tipo", "Tipo", "string", "Tipo","B1_TIPO")
self:addProperty("Unidade", "Unidade de medida", "string", "Unidade","B1_UM")
self:addProperty("Revisao", "Revisao", "date", "Revisao","B1_UREV")

return self:oSchema

...

Bloco de código

title	Exemplo completo - Objeto de negócio com parâmetros nativos manuais
collapse	true

#include "msobject.ch"
#include "totvs.framework.treports.integratedprovider.th"
#include "tlpp-core.th"
#include "tlpp-rest.th"

namespace totvs.protheus.rh.treportsintegratedprovider
 
@totvsFrameworkTReportsIntegratedProvider(active=.T.)
class SRA2TReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider
    public method new() as object
    public method getAreas() as array
    public method getDescription() as character
    public method getData() as object
    public method getSchema() as object
endclass
 
method new() as object class SRA2TReportsBusinessObject
    _Super:new()
    self:setDisplayName("Funcionários")
return self
 
method getDescription() as character class SRA2TReportsBusinessObject
return "Funcionários"
 
method getAreas() as array class SRA2TReportsBusinessObject
return {"RH"}
 
method getData(nPage as numeric, oFilter as object) as object class SRA2TReportsBusinessObject
local cQuery as character   
local jParams as json
local cWhere as character

jParams := oFilter:getParameters() //metodo para retorno do json dos parâmetros

cWhere := " D_E_L_E_T_ = ' '"

//MV_PAR04 é multivalue
if Len(jParams['MV_PAR04']) > 0
    cWhere += " AND RA_MAT IN ('" + ArrTokStr(jParams['MV_PAR04'], "','") + "')"
endif

cQuery := "SELECT #QueryFields# FROM " + RetSQLName("SRA") +  " WHERE #QueryWhere#"

//Define a quantidade máxima por página (Default 100)
self:setPageSize(500)
//Define a query do Objeto de Negócio
self:setQuery(cQuery)
//Define o campo de ordenação da query
self:setOrder("RA_MAT")

//Define o where da query
self:setWhere(cWhere) 
return self:oData
 
method getSchema() as object class SRA2TReportsBusinessObject
    self:aliasToSchema("SRA" , {"RA_NOME", "RA_FILIAL", "RA_MAT", "RA_EMAIL", "RA_ADMISSA"})
	self:addParameter("logico","logico","boolean", .F.) //Adicionando o parâmetro manual 
return self:oSchema

Objeto de negócio localizado

Temos uma documentação completa sobre como montar o objeto de negócio localizado, acessar o link: TReports Smart View - Objeto de negócio Localizado

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 114

Nova versão 115

Chave

Índice

Objetivo e Vantagens do Objeto de Negócio em TLPP

Utilização da classe IntegratedProvider

Métodos

New()

GetSchema()

Exemplos de uso:

GetData()

Parâmetros:

Exemplos de uso:

SetDisplayName()

Exemplo de uso:

GetDisplayName()

AppendArea()

Parâmetros:

Exemplo de uso:

GetAreas()

SetDescription()

GetDescription()

SetPergunte()

Parâmetros:

Exemplo de uso:

SetCanFilter()

Parâmetros:

Exemplo de uso:

SetPropDisplayName()

Parâmetros:

Exemplo de uso:

Implementação do LookUp nos Filtros de campos

Padrão Key-Label

Método self:setIsCBoxLookup()

Parâmetros:

Exemplo de uso:

Método self:oSchema:setComboValues()

Parâmetros:

Utilização com o método addProperty() documentado acima

Exemplo de uso:

Exemplos completos com LookUp Key-Label:

Padrão LookUp

Método self:setIsLookup()

Parâmetros:

Exemplo de uso:

Método self:oSchema:setDescriptor()

Parâmetros:

Exemplo de uso:

Método self:oSchema:setLookUpVal()

Parâmetros:

Exemplo de uso:

Método self:oSchema:setX5Struct()

Parâmetros:

Exemplo de uso:

Método self:oSchema:setLookUpQuery()

Parâmetros:

Exemplo de uso:

Exemplos completos com padrão LookUp:

Log para os Filtros do

Smart View

Paginação no Objeto de Negócio

Método self:setPageSize()

Parâmetros:

Exemplo de uso:

Método self:getPageSize()

Exemplo de uso:

Método self:setQuery()

Parâmetros:

Observações:

Exemplo de uso:

Método self:setWhere()

Parâmetros:

Exemplo de uso:

Método self:setOrder()

Parâmetros:

Exemplo de uso:

Método self:setHasNext()