PPE - Melhorias no agendamento de matérias realizado pelo SEI
| Data de elaboração | 28/09/2022 |
|---|---|
| Responsável pelo estudo | Moisés Ferreira Evangelista |
| Equipe do estudo | Caveiras |
| Alvo | PPE - Plataforma de publicação eletrônica |
| Origem |
o que originou o estudo? usar alguma destas classes:
|
| Objetivo | Melhorar o fluxo de agendamento de matérias do SEI |
| Documentação correlata (opcional) |
|
| Observações | observações gerais a respeito do estudo técnico |
1. Introdução
No SEI, eventualmente quando se agenda uma publicação de uma matéria pode ocorrer falha no fluxo da integração entre a aplicação SEI o ServiçoWS (SOAP) e a API-PPE devido a diversas circunstancias, o que pode deixar essa matéria sem a devida publicação no DIOF (Diário Oficial) do dia. Este estudo propõe ações de melhoria no agendamento de matérias que ocorrem no SEI possibilitando um fluxo mais fluído, mapeando cada passo no fluxo trazendo mais clareza sobre o erro que ocorre e também possibilitando ações para determinados problemas.
2. Desenvolvimento
O início do fluxo de agendamento de uma matéria do SEI se dá quando o usuário logado escolhe a data de disponibilização do documento e clica em Salvar, conforme imagem abaixo.
Nesse momento uma requisição com os dados necessários é disparada para a api do PPE, então algumas ações são realizadas como:
- Verifica-se se a secretaria é cadastrada e está adimplente.
- Calcula-se o valor da matéria com base no conteúdo dela.
- Cria-se a matéria e adiciona-se o devido agendamento.
- Gera-se a DARE para as secretarias que são Autarquia e que não estão isentas de cobrança.
Como mostrado acima, existem muitos processos a serem realizados/verificados nessa requisição o que pode causar uma falha no fluxo e assim não agendar de fato a publicação da matéria.
Atualmente na aplicação temos logs de erro para nos apoiar em eventuais casos de falha nesse fluxo, porém a investigação, o entendimento daquilo que aconteceu e a solução para contornar um possível erro ainda é muito dolorosa, exige bastante conhecimento técnico e pode levar um bom tempo.
Esse estudo propõe alguns pontos de melhoria para que seja possível uma visualização mais clara do fluxo de agendamento das matérias em casos de falha, possibilitando algumas ações para alguns pontos de falha aos usuários administradores do PPE
Criar estrutura para armazenar as informações do fluxo do agendamento realizado pelo SEI
Para cada requisição de agendamento será incluída uma linha de registro na tabela de requisição de agendamento com as informações do request, como a secretaria, o protocolo, documento e a data de disponibilização. Para cada step dentro do fluxo será adicionado um registro na tabela de logs do agendamento com as informações do step acionado e a mensagem conforme mapeamento mostrado na imagem abaixo.
Os textos em vermelho iremos considerar como mensagens que indicam falha, isso nos ajuda a mapear possíveis ações dependendo do erro.
Criar tela para listar agendamentos com falha
Uma tela de listagem dos agendamento que ocorreram erro deverá ser incluída nos detalhes do DIOF, onde será possível visualizar e tomar ações de contornos antes da publicação do Diário Oficial.
Mapear falhas pontuais e adicionar ações de correções (Gerar Dare, Tentar Novamente)
Por exemplo, se o último log de um determinado agendamento for Falha na geração da Dare podemos disponibilizar a ação Gerar a Dare individualmente, possibilitando a conclusão do fluxo de agendamento e evitando que essa matéria não entre no DIOF do dia.
Para o caso Secretaria não encontrada, podemos possibilitar o cadastro da mesma. Com a secretaria cadastrada, posteriormente seria possível Tentar novamente, essa ação refaz todo o fluxo, que desta vez vai encontrar a secretaria.
Possibilitar filtro por Protocolo, documento, requisições com erros e requisições sem erros
Na tela de listagem de erros, será possível encontrar qualquer matéria, os filtros propostos permitirão uma ação rápida de resolução da falha
3. Conclusão
A implementação desse estudo, torna mais simples a descoberta de uma possível falha no fluxo de agendamento das matérias do SEI, evidencia a real causa do erro, possibilita uma visualização mais clara e disponibiliza ações rápidas para os principais erros mapeados. Assim a ocorrência de um eventual erro no fluxo pode ser resolvido pela própria aplicação do PPE através do perfil de Administrador do sistema não sendo mais necessária nenhuma ação do desenvolvedor.