DET - Documento de Especificação Técnica Controle de Numeração de Documentos

O sistema TCE-Docs deverá gerar numeração para documentos conforme configuração de numeração por Tipo de Documento, dessa forma caso não tenha configuração de numeração para o tipo de documento, o sistema TCE-Docs não vai gerar numeração para os documentos criados desse tipo de documento. Essa numeração quando gerada pelo TCE-Docs, deve ser controlada de modo a garantir a disponibilidade do serviço de geração de numeração conforme configuração.

São restrições do controle de numeração de documentos:

• A numeração do documento não será aplicada formatação para apresentação da numeração, devendo o usuário criar a sua formatação de apresentação da numeração no documento utilizando os indicadores do tipo modelo.
• A numeração do documento será incluída como Indicador Fixo do tipo Modelo.
• O controle de gerar numeração ou não, bem como de que forma (se geral para o tipo de documento, ou por ano ou setor de origem do documento) será de inteira responsabilidade de quem configurou o controle de numeração.

A estória de usuário que representa a necessidade acima apresentada é a estória:

O controle de numeração de documentos será controlado por Tipo de Documento. O controle de numeração poderá ser geral por Tipo de Documento, e ser por Ano, e/ou ainda ser por Setor origem do documento. A configuração por ano e setor poderá ser conjunta, isto é, a cada ano a numeração será zerada para o setor origem do documento.

A numeração por tipo de documento poderá mudar durante o ciclo de vida do tipo de documento, nesse sentido, a configuração de numeração dos documentos deverá ser configurada para iniciar em uma determinada data, assim a configuração de numeração anterior se encerrará no dia anterior a data de início da próxima configuração de numeração. Dessa forma mantendo o histórico de numeração do controle de numeração anterior.

O momento de geração da numeração do documento será sempre no momento de enviar o documento para assinatura. Dessa forma, quando um documento for criado quando a configuração do controle de numeração em vigência era um e no momento da assinatura for outro, a numeração deste documento irá respeitar o controle de numeração vigente, visto que a regra está no momento de enviar para assinatura, o que ocorreu no momento do controle de numeração atual.

O controle de numeração será permitido apenas uma configuração ativa (vigente) por Tipo de Documento. Dessa forma, o sistema deverá validar se a configuração cadastrada, a data de início de vigência informado não é retroativa, isto é, data menor ou igual a data inicial do controle atual e não seja menor que a data atual.

A funcionalidade de controle de numeração estará acessível pela opção do menu Controle, através da funcionalidade Controle de Numeração de Documentos, como apresentado abaixo:

Quando o usuário acessar a funcionalidade Controle de Numeração de Documentos, o sistema irá apresentar a tela de aterrissagem na qual serão listados os controles de numeração cadastrados.

Na tela de aterrissagem o usuário poderá utilizar filtros para auxiliar na localização de determinados controles de numeração, através do botão Filtros. Quando o usuário acionar esse botão, será apresentado os campos Tipo de Documento (campo de pesquisa do tipo de documento do controle que deseja pesquisar), o campo Situação (situação do controle de numeração) e o período de vigência, como apresentado abaixo:

A funcionalidade de manutenção de numeração de documentos, o usuário irá configurar por Tipo de Documento o controle de numeração para serem gerados para os documentos criados no momento de enviar para assinatura. Esse controle poderá ser geral para o tipo de documento, ou ser incremental por ano ou ainda por setor. O usuário ainda irá definir a data de início da vigência do controle que deverá ser maior ou igual a data corrente, e deverá ser maior que a data de início vigência do controle de numeração vigente à época da criação do novo controle de numeração. Dessa forma, a data final da vigência será um dia antes do início de vigência do próximo controle de numeração. Segue abaixo a proposta de tela para essa funcionalidade.

Através do botão “L” da tela de aterrissagem do Controle de Numeração de Documentos, o sistema irá apresentar os logs de controle de numeração. Os logs serão gerados com todas as operações realizadas pelo sistema durante o ciclo de vida do controle de numeração, dês da sua criação até o momento que o sistema altera a situação para inativo no momento que será obtida a primeira numeração para um documento de um novo controle de numeração. Dessa forma toda chamada do serviço de obtenção de numeração de um documento será registrado log do controle de numeração, seja geral, por ano e/ou por setor. Segue abaixo proposta de tela de visualização de logs do controle de numeração.

N/A

1. Não poderá ser excluído um controle de numeração que já tenha numeração registrada;
2. Não poderá ser alterada a configuração do controle de numeração (marcar ou desmarcar as propriedades Controlado por ano? e Controlado por setor?) e o tipo de documento do controle, quando já existir numeração gerada associada ao controle de numeração.
3. A qualquer momento o usuário poderá alterar a situação do controle de numeração para Inativo;
4. Apenas os controles de numeração que não tiver novo controle de numeração com data de vigência acima da data de fim de vigência, poderá ser reativado (retornar para a situação de Ativo).

Para que o controle de numeração seja possível, configurando de forma geral, por ano e/ou por setor, foi modelado nos diagramas abaixo para ilustrar a solução proposta.

• Diagrama de Classes

• Diagrama de Sequência

1. Para a configuração de numeração para o tipo de documento do documento que deseja gerar numeração, o serviço de controle de numeração deverá verificar com base na configuração se é controle geral, ou controlado por ano, ou por setor, ou por ano e setor. Essa verificação será realizada na chamada do método ObtemControleNumeracao. Caso não exista configuração será criado o controle no BD, para controlar a numeração, conforme configuração.
2. A operação de obtenção do controle de numeração ObtemControleNumeracao, bem como a operação IncrementaNumeracao serão controladas de modo a garantir que apenas uma operação para o tipo de documento possa ser executada por vez, por esse motivo que no diagrama de sequencia há o controle de acesso a essas operações, identificado pela notação lock.
3. Só existirá uma configuração de controle de numeração ativa para o tipo de documento, de modo a garantir que no momento de obtenção da numeração realizada pelo documento, o sistema utilize apenas uma configuração de controle de numeração.