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.

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.

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.

[Novo!]

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.

Importante : Se o usuário do aluno estiver Ativo, o processo customizado irá pegar a informação do DE/PARA da situação de matrícula na parametrização do Portal SESI.

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

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.

Na integração de Funcionários ao Portal SESI Educação os registros contêm uma propriedade indicando o perfil do funcionário, por padrão é enviado o perfil "FUNCIONARIO" que equivale ao Funcionário Administrativo do Portal SESI Educação. Caso o perfil do Funcionário não deva ser Funcionário Administrativo, deve ser utilizado este cadastro para selecionar outro perfil [Funcionário Pedagógico e Administrador de Unidade]. 
Em vista disto, 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.

Ao salvar um novo cadastro de Turma, são realizadas as seguintes validações:

• Caso o campo complementar TURMASESIEDUCACAO não esteja preenchido é validado caracteres especiais no código da turma;

• Tendo preenchido o campo complementar TURMASESIEDUCACAO é validado para caracteres especiais no código ou descrição da Turma SESI preenchido.

• Quando existir log de integração do SGE x Portal SESI Educação no "Monitor de Log", identificando que já fora realizado alguma integração, o campo complementar TURMASESIEDUCACAO ficará bloqueado para edição.

Somente são validadas turmas que pertençam a Cursos parametrizados (parâmetro Curso/Segmento) e quando a integração estiver habilitada.

Ao enviar o Aluno ao Portal SESI Educação, são realizadas as seguintes validações:

1. Validação de email do Aluno (quando aluno não possui o email O365 (SALUNOCOMPL.EMAILO365 preenchido), utilizando serviço de validação de email, que deve ser parametrizado junto aos parâmetros da customização;
2. Validação de email do Responsável Acadêmico (quando preenchido), utilizando serviço de validação de email, que deve ser parametrizado junto aos parâmetros da customização.

Importante: Em caso de novo envio ao Portal SESI com email já tendo sido validado e não tenha sido alterado, é utilizado o ultimo resultado da validação.

Pré-Requisitos / Parametrizações

1. Realizar a parametrização da Integração e preenchimento De/Para;
2. Para envio dos dados do aluno enviamos ao PortalSESI um form-data que convertido em formato JSON são:

AlunoSGE {
    idred (string, obrigatório),
    regional (string, obrigatório),
    inep (string, obrigatório),
    codigointegrador (string, opcional),
    curso (string|AlunoItinerario, opcional),
    perfil (string, obrigatório),
    nome (string, obrigatório),
    codigoexterno (string, obrigatório),
    user_sen (string, opcional),
    sexo (string, obrigatório),
    nasc (DateTime, obrigatório),
    turno (string, opcional),
    segmento (string, obrigatório),
    serie (string, obrigatório),
    turma (string, obrigatório),
    respon_nome (string, opcional),
    respon_cpf (string, opcional),
    respon_email (string, opcional),
    respon_ra (string, opcional),
    respon_sen (string, opcional),
    status (string, obrigatório),
    cpf (string, opcional),
    email (string, opcional),
    emailcomplementar (string, opcional),
}
AlunoItinerario{
    area (string, obrigatório),
    itinerario (string, obrigatório)
}

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 pertençam a Período Letivo (SPLETIVO) que não estão encerrados, desconsiderando os demais.

[Novo!]

Alteração na Integração de Aluno - Considerar Somente a matrícula mais recente (DTMATRICULA) de turma que já tenham iniciado

A Integração de Aluno considera somente a matrícula no Período Letivo mais recente, considerando assim a que tiver a maior Data de Matricula no período Letivo dentre os cursos parametrizados para integrar (em parâmetros Cursos/Segmentos) e que a turma já tenha iniciado (Data Inicial da turma menor ou igual hoje). Identificado a matrícula mais recente do Aluno, são verificadas as demais consistências para esta matrícula, bem como a verificação se a turma desta matrícula está vigente - Considerando como vigente a turma que a data corrente compreender entre a Data Inicial e Final da Turma.

[Novo!]

Alteração na Integração de Aluno - Desconsiderar matrículas com situação de matrícula indicada para "Não enviar ao Portal SESI"

A Integração de Aluno considera somente as matrículas cuja o status não corresponder a uma das situações de matrícula parametrizadas com o checkbox "Não enviar ao Portal SESI" marcado. De modo que se a matrícula mais recente for uma com uma destas situações de matrícula o sistema irá procurar a próxima mais recente para enviar ao Portal SESI.

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.

Pré-Requisitos / Parametrizações

1. Realizar a parametrização da Integração e preenchimento De/Para;
2. Para envio dos dados do professor enviamos ao PortalSESI um form-data que convertido em formato JSON são:

   DocenteSGE {
       idred (string, obrigatório),
       regional (string, obrigatório),
       inep (string, obrigatório),
       codigointegrador (string, opcional),
       perfil (string, obrigatório),
       codigoexterno (string, obrigatório),
       cpf (string, opcional),
       nome (string, obrigatório),
       email (string, opcional),
       emailcomplementar (string, opcional),
       sexo (string, obrigatório),
       nasc (DateTime, obrigatório),
       status (string, obrigatório),
       aulas (array[Aula], obrigatório),
       user_sen (string, opcional)
   }
   Aula{
       area (string, obrigatório),
       segmento (string, obrigatório),
       turno (string, obrigatório),
       serie (string, obrigatório),
       turma (string, obrigatório),
       componente (string, obrigatório),
   }

   Nome	Campo	Origem	Observações
   Identificador SGE	DocenteSGE.idred	"7"	Enviado de forma fixa o valor '7'
   Regional	DocenteSGE.regional	GCOLIGADA.ESTADO	Estado do cadastro da Coligada
   Código Integrador	DocenteSGE.inep	DFILIAL.CAMPOLIVRE1	Cadastro de Filial: DFILIAL.CAMPOLIVRE1
   Código Integrador	DocenteSGE.codigointegrador	DFILIAL.CAMPOLIVRE1	Cadastro de Filial: DFILIAL.CAMPOLIVRE1
   Perfil	DocenteSGE.perfil	"ESTUDANTE"	Enviado de forma fixa o valor 'DOCENTE'
   Nome	DocenteSGE.nome	PPESSOA.NOME	Nome do Professor
   Código Externo	DocenteSGE.codigoexterno	PPESSOA.CODUSUARIO	Código do Usuário do Professor
   Senha do Usuário	DocenteSGE.user_sen	Senha do Usuário	Senha do Usuário do Professor
   Sexo	DocenteSGE.sexo	PPESSOA.SEXO	Correspondendo à 'feminino' | 'masculino'
   Data de Nascimento	DocenteSGE.nasc	PPESSOA.DTNASCIMENTO	Data de nascimento do Professor
   Status	DocenteSGE.status	SMATRICPL.CODSTATUS	Caso o GUSUARIO.STATUS for ativo, enviamos Ativo Senão enviamos Excluído
   CPF do Professor	DocenteSGE.cpf	PPESSOA.CPF	CPF do Professor
   E-mail do Professor	DocenteSGE.email	PPESSOA.EMAIL	Caso o e-mail O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado.
   E-mail complementar do Professor	DocenteSGE.emailcomplementar	SALUNOCOMPL.EMAILO365	Caso o email O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado como email complementar, do contrário nenhum email é enviado como complementar.
   Aulas	DocenteSGE.aulas	Turmas do Professor	Turma do professor (SMATRICPL.CODTURMA | STURMACOMPL.TURMASESIEDUCACAO), Curso da turma (SHABILITACAOFILIAL.CODCURSO | ZDEPARASEG.CODIGOPORTAL), Série da Turma (SHABILITACAOFILIAL.CODHABILITACAO | ZDEPARASERIE.CODIGOPORTAL), Turno da Turma (STURNO.TIPO | (Manhã;Tarde;Noite;Integral)), Área - Grupo de Complemento (SDISCGRADE.IDGRUPOCOMPLEMENTO | ZDEPARAAREA.CODIGOPORTAL), Disciplina/Componente (SDISCIPLINA.CODDISC | ZDEPARADISC.CODIGOPORTAL) como lista no formato JSON conforme a seguir: [{"turma":"A","segmento":"14","serie":"1","turno":"Tarde","area":"1","componente":"22"},{"turma":"A","segmento":"14","area":null,"componente":"33"},{"turma":"A","segmento":"14","serie":"1","turno":"Manhã","area":"1","componente":"4"}] Somente serão enviadas aulas de professores que atenderem aos critérios:  Estar vinculadas à uma turma que esteja com os campos data inicial e data final preenchidos (STURMA.DTINICIAL e STURMA.DTFINAL) e dentro do período vigente; Estar vinculadas à uma Turma/Disciplina que esteja com os campos data inicial e data final do período do professor preenchidos (SPROFESSORTURMA.DTINICIO e SPROFESSORTURMA.DTFINAL) e dentro do período vigente; Caso as datas de início e fim das Turmas e/ou período do professor na Turma/Disciplina, estejam em branco ou fora do período de vigência, não terão suas disciplinas exportadas.
   Turma	Aula.turma	STURMA.CODTURMA | STURMACOMPL.TURMASESIEDUCACAO	A prioridade é do campo TURMASESIEDUCACAO quando preenchido
   Segmento	Aula.segmento	SHABILITACAOFILIAL.CODCURSO	De/Para de Segmento correspondente ao Campo
   Turno	Aula.turno	SHABILITACAOFILIAL.CODTURNO	Correspondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral'
   Série	Aula.serie	SHABILITACAOFILIAL.CODHABILITACAO	De/Para de Serie correspondente ao Campo
   Área	Aula.area	SDISCGRADE.IDGRUPOCOMPLEMENTO	De/Para de Área - Grupo de Complemento correspondente ao Campo
   Componente	Aula.componente	STURMADISC.CODDISC	De/Para de Disciplina/Componente correspondente ao Campo

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 SESI Educação, 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

1. Realizar a parametrização da Integração;
2. Para envio dos dados do funcionário enviamos ao PortalSESI um form-data que convertido em formato JSON são:

   FuncionarioSGE {
       idred (string, obrigatório),
       regional (string, obrigatório),
       inep (string, obrigatório),
       codigointegrador (string, opcional),
       perfil (string, obrigatório),
       codigoexterno (string, obrigatório),
       cpf (string, opcional),
       nome (string, obrigatório),
       email (string, obrigatório),
       sexo (string, obrigatório),
       nasc (DateTime, obrigatório),
       status (string, obrigatório),
       user_sen (string, opcional)
   }

   Nome	Campo	Origem	Observações
   Identificador SGE	FuncionarioSGE.idred	"7"	Enviado de forma fixa o valor '7'
   Regional	FuncionarioSGE.regional	GCOLIGADA.ESTADO	Estado do cadastro da Coligada
   Código Integrador	FuncionarioSGE.inep	DFILIAL.CAMPOLIVRE1	Cadastro de Filial: DFILIAL.CAMPOLIVRE1
   Código Integrador	FuncionarioSGE.codigointegrador	DFILIAL.CAMPOLIVRE1	Cadastro de Filial: DFILIAL.CAMPOLIVRE1
   Perfil	FuncionarioSGE.perfil		Caso preenchido, é enviado o perfil parametrizado nos parâmetros de Funcionários (na parametrização da Integração Portal SESI Educação). Os Funcionários que não parametrizados são enviados com o perfil padrão (Funcionário Administrativo).
   Nome	FuncionarioSGE.nome	PPESSOA.NOME	Nome do Funcionário
   Código Externo	FuncionarioSGE.codigoexterno	PPESSOA.CODUSUARIO	Código do Usuário do Funcionário
   Senha do Usuário	FuncionarioSGE.user_sen	Senha do Usuário	Senha do Usuário do Funcionário
   Sexo	FuncionarioSGE.sexo	PPESSOA.SEXO	Correspondendo à 'feminino' | 'masculino'
   Data de Nascimento	FuncionarioSGE.nasc	PPESSOA.DTNASCIMENTO	Data de nascimento do Funcionário
   Status	FuncionarioSGE.status	SMATRICPL.CODSTATUS	Caso o GUSUARIO.STATUS for ativo, enviamos Ativo Senão enviamos Excluído
   CPF do Funcionário	FuncionarioSGE.cpf	PPESSOA.CPF	CPF do Funcionário
   E-mail do Funcionário	FuncionarioSGE.email	PPESSOA.EMAIL	E-mail do cadastro de pessoa (PPESSOA.EMAIL) do Funcionário é enviado.

Detalhamento do Processo

O termo 'funcionários' se refere às pessoas designadas a determinadas funções no SGE – Módulo Educacional (secretários escolares, membros da comissão coordenadora e diretores escolares).

Tais registros de 'funcionários' do SGE – Módulo Educacional são pessoas (PPESSOA) associados às funções através dos Menus:

• Filial | Dados Educacionais | <anexo> Diretores por Filial 
• Módulo Educacional | Currículo e Oferta | Estrutura Curricular | Matrizes curriculares | <anexo> Matriz aplicada | <anexo> Comissão Coordenadora'. 

Comissão Coordenadora:

Os membros da Comissão coordenadora devem estar cadastrados conforme abaixo:

Ao incluir uma pessoa no anexo de Comissão coordenadora, será necessário informar a função dessa pessoa na Comissão. Para esses membros temos as cinco funções:

• Coordenador,
• Vice- Coordenador,
• Assistente de coordenador,
• Conselho de coordenação,
• Coordenação pedagógica.

Diretores e secretários:

O cadastro dos Diretores e secretários, serão consultados com base nos dados informados em:

SGE - Módulo Fiscal | Filiais | Dados Educacionais | Diretores por Filial. 

Neste módulo são cadastrados os diretores e secretários.

Pré-Requisitos / Parametrizações

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

Detalhamento do Processo

A Inativação dos usuários de Alunos no Portal SESI Educação ocorre a partir da execução do Processo de Exportação de Inativação de Alunos. Este processo envia os usuários de Alunos a serem inativados no Portal SESI Educação dado o Fim da Vigência da Turma ou Status de resultado final preenchido.

  - É considerado somente a matrícula em Período Letivo mais recente (ultimo período letivo que tenha turma iniciada) para os Cursos/Segmentos parametrizados;
  - O Final da Vigência da turma é identificado quando a Data Corrente é maior que a Data Fim da Turma;
  - Tendo sido preenchido qualquer Situação na Situação de Resultado Final da Matrícula no Período Letivo o Aluno também é considerado para inativação;
  - São enviados somente os Alunos cujo a Data Matrícula mais recente tenha sido realizada após a "Data Referência" (configurada em parâmetros);

  - Não são enviadas inativação referente a matrículas em Filial inativa, sem o Código Integrador preenchido ou que tenha sido realizada antes da "Data Referência" (configurada em parâmetros);

O Processo pode ser agendado em ambientes de 3 camadas:

Importante: Os alunos que forem enviados para inativação, serão enviados apenas uma vez com sucesso para a matrícula, somente caso ocorra erro na inativação do Aluno que o mesmo será enviado novamente na próxima execução do processo. O Reenvio desta exportação se dá na própria execução do processo, não sendo possível enviar unitariamente.

Pré-Requisitos / Parametrizações

Detalhamento do Processo

A Inativação dos usuários de Funcionários no Portal SESI Educação ocorre a partir da inativação do usuário no cadastro do SGE.

Ao acessar o cadastro de um usuário que esteja integrado e ativo no Portal Sesi, desmarcando a flag Ativo será enviado o comando de inativação do usuário ao Portal Sesi Educação.

Pré-Requisitos / Parametrizações

Detalhamento do Processo

A exclusão dos usuários de Professores no Portal SESI Educação ocorre a partir da inativação do usuário no cadastro do SGE.

Para Excluir um professor do Portal SESI, acesse o cadastro do Professor e clique no Usuário, em seguida, desmarque a opção “Ativo” e clique em Salvar para desativar.

Logo após, edite alguma informação do cadastro do professor e clique em Salvar para a customização disparar o gatilho para a exclusão do usuário no Portal SESI:

Caso o professor que deseja excluir ministrava disciplinas que pertencem a um período letivo que esteja com a opção “Período letivo encerrado” marcada, o gatilho da customização não será disparado e não irá gerar log.

Pré-Requisitos / Parametrizações

1. Realizar a parametrização da Integração e preenchimento De/Para;

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.

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

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: