Manual Operacional da customização - Integração Identity Provider

Req. 01 – Parâmetros da Integração 

Objetivo do Requisito

Foi criado uma nova interface de parâmetros para identificar os perfis de usuários considerados alunos, a situação de matrícula que indica matrícula ativa e os dados necessários para conexão, referentes ao novo processo de exportação de usuários para o Identity Provider Nacional.

Criada uma nova interface chamada Parâmetros - IDP Nacional para conter o novo parâmetro e outros que forem necessários para a Integração do TOTVS Educacional com Identity Provider.

Detalhamento do Processo

Estará disponível em: TOTVS Educacional | Sistema Indústria | IDP Nacional | Parâmetros. 

A interface exibirá os seguintes campos: 

• Perfil Usuário - Aluno: O campo será do tipo lookup e terá como objetivo permitir que o usuário informe os perfis de usuário de aluno, para customização identificar os usuários que são alunos no momento da exportação para o Identity Provider Nacional. Esse parâmetro será por Coligada. 
• Situação de Matrícula - Matriculado: O campo será do tipo lookup e terá como objetivo permitir que o usuário informe as situações de matrícula do aluno para customização identificar os alunos que possuem matrículas ativas no período letivo. Serão exportados apenas os usuários de alunos com matrículas ativas. Esse parâmetro será por Nível de Ensino. 
• Token: Campo do tipo texto onde o usuário deverá informar o token de acesso à API de integração com Identity Provider. Esse valor deverá ser preenchido com a informação repassada pelos responsáveis pela API.
• WebService SENAI: Campo do tipo texto onde o usuário deverá informar a URL do WebService da API integração com o Identity Provider. Esse valor deverá ser preenchido com a informação repassada pelos responsáveis pela API.
• Owner ID: Campo do tipo texto onde o usuário deverá informar o identificador do regional na API SENAI. Esse valor deverá ser preenchido com a informação repassada pelos responsáveis pela API.

Objetivo do Requisito

Exportar do SGE para o Identity Provider Nacional (IDP WSO2) os dados de usuário criados no SGE de alunos, professores e demais acessos (se associados à uma Pessoa no SGE), independente de terem sido integrados com o Google para criação de e-mail.

• Descrição do processo
• A interface customizada estará disponível em: TOTVS Educacional | Sistema Industria | Integração Sapes| Exportação de Dados. 
• O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job. Para isso é necessário que o ambiente esteja configurado em três camadas para ser executado.
• Detalhamento do processo
• Clique em Exportação de Dados
• 
• 
• A Exportação de Dados para o Sapes será realizada apenas para os alunos que estiverem matriculados nas turmas/disciplinas das modalidades parametrizadas na (Aba Modalidades de Cursos) e quando atingir o número de dias anteriores à data final da turma/disciplina. Esta informação irá definir quantos dias antes do término da turma/disciplina será enviada a Pesquisa de Egresso para o Sapes, com a lista de dados das matrículas dos alunos.
• Serão exportados dados dos alunos após atualizar a Analise Curricular, de acordo com as seguintes regras:
• Alunos com status de matrícula diferente de concluinte e matriculado não integram na primeira carga.
• Aluno com status de matricula que indica pendências em pelo menos 1 disciplina, não será integrado. (Ex: Evadido, Trancado, Cancelado, Reprovado etc..)
• Para os casos de alunos que tiveram a situação de matrícula alterada após serem integrados na primeira carga, caso tenha apresentado alguma pendência após o envio (foi reprovado por exemplo), o processo customizado deverá enviar o registro do aluno novamente, com atual situação após alteração do status (para cancelar o envio no SAPES).
• Para o envio dos dados ao Sapes, a customização irá consumir o método do Webservice parametrizado, sendo enviadas informações do aluno, da unidade, do curso e da modalidade.
• Após processamento, o Sapes retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro. Ao final do processamento, os registros serão gravados em tabela customizada de log, com dados como: data da criação, usuário responsável, dados enviados, dados recebidos, mensagem de erro e status do registro na integração.

Pré-requisitos

Para envio da pesquisa de Egresso do Senai, serão considerados os dados dos alunos que estão concluindo determinado curso das modalidades parametrizadas.

Descrição do processo

O menu utilizado ficará disponível em: TOTVS Educacional| Currículo e Oferta | Turma | Processos| Exportar Dados para o Sapes, para ser executado de forma manual pelo usuário.

Detalhamento do processo

Ao clicar no processo, será exibida tela com a lista de aluno da turma selecionada, para que o usuário selecione todos ou apenas os desejados. O processo enviará ao Sapes uma lista de dados das matrículas dos alunos selecionados que atenderem aos requisitos pré-definidos. Se ocorrer alguma atualização dos dados após o envio, o processo irá identificar a modificação e enviar a atualização para o SAPES. 

Serão exportados dados dos alunos após atualizar a Analise Curricular, de acordo com as seguintes regras:

• Alunos com status de matrícula diferente de concluinte e matriculado não integram na primeira carga.
• Aluno com status de matricula que indica pendências em pelo menos 1 disciplina, não será integrado. (Ex: Evadido, Trancado, Cancelado, Reprovado etc..)

Observação: O Processo de Exportação de Dados para o Sapes por Turma, permite selecionar apenas um registro de turma, por processamento. Caso o usuário selecione mais de uma turma, será exibida a seguinte mensagem.

Pré-requisitos

Não se aplica.

Descrição do processo

O objetivo da Interface de Log é armazenar informações e status dos dados que foram exportados do SGE para o Sapes.

Detalhamento do processo

Será possível acompanhar os status dos dados de matrículas dos alunos enviados para o Sapes. Nesta interface será possível identificar os status dos alunos integrados. Não será permitida a inclusão, alteração ou exclusão de registros nesta interface. Os dados exibidos nesta interface ficam armazenados na tabela customizada ZDOCSIGNMONITOR. Os históricos das exportações de dados para o Moodle serão registrados e poderão ser visualizadas no menu TOTVS Educacional | Sistema Indústria | Integração Sapes| Monitor de Log.

Na tela de log estarão disponíveis os seguintes campos: 

•  Id Log: Identificador sequencial de Log.
•  Campos Chave: Descrição dos campos utilizados para gerar o registro integrado. 
•  Valores Chave: Chave primária do registro integrado. 
•  Status: Situação da Integração (Sucesso ou Erro). 
•  Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação de Dados). 
•  Módulo: Tipo da integração que está sendo feita.
•  Data de Criação: Data de Criação do registro. 
•  Data da última alteração: Data da última alteração do registro.

Ao acessar o anexo de um registro será possível o usuário visualizar todos os registros relacionados ao cadastro integrado selecionando a opção Item de Log. Estarão disponíveis os seguintes campos:

• Id. Item Log: Identificador sequencial de log; 
• Id. Log: Identificador sequencial de log;
• Mensagem: Mensagem com o status da integração do item; 
• Status: Situação da integração do item selecionado;
• Dados Enviados: Relação dos dados enviados para integração;
• Dados Recebidos: Relação dos dados recebidos;
• Data de Criação: Data de criação do registro;

• Data da última Alteração: Data da última alteração do registro.

  
  

Pré-requisitos

Possuir registros enviados com erro.

Descrição do processo

O objetivo do processo de reenvio de dados é permitir o envio para o Sapes dos registros que não foram exportados corretamente. Esse processo poderá ser executado manualmente ou poderá ser agendado, por registro (com status de cancelado, erro ou pendente) e a integração efetuará a exportação dos registros novamente.

Detalhamento do processo

O Reenvio de Dados, que ao ser acionado a customização tentará realizar novamente o envio das informações ao Sapes. A funcionalidade estará disponível na tela de Monitor de Logs, menu TOTVS Educacional | Sistema Indústria | Integração Sapes| Monitor de Log | Processos | Reenvio de Log.

Neste exemplo abaixo o envio apresentou o status de erro;

Selecione o erro que desejo reenviar,clicar em processos, reenvio de log;