Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Informações Gerais
Especificação | |||
Produto | Microsiga Protheus | Módulo | SIGAJURI |
Segmento Executor | Gestão Jurídica | ||
Projeto1 | M_JUR_JUR001 | IRM1 | PCREQ-4266 |
Requisito1 | PCREQ-4267 | Subtarefa1 |
|
Release de Entrega Planejada | 12.1.7 | Réplica |
|
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. |
Objetivo
Permitir que atividades sejam executadas e aprovadas através do FLUIG.
Definição da Regra de Negócio
Atividades/Pendências serão incluídas através do SIGAJURI e poderão ser acompanhadas e sofrer interações (aprovações) através do FLUIG.
Criação de WIDGET de aprovadores de atividades
Criar uma WIDGET com dataset no FLUIG para configurar as aprovações do SIGAJURI. O formulário deve conter os seguintes campos:
Widget de configuração de aprovações | ||
Campo | Descrição | Origem |
Assunto Jurídico | Tipo de assunto jurídico do SIGAJURI. Se não for preenchido, entende-se que a configuração vale para todos os assuntos jurídicos. | Combo com dados preenchidos através de WS do SIGAJURI (NYB). |
Tipo de Follow-Up | Tipo de Follow-up do SIGAJURI. Campo Obrigatório. | Combo com dados preenchidos através de WS do SIGAJURI (NQS). |
Grupo Aprovador | Grupo de usuários do FLUIG. Deverá ser usado para determiner a área do participante. | FLUIG |
Papel Aprovador | Papel cadastrado no FLUIG. Deverá ser usado para determinar o cargo do participante. | FLUIG |
Ordem | Campo numérico que determina a ordem de aprovação. Deve ser usado caso exista mais de um aprovador. | FLUIG |
Faixa de Valor | Devem ser criados dois campos para determiner uma faixa de valor que deve ser utilizada para controle de alçada. | FLUIG |
Alterações no cadastro de Resultados de Follow-up (JURA017/NQN)
Alterar o cadastro de resultados de follow-up para incluir uma nova opção no campo NQN_TIPO (4 – Em Aprovação). O cadastro dos tipos de resultados deve ser validado para que seja possível incluir apenas um resultado com esta opção no campo NQN_TIPO. Ver protótipo 02.
Alteração no cadastro de tipo de follow-up (JURA021/NQS)
Para melhorar a interface de configuração dos tipos de follow-up, algumas alterações precisam ser feitas no dicionário e fonte JURA021. No fonte, é preciso mudar a proporção do formfield e do formgrid, para 70 e 30 porcento, respectivamente.
Criar os seguintes agrupamentos:
1- Geral
2- Andamento
3- Correspondentes
4- Fluig
Ver protótipo 04.
Alterações no cadastro de Follow-Up (JURA106/NTA)
Todos os compromissos do SIGAJURI são controlados usando o cadastro de follow-up. Para que os usuários vejam suas tarefas dentro do FLUIG e no SIGAJURI, este cadastro será integrado via workflow de atividades. Será possível que sejam executadas tarefas quando um follow-up for aprovado ou cancelado. Para permitir que tarefas sejam executadas, criar a tabela NZK (Tarefas Follow-Up) e incluir ela no modelo JURA106 como filho (detalhe) do modelo NTAMASTER. Este modelo não deve estar disponível na tela. Ele será utilizado apenas no model para ser usado nas inclusões de tarefas e execuções da mesma.
Criar um campo chamado NTA_CODWF para armazenar o id da atividade criada no FLUIG que corresponde ao follow-up.
O fluxo da inclusão de follow-up deve ficar da seguinte forma:
1- Ao término de cada inclusão de follow-up, deve ser validado:
- O parâmetro MV_JFLUIGAP está habilitado?
i. Sim
- Qual o Resultado do Follow-up?
- Se o tipo do resultado (NQN_TIPO) for “Pendente” ou “Em Aprovação”
i. Abrir um workflow no FLUIG usando como id de formulário o parâmetro MV_JWFAPRV. Os campos devem ser preenchidos de acordo com o a regra de preenchimento na tabela de campos do formulário, descrita neste documento.
- Caso contrário não deve ser aberto o workflow
ii. Não
- Nenhuma validação é necessária.
Será criado um web service que vai receber chamadas do FLUIG, informando o status do follow-up para que as alterações necessárias possam ser realizadas.
O fluxo da alteração de follow-up deve ficar da seguinte forma:
1- Ao término de cada alteração do campo Resultado de follow-up (NQN_CRESUL), deve ser validado:
- O campo NTA_CODWF está preenchido?
i. Sim
- Se o tipo do resultado (NQN_TIPO) foi alterado de “Pendente” ou “Em Aprovação” para “Concluído” ou “Cancelado”
- Se for “Cancelado”
i. Não há nada a fazer.
- Se for “Concluído”
i. Avaliar os dados do modelo da tabela NZK e realizar as operações de alteração de dados que estiverem cadastradas na tabela para o status escolhido.
ii. Origem da alteração é o FLUIG?
- Verificar se existe sugestão de andamento vinculada ao tipo de Follow-up (NQS_CSUGES)
- Se o campo estiver preenchido, um andamento (NT4) deve ser incluído (JURA100).
i. A descrição do andamento (NT4_DESC) deverá ser preenchida com o campo de Observações do Executor do WorkFlow do FLUIG.
ii. Preencher a tabela NZL com o código do WorkFlow e campo que deve ser preenchido no FLUIG com o conteúdo do campo NT4_DESC.
- Se o tipo do resultado (NQN_TIPO) for alterado de “Em Aprovação” para “Pendente”.
- Os dados cadastrados no modelo de tarefas (NZK) deve ser apagado. O mesmo será alimentado quando a ação que originou o follow-up for realizada novamente.
ii. Não
- Nenhuma validação é necessária.
O fluxo de exclusão de follow-up deve ficar da seguinte forma:
1- O campo NTA_CODWF está preenchido?
- Sim
i. Consultar o FLUIG e cancelar o WF caso o mesmo esteja em execução ainda.
- Não
i. Nenhuma validação é necessária.
Validações da tela de cadastro de follow-up
Criar uma função para ser utilizada na propriedade WHEN do campo NTA_CRESUL de forma que o mesmo fique desabilitado quando um follow-up estiver com o campo NTA_CODWF estiver preenchido e o tipo de resultado do follow-up for “Pendente” ou “Em Aprovação”. A alteração só deverá ser permitida quando a alteração for feita através do WebService do Protheus, chamado pelo FLUIG.
Alterações no cadastro de Follow-Up (JURA106/NTA)
Criar a tabela NZL para guardar o retorno que deve ser enviado ao FLUIG quando o andamento for incluído. Incluir esta tabela no modelo JURA106 como detalhe do modelo NT4MASTER. Este modelo deve estar disponível apenas na model e não na view, para que não seja exibida na interface do usuário.
Abaixo o fluxo da inclusão de andamentos:
1- Ao término de cada inclusão de um andamento, deve ser validado:
- O parâmetro MV_JFLUIGAP está habilitado?
i. Sim
- Existem linhas no modelo NZLDETAIL?
- Sim
i. Acessar o serviço do FLUIG, utilizando como formulário o campo NZL_CODWF e preencher a informação descrita no campo NZL_DCAMPO com a informação do campo NT4_DESC.
ii. Alterar o campo NZL_STATUS para ‘1’ para indicar que a operação foi realizada.
- Não
i. Não há nada a fazer.
Criação de WebService para consulta de informações do SIGAJURI
Criar um WebService chamado WSFLUIGJURIDICO, que conterá diversos métodos para que o FLUIG pegue informações necessárias para montar os objetos na tela, para WIDGETS de configuração e formulários de WORKFLOW. Segue lista dos mesmos:
Lista de serviços que precisam ser consumidos pelo FLUIG | ||
Informação | Descrição | Origem |
Assuntos Jurídicos | Este método deve enviar como resposta a lista dos assuntos jurídicos cadastrados na tabela NYB. | Deve ser enviados os campos NYB_COD e NYB_DESC. |
Tipos de Follow-Up | Este método deve enviar como resposta a lista dos tipos de follow-up cadastrados na tabela NQS. | Deve ser enviados os campos NQS_COD e NQS_DESC. |
Criação de WebService de sincronização de atividades do SIGAJURI
Criar um método no WebService no Protheus WSFLUIGJURIDICO que será consumido pelo FLUIG sempre que uma atividade sofrer alteração. O WebService receberá o código do follow-up com a filial e o status que a atividade se encontra, sendo 1 – Pendente, 4 – Em Aprovação, 2 – Concluída e 3 – Cancelada.
O WebService vai receber a chamada do FLUIG e deve carregar o modelo JURA106 e efetuar as alterações que vieram do FLUIG.
Workflow de Atividades
Criação de um workflow no FLUIG para controlar execução e aprovação de atividades (follow-up), conforme protótipo 1 e 03, que será iniciado através do SIGAJURI. Criar um parâmetro chamado MV_JWFATV do tipo caracter, que será responsável por armazenar o código identificador deste workflow no FLUIG. O workflow de atividades pode ser iniciado na fase de execução ou ir direto para a fase de aprovação, quando tratar-se de uma aprovação de atividades que já foram executadas no SIGAJURI. No caso de Follow-Up, a tarefa sempre começa na fase de execução. O que pode acontecer é ser movimentada para aprovação se a execução for registrada pelo SIGAJURI.
Abaixo uma descrição das informações que o workflow devde ter e que devem ser preenchidas quando uma atividade do mesmo for iniciada:
Workflow de atividades | |||
Campo | Descrição | Visível | Regra de Preenchimento |
Cod Follow-up SIGAJURI | Código (Chave) do follow-up criado no SIGAJURI, da tabela NTA | Não | Recebido do Protheus, campo NTA_COD |
Status Atividade | Campo interno que identifica se a tarefa foi aprovada ou reprovada. 1 – Pendente, 4 – Em Aprovação, 2 – Concluída e 3 – Cancelada. Esta informação é utilizada nas interações FLUIG – SIGAJURI | Não | Recebido do Protheus. Campo NQN_TIPO. |
Serviço Protheus | Caminho do serviço que deve ser chamado no Protheus nas chamadas FLUIG -> PROTHEUS | Não | A DEFINIR |
Num Solicitação | Campo gerado automaticamente pelo FLUIG quando uma instância do workflow é criada | Sim, somente leitura. |
|
Data Inclusão | Campo gerado automaticamente pelo FLUIG quando uma instância do workflow é criada | Sim, somente leitura. |
|
Usuário Executor | Campo que mostra o usuário responsável pela atividade | Sim, somente leitura. | Campo preenchido pelo Protheus. Utilizar o responsável do follow-up, da tabela NTE, relacionada com a NTA. |
Prazo tarefa | Data prazo para a execução da atividade. Deve ser informado pelo Protheus. No caso de follow-up, a data do follow-up. | Sim, somente leitura. | Campo enviado pelo Protheus. Deve ser usado a data do follow-up da tabela NTA. (NTA_DTFLWP) |
Prazo Aprovação | Data prazo para aprovação da tarefa. Deve ser informado pelo Protheus. | Sim, somente leitura. | Campo enviado pelo Protheus. Usar campo NQS_DPRAZO. |
Tipo | Campo do tipo caracter que deve receber informações sobre a atividade do SIGAJURI. No caso de follow up, Follow-Up - <Descrição Tipo Follow-up>. | Sim, somente leitura. | Campo preenchido através do Protheus. Deve ser enviada a descrição do tipo de follow-up, conteúdo do campo virtual NTA_DTIPO |
Status | Campo do tipo caracter que indica se o workflow está na fase de execução ou aprovação | Sim, somente leitura. | Deve ser preenchido pelo FLUIG com base no campo interno Status Atividade. |
Solicitante | Usuário que incluiu a atividade | Sim, somente leitura. | Deve ser preenchido pelo Protheus, utilizando o usuário de inclusão de follow-up. Campo NTA_USUINC. |
Código Jurídico | Cliente/Caso do assunto jurídico, relacionado com a atividade que será executada. | Sim, somente leitura. | Deve ser preenchido pelo Protheus, utilizando o cliente/caso na tabela NSZ (NSZ_CCLIEN+NSZ_CLOJA+ ”/” + NSZ_NUMCAS). |
Descrição Atividade | Descrição do que deve ser feito na atividade. No acso de follow-up, deve ser preenchido com o conteúdo do campo descrição do Follow-up. | Sim, somente leitura. | Deve ser preenchido pelo Protheus, utilizando o campo de descrição do follow-up. (NTA_DESC) |
Complemento | Dados complementares a solicitação, no caso de processos, informações básicas sobre o processo: Partes envolvidas, Detalhamento do Objeto e Último andamento (Data + Descrição). | Sim, somente leitura. | Deve ser preenchido pelo Protheus, utilizando uma descrição padrão de resumo do processo que está definida neste documento. |
Observações Executor | Campo onde o executor da tarefa pode escrever informações pertinentes a atividade executada. | Sim, edição para o executor e somente leitura para o aprovador. | Quando o follow-up for incluído automaticamente através de outras rotinas, este campo receberá a informação do campo descrição de follow-up (NTA_DESC). |
Observações Aprovador | Campo onde o aprovador da tarefa pode escrever informações pertinentes a aprovação da atividade. | Sim, edição para o aprovador e somente leitura para o executor. |
|
Pasta Caso {sPastaCaso}
| Campo que deve receber do Sigajuri o id da pasta do caso criada no FLUIG para o mesmo. | Não | Quando o workflow for iniciado, preencher com o valor do campo NZ7_LINK, relacionado com os dados de cliente/caso da tabela NSZ. |
Tabelas Utilizadas
- NSZ – Assuntos Jurídicos
- NTA – Follow-up
- NZK – Tarefas Follow-up
- NQS – Tipo de Follow-up
Opcional
Protótipo de Tela
Protótipo 01
Protótipo 02
Protótipo 03
Protótipo 04
Protótipo 05
Protótipo 06
Protótipo 07
Protótipo 08
Opcional
Dicionário de Dados
Arquivo: NTA – Follow-up
Campo | NTA_CODWF |
Tipo | C |
Tamanho | 10 |
Descrição | Código Sol WF |
Título | Código WF |
Picture |
|
Help de Campo | Número da solicitação que identifica o workflow do FLUIG. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Arquivo: NZK – Tarefas Follow-up
Índice | Chave |
01 | NZK_FILIAL+NZK_CFLWP+NZK_STATUS+NZK_FONTE +NZK_MODELO+NZK_CAMPO |
Campo | NZK_FILIAL |
Tipo | C |
Tamanho | 2 |
Descrição | Filial do Sistema |
Título | Filial |
Picture | @! |
Help de Campo | Filial do Sistema |
Usado | Não |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Grupo | 033 |
Campo | NZK_CFLWP |
Tipo | C |
Tamanho | 10 |
Descrição | Codigo do Follow-up |
Título | Codigo FW |
Picture | @! |
Help de Campo | Código do follow-up relacionado as tarefas |
Usado | Sim |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Visualizar |
Inicializador Padrão |
|
Val. Sistema | ExistCpo('NTA',M->NZK_CFLWP,1) |
Grupo |
|
Campo | NZK_STATUS |
Tipo | C |
Tamanho | 1 |
Descrição | Status |
Título | Status |
Picture |
|
Help de Campo | Status das tarefas relacionadas. Desta forma, podem existir tarefas para status diferentes. Ex. Tarefas executadas quando o follow-up for aprovado/concluído ou reprovado. 0 – Em Execução, 1 – Em Aprovação, 2 – Aprovada e 3 – Reprovada. |
Usado | Sim |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZK_FONTE |
Tipo | C |
Tamanho | 10 |
Descrição | Fonte do modelo |
Título | Fonte |
Picture |
|
Help de Campo | Fonte que contém o modelo que será alterado nas tarefas. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZK_MODELO |
Tipo | C |
Tamanho | 30 |
Descrição | Modelo de dados |
Título | Modelo |
Picture |
|
Help de Campo | Nome do modelo do MVC do fonteonde está localizado o campo que deverá ser alterado na tarefa. Ex: NTAMASTER. |
Usado | Sim |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZK_CAMPO |
Tipo | C |
Tamanho | 10 |
Descrição | Campo |
Título | Campo |
Picture |
|
Help de Campo | Campo que deve ser alterado nas tarefas. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZK_VALOR |
Tipo | C |
Tamanho | 200 |
Descrição | Valor |
Título | Valor |
Picture |
|
Help de Campo | Valor que será preenchido no campo do modelo listado na tarefa. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZK_CHAVE |
Tipo | C |
Tamanho | 50 |
Descrição | Chave do registro origem |
Título | Chave |
Picture |
|
Help de Campo | Chave do registro que originou o follow-up. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZK_FILTRO |
Tipo | C |
Tamanho | 100 |
Descrição | Filtro do registro origem |
Título | Filtro |
Picture |
|
Help de Campo | Filtro do registro que originou o follow-up. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Arquivo: NQS – Tipo de Follow-up
Campo | NQS_FILIAL |
Agrupamento | 001 |
Campo | NQS_COD |
Agrupamento | 001 |
Campo | NQS_DESC |
Picture | @S20 |
Agrupamento | 001 |
Campo | NQS_TIPO |
Picture | @S15 |
Agrupamento | 001 |
Campo | NQS_HORAM |
Agrupamento | 001 |
Campo | NQS_DURACA |
Agrupamento | 001 |
Campo | NQS_DESCR |
Agrupamento | 001 |
Campo | NQS_AVALIA |
Agrupamento | 001 |
Campo | NQS_SUGERE |
Agrupamento | 002 |
Campo | NQS_DESCRI |
Agrupamento | 002 |
Campo | NQS_CSUGES |
Agrupamento | 002 |
Campo | NQS_DSUGES |
Agrupamento | 002 |
Campo | NQS_SUGDES |
Agrupamento | 001 |
Campo | NQS_DESPAD |
Agrupamento | 001 |
Campo | NQS_ANTECE |
Agrupamento | 001 |
Campo | NQS_CRESUL |
Agrupamento | 001 |
Campo | NQS_DRESUL |
Agrupamento | 001 |
Campo | NQS_CRESRE |
Agrupamento | 003 |
Campo | NQS_DRESRE |
Agrupamento | 003 |
Campo | NQS_DPRAZO |
Tipo | C |
Tamanho | 3 |
Descrição | Prazo para aprovação |
Título | Prazo Aprovação |
Picture |
|
Help de Campo | Prazo, em dias, para aprovação do follow-up no FLUIG. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Só deve estar disponível caso o parâmetro MV_JFLUIGAP esteja habilitado |
Inicializador Padrão |
|
Val. Sistema |
|
Agrupamento | 004 |
Campo | NQS_TAPROV |
Tipo | C |
Tamanho | 1 |
Descrição | Tipo Aprovação |
Título | Tipo Aprovação |
Picture | @S15 |
Help de Campo | Tipo de aprovação que o tipo de follow-up será responsável. Só pode haver um tipo de follow-up para acda tipo de aprovação. |
Usado | Sim |
Browse | Não |
Obrigatório | Não |
Contexto | Real |
Visual | Só deve estar disponível caso o parâmetro MV_JFLUIGAP esteja habilitado |
Lista de Opções | Criar função para incluir os tipos 1=Alteracao Valor Provisao;2=Aprovacao de despesas;3=Aprovacao de Garantias; 4=Aprovacao de Levantamento ;5=Encerramento |
Val. Sistema |
|
Agrupamento | 004 |
Arquivo: NZL – Retorno Andamento FLUIG
Índice | Chave |
01 | NZL_FILIAL+NZL_CODWF+NZL_DCAMPO+NZL_STATUS |
Campo | NZL_FILIAL |
Tipo | C |
Tamanho | 2 |
Descrição | Filial do Sistema |
Título | Filial |
Picture | @! |
Help de Campo | Filial do Sistema |
Usado | Não |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Grupo | 033 |
Campo | NZL_CODWF |
Tipo | C |
Tamanho | 10 |
Descrição | Codigo do Workflow |
Título | Codigo WF |
Picture | @! |
Help de Campo | Código do WorkFlow que será utilizado no FLUIG para preencher o campo do formulário |
Usado | Sim |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZL_DCAMPO |
Tipo | C |
Tamanho | 100 |
Descrição | Campo FLUIG |
Título | Campo FLUIG |
Picture |
|
Help de Campo | Nome do campo do formulário do FLUIG que deverá ser preenchido com a descrição do andamento. |
Usado | Sim |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão |
|
Val. Sistema |
|
Grupo |
|
Campo | NZL_STATUS |
Tipo | C |
Tamanho | 1 |
Descrição | Status |
Título | Status |
Picture |
|
Help de Campo | Status do preenchimento do campo no FLUIG. 1 – Pendente, 2 – Pendente. |
Usado | Sim |
Browse | Não |
Obrigatório | Sim |
Contexto | Real |
Visual | Alterar |
Inicializador Padrão | ‘2’ |
Val. Sistema |
|
Grupo |
|
Lista de parâmetros | ||
Nome | Descrição | Ação |
MV_JFLUIGAP | Parâmetro que guardará se o FLUIG será utilizado para aprovar follow-up ou não. | Criação |
MV_JWFAPRV | Parâmetro que guardará o id do workflow de aprovação de atividades criado no FLUIG. | Criação |
MV_ECMUSER | Usuario com privilegio de administracao no ECM. | Já existe. |
MV_ECMPSW | Informe a senha do usuario com privilegio de administracao no ECM. | Já existe. |
MV_ECMEMP | Codigo da empresa para integracao com o ECM | Já existe. |
MV_ECMURL | Informe a URL de integracao com o ECM. (Ex http://fluig.com.br:8080/webdesk) | Já existe. |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|