====== Requisito - Gerenciar Documentos ======
===== Descrição =====
Funcionalidade que possibilita criar, editar, visualizar e excluir um processo, seja em lote ou individual.
\\
//Menu / Local de acesso://
eTCE-Web | Processo | Documentos
===== Atores =====
Usuários com acesso ao processo.
===== Telas =====
==== Tela 01 - Gerenciar documentos ====
^Elemento ^Tipo ^Obrigatório ^Valores Possíveis ^Valor Padrão ^Observação |
| Selecionar documento | Lista |Sim | RN03 RN02 | | Lista com os documentos que o usuário terá permissão de criação |
| Destino | Lista | Sim, se habilitar | Setores cadastrados na aplicação | Desabilitado | Lista com os nomes dos setores que o documento irá ser enviado. |
| Criar documento | Botão | | | | |
| Processo(s) | Tabela | | | | Exibe as informações dos processos selecionados e documentos criados organizados em colunas: Processo, Assunto, Tipo do documento, Atualização documento. \\
RN10. |
| Editar | Botão | | RN04 | Desabilitado | RN08 RN06 |
|Visualizar| Botão | | RN04 | Desabilitado | RN08 |
|Excluir| Botão | | RN04 | Desabilitado | RN08 RN07 |
| Excluir | Botão | | | Desabilitado | RN09 |
| Assinar | Botão | | | Desabilitado | RN09 |
| | | | | | |
===== Fluxos =====
==== Fluxo 01 – Gerenciar documentos (Fluxo Principal) ====
^Passo^Ação^Regra^Tela|
|01| O Usuário seleciona um ou mais processo na listagem inicial e clica na ação Documentos. | |Tela 01|
|01.1| Caso o processo não se encontre no setor do usuário, o Sistema exibe a mensagem “O processo não se encontra mais no setor atual e será removido da lista.” E ao clicar em OK a mensagem fecha. | RN11 | |
|02| O Sistema verifica se o processo ainda se encontra no setor do usuário, caso sim, direciona para a tela Gerenciar documentos com o(s) processo(s) selecionado(s), na tela anterior, exibido(s) em uma tabela. | RN11 | |
|02.1| Caso o Usuário deseje criar um documento individual, o sistema direciona para o fluxo "Criar documento único". | | |
|02.2| Caso o Usuário deseje criar um documento em lote, o sistema direciona para o fluxo “Criar documento em lote”. | | |
|02.3| Caso o usuário deseje editar um documento, o sistema direciona para o fluxo “Editar documento”. | | |
|02.4| Caso o Usuário deseje Visualizar um documento, o sistema direciona para o fluxo “Visualizar documento”. | | |
|02.5| Caso o Usuario deseje excluir um documento, sistema direciona para o fluxo “Excluir documento”. | | |
|02.6| Caso o usuário deseje assinar um documento, o sistema direciona para o requisito “Enviar para assinatura”. | | |
|02.7| Caso o usuário deseje editar ou excluir um documento ou processo que possui bloqueio, o sistema direciona para o fluxo “Processo/documento sigiloso”. | | |
|02.8| Caso o usuário deseje editar ou excluir um documento ou processo que possui assinatura, o sistema direciona para o fluxo “Processo/documento assinado/enviado para assinatura”. | | |
==== Fluxo 02 – Criar documento único ====
^Passo^Ação^Regra^Tela|
|01| Caso haja mais de um processo listado em Gerenciar documento, o usuário seleciona apenas um processo por vez. | RN010 |Tela 01|
|02| O usuário seleciona o tipo de documento que deseja criar e clica no botão Criar documento. |RN01 RN03 RN02| |
|02.1| Caso o usuário tenha selecionado um processo que já tenha um documento criado, Sistema direciona para o fluxo “Processo contém um documento criado”. | | |
|02.2| Caso o usuário selecione um documento para um processo que já esteja assinado, o sistema direciona para o fluxo “Processo assinado”. | | |
|02.3| Caso o usuário selecione um documento que necessite cadastrar um VRF, o sistema direciona para o fluxo “Cadastrar um VRF”. |RN01| |
|02.4| Caso o usuário selecione um processo que não tenha uma Ementa vinculada, o sistema direciona para o fluxo "Ementa não vinculada". | | |
|02.5| Caso o usuário selecione um processo ou apensado com validação pendente de digitalização (SOP), o sistema direciona para o fluxo “Processo ou apensado com validação pendente de digitalização (SOP).” | | |
|02.6| Caso o usuário selecione um processo ou apensado validado, mas com documento assinado ou aguardando assinatura, o sistema direciona para o fluxo “Processo ou apensado validado assinado ou aguardando assinatura” | | |
|03| O sistema exibe mensagem “Deseja criar um documento do processo ? | | |
|04| O usuário clica no botão Sim e o Sistema realiza integração com o TCE-DOCS Web |RN08| |
|04.1| O usuário clica no botão Não e o Sistema cancela a criação do documento para o processo. | | |
==== Fluxo 03 – Criar documento em lote ====
^Passo^Ação^Regra^Tela|
|01| O usuário permanece com o(s) processo(s) listado(s) selecionado(s) | RN09 |Tela 01|
|02| O Usuário seleciona um tipo de documento que deseje criar |RN01 RN03 RN02| |
|02.1| Caso o usuário tenha selecionado um processo que já tenha um documento criado, Sistema direciona para o fluxo “Processo contém um documento criado”. | | |
|02.2| Caso o usuário selecione um documento que não possa ser criado em lote, o sistema direciona para o fluxo “Tipo de documento para processo único”. | | |
|02.3| Caso o usuário selecione um documento para um processo que já esteja assinado, o sistema direciona para o fluxo “Processo assinado”. | | |
|02.4| Caso o usuário selecione um documento que necessite cadastrar um VRF, o sistema direciona para o fluxo “Cadastrar um VRF”. | | |
|03| O usuário seleciona o destino do documento e clica no botão Criar documento. |RN01| |
|04| O sistema exibe a mensagem “Deseja criar um documento dos processos selecionados para o sertor ? | | |
|04.1| Caso o documento não necessite selecionar um destino, o sistema exibe a mensagem “Deseja criar um documento para os processos selecionado? |RN01| |
|05| O usuário clica no botão Sim e o Sistema realiza integração com o TCE-DOCS Web. |RN08| |
|05.1| O usuário clica no botão Não, o Sistema cancela a criação do documento para o(s) processo(s). | | |
==== Fluxo 04 – Processo contém um documento criado ====
^Passo^Ação^Regra^Tela|
|01| O sistema exibe a mensagem “O(s) processo(s) já possui um documento. Deseja substituir este documento por um documento de ? |RN01| |
|02| O usuário clica no botão Sim, sistema realiza integração com o TCE-DOCS Web. |RN08| |
|02.1| O usuário clica no botão Não, sistema fecha mensagem e não realiza a ação de substituição. | | |
==== Fluxo 05 – Processo assinado ====
^Passo^Ação^Regra^Tela|
|01| O sistema exibe a mensagem “O(s) documento(s) deste(s) processo(s) foi(ram) assinado(s) e não pode(s) ser (em) alterado(s).” |RN01 RN05 RN06| |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
==== Fluxo 06 – Cadastrar um VRF ====
^Passo^Ação^Regra^Tela|
|01| O sistema exibe a mensagem “Antes de gerar o documento é necessário cadastrar um VRF.” |RN01| |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
==== Fluxo 07 – Ementa não vinculada ====
^Passo^Ação^Regra^Tela|
|01| O sistema verifica que a validação é impeditiva para criação de documento de seleção única e exibe a mensagem “O documento não pode ser criado pois a EMENTA do PROCESSO deve ser cadastrada, entre em contato com Serviço de PROTOCOLO.” |RN01| |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
==== Fluxo 08 – Processo ou apensado com validação pendente de digitalização (SOP) ====
^Passo^Ação^Regra^Tela|
|01| O sistema verifica que a validação é impeditiva para criação de documento de seleção única e exibe a mensagem "O documento não pode ser criado pois o processo (seu processo principal, ou um dos seus apensados) está aguardando validação após digitalização pelo SDP" |RN01| |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
==== ====
==== Fluxo 09 – Processo ou apensado validado assinado ou aguardando assinatura ====
^Passo^Ação^Regra^Tela|
|01| O sistema verifica que a validação é impeditiva para criação de documento de seleção única e exibe a mensagem "O documento não pode ser criado pois o processo (seu processo principal, ou um dos seus apensados) foi validado após digitalização pelo SDP e teve a sua Certidão de Conferência de Conteúdo assinada ou está Aguardando Assinatura. Remova as assinaturas, cancele o envio para assinatura e crie o documento desejado posteriormente." |RN01| |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
==== ====
==== Fluxo 10 – Tipo de documento para processo único ====
^Passo^Ação^Regra^Tela|
|01| O sistema exibe a mensagem “Somente um processo pode ser selecionado para a opção de documento.” |RN01| |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
===== =====
==== Fluxo 11 – Editar documento ====
^Passo^Ação^Regra^Tela|
|01| O usuário clica no ícone Editar do processo listado na tela | RN05 RN06 RN08 |Tela 01|
|02| O sistema realiza integração com o TCE-DOCS Web para realizar a edição do documento | RN08 | |
==== Fluxo 12 – Visualizar documento ====
^Passo^Ação^Regra^Tela|
|01| O usuário clica no ícone Visualizar do processo listado na tela | RN08 |Tela 01|
|02| O sistema abre um modal exibindo o documento criado |RN10 | |
|03| O usuário clica no botão Ok para fechar o modal e retornar para a tela Gerenciar documento | | |
==== Fluxo 13 – Excluir documento ====
^Passo^Ação^Regra^Tela|
|01| O usuário clica no ícone Excluir do processo listado na tela | RN08 |Tela 01|
|01.1| O usuário seleciona um ou mais processo listado na tela e clica no botão Excluir | RN09 RN05 RN07 | |
|02| O sistema verifica as permissões e exibe a mensagem “Deseja realmente excluir o(s) documento(s) atual(is)?” | | |
|03| O usuário clica no botão Sim, o Sistema exclui o documento do processo selecionado. | | |
|03.1| O usuário clica no botão Não, o sistema fecha a mensagem sem realizar nenhuma ação. | | |
==== Fluxo 14 – Processo/documento sigiloso ====
^Passo^Ação^Regra^Tela|
|01| O sistema verifica as permissões do usuário (se ele pertence ao setor correto, se é o chefe do setor ou se tem uma permissão especial, se não tiver permissão, exibe uma mensagem de alerta "O processo não pode ser acessado, pois segue em sigilo." |RN05 | |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
==== Fluxo 15 – Processo/documento assinado/enviado para assinatura ====
^Passo^Ação^Regra^Tela|
|01| O sistema verifica as permissões do usuário (se ele é chefe do setor ou funcionário do setor com permissão especial), se o documento já foi enviado para assinatura ou se já foi assinado, se sim exibe uma mensagem informando “Uma vez enviado para assinatura, este documento não poderá ser alterado · ou excluído, caso seja necessária alguma manutenção, a assinatura deverá ser removida." |RN05 | |
|02| O usuário clica no botão OK | | |
|03| O sistema fecha a mensagem sem realizar a ação. | | |
===== Regras de Negócio =====
^Regra^Descrição|
|RN01|Criação de Documentos: \\ • Alguns tipos de documentos podem ser criados em lotes e outros não, identificado em [[:etceweb:controledeservicostcedocs|ControleDeServicosTceDocs]]. \\ • Algumas validações são realizadas antes da criação do documento (frmDocCITceDocs) e suas mensagem sempre são iniciadas por “Os processos a seguir apresentaram problemas:” \\ o Documento já assinado \\ o Documento já cadastrado \\ o Processo fora do setor \\ • Para os documentos com identificação DG, DT , PD, PC, antes de gerar esstes documentos, deve ser necessário cadastrar um VRF (Valor de Recursos Fiscalizados). Na tela de lançamento do BACE eles lançam o VRF junto \\ • Documentos com seleção única: \\ o Se a identificação do documento começar com "D", tiver 2 caracteres e for diferente de "DM" ou começar com "P", tiver 2 caracteres: \\ → Não é permitido selecionar mais de um processo para o documento \\ • Documentos com seleções múltiplas (por exemplo): \\ o Comunicado Interno \\ Ao selecionar o documento, sistema habilita o campo Destino que se tornará obrigatório seu preenchimento \\ o Relatório de Avaliação de Política Pública|
|RN02|TCE.Docs.Api: \\ • É consumido um serviço da api do TCE-DOCS ([[https://docs-api-replica.tce.gti.br/api/tipoDocumento/consulta|https://docs-api-replica.tce.gti.br/api/tipoDocumento/consulta]]) que retorna a lista de documentos que o usuário tem acesso, onde é feito uma tratativa para remover da lista um documento do tipo Instrução Técnica Automatizada devido já existir um botão exclusivo para a geração do mesmo e indica se o documento é de tramite. \\ • Da lista de documentos retornada para o usuário pela API, será listado no sistema os tipos de documentos do tipo processuais apontados. \\ • Caso o usuário esteja lotado em mais de um setor, a API deve verificar o nome do usuário e o setor selecionado para realizar o retorno dos tipos de documentos de acordo com o setor selecionado|
|RN03|O menu será hierárquico, onde a lista principal serão opções de primeiro nível, se existirem tipos de documentos que são processuais, mas não sejam de tramite, o sistema vai criar a opção de primeiro nível “Outros Documentos” e todos esses serão apresentados dentro dessa opção como segundo nível.|
|RN04| Exibir um tooltip nos ícones exibindo o motivo que ele está desabilitado |
|RN05|Verificações antes de Editar ou Excluir um documento: \\
• Verifica se o processo ou o documento possui bloqueio (INDR_BLOQUEIODOC_A = "T" ou INDR_BLOQUEIODOC_A ="S"). \\
• Verifica se tiver bloqueio/sigilo verifica as permissões do usuário (se ele pertence ao setor correto, se é o chefe do setor ou se tem uma permissão especial VisualizaProcessoSigiloso. \\ • Verifica se não tiver permissão, exibe uma mensagem de alerta "O processo (" oProc.CODG_PROCESSO_N ") não pode ser acessado, pois segue em sigilo." \\ • Somente o chefe do setor ou o funcionário do setor que tiver acesso ao menu (funAnalisaSigilo) pode visualizar um processo sigiloso. \\ • Verifica se o documento já foi enviado para a assinatura (INDR_AASSINAR_A = "A") ou se já foi assinado (INDR_AASSINAR_A ="S"). \\ • Se sim, exibe um alerta informando que a operação não é permitida sem remover a assinatura/envio de assinatura "Uma vez enviado para assinatura, este documento não poderá ser alterado ou excluído, caso seja necessária alguma manutenção, a assinatura deverá ser removida." |
|RN06|Editar documento: \\
• Para certos tipos de documento ("A", "S", "H"), ele define a geração de PDF como obrigatória; \\
• Se for um documento que estava no fluxo de assinatura e o usuário é o chefe do setor, o ícone de Editar ficará habilitado e o sistema pergunta se deseja remover o documento da Central de Assinatura antes de editar e, se confirmado, executa o cancelamento do trâmite/assinatura. Para usuários diferentes de chefe do setor, o ícone Editar ficará desabilitado, não permitindo realizar edição para esse fluxo. \\
• Prepara o documento para edição no Word através de uma integração (WordDocuments, ManipulaDocumentoDocs) |
|RN07|Excluir documento: \\
• Chama a função apropriada para remover o documento (seja o fluxo legado docLegado.RemoveDocumento ou o novo fluxo ManipulaDocumentoDocs.ExcluirDocumento); \\ • Tipos de documentos que não podem ser excluídos: A=Acordão, E=Relatório/Voto, H=Parecer Prévio e S=Resolução |
|RN08|Ao retornar o documento após criação ou edição no TCE-DOCS Web, o sistema: \\
• Deve preencher as colunas Tipo do documento e Última atualização com o nome do documento criado para cada processo e o nome do usuário que executou a ação com data e hora respectivamente. \\
• O sistema deve habilitar os ícones de ações (visualizar, editar e excluir) para os processos que contém documentos. |
|RN09|O Sistema: \\
• Ordena os processos selecionados pelo número na ordem crescente; \\
• Apresenta cinco registros por página com as opções de paginação, quando aplicável. \\
• Permite ao Usuário alterar a ordenação por qualquer coluna apresentada na tabela. \\
• Habilita os botões Excluir e Enviar para assinatura após seleção de um ou mais processos listados na tabela |
|RN10| Na visualização do documento (via Maven), o sistema não deve permitir realizar nenhum tipo de alteração do documento. |
|RN11| Se o processo selecionado pelo usuário não se encontrar mais no setor que ele está logado, o sistema informa através de mensagem e remove o processo da listagem. |