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

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 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:TOTVS Educacional | Sistema Indústria | IDP Nacional | Exportação de Usuários.

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

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), 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 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.
4. 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.
5. Usuários criados apenas com perfil de aluno sem matrícula ativa não serão exportados. 
6. Não serão verificados os períodos das turmas associadas à matrícula.
7. 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:

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

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. 

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

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.

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

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