DET - Documento de Especificação Técnica Cadastro de Indicadores

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 cadastro de indicadores. Essa funcionalidade deverá ser disponibilizada no módulo do TCE-Docs para os usuários administradores do sistema, os indicadores definidos serão responsáveis por mapear informações primordiais dos documentos produzidos, e transmitidos dentro do tribunal de contas.

Os indicadores serão divididos em duas categorias, sendo indicadores de dados, e indicadores de modelos. Os indicadores de dados irão indicar as informações que serão capturadas do documento para a aplicação, já os indicadores de modelos, serão utilizados para definir os modelos dos documentos dentro do TCE-Docs, as informações desse indicador será da aplicação para o documento, sendo que serão carregados automaticamente na elaboração de um documento.

N/A

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 Matriz de Indicadores apresentará para o usuário que tem acesso a essa opção do menu os indicadores já cadastrados no sistema TCE-Docs. Quando o usuário acessar essa funcionalidade através do menu de acesso, o sistema irá apresentar os indicadores ordenados por descrição, possibilitando através do botão Filtros, consultar pelos filtros Descrição, Tipo de Indicador e Tipo de Dado. Através do botão Inserir, o usuário poderá incluir novos indicadores, através da funcionalidade de Manutenção de Indicador.

Na lista de indicadores localizados, será apresentadas as colunas Ação, Código, Descrição, Tipo de Indicador e Tipo de Dado. A coluna Ação, será apresentado para cada indicador as ações de Excluir (botão “X”), Editar (botão “E”) e Visualizar (botão “V”).

A ação de visualização de um indicador será apenas de mostrar para o usuário qual a configuração do indicador (a descrição, o tipo do indicador - modelo ou dado, o tipo de dado, o tamanho, a precisão, a configuração caso tipo lista, lista tabela e lista web service).

N/A

1. Não será permitido excluir um indicador que já esteja relacionado a um Modelo de Documento;

Como apresentado na seção 2.1., a funcionalidade de manutenção será apresentada no momento de inclusão de novo indicador ou no momento da edição de um indicador existente. Cada indicador, por padrão e de forma obrigatória, deverá ser informada sua Descrição, o Tipo do Indicador e o Tipo de Dado.

Os indicadores do tipo Modelo, serão utilizados para configurar o modelo do documento a fim de formatar o documento na forma de template (modelo Word) do documento que será criado a partir desse template. Já os indicadores do tipo Dado, serão indicadores que irão conter informações relevantes sobre o documento, seja informações obtidas do conteúdo do documento, ou sejam aquelas informadas manualmente em um campo de edição durante a elaboração do documento.

Os tipos de dados de indicadores identificados são:

Para melhor apresentar as funcionalidades para dada tipo de indicador e para cada tipo de dado do indicador, será documentada na seção Protótipo de Tela, o funcionamento para cada tipo de indicador e para cada tipo de dado do indicador.

Na manutenção de indicadores do tipo de dado Imagem, caso o mesmo seja do tipo Modelo, os sistema irá armazenar a imagem no indicador para ser utilizado no modelo do documento (modelo Microsoft Word), como por exemplo o brasão do Estado de Goiás, a logo do TCE-GO dentre outros. dessa forma o sistema irá apresentar a opção de seleção do arquivo para fazer upload da imagem para o sistema.

Já na manutenção de indicadores do tipo de dado Imagem quando for do tipo Dado, a imagem será selecionada na edição do documento documento e relacionada ao indicador.

A manutenção de indicadores do tipo de indicador Modelo e do tipo de dado Texto, o sistema irá apresentar um editor de texto para o usuário informar o conteúdo do modelo textual do indicador de modelo. Esse conteúdo ser armazenado no indicador para ser utilizado na criação/formatação dos modelos de documento, na confecção do modelo de documento Microsoft Word.

Indicador do tipo de indicador Modelo e do tipo de dado Assinatura, o usuário deverá informar se será utilizada a imagem da assinatura no momento de assinar o documento. Esse tipo de indicador será configurado no modelo de documento no local onde ficará a assinatura Digital ou da imagem da assinatura, para incluir a assinatura do usuário assinante conforme cadastro dos assinantes na funcionalidade de Controle de Assinantes.

O usuário assinante, quando o documento estiver para o usuário assinar o documento, e para o indicador de assinatura incluído no documento a propriedade “Utilizar imagem da assinatura manual?” estiver selecionada, o sistema além de incluir a assinatura digital do usuário, também irá incluir no campo selecionado pelo usuário a imagem da assinatura do usuário.

Indicador do tipo de dado Texto poderá ser determinado o tamanho do texto que será informado ao indicador durante a elaboração do documento.

Na manutenção de indicador do tipo de indicador Dado e tipo de dado Numérico, o usuário deverá informar o tamanho (número de dígitos) será permitido informar o indicador e a quantidade de casas decimal, que caso não seja informada será considero como número inteiro.

O indicador de tipo de dado Data e Hora, poderá ser utilizado na configuração dos modelos de documento como sendo Data e Hora, apenas Data ou apenas Horas, conforme configuração do indicador pela sua mascara de configuração.

Na manutenção de indicador do tipo CPF ou CNPJ poderá ser utilizado tanto para CPF quanto para CNPJ, ainda que a informação poderá ser CPF ou CNPJ.

Os indicadores do tipo Lista deverão ser configuradas as opções que compõem a lista, de modo a determinar o valor Chave do campo e o valor da Descrição do campo.

Na manutenção de indicador do tipo de dado Lista Tabela, o usuário deverá informar o nome da Tabela, a Coluna Chave e a Coluna Descrição, todos os campos de preenchimento obrigatório.

Na manutenção de indicador do tipo de dado Web Service, o usuário deverá informar a URL do serviço web, o usuário de autenticação se tiver, e a senha do usuário de autenticação se tiver.

Tela de visualização das opções obtidas na configuração do indicador do tipo de dado Lista Tabela e Lista Web Service.

1. O código do grupo do indicador deverá ser gerado automaticamente.
2. 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 deve exibir 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.
3. Ao acionar a opção de “Excluir”, o sistema deverá realizar um consistências nos dados do indicador, e caso exista dados de um documento vinculado ao indicador do grupo, o mesmo não poderá ser excluído.
4. No TCE-Docs, o indicador de número do processo só será vinculado após a assinatura do documento.

1. Não será permitido alterar o Tipo do Indicador e nem o Tipo de Dado do indicador quando este já esteja relacionado a um Modelo de Documento;

Os indicadores de negócio são um tipo específico de indicadores de modelo. Eles serão usados para compor o modelo durante sua criação, e ao criar o documento terão seus valores obtidos através de uma rotina do sistema que será criada especificamente para cada indicador.

A lista abaixo foi criada com base nos indicadores do sistema GPRO e a forma de obtenção de cada indicador deve ser baseada nas regras existentes nele.

Algumas informações não serão usadas para compor o modelo e não aparecerão no documento mas serão armazenadas para futura utilização. A tabela abaixo contem todos os indicadores metadados que o sistema deverá tratar.

Outros metadados foram citados na documentação do SIGAD, porém foram tratados/implementados como atributos de entidades do sistema.

Após análise e validação, alguns metadados citados pelo SIGAD foram desconsiderados e não serão implementados como indicador e nem como atributos de entidades do sistema.

Os metadados relacionados ao Agente não estão nesta sessão, pois existem no sistema GPAC. Sendo assim, não estão desconsiderados.