Guia de Instalação e Operação
No Simulador de Integração é possível verificar se o Conector está ativo e ter acesso a exemplos de uso das rotas da API do Conector.
Outra função disponível é uma simulação da Gestão de Documentos de um aluno que vai ser diplomado.
É possível gerar e inserir dados fictícios para geração da Documentação Acadêmica e Diploma Digital, além de enviar uma Representação Visual exemplo.
Os documentos de cada aluno estão separados na interface para facilitar a gestão.
As etapas de geração, assinatura e preservação dos documentos são as mesmas do processo manual descrito na documentação do serviço.
Na tela inicial do Simulador de Integração existe um menu com 3 opções para navegação conforme exibido na Figura 1.
A primeira opção é o Deploy do Conector, onde é possível verificar as instruções de como instalar e configurar o Conector Local e verificar se o mesmo está ativo e operante.
Também é possível obter informações de como instalar as bibliotecas clientes para consumir a API do Conector.
As bibliotecas clientes estão disponíveis para as linguagens Java, Python e NodeJS e possuem funções que realizam chamadas para cada rota da API do Conector.
O uso das bibliotecas clientes são opcionais.
A segunda opção da tela inicial do Simulador de Integração é a Gestão de Documentos.
Nessa opção é possível gerenciar todos os documentos que já foram inseridos no Conector além de inserir novos documentos.
A terceira opção da tela inicial do Simulador de Integração é o Workflow de Geração, onde existe informação de todas as rotas disponíveis na API do Conector e também é possível executar chamadas para o Conector pela interface gráfica e ver o código exemplo para cada biblioteca cliente disponível.
Existe ainda um botão de Ajuda (?) para verificar mais informações sobre o Simulador de Integração e ver algumas perguntas frequentes sobre o Serviço do Diploma Digital.
Na tela de Gestão de Documentos são listados todos os grupos de documentos já criados no Conector conforme exibido na Figura 2.
Um grupo de documento se refere a todos os documentos (documentação acadêmica, histórico escolar final, diploma e representação visual) de um aluno.
Também é possível iniciar o processamento de um novo grupo clicando no botão “Novo Grupo”.
O botão leva para a tela de processamento da Documentação Acadêmica (primeiro documento do fluxo de geração).
Nesta tela, conforme exibido na Figura 3, existe um formulário para preenchimento das informações da Documentação Acadêmica.
Os campos são preenchidos inicialmente com dados fictícios e podem ser alterados manualmente. Além disso tem-se a opção de alterar os dados aleatoriamente no botão “Randomizar”.
A partir da versão 0.15.0 é possível gerar documentos NSF marcando a opção de “Gerar documento NSF” no canto inferior esquerdo.
Após enviar os dados para geração, através do botão “Enviar”, será exibido uma tabela onde os status do processamento da Documentação Acadêmica são consultados e exibidos conforme exibido na Figura 4.
O processamento dos Documentos é realizado na mesma forma a qual é descrita na documentação do Serviço do Diploma Digital.
Nesse caso, quando o documento chega no status de “Assinatura Inicializada”, deve-se acessar o RAPSign e realizar as assinaturas necessárias conforme manual próprio.
Após realização das assinaturas, o documento é processado até que chegue no status final de “Documento Válido” conforme exibido na Figura 5.
Nesse momento, a aba do próximo documento a ser processado, o Histórico Escolar Final, será ativada para que os dados sejam preenchidos (conforme exibido na Figura 6) e enviados analogamente a etapa realizada na Documentação Acadêmica.
O processamento do Histórico Escolar Final é realizado da mesma forma e deve ser assinado quando estiver no status de “Assinatura Inicializada”.
E após a conclusão das assinaturas o 9 documento é processado e finalizado com o status de Documento Válido conforme exibido na Figura 7.
Nesse momento, a aba do próximo documento a ser processado, o Diploma, será ativada para que os dados sejam preenchidos, assinados e processados até o status 10 (conforme Figuras 8 e 9).
Por fim, a aba da Representação Visual será ativada. No caso específico da Representação Visual, o arquivo no formato PDF/A deve ser anexado (Figura 10).
a. Credenciais para uso do RAP i. Client ID - ID que identifica unicamente cada instituição b. Credenciais para acesso ao registro de imagens privados do Serviço i. Login ii. Senha
2.2. Conector Local e RAPSign devidamente instalados e configurados.
2.3. Requisitos para Infraestrutura recomendada para instalação do Simulador de Integração:
Serão executados, nesse ambiente, uma imagem Docker.
A configuração mínima é uma Máquina virtual básica com uma CPU e 2Gb de RAM. É recomendado 2 vCPU e 4 Gb de RAM para um processamento mais fluido.
Apesar do Docker virtualizar também para outros sistemas operacionais é fortemente recomendado que a imagem seja utilizada no Sistema Operacional Linux, mais especificamente nas distribuições Ubuntu ou Debian.
Isso é necessário para evitar problemas de configurações que diferem de um sistema para outro, principalmente, configurações de rede.
2.4. Requisitos para instalação do Container
Para o deploy deste projeto, é necessário ter instalado algumas ferramentas de conteinerização: a. Para instalação do Docker Engine execute os seguintes comandos:
a. Para instalação do Docker Compose execute os seguintes comandos:
3.1 Edite o arquivo docker-compose.sim.yml enviado em conjunto com este documento. a. Adicione as credenciais para acesso ao Serviço de Diplomas i. DNS onde o Simulador de Integração será acessado para que a URL da Página Única do Diploma possa ser acessada corretamente (SIMULATOR_DNS_HOST) ii. URL de acesso a API do conector (CONECTOR_API_URL) iii. Client ID (INSTITUTION_ID) b. Realize login no registro privado de imagens do ambiente de homologação
c. Execute o script do docker-compose para: i. Download da imagem atualizada do Simulador de Integração. ii. Configuração automática do banco (criação e execução dos scripts para migração de tabelas). iii. Inicialização dos daemons de processamento de documentos e APIs de Comunicação.
iv. Opcionalmente efetue logoff do serviço de registro de imagens
Para verificar a existência de atualizações no Simulador de Integração deve-se executar o seguinte comando utilizando o docker-compose:
Caso exista a versão mais recente do Simulador de Integração, esta será baixada automaticamente. Após isso, basta reiniciar os containers.
