...
Aviso |
---|
Classe deverá ser utilizada com a linguagem TL++ |
Aviso |
---|
A partir da LIB Label 20230918 é possível fazer o tratamento nos objetos de negócio para aceitar campos personalizados. Documentação completa no link: Smart View - Personalização de Campos |
Aviso |
---|
A partir da LIB Label 20231121 é possível criar objetos de negócio aninhados. Documentação completa no link: Smart View - Objetos de Negócios Aninhados |
Informações | ||
---|---|---|
| ||
É possível ver os logs da integração ligando a chave FwTraceLog=1 no INI do ambiente utilizado, para mais informações sobre a chave: Chaves para controle de logs |
Índice | ||||
---|---|---|---|---|
|
...
Exemplo de uso:
Bloco de código |
---|
#include "protheus.ch"
#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", initialRelease="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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. Método AddParameter() - Método do objeto oSchema que adiciona um parâmetro ao objeto de negócio.
Parâmetros:
|
...
Bloco de código |
---|
method getData(nPage as numeric, oFilter as object) as object class SEDTReportsBusinessObject local cQuery as character local cAlias as character local oExec as object cQuery := "SELECT ED_DESCRIC FROM " + RetSqlName('SED') + " WHERE D_E_L_E_T_ = ' '" if oFilter:hasFilter() cQuery += " AND " + oFilter:getSQLExpression() endif oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQueryoExec:OpenAlias(cQuery) while !(cAlias)->(Eof()) self:appendData({"Descrição": (cAlias)->ED_DESCRIC}) (cAlias)->(DBSkip()) enddo (cAlias)->(DBCloseArea()) return self:oData |
...
Define o nome do relatório.
Aviso | ||
---|---|---|
| ||
É obrigatório o envio do DisplayName nos Objetos de Negócio |
Bloco de código |
---|
SetDisplayName("Naturezas") |
...
Adiciona uma área a qual o relatório pertence.
Aviso | ||
---|---|---|
| ||
É obrigatório o envio de pelo menos uma área nos Objetos de Negócio |
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
cArea | Caracter | X | Nome da área do relatório |
...
Define a descrição do relatório.
Aviso | ||
---|---|---|
| ||
É obrigatório o envio da Descrição nos Objetos de Negócio |
Sintaxe: SetDescription(<cTexto>) → nil
...
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", initialRelease="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 local oExec as object 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 oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQueryoExec:OpenAlias(cQuery) while !(cAlias)->(Eof()) self:appendData({"Nome": (cAlias)->A2_NOME, "Codigo": (cAlias)->A2_COD}) (cAlias)->(DBSkip()) enddo (cAlias)->(DBCloseArea()) return self:oData method getSchema() as object class SA2TReportsBusinessObject self:addProperty("Nome", "Nome do Fornecedor", "string", "Fornecedor", "A2_NOME") self: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", 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") 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 oExec as object 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 cAliasoExec := MPSysOpenQueryFwExecStatement(cQuery) ):New(ChangeQuery(cQuery)) cAlias := oExec:OpenAlias() while !(cAlias)->(Eof()) self:appendData({"Filial": (cAlias)->B1_FILIAL,; "Codigo": (cAlias)->B1_COD,; "Descricao": (cAlias)->B1_DESC,; "Tipo": (cAlias)->B1_TIPO, ; "Unidade": (cAlias)->B1_UM, ; "Revisao": iif(!empty((cAlias)->B1_UREV)), FwTimeStamp(5, StoD((cAlias)->B1_UREV), "00:00:00"), nil) }) //O campo data deverá ser enviado no formato correto, se estiver vazio enviar nil (cAlias)->(DBSkip()) enddo (cAlias)->(DBCloseArea()) return self:oData method getSchema() as object class SB1TReportsBusinessObject self:aliasToSchema("SB1", "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 |
---|
method new() as object class SRA2TReportsBusinessObject _Super:new() self:setDisplayName("Funcionários") if !self:setPergunte("GPER140") //Indica o pergunte que será utilizado no relatório FwLogMsg("WARN",, "SmartView",,, , "Grupo de perguntas nao encontrado", , ,) endif return self |
Sintaxe:setPergunte(<cPergunte>) → nillogical
Informações |
---|
Retorno lógico disponível a partir da LIB Label 20230918 |
Informações | ||
---|---|---|
| ||
Todos os MV_PAR virão maiúsculos no retorno. Ex: MV_PAR01, MV_PAR02 |
...
Indica se o campo pode ser filtrado.o código de erro e as mensagens que serão exibidas no relatório
Informações |
---|
Pode ser utilizado nos métodos getData e getSchema da classe. |
Informações |
Método disponível a partir da LIB Label 20230626 |
Nome | Tipo | Obrigatório | Default | Descrição | ||||
---|---|---|---|---|---|---|---|---|
cIdnCodError | CaractereNumérico | 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 | Códigos de erro 4xx. | ||||
cMessage | Caractere | X | Mensagem de erro que será exibida. | |||||
cDetailedMsg | Caractere | X | Mensagem detalhada do erro que será exibida. | lCanFilter | Lógico | X | Indica se o campo pode ser filtrado |
Bloco de código |
---|
method getSchemanew() 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
Seta o displayName da propriedade.
Informações |
---|
Método disponível a partir da LIB Label 20230626 |
...
Id da propriedade
Obs.: Se foi utilizado o método aliasToSchema o Id da propriedade é o nome do campo na tabela, ex. A1_NOME
SRA2TReportsBusinessObject
_Super:new()
self:setDisplayName("Funcionários")
if !self:setPergunte("GPER140") //Indica o pergunte que será utilizado no relatório GPER140
if !self:setErrorStatus(400,"Sem Pergunte","Verifique o grupo de perguntas informado!")
FwLogMsg("WARN",, "SmartView",,, , "Codigo de erro invalido, aceito somente codigos de erro 4xx", , ,)
endif
FwLogMsg("WARN",, "SmartView",,, , "Grupo de perguntas nao encontrado", , ,)
endif
return self |
Sintaxe:setErrorStatus(<nCodError>, <cMessage>, <DetailedMsg>) → logical
Informações |
---|
Método disponível a partir da LIB Label 20230918 |
...
Indica se o campo pode ser filtrado.
Informações |
---|
Método disponível a partir da LIB Label 20230626 |
...
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
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 Smart 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.
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 Smart View)
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. |
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 |
Bloco de código |
---|
method getSchema() as object class BA3TReportsBusinessObject self:setIsCBoxLookup(.T., .T.) |
Sintaxe: self:SetIsCBoxLookUp(<lKeyLabel>, <lX3>) → nil
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. |
Indica os valores dos combos dos schemas da nova classe.
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
...
Seta o displayName da propriedade.
Informações |
---|
Método disponível a partir da LIB Label 20230626 |
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. |
Nome | Tipo | Obrigatório | Default | Descrição |
---|
cId |
Caractere | X |
cComboValues
lIsRequired
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 |
Bloco de código |
---|
method getSchema() as object class BA3TReportsBusinessObject self:oSchema:addPropertyaliasToSchema("FilialBA3", "Filial", {"stringBA3_DATBLO", "FilialBA3_CODINT", "B1BA3_FILIALMATRIC", "D MG 01=Filial BH; D MG 02=Filial Uberaba", .F.) |
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
...
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 Smart 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.
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 Smart View)
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. |
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 |
Bloco de código |
---|
self:setIsCBoxLookup(.T., .T.) |
Sintaxe: self:SetIsCBoxLookUp(<lKeyLabel>, <lX3>) → nil
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. |
...
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. |
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. |
Bloco de código |
---|
self:oSchema:addProperty("Filial", "Filial", "string", "Filial", "B1_FILIAL", "D MG 01=Filial BH; D MG 02=Filial Uberaba", .F.) |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#include "msobject.ch"
#include " | ||||
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", 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 local oExec as object 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 oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQueryoExec:OpenAlias(cQuery) while !(cAlias)->(Eof()) cDate := iif(!empty((cAlias)->B1_UREV)), FwTimeStamp(5, StoD((cAlias)->B1_UREV), "00:00:00"), nil) 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 |
...
Informações |
---|
Método deverá ser utilizado no new() da nova classe criada, exemplo completo estará no final da documentação. |
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
lIsLookUp | Lógico | X | .F. | Indica que o filtro será do tipo padrão lookup |
Bloco de código |
---|
self:setIsLookup(.T.) |
...
Informações |
---|
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação. |
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 |
Bloco de código |
---|
self:setDescriptor("Código","Código do Produto", "Descrição do Produto") |
...
Informações |
---|
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação. |
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) |
Bloco de código |
---|
self:setLookUpVal(cField, aStruct, lIsRequired) |
...
Informações |
---|
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação. |
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 |
Bloco de código |
---|
self:setX5Struct(cField, cTable, lIsRequired) |
...
Informações |
---|
Método deverá ser utilizado no getSchema() da nova classe criada, exemplo completo estará no final da documentação. |
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) |
Bloco de código |
---|
self:setLookUpQuery(cField, aFields, cQuery, lIsRequired) |
...
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", 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 local oExec as object 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 oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQueryoExec:OpenAlias(cQuery) while !(cAlias)->(Eof()) cDate := iif(!empty((cAlias)->B1_UREV)), FwTimeStamp(5, StoD((cAlias)->B1_UREV), "00:00:00"), nil) 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 |
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", initialRelease="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 local oExec as object cQuery := "SELECT * FROM " + RetSqlName('SA2') + " WHERE D_E_L_E_T_ = ' '" if oFilter:hasFilter() cQuery += " AND " + oFilter:getSQLExpression() endif () endif oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQueryoExec:OpenAlias(cQuery) while !(cAlias)->(Eof()) self: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:addProperty("Nome", "Nome do Fornecedor", "string", "Nome","A2_NOME") self:addProperty("Codigo", "Código do Fornecedor", "string", "Código", "A2_COD") self:addProperty("Estado", "Sigla da Federacao", "string", "Estado", "A2_EST") //Seta o lookup a partir de uma tabela da SX5 self:setX5Struct("A2_EST", "12", .F.) return self:oSchema |
...
Para facilitar a construção do Objeto de Negócio e melhorar a performance foi implementada a paginação na fonte de dados, além de simplificar a forma como ele é construído.
Com isso o desenvolvedor consegue indicar quantos itens serão enviados ao Smart View por requisição.
...
title | Atenção |
---|
...
a performance foi implementada a paginação na fonte de dados, além de simplificar a forma como ele é construído.
Com isso o desenvolvedor consegue indicar quantos itens serão enviados ao Smart View por requisição.
Seta a quantidade de itens por página.
Nota |
---|
A partir da lib 20240408 esse método esta depreciado. |
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
nPageSize | Númerico | X | 100 | Indica a quantidade de itens por requisição |
Bloco de código |
---|
self:setPagesize(nPageSize) |
...
Retorna a quantidade de itens por requisição.
Bloco de código |
---|
self:getPagesize() |
...
Seta a query do objeto de negócio.
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
cQuery | Caracter | X | Indica a query do objeto de negócio |
Aviso | ||
---|---|---|
|
...
| |
|
Bloco de código |
---|
cQuery := "SELECT * FROM " + RetSQLName("SB1") + " WHERE B1_FILIAL = '"+ FWxFilial('SB1') +"' AND D_E_L_E_T_ = ' ' self:setQuery(cQuery) |
...
Seta o where da query.
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
cWhere | Caracter | X | Indica o where da query |
Bloco de código |
---|
self:setWhere("B1_FILIAL = '"+ FWxFilial('SB1') +"' AND D_E_L_E_T_ = ' '") |
...
Seta o campo de ordenação da query.
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
cOrder | Caracter | X | Primeiro campo indicado no método getSchema() | Indica o campo de ordenação |
Bloco de código |
---|
self:setOrder("B1_COD") |
...
Seta se terá próxima página.
Nome | Tipo | Obrigatório | Default | Descrição |
---|---|---|---|---|
lHasNext | Lógico | X | .F. | Indica se terá próxima página |
Bloco de código |
---|
self:setHasNext(.T.) |
...
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", 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 - 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 local oExec as object 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 oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQueryoExec:OpenAlias(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 := iif(!empty((cAlias)->B1_UREV), FwTimeStamp(5, StoD((cAlias)->B1_UREV), "00:00:00"), nil) 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, SB1", name="Produto X Fornecedor", country="ALL", initialRelease="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", "B1_TIPO", "B1_PESO"} 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 jsonarray local aPDFieldsoExec as arrayobject nCount := 0 cQuery := "SELECT A5_FILIAL,A5_PRODUTO,A5_NOMPROD,A5_FORNECE,A5_NOMEFOR,A5_LOJA,A5_CODPRF FROM " + self:getSQLFields(,,,.T.) + " FROM" + RetSQLName("SA5") cQuery += " SA5 LEFT JOIN " + RetSQLName("SA5SB1") + " SB1 ON SB1.B1_COD = SA5.A5_PRODUTO WHERE SB1.D_E_L_E_T_ = ' ' AND SA5.D_E_L_E_T_ = ' '" //Os filtros serão setados na interface do novo TReports if oFilter:hasFilter() cQuery += " AND " + oFilter:getSQLExpression() endif oExec := FwExecStatement():New(ChangeQuery(cQuery)) cAlias := MPSysOpenQuery(cQuery)oExec:OpenAlias() 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 //Verifica se precisa fazer o tratamento para LGPD aPDFields := FwProtectedDataUtil():UsrAccessPDField(__cUserID, self:aFields) lObfuscated := len( aPDFields ) != Len(self:aFields) while !(cAlias)->(Eof()) 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 next nX self:oData:appendData(jItems) endif enddo //Se não for o último registro indica que terá próxima página self:setHasNext(!(cAlias)->(Eof())) (cAlias)->(DBSkipDBCloseArea()) 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 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} getSchemagetStruct RetornaPrepara a estrutura dos campos @return object: self:oSchema@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 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, {cCampo, FWSX3Util():GetDescription(cCampo), cTipR, FWSX3Util():GetDescription(cCampo), cCampo}) next nC return (aCpoTmp) |
Informações |
---|
Parâmetros nativos nos Objeto de Negócio disponíveis a partir da LIB Label 20230515 |
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, {cCampo, FWSX3Util():GetDescription(cCampo), cTipR, FWSX3Util():GetDescription(cCampo), cCampo})
next nC
return (aCpoTmp) |
Informações |
---|
Parâmetros nativos nos Objeto de Negócio disponíveis a partir da LIB Label 20230515 |
Bloco de código | ||||
---|---|---|---|---|
| ||||
#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., team="Framework", tables="SRA", name="Funcionários", country="ALL", initialRelease="12.1.2310")
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
data lExistPergunte as logical
endclass
method new() as object class SRA2TReportsBusinessObject
_Super:new()
self:setDisplayName("Funcionários")
self:lExistPergunte := self:setPergunte("GPER140") //Indica o pergunte que será utilizado no relatório GPER140
if !self:lExistPergunte
if !self:setErrorStatus(400,"Sem Pergunte","Verifique o grupo de perguntas informado!")
FwLogMsg("WARN",, "SmartView",,, , "Codigo de erro invalido, aceito somente codigos de erro 4xx", , ,)
endif
FwLogMsg("WARN",, "SmartView",,, , "Grupo de perguntas nao encontrado", , ,)
endif
| ||||
Bloco de código | ||||
| ||||
#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") self:setPergunte("GPER140") //Indica o pergunte que será utilizado no relatório 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 if !self:lExistPergunte //retorno do método SetPergunte() return self:oData else 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) endif return self:oData method getSchema() as object class SRA2TReportsBusinessObject self:aliasToSchema("SRA" , {"RA_NOME", "RA_FILIAL", "RA_MAT", "RA_EMAIL", "RA_ADMISSA"}) return self:oSchema |
...