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

Objetivo do Processo

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.

Image Removed

, 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
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 O usuário deverá informar a URL do WebService da API integração com o Identity ProviderGoogle. 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
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.

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.

Expandir

title	Processo de Exportação de Usuários

Pré-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 processoObjetivo 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.

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.

Aviso

title	Importante:

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

Descrição do processo

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

Image Added

Este processo poderá ser agendado ou executado manualmente pelo usuário.

Image Removed

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:

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), serão exportados apenas os que apresentarem matrícula ativa no momento da exportação. 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).
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 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
deve
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
deverá ser
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 a customização irá validar as seguintes regras no processo de exportação:
Serão exportados apenas usuários cadastrados na (GUSUARIO.STATUS)
igual a
que possuírem status ativo e que estiverem associados a um cadastro de pessoa
do
no 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
usuários estrangeiros (nacionalidade diferente de Brasileira), 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.
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 e que ainda não foram enviados, citadas acima 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

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

Aviso

title	Importante:

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

Aviso

title	Importante:

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.

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.

Expandir

title	Monitor de Log

Pré-requisitos

Não se aplica.

Objetivo do Processo

O objetivo da interface de log é armazenar informações de usuários exportados para o Identity Provider Nacional, com detalhes dos dados enviados, dados recebidos, status e datas de processamento. O Monitor de log também será a referência do usuário para identificar casos que tenham necessidade de reenvio de dados.

Detalhamento do processo

Para que seja possível acompanhar os status dos usuários par ao Identity
Provider Nacional, foi criado uma interface de Monitor de Log. Nesta interface será possível identificar o status dos dados integrados.

Os dados exibidos nesta interface ficam armazenados nas tabelas customizadas ZTEMPLATELOG e ZTEMPLATELOGITEM.

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 usuários para o Identity Provider serão registrados e poderão ser visualizadas no menu TOTVS Educacional | Sistema Indústria | 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

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:

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

Data de Criação

:

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

Será apresentada ao usuário uma visão com relação a registros exportados. Não será possível incluir, editar ou excluir informações através dessa interface.

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

Image AddedImage Removed

Na tela de item de log, ao acessar um registro, será possível visualizar todos os registros relacionados ao cadastro integrado selecionando a opção Item de Log. Estarão disponíveis os seguintes campos:

Item Log: Identificador sequencial de log.

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

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

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

Notawarning

title	Importante

Esta visão será apenas de leitura, não possibilitando ao usuário fazer qualquer tipo de manutenção nos registros, ou seja, inclusão, edição e exclusão.

Os protótipos são meramente ilustrativos, podendo variar ao longo do desenvolvimento de acordo com a ferramenta TOTVS

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.

Expandir

title	Processo de Reenvio de Dados

Pré-requisitos

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

Objetivo do Processo

O objetivo do Processo é permitir o envio para o Identity Provider Nacional, dos registros que não foram exportados com sucesso.

Descrição do processo

Esse processo poderá ser executado manualmente ou poderá ser agendado pelo menu de Processos de Monitor de Log, por registro (com status de erro ou pendente) e a integração efetuará a exportação dos registros novamente.

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

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,

O Reenvio de Dados, que ao ser acionado

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.

Neste exemplo abaixo o envio apresentou o status de erro;

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

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 10

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 10

Nova versão Atual

Chave

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

Pré-Requisitos / Parametrizações

Pré-Requisitos