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.

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

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

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. 

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.

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 - GET pela própria API do Identity Provider, 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.  

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

A segunda visualização que seria 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:

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

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. 

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.

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.