DET - Documento de Especificação Técnica Configuração do Documento

A Configuração de Documento foi criada para atender a necessidade de garantir no ato da criação do documento, a padronização seguindo determinados parâmetros como por exemplo, tipo do documento, setor, indicadores e modelo word. Em outras palavras, ao criar um documento, o usuário deve escolher a pré-configuração e o sistema criará um documento baseado nas características estabelecidas na configuração.

Neste contexto, é necessário também que os documentos criados mantenham referência a pré-configuração original mesmo que esta pré-configuração seja modificada posteriormente. Neste caso, o sistema deve guardar a versão original (antes da alteração) e a versão alterada. E isso poderá ser feito tantas vezes quanto necessário. O sistema então, deve controlar uma ou mais versões das configurações de documentos.

Caso haja apenas uma configuração que atenda aos criterios de escolha de um documento, o sistema automaticamente a usará, não havendo a necessidade de apresentar a opção de escolha da configuração. Este e outros aspectos referentes à produção de documento serão detalhados no Documento de Especificação Técnica - Produção de Documento.

É preciso ainda que ao criar um documento, haja predefinido quais setores terão acesso ao documento, dependendo do tipo de documento.

1. Estamos considerando para o desenvolvimento da integração com o Microsoft Word, a versão “Microsoft Office Professional Plus 2016” que será adquirida pelo TCE-GO.
2. Somente administradores do sistema podem acessar esta funcionalidade.

Com base na necessidade acima apresentada, foram identificadas as seguintes Estórias de Usuário, as quais são identificadas pelo prefixo EU (Estória de Usuário) seguida de um número, como apresentado abaixo:

A proposta de solução descrita neste escopo é uma sugestão e poderá sofrer mudanças durante o processo de desenvolvimento, caso se identifique a necessidade.

A funcionalidade de “Pesquisa de Configuração de documento” deverá ser disponibilizado no menu de “Configuração de Documentos” através do sistema do TCE-Docs para todos os usuários que tiverem o acesso cadastrado através do Módulo de Autorizações atribuídas pelo Supervisor do Módulo ou Supervisor Geral (Administradores).

Essa funcionalidade será responsável por pesquisar as configurações de documentos já cadastradas na base de dados do TCE-Docs. O resultado da pesquisa, será a combinação dos campos informados em tela que devem seguir os protótipos abaixo:

Os atributos usados na tela de pesquisa devem seguir as definições dos campos da tela de Cadastro de Configuração de Documentos. Entretanto, o campo Descrição é usado para informar parte da descrição a ser pesquisada.

1. Não será permitido excluir uma configuração de documento caso exista algum documento que use a configuração em questão;
2. O botão de publicação, só pode ser exibido para configurações com situação “Em Edição”;
3. Caso a situação da configuração seja diferente de “em edição”, o sistema deve exibir a tela preenchida com os dados da configuração, somente para leitura;
4. Ao copiar uma configuração, o sistema deve armazenar a configuração (ID) que originou a cópia, afim de manter a rastreabilidade de versões da mesma.
5. Ao copiar uma configuração, o sistema deve bloquear a alteração dos campos Descrição e Tipo de Documento;

A funcionalidade de “Cadastro de Configurações de Documentos” deverá ser disponibilizado no menu de Configuração de Documentos através do sistema do TCE-Docs para todos os usuários que tiverem o acesso cadastrado através do Módulo de Autorizações atribuídas pelo Supervisor do Módulo ou Supervisor Geral (Administradores).

Os indicadores de dados, são um recurso do sistema para extrair informações do documento, manual ou automaticamente. No momento da criação da configuração, será definido quais indicadores serão usados nos documentos que a usarem. Na descrição da funcionalidade de Produção de Documento, será descrita o comportamento e os detalhes da extração dos dados via indicadores. Aqui estamos definindo somente quais indicadores serão usados em todos os documentos que utilizem a configuração.

A ordem de inclusão e de agrupamento por seção é superimportante visto que esta ordem será usada na visualização dos indicadores de dados dentro da ferramenta de integração com o WORD.

O usuário deve informar os setores que poderão visualizar a configuração na produção de documentos, os grupos de usuário que terão acesso ao documento e demais informações que estão definidas no protótipo.

A definição e os detalhes de quais usuários ou grupos de usuários deverão assinar os documentos criados a partir de uma configuração, serão tratados no Documento de Especificações Produção de Documentos .

Um Modelo de documento é composto por duas partes: um registro em sistema e um modelo word (arquivo dotx). Sua manutenção será tratada no Documento de Especificação Técnica Modelos de Documentos. Aqui ele é apenas um campo para que o usuário selecione o modelo desejado.

Essa Tela será responsável por incluir ou alterar uma configuração de documento.

A inserção de Indicadores de Dados é opcional, Entretanto, para inserir um indicador à configuração, deve-se respeitar os campos marcados como obrigatórios.

1. Ao acionar a opção de “Salvar”, o sistema deverá realizar as devidas consistências nos dados informados quanto à obrigatoriedade, tipo, tamanho, composição, e demais regras definidas na “Descrição dos Atributos”. Caso exista alguma informação inconsistente, o sistema deverá exibir uma mensagem informando a inconsistência, e não salvar as informações. Se as informações estiverem consistentes, o sistema deve salvá-las persistido na base de dados do TCE-Docs.
2. Ao acionar a opção de “Salvar”, o sistema deverá obedecer a regra de Unicidade do Tipo de Documento, Setor e assunto. Ou seja, para cada configuração de documento (Refere-se tipo de documento, pois para cada configuração de documento pode haver somente um Tipo de Documento vinculado) pode haver somente uma configuração de Assunto para um setor específico, ou de um setor para um assunto específico, mesmo que uma ou outra sejam vazios. Por exemplo: O Tipo de Documento 'ACÓRDÃO' pode ter somente uma configuração, não ligada a nenhum setor e a nenhum assunto (Genérica). Se ao criar outra confiugração de documento, selecionarmos ACÓRDÃO e tentar salvar, com o assunto e setor em branco, o sistema não deverá deixar, e a regra vale assim por diante. Resumindo, é permitido apenas uma configuração do conjunto das configurações (Tipo de Documento, Assunto e Setor).

Para cada uma das ações de Criação, Edição, Exclusão e Publicação, o sistema deve armazenar data, hora e o usuário encarregado pela ação.
No entanto, na descrição da funcionalidade de Log será descrito o comportamento, os detalhes de persistência e visualização detalhada de informações para auditoria.