Exibir origem

01. DADOS GERAIS

Linha de Produto:	Microsiga Protheus®
Segmento:	Backoffice
Módulo:	Financeiro
Idiomas:	Português
Função:	Portal do Cliente

02. DESCRIÇÃO

O ponto de entrada PCINVREL permite definir os relatórios que serão disponibilizados nas ações dos títulos do Portal do Cliente - SIGAFIN.

Parâmetros disponibilizados no ponto de entrada:

PARAMIXB	Tipo	Descrição
1º Posição	Array	Contém um Array com as chaves (FILIAL+CODIGO+LOJA) dos clientes selecionados no portal. Cada posição do Array contém um objeto Json com as propriedades: filial, codigo e loja.
2º Posição	Caracter	Usuário de login do Portal do cliente

Retorno do ponto de entrada:

O ponto de entrada deve retornar um Array contendo em cada posição outro Array conforme a seguinte configuração:

Sub-Array

Obrigatoriedade

Descrição

1º Posição

Obrigatório

Nome do relatório (Nome que será apresentado no Portal do Cliente).

2º Posição

Obrigatório

Nome da função que será chamada para geração do relatório. Deve retornar o caminho do arquivo gerado.

Caso a função utilize namespace é necessário passar o nome completo com namespace
Caso seja uma User Function, não é necessário informar "U_" no nome da função

3º Posição

Opcional

Ícone que será apresentado no Portal do Cliente, utilizar os ícones disponíveis no link: https://po-ui.io/guides/icons. Caso não seja informado será utilizado o ícone po-icon-pdf como padrão.

Parâmetros disponíveis na função de download (Função informada no ponto de entrada):

PARAMIXB	Tipo	Descrição
1º Posição	Array	Contém um Array com as chaves (FILIAL+CODIGO+LOJA) dos clientes selecionados no portal. Cada posição do Array contém um objeto Json com as propriedades: filial, codigo e loja.
2º Posição	Caracter	Usuário de login do Portal do cliente
3º Posição	Caracter	Nome da tabela que está acionando o ponto de entrada. (SF2)
4º Posição	Caracter	Chave da tabela separada por PIPE "\|"

03. EXEMPLO DE UTILIZAÇÃO

/*/{Protheus.doc} User Function PCINVREL
    Utilizado para criação de relatorios na notas do Portal do 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 clientes selecionados no portal
	Local cUsuario    := PARAMIXB[2] as Character // código d usuário do portal

	//[1] titulo; [2] user function; [3] po-ui icon, default po-icon-pdf (https://po-ui.io/guides/icons)
	AADD(aRelatorios, {"Documento", "PCINV01"}) //Nome da função sem U_
	AADD(aRelatorios, {"Produtos" , "PCINV02", "po-icon po-icon-cart"}) //Nome da função sem U_
Return aRelatorios

#Include "Protheus.ch"

/*/{Protheus.doc} User Function PCINV01
    Retorna o caminho do arquivo gerado para download no Portal do 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 selecionados no portal
	Local cUsuario  := PARAMIXB[2] as Character  // código d usuário do portal
	Local cTable    := PARAMIXB[3] as Character  // Tabela
	Local cKey      := PARAMIXB[4] as Character  // Chave da tabela 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 gerar o relatório

	cCaminho := "spool/PCINV01_001.pdf"

Return cCaminho