PCINVREL – Configuración de informes en las facturas del Portal del cliente

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 PCINVREL permite definir los informes que se pondrán a disposición en las acciones de los títulos 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.

Atención

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-pdf como estándar.

Parámetros disponibles en la función de download (Función informada 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
3º Posición	Carácter	Nombre de la tabla que está activando el punto de entrada. (SF2)
4º Posición	Carácter	Clave de la tabla separada por PIPE "\|"

03. EJEMPLO DE UTILIZACIÓN

PCINVREL

/*/{Protheus.doc} User Function PCINVREL
    Se utiliza para creación de informes en las facturas del Portal del cliente - FIN.

    @type user function
    @author Totvs
    @since 09/10/2023
    @version 1.0
    @see https://tdn.totvs.com/pages/viewpage.action?pageId=794380059
/*/
User Function PCINVREL()
	Local aRelatorios := {} as Array
	Local aClientes   := PARAMIXB[1] as Array     // lista de de clientes seleccionados en el portal
	Local cUsuario    := PARAMIXB[2] as Character // código de usuario del portal

	//[1] titulo; [2] user function; [3] po-ui icon, default po-icon-pdf (https://po-ui.io/guides/icons)
	AADD(aRelatorios, {"Documento", "PCINV01"}) //Nombre de la función sin U_
	AADD(aRelatorios, {"Produtos" , "PCINV02", "po-icon po-icon-cart"}) //Nombre de la función sin U_
Return aRelatorios

INFORME

#Include "Protheus.ch"

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

    @type user function
    @author Totvs
    @since 09/10/2023
    @version 1.0
/*/
User Function PCINV01()
	Local cCaminho  := ""          as Character
	Local aClientes := PARAMIXB[1] as Array      // lista de clientes seleccionados en el portal
	Local cUsuario  := PARAMIXB[2] as Character  // código de usuario del portal
	Local cTable    := PARAMIXB[3] as Character  // Tabla
	Local cKey      := PARAMIXB[4] as Character  // Clave de la tabla separado por PIPE F2_FILIAL|F2_DOC|F2_SERIE|F2_CLIENTE|F2_LOJA
	Local aKey      := {}          as Array
	// transforma a chave em array ficand [1]F2_FILIAL;[2]F2_DOC;[3]F2_SERIE;[4]F2_CLIENTE;[5]F2_LOJA
	aKey := StrTokArr2(cKey, "|", .T.)

	// lógica para generar el informe

	cCaminho := "spool/PCINV01_001.pdf"

Return cCaminho

Atalhos

Árvore de páginas