Histórico da Página
Classe criada para a execução de recursos do Smart View no Protheus.
| Informações | ||
|---|---|---|
| ||
Disponível a partir da LIB Label 20240226 |
...
Método de instância da classe.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cProtheusId | Caractere | X | Id do recurso que será |
| impresso (relacionado ao nome do arquivo .trp) | ||||
| cType | Caractere | Apenas quando for a execução de recurso único | Tipo do recurso (report, pivot-table ou data-grid) |
Exemplos de uso:
| Bloco de código | ||
|---|---|---|
| ||
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product.default.rep.bra", "report") |
| Bloco de código | ||
|---|---|---|
| ||
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product") |
Sintaxe: New() → objeto self
...
| Informações |
|---|
Esse método deverá ser utilizado apenas para relatórios. Utilizando a geração em job o método executeSmartView da classe sempre retornará .T., pois será iniciado um startJob, sendo possível verificar a geração a partir do console.log com a chave FwTraceLog=1 ligada. |
...
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| lIsJob | Lógico | X | .F. | Indica se o recurso será executado em job |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setRunInJob(.T.) |
Sintaxe: setRunInJob(<lIsJob>) → nil
...
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| lNoInterface | Lógico | X | .F. | Indica se o recurso será executado sem interface |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setNoInterface(.T.) |
Sintaxe: setRunInJobsetNoInterface(<lNoInterface>) → nil
...
setShowWizard()
...
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| lShowWizard | Lógico | X | .F. | Indica se abre o wizard de configuração |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setShowWizard(.T.) |
Sintaxe: setShowWizard(<lShowWizard>) → nil
...
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| lShowParams | Lógico | X | .T. | Indica irá mostrar o botão de parâmetros |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setShowParams(.T.) |
Sintaxe: setShowParams(<lShowParams>) → nil
...
| Informações |
|---|
Neste método é considerado o envio de todos os parâmetros de uma vez, para enviar um de cada, pode-se utilizar o método setParam(), não é possível utilizar os dois métodos ao mesmo tempo, pois um sobrescreve o outro. |
...
- Caso seja enviado como .T. indica que irá sobrescrever o profile do usuário com os parâmetros enviados, caso alguns parâmetros não sejam enviados ficarão com o valor do profile.
Propriedade visibility:
- Default - O parâmetro é exibido e pode ter seu valor alterado pelo usuário;
- Hidden - O parâmetro não é exibido no viewer;
- Disabled - O parâmetro é exibido no viewer, porém o usuário não pode alterar seu valor.
Caso a mesma não seja enviada, terá o valor 'Default'
Parâmetros multivalores:
- Deverão ser enviados como string e separados por ';'. Ex.: "D MG 01; D MG 02"
Parâmetros do tipo data:
- Utilizar as funções de conversão disponibilizadas na lib para enviar o formato correto. Doc: Smart View - Conversão de datas
Exemplo de uso:
| Bloco de código |
|---|
jParams := JsonObject():new()
jParams["parameters"] := Array(2)
jParams["force"] := .T. //Indica se força o valor
jParams["parameters"][1] := JsonObject():New()
jParams["parameters"][1]["name"] := "MV_PAR01"
jParams["parameters"][1]["value"] := ""
jParams["parameters"][1]["visibility"] := "Disabled"
jParams["parameters"][2] := JsonObject():New()
jParams["parameters"][2]["name"] := "MV_PAR02"
jParams["parameters"][2]["value"] := "ZZZZ"
jParams["parameters"][2]["visibility"] := "Disabled"
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product")
oSmartView:setParameters(jParams) |
Sintaxe: setShowParamssetParameters(<lShowParams><jParams>) → nil
...
setParam()
Indica o valor de um parâmetro do relatório.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| cName | Caractere | X | Identificação do parâmetro, ex.: MV_PAR01 |
| xValue |
| Variante | X | Valor do parâmetro | ||
| cVisibility | Caractere | Default | Visibilidade do Parâmetro |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setParam("MV_PAR01", "", "Disabled")
oSmartView:setParam("MV_PAR02", "ZZZZZ")
oSmartView:setParam("MV_PAR03", 2, "Hidden")
oSmartView:setParam("MV_PAR04", totvs.framework.treports.date.stringToTimeStamp("20240130")) |
Sintaxe: setParam(<cName>, <xValue>, <cVisibility>) → nil
...
setForceParams()
Indica se irá forçar o preenchimento dos parâmetros com o valores enviados.
Com o force ativado o profile do usuário sempre será sobrescrito com os valores dos parâmetros enviados, aqueles que não forem enviados, será preenchido pelo profile, caso exista.
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| lForce | Lógico | X | .F. | Indica se força os valores dos parâmetros |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setForceParams(.T.) |
Sintaxe: setForceParams(<lForce>) → nil
...
setPrintType()
Indica o tipo de impressão.
| Informações |
|---|
Esse método deverá ser utilizado apenas para relatórios. |
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| nPrintType | Numérico | X | 1 | Tipo de impressão, sendo elas: 1 - Arquivo 2 - E-mail |
Exemplo de uso:
| Bloco de código |
|---|
oSmartView:setPrintType(1) |
Sintaxe: setPrintType(<nPrintType>) → nil
...
setPrintInfo()
Indica os valores de impressão do recurso.
| Informações |
|---|
Esse método deverá ser utilizado apenas para relatórios. |
Parâmetros:
Nome | Tipo | Obrigatório | Default | Descrição |
|---|---|---|---|---|
| jPrintInfo | Json | X | Informações de impressão. |
Formato esperado:
É necessário o envio de algumas informações sobre a impressão a partir do jPrintInfo, sendo elas:
- Opção 1 - Impressão em arquivo
Propriedades:
Propriedades | Obrigatório | Default | Descrição |
|---|---|---|---|
| name | Nome do relatório na tabela (TR__IDREL) + Data/Hora | Nome do arquivo | |
| extension | Extensão | ||
| path | MV_RELT | Pasta onde será salvo |
- Opção 2 - Impressão por E-mail
Propriedades:
Propriedades | Obrigatório | Default | Descrição |
|---|---|---|---|
| to | X | Destinatário do E-mail | |
| subject | Relatório Smart View | Assunto do E-mail | |
| body | Descrição do relatório (TR__DESCRI) | Corpo do -email | |
| name | Nome do relatório na tabela (TR__IDREL) + Data/Hora | Nome do arquivo | |
| extension | Extensão | ||
| path | MV_RELT | Pasta onde será salvo |
| Informações |
|---|
Necessário ter configurado o SMTP para envio de e-mail - Configurar o SMTP para envio de relatórios por e-mail |
| Aviso | ||
|---|---|---|
| ||
O tWebEngine possui uma proteção para não realizar download de arquivos maliciosos. Por padrão é possível realizar download de arquivos do Smart View com as seguintes extensões: pdf, xls, xlsx, rtf, docx, mht, html, txt, csv e png. Caso seja necessário realizar o download de outras extensões deve ser realizado tratamento pelo ponto de entrada AddLexList (https://tdn.totvs.com/display/PROT/AdDLExList). Para utilizar este ponto de entrada é necessário o fonte FwDLExList.prw mais atual. |
Exemplo de uso:
| Bloco de código |
|---|
jPrintInfo := jsonObject():new()
jPrintInfo["extension"] := "xlsx"
jPrintInfo["name"] := "product" + FWTimeStamp()
oSmartView:setPrintInfo(jPrintInfo) |
Sintaxe: setPrintInfo(<jPrintInfo>) → nil
...
executeSmartView()
Executa o recurso escolhido.
Retorno:
Nome | Tipo | Descrição |
|---|---|---|
| lSuccess | Lógico | Indica o erro na execução |
Exemplo de uso:
| Bloco de código |
|---|
lSuccess := oSmartView:executeSmartView() |
Sintaxe: oSmartView:executeSmartView() → lSuccess
...
getError()
Retorna o erro na geração.
Retorno:
Nome | Tipo | Descrição |
|---|---|---|
| cError | Caractere | Indica o erro na execução |
Exemplo de uso:
| Bloco de código |
|---|
cError := oSmartView:getError() |
Sintaxe: oSmartView:getError() → cError
...
destroy()
Remove os recursos que podem prender memória.Exemplo de uso:
| Bloco de código |
|---|
oSmartView:destroy() |
Sintaxe: oSmartView:destroy() → nil
...
Exemplos completos
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
#include "protheus.ch"
user function sv_job()
local oSmartView as object
RpcSetEnv('T1', 'D MG 01', "admin", "1234") //Necessário ter o ambiente inicializado
//Para geração em job sempre deverá ser setado um recurso único
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product.default.rep.bra", "report")
oSmartView:setRunInJob(.T.)
oSmartView:setParam("MV_PAR01", "", "Disabled")
oSmartView:setParam("MV_PAR02", "ZZZZZ")
oSmartView:setPrintType(1)
oSmartView:executeSmartView() //A geração deverá ser acompanhada via logs pelo server
oSmartView:destroy()
return |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
#include "protheus.ch"
user function sv_noInterface()
local lSuccess as logical
local oSmartView as object
local jPrint as json
RpcSetEnv('T1', 'D MG 01', "admin", "1234") //Necessário ter o ambiente inicializado
//Para geração sem interface sempre deverá ser setado um recurso único
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product.default.rep.bra", "report")
oSmartView:setNoInterface(.T.)
oSmartView:setParam("MV_PAR01", "", "Disabled")
oSmartView:setParam("MV_PAR02", "ZZZZZ")
oSmartView:setPrintType(1)
jPrint := jsonObject():new()
jPrint["extension"] := "xlsx"
jPrint["name"] := "teste_print" + FWTimeStamp()
oSmartView:setPrintInfo(jPrint)
lSuccess := oSmartView:executeSmartView()
If !lSuccess
Conout(oSmartView:getError())
EndIf
oSmartView:destroy()
return |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
#include "protheus.ch"
user Function callSV()
local lSuccess As logical
local jParams as json
local oSmartView as object
jParams := JsonObject():new()
jParams["parameters"] := Array(2)
jParams["force"] := .T. //Indica se força o valor
jParams["parameters"][1] := JsonObject():New()
jParams["parameters"][1]["name"] := "MV_PAR01"
jParams["parameters"][1]["value"] := ""
jParams["parameters"][1]["visibility"] := "Disabled"
jParams["parameters"][2] := JsonObject():New()
jParams["parameters"][2]["name"] := "MV_PAR02"
jParams["parameters"][2]["value"] := "ZZZZ"
jParams["parameters"][2]["visibility"] := "Disabled"
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product.synt.rep.bra", "report")
oSmartView:setParameters(jParams)
lSuccess := oSmartView:executeSmartView()
If !lSuccess
Conout(oSmartView:getError())
EndIf
oSmartView:destroy()
return .T. |
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
#include "protheus.ch"
user Function callMultiSV()
local lSuccess As logical
local oSmartView as object
oSmartView := totvs.framework.smartview.callSmartView():new("framework.sv.framework.product")
oSmartView:setParam("MV_PAR01", "")
oSmartView:setParam("MV_PAR02", "ZZZZZ")
oSmartView:setParam("MV_PAR03", 2)
oSmartView:setParam("MV_PAR04", totvs.framework.treports.date.dateToTimeStamp(date()))
lSuccess := oSmartView:executeSmartView()
If !lSuccess
Conout(oSmartView:getError())
EndIf
oSmartView:destroy()
return .T. |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas