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

O manual a seguir visa tem como objetivo detalhar as customizações realizadas feitas neste projeto para realizar a exportação de dados de Alunos usuários do SGE para o SapesIdentity Provider Nacional.

Expandir

title	Parâmetros da Integração

Pré-Requisitos / Parametrizações

No TOTVS Serviços Globais, por meio do menu Customização | Controle de customizações ativas, verificar se a customização Lib CNI e Integração Identity Provider está ativada.

Image Added

Descrição do Processo

Esta tela permitirá o cadastro dos parâmetros necessários para efetuar a integração com Identity Provider.

No TOTVS Educacional, por meio do menu

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

Objetivo do Requisito

Criação de 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.

Será 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. Estará disponível em: TOTVS Educacional | Sistema Indústria | IDP Nacional | Parâmetros.

Image Removed

Aviso

title	Sigla Estado - DR

O preenchimento campo Sigla Estado, é obrigatório para a exportação de dados dos alunos para o Sapes.

Descrição do processo

Tela disponibilizada em TOTVS Educacional | Sistema Indústria | Integração Sapes| Parâmetros para que o usuário defina todos parâmetros necessários para efetuar a integração com o sistema Sapes.

Detalhamento do processo

Foi disponibilizada a seguinte tela para informar os dados da integração:

Image Removed

Endereço WebService SAPES: Neste parâmetro o usuário deverá informar o Endereço de acesso ao WebService disponibilizado pelo Sapes. .
Token acesso (Integração): O Token será valor fixo de acordo com cada Regional utilizado na autenticação da Integração com WebService do Sapes.

Image Removed

● Número tentativas de reenvio: Neste campo o usuário deverá informar o número máximo de tentativas que a customização deverá tentar realizar a integração com Sapes dos registros com status de erro.

Image Removed

● Modalidade: Modalidades dos cursos que serão exportados para o Sapes

● Qtde. Dias – Envio Conclusão (Disciplina): campo do tipo texto onde o usuário deverá informar a quantidade de dias anteriores à data final da última matrícula do aluno na última turma/disciplina (STURMADISC.DTFINAL), do último Período do Curso, na Análise Curricular do Curso/Habilitação no SGE, de acordo com a Modalidade do Curso. Esta informação irá definir quantos dias antes da conclusão será enviada a Pesquisa de Egresso para o Sapes, com a lista de dados das matrículas dos alunos

, o usuário administrador efetuará as parametrizações referentes ao processo.

Image Added

A interface exibirá os seguintes campos:

Client ID: 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.
Client Secret: Deverá informar o Client Secret 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: O usuário deverá informar a URL do WebService da API integração com o Google. Esse valor deverá ser preenchido com a informação repassada pelos responsáveis pela API.
Situação de Matrícula - Matriculado: O usuário deverá informar as situações de matrícula que indicam inclusão de aluno, ou seja, que permitirão que seu registro seja integrado com o Identity Provider.
Número de Tentativas de Reenvio: Quantidade de vezes que um registro deve ser reenviado caso seu status seja erro.
Perfil Usuário - Aluno: O usuário deverá informar 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.

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

Expandir

title	Processo de Exportação de dados para Sapes - Automático Usuários

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

Requisitos

O usuário deverá estar vinculado a um cadastro de Pessoa, para que seja possível executar o processo de exportação de usuários do SGE para o Identity Provider Nacional, apenas usuários vinculados a um cadastro de Pessoa do SGE serão exportados.

Descrição do processo

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. O processo customizado de Exportação de Usuários - IDP Nacional estará disponível através do no menu

A interface customizada estará disponível em

:TOTVS Educacional | Sistema

Industria
Indústria |
Integração Sapes
IDP Nacional | Exportação de
Dados
Usuários.

Image Added
O
Este processo poderá ser agendado ou executado
a qualquer momento
manualmente 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
Image Removed
Image Removed
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.
Aviso
title Importante:
As informações serão extraídas de cadastros nativos do SGE, não sendo criado nenhum novo cadastro e/ou campo.
Os dados serão exportados do SGE para o Sapes, onde a pesquisa de egresso será realizada.

Expandir

title	Processo de Exportação de dados para Sapes - Por Turma

.

Image Added

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.

Nota

title	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), a customização irá validar as seguintes regras no processo de exportação:

Serão exportados apenas usuários cadastrados na (GUSUARIO.STATUS) que possuírem status ativo e que estiverem associados a um cadastro de pessoa no SGE.
Para o IDP Nacional, o número do CPF (cadastro de pessoa) é obrigatório (exceto para os estrangeiros).
Serão exportados apenas usuários que possuir matrícula ativa igual a status Matriculado (parâmetro).
1. 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.
2. 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 como aluno e sim como outros usuários.
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.
Usuários criados apenas com perfil de aluno sem matrícula ativa não serão exportados como aluno e sim como outros usuários.
Não serão verificados os períodos das turmas associadas à matrícula.
O processo irá 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 será identificado com matrícula ativa e exportado.

Para usuários que não forem alunos: Professores e demais acessos, a customização irá validar as seguintes regras no processo de exportação:

Serão exportados apenas usuários cadastrados na (GUSUARIO.STATUS) que possuírem status ativo e que estiverem associados a um cadastro de pessoa no SGE.
Para o IDP Nacional, o número do CPF (cadastro de pessoa) é obrigatório (exceto para os estrangeiros).
Para usuários estrangeiros (nacionalidade diferente de Brasileira), além das validações de professor e aluno, o CPF não será obrigatório. Caso a nacionalidade não esteja preenchida, o CPF continuará obrigatório para exportação.

Novo!

4. Só serão exportados usuários que estejam associados a algum perfil no RM em Usuário > Segurança > Perfis.

Image Added

Apenas para usuários estrangeiros, além das validações de professor e aluno, após a exportação com sucesso para os usuários estrangeiros, a API nos retornará um identificador sequencial como CPF, que será armazenado no SGE ao termino do processo (tabela de controle interna).

Todos os usuários existentes no momento da execução e que atendam as condições citadas acima serão exportados.

O Identity Provider possui duas APIS diferentes: uma para inclusão e outra para alteração de usuários. Antes do envio do usuário, é necessário consultar se o usuário existe no Identity Provider através do CPF. Para estrangeiros, utilizamos o código único gerado pelo Identity Provider e devolvido para o SGE. Caso o usuário exista, é chamada a API de alteração, caso seja um usuário novo, API de inclusão.

Aviso

title	Estrangeiros:

Para os usuários sem CPF e que ainda não possuírem o identificador único no SGE (primeira exportação), não será possível verificar a existência do usuário no Identity Provider (será enviado como inclusão).

A API também será responsável em enviar atualização dos dados sempre que algum campo utilizado for alterado no SGE para o usuário/pessoa, a API do Identity será chamada para atualização, quando o processo customizado for executado.

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.

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.

Image Removed

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..)

Image Removed

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.

Image Removed

Aviso

title	Importante

Expandir

title	Monitor de Log

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

Esse processo não possui pré-requisitos, porem para que o mesmo contenha dados é necessário a execução do processo de exportação de dados para a API do Identity Provider.

Descrição do processo

A interface de Log será responsável por controlar todos processos realizados pela integração Identity Provider. Neste cadastro você poderá encontrar qualquer valor referente a um registro exportado. Dessa forma essa funcionalidade representa todo o seu histórico de exportação. Os históricos das exportações de

dados

usuários para o

Moodle

Identity Provider serão registrados e poderão ser visualizadas no menu TOTVS Educacional | Sistema Indústria |

Integração Sapes

IDP Nacional | Monitor de Log.

Image Removed

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

A funcionalidade de Log é baseada em duas visões sendo a primeira o valor de registro principal de usuário que foi exportado para o Identity Provider:

Image Added

Detalhamento dos campos

Id Log:

Campo	Descrição
Id Log

Funcionalidade:

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).

Campos Chave	Representar os campos que forma a chave para um determinado registro, por exemplo, os registros cuja a funcionalidade seja Exportação de Usuários IDP sempre serão formados pela chave CODUSUARIO
Valor Chaves	Representar o valor dos campos chave, por exemplo, um registro cuja a funcionalidade seja Exportação de Usuários IDP o valor da chave seria 96206224058 onde o numero representar o valor do Código do usuário (CODUSUARIO)
Status	Representa o status da última interação com a API do SENAI, podendo ser 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

Data

de Criação

:

Data de Criação do registro.

Data

Data da última alteração

:

Data da última alteração do registro.


Número de tentativas de Reenvio	Quantidade de vezes que um registro já foi reenviado.
Criador por	Usuário responsável pela inclusão do registro.
Alterado Por	Usuário responsável pela alteração do registro.
Módulo	Identity Provider Nacional

O item de log representará a quantidade de vezes que esse usuário teve interações com o Identity Provider, como por exemplo, a quantidade de vezes que o cadastro desse usuário foi atualizado, como na imagem abaixo:

Image Added

Na tela de item de log, ao acessar um registroAo 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;

Campo	Descrição
Dados Enviados	Requisição web que foi enviado para a API do SENAI, sendo que a primeira palavra do texto sempre será o tipo de requisição
Dados Recebidos	Retorno da requisição realizada em forma de objeto, por exemplo, o objeto de usuário que foi criado
Mensagem	A mensagem retornada pela requisição, por exemplo, Not Found (Não encontrado) ou OK (Sucesso)
Status	Representa se a interação desse item com a API do SENAI foi com sucesso ou erro

Os dados informados nesta interface serão armazenados em tabela customizada por Filial.

Informações
Para informações sobre Alteração Status Logs com Erro e o processo de Exclusão de Logs no monitor, acesse o Manual Operacional da Customização - LIB DN

Nota

title	Importante

A cada nova interação com o API do Identity Provider será gerado um novo item de log para o registro principal, ou seja, cada atualização, por exemplo, de um usuário será gerado um novo item de log registro principal do log para o usuário que foi atualizado

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

.

Expandir

title	Processo para de Reenvio de Dados

Pré-requisitos

Possuir registros enviados com erro.

Para e realização do processo é necessário dados registrados no Monitor de log com o status de pendente ou erro para serem reprocessados para a API do Identity Provider.

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 pelo menu de Processos de Monitor de Log, 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

em: TOTVS Educacional | Sistema Indústria |

Integração Sapes

IDP Nacional | 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;

Image Removed

Dados.

Image Added

Image Added

Será permitido o usuário selecionar um ou vários registros com o status de Erro ou Cancelado e poderá ser executado manualmente. Caso o usuário não selecione nenhum registro na visão, o processo de reenvio é executado para todos os registros com status de Erro, e neste caso, pode ser agendado.

Ao ser acionado o processo customizado de reenvio de dados, a customização tentará realizar novamente o envio das dos usuários ao Identity Provider. Caso seja processado corretamente, o status do registro passará para Sucesso.

Os registros com erro também são reprocessados pelo próprio processo e Exportação de Usuários - Identity Provider, que possui opção de “Reenviar registros com erro”. O reenvio automático será executado até atingir o número máximo de tentativas parametrizado (Parâmetros da integração - Número de Tentativas de Reenvio). Caso o parâmetro esteja vazio a customização não realizará nenhuma tentativa de reenvio automaticamente.

Quando o número máximo de tentativas de reenvio for atingido e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado.

Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio.

Image Removed

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

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

Pré-Requisitos / Parametrizações

Pré-

Requisitos

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

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

Pré-Requisitos / Parametrizações

Pré-

Requisitos