Fábrica de Software TOTVS BH

Atalhos

Páginas filhas
  • Manual Operacional da Customização - Integração Identity Provider

Versões comparadas

Versão antiga 15

changes.mady.by.user Pedro Henrique Rosa de Souza

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Andre Oliveira de Souza

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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

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


Expandir
titleParâ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 Detalhamento 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 Sistema Indústria | IDP Nacional | Parâmetros, o usuário administrador efetuará as parametrizações referentes ao processo.

A interface exibirá os seguintes campos: 

  • Client ID: Campo do tipo texto onde o 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.


Para usuários estrangeiros,
  1. 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),
  1. o CPF
será obrigatório. Caso a nacionalidade
  1. não
seja brasileira, o CPF não
  1. 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

Após

a exportação com sucesso para os usuários estrangeiros, a API nos retornará um identificador sequencial como CPF,

onde o mesmo será guardado

que será armazenado no SGE ao termino do processo

em nossa

(tabela de controle

.

Conforme descrito anteriormente, antes de realizar a exportação dos registros para a API do Identity Provider, e necessário realizar a chamada de outro método da API de busca de usuário, utilizando como filtro o CPF. Como o estrangeiro existe a possibilidade de não ter em seu cadastro o CPF, este recurso utilizado para validar a existência de usuários já cadastrados no lado do Identity Provider não funcionará, somente para casos de usuários estrangeiros já processados pela customização utilizando como CPF o identificador sequencial gerado pela API do Identity Provider.

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. 


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

Aviso
titleImportante:

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
titleObservaçã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:

  1.  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. 
  2. Para o IDP Nacional, o número do CPF (cadastro de pessoa) é obrigatório (exceto para os estrangeiros). 
  3. 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
possua matrícula em período letivo com status Matriculado (parâmetro) e com resultado final
    1. não
preenchido, significa que o aluno tem matrícula ativa (curso em andamento). Caso o aluno não
    1. 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.
  2. 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.
  3. 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. 
  4. Não serão verificados os períodos das turmas associadas à matrícula.
  5. O processo
deve
  1. 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
  1. 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
  1. .
 


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:

  1. Serão exportados apenas usuários cadastrados na (GUSUARIO.STATUS)
igual a
  1. que possuírem status ativo e que estiverem associados a um cadastro de pessoa
do
  1. no SGE. 
  2. Para o IDP Nacional, o número do CPF (cadastro de pessoa) é obrigatório (exceto para os estrangeiros).
 
  2. 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.

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. 

Após respeitar os critérios descritos anteriormente e estarem aptos para a exportação, os mesmos antes de realizar exportação (consumo de criação/atualização de usuário da API) será utilizado o método de busca de usuário pela própria API, utilizando como filtro para pesquisar o CPF. Por meio desta etapa poderá validar a existência ou não do cadastro do usuário pelo lado do Identity Provider. Após está etapa o processo pode realizar corretamente a exportação de cada registros sendo criação ou atualização do mesmo.

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.  

Nota
titleUsuários Estrangeiros
Aviso
titleEstrangeiros:

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.  

Aviso
titleImportante:
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).

Expandir
titleMonitor de Log

Pré-requisitos

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.

Detalhamento do processo

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:


Detalhamento dos campos

 

Campo

Descrição

Id Log

Identificador sequencial de Log.

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

FuncionalidadeTipo de Processo que está sendo feito (Por exemplo: Exportação de Dados).
Data de CriaçãoData de Criação do registro.
Data da última alteraçãoData da última alteração do registro.
Número de tentativas de ReenvioQuantidade de vezes que um registro já foi reenviado.
Criador porUsuário responsável pela inclusão do registro.
Alterado PorUsuário responsável pela alteração do registro.
MóduloIdentity Provider Nacional

A segunda visualização que seria o  O item de log . 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:


Na tela de item de log, ao acessar um registro. Estarão disponíveis os seguintes campos:


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
titleImportante

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
titleProcesso 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 de reenvio de dados é 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.

Detalhamento do processo

Será implementado um processo na interface customizada de Monitor de Log que ao ser executado tentará realizar a exportação do registro novamente, armazenando o novo retorno. A funcionalidade estará disponível em: TOTVS Educacional | Sistema Indústria | IDP Nacional  | Monitor de Log| Processos | Reenvio de Dados.

Image Added

Image RemovedImage Added

Image RemovedImage 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 no Req.01 deste documento  “Número (Parâmetros da integração - Número de Tentativas de Reenvio”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.