CONTEÚDO

1. Visão Geral
2. Pré-requisitos
3. Menu
4. Restrições
   1. Cadastro das Rotinas Customizadas
   2. Consulta da Rotina Cadastrada 
      
5. Tabelas utilizadas

01. VISÃO GERAL

O Cadastro de Rotinas customizadas tem por objetivo permitir que o usuário cadastre Rotinas Customizadas em MVC no formato do PagPFS (em PO-UI).

02. PRÉ-REQUISITOS

Para a utilização da tela é necessário realizar as configurações do Contas a Pagar para Escritórios de Advocacia - PagPFS. 

03. MENU

Para utilizar o cadastro de Rotinas Customizadas é necessário criar uma opção de Menu chamando a função PFSAPPCROT.

04. RESTRIÇÕES

O cadastro de Rotinas Customizadas contem duas principais funcionalidades:

• Cadastrar as rotinas customizadas
• Consultar as rotinas cadastradas e permitir a Visualização/Inclusão/Alteração/Exclusão dos registros.

Porem é necessário obedecer algumas restrições para utilizar a nova funcionalidade da melhor forma possível.

a. Cadastro das Rotinas Customizadas

No campo Rotina MVC o usuário deve informar o nome da Rotina que será invocada na Consulta da rotina. A rotina obrigatoriamente tem de ser MVC (Model View Controller). 

Logo abaixo é apresentado uma tabela que será preenchida por Campos que serão utilizados no Filtro da Consulta da Rotina. Esses campos obrigatoriamente tem de ser da Rotina indicada no campo Rotina MVC.

Os campos apresentados no Campo Chave também serão validados, verificando se existem no modelo apresentado.

A Rotina MVC obrigatoriamente tem de ter um Modelo com o pós fixo "MASTER" conforme exemplo abaixo. Se a rotina não tiver um modelo MASTER o sistema não irá encontrar a estrutura.

Obs: A rotina precisa estar publicada e disponível para consultas REST. Para disponibilizar o modelo siga a documentação do FWRestModel.

b. Consulta da Rotina Cadastrada

Na consulta da Rotina o usuário irá visualizar todos os registros da rotina. Para controle das colunas no Grid só serão demonstradas as colunas que estão marcadas como Browse igual a "Sim".

Na tela de Cadastro da Rotina MVC o sistema irá interpretar a Estrutura MVC obedecendo os seguintes critérios:

• Campos virtuais: Nenhum campo virtual será demonstrado em tela.
• Campos F3: Campos com consulta padrão serão disponibilizados em Combos. Os combos irão reproduzir a consulta original e retorna os 10 primeiros resultados. Para filtrar melhor a busca o usuário terá de digitar no campo.
• Campos com CBOX: Campos com combo pré-definido (X3_CBOX) serão disponibilizados em Bullets (RadioButtons) com as opções abertas no Formulário.

O botão de Salvar somente será habilitado após os campos obrigatórios serem preenchidos.

Ao clicar em Salvar o sistema irá rodas as todas as validações do modelo original.

As regras de When (X3_WHEN) ou Gatilhos (SX7) não serão reproduzidas na tela de cadastro.

05. TABELAS UTILIZADAS

• OHX - Cadastro de Rotinas Customizada
• OHY - Filtro da Rotina Customizada

#INCLUDE "PROTHEUS.CH"
#INCLUDE "FWMVCDEF.CH"

//-------------------------------------------------------------------
/*/{Protheus.doc} JMODTST
Modelo de Teste
/*/
//-------------------------------------------------------------------
Function JMODTST()
    Local oBrowse := FwLoadBrw("JMODTST")

    oBrowse:Activate()

Return Nil

//-------------------------------------------------------------------
/*/{Protheus.doc} MenuDef
Menu Funcional

/*/
//-------------------------------------------------------------------
Static Function MenuDef()
	Local aRotina := {}
Return (aRotina)

//-------------------------------------------------------------------
/*/{Protheus.doc} ViewDef
Modelo de exemplo
/*/
//-------------------------------------------------------------------
Static Function ViewDef()
	Local oStructFKF := FWFormStruct(2, "Z01")
	Local oModel     := FWLoadModel("JMODTST")
	Local oView      := Nil
	
	oView := FWFormView():New()
	oView:SetModel(oModel)
	oView:AddField("JMODTST_VIEW", oStructFKF, "Z01MASTER")
	oView:CreateHorizontalBox("FORMFIELD", 100)
	oView:SetOwnerView("JMODTST_VIEW", "FORMFIELD")
	oView:SetDescription("Teste Rotinas Customizadas") 
	oView:EnableControlBar(.T.)

Return (oView)

//-------------------------------------------------------------------
/*/{Protheus.doc} ModelDef
Modelo de exemplo
/*/
//-------------------------------------------------------------------
Static Function Modeldef()
	Local oStructFKF := FWFormStruct(1, "Z01")
	Local oModel     := NIL
	
	oModel:= MPFormModel():New("JMODTST", /*Pre-Validacao*/, {|oModel| JMODTSTOK(oModel)}/*Pos-Validacao*/, /*Commit*/, /*Cancel*/)
	oModel:AddFields("Z01MASTER", Nil, oStructFKF, /*Pre-Validacao*/, /*Pos-Validacao*/)
	oModel:SetDescription("Teste Rotinas Customizadas") 
	oModel:GetModel("Z01MASTER"):SetDescription("Teste Rotinas Customizadas") 

	oModel:SetPrimaryKey({'Z01_FILIAL','Z01_IDDOC'})

Return (oModel)

//-------------------------------------------------------------------
/*/{Protheus.doc} JMODTSTOK
Exemplo de Validação de modelo

/*/
//-------------------------------------------------------------------
Static function JMODTSTOK(oModel)
Local lRet      := .T.
Local nOpc      := oModel:GetOperation()
Local oModelZ01 := oModel:GetModel("Z01MASTER")

	If nOpc < 5
		If Upper(AllTrim(oModelZ01:GetValue("Z01_TXTOBG"))) == "ERROR"
			lRet := JurMsgErro(EncodeUTF8("Erro de validação do campo"))
		EndIf
	EndIf

Return lRet