01. DATOS GENERALES

Línea de producto:

Microsiga Protheus®

Segmento:

Backoffice

Módulo:

Financiero

Idiomas:

Portugués

Función: 

Portal del cliente

02. DESCRIPCIÓN

El punto de entrada se liberó por medio del paquete de expedición continua del módulo Financiero después del mes de octubre.

El punto de entrada PCBROWSE permite incluir opciones de menú para el listado de ítems personalizados en elPortal del cliente - SIGAFIN.

El punto de entrada debe devolver un array con el json de configuración de cada menú que desea agregar.

03. CONFIGURACIÓN

Parámetros puestos a disposición en el punto de entrada:


PARAMIXB

Tipo

Descripción

1º Posición

Character

Usuario de login del Portal del cliente.


Configuración necesaria para que se cargue la opción de menú en el portal del cliente. Si alguna información obligatoria, función de usuario informada no compilada o error de ejecución ocurriera, no se cargará el menú.

Propiedad

Obligatoriedad

Descripción

tituloMenu

Obligatorio

Título mostrado en el menú.

iconeMenu

Opcional

Ícono para el menú. Lista de íconos PO UI que pueden utilizarse en esta propiedad. https://po-ui.io/guides/icons

tituloPagina

Obligatorio

Titulo mostrado en la página.

funcaoQuery

Obligatorio

Nombre de la User Function que devolverá la query para buscar los datos.

orderQuery

Opcional

Campo en el cual se basará el orden de la tabla.

tabla

Obligatorio

Alias de la tabla utilizada para tratamiento interno.

columnas

Es obligatorio si no se envían fields

Array de campos del browse, el sistema utilizará el título de la SX3. Si se informan fields, se ignorará esta propiedad.

fields

Opcional

Array de json con los campos del browse. Cada campo debe tener las propiedades property, type y label (PoTableColumn):

  • property: string con el nombre del campo.
  • type: string con el tipo del campo (Tipos aceptados: currency, date, number, string).
  • label: string que contiene el título del campo.

leyeendas

Opcional

Configuración de las leyendas. Array de json con las propiedades  value, color y label. (labels del PoTableColumnLabel)

campoLegendas

Opcional

Campo utilizado para leyenda.

tituloLegendas

Opcional

Título de la leyenda.

detalles

Opcional

Json con las propiedades para que se muestre en la pantalla de  detalles del registro. Consulte el ítem 03.02 Configuración de detalles.


03.01. CONFIGURACIÓN DE BÚSQUEDA

Es posible configurar la búsqueda simple y avanzada por medio de la configuración:

Propiedad

Obligatoriedad

Descripción

campoBusca

Opcional

Campo para búsqueda rápida.

camposBuscaAvancada

Opcional

Lista de campos para búsqueda avanzada, el sistema utilizará el título de la SX3. Si se informa fieldsBuscaAvancada , se ignorará esta propiedad.

fieldsBuscaAvancada

Opcional

Array de json con los campos para utilizar en la búsqueda avanzada. Cada campo debe tener las propiedades property, type y label (PoDynamicFormField):

  • property: string con el nombre del campo.
  • type: string con el tipo de campo (Tipos aceptados: currency, date, number, string).
  • label: string que contiene el título del campo.

03.02. CONFIGURACIÓN DE DETALLES

Si se configuran los detalles, se muestra en el ítem la opción "visualizar" para la exhibición de las informaciones y el listado de ítems.

Propiedad

Obligatoriedad

Descripción

tituloPagina

Obligatorio

Título que se muestra en la página de detalles.

tituloAbaPrincipal

Obligatorio

Título que se muestra en la solapa principal.

camposDetalhes

Obligatorio

Lista de campos que se mostrarán, el sistema utilizará el título de la SX3. Si se informa fieldsDetalhes , se ignorará esta propiedad.

fieldsDetalhes

Opcional

Array de json con los campos del browse. Cada campo debe tener las propiedades property, type y label (PoTableColumn):

  • property: string con el nombre del campo.
  • type: string con el tipo de campo (Tipos aceptadoss: date, number, string).
  • label: string que contiene el título del campo.
  • divider: string con el título para la definición de la sección (Los campos agregados después de este, formarán parte de esta división/sección).

orderQueryItens

Opcional

Campo en el cual se basará el orden de la tabla.

tituloAbaItens

Opcional

Título que se muestra en la solapa Ítems.

funcaoQueryItens

Es obligatorio si se informa tituloAbaItens

User Funcion que devolverá la query de los ítems.

tabelaItens

Es obligatorio si se informa tituloAbaItens

Alias dos itens.

columnas

Es obligatorio si se informa tituloAbaItens

Lista de campos del browse, el sistema utilizará el título de la SX3. Si se informa fields , se ignorará esta propiedad.

fields

Es obligatorio si se informa tituloAbaItens

Array de json con los campos del browse. Cada campo debe tener las propiedades property, type y label (PoTableColumn):

  • property: string con el nombre del campo.
  • type: string con el tipo do campo (Tipos aceptados: date, number, string).
  • label: string que contiene el título del campo.

04. USER FUNCTION QUERY

La función pasada en la propiedad 'funcaoQuery' y 'funcaoQueryItens' se llamará por el Portal del cliente para que devuelva la query personalizada que se utilizará en la búsqueda de los ítems. 

funcaoQuery recibe los parámetros: 

PARAMIXB

Tipo

Descripción

1º Posición

Array

Contiene un Array con las claves (SUCURSAL+CÓDIGO+TIENDA) de los clientes seleccionados en el portal. 

Cada posición del Array contiene un objeto Json con las propiedades: sucursal, código y tienda.

2º Posición

Carácter

Usuario de login del Portal del cliente

funcaoQueryItens recibe los parámetros: 

PARAMIXB

Tipo

Descripción

1º Posición

Array

Contiene un Array con las claves (SUCURSAL, CÓDIGO, TIENDA) de los clientes seleccionados en el portal. 

Cada posición del Array contiene un objeto Json con las propiedades: sucursal, código y tienda.

2º Posición

Carácter

Usuario de login del Portal del cliente

2º Posición

Json

Json de la línea seleccionada en el formato "{ Campo: Valor} " Ej.: "{E1_FILIAL: '01', E1_NUM: '000001'}"

Devolución del punto de entrada:

La función debe devolver la query personalizada:

Deben utilizarse los Id:

#QueryFields# Campos del SELECT, existe tratamiento para el FIELDS en el QueryParam
#QueryWhere# Condiciones del WHERE, existe tratamiento para FILTER en el QueryParam


Tipo

Obligatoriedad

Descripción

Carácter

Obligatorio

Query personalizada para listado de los registros del menú personalizado.

05. EJEMPLO DE UTILIZACIÓN

#Include 'Protheus.ch'
 
/*/{Protheus.doc} PCBROWSE
    Ponto de entrada para adicionar opcoes de menu no Portal do cliente
    @type function
    @return array, array de configuracao
/*/
User Function PCBROWSE()
    Local cUser := PARAMIXB[1] as Character // Codigo do usuario logado no portal.
    Local aMenu := {} as Array

    AAdd(aMenu, MENU1()) // exemplo utilizando colunas SX3
    AAdd(aMenu, MENU2()) // exemplo configurando fields
Return aMenu
 
/*/{Protheus.doc} MENU1
    Configuracao do menu
    @type function
    @return json, configuracao do browse
/*/
Static Function MENU1()
    Local jMenu     := JsonObject():new() as Json
    Local jDetalhes := JsonObject():new() as Json

    //titulo apresentado no menu
    jMenu['tituloMenu'] := 'Pedidos1'

    //icone para o menu, lista de icones https://po-ui.io/guides/icons
    jMenu['iconeMenu']  := 'po-icon po-icon-manufacture'

    //titulo apresentado na pagina
    jMenu['tituloPagina'] := 'Meus Pedidos1'

    //user funcion que vai retornar a query de busca
    jMenu['funcaoQuery'] := 'PCQRY01'

    //campo que vai ser ordenado
    jMenu['orderQuery']  := 'C5_EMISSAO DESC'

    //alias da tabela utilizada para tratamentos internos
    jMenu['tabela'] := 'SC5'

    //lista de campos do browse, o sistema vai utilizar o titulo da SX3. Se informar fields essa propriedade é ignorada
    jMenu['colunas'] := {'c5_filial', 'c5_condpag', 'c5_num', 'c5_vend1', 'c5_nota', 'c5_emissao'}
     
    //configuracao de legendas, array com value, color e label
    jMenu['legendas'] := {}

    AAdd(jMenu['legendas'], prepareStatus("N", "color-01", "Normal"))
    AAdd(jMenu['legendas'], prepareStatus("C", "color-02", "Compl.PrecIo/Cantidad"))
    AAdd(jMenu['legendas'], prepareStatus("I", "color-03", "Compl.ICMS"))
    AAdd(jMenu['legendas'], prepareStatus("P", "color-04", "Compl.IPI"))
    AAdd(jMenu['legendas'], prepareStatus("D", "color-05", "Dev.Compras"))
    AAdd(jMenu['legendas'], prepareStatus("B", "color-06", "Utiliza proveedor"))

    jMenu['campoLegendas']  := 'c5_tipo'
    jMenu['tituloLegendas'] := 'Tipo'
 
    //campo para busca rapida, Se informar fieldBusca essa propriedade é ignorada
    jMenu['campoBusca'] := 'c5_num'

    //lista de campos apra busca avancada, o sistema vai utilizar o titulo da SX3. Se informar fieldsBuscaAvancada essa propriedade é ignorada
    jMenu['camposBuscaAvancada'] := {'c5_filial', 'c5_vend1', 'c5_nota', 'c5_emissao', 'c5_transp'}
     
    //exemplo de configuracao de detalhes
    //titulo apresentado na pagina de detalhes
    jDetalhes['tituloPagina'] := 'Detalhes do pedido'

    //titulo apresentado na aba principal
    jDetalhes['tituloAbaPrincipal'] := 'Dados gerais'

    //lista de campos que serao apresentados, o sistema vai utilizar o titulo da SX3. Se informar fieldsDetalhes essa propriedade é ignorada
    jDetalhes['camposDetalhes'] := {'c5_num','c5_tipo', 'c5_nota', 'c5_emissao', 'c5_vend1', 'c5_tabela', 'c5_cliente', 'c5_lojacli', 'c5_transp', 'c5_frete', 'c5_seguro',}
 
    //titulo apresentado na aba itens
    jDetalhes['tituloAbaItens'] := 'Produtos'

    //user funcion que vai retornar a query dos itens
    jDetalhes['funcaoQueryItens'] := 'PCITEM'

    //campo que vai ser ordenado
    jDetalhes['orderQueryItens'] := 'c6_item desc'

    //alias dos itens
    jDetalhes['tabelaItens'] := 'SC6'

    //lista de campos do browse, o sistema vai utilizar o titulo da SX3. Se informar fields essa propriedade é ignorada
    jDetalhes['colunas'] := {'c6_item', 'c6_produto', 'c6_descri', 'c6_qtdven', 'c6_prcven', 'c6_valor'}
     
    jMenu['detalhes'] := jDetalhes
 
Return jMenu
 
/*/{Protheus.doc} MENU2
    Configuracao do menu utilizando as propriedades fields
    @type function
    @return json, configuracao do browse
/*/
Static Function MENU2()
    Local jMenu     := JsonObject():new() as Json //Json com as propriedades esperadas.
    Local jDetalhes := JsonObject():new() as Json
 
    jMenu['tituloMenu']   := 'Pedidos2'
    jMenu['iconeMenu']    := 'po-icon po-icon-manufacture'
    jMenu['tituloPagina'] := 'Meus Pedidos2'
    jMenu['funcaoQuery']  := 'PCQRY01'
    jMenu['orderQuery']   := 'C5_DATA1 ASC'
    jMenu['tabela']       := 'SC5'
 
    //lista de campos do browse, utilizado quando nao quer pegar dados da SX3.
    //deve ser um array de json com as propriedades property, type e label
    jMenu['fields'] := {}

    AAdd(jMenu['fields'], prepareField("c5_filial" , "string", "Filial do pedido"))
    AAdd(jMenu['fields'], prepareField("c5_num"    , "string", "Pedido"))
    AAdd(jMenu['fields'], prepareField("c5_vend1"  , "string", "Vendedor"))
    AAdd(jMenu['fields'], prepareField("c5_condpag", "string", "Forma de pagamento"))
    AAdd(jMenu['fields'], prepareField("c5_nota"   , "string", "NF"))
 
    //campo para busca rapida, utilizado quando nao quer pegar dados da SX3.
    //deve ser um array de json com as propriedades property, type e label
    jMenu['fieldBusca'] := prepareField("c5_num", "string", "Pesquisa por pedido")
 
    //lista de campos apra busca avancada, o sistema vai utilizar o titulo da SX3. Se informar fieldsBuscaAvancada essa propriedade é ignorada
    jMenu['fieldsBuscaAvancada'] := {}

    AAdd(jMenu['fieldsBuscaAvancada'], prepareField("c5_emissao", "date"  , "Data"))
    AAdd(jMenu['fieldsBuscaAvancada'], prepareField("c5_filial" , "string", "Filial"))
    AAdd(jMenu['fieldsBuscaAvancada'], prepareField("c5_nota"   , "string", "NF"))
    AAdd(jMenu['fieldsBuscaAvancada'], prepareField("c5_num"    , "string", "Pedido"))
 
    //exemplo de configuracao de detalhes
    //titulo apresentado na pagina de detalhes
    jDetalhes['tituloPagina'] := 'Detalhes do pedido'

    //titulo apresentado na aba principal
    jDetalhes['tituloAbaPrincipal'] := 'Dados gerais'

    //Utiliza as propriedades PoDynamicViewField do po-dynamic-view poui. https://po-ui.io/documentation/po-dynamic-view
    jDetalhes['fieldsDetalhes'] := {}     

	AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_num'    , 'string', 'Pedido'            , 'Dados'     ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_tipo'   , 'string', 'Tipo do pedido'                  ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_nota'   , 'string', 'Nota'                            ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_emissao', 'date'  , 'Data'                            ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_vend1'  , 'string', 'Vendedor'                        ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_tabela' , 'string', 'Tabela de preços'                ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_cliente', 'string', 'Código', 'Comprador'             ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_lojacli', 'string', 'Loja'                            ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_transp' , 'string', 'Código transportadora', 'Entrega'))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_frete'  , 'string', 'Valor do frete'                  ))
    AAdd(jDetalhes['fieldsDetalhes'], prepareField('c5_seguro' , 'string', 'Valor do seguro'                 ))
 
    //titulo apresentado na aba itens
    jDetalhes['tituloAbaItens'] := 'Produtos'

    //user funcion que vai retornar a query dos itens
    jDetalhes['funcaoQueryItens'] := 'PCITEM'

    //alias dos itens
    jDetalhes['tabelaItens'] := 'SC6'

    //lista de campos do browse, deve ser um array de json com as propriedades property, type e label
    jDetalhes['fields'] := {}

    AAdd(jDetalhes['fields'], prepareField('c6_item'   , 'string'  , 'Item'))
    AAdd(jDetalhes['fields'], prepareField('c6_produto', 'string'  , 'Código'))
    AAdd(jDetalhes['fields'], prepareField('c6_qtdven' , 'string'  , 'Quantidade'))
    AAdd(jDetalhes['fields'], prepareField('c6_prcven' , 'currency', 'Preço'))
    AAdd(jDetalhes['fields'], prepareField('c6_valor'  , 'currency', 'Valor'))
 
    jMenu['detalhes'] := jDetalhes
Return jMenu
 
/*/{Protheus.doc} prepareField
    funcao auxiliar para preparar as propriedades do field
    @type function
    @param cCampo, character, campo
    @param cTipo, character, tipo (string, date, number)
    @param cTitulo, character, titulo
    @param cDivisor, character, titulo do divisor (utilizado nos detalhes)
    @return json, json de field
/*/
Static Function prepareField(cCampo as Character, cTipo as Character, cTitulo as Character, cDivisor as Character)
    Local jField       := JsonObject():new() as Json

    jField["property"] := cCampo
    jField["type"]     := cTipo
    jField["label"]    := cTitulo

    If !Empty(cDivisor)
        jField["divider"] := cDivisor
    EndIf

Return jField
 
/*/{Protheus.doc} prepareStatus
    funcao auxiliar para preparar as propriedades da legenda
    @type function
    @param cValor, character, valor
    @param cCor, character, cor
    @param cTitulo, character, label
    @return variant, rconfiguracao de legenda
/*/
Static Function prepareStatus(cValor as Character, cCor as Character, cTitulo as Character)
    Local jStatus    := JsonObject():new() as Json

    jStatus["value"] := cValor
    jStatus["color"] := cCor
    jStatus["label"] := cTitulo

Return jStatus
#Include 'Protheus.ch'  

/*/{Protheus.doc} PCQRY01
	Query para listar os itens do PE PCBROWSE
	@type function
	@return character, query
/*/
User Function PCQRY01()
	Local aSA1   := Paramixb[1] // Array de clientes {{"D MG    ", "000002", "02"}, {"D RJ    ", "000002", "12"}}
	Local cLogin := Paramixb[2] // Login do portal 
	Local cQuery := ""
	Local cAlias := "SC5"
	Local nCli   := 1
	Local cOr    := ""

	cQuery := " SELECT #QueryFields#  "
	cQuery += " FROM " + RetSqlName(cAlias) + " SC5 "
	cQuery += " WHERE SC5.D_E_L_E_T_ = ' ' AND "
	cQuery += "("

	// lógica para filtro utilizando os código de clientes
	For nCli := 1 to len(aSA1)

		If (nCli > 1)
			cOr := " OR "
		EndIf

		cQuery +=  cOr + "(SC5.C5_CLIENTE = '" + aSA1[nCli][2] + "' AND SC5.C5_LOJACLI = '" + aSA1[nCli][3]+"')" 
	Next

	cQuery += ")"
	cQuery += " #QueryWhere# "

Return cQuery

/*/{Protheus.doc} PCITEM
	Query para listar os detalhes do item do PE PCBROWSE
	@type function
	@return character, query
/*/
User Function PCITEM()
    Local aSA1    := Paramixb[1] // Clientes
    Local cUser   := Paramixb[2] // Login do portal
    Local jFilter := Paramixb[3] // Linha selecionada para os detalhes
    Local cAlias  := "SC6"

    cQuery := " SELECT #QueryFields#  "
    cQuery += " FROM " + RetSqlName(cAlias) + " " + cAlias
    cQuery += " WHERE  " + cAlias + ".D_E_L_E_T_ = ' ' AND "
    cQuery += " C6_FILIAL = '" + jFilter['C5_FILIAL'] + "' AND "
    cQuery += " C6_NUM = '" + jFilter['C5_NUM'] + "'"
    cQuery += " #QueryWhere# "
Return cQuery