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

O manual a seguir visa detalhar a integração de

Expandir

title	Síntese

O SESI adota como diretriz para a gestão escolar a solução SGE (Totvs) e o complementa com o Portal SESI Educação (EducarBrasil) portal de apoio voltado ao ensino que está em consonância com as diretrizes definidas pelo Ministério da Educação que permite ao usuário uma navegação fácil, rápida e intuitiva.
Âncora_GoBack_GoBackFoi identificada pelo SESI a necessidade de integrar

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

Para atender tal demanda, foram desenvolvidas rotinas customizadas que utilizam de Webservices disponibilizados por ambos os sistemas para possibilitar a comunicação e a integração dos dados. Âncora_Toc526258657

Web Service Consulta SQL

_Toc526258657

Cloak

Observações Importantes

Nas máquinas e/ou servidores com acesso ao RM.exe onde será realizada a importação de e-mails via XLS (a ser realizada uma única vez como processo inicial) torna-se necessário que exista o MS-Office/Ms-Excel instalado, para que seja possível à customização abrir o arquivo e executar a leitura do mesmo durante a importação de planilhas do Excel.
Detalhes sobre necessidade do MS-Excel:
Para que este método funcione é necessário ter instalado, no computador onde o processo será iniciado (client), os objetos de transferência de dados entre aplicações do office (Microsoft Access Database Engine Redistributable – AccessDatabaseEngine.exe). Normalmente, em computadores que possuem o office instalado, isto já está presente.

*_

Office 2007: http://www.microsoft.com/en-us/download/details.aspx?id=23734

_*

Office 2010: http://www.microsoft.com/en-us/download/details.aspx?id=13255

O Excel avalia o conteúdo das primeiras linhas para determinar o tipo de dado (http://dougbert.com/blog/post/Importing-from-Excel-IMEX-and-mixed-data-types.aspx

,_*

http://support.microsoft.com/kb/194124/EN-US) então é importante que as colunas das planilhas e seus dados estejam com a tipagem de acordo com os definidos nos layouts abaixo.

_*

anchor

Expandir

ParametrosParametros Âncora_Toc526258658_Toc526258658Parâmetros de customização integração

Pré-Requisitos / Parametrizações

Nenhum.

Descrição do Processo

Foi desenvolvida uma parametrização para configurar os dados da integração SGE – Módulo Educacional (Totvs) e Portal SESI Educação (EducarBrasil).

Detalhamento do Processo

No SGE – Módulo Educacional, por meio do menu customização, foi criada uma interface customizada por onde o usuário administrador poderá efetuar a parametrização da integração.
Esta parametrização será realizada por coligada (SESI – Departamento Regional) e nível de ensino do SGE – Módulo Educacional (Educação Básica) e as informações preenchidas pelo usuário são armazenadas em tabela customizada.
Os parâmetros estão agrupados em abas/guias. A seguir apresentamos os parâmetros necessários para a integração e seus significados:
Aba Identificação

Integração habilitada: parâmetro do tipo caixa de marcação (checkBox) e 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;
ATENÇÃO: Esse parâmetro deve estar desmarcado para a execução do processo de carga inicial. Após isso ele deve ser marcado para possibilitar a integração síncrona.

Dados de acesso ao webservice disponibilizado pela EducarBrasil:

Caminho do WebService: parâmetro do tipo texto onde deve ser informado o endereço de acesso ao webservice de integração disponibilizado pela EducarBrasil;

Usuário: parâmetro do tipo texto e onde deve ser informado o usuário do Portal SESI Educação (EducarBrasil) para o consumo do webservice;

Token: parâmetro do tipo texto que representa uma chave de verificação para o consumo do webservice;

Utilizar data referência/corte: parâmetro do tipo caixa de marcação (checkBox) e representa um indicativo se a integração, na recuperação dos registros, utilizará uma data mínima como referência, isto é, apenas registros incluídos/alterados após tal data serão considerados na integração.

Caso tal parâmetro não seja marcado então todos os registros da entidade serão considerados na integração;

Data referência: parâmetro que aceitará apenas valores do tipo data e onde deve ser informado com data de referência (ou de corte) a ser utilizada para recuperação dos registros a serem considerados no processo de integração. Apenas registros incluídos/alterados cuja data seja igual ou posterior a tal data serão processados.

Este parâmetro estará/será habilitado apenas se o parâmetro "Utilizar data referência" estiver marcado.
Caso o parâmetro "Utilizar data referência" estiver marcado então este campo será obrigatório;

Data da última execução do processo (data da última integração): As integrações podem ser realizadas por cadastros separadamente, então apresentaremos, apenas para visualização (somente leitura), as datas em que ocorreu a última integração de acordo com o cadastro.

Caso o parâmetro "Integração habilitada" esteja marcado (integração ativa) então os parâmetros "Caminho do WebService", "Usuário" e "Token" são de preenchimento obrigatórios.

Image Removed
Aba Reconhecimentos de Saberes
Os seguintes parâmetros serão utilizados nos processos de alteração de matrícula. Essa parametrização deve ser realizada por nível de ensino.

Token para WS: Este parâmetro será utilizado para uma autenticação que será realizada com um Web Service.

Status de reconhecimento de saberes: Este parâmetro será utilizado para identificar as disciplinas em Reconhecimento de Saberes. Colocar o status de matricula igual a "Reconhecimento de Saberes".

Status de competências reconhecidas: Este parâmetro será utilizado para alterar as disciplinas certificadas no Reconhecimento de Saberes. Colocar o status de matricula igual a "Competência certificada".

Motivo de alteração situação de matrícula na competência reconhecida: Neste parâmetro deverá ser informado o motivo a ser utilizado ao alterar a situação de matrícula para aprovado automaticamente pelo processo.

Status de competência não reconhecidas: Este parâmetro será utilizado para alterar as disciplinas reprovadas no Reconhecimento de Saberes. Colocar o status de matricula igual a "Pre-Matricula".

Motivo de alteração situação de matrícula de competência não reconhecida: neste parâmetro deverá ser informado o motivo a ser utilizado para alterar a situação de matrícula para Pré-Matriculado automaticamente pelo processo.

Status de matrícula no período letivo: este parâmetro será utilizado para alterar o status da Matrícula no Período Letivo. Colocar o status de matricula igual a "Matriculado".

Motivo de alteração de situação de matriculado no período letivo: será o motivo para alterar a situação de matrícula automaticamente pelo processo.

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

title	Obrigatoriedade e verificação do campo e-mail para Alunos e Professores

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

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

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

Nome: Letícia Viana

CPF: 111.111.111-11”

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

Expandir

title	Parâmetros de customização integração

Pré-Requisitos / Parametrizações

Nenhum.

Descrição do Processo

Parametrização para configurar os dados da integração SGE – Módulo Educacional (Totvs) e Portal SESI Educação (EducarBrasil).

Detalhamento do Processo

No SGE – Módulo Educacional, por meio do menu customização, foi criada uma interface customizada por onde o usuário administrador poderá efetuar a parametrização da integração.
Esta parametrização é realizada por coligada (SESI – Departamento Regional) e nível de ensino do SGE – Módulo Educacional (Educação Básica) e as informações preenchidas são armazenadas em tabela customizada.

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

Aba Identificação

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

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;

ATENÇÃO: Esse parâmetro deve estar desmarcado para a execução do processo de carga inicial. Após isso ele deve ser marcado para possibilitar a integração síncrona.

Dados de acesso ao webservice disponibilizado pela EducarBrasil:

Caminho do WebService: parâmetro onde deve ser informado o endereço de acesso ao webservice de integração disponibilizado pela EducarBrasil;

Usuário: parâmetro onde deve ser informado o usuário do Portal SESI Educação (EducarBrasil) para o consumo do webservice;

Token: parâmetro do tipo texto que representa uma chave de verificação para o consumo do webservice;

Utilizar data referência/corte: parâmetro que representa um indicativo se a integração, na recuperação dos registros, utilizará uma data mínima como referência, isto é, apenas registros incluídos/alterados após tal data serão considerados na integração.

Caso tal parâmetro não seja marcado então todos os registros da entidade serão considerados na integração;

Data referência: parâmetro que aceitará apenas valores do tipo data e onde deve ser informado com data de referência (ou de corte) a ser utilizada para recuperação dos registros a serem considerados no processo de integração. Apenas registros incluídos/alterados cuja data seja igual ou posterior a tal data serão processados.

Este parâmetro é habilitado apenas se o parâmetro "Utilizar data referência" estiver marcado.

Caso o parâmetro "Utilizar data referência" estiver marcado então este campo será obrigatório;

Data da última execução do processo (data da última integração): As integrações podem ser realizadas por cadastros separadamente, então apresentaremos, apenas para visualização (somente leitura), as datas em que ocorreu a última integração de acordo com o cadastro.

Caso o parâmetro "Integração habilitada" esteja marcado (integração ativa) então os parâmetros "Caminho do WebService", "Usuário" e "Token" são de preenchimento obrigatórios.

Image Added

Aba Reconhecimentos de Saberes

Os seguintes parâmetros são utilizados nos processos de alteração de matrícula. Essa parametrização deve ser realizada por nível de ensino.

Token para WS: utilizado para uma autenticação que será realizada com um Web Service.

Status de reconhecimento de saberes: utilizado para identificar as disciplinas em Reconhecimento de Saberes. Colocar o status de matricula igual a "Reconhecimento de Saberes".

Status de competências reconhecidas: utilizado para alterar as disciplinas certificadas no Reconhecimento de Saberes. Colocar o status de matricula igual a "Competência certificada".

Motivo de alteração situação de matrícula na competência reconhecida: informar o motivo a ser utilizado ao alterar a situação de matrícula para aprovado automaticamente pelo processo.

Status de competência não reconhecidas: utilizado para alterar as disciplinas reprovadas no Reconhecimento de Saberes. Colocar o status de matricula igual a "Pre-Matricula".

Motivo de alteração situação de matrícula de competência não reconhecida: informar o motivo a ser utilizado para alterar a situação de matrícula para Pré-Matriculado automaticamente pelo processo.

Status de matrícula no período letivo: utilizado para alterar o status da Matrícula no Período Letivo. Colocar o status de matricula igual a "Matriculado".

Motivo de alteração de situação de matriculado no período letivo: informar o motivo para alterar a situação de matrícula automaticamente pelo processo.

Image Added

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.

Image Added

Aba Situações de matrículas

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.

Image Added

Observação: Todas as Situações de Matrícula parametrizadas no SGE – Módulo Educacional com permissão de acesso ao Portal SGE Educacional, devem ser configuradas como "Ativo".

Além dos cadastros da tela de parametrização, será necessário ativar o Campo Complementar TURMASESIEDUCACAO no cadastro de turmas a ser preenchido via tabela dinâmica TURMASSESI.

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

Campo complementar de Turma:

Nome da Coluna: TURMASESIEDUCACAO
Image Added

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

Os itens dessa tabela dinâmica devem

Image RemovedAba Situações de matrículas
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, disponibilizamos 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.
O usuário selecionará/informará a situação de matrícula e marcará o status desta para o Portal SESI Educação podendo marcar uma entre três opções Ativo, Inativo e Excluído. Este mapeamento deverá ser realizado para todas as situações de matrícula do SGE – Módulo Educacional.

Image Removed
Observação: Todas as Situações de Matrícula parametrizadas no SGE – Módulo Educacional com permissão de acesso ao Portal SGE Educacional, devem ser configuradas como "Ativo". Além dos cadastros da tela de parametrização, será necessário ativar o Campo Complementar TURMASESIEDUCACAO no cadastro de turmas a ser preenchido via tabela dinâmica TURMASSESI.

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

Campo complementar de Turma:
Nome da Coluna: TURMASESIEDUCACAO

Image Removed
Esse campo complementar deverá fazer uso de uma tabela dinâmica:

Image RemovedOs itens dessa tabela dinâmica deverão

ser cadastrados conforme regra do cliente de acordo com o documento disponibilizado pela EducarBrasil.

Image Modified

Este campo

deverá

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.

Image Modified

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.

Image Modified

anchor

Expandir

DeParaGeralDeParaGeral Âncora_Toc526258659_Toc526258659

title

Cadastro DE/PARA para integração

Pré-Requisitos / Parametrizações

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

necessário criar

criada uma funcionalidade que permite o mapeamento e equivalência dos valores do SGE – Módulo Educacional para os valores utilizados pelo Portal SESI Educação.

Esta funcionalidade será denominada

A funcionalidade

'Cadastro de DE/PARA'

e está sendo

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

Descrição

Detalhamento do Processo

Os cadastros que necessitam de uma DE/PARA são: 'Segmento/Nível de Ensino' do Portal SESI Educação, que no

Acesse o SGE – Módulo Educacional

é interpretado como 'Curso', e o cadastro de 'Disciplinas'.
A interface de edição contará com os seguintes controles:

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

A consistência deste cadastro será a obrigatoriedade de preenchimento dos três campos.

Detalhamento do Processo

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

Image RemovedAtravés desse módulo o usuário poderá realizar o cadastro de De/PARA. Ao incluir um novo registro será exibida uma tela contendo os três campos para identificação.

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

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

Image Added

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

Image Added.

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

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

os cursos disponíveis;

Disciplina: serão exibidos no campo "Valor do SGE – Módulo Educacional" as disciplinas disponíveis;

Habilitação/Série: serão exibidos no campo "Valor do SGE – Módulo Educacional"

as habilitações disponíveis.
Área - Grupo de Complemento:

serão

são exibidos no campo "Valor do SGE – Módulo Educacional" aos grupos de complemento disponíveis.

No campo "Valor no Portal SESI Educação"

deverá

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

ÂncoraDeParaSegmentosDeParaSegmentosPara Segmento:

Para Segmento:

Chart from Table

id	1586291586725_-1757961241

Image Added

Image Removed

Imagem ilustrativa: Os valores corretos devem ser verificados no manual da EducarBrasil

Então

para

um De/Para

será

é cadastrado:
Image Modified

Âncora

	DeParaHabilitacao
	DeParaHabilitacao

Para Habilitação/Série:

Image Removed

Image Added

Imagem ilustrativa: Os valores corretos devem ser verificados no manual da EducarBrasil

ATENÇÃO: O cadastro dos códigos digitáveis devem ser digitados exatamente iguais aos códigos das tabelas de códigos válidos, considerando assim maiúsculas/minúsculas e caracteres especiais.

Então

para

um De/Para

será

é cadastrado:
Image Modified

ÂncoraDeParaDisciplinasDeParaDisciplinas

Para Disciplinas:

Image Modified

Imagem ilustrativa: Os valores corretos devem ser verificados no manual da EducarBrasil

Importante:

É necessário incluir

Para as disciplinas de EJA Pro e Nova EJA

no

e Novo Ensino Médio o cadastro de De-Para

com as disciplinas semelhantes da tabela informada pela

deve ser realizado para entidade "Área - Grupo de Complemento" como informado pela tabela do Educar Brasil.

Importante: O valor do código para as disciplinas de Educação Continuada será sempre o mesmo.

Então

para

um De/Para

será

é cadastrado:
Image Modified

Para Área - Grupo de Complemento:

Image Removed

Image Added
Imagem ilustrativa: Os valores corretos devem ser verificados no manual da EducarBrasil

Então

para

um De/Para

será

é Cadastrado:

Image Modified

anchor

Expandir

IntegracaoAlunoIntegracaoAluno Âncora_Toc526258660_Toc526258660

title

Integração de alunos (e responsáveis acadêmicos dos alunos)

Pré-Requisitos / Parametrizações

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

Campo	Localização
Regional	Cadastro de Coligada: GCOLIGADA.ESTADO

Inep

Código Integrador	Cadastro de Filial / Dados para o MEC: SFILIALMEC.CODINEPESCOLA
Nome	PPESSOA.NOME - Caso o PPESSOA.NOMESOCIAL esteja preenchido ele substitui o nome juntando com o sobrenome da pessoa (PPESSOA.SOBRENOME)
CPF	PPESSOA.CPF

Código Externo

PPESSOA.CODUSUARIO


Sexo	PPESSOA.SEXO
Nascimento	PPESSOA.DTNASCIMENTO
Turno	Matriz Aplicada (SHABILITACAOFILIAL.CODTURNO)
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

CPF

Email
Código Externo
Senha

Caso o aluno seja menor de 18 anos e o segmento exija deve ser enviado.
SALUNO.CODPESSOARACA => PPESSOA.NOME
SALUNO.CODPESSOARACA => PPESSOA

.CPF
SALUNO

.

CODPESSOARACA => PPESSOA.

EMAIL
SALUNO.CODPESSOARACA => PPESSOA.SENHA
Obrigatória na inclusão

Descrição do Processo

Foi desenvolvido uma funcionalidade

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

Descrição do Processo

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

Detalhamento do Processo

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

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

Premissas para o valor da turma do aluno a ser integrada
O valor da turma a ser integrado do SGE – Módulo

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

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

Premissas para o valor da turma do aluno a ser integrada

O valor da turma a ser integrado do SGE – Módulo Educacional para o Portal SESI Educação

será

é dado através do uso de tabela dinâmica X campo complementar na turma então

será

é necessário a criação de uma tabela dinâmica que conterá os identificadores de turmas e um campo complementar na turma para indicar qual o valor a ser enviado à integração.

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

Importante: Ao instalar a customização no ambiente de produção

será

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

ÂncoraIntegracaoProfIntegracaoProf Âncora_Toc526258661_Toc526258661

Expandir

title

Integração de professores (e disciplinas)

Pré-Requisitos / Parametrizações

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

Descrição do Processo

Foi desenvolvido uma funcionalidade

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

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

Campo	Localização
Regional	Cadastro de Coligada: GCOLIGADA.ESTADO

Inep

Código Integrador

Cadastro de Filial / Dados

para o MEC: SINSTITUICAOMEC.CODINEPINSTITUICAO

Adicionais: DFILIAL.CAMPOLIVRE1
Nome	PPESSOA.NOME
Código Externo	PPESSOA.CODUSUARIO
Sexo	PPESSOA.SEXO
Nascimento	PPESSOA.DTNASCIMENTO
Email	PPESSOA.EMAIL
CPF	PPESSOA.CPF
Senha	Obrigatória na inclusão

Detalhamento do Processo

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

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

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

será

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

ÂncoraIntegracaoFuncIntegracaoFunc Âncora_Toc526258662_Toc526258662

Expandir

title

Integração de funcionários (Diretor, Secretários, Orientador Pedagógico e Coordenador)

Pré-Requisitos / Parametrizações

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

Descrição

Dscrição do Processo

Foi desenvolvido uma funcionalidade

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

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

Campo	Localização
Regional	Cadastro de Coligada: GCOLIGADA.ESTADO
Inep	Cadastro de Filial / Dados para o MEC: SINSTITUICAOMEC.CODINEPINSTITUICAO
Nome	PPESSOA.NOME
Código Externo	PPESSOA.CODUSUARIO
Sexo	PPESSOA.SEXO
Nascimento	PPESSOA.DTNASCIMENTO
Email	PPESSOA.EMAIL
CPF	PPESSOA.CPF
Senha	Obrigatória na inclusão

Detalhamento do Processo

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

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

Image Modified

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

Image Modified

Os campos obrigatórios, parametrizações e e-mail

serão

são validados e, se estiverem corretos,

serão

são o enviados para o Portal EducarBrasil, e seu retorno será gravado na tabela de Log.

anchor

Expandir

_Toc526258663

title

_Toc526258663

Processo alteração de senha usuário SGE – Módulo Educacional

Pré-Requisitos / Parametrizações

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

Descrição do Processo

Foi desenvolvido um processo

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

Detalhamento do Processo

O Registro dos usuários são criados apenas no SGE e ao realizar uma alteração nos dados eles

devem ser

são enviados ao Portal SESI Educação, no modelo síncrono, afim de manter os dados dos dois sistemas sincronizados.

A funcionalidade é acionada no SGE a partir da alteração dos dados do usuário no cadastro de Usuários, no "Trocar Senha" da aba ambiente e no trocar senha por meio do Portal SGE. A customização

irá interceptar

intercepta a alteração,

irá verificar

verifica a entidade que pertence o registro

e irá realizar

e realiza o processo de integração das informações. Ao final, um Log

será

é inserido na tabela customizada informando o status da operação.

Observação: Caso ocorra um erro durante a integração, um registro

será

é inserido no Log e o cadastro/alteração de senha do RM

ocorrerá

ocorre normalmente, sem que qualquer mensagem de erro seja exibida

ao usuário

.

anchor

Expandir

_Toc526258664

title

_Toc526258664

JobServer de integração (exportação)

Pré-Requisitos / Parametrizações

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

Descrição do Processo

Foi desenvolvido um processo

Processo customizado que

realizará

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

Detalhamento do Processo

Foi criado um processo customizado no SGE – Módulo Educacional para realizar a integração entre o SGE e o Portal SESI Educação. O processo

poderá

pode ser acionado via menu ou agendado para executar com periodicidade definida.

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

Conforme imagem abaixo:

Image Modified

anchor

Expandir

_Toc526258665

title

_Toc526258665

Log Customizado

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

Para cada registro exportado,

será

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

Image Modified

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

Observação: Todos os dados

serão

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

O log

será

é apresentado ao usuário logado com base no seu acesso a filiais

(SUSUARIOFILIAL)

, assim o mesmo só terá acesso aos logs das filiais em que tiver acesso.

anchor

Expandir

_Toc526258666

title

_Toc526258666

Processo de reenvio de dados

Pré-Requisitos / Parametrizações

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

Descrição do Processo

Foi desenvolvido um processo

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

Detalhamento do Processo

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

Os registros que foram exportados e geraram erros

poderão

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

será

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

Âncora_Toc526258667

Expandir

title

_Toc526258667

	WebMethod integração usuário

Pré-Requisitos / Parametrizações

Nenhum.

Descrição do Processo

Foi desenvolvido um

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

Detalhamento do Processo

A partir do WebService desenvolvido, foi publicado um WebMethod para permitir a integração de usuários. O método possui a seguinte assinatura:
public ResponseDataType IntegraUsuario(UserDataType userData)

O objeto de retorno possui as seguintes propriedades:
public class ResponseDataType
{
public string CodUsuario;
public int ErrorCode;
public bool Success;
public string Message;
}Sendo ErrorCode um código referente a algum erro que possa acontecer durante a integração. Virá como 0 (zero) em caso de sucesso. O booleano Sucess indica se ocorreu sucesso ou não na integração e o Message informa uma mensagem referente a algum possível erro, vindo vazio se tudo ocorrer corretamente.

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

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

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

Envio da requisição via Postman:

Image Added

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

Image Added

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

Image Added

O objeto UserDataType possui os seguintes parâmetros, que são os dados para a integração em si:
public class UserDataType
{
public string CodigoUsuario;
public string NovaSenha;
public string Email;
}O código do usuário que irá ser integrado, a nova senha e o Email.
Observação: A senha deve trafegar em Base64.

Token de Segurança
Para que seja possível efetivar as requisições no WebService customizado, é preciso informar um usuário e senha válidos para realizar o login no SGE. Novamente, a senha deve estar na codificação encode/Base64.
Exemplo da configuração da requisição no SoapUI:

Image RemovedExemplo de resposta de uma requisição processada com sucesso:

Image RemovedExemplo de erro da requisição de validação de E-mail:

Image Removed

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

Âncora_Toc526258668

Expandir

title

_Toc526258668

	Auto login Portal SGE

Pré-Requisitos / Parametrizações

Nenhum.

Descrição do Processo

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

Detalhamento do Processo

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

O serviço de auto-login (ou login automático) no Portal SGE se

baseará

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

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

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

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

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

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

Âncora_Toc526258669_Toc526258669

Cloak

Importação de E-mails (Base do Portal SESI Educação)

Pré-Requisitos / Parametrizações

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

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

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

identificar

identifica-se o registro da "pessoa" equivalente no SGE Módulo Educacional e

atualizar

apenas o campo e-mail do registro é atualizado.

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

Descrição do Processo

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

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

Detalhamento do Processo

Usuário acessa

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

Image RemovedO usuário deverá informar

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

Na máquina onde RM.Exe está instalado e é realizado o

usuário realizará o

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

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

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

Image Removed

Neste caso o sistema localizará na base de dados uma pessoa com o mesmo CPF informado na planilha e alterará seu email no cadastro de Pessoa do SGE.
Para alteração de

email

e-mail de Aluno com base no CPF do seu Responsável Acadêmico, deverá ser utilizada uma planilha contendo três colunas: Uma para o

email

e-mail, outra para o nome do aluno e outra para o CPF do responsável Acadêmico.
Exemplo:

Image Removed

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

Image Removed

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

Image Removed

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

Image Removed

Expandir

title

Âncora_Toc526258670_Toc526258670

	Integração síncrona de alunos, professores e funcionários

Pré-Requisitos / Parametrizações

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

Descrição do Processo

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

Detalhamento do Processo

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

Currículo e Oferta | Aluno | <processo> Matricular aluno;
Currículo e Oferta | Aluno | <anexo> Matriculas no Período letivo | <processo> Alterar situação de matrícula;
Currículo e Oferta | Aluno | <anexo> Matriculas no Período letivo | <processo> Matricular aluno nas disciplinas;
Currículo e Oferta | Aluno | <anexo> Matriculas isolada | <processo>

Matricular aluno

> Alterar situação de matrícula;

Currículo

Matrícula e

Oferta

Avaliação |

Aluno

Matrículas | <anexo>

Matriculas no Período letivo

Matrículas em disciplinas | <processo> Alterar situação de matrícula;

Currículo

Matrícula e

Oferta

Avaliação |

Aluno | <anexo> Matriculas no Período letivo

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;

Currículo e Oferta | Aluno | <anexo> Matriculas

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ículas | <anexo> Matrículas em disciplinas

Matrícula | <processo>

Alterar situação de matrícula

Rematrícula;
Matrícula e Avaliação |

Matrículas | <anexo> Matrículas em turma mista

Matrícula | Mais | <processo>

Alterar situação

Confirmação de matrícula por pagamento;
Matrícula e Avaliação | Matrícula |

Matrículas | <processo> Alterar situação de matrícula;

Matrícula e Avaliação | Matrícula | Matrículas | <processo> Matricular aluno nas disciplinas;

Matrícula e Avaliação | Matrícula | Matrículas | <processo> Confirmação de matrícula por pagamento;

Matrícula e Avaliação | Matrícula | Matrícula isolada | <processo> Alterar situação de matrícula;

Matrícula e Avaliação | Matrícula | <processo> Rematrícula;

Matrícula e Avaliação | Matrícula | Mais | <processo> Confirmação de matrícula por pagamento;

Matrícula e Avaliação | Matrícula | Mais | <processo> Matricula de disciplinas em lote;

Matrícula on-line;

Cadastro de pessoas;

Cadastro do aluno;

Cadastro de matrículas;

Estrutura Curricula | Matriz Curricular | Matriz Aplicada | Comissão Coordenadora;

Cadastro de Filial | Dados Educacionais | Diretores por Filial;

Curriculo e Oferta | Professores;

Curriculo e Oferta | Oferta | Turma Disciplina | Professores.

Mais | <processo> Matricula de disciplinas em lote;
Matrícula on-line;
Cadastro de pessoas;
Cadastro do aluno;
Cadastro de matrículas;
Estrutura Curricula | Matriz Curricular | Matriz Aplicada | Comissão Coordenadora;
Cadastro de Filial | Dados Educacionais | Diretores por Filial;
Curriculo e Oferta | Professores;
Curriculo e Oferta | Oferta | Turma Disciplina | Professores.

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

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

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

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

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

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

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

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

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

Expandir

title	Integração de Reconhecimento de Saberes via Web Service

Pré-Requisitos / Parametrizações

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

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

Descrição do Processo

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

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

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

Detalhamento do Processo

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

Os dados trafegados são:

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

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

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

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

Código	Status
MAT-C1	1
MAT-C2	0
MAT-C3	1
MAT-C4	1
CNT-C1	0
CHT-C1	1

Image Added

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

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

O log do processo pode ser consultado na tabela ZLOGRECSABERPORTAL.

Expandir

title	WebMethod Alteração de Senha Usuário

Pré-Requisitos / Parametrizações

Nenhum.

Descrição do Processo

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

Detalhamento do Processo

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

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

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

Envio da requisição via Postman:

Image Added

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:

Image Added

Expandir

title	Referência Dados - Educar Brasil

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

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

MANUAL_WEBSERVICE_SESI_SGE_2019_1_5.pdf

Serão integrados apenas os registros cujo curso/segmento, do contexto do processo e/ou do aluno que se está alterando, seja um dos parametrizados para a integração e apenas os registros cuja situação de matrícula, do contexto do processo e/ou do aluno que se está alterando, seja um dos parametrizados em "situações de matrícula" para a integração.As rotinas de envio, antes de acionar as rotinas de integração, conterão tratamentos de validação do campo e-mail e responsável acadêmico:

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

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

Após as consistências mencionadas acima, as rotinas do plug-in se encarregarão de identificar a chave primária dos registros que estão sendo processados/alterados (no caso de processos pode ser mais de um aluno ao mesmo tempo) e acionar as rotinas de integração fornecendo a estas tais chaves primárias.As regras da integração de alunos (recuperação de valores, mapeamento de campos, validações, etc.) são as mesmas detalhadas na integração de alunos. Neste caso elas receberão as chaves primárias dos alunos e a recuperação dos dados e integração ocorrerá apenas para os alunos representados por estas chaves. A integração com o Portal SESI Educação ocorrerá e seus retornos (sucesso ou falha) serão retornados ao plug-in que acionou a integração.Após o processamento das integrações, com o retorno em mãos, o plug-in avaliará os status de retorno para cada registro (aluno) e montará uma mensagem a ser gravada na tabela de LOG com as informações de aluno, status da integração e, em caso de erros, a mensagem de erro.Caso ocorra algum erro na integração o processo nativo não será interrompido, porém o erro da integração constará em log, nesse caso não será realizada a integração do SGE com o Portal SESI Educação.Para exportação dos dados Funcionários e Professores, serão exportados apenas os cadastros que possuírem usuário associado e que atendam as regras de validação de campos obrigatórios. Âncora_Toc526258671_Toc526258671Integração de Reconhecimento de Saberes via Web Service

Pré-Requisitos / Parametrizações

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

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

Descrição do Processo

O Portal SESI acionará 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 identificará para o CPF enviado a Matrícula do Período Letivo do aluno com status Reconhecimento de Saberes. O status Reconhecimento de Saberes será determinado pela informação contida no campo Status de Reconhecimento de Saberes dos parâmetros customizados.

Em seguida, para cada código de Competência (Disciplina) enviada a customização realizará a alteração do status de matrícula de acordo com a parametrização definida pelo Regional.Caso ocorra erro na modificação do status de qualquer competência (disciplina) de um Aluno a customização não concluirá a alteração do status para todas as demais competências (disciplinas) do Aluno, bem como também não alterará a situação de matrícula no período letivo.
OBSERVAÇÃO: Detalhes técnicos para o correto funcionamento do Web Service podem ser consultados no documento "Manual de Customização RM - WEB API - FS007972".

Detalhamento do Processo

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

CPF;

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

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

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

Exemplo:
CPF: 012.345.678-90
Lista de Competências (disciplinas):

Código

Status

MAT-C1

1

MAT-C2

0

MAT-C3

1

MAT-C4

1

CNT-C1

0

CHT-C1

1

Image Removed

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

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

O log do processo pode ser consultado na tabela ZLOGRECSABERPORTAL. Âncora_Toc526258672_Toc526258672Histórico de Atualização do DocumentoHistórico de Versões

Cloak
Histórico de Atualização do Documento

Autor	Versão	Data	Descrição das alterações
Adilson José de Aquino Thiago Neiva Chagas	1.0	03/05/2016
Adilson José de Aquino	2.0	12/05/2016
Adilson José de Aquino	3.0	30/05/2016	Versão da Biblioteca
Adilson José de Aquino	4.0	08/06/2016	Versão da Biblioteca e ajustes solicitados
Adilson José de Aquino	5.0	09/06/2016	Ajustes solicitados
Adilson José de Aquino	6.0	15/06/2016	Versão da Biblioteca
Adilson José de Aquino	7.0	08/08/2016	Análise de impacto II
Gustavo Fonseca Nunes	8.0	25/04/2018	Ajustes dos arquivos
Pedro Antonio Silva Barroso	9.0	22/05/2018	Ajustes de acordo com as modificações do Rollaout 14/05/2018
Gustavo Fonseca Nunes	10.0	17/07/2018	Ajuste do campo CPF do Aluno que será enviado ao Portal SESI. Atualização das imagens do De-Para da integração e orientação para consultar a documentação da EducarBrasil.
Ana Luiza Martins Moreira Pedro Marcus Paixão Silva	11.0	17/09/2018	Incluindo Req 01 e 02 da especificação FS007972 (976970) - Reconhecimento de saberes.
Pedro Antonio Silva Barroso	12.0	27/09/2018	Formatação do documento para novo padrão FSW
Ana Luiza Martins Moreira	13.0	21/10/2019	Atualização da formatação do documento
Jéssica Gonçalves Silva	14.0	07/04/2020	Atualização nas tabelas de/para de acordo com o manual disponibilizado pela Educar Brasil.
Thiago Neiva Chagas	15.0	04/03/2021	Incluído WebMethod de alteração de senha dos usuários

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 18

Nova versão Atual

Chave

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

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Detalhamento do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Dscrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Pré-Requisitos / Parametrizações

Descrição do Processo

Detalhamento do Processo

Autor

Versão

Data

Descrição das alterações