Páginas filhas
  • Manual Operacional - Integração SGE x Portal SESI

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações
iconfalse

Toggle Cloak
Premissas

Cloak

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

  1. É necessário ter um usuário RM vinculado à base de dados;
  2. É necessário ter o FRAMEHTML configurado e publicado em zona publica e acessível à chamada do Portal SESI Educação;
  3. A publicação do FRAMEHTML deve ser feito em DNS público e com certificado válido, disponibilizando em um site HTTPS;
  4. As devem ter sido realizadas com sucesso;
  5. A Instalação Completa da customização, seguindo instruções apresentadas na Guia de instalação e Release Notes;
  6. A configuração inicial, com as informações do WebService, Usuário, TOKEN, devem ser preenchidos e a customização ativada (não Habilitada);
  7. Alterar senha de todos os usuários que necessitam ser integrados com o Portal SESI (alunos, responsáveis acadêmicos, professores, funcionários);
  8. Preencher as equivalências dos códigos de Turma;
  9. Os Cursos a serem integrados e os DE | Para.


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

...

Informações
iconfalse

Toggle Cloak
Parametrizações

Cloak

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) 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: 

false

Aba Identificação

Habilita Integração Portal SESI Educaçã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.

Dados de Integraçã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.

Datas

  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. Também é utilizada no envio de Inativação de alunos para filtrar matrículas antigas, enviando apenas inativações relacionadas à matrículas posteriores a Data Referência;
  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 é utilizado somente para o envio das inativações de alunos,  e para os demais 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.

false

Aba Reconhecimento de Saberes

Token

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.

À Reconhecer

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

Competência Reconhecida

  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.
Competência não Reconhecida

  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.
Matrícula no Período Letivo

  1. 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;
  2. Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.
false

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.

false

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.

[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.

false

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.
false

Aba Funcionários [Novo!]

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.

...

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).
Informações
iconfalse

Toggle Cloak
Integrações

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 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.
Checklist do Aluno 1 complete O Curso da Matrícula do Aluno está parametrizado nos Cursos/Segmentos? 2 complete A Matrícula verificada é a mais recente? - Somente a matrícula mais recente em curso parametrizado é considerada para a integração. 3 incomplete O Aluno está ativo e possui cadastro de usuário? - O Usuário é necessário para a integração. 4 incomplete Desde a configuração da integração a senha do aluno já foi alterada ao menos uma vez? - É necessário para que a integração registre o usuário na tabela ZUSUARIOSGE 5 incomplete A turma está vigente? - Considerando como vigente a turma que a data corrente compreender entre a Data Inicial e Final da Turma. 6 incomplete O Período Letivo não está encerrado? - Períodos letivos encerrados não são enviados. 7 incomplete O Aluno não tem Situação de Resultado Final? - Somente alunos sem resultado são enviados. 8 incomplete O campo Obrigatório "CodInepInstituição" está preenchido? (Campo "CAMPOLIVRE1" do Anexo Dados Fiscais do cadastro de Filial não preenchido) 9 incomplete A Situação de Matrícula está parametrizada? - Parâmetro utilizado para definir o status correspondente que será enviado ao Portal SESI Educação. 10 incomplete O Email do Aluno está preenchido? - Obrigatório para integração. 11 incomplete Caso seja menor de 18 anos, o seu responsável acadêmico está preenchido? - E neste caso o usuário do responsável também deve estar presente na ZUSUARIOSGE, pois se torna obrigatório para a integração.

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.

falseProfessores (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:

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.
  1. 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)
}

Cloak
false

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: DFILIAL.CAMPOLIVRE1

Nome

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

CPF

PPESSOA.CPF

EMAILCaso o email O365 (SALUNOCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o email do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado. [Alterado!]
EMAIL ComplementarCaso o email O365 (SALUNOCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado como email complementar, do contrário nenhum email é enviado como complementar. [Alterado!]

Sexo

PPESSOA.SEXO

Nascimento

PPESSOA.DTNASCIMENTO

Turno

Matriz Aplicada (SHABILITACAOFILIAL.CODTURNO)

Curso [Novo!]

Área Itinerário (SCURSO.CODCURSO | DEPARAAREAITINERARIO.CODIGOPORTAL) Itinerário (SITINERARIOFORMATIVOGRADE.CODITINERARIOFORMATIVO | DEPARAITINERARIO.CODIGOPORTAL) como item único no formato JSON conforme a seguir: {"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

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

EMAIL ComplementarEmail O365 (SPROFESSORCOMPL.EMAILO365).

CPF

PPESSOA.CPF

Senha

Obrigatória na inclusão

Aulas [Novo!]

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.
Nome

Campo

Origem

Observações

Identificador SGEAlunoSGE.idred "7"Enviado de forma fixa o valor '7'
RegionalAlunoSGE.regional GCOLIGADA.ESTADOEstado do cadastro da Coligada
Código IntegradorAlunoSGE.inep DFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1
Código IntegradorAlunoSGE.codigointegradorDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1
CursoAlunoSGE.curso|stringSCURSO.CODCURSODe/Para de Curso correspondente ao Campo caso o AlunoSGE.segmento seja 17 ou 18
PerfilAlunoSGE.perfil "ESTUDANTE"Enviado de forma fixa o valor 'ESTUDANTE'
NomeAlunoSGE.nome PPESSOA.NOME | PPESSOA.NOMESOCIAL + PPESSOA.SOBRENOMENome do Aluno - Caso o PPESSOA.NOMESOCIAL esteja preenchido ele substitui o nome juntando com o sobrenome da pessoa (PPESSOA.SOBRENOME)
Código ExternoAlunoSGE.codigoexterno PPESSOA.CODUSUARIOCódigo do Usuário do Aluno
Senha do UsuárioAlunoSGE.user_sen Senha do UsuárioSenha do Usuário do Aluno
SexoAlunoSGE.sexo PPESSOA.SEXOCorrespondendo à 'feminino' | 'masculino'
Data de NascimentoAlunoSGE.nasc PPESSOA.DTNASCIMENTOData de nascimento do Aluno
TurnoAlunoSGE.turno SHABILITACAOFILIAL.CODTURNOCorrespondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral'
SegmentoAlunoSGE.segmento SHABILITACAOFILIAL.CODCURSODe/Para de Segmento correspondente ao Campo
SérieAlunoSGE.serie SHABILITACAOFILIAL.CODHABILITACAODe/Para de Serie correspondente ao Campo
TurmaAlunoSGE.turma STURMA.CODTURMA | STURMACOMPL.TURMASESIEDUCACAOA prioridade é do campo TURMASESIEDUCACAO quando preenchido
Nome do ResponsávelAlunoSGE.respon_nomePPESSOA.NOMENome do Responsável Acadêmico
CPF do ResponsávelAlunoSGE.respon_cpf PPESSOA.CPFCPF do Responsável Acadêmico
E-mail do ResponsávelAlunoSGE.respon_email PPESSOA.EMAILE-mail do Responsável Acadêmico
Código do Usuário do ResponsávelAlunoSGE.respon_ra PPESSOA.CODUSUARIOCódigo do Usuário do Responsável Acadêmico
Senha do UsuárioAlunoSGE.respon_sen Senha do UsuárioSenha do Usuário do Responsável Acadêmico
StatusAlunoSGE.status SMATRICPL.CODSTATUS

Caso o GUSUARIO.STATUS for ativo, identificamos de acordo com os parâmetros de Situação de Matrícula correspondendo à Ativo | Inativo | Excluído

Senão enviamos Excluído

CPF do AlunoAlunoSGE.cpf PPESSOA.CPFCPF do Aluno
E-mail do AlunoAlunoSGE.email PPESSOA.EMAILCaso o e-mail O365 (SALUNOCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado. 
E-mail complementar do AlunoAlunoSGE.emailcomplementar SALUNOCOMPL.EMAILO365Caso o email O365 (SALUNOCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado como email complementar, do contrário nenhum email é enviado como complementar.
Área do ItinerárioAlunoItinerario.areaSHABILITACAOFILIAL.CODCURSOCaso o aluno esteja matriculado em um Itinerário: De/Para de Área correspondente ao Campo
ItinerárioAlunoItinerario.itinerarioSMATRICPLITINERARIOFORMATIVO.CODITINERARIOFORMATIVOCaso o aluno esteja matriculado em um Itinerário: De/Para de Itinerário correspondente ao Campo

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 (STURMA.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 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.



Checklist do Aluno 1 incomplete O Curso da Matrícula do Aluno está parametrizado nos Cursos/Segmentos? 2 incomplete A Matrícula verificada é a mais recente? - Somente a matrícula mais recente em curso parametrizado é considerada para a integração. 3 incomplete O Aluno está ativo e possui cadastro de usuário? - O Usuário é necessário para a integração. 4 incomplete Desde a configuração da integração a senha do aluno já foi alterada ao menos uma vez? - É necessário para que a integração registre o usuário na tabela ZUSUARIOSGE 5 incomplete A turma está vigente? - Considerando como vigente a turma que a data corrente compreender entre a Data Inicial e Final da Turma. 6 incomplete O Período Letivo não está encerrado? - Períodos letivos encerrados não são enviados. 7 incomplete O Aluno não tem Situação de Resultado Final? - Somente alunos sem resultado são enviados. 8 incomplete O campo Obrigatório "CodInepInstituição" está preenchido? (Campo "CAMPOLIVRE1" do Anexo Dados Fiscais do cadastro de Filial não preenchido) 9 incomplete A Situação de Matrícula está parametrizada? - Parâmetro utilizado para definir o status correspondente que será enviado ao Portal SESI Educação. 10 incomplete O Email do Aluno está preenchido? - Obrigatório para integração. 11 incomplete Caso seja menor de 18 anos, o seu responsável acadêmico está preenchido? - E neste caso o usuário do responsável também deve estar presente na ZUSUARIOSGE, pois se torna obrigatório para a integração.


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.

false

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 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 SGEDocenteSGE.idred "7"Enviado de forma fixa o valor '7'
    RegionalDocenteSGE.regional GCOLIGADA.ESTADOEstado do cadastro da Coligada
    Código IntegradorDocenteSGE.inep DFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1
    Código IntegradorDocenteSGE.codigointegradorDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1
    PerfilDocenteSGE.perfil "ESTUDANTE"Enviado de forma fixa o valor 'DOCENTE'
    NomeDocenteSGE.nome PPESSOA.NOMENome do Professor
    Código ExternoDocenteSGE.codigoexterno PPESSOA.CODUSUARIOCódigo do Usuário do Professor
    Senha do UsuárioDocenteSGE.user_sen Senha do UsuárioSenha do Usuário do Professor
    SexoDocenteSGE.sexo PPESSOA.SEXOCorrespondendo à 'feminino' | 'masculino'
    Data de NascimentoDocenteSGE.nasc PPESSOA.DTNASCIMENTOData de nascimento do Professor
    StatusDocenteSGE.status SMATRICPL.CODSTATUS

    Caso o GUSUARIO.STATUS for ativo, enviamos Ativo

    Senão enviamos Excluído

    CPF do ProfessorDocenteSGE.cpf PPESSOA.CPFCPF do Professor
    E-mail do ProfessorDocenteSGE.email PPESSOA.EMAILCaso 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 ProfessorDocenteSGE.emailcomplementar SALUNOCOMPL.EMAILO365Caso 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.
    AulasDocenteSGE.aulasTurmas 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.
    TurmaAula.turmaSTURMA.CODTURMA | STURMACOMPL.TURMASESIEDUCACAOA prioridade é do campo TURMASESIEDUCACAO quando preenchido
    SegmentoAula.segmentoSHABILITACAOFILIAL.CODCURSODe/Para de Segmento correspondente ao Campo

    Turno

    Aula.turnoSHABILITACAOFILIAL.CODTURNOCorrespondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral'
    SérieAula.serieSHABILITACAOFILIAL.CODHABILITACAODe/Para de Serie correspondente ao Campo
    ÁreaAula.areaSDISCGRADE.IDGRUPOCOMPLEMENTODe/Para de Área - Grupo de Complemento correspondente ao Campo
    ComponenteAula.componenteSTURMADISC.CODDISCDe/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.

false

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

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'

    RegionalFuncionarioSGE.regionalGCOLIGADA.ESTADOEstado do cadastro da Coligada
    Código IntegradorFuncionarioSGE.inepDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1
    Código IntegradorFuncionarioSGE.codigointegradorDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1
    PerfilFuncionarioSGE.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).

    NomeFuncionarioSGE.nomePPESSOA.NOMENome do Funcionário
    Código ExternoFuncionarioSGE.codigoexternoPPESSOA.CODUSUARIOCódigo do Usuário do Funcionário
    Senha do UsuárioFuncionarioSGE.user_senSenha do UsuárioSenha do Usuário do Funcionário
    SexoFuncionarioSGE.sexoPPESSOA.SEXOCorrespondendo à 'feminino' | 'masculino'
    Data de NascimentoFuncionarioSGE.nascPPESSOA.DTNASCIMENTOData de nascimento do Funcionário
    StatusFuncionarioSGE.statusSMATRICPL.CODSTATUS

    Caso o GUSUARIO.STATUS for ativo, enviamos Ativo

    Senão enviamos Excluído

    CPF do FuncionárioFuncionarioSGE.cpfPPESSOA.CPFCPF do Funcionário
    E-mail do FuncionárioFuncionarioSGE.emailPPESSOA.EMAILE-mail do cadastro de pessoa (PPESSOA.EMAIL) do Funcionário é enviado. 
falseFuncioná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 : 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

Perfil [Novo!]


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, membros da comissão coordenadora e 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 'dos Menus:

  • Filial | Dados Educacionais | <anexo> Diretores por
Filial e 'SGE –
  • 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:

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, as parametrizações e os e-
mail
  • mails dos funcionários (seja eles membros da comissão, diretores ou secretários) são validados e
,
  • se estiverem corretos, são o enviados para o Portal SESI Educação, e seu retorno será gravado na tabela de Log.
  • Para que um "funcionário seja exportado, no seu cadastro de pessoal ele deve ter um usuário vinculado, conforme imagem abaixo:

           

false

Inativação de Alunos [Novo!]

Pré-Requisitos / Parametrizações

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

Importante

Para realizar a Inativação de Alunos o Parâmetro "Data Referência" deverá ser preenchido.



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.

false

Inativação de Funcionários [Novo!]

Pré-Requisitos / Parametrizações


Importante

Diferente da Inativação de Alunos, a Inativação de Funcionários não possui um processo automatizado, necessitando ser feito manualmente pelo usuário.

Essa inativação é feita através do gatilho (plugin) existente no cadastro de usuários.



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.

false

Exclusão de Professores [Novo!]

Pré-Requisitos / Parametrizações


Importante

Da mesma forma que a Inativação de Funcionários, a exclusão de Professores não possui um processo automatizado, necessitando ser feito manualmente pelo usuário.

Essa exclusão é feita através do gatilho (plugin) existente no cadastro de usuários.



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.

...

Informações
iconfalse

Toggle Cloak
Monitor de Log

Cloak

Uma visão customizada foi criada para que seja possível verificar os dados enviados durante as integrações realizadas. Para cada registro exportado, foi criado um Log nessa tabela contendo os parâmetros utilizados, a entidade integrada.

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


Para informações sobre Alteração Status Logs com Erro e o processo de Exclusão de Logs no monitor, acesse o Manual Operacional da Customização - LIB DN

Informações
iconfalse

Toggle Cloak
Web APIs

Cloak
false

Integração de Usuários

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

false

Integração de Senha

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:


...