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 PCREPORTS permite definir los informes que se pondrán a disposición en el menú Informes del Portal del cliente - SIGAFIN.

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

PARAMIXB

Tipo

Descripción

1º Posición

Array

Contiene un Array con las claves (FILIAL+CODIGO+LOJA) 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


Devolución del punto de entrada:

El punto de entrada debe devolver un Array conteniendo en cada posición otro Array de acuerdo con la siguiente configuración:


Subarray

Obligatoriedad

Descripción

1º Posición

Obligatorio

Nombre del informe (Nombre que se mostrará en el Portal del cliente).

2º Posición

Obligatorio

Nombre de la función que se activará para generación del informe. Debe devolver el camino del archivo generado.

  • Si la función utiliza namespace, es necesario pasar el nombre completo con namespace
  • Si fuera una User Function, no es necesario informar "U_" en el nombre de la función

3º Posición

OpcionalÍcono que se mostrará en el Portal del cliente, utilizar los íconos disponibles en el enlace: https://po-ui.io/guides/icons. Si no se informara se utilizará el ícono po-icon po-icon-news como estándar.


Parámetros disponibles en la función de download (Función informada en el punto de entrada):

Las funciones informadas en el punto de entrada (Función responsable por la generación del informe) tiene acceso a los mismos parámetros enviados en el punto de entrada.

PARAMIXB

Tipo

Descripción

1º Posición

Array

Contiene un Array con las claves (FILIAL+CODIGO+LOJA) 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


03. EJEMPLO DE UTILIZACIÓN

#Include "Protheus.ch"


/*/{Protheus.doc} User Function PCREPORTS
    Utilizado para criação do menu de relatorios no Portal do Cliente - FIN.

    El P.E. debe devolver un array con los objetos para creación del menú,
    siendo la primera posición el título del informe, la segunda posición la función
    que se ejecutará (Debe devolver el camino para download del archivo) y 
    la última posición (opcional) un ícono de acuerdo con la lista: https://po-ui.io/guides/icons.

    @type Function
    @author Totvs
    @since 15/09/2023
    @version 1.0
    @see https://tdn.totvs.com/pages/editpage.action?pageId=789976160
/*/
User Function PCREPORTS()
	Local aRelatorios := {} as Array
    Local aClientes := PARAMIXB[1] as Array
    Local cUsuario := PARAMIXB[2] as Character
    Local nContador := 1 as Numeric
    
    If cUsuario <> "USER.BLOQ"
        For nContador := 1 to Len(aClientes)
            If aClientes[nContador]['codigo'] == '000002'
                AADD(aRelatorios, {'RELATORIO 01', 'PCRFUN1'}) //Nombre de la función sin U_
                AADD(aRelatorios, {'RELATORIO 02', 'PCRFUN2', "po-icon po-icon-credit-payment"}) //Nombre de la función sin U_
                Exit
            EndIf
        Next
    EndIf

Return aRelatorios

/*/{Protheus.doc} User Function PCRFUN1
    Devuelve el camino del archivo generado para download en el Portal del cliente - FIN.

    @type Function
    @author Totvs
    @since 15/09/2023
    @version 1.0
/*/
User Function PCRFUN1()
    Local cCaminho := "" as Character
    Local nContador := 1 as Numeric
    Local aClientes := PARAMIXB[1] as Array
    Local cUsuario := PARAMIXB[2] as Character

    If cUsuario <> "USER.BLOQ"
        For nContador := 1 to Len(aClientes)
            // Lógica para generación del archivo         Next
    EndIf

    cCaminho := "/baseline/PCREPORTS_001.pdf"
Return cCaminho

/*/{Protheus.doc} User Function PCRFUN2
    Devuelve el camino del archivo generado para download en el Portal del cliente - FIN.

    @type Function
    @author Totvs
    @since 15/09/2023
    @version 1.0
/*/
User Function PCRFUN2()
    Local cCaminho := "" as Character
    Local nContador := 1 as Numeric
    Local aClientes := PARAMIXB[1] as Array
    Local cUsuario := PARAMIXB[2] as Character

    If cUsuario <> "USER.BLOQ"
        For nContador := 1 to Len(aClientes)
            // Lógica para generación del archivo         Next
    EndIf

    cCaminho := "/baseline/PCREPORTS_002.pdf"
Return cCaminho