Histórico da Página
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 | ||
|---|---|---|
| ||
Objetivo Detalhamento 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 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 Estará disponível em: TOTVS Educacional | Sistema Indústria | IDP Nacional | Parâmetros.
, o usuário administrador efetuará as parametrizações referentes ao processo.
A interface exibirá os seguintes campos:
|
| Expandir | |||||
|---|---|---|---|---|---|
| |||||
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. 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. 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. Para usuários estrangeiros, 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. 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. 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 |
| Nota | ||
|---|---|---|
| ||
Para usuários estrangeiros, 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. Caso a nacionalidade não seja brasileira, o CPF não será obrigatório. Caso a nacionalidade não esteja preenchida, o CPF continuará obrigatório para exportação. 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 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. |
| Aviso | ||
|---|---|---|
| ||
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 que algum campo 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 | ||
|---|---|---|
| ||
|
| Expandir | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||
| Expandir | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
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 Os dados exibidos nesta interface ficam armazenados nas tabelas customizadas ZTEMPLATELOG e ZTEMPLATELOGITEM. 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.
Na tela de log estarão disponíveis os seguintes campos: 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 Id Log:
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.
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 Na tela 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:
Os dados informados nesta interface serão armazenados em tabela customizada por Filial.
|
| Expandir | ||
|---|---|---|
| ||
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.
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 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. Aviso | | |
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas