Manual Operacional da customização - Integração SGE x Portal SESI


Objetivo

Este documento foi elaborado para informar aos usuários chave da área Educacional do SESI, sobre a Integração SGE x Portal SESI . A integração com o TOTVS Educacional é responsável pela exportação dos registros, facilitando assim a gestão e acesso aos participantes (alunos, professores, funcionários)..

Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários chave do SESI.

Metodologia

Este material tem como base a visão prática e completa do Processo Customizado da área Educacional através da Integração Portal SESI.

A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional. Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.


Para utilização da Integração com o Portal SESI Educação é necessário observar alguns pontos:

  1. É necessário ter o FRAMEHTML configurado e publicado em zona publica e acessível à chamada do Portal SESI Educação;
  2. A publicação do FRAMEHTML deve ser feito em DNS público e com certificado válido, disponibilizando em um site HTTPS;
  3. As configurações de publicação de serviços customizados no FRAMEHTML devem ter sido realizadas com sucesso;
  4. A Instalação Completa da customização, seguindo instruções apresentadas na Guia de instalação e Release Notes;
  5. A configuração inicial, com as informações do WebService, Usuário, TOKEN, devem ser preenchidos e a customização ativada (não Habilitada);
  6. Alterar senha de todos os usuários que necessitam ser integrados com o Portal SESI (alunos, responsáveis acadêmicos, professores, funcionários);
  7. Preencher todos os parâmetros. Atenção: Esta parametrização é realizada por coligada (SESI – Departamento Regional) e somente para o nível de ensino do SGE – Módulo Educacional Educação Básica (Ensino Básico)
  8. Habilitar os menus, dando permissões aos perfis de usuários, conforme demostrado no Gif abaixo:

           


Além das premissas técnicas, é essencial realizar algumas configurações para garantir o sucesso da integração:

Acesse os Parâmetros através do seguinte caminho:

TOTVS Educacional > Sistema Indústria >Portal SESI> Parâmetros 


A interface exibirá sete abas para serem configurados: Identificação, Reconhecimento de Saberes, Cursos (segmentos), Situações de matrícula, Validação de e-mail, Funcionários e Autenticação SSO.


Nesta aba, são configurados os campos básicos para o funcionamento da integração.



  • Habilita Integração Portal SESI Educação - O processo de integração pode estar agendado, mas a integração apenas irá ocorrer se este parâmetro estiver marcado. Tal parâmetro é valido para os registros de Alunos, Responsáveis Acadêmico, Professores, Diretor(es), Secretário(s), Coordenador(es) e Orientador Pedagógico para que seja realizada a integração de usuários para o Portal SESI Educação.
  • Dados da Integração:
    • Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil;
    • Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil;
    • Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil.
  • Classificação de Municípios (IBGE): Campo com lista de classificação de municípios (DCLASSIFMUNICIPIO), para o usuário selecionar em qual classificação de Município corresponde a do IBGE.

  • Dias para envio de turma finalizada: Neste campo o usuário deverá informará a quantidade de dias (em números)  em que uma turma já finalizada será considerada na exportação.

Nesta aba, são configurados os campos referentes ao Reconhecimento de Saberes.

Token para WS: Este recurso serve para gerar um Token do tipo Basic Authentication, o qual deve ser informado no Portal SESI para utilização da autenticação da comunicação com o SGE

Gerando...

Para gerar o Token deve ser informado o usuário e senha do usuário que será registrado a utilização da integração vinda do Portal SESI Educação.

É importante utilizar um usuário exclusivo.

Os demais campos, são para configurar os status e motivos de alteração para indicar quando a situação do aluno  for:

  • Reconhecimento de Saberes: Utilizado para identificar as disciplinas em Reconhecimento de Saberes, que precisam ser reconhecidas pelo Portal SESI Educação.


  • Competências reconhecidas:  Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
  • Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência Reconhecida automaticamente pelo processo.


  • Competências não reconhecidas: Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes
  • Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência não Reconhecida automaticamente pelo processo.


  • Matricula no período letivo: Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
  • Motivo de alteração: Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.



Nesta aba deverá ser informado/cadastrado os cursos do SGE – Módulo Educacional (segmentos de ensino da Educação Básica indicadas no Portal SESI Educação (Educar Brasil)) para os quais somente alunos e professores/disciplinas de tais cursos serão integrados.


Junto a informação de cada curso deverá ser sinalizado se o e-mail do aluno (matriculado em tal curso) deverá ser obrigatório e também se alunos menores de 18 (dezoito) anos (matriculado em tal curso) deverão ter um responsável acadêmico informado. 

Cursos (Segmentos).gif

Para integração dos alunos  no Portal SESI, o status do aluno é definido de acordo com sua Situação de Matrícula no SGE. 

Nesta aba o usuário deverá informar as situações de matricula no SGE, que o Portal SESI deve considerar como: Pré matriculado, Matriculado ou Inativo.


Ao incluir um novo registro será apresentado 3 campos para preenchimento:

Sit. Matricula: Lista  das as situações de matrículas existentes na base.

Status Indica: Status no Portal SESI, da situação de matricula selecionada. Podendo ser Pré matriculado, Matriculado ou Inativo.

Não enviar ao Portal SESI:  Se o checkbox "Não enviar ao Portal SESI" estiver marcado as matrículas com tal situação serão desprezadas para a integração.


           


Se a Escola  considerar que a situação de matricula "cancelado" do SGE deve ser enviada ao Portal SESI como Inativo, o preenchimento será da seguinte:

Se em determinado momento a Escola determinar que essa situação de matrícula não deve ser considerada na  Exportação ao Portal SESI é necessário marcar  o checkbox:



Se o usuário do aluno estiver Ativo, o processo customizado de exportação ao Porlta SESI busca a informação  parametrizada nessa aba, para fazer a relação da situação de matricula do Aluno com status indica, identifcado se será ou não exportado.

Se o usuário do aluno estiver Inativo, o processo customizado já envia para o Portal SESI como Inativo.

Essa aba refere-se a configurações para utilização de Consulta/validação de email pela Quickemail.

Os campos apresentados são:

URL API: Endereço de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil;

TOKEN: Token de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil.

Intervalo de horas: Este campo será considerado para validar novamente o e-mail na QuickeMail (somente daqueles que  não tenham sido considerados "válidos") respeitando o intervalo de horas definido no parâmetro. 



Na integração de Funcionários ao Portal SESI Educação os registros contêm uma propriedade indicando o perfil do funcionário.

Este cadastro deve ser utilizado para informar o perfil de cada Funcionário, que poderá ser:

  • Funcionário Administrativo (Perfil padrão do Portal SESI)
  • Funcionário Pedagógico e
  • Administrador de Unidade

Neste cadastro devem ser preenchidos os campos conforme a sua funcionalidade:

  1. Código da filial/escola: utilizado para identificar para qual filial se destina o funcionário que terá um perfil diferenciado do padrão. Um funcionário pode estar em mais de uma filial e com perfis diferentes;
  2. Código da Pessoa: mostrando apenas os funcionários a serem levados ao Portal SESI para filial selecionada no campo 1 que ainda não foram parametrizados, deve ser selecionado o funcionário ao qual se quer atribuir um perfil diferenciado para a filial selecionada;
  3. Perfil no Portal SESI Educação: utilizado para identificar qual perfil enviar ao Portal SESI, combo que permite selecionar entre os perfis: Funcionário Administrativo, Funcionário Pedagógico e Administrador de Unidade.

Somente os funcionários cuja o perfil padrão (Funcionário Administrativo) não atenda as necessidades da Unidade que devem ser parametrizados neste cadastro.

Aba destinada à configuração de logins via SSO (Single Sign-On). 

Os campos são preenchidos automaticamente após a Importação do Arquivo (config_sesi.json) que é fornecido pelo Portal SESI


Abaixo descrição dos campos para conhecimento:

  • Endereço WebService: Endereço de acesso ao webservice disponibilizado pelo Portal SESI.
  • Public Key: chave pública para descriptografar o token JWT.
  • Client ID: usuário de acesso ao webservice disponibilizado pelo Portal SESI.
  • Secret Key: Senha de acesso ao webservice disponibilizado pelo Portal SESI.
  • Importar arquivo (config_sesi.json): Botão para importação das configurações via arquivo JSON*.

*Arquivo disponibilizado pelo Portal SESI.

O SGE possui valores para as suas tabelas, campos, cadastros, tipos que divergem com os valores atuais cadastrados no Portal SESI Educação. Além das parametrizações descritas acima, é

Para a integração é necessário ter valores equivalentes aos do Portal SESI Educação, antes de acionar o serviço que efetiva a integração. 
A funcionalidade 'Cadastro de DE/PARA' foi disponibilizada para criar esse relacionamento e equivalência entre os sistemas. 

O Cadastro está disponível no Menu:  TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | DE/PARA da integração

A tela de cadastro do DE I PARA é composta por 4 campos que devem ser preenchidos seguindo a ordem: 

1- Entidade (Cadastro): Lista com 6 entidades que devem ter equivalências com o Portal SESI informada. Sendo elas:

    • Curso/segmento,
    • Disciplina
    • Habilitação/Serie
    • Área - Grupo de complemento
    • Área Itinerário
    • Itinerário


2- Curso: Lista com todos os cursos cadastrados na base. 

O campo Curso, ficará desabilitado caso tenha selecionado as seguintes entidades: Cursos/Segmentos ou Área itinerário.


3- Valor no TOTVS Educacional: Lista da Entidade e Curso selecionado anteriormente. (No exemplo acima, foi selecionado a Entidade: Disciplina e o Curso: EF II, neste caso o valor no TOTVS Educacional trará todas as disciplinas do EF II).

4- Valor no Portal SESI Educação: Onde deve ser informado o código equivalente no Portal SESI Educação (validar com responsável pelo portal).

O Portal SESI Educação disponibiliza uma documentação Online para facilitar a identificação das Entidades a serem parametrizadas no De/Para. Para acessar, entre em contato com o SESI DN.

Após as configurações descritas acima, o usuário poderá executar o processo de Exportação.

A exportação de dados é responsável pelo envio das seguintes Entidades:

  • Alunos (e responsáveis acadêmicos)
  • Docentes
  • Funcionários (Diretores escolares, secretários Escolares, orientadores, comissão coordenadores)
  • Turmas
  • Matriculas
  • Aulas Docentes
  • Oficinas (apenas para o Regional Paraná)

Antes de executar o processo é necessário que o usuário entenda as regras de cada Entidade que será integrada.


Integração de Alunos 

Integração de Docentes

Para integração de alunos é necessário:


nome

Para integração de Docentes é necessário:


nome

















através do Menu:

TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | Exportação de Entidades

A exportação de dados é responsável pelo envio de:

  • Alunos (e responsáveis acadêmicos)
  • Docentes
  • Funcionários (Diretores escolares, secretários Escolares, orientadores, comissão coordenadores)
  • Turmas
  • Matriculas
  • Aulas Docentes
  • Oficinas (apenas para o Regional Paraná)

O usuário poderá executar o processo manualmente ou agenda-lo conforme recurso nativo.

Também pode ser selecionado um ou mais entidades para o envio.

Para que o envio de cada uma dessas entidades,  seja executado com sucesso, são considerados alguns pré requisitos e validações, que serão listadas abaixo:











Acesse o menu: TOTVS Educacional | Sistema Indústria | Integrações | Integração Portal SESI. Dentro da opção, selecione o processo de Exportação de Dados do Portal SESI.

O processo de Exportação de Dados do Portal SESI será modificado para incluir o envio das informações das Oficinas da Regional Paraná. Será adicionado um novo checkbox chamado "Oficinas" na interface, permitindo que o usuário marque quando desejar enviar esses dados.

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


 Ao executar o processo a customização irá considerar para envio as seguintes regras:

  1. Para que a Oficina seja enviada para o Portal SESI, é necessário que haja pelo menos um aluno matriculado nela e que sua data final + o número de “Dias para envio da Turma/Oficina Finalizada” (parâmetro) seja maior que a data corrente. Neste momento, serão enviados os dados da Oficina e seus respectivos professores: responsáveis e associados à Oficina. 
  2. O envio contempla apenas professores que já estão previamente integrados ao Portal SESI, devendo ter sido integrados por meio do processo atual.
  3. Serão enviadas apenas Oficinas do Tipo Formação Geral Básica (Ensino Médio) e Interseriado (Ensino Fundamental), definido no cadastro da oficina.

Será utilizado o parâmetro “Dias para envio da Turma Finalizada”, que terá seu nome alterado para “Dias para envio da Turma/Oficina Finalizada” para o Regional Paraná. Ele armazena o  número de dias considerados após o final da Oficina para identificar se ela deverá ser enviada. Será utilizado como base a Data final da Etapa Principal da Oficina.


Dias para envio da Turma/Oficina Finalizada: 30 

Data corrente de execução do processo: 10/01/2024

Data calculada: 10/01/2024 - 30: 11/12/2023 (desconsidera as finalizadas até essa data)

Oficina ABC - Data início: 01/10/2023 e Data fim: 02/12/2023 - Não enviada

Oficina 321 - Data início: 01/12/2023 e Data fim: 11/12/2023 - Enviada

Oficina DEF - Data início: 01/01/2024 e Data fim: 30/03/2024 - Enviada

Ao ocorrer qualquer alteração nos dados das oficinas enviadas ou inclusão/exclusão de professores vinculados à sala oficina, os dados atualizados serão enviados ao Portal SESI ao rodar o processo de exportação novamente.

Os dados das oficinas na matrícula serão enviados para o Portal SESI quando o processo de exportação for executado ou quando uma matrícula em oficina for efetuada. 

    • Processo existente de Exportação de Dados disponível no menu: TOTVS Educacional  |  Sistema Indústria  |  Integrações  | Integração Portal SESI.
  • Ao realizar uma nova matrícula em Oficina, através dos menus: 
    • Portal Oficinas - Aluno: Oficinas | Inscreva-se
    • Portal Oficinas - Pedagogo: Matrícula na Oficina

O processo atual de envio de matrículas do SGE para o Portal SESI será modificado para incluir informações das oficinas. Quando uma matrícula é enviada e contém informações de matrícula em oficina, essas informações serão enviadas na mesma requisição.

A API de Matrícula atual será ajustada pelo Portal SESI para considerar uma nova lista chamada "Oficinas", permitindo o envio desses dados pelo SGE.

Se não houver oficinas vinculadas, o processo de envio de matrícula continuará enviando apenas os dados da matrícula do aluno, conforme o fluxo padrão da integração do Portal SESI.

Durante o ano, um aluno pode estar vinculado a mais de uma oficina, portanto, todas as oficinas associadas à matrícula do aluno devem ser informadas ao Portal SESI. Sempre que ocorrer uma matrícula no Portal Oficina, o processo será acionado para atualizar as informações da matrícula do aluno com todas as oficinas associadas.

Serão consideradas apenas as oficinas do tipo Formação Geral e Básica e Interseriado.