DVP - Documento de Visão do Projeto - Fase 1
1. Visão Geral do Documento
2. Visão Geral do Negócio
2.1. Perspectiva do Negócio
2.2. Motivações, Necessidades e Problemas
3. Visão Geral do Produto
3.1. Perspectiva do Produto
3.2. Oportunidades de Negócio
4. Requisitos Funcionais do Produto
4.1. Estórias do usuário
Requisitos funcionais
| ID | Estória do usuário | Tema | Prioridade |
|---|---|---|---|
| HU.01 | Como usuário da Secretaria de Controle Externo quero manter layouts de prestação de contas, contendo campos obrigatórios e facultativos, para que o controle externo possa auditar as atividades dos jurisdicionados, os quais ficarão obrigados a prestar contas de suas atividades, enviando as informações apresentadas no layout. | Configuração | |
| HU.02 | Como usuário da Secretaria de Controle Externo quero determinar quais os layouts de qual versão estarão disponíveis para receber as informações do jurisdicionado, de modo a determinar a data de início e fim do período do calendário de prestação de contas, organizadas por dimensão das informações, bem como o período de apuração das atividades. | Configuração | |
| HU.03 | Como usuário da Secretaria de Controle Externo quero habilitar para um ou mais jurisdicionados específicos um período de prestação de contas especial, para que possam regularizar sua situação junto ao TCE. | Configuração | |
| HU.04 | Como usuário da Secretaria de Controle Externo quero criar novas versões de layout a partir de um layout existente. | Configuração | |
| HU.05 | Como usuário da Secretaria de Controle Externo quero visualizar os recibos de prestações de contas por calendário de obrigações, contendo os jurisdicionados que devem prestar contas, bem como a situação da prestação de contas no momento da visualização, e o recibo de entrega vinculado a prestação de contas se houver. | Relatório | |
| HU.06 | Como usuário Jurisdicionado quero visualizar as obrigações de prestação de contas que terei que apresentar junto ao TCE em um determinado período do ano, bem como a configuração dos layouts que devo enviar ao TCE. | Informativo | |
| HU.07 | Como usuário Jurisdicionado quero visualizar notícias que o TCE por ventura virá a publicar referente às obrigações de prestação de contas, como prorrogação de período de apuração, notificação de data limite de prestação de contas, período de retificação das prestações de conta com críticas etc. | Informativo | |
| HU.08 | Como usuário Jurisdicionado quero visualizar meus recibos de prestação de contas já enviados ao TCE, para que possa utilizar os recibos como garantia de que foi ou não prestado contas, dentro ou fora do período de obrigação, e a qualquer momento imprimir o recibo para comprovação. | Relatório/Controle | |
| HU.09 | Como usuário Jurisdicionado quero validar os arquivos de prestação de contas que estamos criando para enviar ao TCE, estão corretos quanto à estrutura do layout, antes de enviar em ambiente definitivo. | Verificação/Homologação | |
| HU.10 | Como usuário Jurisdicionado quero visualizar as críticas que as obrigações enviadas ao TCE tiveram por recibo, para que possam ser feitos os reparos necessários para regularizar. | Relatório | |
| HU.11 | Como usuário Jurisdicionado quero enviar as obrigações de prestar contas ao TCE via Portal Web ou via Web Service. | Recepção de Dados | |
| HU.12 | Como usuário da Secretaria do Controle Externo, quero alterar o layout de determinado arquivo, caso exista calendário de obrigações vinculado ao layout atualizado e cujo período de prestação de contas à data de publicação do layout esteja contido, o sistema me questione se desejo atualizar os calendários nessa situação. | Configuração | |
| HU.13 | Como usuário da Secretaria do Controle Externo, quero que o sistema envie e-mail informativo aos jurisdicionados, sobre período de prestação de contas, alteração, prorrogação ou cancelamento de obrigação de prestação de contas, alerta de que faltam 5 dias para encerrar o prazo de prestação de contas e outras situações. | Configuração/Controle | |
| HU.14 | Como usuário da Secretaria do Controle Externo, quero visualizar as declarações processadas, e as não processadas por motivo de erro ou inconsistência do sistema, de modo que as informações não processadas por motivo de disponibilidade do serviço ou falha do serviço posso mandar reprocessar. | Controle | |
| HU.15 | Como usuário da Secretaria do Controle Externo, quero visualizar e acompanhar os Logs de exeção ocorridas no recebimento da declaração, a fim de soliciar eventuais correções e melhorias do sistema, para garantir a disponibilidade e continuidade do sistema. | Controle | |
| HU.16 | Como usuário da Secretaria de Controle Externo, quero que as declarações recebidas sejam processadas e armazenadas no banco de dados do projeto Informa (de forma escalavel - microservices). | Verificação/Homologação | |
| HU.17 | Como Jurisdicionado quero enviar os arquivos anexos à informação declarada seja enviada ao TCE, em serviço desvinculado ao serviço de declaração de execução das atividades. | Recepção de Dados | |
| HU.18 | Como usuário da Gerencia de TI quero configurar e iniciar a execução dos agentes de Microservices nas máquinas físicar ou virtuais. (Anteração do Worker de Log, Testes reais com microservices) - Projeto TCE.Microservices | Configuração/Controle | |
| HU.18 | Como Jurisdicionado quero retificar declarações enviadas para o TCE-GO, para corrigir qualquer inconsistência na declaração por causa do leiaute ou por inconformidade de negócio. (Criar método de exclusão de informação no Informa; tratar cenários de situação da declaração (Declaração com críticas de leiaute, Declaração validada quanto ao leiaute, Declaração Homologada com Críticas, Declaração Homologada) | Recepção de Dados |
5. Requisitos Não-Funcionais do Produto
5.1. Requisitos Legais e de Padrões
A comunicação do sistema via Portal ou via Web Service deve ser autenticada com o usuário TCENet, a fim de identificar o remetente da informação e carregar as funcionalidades especificadas nas Estórias de Usuário contidas na seção anterior deste documento, filtrando pelo Órgão do usuário autenticado.
Na autenticação e o envio do arquivo de apuração no portal, deverá ser executada via protocolo seguro, sendo assim será utilizado HTTPS que criptografa as mensagens de comunicação entre o usuário (via browser) com o serviço web do produto TCE-CONTEX. A comunicação via Web Service também será via protocolo seguro, utilizando HTTPS, em que o padrão de comunicação com o serviço de Web Service irá encriptar a mensagem e a assinatura de autenticação nas chamadas dos serviços.
O arquivo de apuração das atividades dos jurisdicionados entregues via portal ou via Web Service, este utilizando a arquitetura SOAP WCF, será via XML, devendo o usuário no primeiro caso estruturar o arquivo de acordo com a especificação do layout conforme definido e contemplado no calendário de obrigações.
No recebimento da informação, tanto via Portal ou Web Service, o sistema deverá gerar um protocolo de recebimento da informação, e apresentar o mesmo no momento de envio da informação, válida ou inválida, para que o processamento do conjunto de informações recebidas pelo serviço do Controle Externo, possa executar suas etapas de verificação e consolidação de forma assíncrona, e possibilitando processamento em paralelo, dado o volume de informações recebidas por sessão de comunicação. A abordagem de processamento das informações de forma concorrente, em paralelo, se dá devido o volume de informações que o sistema deverá estar adaptado a receber, tendo em vista que atualmente são mais de 50 jurisdicionados que prestaram contas de suas atividades em períodos de execução, agrupados em mais de 70 layouts de arquivos distintos, enviados durante todo ano. Com base nessa realidade, faz-se necessário desenvolver um produto de software que suporta escalabilidade dos serviços de recebimento e processamento de dados.
5.2. Requisitos de Sistema e Infraestrutura
Os requisitos apresentados nessa seção serão detalhados com base nas Estórias de Usuário.
- HU.01 - Como usuário da Secretaria de Controle Externo quero manter layouts de prestação de contas, contendo campos obrigatórios e facultativos, para que o controle externo possa auditar as atividades dos jurisdicionados, os quais ficarão obrigados a prestar contas de suas atividades, enviando as informações apresentadas no layout.
O produto de software TCE-CONTEX deverá possibilitar que a Secretaria de Controle Externo do TCE-GO, configure e disponibilize os layouts de recebimento de informações e controle de entrega de informação. O controle pode ser cancelado, mesmo que já tenha prestação de contas para a Dimensão e período de apuração.
- HU.03 - Como usuário da Secretaria de Controle Externo quero habilitar para um ou mais jurisdicionados específicos um período de prestação de contas especial, para que possam regularizar sua situação junto ao TCE.
O controle de recebimento de informações das atividades dos jurisdicionado, poderão ser estendido em casos excepcionais, sendo habilitada para o órgão ou entidade a entrega de apurações fora do prazo. Para este controle a Secretaria de Controle Externo seleciona o calendário que deseja permitir o recebimento especial de informações, atribuindo ao calendário-dimensão previamente cadastrado de um jurisdicionado, qual o período inicial e final que será esperada a recepção destas novas informações. Deve-se prever nestas estórias os seguintes cenários:
- Jurisdicionado não prestou informações neste calendário-dimensão;
- Jurisdicionado já prestou informações e está reenviando a totalidade dos layouts a fim de retificar os dados. Sendo que a informação anteriormente recebida já foi processada pelo extrator de dados;
- Item de lista não ordenadaJurisdicionado já prestou informações e está reenviando a totalidade dos layouts a fim de retificar os dados. Sendo que a informação anteriormente recebida ainda não foi processada pelo extrator de dados;
O sistema não permitirá receber uma parte dos layouts da dimensão. Toda recepção de dados espera a totalidade de informações de um período de apuração. Ao receber um calendário-dimensão por usuário especial, deve-se identificar esta situação no recibo de processamento das informações e apresenta-las nas funcionalidades que tratem disso do portal.
- HU.04 - Como usuário da Secretaria de Controle Externo quero criar novas versões de layout a partir de um layout existente
Como apresentado anteriormente, na estória de usuário HU.01, o usuário do Controle Externo do TCE-GO poderá criar novas versões dos layouts a partir da cópia dos layouts anteriores, de modo a facilitar as alterações do layout na nova versão.
- HU.05 Como usuário da Secretaria de Controle Externo quero visualizar as prestações de contas por calendário de obrigações, contendo os jurisdicionados que devem prestar contas, bem como a situação da prestação de contas no momento da visualização, e o recibo de entrega vinculado à prestação de contas se houver
O TCE-CONTEX com o controle dos períodos de entrega, em conjunto com o controle das informações das atividades referente ao período de apuração configurado no controle do período de recebimento das informações, irá possibilitar que o usuário de Controle Externo do TCE-GO, verifique quais órgãos/entidades do poder público estadual, entregaram as informações das apurações das atividades, dentro e fora do prazo, bem como as pendências das entregas (entrega com crítica).
Nesse relatório que apresenta as apurações entregues e não entregues, será apresentado à situação de cada informação, com base no andamento do processo de verificação e consolidação dos dados recebidos.
- HU.06 - Como usuário Jurisdicionado quero visualizar as obrigações de prestação de contas que terei que apresentar junto ao TCE em um determinado período do ano, bem como a configuração dos arquivos que devo enviar ao TCE.
Serão apresentados os calendários/dimensões que o jurisdicionado logado deverá prestar contas. Apresentação do período de calendário e período de apuração para cada Dimensão, permitindo aplicar filtros em qualquer período do ano para a informação de calendário ou apuração. Disponibilizar forma de visualização detalhada que liste todos os layouts que compõem a dimensão, assim como as versões atribuídas. Além de permitir o detalhamento da estrutura do layout que deve ser utilizada para o envio de dados.
Uma vez configurada a obrigação de prestação de contas do calendário-dimensão, os jurisdicionados deverão ter acesso a quais obrigações deverão prestar contas, em quais períodos do ano, e para cada prestação de contas, o sistema deverá apresentar a composição dos layouts que o jurisdicionado deverá informar.
A definição da composição do arquivo deverá apresentar a composição de todo o layout da prestação de contas configurada no calendário.
- HU.07 - Como usuário Jurisdicionado quero visualizar notícias que o TCE por ventura virá a publicar referente as obrigações de prestação de contas, como prorrogação de período de apuração, notificação de data limite de prestação de contas, período de retificação das prestações de conta com críticas etc.
As notícias referentes à prestação de contas das atividades do jurisdicionado ao TCE-GO, publicadas como notícia deve apresentar no produto de software ContEx (portal), de modo que o usuário jurisdicionado possa visualizar o tópico da notícia e o conteúdo completo.
Estas notícias são cadastradas pelo perfil de usuário da Secretaria de Controle Externo, com a criação de um novo item do menu de tipos de notícia, habilitar esse menu para ser acessado pelo usuário da Secretaria de Controle Externo, isso na Gerência de Websites.
- HU.08 - Como usuário Jurisdicionado quero visualizar meus recibos de prestação de contas já enviados ao TCE, para que possa utilizar os recibos como garantia de que foi ou não prestado contas, dentro ou fora do período de obrigação, e a qualquer momento imprimir o recibo para comprovação.
Os usuários jurisdicionados ou do Controle Externo do TCE-GO, poderão visualizar os recibos de entrega das apurações das atividades dos jurisdicionado, sendo que o primeiro irá visualizar apenas as suas prestações de contas.
Essa funcionalidade permitirá consultar filtrando por dimensão, por layouts, período de recebimento da informação, período de referencia das apurações, se entregue dentro do prazo ou fora do prazo, e podendo filtrar pelo número do protocolo de envio da informação.
- HU.09 - Como usuário Jurisdicionado quero validar os arquivos de prestação de contas que estamos criando para enviar ao TCE, validando se estão corretos quanto à estrutura do layout, antes de enviar em ambiente definitivo
O TCE-CONTEX deverá disponibilizar um serviço de homologação de arquivo, o qual irá apenas verificar a estrutura da entrega da informação, se a mesma está em conformidade com a especificação do layout do arquivo, e de acordo com os conjuntos de informação para o calendário-dimensão para o período de entrega.
- HU.10 - Como usuário Jurisdicionado quero visualizar as críticas que as obrigações enviadas ao TCE tiveram por recibo, para que possam ser feitos os reparos necessários para regularizar.
A entrega das informações de prestação de contas das atividades dos jurisdicionados serão verificadas quando a configuração do calendário de obrigações (conjunto de arquivos que compõem o calendário) e quando a especificação de cada arquivo de informação (layout do arquivo), isso na primeira etapa do processo. Já a consolidação das informações quanto ao negócio, isso na segunda etapa do processo de Controle Externo do recebimento das informações.
O processo de validação da informação que avalia os aspectos de regras de negócio é escopo do módulo Extrator de dados, que será melhor especificado em outro projeto. As criticas geradas nas verificações e nas validações das informações serão apresentadas ao usuário jurisdicionado e ao usuário do Controle Externo, para cada arquivo de informação recebido.
Deve-se apresentar também os calendários-dimensões com situação de não entregue.
- HU.11 - Como usuário Jurisdicionado quero enviar as obrigações de prestar contas ao TCE via Portal Web ou via Web Service
A interface de prestação de contas das atividades dos jurisdicionado deverá possibilitar que seja feita via Portal do Jurisdicionado, com o upload de arquivo XML, ou via Web Service, na chamada de serviço.
Em ambas as situações, o usuário remetente da informação deverá ser autenticado como usuário da plataforma TCENet, o qual será permitido prestar contas apenas do calendário-dimensão cadastrados para o jurisdicionado logado.
O sistema ao receber os arquivos identifica no Header as informações da Dimensão, layout e período de apuração, sendo que com estes dados será identificado o Calendário-Dimensão que o jurisdicionado está prestando conta.
Após esta identificação o sistema valida a estrutura do layout recebido e registra a situação de conformidade deste arquivo, realizando o processamento de todos os layouts disponibilizado para aquela dimensão.
Os layouts que foram recebidos e para qual período de apuração, além de registrar um recibo das informações por calendário e dimensão e também um protocolo de recebimento de cada layout.
A prestação de contas das obrigações configuradas por calendário de obrigações, deverá apresentar sempre todo o conjunto de arquivos que compõem o calendário, para os períodos de atividade configurados no calendário. Para os períodos que não tem movimentação, deverá apresentar no arquivo de apresentação de contas do arquivo um identificador de que não tem movimentação no período de atividade.
No âmbito dos recebimentos das informações para um calendário-dimensão, o sistema irá validar se a estrutura do dado recebido está em conformidade com o layout-versão atribuído ao calendário.
- HU.12 - Como usuário da Secretaria do Controle Externo, quero alterar o layout de determinado arquivo, caso exista calendário de obrigações vinculado ao layout atualizado e cujo período de prestação de contas à data de publicação do layout esteja contido, o sistema me questione se desejo atualizar os calendários nessa situação
Alteração do layout do formulário no TCE-Informa, caso exista calendário que o período de entrega das informações esteja contemplando o recebimento na data de publicação do novo layout, o sistema informa irá questionar o usuário se deseja atualizar os calendários afetados para a nova versão do layout. Sendo que essa atualização caso tenha calendário sem receber informação o calendário será alterado na integra, e para os calendários que já tem informação será encerrado o período do calendário corrente para a data de publicação do novo layout e criará novo calendário com a data inicial no dia posterior a data de publicação e a data final com a data final do calendário encerrado.
Deve verificar como os usuários interessados nessa alteração serão informados desse ajuste, como criação de notícia automática e/ou enviar email aos interessados.
- HU.13 - Como usuário da Secretaria do Controle Externo, quero que o sistema envie email informativo aos jurisdicionado, sobre período de prestação de contas, alteração, prorrogação ou cancelamento de obrigação de prestação de contas, alerta de que faltam 5 dias para encerrar o prazo de prestação de contas e outras situações.
Nesta funcionalidade deverá prever um mecanismo de envio de email aos jurisdicionados relacionados aos calendários-dimensões. Sendo que, o usuário pode selecionar todos os calendários apresentados que ele deseja realizar uma notificação. O sistema permitirá que sejam cadastradas mensagens padrões e que o usuário escolha a mais adequada a situação do envio.
O sistema permitirá também nesta funcionalidade que o usuário selecione o envio automático de email ao jurisdicionado que tenha alguma obrigação ainda não entregue que o prazo de recebimento já tenha expirado. No caso de envio o sistema deve marcar a situação.
5.3. Requisitos de Segurança
O consumo dos serviços do TCE-CONTEX, seja no envio ou na consulta via Web Service ou Portal, deverá ser realizado via protocolo seguro HTTPS, utilizando o certificado digital do TCE-GO. Além disso, o usuário de acesso deverá estar autenticado no sistema, com o usuário do TCENet.