No cadastro de Alunos e Professores do TOTVS Educacional, a customização valida o preenchimento do campo e-mail, tornando esse campo obrigatório ao incluir ou editar um registro, exibindo a mensagem Campo e-mail obrigatório, caso o usuário não preencha o e-mail.

Além da obrigatoriedade do campo e-mail, a customização valida se o e-mail informado no cadastro da pessoa já está associado a outra Pessoa. Se sim, é exibida a seguinte mensagem com os dados de Nome e CPF da pessoa que já está utilizando o e-mail:

“O e-mail informado já está sendo utilizado por:

Nome: Letícia Viana

CPF: 111.111.111-11”

Em ambos os casos, o registro não é salvo.

Pré-Requisitos / Parametrizações

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 necessário criar 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 

Esta funcionalidade será denominada 'Cadastro de DE/PARA' e está sendo 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, disponibilizaremos 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).

Detalhamento do Processo

Os cadastros que necessitam de uma DE/PARA são: 'Segmento/Nível de Ensino' do Portal SESI Educação, que no Acesse o SGE – Módulo Educacional é interpretado como 'Curso', e o cadastro de 'Disciplinas'. 
A interface de edição contará com os seguintes controles:

• Um controle do tipo "lista para seleção" para permitir a seleção de a qual cadastro (Segmento/Curso ou Disciplina ou Série) se referem os valores;
• Um campo do tipo 'seleção a partir de uma lista dinâmica' para permitir a seleção do valor no SGE – Módulo Educacional, será o valor do campo DE (origem);
• Um campo alfanumérico para digitação do valor equivalente no Portal SESI Educação, será o valor do campo PARA (destino).

Detalhamento do Processo

Usuário acessa o SGE – Módulo Educacional, através do menu "Customização / DE/PARA da integração". Será exibida uma tela de visão com as opções de inclusão, exclusão e edição.

Image Removed

, através do menu "Customização / DE/PARA da integração". É exibida uma tela de visão com as opções de inclusão, exclusão e edição.

Image Added

Através desse módulo é possível realizar o cadastro de De/PARA. Ao incluir um novo registro é exibida uma tela contendo os três campos para identificação.

Image Added.

Deve ser selecionado o tipo de Entidade (Cadastro), que pode ser: Curso/Segmento, Disciplina ou Habilitação/Série.

• Curso/Segmento: são exibidos no campo "Valor do SGE – Módulo Educacional" os cursos disponíveis;
• Disciplina: são exibidos no campo "Valor do SGE – Módulo Educacional" as disciplinas disponíveis;
• Habilitação/Série: são

Image Removed

• Curso/Segmento: serão exibidos no campo "Valor do SGE – Módulo Educacional" os cursos disponíveis;
• Disciplina: serão exibidos no campo "Valor do SGE – Módulo Educacional" as disciplinas disponíveis;
• Habilitação/Série: serão exibidos no campo "Valor do SGE – Módulo Educacional" as habilitações disponíveis.
• Área - Grupo de Complemento:  serão são exibidos no campo "Valor do SGE – Módulo Educacional" aos grupos de complemento disponíveis.

No campo "Valor no Portal SESI Educação" deverá deve ser informado o valor a ser enviado quando for executada a integração. 
Exemplo:
No SGE – Módulo Educacional o Nome da Habilitação é "Ferramentas da Qualidade", porém esse código não é válido para o Portal SESI. Neste caso deve informado um valor válido conforme manual do WebService de Integração disponibilizado pela equipe do EducarBrasil. 
Conforme manual de Integração do WebService os valores válidos são:

Pré-Requisitos / Parametrizações

Realizar a parametrização da Integração e parametrização do De/Para Cursos, Habilitações e Disciplinas. 
Para envio dos dados do aluno os campos abaixo são de preenchimento obrigatório:

Descrição do Processo

Funcionalidade no Job de integração para realizar a exportação de Alunos.

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

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.

Pré-Requisitos / Parametrizações

Realizar parametrização da Integração e Parametrização De/Para Cursos e Disciplinas.

Descrição do Processo

Funcionalidade no Job de integração para realizar a exportação de Professores. 

Para envio dos dados do professor os campos abaixo são de preenchimento obrigatório:

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 expotados Professores cujas as Turmas pertencam 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.

Pré-Requisitos / Parametrizações

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

Dscrição do Processo

Funcionalidade no Job de integração para realizar a exportação de Funcionários. 

Para envio dos dados do funcionário os campos abaixo são de preenchimento obrigatório:

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. 

Image Modified

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.

Image Modified

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:

• Alunos (e responsáveis pelos alunos);
• Professores (Docentes);
• Funcionários (Diretores Escolares, Secretários Escolares, Orientadores, Coordenadores);
• Reenvio de dados.

Conforme imagem abaixo:

Image Modified

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.

Image Modified

Image Modified

Image Modified

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:

Image Added

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:

Image Added

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

Image Added

Tabela com códigos de erros do WebService

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

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.