Requisito - [TCE] Demonstrativo LRF [Wiki TCE-GO]

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
====== Requisito - [TCE] Demonstrativo LRF ======

===== Descrição =====

Fluxo BPM para solicitar, validar, corrigir e encaminhar ao TCE-GO os Demonstrativos da LRF (ex.: RGF/RREO), com suporte a anexação de documentos, verificação de memória de cálculo, integração para autuação no eTCE e inclusão de peças no CPA.\\
\\
//Local de acesso:// Solar BPM | [TCE] Demonstrativo LRF\\
//Artefatos de apoio:// Diagrama [TCE] Demonstrativo LRF.svg

===== Atores =====

  * USUARIO QUE CADASTROU O PROCESSO
  * ator dinâmico LRF SOLICITANTE
  * ator dinâmico LRF_ORGAO

===== Telas =====

==== Tela 01 - [TCE] - 01 - Envio dos Demonstrativos LRF ====

^Elemento^Tipo^Obrigatório^Valores Possíveis^Valor Padrão^Observação|
|Exercício de Referência (exercicioDeReferencia)|Campo (mask)|Sim| | |Ano/exercício a que se referem os demonstrativos.|
|Tipo de Demonstrativo (tp_demonstrativo)|Seleção|Sim|RGF, RREO, RGF-CONSOLIDADO| |Tipo do demonstrativo LRF.|
|Período de referência (periodoDeReferencia)|Seleção|Sim|1º..6º Período| |Período do demonstrativo.|
|Órgão/Poder (orgaoPoder)|Seleção|Não|Lista de órgãos/poderes| |Preenchido conforme contexto do processo.|
|CPF (cpf)|Campo CPF|Não| | |Informação do solicitante.|
|CNPJ (cnpj)|Campo CNPJ|Não| | |Informação do solicitante/órgão.|
|E-mail (email)|Campo texto|Sim| | |Contato para comunicação.|
|Telefone (telefone)|Campo (mask)|Não| | |Contato para comunicação.|
|Resumo da Solicitação (resumoSolicitacao)|Texto longo|Sim| | |Resumo/descrição da solicitação.|
|Demonstrativos e documentos diversos (up_demostrativos_anexos)|Upload múltiplo|Sim| | |Anexos principais da solicitação.|
|Documentos Complementares da Memória de cálculo (up_memoriaDeCalculoComplemento)|Upload múltiplo|Não| | |Anexos complementares.|
|Memória de cálculo Anexo 1 (RGF) (up_memoriaDeCalculo)|Upload|Não| | |Anexo de memória de cálculo.|
|Iniciar verificação (btn_verificacao)|Botão|Não| | |Dispara a verificação e alimenta resultados na tela.|
|Exportar Irregularidades para planilha Excel (btn_exportarIrregularidades)|Botão|Não| | |Exporta irregularidades identificadas.|
|Finalizar solicitação (submit_1)|Botão submit|Não| | |Submete a solicitação e avança no fluxo.|
|Tabela RGF (tb_rgf)|Tabela editável|Não| | |Tabela consolidada (somente leitura no formulário).|
|Irregularidade(s) no preenchimento (tb_irregularidade)|Tabela editável|Não| | |Tabela de irregularidades (somente leitura).|

==== Tela 02 - [TCE] - 1 - AVALIAR SOLICITAÇÃO DE DEMONSTRATIVOS LRF ====

^Elemento^Tipo^Obrigatório^Valores Possíveis^Valor Padrão^Observação|
|Exercício de Referência (exercicioDeReferencia)|Campo (mask)|Não| | |Somente leitura.|
|Tipo de Demonstrativo (tp_demonstrativo)|Seleção|Não|RGF, RREO, RGF-CONSOLIDADO| |Somente leitura.|
|Período de referência (periodoDeReferencia)|Seleção|Não|1º..6º Período| |Somente leitura.|
|Órgão/Poder (orgaoPoder)|Seleção|Não|Lista de órgãos/poderes| |Somente leitura.|
|Resumo da Solicitação (resumoSolicitacao)|Texto longo|Não| | |Somente leitura.|
|Demonstrativos (up_demostrativos_anexos)|Upload múltiplo|Não| | |Somente leitura.|
|Memória de cálculo Anexo 1 (RGF) (up_memoriaDeCalculo)|Upload|Não| | |Somente leitura.|
|Tabela RGF (tb_rgf)|Tabela editável|Não| | |Somente leitura.|
|Irregularidade(s) no preenchimento (tb_irregularidade)|Tabela editável|Não| | |Somente leitura.|
|A solicitação está correta? (avaliacao)|Seleção (radios)|Sim|Sim, Não| |Decisão que direciona o fluxo.|
|Justifique-se (justificativa)|Texto longo|Não| | |Obrigatório quando avaliação = Não.|
|Finalizar solicitação (submit_1)|Botão submit|Não| | |Conclui a avaliação.|

==== Tela 03 - [TCE] - 4 - CORRIGIR SOLICITAÇÃO DE DEMONSTRATIVOS LRF (DOCUMENTOS) ====

^Elemento^Tipo^Obrigatório^Valores Possíveis^Valor Padrão^Observação|
|Justificativa (justificava)|Texto longo|Não| | |Apresenta motivo/justificativa da correção (somente leitura).|
|Exercício de Referência (exercicioDeReferencia)|Campo|Não| | |Permite ajustar a solicitação.|
|Tipo de Demonstrativo (tp_demonstrativo)|Seleção|Não|RGF, RREO, RGF-CONSOLIDADO| |Permite ajustar a solicitação.|
|Período de referência (periodoDeReferencia)|Seleção|Não|1º..6º Período| |Permite ajustar a solicitação.|
|E-mail (email)|Campo texto|Sim| | |Contato para comunicação.|
|Resumo da Solicitação (resumoSolicitacao)|Texto longo|Sim| | |Permite atualizar o resumo.|
|Demonstrativos (up_demostrativos_anexos)|Upload múltiplo|Não| | |Atualiza anexos.|
|Memória de cálculo Anexo 1 (RGF) (up_memoriaDeCalculo)|Upload|Não| | |Atualiza anexo de memória de cálculo.|
|Iniciar verificação (btn_verificacao)|Botão|Não| | |Refaz a verificação, se necessário.|
|Exportar Irregularidades para planilha Excel (btn_exportarIrregularidades)|Botão|Não| | |Exporta irregularidades identificadas.|
|Reenviar solicitação (submit_1)|Botão submit|Não| | |Reenvia a solicitação para nova avaliação.|

==== Tela 04 - [TCE] Encaminhar Demonstrativos ao TCE ====

^Elemento^Tipo^Obrigatório^Valores Possíveis^Valor Padrão^Observação|
|Data | hora de envio dos demonstrativos (dataHora_fimTarefa)|Campo|Não| | |Somente leitura.|
|Observação? (obs)|Texto longo|Não| | |Somente leitura.|
|Finalizar solicitação (submit_1)|Botão submit|Não| | |Finaliza a etapa de encaminhamento.|

===== Fluxos =====

==== Fluxo 01 – Solicitar e Enviar Demonstrativos LRF (Fluxo Principal) ====

^Passo^Ação^Regra^Tela|
|01|O Usuário inicia o processo.|RN01| |
|02|O Usuário preenche os dados da solicitação e anexa os demonstrativos.|RN02, RN03|Tela 01|
|03|O Sistema busca dados do órgão (CNPJ/identificação) em serviço externo.|RN04| |
|04|O Sistema direciona para avaliação da solicitação.|RN05|Tela 02|
|05|O Usuário avalia se a solicitação está correta (Sim/Não).|RN06|Tela 02|
|05.1|Se a avaliação for Não, o Sistema direciona para correção e depois retorna para nova avaliação.|RN07|Tela 03 / Tela 02|
|05.2|Se a avaliação for Sim, o Sistema segue o fluxo para preparação/inclusão de peça e encaminhamento.|RN08| |
|06|O Sistema inclui peça no CPA (etapa 4.1).|RN09| |
|07|O Sistema prepara o título do processo/solicitação.|RN10| |
|08|O Sistema direciona para a etapa “Encaminhar Solicitação para o TCE”.|RN11|Tela 04|
|09|O Sistema inclui peça no CPA (etapa 2.1).|RN09| |
|10|O Sistema decide o caminho de autuação e prepara a descrição para envio.|RN12| |
|11|O Sistema solicita autuação no eTCE e gera evento de continuidade do fluxo.|RN13| |
|12|O Sistema executa subprocesso de atualização de dados de negócio.|RN14| |
|13|O Sistema direciona para a etapa manual “Enviar dados ao TCE”.|RN15| |
|14|Após o envio manual, o processo é arquivado/finalizado.|RN16| |

==== Fluxo 02 – Corrigir Solicitação (documentos) ====

^Passo^Ação^Regra^Tela|
|01|O Sistema direciona para correção quando a avaliação indicar inconsistências.|RN07|Tela 03|
|02|O Usuário ajusta dados e/ou anexos, e reenvia a solicitação.|RN07|Tela 03|
|03|O Sistema retorna para nova avaliação.|RN05|Tela 02|

==== Fluxo 03 – Autuar no TCE ====

^Passo^Ação^Regra^Tela|
|01|O Sistema prepara descrição para envio na autuação.|RN12| |
|02|O Sistema chama serviço do eTCE para solicitar autuação.|RN13| |
|03|O Sistema atualiza dados de negócio (subprocesso).|RN14| |

===== Regras de Negócio =====

^Regra^Descrição|
|RN01|**Início do Processo:** O processo “[TCE] Demonstrativo LRF” inicia com o preenchimento da solicitação pelo usuário executor.|
|RN02|**Campos Obrigatórios da Solicitação:** No envio, são obrigatórios: Exercício de Referência, Tipo de Demonstrativo, Período de Referência, E-mail e anexos “Demonstrativos e documentos diversos”.|
|RN03|**Anexação de Documentos:** A solicitação deve permitir anexar documentos principais (demonstrativos) e anexos complementares (memória de cálculo e complementos).|
|RN04|**Consulta de Órgão (CNPJ):** Após envio, o sistema consulta dados do órgão via serviço externo (consulta detalhada do órgão) para compor/validar dados do processo.|
|RN05|**Direcionamento para Avaliação:** Toda solicitação enviada deve ser avaliada na tarefa “1- Avaliar Solicitação Enviada”.|
|RN06|**Decisão de Avaliação:** O campo “A solicitação está correta?” direciona o fluxo: Sim continua; Não retorna para correção.|
|RN07|**Correção com Retorno:** Ao selecionar “Não”, o sistema direciona para “4- Corrigir Solicitação (documentos)” e, ao reenviar, retorna para nova avaliação.|
|RN08|**Aprovação Continua o Fluxo:** Ao selecionar “Sim”, o fluxo segue para inclusão de peça, preparação de título e encaminhamento para autuação no TCE.|
|RN09|**Inclusão de Peça no CPA:** O sistema inclui documentos no CPA via operação de inclusão de documentos de formulário dinâmico na pasta do processo.|
|RN10|**Preparação do Título:** O sistema gera/prepara o título da solicitação/processo antes do encaminhamento ao TCE.|
|RN11|**Encaminhamento ao TCE:** A tarefa “2- Encaminhar Solicitação para o TCE” confirma o encaminhamento para autuação.|
|RN12|**Preparação de Descrição:** O sistema prepara a descrição que será utilizada no envio para autuação no TCE.|
|RN13|**Solicitação de Autuação:** O sistema solicita autuação no eTCE via serviço dedicado e utiliza o retorno/eventos do fluxo para continuidade.|
|RN14|**Atualização de Dados de Negócio:** Após autuação, o subprocesso “Atualiza dados de negócio” consolida dados do processo (ex.: identificadores).|
|RN15|**Envio Manual ao TCE:** A etapa “Enviar dados ao TCE” é manual e ocorre após as automações/inclusões necessárias.|
|RN16|**Arquivamento:** Após conclusão do envio manual, o processo segue para o evento final de arquivamento (“6 - Arquivar”).|

===== Integrações =====

^Tarefa^Tipo^Nome^Serviço^Operação^Observação|
|2.1- Incluir Peça|REST|incluir peça|cpa-core-backend|POST_/documento/inclui-documentos-form-dinamico-pasta-processo|Inclui documentos anexados no CPA.|
|4.1- Incluir Peça|REST|incluir peça|cpa-core-backend|POST_/documento/inclui-documentos-form-dinamico-pasta-processo|Inclui documentos anexados no CPA.|
|BUSCA CNPJ ORGAO|REST|Busca cnpj Orgao(Tomada de Contas Especiais)|Serviços do TCE para Prestação de Contas|GET_/ConsultaOrgaoDetalhado?ano={ano}&tipoPrestacao={tipo}&orgao={orgao}|Consulta dados do órgão.|
|3- Autuar no TCE|REST|Solicita autuação LRF|eTCE|POST_/api/solicitacaoautuacao/SolicitacaoAutuacaoSIAP|Solicita autuação do demonstrativo no TCE.|

===== Scripts =====

^Tarefa^Script^Objetivo (alto nível)^Observação|
|Envio dos demostrativos LRF|BUSCA USUÁRIO PELO CDUSUARIO|Resolve dados do usuário a partir do cdUsuario.|Apoia preenchimento/assinatura/contato.|
|1- Avaliar Solicitação Enviada|ator dinâmico LRF SOLICITANTE|Resolve o ator dinâmico do solicitante para a tarefa.|Define executor da tarefa.|
|4- Corrigir Solicitação (documentos)|ator dinâmico LRF SOLICITANTE|Resolve o ator dinâmico do solicitante para a tarefa.|Define executor da tarefa.|
|2- Encaminhar Solicitação para o TCE|ator dinâmico LRF_ORGAO|Resolve o ator dinâmico do órgão responsável.|Define executor da tarefa.|
|Prepara titulo|Titulo - LRF|Gera/prepara o título do processo/solicitação.|Executado antes do encaminhamento.|
|Prepara descrição para envio na autuação|Descrição - LRF|Gera/prepara descrição para a autuação.|Executado antes de chamar o eTCE.|

===== Variáveis =====

Conjunto de variáveis identificadas no processo (referência).\\
\\
**Runtime / Controle**
  * cdVinculo
  * solar.bpm.leave_node_disabled
  * bpm.url.identificacao.instancia
  * bpm.ator.executor.atividade
  * solar.bpm.task.deleted.by.boundary.event
  * bpm.ator.iniciador.processo
  * bpm.sistema.origem
  * cdDefinicao
  * bpm.identificacao.instancia
  * solar.bpm.execution_running_async_context
\\
**Negócio / Dados da Solicitação**
  * ano
  * exercicioDeReferencia
  * tp_demonstrativo
  * periodoDeReferencia
  * orgaoPoder
  * orgaoPoder_descricao
  * descricao
  * resumoSolicitacao
  * titulo
  * resumo
  * avaliacao
  * justificativa
\\
**Identificação / Contato**
  * cdUsuario
  * cpf
  * cnpj
  * cpfCnpj
  * tipoPessoa
  * nomeRazaoSocial
  * email
  * telefone
\\
**Endereço**
  * logradouro
  * numero
  * bairro
  * cep
  * cidade
  * estado
\\
**CPA / Integrações**
  * CPA.cdProcesso
  * idSolicitacaoAutuacao
  * ProcessoETCE
  * idDoSistemaQueEstaChamando
  * sgSetor
  * setor
  * setor_formatado
\\
**Arquivos / Anexos**
  * documentosAdicionados
  * up_demostrativos_anexos
  * up_memoriaDeCalculo
  * up_memoriaDeCalculoComplemento
\\
**Tabelas / Validações**
  * encontrados
  * tb_rgf
  * tb_irregularidade
  * lista_codigoDespesaPessoal
  * new_listacpfCnpj
  * CNPJORGAO
\\
**Outras**
  * comentarios
  * obs
  * dataHora_fimTarefa
  * FD.respForm
  * inseredoc
  * propriedade_avancar
  * nome_tarefa
  * nome_tarefa_1
  * nome_tarefa_2
  * nome_tarefa_4