MANUAL

DE UTILIZAÇÃO
DO SISTEMA E
CADASTRO DE
DOCUMENTOS
VERSÃO
1.0

ELABORADO POR:
xxxxxx
INTRODUÇÃO
O objetivo deste manual é orientar os usuários quanto a utilização do sistema, desde a
indexação de documentos até a recuperação da informação através da geração de
listagens, bem como, a exportação de documentos contendo os dados indexados. Este
documento apresentará o passo a passo de utilização de cada campo do sistema.
 SOBRE O SISTEMA

O sistema de indexação foi desenvolvido para atender as demandas de automatização da

busca por dados de documentos no arquivo do Ministério do Desenvolvimento Regional.
O sistema consiste no preenchimento de campos pré-definidos para coleta de dados e
mecanismos de busca que, por meio de filtros, auxiliam na recuperação da informação.

O sistema é capaz de exportar os dados em três formatos: PDF, XLS e CSV.

 CAMPOS PARA
ACESSO E CADASTRO
DE USUÁRIO
01
01
02

02 03

04

NOS CASOS EM QUE JÁ HOUVER NOS CASOS EM QUE NÃO HÁ

CADASTRO: CADASTRO:

01 Campo para e-mail: O usuário

deverá inserir um e-mail válido. 01
Campo para e-mail: O usuário
deverá inserir um e-mail válido;

Campo para Nome Completo: O

02 usuário deverá inserir seu nome
02 Campo para senha: O usuário
deverá inserir a senha cadastrada
para identificação no sistema;

e clicar no botão entrar,

Campo para senha: O usuário
destacado em vermelho; 03 deverá inserir uma senha com no
mínimo 6 caracteres;
Cadastre-se: Caso o usuário não
tenha feito cadastro Campo para confirmação de
anteriormente, será necessário 04 senha: O usuário deverá repetir a
acessar a tela de cadastro. senha inserida no campo
anterior;

Clique no campo cadastro para

concluir a ação.
Caso o usuário não tenha cadastro no sistema, a mensagem abaixo será exibida, portanto,
para acessá-lo é necessário efetuar o cadastro seguindo os passos descritos
anteriormente.

Após a realização do cadastro, o sistema apresentará a seguinte mensagem:

Formulário de Cadastro
de Documento
(aba ‘Cadastro’):

Para a padronização do cadastro, foram realizados estudos das normas e padronizações

brasileiras e internacionais, sendo utilizada como base principalmente a Norma Brasileira de
Descrição Arquivística (NOBRADE), que estabelece as diretrizes para descrição de
documentos arquivísticos no Brasil, compatíveis com as normas internacionais ISAD e ISAAR.

Para efetuar o cadastro do documento, aparecerá a seguinte tela:



Seção 1: Localização do Documento

Na primeira seção de cadastro, são inseridas as informações referentes à localização física

dos documentos:

01 02 03

04 05 06

Campo ‘Caixa Antiga (CA)’: Quando Campo ‘Estante’: Deve-se inserir a

01 houver, deve-se inserir o número de 05 identificação da estante,
caixa na qual o documento estava determinada por letras, na qual
antes da ordenação; determinado documento se
encontra;
Se trata de um campo importante,
por manter o histórico de produção Campo ‘Prateleira’: Deve-se
do documento, bem como, a 06 inserir a identificação numérica da
prateleira na qual determinado
referência de localização que os
usuários que transferiram essa documento se encontra;
documentação para o Arquivo
Central mantém.

Campo ‘Caixa Nova (CN)’: Deve-se

02 inserir o número de caixa na qual o
documento foi armazenado,
número esse, que foi atribuído
após a ordenação;

Campo ‘Conjunto de Módulo’: Deve-

03 se inserir a identificação numérica

de um dos conjuntos de módulo,
dentre os cinco no qual determinado
documento se encontra;

Campo 'Módulo': Deve-se inserir a

04 identificação numérica do
módulo/corredor no qual
determinado documento se
encontra;


Seção 2: Dados do Documento

Nessa seção, são inseridos os dados gerais do documento, principalmente no que diz respeito
ao seu contexto de produção.

01 02 03

04 05 06 07

08 09 10

Campo ‘Procedência’: Identificação da procedência imediata do documento;

01
Conforme definição do Dicionário de Terminologia Arquivística, a procedência é o
termo empregado para designar a origem mais imediata do arquivo, quando se trata
de entrada de documentos efetuada por entidade diversa daquela que o gerou.

Campo ‘Órgão Produtor’: Deve-se inserir a identificação do órgão produtor no qual

02 o documento foi produzido;

No caso do Ministério do Desenvolvimento Regional pode ser uma das opções

predefinidas que o sistema apresenta, conforme o histórico do Ministério:
Ministério da Justiça e Negócios Interiores
Ministério do Interior
Secretaria de Desenvolvimento Regional
Ministério da Integração Regional
Ministério das Cidades
Ministério da Integração Nacional
Ministério do Desenvolvimento Regional

Campo ‘Código de Classificação’: Deve-se inserir a identificação do código de

03 classificação. Seguindo os padrões da Portaria n°47 do Arquivo Nacional ou do
Código de Classificação de Documentos da área fim do Ministério;
 01 02 03

04 05 06 07

08 09 10

Campo ‘Nº de Documento’: Campo ‘Tipo Documental’: é a

04 Identificação do número do 09 configuração que assume uma espécie
documento, sendo ele um Número documental de acordo com a atividade
Único de Protocolo (NUP) ou outro que a gerou. (Dicionário de
identificador numérico. Terminologia Arquivística, 1996)

Campo ‘Volume’: Quando houver, o São exemplos de tipos documentais:

05 campo deve ser preenchido com a
identificação do número do volume
do documento.
Campo ‘Formato’: Deve-se inserir a
ata de reunião, ata de posse, boletim
informativo, diário de obra, ficha
financeira, formulário de transferência
de material, processo de apuração de
responsabilidade , etc.

06 identificação do formato do
documento que consiste nas
Campo ‘Ponto de Acesso’: Onde se
“características físicas de 10 registra os termos selecionados, onde
apresentação, das técnicas de
os padrões são decididos a cada
registro e da estrutura da
conjunto documental, para localização
informação e informação do
e recuperação da unidade de
conteúdo de um documento no que
descrição.
diz respeito à espécie documental”.
(Dicionário de Terminologia
São exemplos de pontos de acesso:
Arquivística, 1996)
Nome próprio: Júlio Flávio
Gameiro Miragaya;
São exemplos de espécie
Trechos de passagens: Trecho:
documental: ata, processo,
BSB/FOR/BSB;
memorando, ofício, planta, relatório,
Trecho ou km das obras: TRECHO
etc.
IV - RAMAL DO APODI;
Nome de projeto ou programa:
Campo ‘Data Inicial’: Data de Programa de Geração de Emprego
07 criação do documento. e Recuperação de Renda em áreas
de pobreza do Estado de Alagoas;
Órgão que solicita uma
informação;
08 Campo ‘Data Final’: Data de
conclusão do documento.
Nome de uma empresa: Empresa
Magna Engenharia LTDA.
 Seção 3: Demais Informações

Nessa seção são inseridas as informações referentes a informações adicionais dos

documentos.

01 02 03

Campo ‘Assunto’: Deve-se inserir a identificação do assunto do documento,

01 conforme os dados que o documento já apresenta, geralmente na capa, conforme
exemplo a seguir:

Campo ‘Órgão Produtor’: Deve-se inserir a identificação do órgão produtor no qual

02 o documento foi produzido;

No caso do Ministério do Desenvolvimento Regional pode ser uma das opções

predefinidas que o sistema apresenta, conforme o histórico do Ministério:
Ministério da Justiça e Negócios Interiores
Ministério do Interior
Secretaria de Desenvolvimento Regional
Ministério da Integração Regional
Ministério das Cidades
Ministério da Integração Nacional
Ministério do Desenvolvimento Regional

Campo ‘Código de Classificação’: Deve-se inserir a identificação do código de

03 classificação. Seguindo os padrões da Portaria n°47 do Arquivo Nacional ou do
Código de Classificação de Documentos da área fim do Ministério;
Vale destacar que, no campo cadastro existem alguns campos obrigatórios, destacados em
azul, sem o preenchimento destes, não é possível cadastrar um documento. Após a
inserção dos dados corretamente, basta clicar em ‘Cadastrar Documento’ destacado em
vermelho:

Caso os campos obrigatórios estejam preenchidos corretamente, o sistema mostrará

uma mensagem no navegador:

O sistema possui ainda, a função de cadastro de documentos anexos e/ou apensos ao
documento principal já cadastrado. O botão ‘Adicionar Anexo ou Apenso’ destacado em
vermelho, ativa o formulário para a inclusão de um documento anexo, para inseri-lo,
basta inserir os dados solicitados e selecionar a opção “ Salvar anexo”.

É possível adicionar mais de um anexo, e todos eles ficam listados abaixo da seção 3, na
seção de anexos conforme imagem a seguir:

É de suma importância verificar atentamente todos os campos preenchidos no

cadastro, pois pelo fato de sua maioria serem campos de inserção manual, sem
palavras pré-definidas, sem a devida atenção, podem acarretar erros que irão
prejudicar a recuperação do documento.
 Aba 'Listagem':

A segunda aba do sistema, é destinada à recuperação da informação dos documentos já

cadastrados. Através desta aba é possível filtrar os campos de busca conforme as
demandas dos usuários, os mesmos campos da aba de cadastramento se encontram nos
filtros conforme figura a seguir:

Filtrar: Botão para exibição dos filtros para busca de documentos cadastrados na base.
 Listagem, Busca e Edição de Documentos

Ainda na aba “Listagem”, é possível ainda um ou mais conjuntos de dados de documentos

registrados. Para isso o usuário pode ou não utilizar o recurso dos filtros, quando não
utilizado, o sistema gera todo o universo de dados cadastrados, quando selecionado, o
sistema trará as informações conforme o filtro selecionado.

Além da listagem e da visualização dos dados de um determinado documento, é possível

editá-los:

O sistema conta ainda com opções de ‘Detalhar’, ‘Editar’ e ‘Deletar’ para cada documento
listado;

Na opção de ‘Detalhar’, o usuário poderá visualizar os dados do documento:

Na opção ‘Editar’, o usuário poderá fazer modificações nos dados:

Ainda na opção ‘Editar’, é necessário confirmar a ação para persistir as alterações no

banco de dados. Caso as requisições tenham sido bem-sucedidas, o sistema
retornará uma mensagem de sucesso:

Na opção ‘Deletar’, o usuário poderá remover permanentemente o documento da base

de dados, ficando disponível apenas em arquivos .dump de versões anteriores de
backup:

 Aba ‘Exportação’:

INSERIR O PRINT

Filtrar: Botão para exibição dos filtros para busca de documentos cadastrados na
base.
Campo ‘Selecione o formato’: Definição do formato de saída do documento;
Gerar: Botão para iniciar a geração do arquivo com os dados filtrados para
exportação;
Baixar planilha: Botão para download do arquivo gerado.

No exemplo abaixo, utilizamos o filtro por órgão produtor e selecionamos Ministério

do Interior, portanto, a planilha gerada trouxe apenas os documentos produzidos por
esse órgão.
Sobre a utilização
Opções de usuários

Para acessar o sistema, basta o usuário acessar o servidor a partir do endereço de IP

fornecido após os passos de iniciação do sistema que constam no RT XXXX . A
performance, nesse caso, depende da conexão entre a máquina do usuário e o servidor
na rede compartilhada.

Existem dois tipos de usuário definidos no sistema, cada um com seus respectivos
papéis, fica a critério do MDR, definir quais perfis atribuir aos usuários.

Tipo USER: usuário comum do sistema. Tem acesso a todas as funcionalidades do

sistema, com exceção da opção de editar ou deletar um documento que não foi
cadastrado por ele;

Tipo ADMIN: usuário que, além de ter acesso a todas as funcionalidades do sistema,
também pode editar e deletar os documentos que não foram cadastrados por ele.