Histórico da Página
...
Aviso |
---|
Classe deverá ser utilizada com a linguagem TL++ |
Índice
Índice | ||||
---|---|---|---|---|
|
Objetivo e Vantagens da Utilização da Fonte de Dados Nativa
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 que e Annotation que deverá ser herdado no novo fonte.
...
Bloco de código |
---|
#include "msobject.ch" // Referência o .th da classe #include "totvs.framework.treports.integratedprovider.th" // Cria um novo namespace para sua classe namespace custom.financeiro.naturezas.integratedprovider // Caso queira desativar a utilização da classe mudar para active=.F. @totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGAFIN", tables="SED", name="Naturezas", country="ALL", release="12.1.2210") // Cria uma nova classe e herda a classe principal (IntegratedProvider) com o namespace class SEDTReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider public method new() as object endclass |
Informações | ||
---|---|---|
| ||
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 oSchema Serão feitos tratamentos internos neste objeto. Ele possui apenas dois métodos para uso externo, usados em conjunto com os métodos da nova classe, sendo eles: Método AliasToSchema() - Método do objeto oSchema que transforma o alias em um schema, caso seja utilizado apenas o primeiro parâmetro todos os campos serão enviados. Parâmetros:
Método AddProperty() - Método do objeto oSchema que adiciona uma propriedade ao schema. Parâmetros:
Exemplos de uso estarão abaixo nos métodos criados para a classe IntegratedProvider. Obs: O nome real é necessário para que o filtro seja feito com base no nome real do campo, caso contrário, o mesmo levará em consideração a propriedade name. |
GetSchema()
Retorna a Estrutura de dados.
Exemplos de uso:
Bloco de código |
---|
method getSchema() as object class SEDTReportsBusinessObject
self:oSchema:aliasToSchema("SED") //Alias utilizado para retorno dos dados
return self:oSchema |
Bloco de código |
---|
method getSchema() as object class SEDTReportsBusinessObject
self:oSchema:aliasToSchema("SED", "E1_FILIAL") //Alias e campo utilizado para retorno dos dados
return self:oSchema |
Bloco de código |
---|
method getSchema() as object class SEDTReportsBusinessObject
local aFields as array
aFields := {"E1_PREFIXO","E1_NUM"}
self:oSchema:aliasToSchema("SED", aFields) //Alias e campos utilizados para retorno dos dados
return self:oSchema |
Bloco de código |
---|
method getSchema() as object class SEDTReportsBusinessObject self:oSchema:addProperty("Descricao", "Descrição da Natureza", "string", "Descrição", "ED_DESCRIC") self:oSchema:addProperty("Código", "Código da Natureza", "string", "Natureza", "ED_CODIGO") return self:oSchema |
Informações | ||
---|---|---|
A partir da LIB Label 20230403 poderá ser informado campos memos no método addProperty(). Exemplo:
|
...
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:oData:aliasToData("SED", oFilter)
return self:oData |
Bloco de código |
---|
method getData(nPage as numeric, oFilter as object) as object class SEDTReportsBusinessObject
local cQuery as character
local cAlias as character
cQuery := "SELECT ED_DESCRIC FROM " + RetSqlName('SED') + " WHERE D_E_L_E_T_ = ' '"
if oFilter:hasFilter()
cQuery += " AND " + oFilter:getSQLExpression()
endif
cAlias := MPSysOpenQuery(cQuery)
while !(cAlias)->(Eof())
self:oData:appendData({"Descrição": (cAlias)->ED_DESCRIC})
(cAlias)->(DBSkip())
enddo
(cAlias)->(DBCloseArea())
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.
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.financeiro.naturezas.integratedprovider @totvsFrameworkTReportsIntegratedProvider(active=.T.) class SEDTReportsBusinessObject from totvs.framework.treports., team="SIGAFIN", tables="SED", name="Naturezas", country="ALL", release="12.1.2210") class SEDTReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider public method new() as object public method getDisplayName() as character public method getAreas() as array public method getData() as object public method getSchema() as object endclass method new() as object class SEDTReportsBusinessObject _Super:new() self:setDescription("Naturezas financeiras do Protheus") return self method getDisplayName() as character class SEDTReportsBusinessObject return "Naturezas" method getAreas() as array class SEDTReportsBusinessObject return {"Financeiro"} // Os filtros serão setados na interface do novo TReports method getData(nPage as numeric, oFilter as object) as object class SEDTReportsBusinessObject self:oData:aliasToData("SED", oFilter) return self:oData method getSchema() as object class SEDTReportsBusinessObject self:oSchema:aliasToSchema("SED") return self:oSchema |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.financeiro.fornecedores.integratedprovider @totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGACOM", tables="SA2", name="SA2TReportsBusinessObject", country="ALL", release="12.1.2210") class SA2TReportsBusinessObject 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 SA2TReportsBusinessObject _Super:new() self:setDisplayName("Fornecedores") return self method getDescription() as character class SA2TReportsBusinessObject return "Fornecedores do Protheus" method getAreas() as array class SA2TReportsBusinessObject return {"Financeiro", "Contas a pagar"} method getData(nPage as numeric, oFilter as object) as object class SA2TReportsBusinessObject local cQuery as character local cAlias as character cQuery := "SELECT A2_NOME, A2_COD FROM " + RetSqlName('SA2') + " 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()) self:oData:appendData({"Nome": (cAlias)->A2_NOME, "Codigo": (cAlias)->A2_COD}) (cAlias)->(DBSkip()) enddo (cAlias)->(DBCloseArea()) return self:oData method getSchema() as object class SA2TReportsBusinessObject self:oSchema:addProperty("Nome", "Nome do Fornecedor", "string", "Fornecedor", "A2_NOME") self:oSchema:addProperty("Codigo", "Codigo do Fornecedor", "string", "Cod do Fornecedor", "A2_COD") return self:oSchema |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#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", release="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") 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()) self:oData:appendData({"Filial": (cAlias)->B1_FILIAL,; "Codigo": (cAlias)->B1_COD,; "Descricao": (cAlias)->B1_DESC,; "Tipo": (cAlias)->B1_TIPO, ; "Unidade": (cAlias)->B1_UM, ; "Revisao": FwTimeStamp(6, StoD((cAlias)->B1_UREV)) }) //O campo data deverá ser enviado no formato correto (cAlias)->(DBSkip()) enddo (cAlias)->(DBCloseArea()) return self:oData method getSchema() as object class SB1TReportsBusinessObject self:oSchema:aliasToSchema("SB1", "B1_COD") self:oSchema:addProperty("Descricao", "Descricao", "string", "Descricao","B1_DESC") self:oSchema:addProperty("Tipo", "Tipo", "string", "Tipo","B1_TIPO") self:oSchema:addProperty("Unidade", "Unidade de medida", "string", "Unidade","B1_UM") self:oSchema:addProperty("Revisao", "Revisao", "date", "Revisao","B1_UREV") return self:oSchema |
Implementação do LookUp dos 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, 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 | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
| ||||
#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", release="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:oData: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:oSchema:addProperty("Filial", "Filial", "string", "Filial", "B1_FILIAL", cComboFil,.F.) self:oSchema:addProperty("Codigo", "Codigo", "string", "Codigo", "B1_COD") self:oSchema:addProperty("Descricao", "Descricao", "string", "Descricao","B1_DESC") self:oSchema:addProperty("Tipo", "Tipo", "string", "Tipo","B1_TIPO") self:oSchema:addProperty("Unidade", "Unidade de medida", "string", "Unidade","B1_UM") self:oSchema:addProperty("Revisao", "Revisao", "date", "revisao","B1_UREV") self:oSchema:addProperty("Data", "Data", "date", "Data","B1_UREV") self:oSchema:addProperty("Preco", "Preço", "number", "Preço","B1_PRV1") return self:oSchema |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "protheus.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.financeiro.naturezas.integratedprovider // Parece que ao fazer o uso da namespace dessa forma, está gerando alguams exceções aleatório quanto as propriedades das classes // using namespace totvs.framework.treports.integratedprovider @totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGAFIN", tables="SED", name="Naturezas Financeiras", country="ALL", release="12.1.2210") class SEDTReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider public method new() as object public method getDisplayName() as character public method getAreas() as array public method getData() as object public method getSchema() as object endclass method new() as object class SEDTReportsBusinessObject _Super:new() self:setDescription("Naturezas financeiras do Protheus") self:setIsCBoxLookup(.T., .F.) return self method getDisplayName() as character class SEDTReportsBusinessObject return "Naturezas" method getAreas() as array class SEDTReportsBusinessObject return {"Financeiro"} method getData(nPage as numeric, oFilter as object) as object class SEDTReportsBusinessObject self:oData:aliasToData("SED", oFilter) return self:oData method getSchema() as object class SEDTReportsBusinessObject self:oSchema:aliasToSchema("SED") self:oSchema:setComboValues("ED_FILIAL", "D MG 01=Filial BH; D MG 02=Filial Uberaba", .F.) self:oSchema:setComboValues("ED_CALCIRF", "Sim=Sim; Não=Não") 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 | Obrigatório | 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:oSchema: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[2][1]:"0003" | |
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:oSchema:setLookUpVal(cField, aStruct, lIsRequired) |
Sintaxe: self:oSchema: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:oSchema:setX5Struct(cField, cTable, lIsRequired) |
Sintaxe: self:oSchema: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) | |
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:oSchema:setLookUpQuery(cField, aFields, cQuery, lIsRequired) |
Sintaxe: self:oSchema:setLookUpQuery(<cField>, <aFields>, <cQuery>, <lIsRequired>) → nil
Exemplos completos com padrão LookUp:
Bloco de código | ||||
---|---|---|---|---|
| ||||
#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", release="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("MateriaisCompras") 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:oData: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:oSchema: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:oSchema:aliasToSchema("SB1", {"B1_FILIAL", "B1_COD"}) self:oSchema:addProperty("Descricao", "Descricao", "string", "Descricao","B1_DESC") self:oSchema:addProperty("Tipo", "Tipo", "string", "Tipo","B1_TIPO") self:oSchema:addProperty("Unidade", "Unidade de medida", "string", "Unidade","B1_UM") self:oSchema:addProperty("Revisao", "Revisao", "date", "revisao","B1_UREV") self:oSchema: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:oSchema:setLookUpVal(cField, aStruct, lIsRequired, aDescriptor, nFieldReturn) return self:oSchema |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "protheus.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.financeiro.fornecedores.integratedprovider.lookup @totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGAFIN", tables="SA2", name="Fornecedores", country="ALL", release="12.1.2210") class SA2TReportsBusinessObject 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 SA2TReportsBusinessObject _Super:new() self:setDisplayName("Fornecedores") self:setIsLookUp(.T.) return self method getDescription() as character class SA2TReportsBusinessObject return "Fornecedores do Protheus" method getAreas() as array class SA2TReportsBusinessObject return {"Financeiro", "Contas a pagar"} method getData(nPage as numeric, oFilter as object) as object class SA2TReportsBusinessObject local cQuery as character local cAlias as character cQuery := "SELECT * FROM " + RetSqlName('SA2') + " WHERE D_E_L_E_T_ = ' '" if oFilter:hasFilter() cQuery += " AND " + oFilter:getSQLExpression() endif cAlias := MPSysOpenQuery(cQuery) while !(cAlias)->(Eof()) self:oData:appendData({"Nome": (cAlias)->A2_NOME,; "Codigo": (cAlias)->A2_COD,; "Estado": (cAlias)->A2_EST}) (cAlias)->(DBSkip()) enddo (cAlias)->(DBCloseArea()) return self:oData method getSchema() as object class SA2TReportsBusinessObject self:oSchema:addProperty("Nome", "Nome do Fornecedor", "string", "Nome","A2_NOME") self:oSchema:addProperty("Codigo", "Código do Fornecedor", "string", "Código", "A2_COD") self:oSchema:addProperty("Estado", "Sigla da Federacao", "string", "Estado", "A2_EST") //Seta o lookup a partir de uma tabela da SX5 self:oSchema:setX5Struct("A2_EST", "12", .F.) return self:oSchema |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.financeiro.naturezas.integratedprovider.lookup @totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGAFIN", tables="SED", name="Naturezas", country="ALL", release="12.1.2210") class SEDTReportsBusinessObject from totvs.framework.treports.integratedprovider.IntegratedProvider public method new() as object public method getDisplayName() as character public method getAreas() as array public method getData() as object public method getSchema() as object endclass method new() as object class SEDTReportsBusinessObject _Super:new() self:setDescription("Naturezas financeiras do Protheus") self:setIsLookUp(.T.) return self method getDisplayName() as character class SEDTReportsBusinessObject return "Naturezas" method getAreas() as array class SEDTReportsBusinessObject return {"Financeiro"} method getData(nPage as numeric, oFilter as object) as object class SEDTReportsBusinessObject self:oData:aliasToData("SED", oFilter) return self:oData method getSchema() as object class SEDTReportsBusinessObject local cQuery as character local aFields as array Local aDescriptor as array Local cReturn as character Local cOrder as character self:oSchema:aliasToSchema("SED") cQuery := "SELECT * FROM "+ RetSQLName("SED") +" WHERE D_E_L_E_T_ = ' '" //cQuery := "SELECT ED_CODIGO, ED_DESCRIC FROM "+ RetSQLName("SED") +" WHERE D_E_L_E_T_ = ' '" aFields := {"ED_CODIGO", "ED_DESCRIC"} aDescriptor := {"Codigo", "Descrição"} cReturn := "ED_CODIGO" cOrder := "ED_DESCRIC" //Seta o lookup a partir da query self:oSchema:setLookUpQuery("ED_CODIGO", aFields, cQuery, .F., aDescriptor, cReturn, cOrder) return self:oSchema |
Exemplo do padrão LookUp na interface:
Log para os Filtros do TReports
Foi criada a chave fw-treports-debug para mandar mensagens para o console e ajudar a identificar erros relacionados aos filtros enviados ao TReports.
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 |
...
Informações | ||
---|---|---|
| ||
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 página |
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 página.
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 das Fontes de Dados Nativas em TLPP
Bloco de código | ||||
---|---|---|---|---|
| ||||
#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", release="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("MateriaisCompras") //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 | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.materiais.produtos.integratedprovider @totvsFrameworkTReportsIntegratedProvider(active=.T.)th" namespace custom.materiais.produtos.integratedprovider @totvsFrameworkTReportsIntegratedProvider(active=.T., team="SIGACOM", tables="SB1", name="Materiais", country="ALL", release="12.1.2210") class SB1TReportsBusinessObjectData 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 SB1TReportsBusinessObjectData _Super:new() //Define a Área self:appendArea("MateriaisCompras") //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(nPage as numeric, oFilter as object) as object class SB1TReportsBusinessObjectData //Define a quantidade máxima por página (Default 100) self:setPageSize(500) //Setar antes de fazer o aliasToData() self:aliasToData("SB1", oFilter) return self:oData method getSchema() as object class SB1TReportsBusinessObjectData self:aliasToSchema("SB1") return self:oSchema |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#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", release="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 - KeyLabel") //Seta o lookup do campo do tipo combobox 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 local nSkip as numeric local nEnd as numeric local nCount as numeric nCount := 0 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) //Seta a quantidade de itens por página (Default 100) self:setPageSize(15) //Posiciona o conteúdo da query if nPage == 1 (cAlias)->(dbGoTop()) else //Encontra a quantidade de itens que irá pular de acordo com a página atual nSkip := ((nPage - 1) * self:getPageSize()) (cAlias)->(dbSkip(nSkip)) endif while !(cAlias)->(Eof()) cDate := FwTimeStamp(6, StoD((cAlias)->B1_UREV)) self:oData: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()) nCount++ //Sai do loop quando chegar no tamanho de itens da página if nCount == self:getPageSize() exit endif enddo //Se não for o último registro indica que terá próxima página self:setHasNext(!(cAlias)->(Eof())) (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 |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch" #include "protheus.ch" #include "totvs.framework.treports.integratedprovider.th" namespace custom.materiais @totvsFrameworkTReportsIntegratedProvider(active=.T.) , team="SIGACOM", tables="SA5", name="Produto X Fornecedor", country="ALL", release="12.1.2210") //------------------------------------------------------------------- /*{Protheus. doc} MATR190TReportsBusinessObject Classe para criação do Objeto de Negócio de Prod x Forn para o TReports @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- class MATR190TReportsBusinessObject 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 protected data aFields as array protected data aStruct as array endclass //------------------------------------------------------------------- /*{Protheus.doc} new Método de instância da classe @return object: self @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- method new() class MATR190TReportsBusinessObject _Super:new() self:appendArea("Compras") self:aFields := {"A5_FILIAL", "A5_FORNECE", "A5_LOJA", "A5_NOMEFOR", "A5_PRODUTO", "A5_NOMPROD", "A5_CODPRF"} self:aStruct := getStruct(self:aFields) return self //------------------------------------------------------------------- /*{Protheus.doc} getDisplayName Retorna o nome de exibição do objeto de negócio @return string @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- method getDisplayName() as character class MATR190TReportsBusinessObject return "Produtos x Fornecedores" //------------------------------------------------------------------- /*{Protheus.doc} getDescription Retorna a descrição do objeto de negócio @return string @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- method getDescription() as character class MATR190TReportsBusinessObject return "Produtos x Fornecedores" //------------------------------------------------------------------- /*{Protheus.doc} getData Retorna os dados do objeto de negócio @param nPage, numérico, indica a página atual do relatório @param oFilter, objeto, contém o filtro do TReports @return object: self:oData @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- method getData(nPage as numeric, oFilter as object) as object class MATR190TReportsBusinessObject local cQuery as character local cAlias as character local nSkip as numeric local nCount as numeric local nX as numeric local jItems as json local aPDFields as array nCount := 0 cQuery := "SELECT A5_FILIAL,A5_PRODUTO,A5_NOMPROD,A5_FORNECE,A5_NOMEFOR,A5_LOJA,A5_CODPRF FROM " + RetSQLName("SA5") + " 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) if nPage == 1 (cAlias)->(dbGoTop()) else //Encontra a quantidade de itens que irá pular de acordo com a página atual nSkip := ((nPage - 1) * self:getPageSize()) (cAlias)->(dbSkip(nSkip)) endif while !(cAlias)->(Eof()) //Verifica se precisa fazer o tratamento para LGPD aPDFields := FwProtectedDataUtil():UsrAccessPDField(__cUserID, self:aFields) lObfuscated := len( aPDFields ) != Len(self:aFields) jItems := JsonObject():new() for nX := 1 To Len(self:aStruct) if lObfuscated .and. aScan(aPDFields, self:aStruct[nX][5]) == 0 jItems[self:aStruct[nX][1]] := FwProtectedDataUtil():ValueAsteriskToAnonymize((cAlias)->&(self:aStruct[nX][5])) else jItems[self:aStruct[nX][1]] := (cAlias)->&(self:aStruct[nX][5]) endif next nX self:oData:appendData(jItems) (cAlias)->(DBSkip()) nCount++ //Sai do loop quando chegar no tamanho de itens da página if nCount == self:getPageSize() exit endif enddo //Se não for o último registro indica que terá próxima página self:setHasNext(!(cAlias)->(Eof())) (cAlias)->(DBCloseArea()) return self:oData //------------------------------------------------------------------- /*{Protheus.doc} getSchema Retorna a estrutura dos campos @return object: self:oSchema @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- method getSchema() as object class MATR190TReportsBusinessObject Local nX as numeric for nX := 1 To Len(self:aStruct) self:addProperty(self:aStruct[nX][1], self:aStruct[nX][2], self:aStruct[nX][3], self:aStruct[nX][4], self:aStruct[nX][5]) Next nX return self:oSchema //------------------------------------------------------------------- /*{Protheus.doc} getStruct Prepara a estrutura dos campos @param aCpos array: Array com os campos do relatório @return array: Array com a estrutura dos campos @author Vanessa Ruama @since 02/03/2023 @version 1.0 */ //------------------------------------------------------------------- function getStruct(aCpos) Local aDeParaCpo as array Local aCpoTmp as array Local cCampo as character Local cCpoQry as character Local cTipR as character Local nPos as numeric Local nC as numeric aDeParaCpo := {{"C", "string"}, {"D", "date"}, {"N", "number"}, {"L", "boolean"}} aCpoTmp := {} for nC := 1 to Len(aCpos) cCpoQry := aCpos[nC] nPos := AT(".", aCpos[nC]) + 1 if nPos > 0 cCampo := Substr(cCpoQry, nPos) else cCampo := cCpoQry endif cTipo := GetSx3Cache(cCampo, "X3_TIPO") if (nPos := aScan(aDeParaCpo, {|c| c[01] = cTipo})) > 0 cTipR := aDeParaCpo[nPos, 02] else cTipR := "string" endif AAdd(aCpoTmp, {strTran(cCampo, "_", ""), FWSX3Util():GetDescription(cCampo), cTipR, cCampo, cCampo}) next nC return (aCpoTmp) |