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

O manual a seguir visa detalhar as customizações realizadas neste projeto para realizar a exportação de Alunos para o Sapes.


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. E um novo parâmetro chamado “Número de Tentativas de Reenvio". Ele será do tipo inteiro e o usuário deverá definir a quantidade de vezes que um registro processado com erro deverá ser reprocessado. Ele será utilizado quando o usuário agendar ou executar o processo de Exportação de Usuários, marcando o checkbox existente na interface “Reenviar registros com erro”.

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.

No contexto do SGE, um usuário (GUSUARIO) pode ser cadastrado sem necessidade de estar associado a um cadastro de pessoa (PPESSOA). Para alunos e professores, esse vínculo é obrigatório e para qualquer outro acesso (usuários internos, secretaria), o cadastro da pessoa e seu vínculo são opcionais. No contexto desta integração, para que o usuário seja exportado para o IDP Nacional, será necessário cadastrar uma Pessoa no SGE, com seu respectivo CPF e dados necessários para integração, e associar o usuário a esse cadastro, através da interface. Apenas usuários vinculados a um cadastro de Pessoa do SGE serão exportados. 

Apenas usuários vinculados a um cadastro de Pessoa do SGE serão exportados. 

Descrição do processo

Criado um novo processo chamado Exportação de Usuários - IDP Nacional, disponível no menu: TOTVS Educacional | Sistema Indústria | IDP Nacional | Exportação de Usuários, que visa contemplar a nova funcionalidade: Exportação de dados de Usuários SGE para o Identity Provider Nacional. Este processo poderá ser agendado ou executado manualmente pelo usuário. 

Detalhamento do processo

Ao executar o processo, a customização irá identificar todos os usuários criados que ainda não foram integrados com o Identity Provider e os usuários que sofreram alguma alteração nos dados que são enviados, como e-mail Google, por exemplo. 

Observação: O e-mail Google, quando gerado pelo processo customizado de integração com Google, fica gravado no e-mail principal do aluno ou professor. O e-mail principal, sempre que for atualizado, precisa ser enviado para o Identity Provider. 

Para usuários que estiverem relacionados ao perfil de Alunos (parâmetro), serão exportados apenas os que apresentarem matrícula ativa no momento da exportação. O processo irá verificar se existe matrícula ativa (curso em andamento) através do status da matrícula do período letivo e existência do resultado final. Caso o aluno possua matrícula em período letivo com status Matriculado (parâmetro) e com resultado final não preenchido, significa que o aluno tem matrícula ativa (curso em andamento). Caso o aluno não possua matrícula em período letivo ou possua matrícula com resultado final preenchido, não será considerado aluno com matrícula ativa e portanto, não será exportado. Não serão verificados os períodos das turmas associadas à matrícula.

O processo deve contemplar os usuários já criados com matrículas ativas no momento da execução do processo e, quando uma matrícula for criada para um usuário já existente, ele deverá ser identificado com matrícula ativa e exportado. Usuários criados apenas com perfil de aluno sem matrícula ativa não serão exportados. 

Para usuários que não forem alunos: Professores e demais acessos, serão exportados todos os usuários criados com o status do cadastro de usuário (GUSUARIO.STATUS) igual a ativo e que estiverem associados a um cadastro de pessoa do SGE. Para o IDP Nacional, o número do CPF (cadastro de pessoa) é obrigatório (exceto para os estrangeiros). 

Para os usuários alunos, que também desempenham outro papel, como professor ou usuário da secretaria, não será verificado se existe matrícula ativa. Neste caso, prevalecerá a regra de envio do professor e demais acessos: ativo e vinculado a uma Pessoa no SGE.

Para usuários estrangeiros, além das validações de professor e aluno, será aplicada a seguinte regra: Se a nacionalidade do cadastro de pessoa for igual a 10 - Brasileira (tabela fixa do SGE), o CPF será obrigatório e o campo "estrangeiro" será enviado como "false". Caso a nacionalidade não seja brasileira, o CPF não será obrigatório e o campo "estrangeiro" será preenchido com true. Caso a nacionalidade não esteja preenchida, o CPF continuará obrigatório para exportação. 

Todos os usuários existentes no momento da execução, que atendam as condições e que ainda não foram enviados, serão exportados. 

Ao executar o processo e enviar o usuário, o registro é salvo na tabela de integração (interna) para controle de envio dos dados. O envio também ficará disponível na interface de log, para visualização do usuário.  

Para contemplar esse processo, será disponibilizada pelo SENAI uma nova API para que o SGE envie os seguintes dados dos usuários:  

Informação

Origem

Nome

Nome do cadastro de usuário

GUSUARIO.NOME

Nome Social 

Nome social do cadastro de usuário

GUSUARIO.NOMESOCIAL

CPF

CPF da Pessoa associada ao usuário. 

PPESSOA.CPF

Para usuários estrangeiros, este campo não será preenchido

E-mail principal

E-mail principal associado ao cadastro da pessoa.

PPESSOA.EMAIL

E-mail legado ou pessoal

E-mail original do aluno/professor cadastrado antes da geração do novo e-mail google. SALUNOCOMPL.EMAILLEGADO

SPROFESSORCOMPL.EMAILLEGADO

Apenas para Aluno e Professor.

E-mail SENAI Google

E-mail gerado pelo Google para Aluno e Professor.

SALUNOCOMPL.EMAILGOOGLE

SPROFESSORCOMPL.EMAILGOOGLE

Apenas para Aluno e Professor.

Tipo

“aluno”, “docente” e “outros”.

Se o usuário acumular mais de um papel, será enviada a lista.

Data de nascimento

Data de nascimento do cadastro da pessoa, quando preenchida. 

PPESSOA.DTNASCIMENTO

Gênero

Sexo do cadastro da pessoa, quando preenchido. 

PPESSOA.SEXO

F - Feminino ou M- Masculino

Celular

Telefone do cadastro da pessoa. 

PPESSOA.TELEFONE2

Unidades Operacionais

Filiais cadastradas no Anexo Usuário/Filial do cadastro do Usuário

SUSUARIOFILIAL.CODFILIAL 

GFILIAL.NOME

Cidade

Nome da Cidade do endereço do cadastro da pessoa

PPESSOA.CIDADE

UF

Código UF do endereço do cadastro da pessoa. 

PPESSOA.ESTADO.

Registro Acadêmico

RA do Aluno.

SALUNO.RA

Apenas para Alunos.

Estrangeiro

True ou False, de acordo com a nacionalidade informada. 

PPESSOA.NACIONALIDADE

10 = False

Diferente de 10 = True

Alguns dados exportados se referem ao cadastro da Pessoa associada ao aluno ou professor no SGE. Normalmente usuários de secretaria/internos não ficam vinculados a um cadastro de pessoa, mas para serem exportados neste processo, será necessário cadastrar a Pessoa informando os dados necessários para a exportação e vincular o usuário criado. Portanto, se o usuário for cadastrado diretamente na tela de usuários do SGE, ele não estará associado a uma Pessoa e portanto, não estará apto para ser enviado na exportação. Ele só será exportado após ser vinculado à Pessoa (para alunos, precisa atender também a regra da matrícula ativa).

Os dados serão disponibilizados para a API independente de já ter criado sua conta Google, conforme regras de aluno, professor e demais acessos.

A API também será responsável em enviar atualização desses campos, ou seja, toda vez que algum campo for alterado no SGE para o usuário/pessoa, a API do Identity será chamada para atualização, quando o processo customizado for executado.  

  • A responsabilidade referente ao cumprimento das regras definidas na LGPD é do SENAI.
  • Os itens abaixo são de responsabilidade da API do SENAI e não estão previstos neste escopo:
    • Unificar dados de usuários duplicados no SGE no momento do envio dos dados, seja do mesmo regional ou de regionais diferentes. 
    • Tratamento para não substituir dados no Identity Provider, já enviados anteriormente. 
    • Associar usuário Google a usuário do Identity Provider.

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.

  • Após processamento, o Sapes retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro.


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;