Conteúdo

01. Visão Geral

Essa rotina permite que o advogado possa cadastrar as rotinas customizadas e as mesmas serem disponibilizadas no TOTVS Jurídico Departamentos.

Possuindo dois propósitos desse cadastro, sendo eles:

Listar e manipular os cadastros básicos customizados na tela de Gestão de cadastros básicos.
Listar e manipular cadastros customizados vinculados à um processo por meio de uma ação do resumo do processo.

02. Exemplo de Utilização

O cadastro de Rotinas customizadas, possui as seguintes operações:

Inclusão
Alteração
Exclusão
Pesquisar
Lista das rotinas customizadas

O acesso ao cadastro de rotinas customizadas feito pelo menu de Cadastros Básicos:

Para visualizar a lista de rotinas customizadas, basta clicar no menu configurações e então clicar em rotinas customizadas.
Para alterar uma rotina customizada, é preciso clicar no ícone de edição que fica à direita do registro na listagem e então alterar as informações necessárias.

03. Principais Campos

No formulário de rotina customizada, temos os seguintes campos:

Campo	Descrição	Obrigatório
Rotina	Rotina em MVC Vide aqui a seção de orientações para mais informações referente à rotina em MVC	Sim
Titulo	Título da rotina customizada O mesmo será disponibilizado na listagem de cadastros ou na ação do resumo de processo	Sim
Descrição	Informe uma breve descrição da rotina O mesmo será disponibilizado na listagem de cadastros	Sim
Disponível em:	Selecione aonde será disponibilizada a rotina customizada, sendo possível em: 1- Cadastros básicos 2- Resumo do Processo	Sim
Chave relacional ao CAJURI (FK)	Informe a chave que será relacionada ao Código do assunto jurídico Por essa chave que será feito o relacionamento e o filtro dos registros da rotina customizada Obs.: Esse campo só será apresentado quando a disponibilidade for em Processo.	Não

04. Tela - Lista de rotinas customizadas

Lista de rotinas customizadas

Descrição

Nesta tela, temos as seguintes informações:

Botão +Incluir novo que é responsável por abrir o formulário para cadastrar uma nova rotina.
Pesquisa: por meio dessa pesquisa é possível filtrar os registros conforme a palavra chave informada.
Lista de rotinas customizadas:
1. Rotina
2. Título
3. Descrição
4. Disponível em?
5. Ícone: permite realizar alteração da rotina customizada
6. Ícone: permite realizar exclusão da rotina customizada
7. Ícone: caso a rotina for do tipo cadastro básico, será disponibilizado esse ícone para abrir uma nova aba de seu navegador para a pagina referente à esse cadastro selecionado

05. Tela - Inclusão de rotina customizada

Inclusão via lista de cadastros	Descrição
	Para cadastrar uma nova rotina customizada, o usuário pode realizar através da pagina Gerenciar cadastros básicos clicando na ação "+ Novo registro" da seção de rotinas customizadas.
Inclusão via listagem de rotinas customizadas	Descrição
	Para cadastrar uma nova rotina customizada, o usuário pode realizar através do botão "+Incluir novo"
Preenchimento do formulário	Descrição
	Para iniciar a inclusão de uma rotina customizada, o formulário se encontra bloqueado, permitindo apenas informar a rotina. Deve-se informar uma rotina válida para desbloquear os demais campos Vide aqui a seção de orientações para mais informações referente à rotina em MVC
	Após informado a rotina customizada, serão carregados os dados de título e descrição como sugestão. Podendo alterar os mesmos. O título se baseia conforme informado na descrição da View da rotina Ex,: oView:SetDescription('ROTINA CUSTOMIZADA PROCESSO') Para a seção de "disponível em", deve-se atentar se essa rotina customizada deverá ser apresentada nos cadastros básicos ou será apresentado nas demais ações do resumo do processo.
	Quando selecionado disponível em processo, será apresentado o campo de Chave relacional ao CAJURI (FK). Esse campo se torna obrigatório para o funcionamento da rotina. Com essa chave que será feito o relacionamento entre o cadastro customizado com o processo posicionado.
Preenchimento do formulário	Descrição
	Na seção de campos para pesquisa, deve-se informar os campos que serão utilizados para pesquisa dos registros dessa rotina customizada. Para incluir um campo, basta clicar no botão "Incluir campo" do lado direito
	Ao clicar no botão, será disponibilizado um formulário para selecionar os campos desejados, Os campos disponíveis, serão conforme a tabela selecionada no modelo principal da rotina Caso deseja que o mesmo seja disponibilizado de forma dinâmica do breadcrumb da alteração do registro desta rotina, deve-se alterar o interruptor para que ele fique ativo. Exemplo de um breadcrumb: Para incluir, basta preencher qual campo deseja e clicar no botão "+Incluir"
	Na listagem de campos, é possível verificar os seguintes dados: Campo: Código do campo cadastrado no modelo da rotina Nome: Título do campo definido no modelo da rotina Breadcrumb?: Se esse campo será disponibilizado no breadcrumb Ícones: Editar:Caso deseja editar o campo (vide próxima seção) Excluir:Caso deseja editar o campo (vide próxima seção)
Operações da listagem de campos	Descrição
	Ao clicar no ícone para editar o campo será apresentado o formulário de edição do campo, podendo apenas alterar se ele será incluso no breadcrumb ou não. Caso clicar no botão Cancelar, não será feito nenhuma alteração Caso clicar no botão alterar, o mesmo campo será ajustado, e a listagem será atualizada.
	Ao clicar no ícone para excluir o campo. Será apresentado uma pergunta se realmente deseja excluir esse campo Caso clicar no botão Cancelar, não será feito nenhuma alteração Caso clicar no botão Confirmar, o mesmo campo será removido da listagem.
Salvar a inclusão	Descrição
	Ao preencher todas as informações necessárias, O botão salvar no lado inferior direito será habilitado Basta clicá-lo para confirmar a gravação. Caso sucesso, será redirecionado para a tela anterior, conforme selecionado o meio de inclusão (as duas primeiras seções deste tópico)

06. Tela - Alteração da rotina customizada

Alteração da rotina customizada

Descrição

Para alterar ou visualizar um registro, o usuário pode realizar esta operação através da tela de listagem, no ícone localizado à direita do registro.

Ao clicar no ícone do registro em que deseja, o sistema fará o redirecionamento para a pagina do formulário da rotina customizada. Onde poderá atualizar ou visualizar as informações.

Após realizar a alteração das informações, clique em salvar para que efetive a alteração das informações.

Após salvo, será redirecionado para a pagina anterior.

Na pagina do cadastro é possível realizar a exclusão através do botão excluir.

Ao clicar no botão excluir é apresentado uma pergunta ao usuário, se realmente deseja realizar a operação de exclusão da equipe.

Ao confirmar a exclusão, será redirecionado para a pagina anterior.

07. Exclusão da rotina customizada

Exclusão via listagem	Descrição
	Para excluir um registro, o usuário pode realizar esta operação através da tela de listagem, no ícone localizado à direita do registro.
	Ao clicar no ícone do registro em que deseja, o sistema perguntará se realmente deseja excluir esse registro Caso confirme a exclusão, a listagem será recarregada.
Exclusão via alteração	Descrição
	Para excluir um registro, o usuário pode realizar esta operação através da tela de listagem, no ícone localizado à direita do registro, abrindo o formulário desse registro
	No final do formulário, possui o botão "Excluir", basta clica-lo e será apresentado uma pergunta se realmente deseja excluir esse registro. Caso confirme a exclusão, será redirecionado para a tela anterior

08. Orientações

Rotina MVC

Para o correto funcionamento, é necessário que a rotina tenha sido desenvolvida em MVC e a mesma rotina possua inclusive a ViewDef.
Sempre defina o id do modelo o mesmo nome do fonte.
Para utiliza-lo na aplicação do TOTVS Jurídico, é necessário que publique-o.
Na publicação, informe que o objeto de referencia seja o JURMODREST, para que seja possível utilizar as funções de buscas corretas.
O modelo principal da rotina (Owner) sempre deverá possuir na identificação o conteúdo "MASTER", é por ele que a rotina se baseia.

Exemplo de rotina MVC

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

//Publicação do modelo para utilizar o FwRestModel, herdando a classe JurModRest
PUBLISH USER MODEL REST NAME CUSTOMZZ1_RDM SOURCE CUSTOMZZ1_RDM RESOURCE OBJECT JurModRest

//------------------------------------------------------------------------------
/*/{Protheus.doc} CUSTOMZZ1_RDM
Rotina customizada de exemplo
/*/
//------------------------------------------------------------------------------
Function CUSTOMZZ1_RDM()
Local oBrowse := FWMBrowse():New()

oBrowse:SetAlias('ZZ1')

oBrowse:SetMenuDef('CUSTOMZZ1_RDM')
oBrowse:SetDescription('Rotina customizada')

oBrowse:Activate()
oBrowse:Destroy()

Return

//------------------------------------------------------------------------------
/*/{Protheus.doc} MenuDef
Função responsável pela definição do menu
@return aRotina, retorna as opções do menu
/*/
//------------------------------------------------------------------------------
Static Function MenuDef()
Local aRotina := {} 

	ADD OPTION aRotina TITLE 'Visualizar'	ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_VISUALIZAR	ACCESS 0 // Visualizar
	ADD OPTION aRotina TITLE 'Incluir'		ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_INCLUIR		ACCESS 0 // Incluir
	ADD OPTION aRotina TITLE 'Alterar'		ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_ALTERAR		ACCESS 0 // Alterar
	ADD OPTION aRotina TITLE 'Excluir'		ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_EXCLUIR		ACCESS 0 // Excluir

	ADD OPTION aRotina TITLE 'Pesquisar'	ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_PESQUISAR	ACCESS 0 // Pesquisar
	ADD OPTION aRotina TITLE 'Imprimir'		ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_IMPRIMIR	ACCESS 0 // Imprimir
	ADD OPTION aRotina TITLE 'Cópia'		ACTION 'VIEWDEF.CUSTOMZZ1_RDM' OPERATION OP_COPIA		ACCESS 0 // Cópia

Return aRotina

//------------------------------------------------------------------------------
/*/{Protheus.doc} ModelDef
Função responsável pela definição do modelo
@return oModel, retorna o Objeto do Menu
/*/
//------------------------------------------------------------------------------
Static Function ModelDef()
Local oModel	:= nil
Local oStrZZ1	:= FWFormStruct(1,'ZZ1')

oModel := MPFormModel():New('CUSTOMZZ1_RDM', /*bPreValidacao*/, /*bPosValid*/, /*bCommit*/, /*bCancel*/ )

oModel:AddFields('ZZ1MASTER',/*cOwner*/,oStrZZ1,/*bPre*/,/*bPos*/,/*bLoad*/)

oModel:SetDescription('ROTINA CUSTOMIZADA PROCESSO')

oModel:GetModel('ZZ1MASTER'):SetDescription('ROTINA CUSTOMIZADA PROCESSO')

Return oModel

//------------------------------------------------------------------------------
/*/{Protheus.doc} ViewDef
Função responsável pela definição da view
@version 1.0
@return oView, retorna o Objeto da View
/*/
//------------------------------------------------------------------------------
Static Function ViewDef()
Local oView		:= FWFormView():New()
Local oModel	:= FwLoadModel('CUSTOMZZ1_RDM')
Local oStrZZ1	:= FWFormStruct(2, 'ZZ1')

oView:SetModel(oModel)

oView:AddField('VIEW_ZZ1' ,oStrZZ1,'ZZ1MASTER')

oView:CreateHorizontalBox('TELA', 100)

oView:SetOwnerView('VIEW_ZZ1','TELA')

oView:SetDescription('ROTINA CUSTOMIZADA PROCESSO') //'ROTINA CUSTOMIZADA PROCESSO'

Return oView

Chave relacional CAJURI

Deve-se informar apenas os campo referente à filial e ao código do assunto jurídico, concatenados pelo caractere mais "+", informando-os pela sempre pela sequencia filial + cajuri

Árvore de páginas

TOTVS Jurídico Departamentos - Cadastro de rotinas customizadas