DET - Documento de Especificação Técnica Produção de Documento [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.
====== DET - Documento de Especificação Técnica Produção de Documento ======
===== 1. Informações Gerais sobre o Levantamento =====
==== RESPONSÁVEL PELA ELABORAÇÃO ====
| **Unidade**  | **Nome**                        | **Fone**  | **e-mail**                |
| GER-TI       | Cassio Guilhermy Tavares Souza             || cguilhermy@tce.go.gov.br  |
| GER-TI       | Igor Vinicius dos Santos Silva  |           | ivinicius@tce.go.gov.br   |

===== 1. Descrição das Necessidades =====
Com a criação de uma 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 produção documental. Essa funcionalidade deverá ser disponibilizada no módulo do TCE-Docs para todos os usuários do Tribunal de Contas do Estado(TCE-GO) que possuírem permissões ao sistema, a funcionalidade deverá possibilitar a criação, e edição de documentos conforme padrão de configurações definidos para tratar cada assunto de negócios do Tribunal de Contas do Estado.

==== ====

===== 2. Premissas e Restrições =====

  - Estamos considerando para o desenvolvimento da integração com o Microsoft Word, a versão "Microsoft Office Professional Plus 2016" e "Microsoft Office 365 ProPlus" que será adquirida pelo TCE-GO.
  - 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.

===== 3. Estórias de Usuário =====
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:
^Código^Descrição|-
|EU.01|COMO usuário do TCE-GO QUERO confeccionar documentos conforme modelos previamente definidos PARA que minhas recomendações, ou citações sigam o padrão definido pelo TCE-GO.|

A especificação de criação de Documentos através da integração Web Api, está descrita no [[pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_esp_tec_integracao_docs_plugin|Documento de Especificações Técnicas de Serviços Web Api]].

===== 4. Proposta de Solução =====
**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.**


==== 4.1. Pesquisa de Documento ====
A funcionalidade de "Pesquisa de Documentos" deverá ser disponibilizado no menu de "Documentos" através do sistema do TCE-Docs
para todos os usuários que tiverem acesso cadastrado através do Módulo de Autorizações atribuídas pelo Supervisor do Módulo ou Supervisor Geral (Administradores), apenas para documentos não processuais, isto é, documentos que não estão vinculados a processos do TCE-GO. A propriedade que determina se o documento é ou não processual é dada pelo Tipo de Documento, no qual tem um atributo que define se é ou não processual.

Essa funcionalidade será responsável por mostrar e pesquisar documentos produzidos, em edição, ou finalizados pelo usuário corrente, juntamente com os documentos vinculados/autorizados ao mesmo, ou ao seu setor vinculado. Nos filtros de busca, o usuário poderá buscar um documento por um tipo de documento, pela descrição de um documento, pelo assunto de um documento, por período de criação, pelo plano de classificação, e pela situação do documento.

Na grid de documentos localizados, será apresentadas na coluna Ação, as ações de Visualizar (botão "V"), Editar (botão "E"), e Assinar (botão "A").

== 4.1.1. Protótipo de Tela ==

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_2.png?1000 |}}

== 4.1.2. Descrição dos Atributos ==
N/A

== 4.1.3. Regras de Sistema ==
N/A

==== 4.2. Produção de Documentos ====
A funcionalidade de "Produção de Documentos" deverá ser disponibilizado no menu de Produção Documental 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 criar, alterar, e excluir (exclusão lógica) um documento conforme configuração de documentos predefinidos de documentos não processuais. A funcionalidade possibilitará ao usuário com as devidas permissões acompanhar também outros documentos que estejam vinculados ao mesmo por meio de grupos de usuários, e autorizações especificas dadas aos usuários do grupo. A produção de documentos será por meio de uma integração com o Microsoft Word por meio da tecnologia “Add-ins for Word JS”. Sendo assim a funcionalidade de produção de documentos terá duas interfaces, a primeira será por meio de integrações de serviços Web API a serem disponibilizados para que outros sistemas possam comunicar com o TCE-Docs para criar, alterar, consultar, e excluir documentos. A segunda interface será pelo portal do TCE-Docs, onde o usuário com as devidas permissões poderá também criar, editar, e excluir documento por meio de um portal web. Na primeira interface, será possível informar os indicadores de modelo do documento através da chave de integração definida previamente. Já na segunda interface, via portal Web, os indicadores de modelo não serão informados, devendo o usuário informar pelo próprio Add-ins for Word JS. 

Para a criação de novos documentos o usuário basta clicar no botão inserir (circulo com o sinal de "mais"). Uma vez pressionado o botão, caso o usuário tenha mais de um tipo de documento com permissão de criar documentos, serão listados em botões menores que serão apresentados acima do potão de inserir. Ao usuário clicar em uma das opções de tipo de documento, o sistema irá criar o documento para o usuário e será feito download do documento. 

Nesse momento caso a configuração de documentos tenha mais de um modelo de documentos vinculado, será apresentada uma caixa de diálogo para que o usuário selecione o modelo de documentos que se deseja utilizar.

Na criação de documento o nome do arquivo, a descrição do arquivo, e o sigilo do documento no momento da criação do mesmo será feita pelo componente Add-ins for JS através de uma aba de manutenção das propriedades do documento, caso o usuário não altere essas informações será dado um nome automaticamente para o documento e por padrão o documento será sigiloso. Na tela de manutenção de documentos pelo portal Web, o usuário poderá alterar as configurações do documento, alterando o nome, descrição, assunto, classificação e sigilo, bem como a possibilidade de adicionar grupos de usuário ou usuário específico para editar e ou visualizar o documento, não sendo possível alterar o tipo de documento e nem a configuração de documento utilizada na criação do documento. O tipo de documento será apresentado ao usuário apenas para consulta.

A aba de manutenção das propriedades do documento no Add-ins Word for JS só será apresentada para os documentos não processuais. Caso o usuário não altere as propriedades será mantidas as propriedades geradas automaticamente pelo sistema.

== 4.1.1. Protótipo de Tela ==
==  ==

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_2.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_3.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_3_1.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_1.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_1_1.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_pagina_inicial_1_1_1.png?1000 |}}

{{ :pres:gerti:servico_de_desenvolvimento_de_sistemas_de_informacao:projetos:tce-docs:documento_producao_word.png?1000 |}}

==  ==
== 4.1.2. Descrição dos Atributos ==

{| class="wikitable"
|-
! scope="col"| Nome Funcionalidade
! scope="col"| Obrigação
! scope="col"| Regras Atributos
|-
| Título
|x
|
{| class="wikitable"
! scope="row"| Finalidade
| Define o título do documento.
| 
| 
|-
! scope="row"| Tipo/Tamanho
| Alfanumérico / 120
| 
| 
|-
! scope="row"| Observação
| N/A
| 
| 
|}
|-
| Descrição
|x
|
{| class="wikitable"
! scope="row"| Finalidade
| Define a descrição ou objetivo do documento que está sendo criado.
| 
| 
|-
! scope="row"| Tipo/Tamanho
| Alfanumérico / 120
| 
| 
|-
! scope="row"| Observação
| N/A
| 
| 
|}
|-
| Tipo de Documento
|x
|
{| class="wikitable"
! scope="row"| Finalidade
|  Define o tipo de documento que será vinculado ao documento.
| 
| 
|-
! scope="row"| Tipo/Tamanho
|Seleção/ 01
| 
| 
|-
! scope="row"| Domínio
|  N/A
| 
| 
|-
! scope="row"| Observação
|  N/A
| 
| 
|}
|-
| Classificação quanto ao Plano de Classificação
|
|
{| class="wikitable"
! scope="row"| Finalidade
|  Define uma classificação do documento, quanto a classe, subclasse, grupo ou subgrupo, configurado no plano de classificação vigente na data de criação/manutenção do documento.
| 
| 
|-
! scope="row"| Tipo/Tamanho
|Seleção/ 01
| 
| 
|-
! scope="row"| Domínio
|  N/A
| 
| 
|-
! scope="row"| Observação
|  A classificação do documento será possível apenas entre as opções de classificação configurada na configuração do documento, o qual foi informado no documento criado/mantido pelo usuário, isso caso na configuração do documento tenha classificação(ões) vinculadas a configuração. Caso a configuração de documentos selecionada no documento não tenha classificação(ões) quanto ao plano de classificação selecionado(s), na manutenção do documento serão apresentadas todas as opções de classificação do plano de classificação vigente, para que seja selecionada uma opção do plano.
| 
| 
|}
|-
| Assunto
|
|
{| class="wikitable"
! scope="row"| Finalidade
|  Classificação do documento quanto ao assunto processual.
| 
| 
|-
! scope="row"| Tipo/Tamanho
|Seleção/ 01
| 
| 
|-
! scope="row"| Domínio
|  N/A
| 
| 
|-
! scope="row"| Observação
|  Caso a configuração de documento selecionada no documento em manutenção tiver assuntos vinculados, as opções de classificação do documento em manutenção quanto ao assunto serão apenas aquelas vinculadas a configuração de documento selecionada. Caso contrário, os assuntos processuais apresentados serão todos disponíveis no sistema.
| 
| 
|}
|-
| Sigilo
|
|
{| class="wikitable"
! scope="row"| Finalidade
|  Define o sigilo do documento.
| 
| 
|-
! scope="row"| Tipo/Tamanho
|Seleção/ 01
| 
| 
|-
! scope="row"| Domínio
|  Não/Sim
| 
| 
|-
! scope="row"| Observação
|  N/A
| 
| 
|}
|}

== Grupo de Usuários / Permissões ==

{| class="wikitable"
|-
! scope="col"| Nome Funcionalidade
! scope="col"| Obrigação
! scope="col"| Regras Atributos
|-
| Painel de Grupos de Usuários/Permissões
|x
|
{| class="wikitable"
! scope="row"| Finalidade
| Define os grupos de usuários que terão acesso ao documento, e o papel de cada integrante dentro do grupo.
| 
| 
|-
! scope="row"| Tipo/Tamanho
| N/A
| 
| 
|-
! scope="row"| Observação
| N/A
| 
| 
|}
|}


== 4.1.3. Regras de Sistema ==