...
Expandir |
---|
title | Parâmetros da Integração |
---|
|
Table Excerpt |
---|
| 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
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 |
---|
| Card |
---|
| Table Excerpt |
---|
name | parametrosidentificacao |
---|
| Nesta aba, são configurados os campos básicos para o funcionamento da integração.
|
|
Card |
---|
label | Reconhecimento de Saberes |
---|
| Table Excerpt |
---|
| Nesta aba, são configurados os campos referentes ao Reconhecimento de Saberes.
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. É 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, ao alterar a situação de matrícula para situação Competência Reconhecida automaticamente pelo processo.
- Competências não reconhecidas: Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes
- 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 pelo processo.
- Matricula no período letivo: Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
- Motivo de alteração: Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.
|
|
Card |
---|
| Table Excerpt |
---|
| Nesta aba deverá ser 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.
|
|
Card |
---|
label | Situações de Matrícula |
---|
| Table Excerpt |
---|
| Para integração dos alunos no Portal SESI, o status do aluno é definido de acordo com 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.
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: 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.
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:
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:
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. Se o usuário do aluno estiver Inativo, o processo customizado já envia para o Portal SESI como Inativo. |
|
|
Card |
---|
| 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. 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.
|
|
Card |
---|
| 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
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.
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 |
---|
| Table Excerpt |
---|
| 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
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. |
|
|
|
|
Informações |
---|
|
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çãoParâmetro que indica se a integração será realizada ou não
O processo de integração pode estar agendado, mas a integração apenas irá ocorrer se este parâmetro estiver marcado. Tal parâmetro é valido para os registros de Alunos, Responsáveis Acadêmico, Professores, Diretor(es), Secretário(s), Coordenador(es) e Orientador Pedagógico para que seja realizada a integração de usuários para o Portal SESI Educação.
Dados de Integração- 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- 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 SaberesTokenEste 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.
À ReconhecerUtilizado 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 pelo processo.
Competência não Reconhecida- Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes;
- Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação ¹Competência não Reconhecida automaticamente pelo processo.
Matrícula no Período Letivo- Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
- Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.
false Aba Cursos (Segmentos)Um cadastro onde deverá ser relacionado (informado/cadastrado) os cursos do SGE – Módulo Educacional (segmentos de ensino da Educação Básica indicadas no Portal SESI Educação (Educar Brasil)) para os quais somente alunos e professores/disciplinas de tais cursos serão integrados. Junto a informação de cada curso deverá ser sinalizado se o e-mail do aluno (matriculado em tal curso) deverá ser obrigatório e também se alunos menores de 18 (dezoito) anos (matriculado em tal curso) deverão ter um responsável acadêmico informado.
false Aba Situações de MatrículaNo Portal SESI Educação os registros contêm uma propriedade indicando o status dos registros que poderá ser: Ativo, Inativo ou Excluído. Para a integração de alunos este status será definido de acordo com a situação de matrícula do aluno. Como no SGE – Módulo Educacional as situações de matrículas são a partir de um cadastro (existem situações que não se pode alterar, mas é possível cadastrar novas) então é necessário definir o significado de cada situação de matrícula.
Em vista disto, neste módulo de parametrização, há um cadastro onde é possível efetuar o mapeamento entre as diversas situações de matrículas do SGE – Módulo Educacional e o que ela representará para o Portal SESI Educação no momento da integração.
É permitida a seleção da situação de matrícula e do status desta para o Portal SESI Educação podendo marcar uma entre três opções Ativo, Inativo e Excluído. Este mapeamento é realizado para todas as situações de matrícula do SGE – Módulo Educacional.
[Novo!]
Se o checkbox "Não enviar ao Portal SESI" estiver marcado as matrículas com tal situação serão desprezadas para a integração.
Importante : Se o usuário do aluno estiver Ativo, o processo customizado irá pegar a informação do DE/PARA da situação de matrícula na parametrização do Portal SESI.
Se o usuário do aluno estiver Inativo, o processo customizado já envia para o Portal SESI como Excluído.
false Aba Validação de Email [Novo!]- Endereço de acesso à API para consulta de e-mail, disponibilizado pela Educar Brasil;
- Token de acesso à API para consulta de e-mail, disponibilizado pela Educar Brasil.
false Aba Funcionários [Novo!]Na integração de Funcionários ao Portal SESI Educação os registros contêm uma propriedade indicando o perfil do funcionário, por padrão é enviado o perfil "FUNCIONARIO" que equivale ao Funcionário Administrativo do Portal SESI Educação. Caso o perfil do Funcionário não deva ser Funcionário Administrativo, deve ser utilizado este cadastro para selecionar outro perfil [Funcionário Pedagógico e Administrador de Unidade].
Em vista disto, neste cadastro devem ser preenchidos os campos conforme a sua funcionalidade:
- 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.
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.
Informações |
---|
|
Campos Complementares Cloak |
TURMASESIEDUCACAOA 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 – SGONo 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 - Informações |
---|
|
De | Para Cloak |
---|
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 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
'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, 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).
falseAcessando...Deve ser selecionado o tipo de Entidade (Cadastro), que pode ser:
Curso/SegmentoNesta 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).
DisciplinaNesta 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érieNesta 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 ComplementoNesta 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 |
---|
|
Validações Cadastrais [Novo!] Cloak |
false Caracteres especiais Turma SESI EducaçãoAo 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êmicoAo enviar o Aluno ao Portal SESI Educação, são realizadas as seguintes validações:
- 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;
- 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 |
---|
|
Integrações Cloak |
falseAlunos (e seus respectivos responsáveis acadêmicos)Pré-Requisitos / Parametrizações
- Realizar a parametrização da Integração e preenchimento De/Para;
- 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)
}
Nome | Campo | Origem | Observações |
---|
Identificador SGE | AlunoSGE.idred | "7" | Enviado de forma fixa o valor '7' |
Regional | AlunoSGE.regional | GCOLIGADA.ESTADO | Estado do cadastro da Coligada |
Código Integrador | AlunoSGE.inep | DFILIAL.CAMPOLIVRE1 | Cadastro de Filial: DFILIAL.CAMPOLIVRE1 |
Código Integrador | AlunoSGE.codigointegrador | DFILIAL.CAMPOLIVRE1 | Cadastro de Filial: DFILIAL.CAMPOLIVRE1 |
Curso | AlunoSGE.curso|string | SCURSO.CODCURSO | De/Para de Curso correspondente ao Campo caso o AlunoSGE.segmento seja 17 ou 18 |
Perfil | AlunoSGE.perfil | "ESTUDANTE" | Enviado de forma fixa o valor 'ESTUDANTE' |
Nome | AlunoSGE.nome | PPESSOA.NOME | PPESSOA.NOMESOCIAL + PPESSOA.SOBRENOME | Nome do Aluno - Caso o PPESSOA.NOMESOCIAL esteja preenchido ele substitui o nome juntando com o sobrenome da pessoa (PPESSOA.SOBRENOME) |
Código Externo | AlunoSGE.codigoexterno | PPESSOA.CODUSUARIO | Código do Usuário do Aluno |
Senha do Usuário | AlunoSGE.user_sen | Senha do Usuário | Senha do Usuário do Aluno |
Sexo | AlunoSGE.sexo | PPESSOA.SEXO | Correspondendo à 'feminino' | 'masculino' |
Data de Nascimento | AlunoSGE.nasc | PPESSOA.DTNASCIMENTO | Data de nascimento do Aluno |
Turno | AlunoSGE.turno | SHABILITACAOFILIAL.CODTURNO | Correspondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral' |
Segmento | AlunoSGE.segmento | SHABILITACAOFILIAL.CODCURSO | De/Para de Segmento correspondente ao Campo |
Série | AlunoSGE.serie | SHABILITACAOFILIAL.CODHABILITACAO | De/Para de Serie correspondente ao Campo |
Turma | AlunoSGE.turma | STURMA.CODTURMA | STURMACOMPL.TURMASESIEDUCACAO | A prioridade é do campo TURMASESIEDUCACAO quando preenchido |
Nome do Responsável | AlunoSGE.respon_nome | PPESSOA.NOME | Nome do Responsável Acadêmico |
CPF do Responsável | AlunoSGE.respon_cpf | PPESSOA.CPF | CPF do Responsável Acadêmico |
E-mail do Responsável | AlunoSGE.respon_email | PPESSOA.EMAIL | E-mail do Responsável Acadêmico |
Código do Usuário do Responsável | AlunoSGE.respon_ra | PPESSOA.CODUSUARIO | Código do Usuário do Responsável Acadêmico |
Senha do Usuário | AlunoSGE.respon_sen | Senha do Usuário | Senha do Usuário do Responsável Acadêmico |
Status | AlunoSGE.status | SMATRICPL.CODSTATUS | Caso o GUSUARIO.STATUS for ativo, identificamos de acordo com os parâmetros de Situação de Matrícula correspondendo à Ativo | Inativo | Excluído Senão enviamos Excluído |
CPF do Aluno | AlunoSGE.cpf | PPESSOA.CPF | CPF do Aluno |
E-mail do Aluno | AlunoSGE.email | PPESSOA.EMAIL | Caso o e-mail O365 (SALUNOCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado. |
E-mail complementar do Aluno | AlunoSGE.emailcomplementar | SALUNOCOMPL.EMAILO365 | Caso o email O365 (SALUNOCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado como email complementar, do contrário nenhum email é enviado como complementar. |
Área do Itinerário | AlunoItinerario.area | SHABILITACAOFILIAL.CODCURSO | Caso o aluno esteja matriculado em um Itinerário: De/Para de Área correspondente ao Campo |
Itinerário | AlunoItinerario.itinerario | SMATRICPLITINERARIOFORMATIVO.CODITINERARIOFORMATIVO | Caso o aluno esteja matriculado em um Itinerário: De/Para de Itinerário correspondente ao Campo |
A prioridade de envio do código da turma para o Portal SESI sempre é o campo complementar “Turma Sesi Educação”. Apenas quando ele não está preenchido a customização envia o Código da Turma (SMATRICPL.CODTURMA).
Detalhamento do Processo
A exportação de alunos possui a particularidade de exportar não apenas os dados básicos dos alunos, mas também outros dados, como curso (nível de ensino, segmento), turma, turno, série/habilitação (série) – e dados sobre seus responsáveis acadêmicos que estão vinculados ao cadastro do aluno.
Para que todos os dados possam ser integrados corretamente, é preciso realizar a parametrização do De/Para para cada um dos Cursos/Segmentos, Disciplinas e Séries/Habilitações, além de preencher em cada turma o campo complementar, conforme detalhado abaixo:Alteração na Integração de Aluno – Integrar somente Matrículas sem Resultado Final e de Períodos Letivos não encerrados
A integração de Aluno envia somente alunos com Matrículas (SMATRICPL) que ainda não possuem o Resultado Final (SMATRICPL.CODSTATUSRES) preenchido e que pertençam a Período Letivo (SPLETIVO) que não estão encerrados, desconsiderando os demais.
[Novo!]
Alteração na Integração de Aluno - Considerar Somente a matrícula mais recente (DTMATRICULA) de turma que já tenham iniciado
A Integração de Aluno considera somente a matrícula no Período Letivo mais recente, considerando assim a que tiver a maior Data de Matricula no período Letivo dentre os cursos parametrizados para integrar (em parâmetros Cursos/Segmentos) e que a turma já tenha iniciado (Data Inicial da turma menor ou igual hoje). Identificado a matrícula mais recente do Aluno, são verificadas as demais consistências para esta matrícula, bem como a verificação se a turma desta matrícula está vigente - Considerando como vigente a turma que a data corrente compreender entre a Data Inicial e Final da Turma.
[Novo!]
Alteração na Integração de Aluno - Desconsiderar matrículas com situação de matrícula indicada para "Não enviar ao Portal SESI"
A Integração de Aluno considera somente as matrículas cuja o status não corresponder a uma das situações de matrícula parametrizadas com o checkbox "Não enviar ao Portal SESI" marcado. De modo que se a matrícula mais recente for uma com uma destas situações de matrícula o sistema irá procurar a próxima mais recente para enviar ao Portal SESI.
Premissas para o valor da turma do aluno a ser integrada O valor da turma a ser integrado do SGE – Módulo Educacional para o Portal SESI Educação é dado através do uso de tabela dinâmica X campo complementar na turma então é necessário a criação de uma tabela dinâmica que conterá os identificadores de turmas e um campo complementar na turma para indicar qual o valor a ser enviado à integração.
Importante: Para que o aluno seja exportado o mesmo deve ter um usuário cadastrado no SGE.
Checklist do Aluno 1 incomplete O Curso da Matrícula do Aluno está parametrizado nos Cursos/Segmentos? 2 incomplete A Matrícula verificada é a mais recente? - Somente a matrícula mais recente em curso parametrizado é considerada para a integração. 3 incomplete O Aluno está ativo e possui cadastro de usuário? - O Usuário é necessário para a integração. 4 incomplete Desde a configuração da integração a senha do aluno já foi alterada ao menos uma vez? - É necessário para que a integração registre o usuário na tabela ZUSUARIOSGE 5 incomplete A turma está vigente? - Considerando como vigente a turma que a data corrente compreender entre a Data Inicial e Final da Turma. 6 incomplete O Período Letivo não está encerrado? - Períodos letivos encerrados não são enviados. 7 incomplete O Aluno não tem Situação de Resultado Final? - Somente alunos sem resultado são enviados. 8 incomplete O campo Obrigatório "CodInepInstituição" está preenchido? (Campo "CAMPOLIVRE1" do Anexo Dados Fiscais do cadastro de Filial não preenchido) 9 incomplete A Situação de Matrícula está parametrizada? - Parâmetro utilizado para definir o status correspondente que será enviado ao Portal SESI Educação. 10 incomplete O Email do Aluno está preenchido? - Obrigatório para integração. 11 incomplete Caso seja menor de 18 anos, o seu responsável acadêmico está preenchido? - E neste caso o usuário do responsável também deve estar presente na ZUSUARIOSGE, pois se torna obrigatório para a integração. Importante: Ao instalar a customização no ambiente de produção é necessário executar o processo de geração de usuário selecionando todos os alunos para que os mesmos realizem a troca de senhas ao fazer login no sistema.
falseProfessores (e suas aulas)Pré-Requisitos / Parametrizações
Realizar a parametrização da Integração e preenchimento De/Para;Para envio dos dados do professor enviamos ao PortalSESI um form-data que convertido em formato JSON são:DocenteSGE {
idred (string, obrigatório),
regional (string, obrigatório),
inep (string, obrigatório),
codigointegrador (string, opcional),
perfil (string, obrigatório),
codigoexterno (string, obrigatório),
cpf (string, opcional),
nome (string, obrigatório),
email (string, opcional),
emailcomplementar (string, opcional),
sexo (string, obrigatório),
nasc (DateTime, obrigatório),
status (string, obrigatório),
aulas (array[Aula], obrigatório),
user_sen (string, opcional)
}
Aula{
area (string, obrigatório),
segmento (string, obrigatório),
turno (string, obrigatório),
serie (string, obrigatório),
turma (string, obrigatório),
componente (string, obrigatório),
}
Nome | Campo | Origem | Observações |
---|
Identificador SGE | DocenteSGE.idred | "7" | Enviado de forma fixa o valor '7' |
Regional | DocenteSGE.regional | GCOLIGADA.ESTADO | Estado do cadastro da Coligada |
Código Integrador | DocenteSGE.inep | DFILIAL.CAMPOLIVRE1 | Cadastro de Filial: DFILIAL.CAMPOLIVRE1 |
Código Integrador | DocenteSGE.codigointegrador | DFILIAL.CAMPOLIVRE1 | Cadastro de Filial: DFILIAL.CAMPOLIVRE1 |
Perfil | DocenteSGE.perfil | "ESTUDANTE" | Enviado de forma fixa o valor 'DOCENTE' |
Nome | DocenteSGE.nome | PPESSOA.NOME | Nome do Professor |
Código Externo | DocenteSGE.codigoexterno | PPESSOA.CODUSUARIO | Código do Usuário do Professor |
Senha do Usuário | DocenteSGE.user_sen | Senha do Usuário | Senha do Usuário do Professor |
Sexo | DocenteSGE.sexo | PPESSOA.SEXO | Correspondendo à 'feminino' | 'masculino' |
Data de Nascimento | DocenteSGE.nasc | PPESSOA.DTNASCIMENTO | Data de nascimento do Professor |
Status | DocenteSGE.status | SMATRICPL.CODSTATUS | Caso o GUSUARIO.STATUS for ativo, enviamos Ativo Senão enviamos Excluído |
CPF do Professor | DocenteSGE.cpf | PPESSOA.CPF | CPF do Professor |
E-mail do Professor | DocenteSGE.email | PPESSOA.EMAIL | Caso o e-mail O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado. |
E-mail complementar do Professor | DocenteSGE.emailcomplementar | SALUNOCOMPL.EMAILO365 | Caso o email O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado como email complementar, do contrário nenhum email é enviado como complementar. |
Aulas | DocenteSGE.aulas | Turmas do Professor | Turma do professor (SMATRICPL.CODTURMA | STURMACOMPL.TURMASESIEDUCACAO), Curso da turma (SHABILITACAOFILIAL.CODCURSO | ZDEPARASEG.CODIGOPORTAL), Série da Turma (SHABILITACAOFILIAL.CODHABILITACAO | ZDEPARASERIE.CODIGOPORTAL), Turno da Turma (STURNO.TIPO | (Manhã;Tarde;Noite;Integral)), Área - Grupo de Complemento (SDISCGRADE.IDGRUPOCOMPLEMENTO | ZDEPARAAREA.CODIGOPORTAL), Disciplina/Componente (SDISCIPLINA.CODDISC | ZDEPARADISC.CODIGOPORTAL) como lista no formato JSON conforme a seguir: [{"turma":"A","segmento":"14","serie":"1","turno":"Tarde","area":"1","componente":"22"},{"turma":"A","segmento":"14","area":null,"componente":"33"},{"turma":"A","segmento":"14","serie":"1","turno":"Manhã","area":"1","componente":"4"}] Somente serão enviadas aulas de professores que atenderem aos critérios: - Estar vinculadas à uma turma que esteja com os campos data inicial e data final preenchidos (STURMA.DTINICIAL e STURMA.DTFINAL) e dentro do período vigente;
- Estar vinculadas à uma Turma/Disciplina que esteja com os campos data inicial e data final do período do professor preenchidos (SPROFESSORTURMA.DTINICIO e SPROFESSORTURMA.DTFINAL) e dentro do período vigente;
- Caso as datas de início e fim das Turmas e/ou período do professor na Turma/Disciplina, estejam em branco ou fora do período de vigência, não terão suas disciplinas exportadas.
|
Turma | Aula.turma | STURMA.CODTURMA | STURMACOMPL.TURMASESIEDUCACAO | A prioridade é do campo TURMASESIEDUCACAO quando preenchido |
Segmento | Aula.segmento | SHABILITACAOFILIAL.CODCURSO | De/Para de Segmento correspondente ao Campo |
Turno | Aula.turno | SHABILITACAOFILIAL.CODTURNO | Correspondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral' |
Série | Aula.serie | SHABILITACAOFILIAL.CODHABILITACAO | De/Para de Serie correspondente ao Campo |
Área | Aula.area | SDISCGRADE.IDGRUPOCOMPLEMENTO | De/Para de Área - Grupo de Complemento correspondente ao Campo |
Componente | Aula.componente | STURMADISC.CODDISC | De/Para de Disciplina/Componente correspondente ao Campo |
Detalhamento do Processo
A integração (ou exportação) de professores tem como base os registros de professores geridos pelo cadastro de professor "SGE – Módulo Educacional | Currículo e Oferta | Aluno e Professor | Professores" mantidos nas tabelas SPROFESSOR/PPESSOA (dados do professor e dados pessoais do professor) e, como é necessário exportar as disciplinas dos professores, um relacionamento é realizado através da funcionalidade "Turmas/Disciplinas do professor" (SGE – Módulo Educacional | Ofertas | Turmas/Disciplinas | <anexo> Professores) para recuperar suas disciplinas. Somente são exportados Professores cujas as Turmas pertençam a Períodos Letivos não encerrados.
Para a exportação ser efetivada é preciso realizar a parametrização da tabela De/Para, parametrizando obrigatoriamente os Cursos e Disciplinas vinculados ao cadastro dos professores.Os campos obrigatórios, parametrizações de/para e e-mail serão validados e, se estiverem corretos, serão enviados para o Portal SESI Educação, e seu retorno é gravado na tabela de Log.Caso ocorra algum erro durante a integração, este será gravado em log. Após alteração do registro do professor, para realizar nova integração deverá ser selecionado o log referente ao professor e executado o processo de reenvio de erro.Importante: Para que o professor seja exportado o mesmo deve ter um usuário cadastrado no SGE e estar dando aula em alguma Turma/Disciplina que tenha sido informado no cadastro De/Para para disciplinas.falseFuncionários (Diretor, Secretários, Orientador Pedagógico e Coordenadores)Pré-Requisitos / Parametrizações
Realizar a parametrização da Integração;Para envio dos dados do funcionário enviamos ao PortalSESI um form-data que convertido em formato JSON são:FuncionarioSGE {
idred (string, obrigatório),
regional (string, obrigatório),
inep (string, obrigatório),
codigointegrador (string, opcional),
perfil (string, obrigatório),
codigoexterno (string, obrigatório),
cpf (string, opcional),
nome (string, obrigatório),
email (string, obrigatório),
sexo (string, obrigatório),
nasc (DateTime, obrigatório),
status (string, obrigatório),
user_sen (string, opcional)
}
Nome | Campo | Origem | Observações |
---|
Identificador SGE | FuncionarioSGE.idred | "7" | Enviado de forma fixa o valor '7' |
Regional | FuncionarioSGE.regional | GCOLIGADA.ESTADO | Estado do cadastro da Coligada |
Código Integrador | FuncionarioSGE.inep | DFILIAL.CAMPOLIVRE1 | Cadastro de Filial: DFILIAL.CAMPOLIVRE1 |
Código Integrador | FuncionarioSGE.codigointegrador | DFILIAL.CAMPOLIVRE1 | Cadastro de Filial: DFILIAL.CAMPOLIVRE1 |
Perfil | FuncionarioSGE.perfil | Caso preenchido, é enviado o perfil parametrizado nos parâmetros de Funcionários (na parametrização da Integração Portal SESI Educação). Os Funcionários que não parametrizados são enviados com o perfil padrão (Funcionário Administrativo). | Nome | FuncionarioSGE.nome | PPESSOA.NOME | Nome do Funcionário |
Código Externo | FuncionarioSGE.codigoexterno | PPESSOA.CODUSUARIO | Código do Usuário do Funcionário |
Senha do Usuário | FuncionarioSGE.user_sen | Senha do Usuário | Senha do Usuário do Funcionário |
Sexo | FuncionarioSGE.sexo | PPESSOA.SEXO | Correspondendo à 'feminino' | 'masculino' |
Data de Nascimento | FuncionarioSGE.nasc | PPESSOA.DTNASCIMENTO | Data de nascimento do Funcionário |
Status | FuncionarioSGE.status | SMATRICPL.CODSTATUS | Caso o GUSUARIO.STATUS for ativo, enviamos Ativo Senão enviamos Excluído |
CPF do Funcionário | FuncionarioSGE.cpf | PPESSOA.CPF | CPF do Funcionário |
E-mail do Funcionário | FuncionarioSGE.email | PPESSOA.EMAIL | E-mail do cadastro de pessoa (PPESSOA.EMAIL) do Funcionário é enviado. |
Detalhamento do Processo
O termo 'funcionários' se refere às pessoas designadas a determinadas funções no SGE – Módulo Educacional (secretários escolares, membros da comissão coordenadora e diretores escolares).
Tais registros de 'funcionários' do SGE – Módulo Educacional são pessoas (PPESSOA) associados às funções através dos Menus:
- Filial | Dados Educacionais | <anexo> Diretores por Filial
- Módulo Educacional | Currículo e Oferta | Estrutura Curricular | Matrizes curriculares | <anexo> Matriz aplicada | <anexo> Comissão Coordenadora'.
Comissão Coordenadora:
Os membros da Comissão coordenadora devem estar cadastrados conforme abaixo:
Ao incluir uma pessoa no anexo de Comissão coordenadora, será necessário informar a função dessa pessoa na Comissão. Para esses membros temos as cinco funções:
- Coordenador,
- Vice- Coordenador,
- Assistente de coordenador,
- Conselho de coordenação,
- Coordenação pedagógica.
Diretores e secretários:
O cadastro dos Diretores e secretários, serão consultados com base nos dados informados em:
SGE - Módulo Fiscal | Filiais | Dados Educacionais | Diretores por Filial.
Neste módulo são cadastrados os diretores e secretários.
- 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:
falseInativação de Alunos [Novo!]Pré-Requisitos / Parametrizações
Realizar a parametrização da Integração;
ImportantePara realizar a Inativação de Alunos o Parâmetro "Data Referência" deverá ser preenchido.
Detalhamento do Processo
A Inativação dos usuários de Alunos no Portal SESI Educação ocorre a partir da execução do Processo de Exportação de Inativação de Alunos. Este processo envia os usuários de Alunos a serem inativados no Portal SESI Educação dado o Fim da Vigência da Turma ou Status de resultado final preenchido.
- É considerado somente a matrícula em Período Letivo mais recente (ultimo período letivo que tenha turma iniciada) para os Cursos/Segmentos parametrizados;
- O Final da Vigência da turma é identificado quando a Data Corrente é maior que a Data Fim da Turma;
- Tendo sido preenchido qualquer Situação na Situação de Resultado Final da Matrícula no Período Letivo o Aluno também é considerado para inativação;
- São enviados somente os Alunos cujo a Data Matrícula mais recente tenha sido realizada após a "Data Referência" (configurada em parâmetros);
- Não são enviadas inativação referente a matrículas em Filial inativa, sem o Código Integrador preenchido ou que tenha sido realizada antes da "Data Referência" (configurada em parâmetros);
O Processo pode ser agendado em ambientes de 3 camadas:
Importante: Os alunos que forem enviados para inativação, serão enviados apenas uma vez com sucesso para a matrícula, somente caso ocorra erro na inativação do Aluno que o mesmo será enviado novamente na próxima execução do processo. O Reenvio desta exportação se dá na própria execução do processo, não sendo possível enviar unitariamente.
falseInativação de Funcionários [Novo!]Pré-Requisitos / Parametrizações
ImportanteDiferente da Inativação de Alunos, a Inativação de Funcionários não possui um processo automatizado, necessitando ser feito manualmente pelo usuário.
Essa inativação é feita através do gatilho (plugin) existente no cadastro de usuários.
Detalhamento do Processo
A Inativação dos usuários de Funcionários no Portal SESI Educação ocorre a partir da inativação do usuário no cadastro do SGE.
Ao acessar o cadastro de um usuário que esteja integrado e ativo no Portal Sesi, desmarcando a flag Ativo será enviado o comando de inativação do usuário ao Portal Sesi Educação.
falseExclusão de Professores [Novo!]Pré-Requisitos / Parametrizações
ImportanteDa mesma forma que a Inativação de Funcionários, a exclusão de Professores não possui um processo automatizado, necessitando ser feito manualmente pelo usuário.
Essa exclusão é feita através do gatilho (plugin) existente no cadastro de usuários.
Detalhamento do Processo
A exclusão dos usuários de Professores no Portal SESI Educação ocorre a partir da inativação do usuário no cadastro do SGE.
Para Excluir um professor do Portal SESI, acesse o cadastro do Professor e clique no Usuário, em seguida, desmarque a opção “Ativo” e clique em Salvar para desativar.
Logo após, edite alguma informação do cadastro do professor e clique em Salvar para a customização disparar o gatilho para a exclusão do usuário no Portal SESI:
Caso o professor que deseja excluir ministrava disciplinas que pertencem a um período letivo que esteja com a opção “Período letivo encerrado” marcada, o gatilho da customização não será disparado e não irá gerar log.
Informações |
---|
|
Alteração de senha do usuário Cloak |
---|
Pré-Requisitos / Parametrizações
- 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.
A funcionalidade é acionada no SGE a partir da alteração dos dados do usuário no cadastro de Usuários, no "Trocar Senha" da aba ambiente e no trocar senha por meio do Portal SGE. A customização intercepta a alteração, verifica a entidade que pertence o registro e realiza o processo de integração das informações. Ao final, um Log é inserido na tabela customizada informando o status da operação.Observação: Caso ocorra um erro durante a integração, um registro é inserido no Log e o cadastro/alteração de senha do RM ocorre normalmente, sem que qualquer mensagem de erro seja exibida. Informações |
---|
|
Processo de Exportação Cloak |
---|
Pré-Requisitos / Parametrizações
- 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.
A interface do processo contém a lista das possíveis entidades a serem integradas dispostas em controles que permitam ao usuário selecionar/marcar quais registros deseja processar/integrar na execução do processo. São elas:- Alunos (e responsáveis pelos alunos);
- Professores (Docentes);
- Funcionários (Diretores Escolares, Secretários Escolares, Orientadores, Coordenadores);
- Reenvio de dados.
Conforme imagem abaixo:
falseReenvioPré-Requisitos / Parametrizações
- Realizar a parametrização da Integração e preenchimento De/Para;
Detalhamento do Processo
Durante a exportação dos dados do SGE para o Portal SESI Educação, podem ocorrer erros de validações, por exemplo, impedindo o registro de ser integrado corretamente. Por esse motivo, toda a tentativa de exportação é salva no log customizado para posterior conferência/reenvio.
Os registros que foram exportados e geraram erros podem ser reprocessados através do mesmo processo de integração utilizado para integrar as demais entidades. Tal processamento é disparado através do processo de integração ao se marcar a opção 'Reenvio de dados' e acionar a execução do processo (imediato ou agendamento). Outra forma é selecionar o(s) registro(s) individualmente na tela customizada de Log e executar o processo customizado que foi adicionado a ela.Uma nova tentativa de envio é realizada, passando por todos os procedimentos e validações detalhados nos requisitos anteriores. Ao final, os registros da tabela de Log serão atualizados com o novo status e parâmetros enviados/recebidos. Informações |
---|
|
Monitor de Log Cloak |
---|
Uma visão customizada foi criada para que seja possível verificar os dados enviados durante as integrações realizadas. Para cada registro exportado, foi criado um Log nessa tabela contendo os parâmetros utilizados, a entidade integrada.
Observação: Todos os dados são apenas para visualização, não sendo possível a alteração, edição ou exclusão de registros do Log através dessa interface.
Para informações sobre Alteração Status Logs com Erro e o processo de Exclusão de Logs no monitor, acesse o Manual Operacional da Customização - LIB DN
Informações |
---|
|
Web APIs Cloak |
falseIntegração de UsuáriosFoi desenvolvido um webservice customizado para realização de alteração de e-mail e senha dos usuários, recebendo como parâmetro o código do usuário, a nova senha e e-mail. O método está disponível para visualização no swagger.
Observação: a senha deverá ser informada na codificação Base64, conforme exemplos abaixo:
URL com os parâmetros adicionados: http://localhost:8080/rm/api/TOTVSCustomizacao/Usuario/SincronizarUsuario?codUsuario=lucianom&novaSenha=dG90dnM%3D&[email protected]
Envio da requisição via Postman:
O Método HTTP utilizado é o PUT. Quando a sincronização de usuário for realizada com sucesso, o campo "Sucess" será retornado como "true", e quando ocorrer um erro, será retornado como "false", e o campo "Message" irá detalhar o erro ocorrido, conforme no exemplo abaixo:
A Autenticação a ser utilizada é Basic utilizando usuário e senha do RM com devidas permissões para realização das ações:
Tabela com códigos de erros do WebServiceToken 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 |
falseIntegração de SenhaFoi 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:
Informações |
---|
|
Integração síncrona - Gatilhos Cloak |
---|
Pré-Requisitos / Parametrizações
- 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).
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. Informações |
---|
|
Reconhecimento de Saberes Cloak |
---|
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.
- É 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 |
Parâmetros 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.
...