Manual Operacional da customização -

...

Integração Portal SESI

...

...

Objetivo

Este documento foi elaborado para informar aos usuários chave da área Educacional do SESI, sobre a Integração Portal SESI . A integração O manual a seguir visa detalhar a integração de alguns módulos da solução SGE com o Portal SESI Educaçãoé responsável pela sincronização de algumas entidades, facilitando assim a gestão e acesso aos participantes (alunos, professores, funcionários).

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

Metodologia

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

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

Para utilização da Integração com o Portal SESI Educação

é necessário observar alguns pontos:

1. É necessário ter o FRAMEHTML configurado e publicado em zona publica e acessível à chamada do Portal SESI Educação;
2. A publicação do FRAMEHTML deve ser feito em DNS público e com certificado válido, disponibilizando em um site HTTPS;
3. As configurações de publicação de serviços customizados no FRAMEHTML devem ter sido realizadas com sucesso;
4. A Instalação Completa da customização, seguindo instruções apresentadas na Guia de instalação e Release Notes;
5. A configuração inicial, com as informações do WebService, Usuário, TOKEN, devem ser preenchidos e a customização ativada (não Habilitada);

Alterar senha de todos os

1. Campo integrador preenchido (Cadastro de Filial: DFILIAL.CAMPOLIVRE1).
2. Alterar senha de todos os usuários que necessitam ser integrados com o Portal SESI (alunos, responsáveis acadêmicos, professores, funcionários);
3. Preencher

as equivalências dos códigos de Turma;

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.

Expandir
title Permissões e orientações Técnicas
Para utilização da Integração com o Portal SESI Educação
Informações
icon false
Toggle Cloak Premissas
Cloak
Informações
icon false

Toggle Cloak

Habilitando Menus (permissões)

Cloak

Habilitar os Menus dando permissões aos perfis pertinentes no módulo Globais

1. todos os parâmetros de DE PARA (descrito neste manual).
   1. Atenção: Esta parametrização é realizada por coligada (SESI – Departamento Regional) e somente para o nível de ensino do SGE – Módulo Educacional Educação Básica (Ensino Básico)
2. Habilitar os menus, dando permissões aos perfis de usuários, conforme demostrado no Gif abaixo:

           Image Added

infoiconfalse

Expandir
title Parâmetros da Integração
Table Excerpt name ParametrosIntegracao Table Excerpt name ParametrosIntegracaoIntro Além das premissas técnicas, é essencial realizar algumas configurações para garantir o sucesso da integração: Acesse os Parâmetros através do seguinte caminho: TOTVS Educacional > Sistema Indústria >Portal SESI> Parâmetros  Image Added A interface exibirá sete abas para serem configurados: Identificação, Reconhecimento de Saberes, Cursos (segmentos), Situações de matrícula, Validação de e-mail, Funcionários e Autenticação SSO. Deck of Cards history false id Params Card label Identificação Table Excerpt name parametrosidentificacao Nesta aba, são configurados os campos básicos para o funcionamento da integração. Image Added Habilita Integração Portal SESI Educação -
Informações
icon false
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:  falseAba IdentificaçãoHabilita 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 da Integração: Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil; Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil; Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil. Estando Habilitado a Integração, estes 3 parâmetros são Obrigatórios. Datas Classificação de Municípios (IBGE): Campo com lista de classificação de municípios (DCLASSIFMUNICIPIO), para o usuário selecionar em qual classificação de Município corresponde a do IBGE. Dias para envio de turma finalizada: Neste campo o usuário deverá informará a quantidade de dias (em números)  em que uma turma já finalizada será considerada na exportação. Card label Reconhecimento de Saberes Table Excerpt name parametrosrecsabes Nesta aba, são configurados os campos referentes ao Reconhecimento de Saberes. Image Added Token para WS: Este recurso serve para gerar um Token do tipo Basic Authentication, o qual deve ser informado no Portal SESI para utilização da autenticação da comunicação com o SGE Gerando... Para gerar o Token deve ser informado o usuário e senha do usuário que será registrado a utilização da integração vinda do Portal SESI Educação. Image Added É importante utilizar um usuário exclusivo. Os demais campos, são para configurar os status e motivos de alteração para indicar quando a situação do aluno  for: Reconhecimento de Saberes: Utilizado para identificar as disciplinas em Reconhecimento de Saberes, que precisam ser reconhecidas pelo Portal SESI Educação. Competências reconhecidas:  Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes; Motivo da alteração: Utilizado no Motivo Alteração 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; 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; 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; 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 SaberesToken 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 Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes; Utilizado no Motivo Alteração , ao alterar a situação de matrícula para situação ¹ Competência Reconhecida automaticamente Reconhecida automaticamente pelo processo. Competência Competências não Reconhecida reconhecidas: Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes ;Utilizado no Motivo Alteração Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação ¹ Competência não Reconhecida automaticamente Reconhecida automaticamente pelo processo. Matrícula no Período Letivo Matricula no período letivo: Utilizado para alterar a situação da Matrícula da Matrícula no Período Letivo ao Letivo ao receber o retorno do Reconhecimento do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado; Utilizado no Motivo Alteração Motivo de alteração: Utilizado no Motivo Alteração, ao alterar a situação da Matrícula da Matrícula no Período Letivo automaticamente Letivo automaticamente pelo processo. Card false label Aba Cursos (Segmentos) Um cadastro onde Table Excerpt name parametroscursos Nesta aba 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. Image Added 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.  Image Added Card false label 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á Table Excerpt name parametrossitmatric Para integração dos alunos  no Portal SESI, o status do aluno é 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.  sua Situação de Matrícula no SGE.  Nesta aba o usuário deverá informar as situações de matricula no SGE, que o Portal SESI deve considerar como: Pré matriculado, Matriculado ou Inativo. Image Added Ao incluir um novo registro será apresentado 3 campos para preenchimento: Sit. Matricula: Lista  das as situações de matrículas existentes na base. Status Indica: Status no Portal SESI, da situação de matricula selecionada. Podendo ser Pré matriculado, Matriculado ou Inativo. Não enviar ao Portal SESI:  É 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. Image Added           Image Added Estado colour Green title Exemplo: Se a Escola  considerar que a situação de matricula "cancelado" do SGE deve ser enviada ao Portal SESI como Inativo, o preenchimento será da seguinte: Image Added Se em determinado momento a Escola determinar que essa situação de matrícula não deve ser considerada na  Exportação ao Portal SESI é necessário marcar  o checkbox: Image Added Aviso Se o usuário do aluno estiver Ativo, o processo customizado de exportação ao Porlta SESI busca a informação  parametrizada nessa aba, para fazer a relação da situação de matricula do Aluno com status indica, identifcado se será ou não exportado 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 Inativo. false Card label Aba Validação de Email [Novo!] Validação de e-mail Table Excerpt name parametrosvalidaemail Essa aba refere-se a configurações para utilização de Consulta/validação de email pela Quickemail. Os campos apresentados são: URL API: Endereço de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil; TOKEN: Token de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil. false Intervalo de horas: Este campo será considerado para validar novamente o e-mail na QuickeMail (somente daqueles que  não tenham sido considerados "válidos") respeitando o intervalo de horas definido no parâmetro.  Image Added Card label Funcionários Table Excerpt name parametrosfuncionarios Na integração de Funcionários ao Portal SESI Educação os registros contêm uma propriedade indicando o perfil do funcionário. Este cadastro deve ser utilizado para informar o perfil de cada Funcionário, que poderá ser: Funcionário Administrativo (Perfil padrão do Portal SESI) Funcionário Pedagógico e Administrador de Unidade Image Added Neste 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: 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; 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; 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. Image Added Aviso 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.
Card	label	Autenticação SSO toggle table- cloak Extrair Campos ComplementaresTURMASESIEDUCACAO 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.Sistema de Gestão de Oficinas – SGO 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. Validações [Novo!] 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 o código e descrição. 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. Importante: O campo deve ser ativado pelo usuário - name Cloak parametrossso Aba destinada à configuração de logins via SSO (Single Sign-On).  Os campos são preenchidos automaticamente após a Importação do Arquivo (config_sesi.json) que é fornecido pelo Portal SESI Image Added Abaixo descrição dos campos para conhecimento: Endereço WebService: Endereço de acesso ao webservice disponibilizado pelo Portal SESI. Public Key: chave pública para descriptografar o token JWT. Client ID: usuáriode acesso ao webservice disponibilizado pelo Portal SESI. Secret Key: Senhade acesso ao webservice disponibilizado pelo Portal SESI. Importar arquivo (config_sesi.json): Botão para importação das configurações via arquivo JSON*. *Arquivo disponibilizado pelo Portal SESI.

O SGE – Módulo Educacional

possui valores para as suas tabelas, campos, cadastros, tipos que

não condizem

divergem com os valores atuais cadastrados no Portal SESI Educação.

Como estamos tratando de uma

Além das parametrizações descritas acima, é

Para a integração é necessário

efetuar a troca por

ter 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 

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,

para criar esse relacionamento e 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).

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

Image Added

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

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

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

Image Added

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

Image Added

Expandir
title DE I PARA
O SGE
Informações
icon false
Toggle Cloak De | Para
Cloak

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

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

Image Added

4- Valor no Portal SESI Educação: Onde deve ser informado o código equivalente no Portal SESI Educação 

falseAcessando...

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

Curso/Segmento

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

Disciplina

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) - Em caso de não equivalente o mesmo deve ser preenchido com 0.

Habilitação/Série

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

Área - Grupo de Complemento

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) - Em caso de não equivalente o mesmo deve ser preenchido com 0.

Área Itinerário

[Novo!]

Nesta entidade devem ser preenchidos os campos:

• "Valor do TOTVS Educacional" onde deve ser selecionada a Curso que corresponderá uma área no Portal SESI Educação;
• "Valor no Portal SESI Educação" onde deve ser informado o código da área do itinerário no Portal SESI Educação (validar com responsável pelo portal).

Itinerario

[Novo!]

Nesta entidade devem ser preenchidos os campos:

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

Informações

icon	false

Toggle Cloak

Validações Cadastrais [Novo!]

Cloakfalse Caracteres especiais Turma SESI Educação

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.

falseEmail de Aluno e Responsável Acadêmico

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.

Informações

icon	false

Toggle Cloak

Integrações

CloakfalseAlunos (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 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)
}

Campo

Origem

Observações

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

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.

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.

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

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),
}

Campo

Origem

Observações

Caso o GUSUARIO.STATUS for ativo, enviamos Ativo

Senão enviamos Excluído

Turno

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.

Pré-Requisitos / Parametrizações

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'

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

Caso o GUSUARIO.STATUS for ativo, enviamos Ativo

Senão enviamos Excluído

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.

• Os campos obrigatórios, as parametrizações e os e-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:

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;

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.

Pré-Requisitos / Parametrizações

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

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.

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

Conforme imagem abaixo:

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.

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.

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:

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

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:

Pré-Requisitos / Parametrizações

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

Foram desenvolvidos entry-points 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;
• Currículo e Oferta | Professores;
• Currículo e Oferta | Oferta | Turma Disciplina | Professores;
• Cadastro de usuários (apenas alteração de e-mail/senha dispara a exportação).

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

Pré-Requisitos / Parametrizações

1. 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.
2. É 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.
3. 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.

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.

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.

Código

Status

MAT-C1

1

MAT-C2

0

MAT-C3

1

MAT-C4

1

CNT-C1

0

CHT-C1

1

• 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