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

O manual a seguir visa detalhar a integração de alguns módulos da solução SGE com o Portal SESI Educação, facilitando assim a gestão e acesso aos participantes (alunos, professores, funcionários).

Premissas

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, porém antes de continuar a configuração com os segmentos que serão utilizados é necessário realizar os itens 6 e 7;
  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. Solicitar ao Portal SESI execução da sincronização de usuários.


Observação importante: Somente informações relacionadas aos segmentos preenchidos na parametrização serão integrados.

Habilitando Menus (permissões)

Parametrizações

Esta parametrização é realizada por coligada (SESI – Departamento Regional) e nível de ensino do SGE – Módulo Educacional (Educação Básica) e as informações preenchidas são armazenadas em tabela customizada. 

Os parâmetros estão agrupados em abas/guias. A seguir apresentamos os parâmetros necessários para a integração e seus significados: 

Aba Identificação

Parâmetro que indica se a integração será realizada ou nã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.

  1. Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil;
  2. Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil;
  3. Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil.

Estando Habilitado a Integração, estes 3 parâmetros são Obrigatórios.

  1. Utilizar data referência é um parâmetro que habilita o campo Data Referência para que sirva de data de corte, para que somente os dados alterados pela última vez após a data selecionada sejam enviados;
  2. Data da última execução do processo de exportação para entidade de Aluno, esta data servirá de referência para a próxima execução da exportação;
  3. Data da última execução do processo de exportação para entidade de Professor, esta data servirá de referência para a próxima execução da exportação;
  4. Data da última execução do processo de exportação para entidade de Funcionários, esta data servirá de referência para a próxima execução da exportação.

Importante: Caso utilize a data de referência a primeira execução desconsiderará registros criados/alterados antes da data parametrizada. Depois da primeira execução este parâmetro não tem mais utilidade, pois utilizará as datas de última execução.



Importante: Esta parametrização é por Nível de Ensino, portanto, a integração deve ser habilitada para todos os níveis de ensino que a customização deve funcionar.

Aba Reconhecimento de Saberes

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.

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

  1. Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
  2. Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação ¹Competência Reconhecida automaticamente pelo processo.

  1. Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes;
  2. Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação ¹Competência não Reconhecida automaticamente pelo processo.

  1. Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes;
  2. Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.

Aba Cursos (Segmentos)

Um cadastro onde deverá ser relacionado (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.

Aba Situações de Matrícula

No Portal SESI Educação os registros contêm uma propriedade indicando o status dos registros que poderá ser: Ativo, Inativo ou Excluído. Para a integração de alunos este status será definido de acordo com a situação de matrícula do aluno. Como no SGE – Módulo Educacional as situações de matrículas são a partir de um cadastro (existem situações que não se pode alterar, mas é possível cadastrar novas) então é necessário definir o significado de cada situação de matrícula. 
Em vista disto, neste módulo de parametrização, há um cadastro onde é possível efetuar o mapeamento entre as diversas situações de matrículas do SGE – Módulo Educacional e o que ela representará para o Portal SESI Educação no momento da integração. 

É permitida a seleção da situação de matrícula e do status desta para o Portal SESI Educação podendo marcar uma entre três opções Ativo, Inativo e Excluído. Este mapeamento é realizado para todas as situações de matrícula do SGE – Módulo Educacional.

Aba Validação de Email [Novo!]

  1. Endereço de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil;
  2. Token de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil.

Campos Complementares

A criação do campo complementar TURMASESIEDUCACAO e tabela dinâmica é realizada via script disponibilizado no pacote de instalação.

Esse campo complementar deve fazer uso de uma tabela dinâmica: 


Os itens dessa tabela dinâmica devem ser cadastrados conforme regra do cliente e de acordo com o documento disponibilizado pela Educar Brasil. 


Este campo deve estar disponível para visualização na turma e deve ser preenchido de acordo com a turma que será identificada pelo professor para publicação de material.

No caso da unidade que possuir o sistema de Gestão de Oficinas – SGO, este campo estará disponível para visualização no anexo "Turma SESI Educação" do cadastro de Salas do Oficina e deve ser preenchido de acordo com a turma que será identificada pelo professor para publicação de material.


Importante: O campo deve ser ativado pelo usuário - Como ativar campo complementar?

De | Para

O SGE – Módulo Educacional possui valores para as suas tabelas, campos, cadastros, tipos que não condizem com os valores atuais cadastrados no Portal SESI Educação. Como estamos tratando de uma integração é necessário efetuar a troca por valores equivalentes aos do Portal SESI Educação, antes de acionar o serviço que efetiva a integração. 
Em vista desta situação, foi criada uma funcionalidade que permite o mapeamento e equivalência dos valores do SGE – Módulo Educacional para os valores utilizados pelo Portal SESI Educação. A funcionalidade 

'Cadastro de DE/PARA' foi disponibilizada como um cadastro (ao invés de fixo, hardcore) de maneira a permitir que eventuais novos valores possam ser mapeados (criar o relacionamento, equivalência entre os sistemas) e/ou alterados sem a necessidade de novas codificações. 
No SGE – Módulo Educacional, menu customização, disponibilizamos o Cadastro DE/PARA e neste, o usuário (usualmente o administrador do sistema/integração) irá selecionar o registro (SGE – Módulo Educacional) a que se refere e informar o valor equivalente no sistema destino (Portal SESI Educação).

Deve ser selecionado o tipo de Entidade (Cadastro), que pode ser:

Nesta entidade devem ser preenchidos os campos:

  • "Valor do TOTVS Educacional" onde deve ser selecionado o Curso;
  • "Valor no Portal SESI Educação" onde deve ser informado o código do curso equivalente no Portal SESI Educação (validar com responsável pelo portal).

Nesta entidade devem ser preenchidos os campos:

  • "Curso" onde deve ser selecionado o Curso para a disciplina;
  • "Valor do TOTVS Educacional" onde deve ser selecionada a Disciplina;
  • "Valor no Portal SESI Educação" onde deve ser informado o código da disciplina equivalente no Portal SESI Educação (validar com responsável pelo portal).

Nesta entidade devem ser preenchidos os campos:

  • "Curso" onde deve ser selecionado o Curso para a habilitação/serie;
  • "Valor do TOTVS Educacional" onde deve ser selecionada a Habilitação/Serie;
  • "Valor no Portal SESI Educação" onde deve ser informado o código da habilitação/serie equivalente no Portal SESI Educação (validar com responsável pelo portal).

Nesta entidade devem ser preenchidos os campos:

  • "Curso" onde deve ser selecionado o Curso para "Área - Grupo de Complemento";
  • "Valor do TOTVS Educacional" onde deve ser selecionada a "Área - Grupo de Complemento";
  • "Valor no Portal SESI Educação" onde deve ser informado o código da "Área - Grupo de Complemento" equivalente no Portal SESI Educação (validar com responsável pelo portal).

[Novo!]

Nesta entidade devem ser preenchidos os campos:

  • "Curso" onde deve ser selecionado o Curso para a área de conhecimento;
  • "Valor do TOTVS Educacional" onde deve ser selecionada a Área de Conhecimento;
  • "Valor no Portal SESI Educação" onde deve ser informado o código da área de conhecimento equivalente no Portal SESI Educação (validar com responsável pelo portal).

[Novo!]

Nesta entidade devem ser preenchidos os campos:

  • "Curso" onde deve ser selecionado o Curso para a disciplina;
  • "Valor do TOTVS Educacional" onde deve ser selecionada a Disciplina;
  • "Valor no Portal SESI Educação" onde deve ser informado o código da disciplina equivalente no Portal SESI Educação (validar com responsável pelo portal).

Integrações

Alunos (e seus respectivos responsáveis acadêmicos)

Pré-Requisitos / Parametrizações

  1. Realizar a parametrização da Integração e preenchimento De/Para;
  2. Para envio dos dados do aluno os campos abaixo são de preenchimento obrigatório:

Campo

Localização

Regional

Cadastro de Coligada: GCOLIGADA.ESTADO

Código Integrador

Cadastro de Filial / Dados para o MEC: SFILIALMEC.CODINEPESCOLA

Nome

PPESSOA.NOME - Caso o PPESSOA.NOMESOCIAL esteja preenchido ele substitui o nome juntando com o sobrenome da pessoa (PPESSOA.SOBRENOME)

CPF

PPESSOA.CPF

Sexo

PPESSOA.SEXO

Nascimento

PPESSOA.DTNASCIMENTO

Turno

Matriz Aplicada (SHABILITACAOFILIAL.CODTURNO)

Curso [Novo!]

/*TODO*/

Exemplo: {"area":"1","itinerario":"1"}

Segmento

De/Para de Segmento (de/para com o campo CODCURSO da Matriz Aplicada SHABILITACAOFILIAL)

Série

De/Para de Série (Habilitação) (de/para com o campo CODHABILITACAO da Matriz)

Turma

Turma da Matrícula no período letivo (SMATRICPL.CODTURMA => STURMACOMPL.TURMASESIEDUCACAO)

Senha

Obrigatória na inclusão

Status

Parâmetros de situação de matrícula

Responsável,campos:
Nome
Email
Senha

Caso o aluno seja menor de 18 anos e o segmento exija deve ser enviado.
SALUNO.CODPESSOARACA => PPESSOA.NOME
SALUNO.CODPESSOARACA => PPESSOA.EMAIL
SALUNO.CODPESSOARACA => PPESSOA.SENHA
Obrigatória na inclusão

A prioridade de envio do código da turma para o Portal SESI sempre é o campo complementar “Turma Sesi Educação”. Apenas quando ele não está preenchido a customização envia o Código da Turma (SMATRICPL.CODTURMA).


Detalhamento do Processo

A exportação de alunos possui a particularidade de exportar não apenas os dados básicos dos alunos, mas também outros dados, como curso (nível de ensino, segmento), turma, turno, série/habilitação (série) – e dados sobre seus responsáveis acadêmicos que estão vinculados ao cadastro do aluno.


Para que todos os dados possam ser integrados corretamente, é preciso realizar a parametrização do De/Para para cada um dos Cursos/Segmentos, Disciplinas e Séries/Habilitações, além de preencher em cada turma o campo complementar, conforme detalhado abaixo:


Alteração na Integração de Aluno – Integrar somente Matrículas sem Resultado Final e de Períodos Letivos não encerrados

A integração de Aluno envia somente alunos com Matrículas (SMATRICPL) que ainda não possuem o Resultado Final (SMATRICPL.CODSTATUSRES) preenchido e que pertecam a Período Letivo (SPLETIVO) que não estão encerrados, desconsiderando os demais.


Premissas para o valor da turma do aluno a ser integrada 


O valor da turma a ser integrado do SGE – Módulo Educacional para o Portal SESI Educação é dado através do uso de tabela dinâmica X campo complementar na turma então é necessário a criação de uma tabela dinâmica que conterá os identificadores de turmas e um campo complementar na turma para indicar qual o valor a ser enviado à integração. 

Importante: Para que o aluno seja exportado o mesmo deve ter um usuário cadastrado no SGE.


Importante: Ao instalar a customização no ambiente de produção é necessário executar o processo de geração de usuário selecionando todos os alunos para que os mesmos realizem a troca de senhas ao fazer login no sistema.

Professores (e suas aulas)

Pré-Requisitos / Parametrizações

  1. Realizar a parametrização da Integração e preenchimento De/Para;
  2. Para envio dos dados do professor os campos abaixo são de preenchimento obrigatório:

Campo

Localização

Regional

Cadastro de Coligada: GCOLIGADA.ESTADO

Código Integrador

Cadastro de Filial / Dados Adicionais: DFILIAL.CAMPOLIVRE1

Nome

PPESSOA.NOME

Código Externo

PPESSOA.CODUSUARIO

Sexo

PPESSOA.SEXO

Nascimento

PPESSOA.DTNASCIMENTO

Email

PPESSOA.EMAIL

CPF

PPESSOA.CPF

Senha

Obrigatória na inclusão

Aulas [Novo!]

/*TODO*/

Exemplo:

[{"turma":"EP EM EAD A N 20","segmento":"14","area":"1","componente":"22"},{"turma":"EP EM EAD A N 20","segmento":"14","area":null,"componente":"33"},{"turma":"EP EM EAD A N 20","segmento":"14","area":"1","componente":"4"}]



Detalhamento do Processo

A integração (ou exportação) de professores tem como base os registros de professores geridos pelo cadastro de professor "SGE – Módulo Educacional | Currículo e Oferta | Aluno e Professor | Professores" mantidos nas tabelas SPROFESSOR/PPESSOA (dados do professor e dados pessoais do professor) e, como é necessário exportar as disciplinas dos professores, um relacionamento é realizado através da funcionalidade "Turmas/Disciplinas do professor" (SGE – Módulo Educacional | Ofertas | Turmas/Disciplinas | <anexo> Professores) para recuperar suas disciplinas. Somente são exportados Professores cujas as Turmas pertençam a Períodos Letivos não encerrados.


Para a exportação ser efetivada é preciso realizar a parametrização da tabela De/Para, parametrizando obrigatoriamente os Cursos e Disciplinas vinculados ao cadastro dos professores.


Os campos obrigatórios, parametrizações de/para e e-mail serão validados e, se estiverem corretos, serão enviados para o Portal EducarBrasil, e seu retorno é gravado na tabela de Log.


Caso ocorra algum erro durante a integração, este será gravado em log. Após alteração do registro do professor, para realizar nova integração deverá ser selecionado o log referente ao professor e executado o processo de reenvio de erro.


Importante: Para que o professor seja exportado o mesmo deve ter um usuário cadastrado no SGE e estar dando aula em alguma Turma/Disciplina que tenha sido informado no cadastro De/Para para disciplinas.

Funcionários (Diretor, Secretários, Orientador Pedagógico e Coordenador)

Pré-Requisitos / Parametrizações

  1. Realizar a parametrização da Integração;
  2. Para envio dos dados do funcionário os campos abaixo são de preenchimento obrigatório:

Campo

Localização

Regional

Cadastro de Coligada: GCOLIGADA.ESTADO

Inep

Cadastro de Filial / Dados para o MEC: SINSTITUICAOMEC.CODINEPINSTITUICAO

Nome

PPESSOA.NOME

Código Externo

PPESSOA.CODUSUARIO

Sexo

PPESSOA.SEXO

Nascimento

PPESSOA.DTNASCIMENTO

Email

PPESSOA.EMAIL

CPF

PPESSOA.CPF

Senha

Obrigatória na inclusão

Detalhamento do Processo

O termo 'funcionários' se refere às pessoas designadas a determinadas funções no SGE – Módulo Educacional (secretários escolares, coordenadores, diretores escolares, entre outros). Tais registros de 'funcionários' do SGE – Módulo Educacional são pessoas (PPESSOA) associados às funções através das funcionalidades 'Filial | Dados Educacionais | <anexo> Diretores por Filial e 'SGE – Módulo Educacional | Currículo e Oferta | Estrutura Curricular | Matrizes curriculares | <anexo> Matriz aplicada | <anexo> Comissão Coordenadora'. 


Importante: Para que os "Funcionários" seja exportado o mesmo deve ter um usuário vinculado ao seu cadastro de pessoa no SGE. 



A localização de Diretores e secretários serão localizados com base nos dados cadastrados no SGE - Módulo Fiscal | Filiais | Dados Educacionais | Diretores por Filial. Neste módulo são cadastrados os diretores e secretários.



Os campos obrigatórios, parametrizações e e-mail são validados e, se estiverem corretos, são o enviados para o Portal EducarBrasil, e seu retorno será gravado na tabela de Log.





Pré-Requisitos / Parametrizações

Parametrização da Integração e Parametrização De/Para.

Descrição do Processo

Processo para realizar o reenvio de erros ocorridos na integração.

Detalhamento do Processo


O Registro dos usuários são criados apenas no SGE e ao realizar uma alteração nos dados eles são enviados ao Portal SESI Educação, no modelo síncrono, afim de manter os dados dos dois sistemas sincronizados.


A funcionalidade é acionada no SGE a partir da alteração dos dados do usuário no cadastro de Usuários, no "Trocar Senha" da aba ambiente e no trocar senha por meio do Portal SGE. A customização intercepta a alteração, verifica a entidade que pertence o registro e  realiza o processo de integração das informações. Ao final, um Log é inserido na tabela customizada informando o status da operação.


Observação: Caso ocorra um erro durante a integração, um registro é inserido no Log e o cadastro/alteração de senha do RM ocorre normalmente, sem que qualquer mensagem de erro seja exibida.

Pré-Requisitos / Parametrizações


Realizar a parametrização da Integração.

Descrição do Processo


Processo customizado que realiza a exportação de determinados registros para o Portal SESI Educação.

Detalhamento do Processo


Foi criado um processo customizado no SGE – Módulo Educacional para realizar a integração entre o SGE e o Portal SESI Educação. O processo pode ser acionado via menu ou agendado para executar com periodicidade definida.


A interface do processo contém a lista das possíveis entidades a serem integradas dispostas em controles que permitam ao usuário selecionar/marcar quais registros deseja processar/integrar na execução do processo. São elas:

Conforme imagem abaixo:


Uma visão customizada foi criada para que seja possível verificar os dados enviados/recebidos durante as integrações realizadas nos requisitos posteriores.


Para cada registro exportado, foi criado um Log nessa tabela contendo os parâmetros utilizados, a entidade integrada, os dados enviados, o status (Erro ou Sucesso) e a mensagem de erro caso ocorra algum durante a exportação.





Formulário para consulta dos dados do Log de cada registro.


Observação: Todos os dados sãs apenas para visualização, não sendo possível a adição, edição ou exclusão de registros do Log através dessa interface.


O log é apresentado ao usuário logado com base no seu acesso a filiais , assim o mesmo só terá acesso aos logs das filiais em que tiver acesso.

Pré-Requisitos / Parametrizações


Parametrização da Integração e Parametrização De/Para.

Descrição do Processo


Processo para realizar o reenvio de erros ocorridos na integração.

Detalhamento do Processo


Durante a exportação dos dados do SGE para o Portal SESI Educação, podem ocorrer erros de validações, por exemplo, impedindo o registro de ser integrado corretamente. Por esse motivo, toda a tentativa de exportação é salva no log customizado para posterior conferência/reenvio.


Os registros que foram exportados e geraram erros podem ser reprocessados através do mesmo processo de integração utilizado para integrar as demais entidades. Tal processamento é disparado através do processo de integração ao se marcar a opção 'Reenvio de dados' e acionar a execução do processo (imediato ou agendamento). Outra forma é selecionar o(s) registro(s) individualmente na tela customizada de Log e executar o processo customizado que foi adicionado a ela.


Uma nova tentativa de envio é realizada, passando por todos os procedimentos e validações detalhados nos requisitos anteriores. Ao final, os registros da tabela de Log serão atualizados com o novo status e parâmetros enviados/recebidos.

Pré-Requisitos / Parametrizações


Nenhum.

Descrição do Processo


WebService customizado para realizar a integração dos Usuários.

Detalhamento do Processo

Foi desenvolvido um webservice customizado para realização de alteração de e-mail e senha dos usuários, recebendo como parâmetro o código do usuário, a nova senha e e-mail. O método está disponível para visualização no swagger.

Observação: a senha deverá ser informada na codificação Base64, conforme exemplos abaixo:


URL com os parâmetros adicionados: http://localhost:8080/rm/api/TOTVSCustomizacao/Usuario/SincronizarUsuario?codUsuario=lucianom&novaSenha=dG90dnM%3D&[email protected]

Envio da requisição via Postman:


O Método HTTP utilizado é o PUT. Quando a sincronização de usuário for realizada com sucesso, o campo "Sucess" será retornado como "true", e quando ocorrer um erro, será retornado como "false", e o campo "Message" irá detalhar o erro ocorrido, conforme no exemplo abaixo:

A Autenticação a ser utilizada é Basic utilizando usuário e senha do RM com devidas permissões para realização das ações:


Tabela com códigos de erros do WebService

Token Inválido

01

Usuário não encontrado

02

E-mail inválido

03

Inconsistências DataServer RM

04

Erro desconhecido

05

Erro ao conectar no RM

06

Pré-Requisitos / Parametrizações


Nenhum.

Descrição do Processo


Auto Login no Portal SGE de forma transparente aos usuários.

Detalhamento do Processo


Para que a transição do Portal SESI Educação para o Portal SGE ocorra de maneira transparente, é preciso que um recurso de auto login esteja disponível, conforme detalhado abaixo:


O serviço de auto-login (ou login automático) no Portal SGE se baseia no usuário/senha fornecidos para o serviço customizado. Para que funcione plenamente é necessário que tais informações do Portal SESI Educação existam e sejam os mesmos no SGE (premissa garantida através das integrações previstas neste projeto).


Para fazer uso deste recurso é necessário que o link a ser disponibilizado no Portal SESI Educação faça uma requisição do tipo POST para o endereço que provê tal serviço. Nessa requisição é necessário fornecer os dados de usuário, senha e 'alias' de banco de dados (definido por cada regional) onde tais dados serão fornecidos ao serviço como propriedades pré-determinadas – user, pass e 'alias' – pois serão através destes que o serviço recuperará os respectivos valores.


Segue abaixo exemplo de formulário enviando uma requisição HTTP POST para realizar o login no antigo Portal SGE:


<form action="http://localhost/corpore.net/login.aspx?AutoLoginType=ExternalLogin" method="post">
<input type=hidden name="user" value="mestre" />
<input type=hidden name="pass" value="totvs " />
<input type=hidden name="alias" value="CorporeRM" /> 
<input type=submit value="Fazer o Login agora" />
</form>


No arquivo Web.config do Portal SGE a tag "AfterLogoutPage" deve receber o link que direcione para o Portal SESI Educação. Exemplo: 
<add key="AfterLogoutPage" value="http://www.sesieducacao.com.br" />


Essa opção fara com que ao deslogar do Portal SGE o usuário seja direcionado à página inicial do Portal SESI Educação.


Segue abaixo exemplo de formulário enviando uma requisição HTTP POST para realizar o login no novo Portal SGE:


<form name="controller.formLogin" method="POST" action="http://localhost/Corpore.net/Source/EDU-EDUCACIONAL/Public/EduPortalAlunoLogin.aspx?AutoLoginType=ExternalLogin">
<input type="hidden" name="User" value="mestre"/>
<input type="hidden" name="Pass" value="totvs"/>
<input type="hidden" name="Alias" value="CorporeRM"/>

<input type="submit" value="Fazer o Login agora"/>
</form>

Pré-Requisitos / Parametrizações


A base de dados do Portal SESI Educação está povoada com registros (alunos, professores, funcionários) onde estes contêm valores válidos para os endereços de e-mail (formatação e existência da caixa postal).


A demanda consistia de um serviço que fosse capaz de, a partir de tais informações, atualizar os registros equivalentes no SGE – Módulo Educacional com o e-mail válido proveniente do Portal SESI Educação.


Para atender tal demanda é necessário solicitar (recomendado 02 dias de antecedência) duas planilhas Excel à equipe do Portal SESI Educação: uma contendo as informações de e-mails por CPF e outro contendo e-mails por nome do aluno e CPF do responsável. Via serviço customizado iremos realizar a leitura deste arquivo, processar a primeira planilha e em seguida a segunda, onde para cada planilha e cada registro (linha) da planilha, identifica-se o registro da "pessoa" equivalente no SGE Módulo Educacional e apenas o campo e-mail do registro é atualizado.


Na interface do processo o usuário irá selecionar os arquivos contendo as planilhas mencionadas anteriormente e disparar a execução do processo. Ao final do processo será apresentado o LOG informando o status (sucesso/falha) para cada um dos registros das planilhas.

Descrição do Processo


Foi disponibilizado no sistema SGE Módulo Educacional, através do menu "Customização / Importação de E-mails" um processo que ao ser acionado apresentará uma interface ao usuário para que este possa informar/selecionar o arquivo Excel que contém as informações (dispostas em planilhas e linhas) a serem importadas.


Após o preenchimento/seleção da planilha o usuário deverá clicar no botão 'Executar' para que a importação seja iniciada.

Detalhamento do Processo


Ao acessar o RM.exe e o SGE Módulo Educacional, através do menu "Customização / Importação de E-mails" será exibida uma tela para importação de e-mails.



Deve ser informado um arquivo do Excel válido e que contenha(m) a(s) planilha(s) para importação.


Na máquina onde RM.Exe está instalado e é realizado o acesso, é necessário que exista o Office/Ms-Excel instalado, para que seja possível para a customização abrir o arquivo e executar a leitura do mesmo.


O arquivo XLS a ser importado deve ter uma ou duas planilhas conforme exemplo abaixo.

Para alteração de email da Pessoa (Funcionário, Aluno, Professor) diretamente pela pesquisa do CPF deve ser usada a planilha contendo duas colunas: Uma coluna para o email e outra para o CPF que possibilitará a identificação da pessoa na base de dados do SGE. Exemplo de planilha:



Neste caso o sistema localizará na base de dados uma pessoa com o mesmo CPF informado na planilha e alterará seu email no cadastro de Pessoa do SGE. 
Para alteração de e-mail de Aluno com base no CPF do seu Responsável Acadêmico, deverá ser utilizada uma planilha contendo três colunas: Uma para o e-mail, outra para o nome do aluno e outra para o CPF do responsável Acadêmico. 
Exemplo:



Neste caso o sistema localizará a pessoa com o CPF informado e posteriormente localizará o aluno que está vinculado à essa pessoa através da informação do "Responsável Acadêmico". Caso o e-mail do aluno cujo CPF seja diferente do CPF do responsável acadêmico, o sistema realizará a alteração do e-mail do aluno para o e-mail informado na planilha. Caso o CPF do aluno seja o mesmo do responsável, o e-mail não será alterado.



Após executar o processo o sistema apresentará uma tela com um log de texto contendo as informações dos registros alterados e não alterados.



Observação:
Não há necessidade de utilização de dois arquivos para importação das diferentes planilhas, podendo as duas planilhas estarem em um único arquivo Excel, pois a customização está preparada para importar as duas planilhas a partir de um único arquivo. 

Pré-Requisitos / Parametrizações


Realizar a parametrização da Integração.

Descrição do Processo


Foram desenvolvidos entrypoints que serão executados durante alteração de cadastro de aluno e de matrícula, para exportação dos registros para o Portal SESI Educação. Serão exportados dados de professores e funcionários nos momentos de alterações cadastrais ou associação do professor à turma, do funcionário à comissão coordenadora ou direção da filial.

Detalhamento do Processo


Quando o usuário executar algum dos processos abaixo, o processo de integração será executado de forma síncrona, para o(s) registro(s) selecionado(s).


  • Currículo e Oferta | Aluno | <processo> Matricular aluno;
  • Currículo e Oferta | Aluno | <anexo> Matriculas no Período letivo | <processo> Alterar situação de matrícula;
  • Currículo e Oferta | Aluno | <anexo> Matriculas no Período letivo | <processo> Matricular aluno nas disciplinas;
  • Currículo e Oferta | Aluno | <anexo> Matriculas isolada | <processo> > Alterar situação de matrícula;
  • Matrícula e Avaliação | Matrículas | <anexo> Matrículas em disciplinas | <processo> Alterar situação de matrícula;
  • Matrícula e Avaliação | Matrículas | <anexo> Matrículas em turma mista | <processo> Alterar situação de matrícula;
  • Matrícula e Avaliação | Matrícula | Matrículas | <processo> Alterar situação de matrícula;
  • Matrícula e Avaliação | Matrícula | Matrículas | <processo> Matricular aluno nas disciplinas;
  • Matrícula e Avaliação | Matrícula | Matrículas | <processo> Confirmação de matrícula por pagamento;
  • Matrícula e Avaliação | Matrícula | Matrícula isolada | <processo> Alterar situação de matrícula;
  • Matrícula e Avaliação | Matrícula | <processo> Rematrícula;
  • Matrícula e Avaliação | Matrícula | Mais | <processo> Confirmação de matrícula por pagamento;
  • Matrícula e Avaliação | Matrícula | Mais | <processo> Matricula de disciplinas em lote;
  • Matrícula on-line;
  • Cadastro de pessoas;
  • Cadastro do aluno;
  • Cadastro de matrículas;
  • Estrutura Curricula | Matriz Curricular | Matriz Aplicada | Comissão Coordenadora;
  • Cadastro de Filial | Dados Educacionais | Diretores por Filial;
  • Curriculo e Oferta | Professores;
  • Curriculo e Oferta | Oferta | Turma Disciplina | Professores.


Serão integrados apenas os registros cujo curso/segmento, do contexto do processo e/ou do aluno que se está alterando, seja um dos parametrizados para a integração e apenas os registros cuja situação de matrícula, do contexto do processo e/ou do aluno que se está alterando, seja um dos parametrizados em "situações de matrícula" para a integração.


As rotinas de envio, antes de acionar as rotinas de integração, conterão tratamentos de validação do campo e-mail e responsável acadêmico:

  • A obrigatoriedade de preenchimento do campo e-mail deverá respeitar a parametrização realizada observando o curso/segmento do aluno que se está processando (exemplos: curso onde o aluno está se matriculando/confirmando matrícula, ou quando alteração do cadastro de aluno, o curso onde está matriculado);


  • Obrigatoriedade de responsável acadêmico para menores de 18 anos de acordo com a parametrização por curso/segmento relativo ao curso/segmento do contexto de execução do processo e/ou do curso/segmento relativo ao aluno que se está alterando.


Após as consistências mencionadas acima, as rotinas do plug-in se encarregarão de identificar a chave primária dos registros que estão sendo processados/alterados (no caso de processos pode ser mais de um aluno ao mesmo tempo) e acionar as rotinas de integração fornecendo a estas tais chaves primárias.


As regras da integração de alunos (recuperação de valores, mapeamento de campos, validações, etc.) são as mesmas detalhadas na integração de alunos. Neste caso elas receberão as chaves primárias dos alunos e a recuperação dos dados e integração ocorrerá apenas para os alunos representados por estas chaves. A integração com o Portal SESI Educação ocorrerá e seus retornos  de(sucesso ou falha).


Após o processamento das integrações, com o retorno em mãos, é avaliado os status de retorno para cada registro (aluno) e montará uma mensagem a ser gravada na tabela de LOG com as informações de aluno, status da integração e, em caso de erros, a mensagem de erro.


Caso ocorra algum erro na integração o processo nativo não será interrompido, porém o erro da integração constará em log, nesse caso não será realizada a integração do SGE com o Portal SESI Educação.


Para exportação dos dados Funcionários e Professores, serão exportados apenas os cadastros que possuírem usuário associado e que atendam as regras de validação de campos obrigatórios.

Pré-Requisitos / Parametrizações


O código das competências (disciplinas) enviadas pelo Web Service deverão corresponder ao código das disciplinas cadastradas no SGE. Este cadastro é feito manualmente pelos usuários que devem ter atenção para que os dados sejam registrados igualmente entre os sistemas. Além disso, é necessário que o aluno esteja com apenas uma Matrícula no Período Letivo com situação de matrícula igual a "Reconhecimento de Saberes". As disciplinas FIC e quaisquer outras que estejam cadastradas com status "Matriculado" não são modificadas.


Só serão alteradas as informações caso o aluno possua matrícula referente a disciplina, caso contrário não será feita nenhuma alteração e nem gravará nada no log.

Descrição do Processo


O Portal SESI aciona um método customizado capaz de receber dados sobre do aluno e as disciplinas que o aluno já cursou. No momento que o Web Service for acionado a customização identifica para o código do usuário enviado a Matrícula do Período Letivo do aluno com status Reconhecimento de Saberes. O status Reconhecimento de Saberes é determinado pela informação contida no campo Status de Reconhecimento de Saberes dos parâmetros customizados.


Em seguida, para cada código de Competência (Disciplina) enviada a customização realizar a alteração do status de matrícula de acordo com a parametrização definida pelo Regional.


Caso ocorra erro na modificação do status de qualquer competência (disciplina) de um Aluno a customização não conclui a alteração do status para todas as demais competências (disciplinas) do Aluno, bem como também não altera a situação de matrícula no período letivo. 
OBSERVAÇÃO: Detalhes técnicos para o correto funcionamento do Web Service podem ser consultados no documento "Manual de Customização RM - WEB API - FS007972".

Detalhamento do Processo


O Web Service será acionado pelo Portal SESI para alterar o status das matrículas em disciplinas e matrículas no período letivo para alunos com o status "Reconhecimento de Saberes". Para identificar a Matrícula do Período Letivo do aluno a ser alterada, o processo busca as matriculas em disciplinas com status Reconhecimento de Saberes (parametrizado no Req. 01), ou seja, verifica em qual Matrícula do Período Letivo existe uma competência (disciplina) que esteja com status de Reconhecimento de Saberes.


Os dados trafegados são:

  • Código do Usuário;
  • Lista de Competências (disciplinas) informando 0 ou 1 para cada uma delas, sendo que se enviado igual a 1, o status da competência (disciplina) será alterado de acordo com o que foi parametrizado no campo "Status de Competências reconhecidas" na aba Reconhecimento de saberes dos parâmetros customizados. Se enviado igual a 0, o status da competência (disciplina) será alterado de acordo com o que foi parametrizado no campo "Status de Competências não reconhecidas" na aba Reconhecimento de saberes dos parâmetros customizados.

Ao término do processo de importação dos dados via Web Service a situação de Matrícula no Período Letivo será alterada de Reconhecimento de Saberes para Matriculado de acordo com o que foi definido no campo "Status de Matriculado" dos parâmetros automaticamente. 
Para cada disciplina, deverá ser informado um status correspondente a 1 ou 0.

0 = Competência não reconhecida;
1 = Competência reconhecida.


Exemplo: 
Código de Usuário: 012.345.678
Lista de Competências (disciplinas):

Código

Status

MAT-C1

1

MAT-C2

0

MAT-C3

1

MAT-C4

1

CNT-C1

0

CHT-C1

1



Parametros Customizados - Aba Reconhecimento de saberes 
Caso seja executado o processo para o aluno acima e ele esteja matriculado em todas as disciplinas enviadas pelo Web Service, ele ficará com as seguintes situações de matrícula nas disciplinas, considerando as parametrizações do exemplo:

  • MAT-C1: Competência Certificada
  • MAT-C2: Pré-Matriculado
  • MAT-C3: Competência Certificada
  • MAT-C4: Competência Certificada
  • CNT-C1: Pré-Matriculado
  • CHT-C1: Competência Certificada


O log do processo pode ser consultado na tabela ZLOGRECSABERPORTAL.

Pré-Requisitos / Parametrizações


Nenhum.

Descrição do Processo


Foi desenvolvido um webservice com a finalidade da troca de senha dos usuários.

Detalhamento do Processo


Foi desenvolvido um webservice customizado que realizará a troca de senha dos usuários, recebendo como parâmetro o código do usuário e a nova senha. O método está disponível para visualização no swagger.

Observação: a senha deverá ser informada na codificação Base64, conforme exemplos abaixo:


URL com os parâmetros adicionados: http://localhost:8080/rm/api/TOTVSCustomizacao/Usuario/SincronizarSenhaUsuario?codUsuario=lucianom&novaSenha=dG90dnM%3D


Envio da requisição via Postman:


O Método HTTP utilizado é o PUT. Quando a alteração de senha for realizada com sucesso, o campo "Sucess" será retornado como "true", e quando ocorrer um erro, será retornado como "false", e o campo "Message" irá detalhar o erro ocorrido, conforme no exemplo abaixo:



Manual disponibilizado pela equipe da Educar Brasil com a relação dos dados a serem configurados para realização do de-para entre o SGE e o Portal SESI.


IMPORTANTE: O regional deverá confirmar com a equipe da Educar Brasil se não houve alguma mudança/ atualização nas informações disponibilizadas no manual.



MANUAL_WEBSERVICE_SESI_SGE_2019_1_5.pdf


Autor

Versão

Data

Descrição das alterações

Adilson José de Aquino
Thiago Neiva Chagas

1.0

03/05/2016


Adilson José de Aquino

2.0

12/05/2016


Adilson José de Aquino

3.0

30/05/2016

Versão da Biblioteca

Adilson José de Aquino

4.0

08/06/2016

Versão da Biblioteca e ajustes solicitados

Adilson José de Aquino

5.0

09/06/2016

Ajustes solicitados

Adilson José de Aquino

6.0

15/06/2016

Versão da Biblioteca

Adilson José de Aquino

7.0

08/08/2016

Análise de impacto II

Gustavo Fonseca Nunes

8.0

25/04/2018

Ajustes dos arquivos

Pedro Antonio Silva Barroso

9.0

22/05/2018

Ajustes de acordo com as modificações do Rollaout 14/05/2018

Gustavo Fonseca Nunes

10.0

17/07/2018

Ajuste do campo CPF do Aluno que será enviado ao Portal SESI.
Atualização das imagens do De-Para da integração e orientação para consultar a documentação da EducarBrasil.

Ana Luiza Martins Moreira
Pedro Marcus Paixão Silva

11.0

17/09/2018

Incluindo Req 01 e 02 da especificação FS007972 (976970) - Reconhecimento de saberes.

Pedro Antonio Silva Barroso

12.0

27/09/2018

Formatação do documento para novo padrão FSW

Ana Luiza Martins Moreira13.021/10/2019Atualização da formatação do documento
Jéssica Gonçalves Silva14.007/04/2020Atualização nas tabelas de/para de acordo com o manual disponibilizado pela Educar Brasil.
Thiago Neiva Chagas15.004/03/2021Incluído WebMethod de alteração de senha dos usuários



Extra

O Portal SESI Educação utiliza do Web Service de Consultas da Lib DN, onde é possível realizar execução de consultas TOTVS via Web API. A Documentação deste serviço pode ser acessada aqui.