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

Com a criação de um nova suíte de gestão documental denominada de TCE-Docs que será composta por diversos módulos integrados, surge a necessidade da disponibilização de uma funcionalidade de cadastro de modelos de documentos, essa funcionalidade deverá possibilitar aos usuários administradores do sistema do TCE-Docs criar, editar, clonar, e excluir um modelo de documento por meio de uma integração com o “Add-ins for Word JS” com o programa padrão de edição de texto da Microsoft Word. Os usuários administradores poderão mapear um layout de documento dentro do Word, fazer uma pesquisar de modelos de documentos por meio do Add-Ins, definir os indicadores de modelos junto ao layout do documento, e por ultimo salvar o modelo produzido ou editado, para que no momento da criação de um documento, o sistema possa auxiliar ao usuário do TCE-GO criar um documento padrão que siga as normas do mesmo, e substituir os indicadores de modelos por dados da aplicação dentro de um modelo de documento do TCE-Docs, para que algumas informações primordiais já sejam vinculadas ao documento que será redigido.

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. Será de suma importância que todas as alterações no “Modelo do Documento”, dentro da ferramenta de integração com Microsoft Word seja salva pela botão “Salvar” que será disponibilizado dentro da mesma, visto que há limitações na integração, e a mesma não é capaz de capturar o evento do botão “Salvar” do menu do Microsoft Word.

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 Modelos de Documentos” deverá ser disponibilizado no menu de “Modelos 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 os modelos de documentos já cadastrados na base de dados do TCE-Docs, o resultado da pesquisa deverá ser mostrado aos usuários ordenados pela descrição das mesmas. A tela será composta pelas colunas: “Ação”, “Descrição”, e “Data Criação”. A tela também contará com dois botões, um chamado “Filtrar” para buscar os modelos de documentos conforme dados informados pelo usuário, e outro botão chamado “Inserir” para chamar a tela de cadastro de modelos de documentos, e uma gridView com os modelos de documentos já cadastrados no sistema.

Na gridView de modelos de documentos localizados, será apresentadas na coluna Ação, as ações de Excluir (botão “X”), Editar (botão “E”), Visualizar (botão “V”), e Clonar (botão “C”).

Na ação de exclusão de um modelo de documento, o sistema deverá verificar se o modelo de documento a ser excluído está vinculado a alguma configuração de documento, caso exista a ação não poderá ser executada. Caso o modelo de documento não esteja vinculada a nenhuma configuração de documento, o sistema deverá excluir o modelo de documento gerando log de auditorias no sistema do TCE-Docs.

Na ação de editar um modelo de documento, o sistema deverá carregar o modelo de documento com as informações vinculadas, e seus indicadores de modelos para que o usuário possa editar o layout do documento, ou os indicadores de modelos vinculado ao mesmo. Essa edição do layout do documento será dentro da ferramenta de integração com o Microsoft Word, que para ter efeito na base de dados do TCE-Docs, o mesmo deverá salvar o modelo de documento pelo botão “Salvar” do painel de integração com o TCE-Docs.

Na ação de visualização de um modelo de documento, o sistema deverá carregar o layout do documento, juntamente com os indicadores de modelos vinculados ao mesmo, porém o usuário não poderá alterar o modelo do documento, e nem adicionar indicadores de modelos ao mesmo. A visualização deverá bloquear o documento para edição conforme padrão Microsoft Word.

Já na ação de clonar um modelo de documento, o sistema deverá carregar para o plugins de integração Add-ins for Word JS o layout do modelo do documento, juntamente com os indicadores do mesmo para que o usuário possa criar um novo modelo de documento conforme modelo selecionado/Informado.

1. A cada alteração/Edição no modelo de documento, o sistema deverá verificar se o modelo está sendo usado na confecção de um documento. Caso o mesmo esteja sendo utilizado em um confeccionamento de documento, a alteração não deverá ser aplicada ao documento que está sendo produzido, porém os novos documentos deveram seguir o novo layout e indicadores definidos. Caso não tenha nenhum documento sendo produzido pelo modelo de documento alterado, os próximos deveram seguir o layout e indicadores de modelos definidos no mesmo.
2. A cada alteração/Edição no modelo de documento, o modelo deverá ser salvo sempre pela funcionalidade de integração com o Microsoft Word para ter validade na base de dados do TCE-Docs.
3. A cada alteração/Edição no modelo de documento, o sistema de integração com o TCE-Docs deverá gravar logs de auditorias na base de dados, juntamente com a informação binaria do modelo proposto.

A funcionalidade de “Cadastro de Modelos de Documentos” deverá ser disponibilizado no menu de “Modelos 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 cadastrar, alterar, clonar, e excluir um modelo de documento. A funcionalidade possibilitará aos usuários administradores mapear, e definir layouts de documentos para produção de documento dentro do Microsoft Word conforme padrões definidos pelos usuários do TCE-GO. Para isso o usuário administrador do sistema do TCE-Docs, poderá definir e mapear layouts de documentos do zero, ou por meio de uma cópia de outro layout de modelo de documento selecionado/Informado dentro da aplicação do TCE-Docs, poderá também editar, ou excluir modelos de documentos existente no TCE-Docs conforme regras definidas. Para ambos os casos a edição dos mesmos poderá ser pelo portal do TCE-Docs, ou por meio da integração com o Microsoft Word “Add-ins for Word JS”, porém o layout do mesmo será criado/Editado exclusivamente dentro do Microsoft Word.

No cadastro ou na edição de um modelo de documento, o usuário poderá definir e agrupar indicadores de modelos para que na hora da definição do layout do documento dentro do Microsoft Word, o sistema de integração possa disponibilizar um menu lateral com os indicadores de modelos vinculados, para que o usuário defina o local onde as informações da aplicação deverão ser carregadas no momento da produção de um documento. Como o modelo de documento estará sendo desenhado dentro do Microsoft Word, o usuário terá toda a flexibilidade de edição e inserção de dados e objetos dentro do modelo de documento que o editor de texto Word fornece por padrão. Porém para que os indicadores de modelos sejam adicionados ao modelo de documento word, o usuário deverá selecionar o local dentro do arquivo, e posteriormente clicar no indicador que ele queira que seja carregado ao local selecionado. Assim o sistema de integração com o TCE-Docs, fara uma marcação no modelo de documento, que está sendo produzido, para que posteriormente o mesmo saiba onde as informações de indicadores de modelos devam ser carregadas ao documento, na produção de um documento. Em ambos os casos, para que o modelo de documento seja salvo na base do TCE-Docs, o usuário deverá salvar o modelo de documento por meio do painel de integração com Word do TCE-Docs que será disponibilizado a esquerda do documento dentro do Microsoft Word.

Para edição de um modelo de documento já existente, a aplicação do TCE-Docs não fará o versionamento da mesma, ficando como padrão a última edição do modelo de documento que foi editado. Porém os documentos que já estão sendo redigidos com uma configuração de documento definida, esses seguiram até seu termino o modelo de documento/Configuração de documento proposto. Não havendo uma migração/Conversão de layouts de documentos nos mesmos.

Para exclusão de um modelo de documento, o sistema deverá verificar se o modelo de documento está vinculado a alguma configuração de documento. Caso esteja, o sistema não poderá fazer a exclusão do modelo de documento. Caso o mesmo não esteja vinculado a nenhuma configuração de documento, o sistema poderá excluir o modelo selecionado, gerando um log de auditoria do mesmo.

1. Ao termino da montagem do modelo de documento, o sistema deverá validar se existe indicadores de modelos vinculados ao modelo do documento que não esteja sendo utilizados. Caso exista o sistema deverá notificar ao usuário e possibilitar a remoção do vínculo do indicador de modelo do modelo do documento..

A funcionalidade de “Cadastro de Modelos de Documentos Pelo Add-ins for Word JS” deverá ser disponibilizado no plugins de integração com o Microsoft Word 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 permitirá o usuário administrador criar um modelo de documento por meio de uma cópia de outro modelo de documento selecionado, um clone de um modelo de documento principal dentro do Microsoft Word. As regras desta funcionalidade deverão seguir as mesmas definidas no caso de uso “Cadastro de Modelos de Documentos”, exceto que o usuário não poderá excluir um modelo de documento pelo plugins de integração. Para isso o mesmo deverá acessar o portal do TCE-Docs, e no menu de Modelos de Documentos o mesmo selecionar o modelo a ser excluir, e o modelo criado seguir todas as normas e regras definidas no caso de uso.

Na gridView de Pesquisa de um modelo de documento a ser clonado, caso o usuário clique em um resultado apresentado, o sistema deverá carregar para o Microsoft Word o layout do documento para visualização do usuário. Caso o mesmo clique no botão clonar do modelo selecionado, a funcionalidade deverá carregar um novo modelo de documento, com os mesmo layout e indicadores de modelos para que o usuário possa criar seu novo modelo de documento com base no que foi selecionado anteriormente pelo mesmo. No modelo de documento a ser criado por meio de outro selecionado, o usuário poderá adicionar ou remover indicadores de modelo, afim de atender sempre sua perspectiva sobre o layout do mesmo.

1. Caso o usuário tenha informado agrupamento de indicadores de modelos, ou que o mesmo venha da junção de indicadores de modelos de um modelo que está sendo clonado, o sistema deverá verificar ao termino da produção do modelo de documento se todos os indicadores de modelos estão sendo utilizados. Caso exista indicadores de modelo que não esteja sendo utilizado, o sistema deverá comunicar ao usuário, e o modelo de documento não poderá ser salvo na base de dados do TCE-Docs.