Páginas filhas
  • Manual Operacional da customização - Versão 2.0

Versões comparadas

Chave

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

Manual Operacional da customização -

...

Integração Portal SESI

...


Objetivo

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

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

Metodologia

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

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


Informações

Novo instalador disponibilizado em 21/08 - As alterações deste instalador, estão destacadas no manual nos Tópicos terá um: Atualizado e no texto com um:  [Novo!]

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

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

    Expandir
    titlePermissões e orientações Técnicas

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

    1. É necessário ter um usuário RM vinculado à base de dados;
    2. É necessário ter o FRAMEHTML configurado e publicado em zona publica e acessível à chamada do Portal SESI Educação;
    3. A publicação do FRAMEHTML deve ser feito em DNS público e com certificado válido, disponibilizando em um site HTTPS;
    4. As configurações de publicação de serviços customizados no FRAMEHTML devem ter sido realizadas com sucesso;
    5. A Instalação Completa 
    Informações
    iconfalse

    Toggle Cloak
    Premissas

    Cloak
    Informações
    iconfalse
    Toggle Cloak
    Habilitando Menus (permissões)

    Cloak

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

    Informações
    iconfalse

    Toggle Cloak
    Parametrizações

    Cloak
    1. todos os parâmetros de DE PARA (descrito neste manual).
      1. Atenção:
      1. 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)
    1. Habilitar os menus, dando permissões aos perfis de usuários, conforme demostrado no Gif abaixo:

               Image Added


    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    infoiconfalse
    Expandir
    titleParâmetros da Integração [Atualizado]
    Table Excerpt
    nameParametrosIntegracao
    Table Excerpt
    nameParametrosIntegracaoIntro

    Além das premissas técnicas, é essencial realizar algumas configurações para garantir o sucesso da integração:

    Acesse os Parâmetros através do seguinte caminho:

    TOTVS Educacional > Sistema Indústria >Portal SESI> Parâmetros 


    Image Added

    A interface exibirá sete abas para serem configurados: Identificação, Reconhecimento de Saberes, Cursos (segmentos), Situações de matrícula, Validação de e-mail, Funcionários e Autenticação SSO.


    Deck of Cards
    historyfalse
    idParams
    Card
    labelIdentificação
    Table Excerpt
    nameparametrosidentificacao

    Nesta aba, são configurados os campos básicos para o funcionamento da integração.


    Image Added


    • Habilita Integração Portal SESI Educaçã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 da Integração:
      • Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil;
      • Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil;
      • Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil.
    • Classificação de Municípios (IBGE): Campo com lista de classificação de municípios (DCLASSIFMUNICIPIO), para o usuário selecionar em qual classificação de Município corresponde a do IBGE.
    • Dias para envio de turma finalizada: Neste campo o usuário deverá informará a quantidade de dias (em números)  em que uma turma finalizada será considerada na exportação.

    • [Novo!]  Utiliza campo complementar Turma SESI Educação:  Este campo marcado indica que no processo de exportação de turmas ao Portal SESI Educação, será considerado como código da turma, o valor informado no campo complementar mencionado.
      • Caso desmarcado será considerado o valor do campo nativo da turma 'Código da turma' (STURMA.CODTURMA).
      • Caso marcado e o campo complementar não estiver preenchido, será considerado o valor do campo nativo da turma 'Código da turma' (STURMA.CODTURMA). Maiores informações no tópico Processo de exportação.


    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    Card
    labelReconhecimento de Saberes
    Table Excerpt
    nameparametrosrecsabes

    Nesta aba, são configurados os campos referentes ao Reconhecimento de Saberes.

    Image Added

    Token para WS: Este recurso serve para gerar um Token do tipo Basic Authentication, o qual deve ser informado no Portal SESI para utilização da autenticação da comunicação com o SGE

    Gerando...

    Para gerar o Token deve ser informado o usuário e senha do usuário que será registrado a utilização da integração vinda do Portal SESI Educação.

    Image Added

    É importante utilizar um usuário exclusivo.

    Os demais campos, são para configurar os status e motivos de alteração para indicar quando a situação do aluno  for:

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


    • Competências reconhecidas:  Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
    • Motivo da alteração: Utilizado no Motivo Alteração, 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.


    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    Card
    labelCursos (Segmentos)
    Table Excerpt
    nameparametroscursos

    Nesta aba deverá ser informado/cadastrado

    e as informações preenchidas são armazenadas em tabela customizada. 

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

    falseAba IdentificaçãoHabilita Integração Portal SESI Educação

    Parâmetro que indica se a integração será realizada ou não

    O processo de integração pode estar agendado, mas a integração apenas irá ocorrer se este parâmetro estiver marcado. Tal parâmetro é valido para os registros de Alunos, Responsáveis Acadêmico, Professores, Diretor(es), Secretário(s), Coordenador(es) e Orientador Pedagógico para que seja realizada a integração de usuários para o Portal SESI Educação.

    Dados de Integração
    1. Endereço de acesso ao webservice de integração, disponibilizado pela Educar Brasil;
    2. Usuário do Portal SESI Educação para o consumo do webservice, disponibilizado pela Educar Brasil;
    3. Chave de verificação para o consumo do webservice, disponibilizado pela Educar Brasil.

    Estando Habilitado a Integração, estes 3 parâmetros são Obrigatórios.

    Datas
    1. Utilizar data referência é um parâmetro que habilita o campo Data Referência para que sirva de data de corte, para que somente os dados alterados pela última vez após a data selecionada sejam enviados. Também é utilizada no envio de Inativação de alunos para filtrar matrículas antigas, enviando apenas inativações relacionadas à matrículas posteriores a Data Referência;
    2. Data da última execução do processo de exportação para entidade de Aluno, esta data servirá de referência para a próxima execução da exportação;
    3. Data da última execução do processo de exportação para entidade de Professor, esta data servirá de referência para a próxima execução da exportação;
    4. Data da última execução do processo de exportação para entidade de Funcionários, esta data servirá de referência para a próxima execução da exportação.

    Importante: Caso utilize a data de referência a primeira execução desconsiderará registros criados/alterados antes da data parametrizada. Depois da primeira execução este parâmetro é utilizado somente para o envio das inativações de alunos,  e para os demais utilizará as datas de última execução.

    Importante: Esta parametrização é por Nível de Ensino, portanto, a integração deve ser habilitada para todos os níveis de ensino que a customização deve funcionar.

    false Aba Reconhecimento de SaberesToken

    Este recurso serve para gerar um Token do tipo Basic Authentication, o qual deve ser informado no Portal SESI para utilização da autenticação da comunicação com o SGE

    Gerando...

    Para gerar o Token deve ser informado o usuário e senha do usuário que será registrado a utilização da integração vinda do Portal SESI Educação.

    É importante utilizar um usuário exclusivo.

    À Reconhecer

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

    Competência Reconhecida
    1. Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
    2. Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação ¹Competência Reconhecida automaticamente pelo processo.
    Competência não Reconhecida
    1. Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes;
    2. Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação ¹Competência não Reconhecida automaticamente pelo processo.
    Matrícula no Período Letivo
    1. Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
    2. Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.
    false Aba Cursos (Segmentos)Um cadastro onde deverá ser relacionado (informado/cadastrado)

    os cursos do SGE – Módulo Educacional (segmentos de ensino da Educação Básica indicadas no Portal SESI Educação (Educar Brasil)) para os quais somente alunos e professores/disciplinas de tais cursos serão integrados.


    Image Added

    Junto a informação de cada curso deverá ser sinalizado se o e-mail do aluno (matriculado em tal curso) deverá ser obrigatório e também se alunos menores de 18 (dezoito) anos (matriculado em tal curso) deverão ter um responsável acadêmico informado. 

    false Aba Situações de Matrícula

    No Portal SESI Educação os registros contêm uma propriedade indicando o status dos registros que poderá ser: Ativo, Inativo ou Excluído. Para a integração de alunos este status será definido de acordo com a situação de matrícula do aluno. Como no SGE – Módulo Educacional as situações de matrículas são a partir de um cadastro (existem situações que não se pode alterar, mas é possível cadastrar novas) então é necessário definir o significado de cada situação de matrícula. 
    Em vista disto, neste módulo de parametrização, há um cadastro onde é possível efetuar o mapeamento entre as diversas situações de matrículas do SGE – Módulo Educacional e o que ela representará para o Portal SESI Educação no momento da integração. 

    Cursos (Segmentos).gifImage Added

    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    Card
    labelSituações de Matrícula
    Table Excerpt
    nameparametrossitmatric

    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.


    Image Added

    Ao incluir um novo registro será apresentado 3 campos para preenchimento:

    Sit. Matricula: Lista  das as situações de matrículas existentes na base.

    Status Indica: Status no Portal SESI, da situação de matricula selecionada. Podendo ser Pré matriculado, Matriculado ou Inativo.

    Não enviar ao Portal SESI: 

    É permitida a seleção da situação de matrícula e do status desta para o Portal SESI Educação podendo marcar uma entre três opções Ativo, Inativo e Excluído. Este mapeamento é realizado para todas as situações de matrícula do SGE – Módulo Educacional.

    [Novo!]

    Se o checkbox "Não enviar ao Portal SESI" estiver marcado as matrículas com tal situação serão desprezadas para a integração.

    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.


    Image Added           Image Added


    Estado
    colourGreen
    titleExemplo:

    Se a Escola  considerar que a situação de matricula "cancelado" do SGE deve ser enviada ao Portal SESI como Inativo, o preenchimento será da seguinte:

    Image Added

    Se em determinado momento a Escola determinar que essa situação de matrícula não deve ser considerada na  Exportação ao Portal SESI é necessário marcar  o checkbox:


    Image Added


    Aviso

    Se o usuário do aluno estiver Ativo, o processo customizado de exportação ao Portal SESI busca a informação  parametrizada nessa aba, para fazer a relação da situação de matricula do Aluno com status indica, identifcando se será ou não exportado.

    Se o usuário do aluno estiver Inativo, o

    Se o usuário do aluno estiver Inativo, o

    processo customizado já envia para o Portal SESI como

    Excluído

    Inativo.

    false
    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    Aviso

    Para que a entidade: Matrícula seja exportada, é fundamental que o parâmetro: Status Indica esteja devidamente preenchido.

    Caso o parâmetro Status Indica estiver em branco, ou seja, não preenchido, A matrícula não será exportada.

    Card
    labelValidação de e-mail
    Table Excerpt
    nameparametrosvalidaemail

    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:

    Aba Validação de Email [Novo!]

    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. 


    Image Added

    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    Card
    false
    label
    Aba Funcionários [Novo!]
    Funcionários
    Table Excerpt
    nameparametrosfuncionarios

    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

    .

    Este cadastro deve ser utilizado para informar o perfil de cada Funcionário, que poderá ser:

    • Funcionário Administrativo (Perfil padrão do Portal SESI)
    • Funcionário Pedagógico e
    • Administrador de Unidade

    Image Added

    Neste cadastro devem ser preenchidos os campos conforme a sua funcionalidade:

    1. Código da filial/escola: utilizado para identificar para qual filial se destina o funcionário que terá um perfil diferenciado do padrão. Um funcionário pode estar em mais de uma filial e com perfis diferentes;
    2. Código da Pessoa: mostrando apenas os funcionários a serem levados ao Portal SESI para filial selecionada no campo 1 que ainda não foram parametrizados, deve ser selecionado o funcionário ao qual se quer atribuir um perfil diferenciado para a filial selecionada;
    3. Perfil no Portal SESI Educação: utilizado para identificar qual perfil enviar ao Portal SESI, combo que permite selecionar entre os perfis: Funcionário Administrativo, Funcionário Pedagógico e Administrador de Unidade.

    Image Added

    Aviso

    Somente os funcionários cuja o perfil padrão (Funcionário Administrativo) não atenda as necessidades da Unidade que devem ser parametrizados neste cadastro.

    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    Card
    label
    Autenticação SSO
    toggle
    table-
    cloak
    Extrair
    Campos ComplementaresTURMASESIEDUCACAO

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

    Esse campo complementar deve fazer uso de uma tabela dinâmica: 
    Os itens dessa tabela dinâmica devem ser cadastrados conforme regra do cliente e de acordo com o documento disponibilizado pela Educar Brasil. Este campo deve estar disponível para visualização na turma e deve ser preenchido de acordo com a turma que será identificada pelo professor para publicação de material.Sistema de Gestão de Oficinas – SGO

    No caso da unidade que possuir o sistema de Gestão de Oficinas – SGO, este campo estará disponível para visualização no anexo "Turma SESI Educação" do cadastro de Salas do Oficina e deve ser preenchido de acordo com a turma que será identificada pelo professor para publicação de material.

    Validações

    [Novo!]

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

    • Caso o campo complementar TURMASESIEDUCACAO não esteja preenchido é validado caracteres especiais no código da turma;
    • Tendo preenchido o campo complementar TURMASESIEDUCACAO é validado para caracteres especiais o código e descrição.
    • Quando existir log de integração do SGE x Portal SESI Educação no "Monitor de Log", identificando que já fora realizado alguma integração, o campo complementar TURMASESIEDUCACAO ficará bloqueado para edição.

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

    Importante: O campo deve ser ativado pelo usuário -
    name
    Cloak
    parametrossso

    Aba destinada à configuração de logins via SSO (Single Sign-On). 

    Os campos são preenchidos automaticamente após a Importação do Arquivo (config_sesi.json) que é fornecido pelo Portal SESI


    Image Added

    Abaixo descrição dos campos para conhecimento:

    • Endereço WebService: Endereço de acesso ao webservice disponibilizado pelo Portal SESI.
    • Public Key: chave pública para descriptografar o token JWT.
    • Client ID: usuáriode acesso ao webservice disponibilizado pelo Portal SESI.
    • Secret Key: Senhade acesso ao webservice disponibilizado pelo Portal SESI.
    • Importar arquivo (config_sesi.json): Botão para importação das configurações via arquivo JSON*.

    *Arquivo disponibilizado pelo Portal SESI.

    Aviso

    Esse parâmetro deve ser preenchido exclusivamente via importação do arquivo. Qualquer manipulação manual dos campos, resultará em falhas da funcionalidade.

    Aviso

    Todos os parâmetros da integração devem ser consultados e atualizados (quando necessário) antes do envio da entidades ao Portal SESI.

    O SGE – Módulo Educacional

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

    não condizem

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

    Como estamos tratando de uma

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

    Para a integração é necessário

    efetuar a troca por

    ter valores equivalentes aos do Portal SESI Educação, antes de acionar o serviço que efetiva a integração. 

    Em vista desta situação, foi criada uma funcionalidade que permite o mapeamento e equivalência dos valores do SGE – Módulo Educacional para os valores utilizados pelo Portal SESI Educação. A funcionalidade '

    A funcionalidade 'Cadastro de DE/PARA' foi disponibilizada

    como um cadastro (ao invés de fixo, hardcore) de maneira a permitir que eventuais novos valores possam ser mapeados (criar o relacionamento,

    para criar esse relacionamento e equivalência entre os sistemas

    ) e/ou alterados sem a necessidade de novas codificações

    No SGE – Módulo Educacional, menu customização, disponibilizamos o Cadastro DE/PARA e neste, o usuário (usualmente o administrador do sistema/integração) irá selecionar o registro (SGE – Módulo Educacional) a que se refere e informar o valor equivalente no sistema destino (Portal SESI Educação).falseAcessando...

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

    Curso/Segmento

    Nesta entidade devem ser preenchidos os campos:

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

    Nesta entidade devem ser preenchidos os campos:

    • "Curso" onde deve ser selecionado o Curso para a disciplina;
    • "Valor do TOTVS Educacional" onde deve ser selecionada a Disciplina;
    • "Valor no Portal SESI Educação" onde deve ser informado o código da disciplina equivalente no Portal SESI Educação (validar com responsável pelo portal) - Em caso de não equivalente o mesmo deve ser preenchido com 0.
    Habilitação/Série

    Nesta entidade devem ser preenchidos os campos:

    • "Curso" onde deve ser selecionado o Curso para a habilitação/serie;
    • "Valor do TOTVS Educacional" onde deve ser selecionada a Habilitação/Serie;
    • "Valor no Portal SESI Educação" onde deve ser informado o código da habilitação/serie equivalente no Portal SESI Educação (validar com responsável pelo portal).
    Área - Grupo de Complemento

    Nesta entidade devem ser preenchidos os campos:

    • "Curso" onde deve ser selecionado o Curso para "Área - Grupo de Complemento";
    • "Valor do TOTVS Educacional" onde deve ser selecionada a "Área - Grupo de Complemento";
    • "Valor no Portal SESI Educação" onde deve ser informado o código da "Área - Grupo de Complemento" equivalente no Portal SESI Educação (validar com responsável pelo portal) - Em caso de não equivalente o mesmo deve ser preenchido com 0.
    Área Itinerário

    [Novo!]

    Nesta entidade devem ser preenchidos os campos:

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

    [Novo!]

    Nesta entidade devem ser preenchidos os campos:

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

    Expandir
    titleDE I PARA

    O SGE

    Informações
    iconfalse

    Toggle Cloak
    De | Para

    Cloak
    Informações
    iconfalse
    Toggle Cloak
    Validações Cadastrais [Novo!]

    Cloakfalse Caracteres especiais Turma SESI Educação

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

    • Caso o campo complementar TURMASESIEDUCACAO não esteja preenchido é validado caracteres especiais no código da turma;
    • Tendo preenchido o campo complementar TURMASESIEDUCACAO é validado para caracteres especiais no código ou descrição da Turma SESI preenchido.
    • Quando existir log de integração do SGE x Portal SESI Educação no "Monitor de Log", identificando que já fora realizado alguma integração, o campo complementar TURMASESIEDUCACAO ficará bloqueado para edição.

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

    falseEmail de Aluno e Responsável Acadêmico

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

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

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

    Informações
    iconfalse

    Toggle Cloak
    Integrações

    CloakfalseAlunos (e seus respectivos responsáveis acadêmicos)

    Pré-Requisitos / Parametrizações

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

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

    Nome

    Campo

    Origem

    Observações

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

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

    Senão enviamos Excluído

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

    A prioridade de envio do código da turma para o Portal SESI sempre é o campo complementar “Turma Sesi Educação”. Apenas quando ele não está preenchido a customização envia o Código da Turma (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 SGEDocenteSGE.idred "7"Enviado de forma fixa o valor '7'RegionalDocenteSGE.regional GCOLIGADA.ESTADOEstado do cadastro da ColigadaCódigo IntegradorDocenteSGE.inep DFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1Código IntegradorDocenteSGE.codigointegradorDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1PerfilDocenteSGE.perfil "ESTUDANTE"Enviado de forma fixa o valor 'DOCENTE'NomeDocenteSGE.nome PPESSOA.NOMENome do ProfessorCódigo ExternoDocenteSGE.codigoexterno PPESSOA.CODUSUARIOCódigo do Usuário do ProfessorSenha do UsuárioDocenteSGE.user_sen Senha do UsuárioSenha do Usuário do ProfessorSexoDocenteSGE.sexo PPESSOA.SEXOCorrespondendo à 'feminino' | 'masculino'Data de NascimentoDocenteSGE.nasc PPESSOA.DTNASCIMENTOData de nascimento do ProfessorStatusDocenteSGE.status SMATRICPL.CODSTATUS

    Caso o GUSUARIO.STATUS for ativo, enviamos Ativo

    Senão enviamos Excluído

    CPF do ProfessorDocenteSGE.cpf PPESSOA.CPFCPF do ProfessorE-mail do ProfessorDocenteSGE.email PPESSOA.EMAILCaso o e-mail O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido este é enviado como principal, do contrário o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado. E-mail complementar do ProfessorDocenteSGE.emailcomplementar SALUNOCOMPL.EMAILO365Caso o email O365 (SPROFESSORCOMPL.EMAILO365) esteja preenchido o email do cadastro de pessoa (PPESSOA.EMAIL) do professor é enviado como email complementar, do contrário nenhum email é enviado como complementar.AulasDocenteSGE.aulasTurmas do Professor

    Turma do professor (SMATRICPL.CODTURMA | STURMACOMPL.TURMASESIEDUCACAO), Curso da turma (SHABILITACAOFILIAL.CODCURSO | ZDEPARASEG.CODIGOPORTAL), Série da Turma (SHABILITACAOFILIAL.CODHABILITACAO | ZDEPARASERIE.CODIGOPORTAL), Turno da Turma (STURNO.TIPO | (Manhã;Tarde;Noite;Integral)), Área - Grupo de Complemento (SDISCGRADE.IDGRUPOCOMPLEMENTO | ZDEPARAAREA.CODIGOPORTAL), Disciplina/Componente (SDISCIPLINA.CODDISC | ZDEPARADISC.CODIGOPORTAL) como lista no formato JSON conforme a seguir:

    [{"turma":"A","segmento":"14","serie":"1","turno":"Tarde","area":"1","componente":"22"},{"turma":"A","segmento":"14","area":null,"componente":"33"},{"turma":"A","segmento":"14","serie":"1","turno":"Manhã","area":"1","componente":"4"}]

    Somente serão enviadas aulas de professores que atenderem aos critérios: 

      • Estar vinculadas à uma turma que esteja com os campos data inicial e data final preenchidos (STURMA.DTINICIAL e STURMA.DTFINAL) e dentro do período vigente;
      • Estar vinculadas à uma Turma/Disciplina que esteja com os campos data inicial e data final do período do professor preenchidos (SPROFESSORTURMA.DTINICIO e SPROFESSORTURMA.DTFINAL) e dentro do período vigente;
      • Caso as datas de início e fim das Turmas e/ou período do professor na Turma/Disciplina, estejam em branco ou fora do período de vigência, não terão suas disciplinas exportadas.
    TurmaAula.turmaSTURMA.CODTURMA | STURMACOMPL.TURMASESIEDUCACAOA prioridade é do campo TURMASESIEDUCACAO quando preenchidoSegmentoAula.segmentoSHABILITACAOFILIAL.CODCURSODe/Para de Segmento correspondente ao Campo

    Turno

    Aula.turnoSHABILITACAOFILIAL.CODTURNOCorrespondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral'SérieAula.serieSHABILITACAOFILIAL.CODHABILITACAODe/Para de Serie correspondente ao CampoÁreaAula.areaSDISCGRADE.IDGRUPOCOMPLEMENTODe/Para de Área - Grupo de Complemento correspondente ao CampoComponenteAula.componenteSTURMADISC.CODDISCDe/Para de Disciplina/Componente correspondente ao Campo

    Detalhamento do Processo

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

    Para a exportação ser efetivada é preciso realizar a parametrização da tabela De/Para, parametrizando obrigatoriamente os Cursos e Disciplinas vinculados ao cadastro dos professores.Os campos obrigatórios, parametrizações de/para e e-mail serão validados e, se estiverem corretos, serão enviados para o Portal SESI Educação, e seu retorno é gravado na tabela de Log.Caso ocorra algum erro durante a integração, este será gravado em log. Após alteração do registro do professor, para realizar nova integração deverá ser selecionado o log referente ao professor e executado o processo de reenvio de erro.Importante: Para que o professor seja exportado o mesmo deve ter um usuário cadastrado no SGE e estar dando aula em alguma Turma/Disciplina que tenha sido informado no cadastro De/Para para disciplinas.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'

    RegionalFuncionarioSGE.regionalGCOLIGADA.ESTADOEstado do cadastro da ColigadaCódigo IntegradorFuncionarioSGE.inepDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1Código IntegradorFuncionarioSGE.codigointegradorDFILIAL.CAMPOLIVRE1Cadastro de Filial: DFILIAL.CAMPOLIVRE1PerfilFuncionarioSGE.perfil

    Caso preenchido, é enviado o perfil parametrizado nos parâmetros de Funcionários (na parametrização da Integração Portal SESI Educação).

    Os Funcionários que não parametrizados são enviados com o perfil padrão (Funcionário Administrativo).

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

    Caso o GUSUARIO.STATUS for ativo, enviamos Ativo

    Senão enviamos Excluído

    CPF do FuncionárioFuncionarioSGE.cpfPPESSOA.CPFCPF do FuncionárioE-mail do FuncionárioFuncionarioSGE.emailPPESSOA.EMAILE-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;

    Importante

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

    Detalhamento do Processo

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

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

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

    O Processo pode ser agendado em ambientes de 3 camadas:

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

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

    Pré-Requisitos / Parametrizações

    Importante

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

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

    Detalhamento do Processo

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

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

    falseExclusão de Professores [Novo!]

    Pré-Requisitos / Parametrizações

    Importante

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

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

    Detalhamento do Processo

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

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

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

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

    Informações
    iconfalse

    Toggle Cloak
    Alteração de senha do usuário

    Cloak

    Pré-Requisitos / Parametrizações

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

    Detalhamento do Processo

    O Registro dos usuários são criados apenas no SGE e ao realizar uma alteração nos dados eles são enviados ao Portal SESI Educação, no modelo síncrono, afim de manter os dados dos dois sistemas sincronizados.

    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
    iconfalse

    Toggle Cloak
    Processo de Exportação

    Cloak

    Pré-Requisitos / Parametrizações

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

    Detalhamento do Processo

    Foi criado um processo customizado no SGE – Módulo Educacional para realizar a integração entre o SGE e o Portal SESI Educação. O processo pode ser acionado via menu ou agendado para executar com periodicidade definida.

    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:

    falseReenvio

    Pré-Requisitos / Parametrizações

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

    Detalhamento do Processo

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

    Os registros que foram exportados e geraram erros podem ser reprocessados através do mesmo processo de integração utilizado para integrar as demais entidades. Tal processamento é disparado através do processo de integração ao se marcar a opção 'Reenvio de dados' e acionar a execução do processo (imediato ou agendamento). Outra forma é selecionar o(s) registro(s) individualmente na tela customizada de Log e executar o processo customizado que foi adicionado a ela.Uma nova tentativa de envio é realizada, passando por todos os procedimentos e validações detalhados nos requisitos anteriores. Ao final, os registros da tabela de Log serão atualizados com o novo status e parâmetros enviados/recebidos. Informações
    iconfalse

    Toggle Cloak
    Monitor de Log

    Cloak

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

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

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

    Informações
    iconfalse

    Toggle Cloak
    Web APIs

    CloakfalseIntegração de Usuários

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

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

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

    Envio da requisição via Postman:

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

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

    Tabela com códigos de erros do WebService

    Token Inválido

    01

    Usuário não encontrado

    02

    E-mail inválido

    03

    Inconsistências DataServer RM

    04

    Erro desconhecido

    05

    Erro ao conectar no RM

    06

    falseIntegração de Senha

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

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

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

    Envio da requisição via Postman:

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

    Informações
    iconfalse

    Toggle Cloak
    Integração síncrona - Gatilhos

    Cloak

    Pré-Requisitos / Parametrizações

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

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

    Detalhamento do Processo

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

    • Currículo e Oferta | Aluno | <processo> Matricular aluno;
    • Currículo e Oferta | Aluno | <anexo> Matriculas no Período letivo | <processo> Alterar situação de matrícula;
    • Currículo e Oferta | Aluno | <anexo> Matriculas no Período letivo | <processo> Matricular aluno nas disciplinas;
    • Currículo e Oferta | Aluno | <anexo> Matriculas isolada | <processo> > Alterar situação de matrícula;
    • Matrícula e Avaliação | Matrículas | <anexo> Matrículas em disciplinas | <processo> Alterar situação de matrícula;
    • Matrícula e Avaliação | Matrículas | <anexo> Matrículas em turma mista | <processo> Alterar situação de matrícula;
    • Matrícula e Avaliação | Matrícula | Matrículas | <processo> Alterar situação de matrícula;
    • Matrícula e Avaliação | Matrícula | Matrículas | <processo> Matricular aluno nas disciplinas;
    • Matrícula e Avaliação | Matrícula | Matrículas | <processo> Confirmação de matrícula por pagamento;
    • Matrícula e Avaliação | Matrícula | Matrícula isolada | <processo> Alterar situação de matrícula;
    • Matrícula e Avaliação | Matrícula | <processo> Rematrícula;
    • Matrícula e Avaliação | Matrícula | Mais | <processo> Confirmação de matrícula por pagamento;
    • Matrícula e Avaliação | Matrícula | Mais | <processo> Matricula de disciplinas em lote;
    • Matrícula on-line;
    • Cadastro de pessoas;
    • Cadastro do aluno;
    • Cadastro de matrículas;
    • Estrutura Curricula | Matriz Curricular | Matriz Aplicada | Comissão Coordenadora;
    • Cadastro de Filial | Dados Educacionais | Diretores por Filial;
    • Currículo e Oferta | Professores;
    • Currículo e Oferta | Oferta | Turma Disciplina | Professores;
    • Cadastro de usuários (apenas alteração de e-mail/senha dispara a exportação).
    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
    iconfalse

    Toggle Cloak
    Reconhecimento de Saberes

    Cloak

    Pré-Requisitos / Parametrizações

    1. O código das competências (disciplinas) enviadas pelo Web Service deverão corresponder ao código das disciplinas cadastradas no SGE. Este cadastro é feito manualmente pelos usuários que devem ter atenção para que os dados sejam registrados igualmente entre os sistemas.
    2. É necessário que o aluno esteja com apenas uma Matrícula no Período Letivo com situação de matrícula igual a "Reconhecimento de Saberes". As disciplinas FIC e quaisquer outras que estejam cadastradas com status "Matriculado" não são modificadas.
    3. Só serão alteradas as informações caso o aluno possua matrícula referente a disciplina, caso contrário não será feita nenhuma alteração e nem gravará nada no log.

    Descrição do Processo

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

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

    Toggle Cloak
    De/Para Portal SESI Educação

    Cloak
    false

    O Portal SESI Educação disponibiliza uma documentação Online para facilitar a identificação das Entidades a serem parametrizadas no De/Para. Para acessar, clique aqui.

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

    Image Added

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

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

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

    Image Added


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

    Image Added

    Informações

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


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

    Image Added

    4- Valor no Portal SESI Educação: Onde deve ser informado o código equivalente no Portal SESI Educação (validar com responsável pelo portal).

    Image Added

    Aviso

    O Portal SESI Educação disponibiliza uma documentação Online para facilitar a identificação das Entidades a serem parametrizadas no De/Para. Para acessar, entre em contato com o SESI DN.

    Aviso

    O cadastro do DE PARA, deve ser atualizado (quando necessário) antes do envio da entidades ao Portal SESI.

    Expandir
    titleProcesso de Exportação [Atualizado]
    Aviso

    Antes de realizar a exportação das entidades ao Portal SESI, certifique-se que todos os parâmetros e configurações citadas acima, estejam preenchidas e com os valores corretos.

    Após as configurações descritas acima, o usuário poderá executar o processo de Exportação.

    A exportação de dados é responsável pelo envio das seguintes Entidades:

    • Alunos (e responsáveis acadêmicos)
    • Docentes
    • Funcionários (Diretores escolares, secretários Escolares, orientadores, comissão coordenadores)
    • Turmas
    • Matriculas
    • Aulas Docentes
    • Oficinas (apenas para o Regional Paraná)

    Antes de executar o processo é necessário que o usuário entenda as regras de cada Entidade que será integrada.

    Aviso

    Para que os alunos integrados com sucesso sejam visualizados no Portal SESI Educação, é premissa que também tenham sido integradas as entidades: Turmas e Matrículas.

    Informações
    titleClique na entidade e veja as regras ao lado
    Section
    bordertrue
    Column
    width30

    Toggle Cloak
    exclusivetrue
    id1
    Pré Cadastro de Pessoa

    Toggle Cloak
    exclusivetrue
    id2
    Integração de Alunos/responsáveis

    Toggle Cloak
    exclusivetrue
    id3
    Integração de Turmas [Novo!] 

    Toggle Cloak
    exclusivetrue
    id4
    Integração de Matrículas

    Toggle Cloak
    exclusivetrue
    id5
    Integração de Docentes

    Toggle Cloak
    exclusivetrue
    id6
    Integração de Aulas do Docente

    Toggle Cloak
    exclusivetrue
    id7
    Integração de Funcionários

    Toggle Cloak
    exclusivetrue
    id8
    Integração de Oficinas

    Column
    width70
    Cloak
    visibletrue
    id1

    Essa integração antecede o envio de Aluno, Responsável, Docente e Funcionários para o Portal SESI, na intenção de identificar se será aproveitado algum cadastro existente ou criado o pré-cadastro. 

    Para integração de alunos e responsáveis acadêmicos (para alunos menores de 18 anos), tem como base o cadastro de Pessoa. Sendo assim consideramos: 

    Campos obrigatórios para integração
    • Nome
    • Estado Natal e Naturalidade
    • Data de nascimento
    • Sexo
    • E-mail 
    • Nome da mãe (caso não possua CPF informado)
    Campos de envio opcional
    • CPF
    • Nome Social
    • E-mail Complementar (caso o email O365  Esteja preenchido ele será enviado como principal).
    Outras validações

    Sendo encontrado um registro, o Portal SESI retornará o Iduser* correspondente. *Identificar único da pessoa no Portal SESI.

    Cloak
    visibletrue
    id2

    Para integração de alunos e responsáveis acadêmicos (para alunos menores de 18 anos), tem como base o cadastro de Pessoa. Sendo assim consideramos: 

    Campos obrigatórios para integração
    • Nome
    • Estado Natal e Naturalidade
    • Data de nascimento
    • Sexo
    • E-mail 
    • Usuário* (caso o usuário esteja inativo será enviado o comando de inativação ao Portal SESI)
    • Senha do usuário
    • Nome da mãe (caso não possua CPF informado)

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

    Campos de envio opcional
    • CPF
    • Nome Social
    • E-mail Complementar (caso o email O365  Esteja preenchido ele será enviado como principal)
    • Raça
    Outras validações
    • E-mail do responsável acadêmico:  Será verificado se o responsável  acadêmico é também um aluno ou Professor. Caso seja, consultamos se o e-mail do responsável acadêmico (PPESSOA) é o mesmo e-mail do campo complementar a Office 365 (aluno ou professor). Se os e-mails forem idênticos, a validação na Quickemail não será necessária, se forem divergentes, a validação na Quickemail será aplicada respeitando os parâmetros cadastrados.
    • Notificação de Alerta para E-mail Inválido: Será exibida notificação no cadastro de Aluno, caso seja realizada inclusão ou alteração no e-mail, para validar a sintaxe*   do e-mail (*se tem domínio, o @ e ponto caracteres validos)  e alertar da importância de um e-mail válido. 
    • Matrículas do aluno: Caso o aluno possua matrícula, é necessário que a mesma esteja com a flag "Enviar ao Portal Sesi" para que o aluno seja integrado.
    Cloak
    id3

    Para integração é necessário de as Turmas e Turmas/disciplinas sejam cadastras considerando:

    Campos obrigatórios para integração

    Para turmas e turmas Disciplinas:

    • Turno 
    • Data inicial
    • Data final
    • Código turma¹ 

    Para o Novo Ensino Médico considerar também:

    • Itinerário Formativo
    Outras validações
    • [Novo!] ¹Será verificado se o parâmetro 'Utiliza campo complementar Turma SESI Educação' está marcado.
      • Este campo marcado indica que no processo de exportação de turmas ao Portal SESI Educação, será considerado como código da turma, o valor informado no campo complementar mencionado.
      • Caso desmarcado será considerado o valor do campo nativo da turma 'Código da turma' (STURMA.CODTURMA).
        • RedAtenção  Caso o parâmetro esteja marcado o envio do código da turma para o Portal SESI será o campo complementar “Turma Sesi Educação”  desde que esteja preenchido. Quando ele não está preenchido a customização envia o Código da Turma (STURMA.CODTURMA).
    • Campo complementar Enviar ao Portal SESI no cadastro da Turma: Este campo, por padrão estará marcado. Caso seja desmarcado a Turma e seus vínculos  não serão considerados na integração com o Portal SESI.
    Reenvio de turmas já exportadas [Novo!] 

    [Novo!] Para as Turmas que já foram enviadas com sucesso para o Portal SESI com o código da Turma, e o Regional necessite reenviar o registro alterando para o envio da informação existente no campo complementar Turma SESI Educação, será necessário:

    1. Alterar/incluir os registros das Turmas para que a integração entenda que o registro sofreu atualização e precisa ser reenviado ao Portal SESI, nesse reenvio serão consideradas as novas regras implementadas neste escopo.
      O fato de preencher o campo complementar Turma SESI educação já é uma alteração válida para o reenvio.
    2. Executar o processo de exportação de Turmas.
    Cloak
    id4

    Serão exportadas as Matriculas dos alunos considerando:


    Itens que serão integrados

    Alunos já exportados ao Portal SESI e que estejam matriculados com algum dos Status abaixo:

    • Pré-matrícula: para matrículas no período letivo que estiverem parametrizadas com Situação de Matrícula que o Status Indica estiver preenchido como “Pré-Matriculado” ou “Matriculado” e a Data corrente é menor que a Data Início da Turma;
    • Matriculado: para matrículas no período letivo que estiverem parametrizadas com Situação de Matrícula que o Status Indica estiver preenchido como “Matriculado” e não forem identificados como Concluinte ou Pré-Matriculado;
    • Inativo: para matrículas no período letivo que estiverem parametrizadas com Situação de Matrícula que o Status Indica estiver preenchido como “Inativo”.


    Importante:

    • Passaremos a enviar todas as matrículas elegíveis ao Portal SESI educação e não mais somente a última, porém atualizações serão enviadas somente em caso de alteração de situação de matrícula ou resultado, pois estes são os campos enviados que não fazem parte da chave da matrícula.
    • Considerando que a situação de matrícula ‘Pré matriculado’, possivelmente são de alunos cuja turma em que está vinculado ainda não foi iniciada, caso o aluno não tenha situação de matrícula considerada “Matriculado”, no Portal SESI o aluno permanecerá Inativo, até que esta “Pré-matrícula” tenha mudado para “Matriculado”.
    Outras validações
    • Campo complementar Enviar ao Portal SESI na Matrícula do Período letivo: Este campo, por padrão estará marcado. Caso seja desmarcado essa matrícula não será considerada na integração com o Portal SESI.
    • A data de início daturma não é considerada um pré-requisito para exportação. Consideramos a data da entrada da pré-matrícula no SGE (exceto para alunos da EJA).
    Cloak
    id5

    Para integração de Docentes (Professores), tem como base o cadastro de Pessoa. Sendo assim consideramos: 

    Campos obrigatórios para integração
    • Nome
    • Estado Natal e Naturalidade
    • Data de nascimento
    • Sexo
    • E-mail 
    • Usuário (Ativo)
    • Senha do usuário
    • Nome da mãe (caso não possua CPF informado)
    Campos de envio opcional
    • CPF
    • Nome Social
    • E-mail Complementar (caso o e-mail O365  Esteja preenchido ele será enviado como principal)
    • Raça
    Atenção!

    Para que o professor seja exportado, é necessário que ele tenha um usuário cadastrado no SGE e esteja ministrando aula em uma Turma/Disciplina que tenha sido informada no cadastro De/Para para disciplinas.

    Cloak
    id6

    Para integração de Aulas do Docente, será enviado a relação do Docente com as turmas/disciplinas:


    Validações
    • Professores vinculados a turmas/disciplina, já integradas

    Verificar as regras de envio das turmas e turmas/disciplinas.

    Cloak
    id7

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

    Sendo assim, consideramos:

    Campos obrigatórios para integração
    • Nome
    • Estado Natal e Naturalidade
    • Data de nascimento
    • Sexo
    • E-mail 
    • Usuário* (caso o usuário esteja inativo será enviado o comando de inativação ao Portal SESI)
    • Senha do usuário
    • Perfil de funcionário (Cadastrado nos parâmetros)
    • Nome da mãe (caso não possua CPF informado)
    Campos de envio opcional
    • CPF
    • Nome Social
    • E-mail Complementar (caso o e-mail O365  Esteja preenchido ele será enviado como principal)
    • Raça
    Outras validações

    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'.
    Cloak
    id8

    A integração das Oficinas será tratada em tópico a parte deste manual.


    Conhecendo a regra de cada Entidade que será exportada.  O usuário poderá executar o processo de Exportação através do Menu:

    TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | Exportação de Entidades

    Image Added


    Informações
    • Esse processo poderá ser agendado conforme recurso nativo.
    • O processo de exportação acontece de formar síncrona. 
    • O primeiro envio pode levar mais tempo para ser concluído. 

    Executando manualmente o processo o usuário poderá selecionar uma ou mais entidades.

    Image Added


    O resultado da exportação é registrado  no Monitor de log da integração, descrito no próximo tópico deste manual.


    Expandir
    titleMonitor de log

    Após a exportação dos dados, cada exportação gera um determinado registro de Log.

    O Monitor de Log, possibilita uma visão dos dados que foram enviados e o retorno de cada exportação. Ele estará disponível no Menu: 

    TOTVS Educacional | Sistema Industria | Integradores | Portal SESI | DE/PARA da integração

    Image Added

    Ao acessar a tela é apresentado todos os Registros da Exportação. Para facilitar o entendimento vamos apresenta-lo por Funcionalidade.

    Image Added

    Cada Funcionalidade integrada, traz as informações de Log:

    Image Added


    No anexo Item de log, é possível visualizar com mais detalhes os dados exportados:

    Image Added


    Na tela do anexo temos acesso a:


    Informações
    titleClique no item a esquerda e veja a descrição a direita
    Section
    bordertrue
    Column
    width30

    Toggle Cloak
    exclusivetrue
    id10
    Mensagem

    Toggle Cloak
    exclusivetrue
    id20
    Dados Enviados

    Toggle Cloak
    exclusivetrue
    id30
    Dados Recebidos


    Column
    width70
    Cloak
    visibletrue
    id10

    Mensagem: descrição geral da execução do processo.

    Exemplo: Criação do aluno realizada com sucesso.



    Cloak
    visibletrue
    id20

    Dados enviados: Aqui é possível verificar se todos os dados preenchidos foram enviados.

    Exemplo de exportação de Pré Cadastro de Pessoa:


    • Method= POST (criação) ou PUT (atualização)
    • iduser = identificador único da pessoa no Portal SESI
    • idred: será enviado fixo “7”
    • codigoExterno: campo livre 1 (Cadastro de Filial: DFILIAL.CAMPOLIVRE1)



    Cloak
    id30

    Dados recebidos: retorno da exportação.

    Exemplo: “cadastro realizado com sucesso’’





    Caso seja apresentado algum erro na exportação, é possível identificar qual regra foi violada, a partir da mensagem apresentada:


    Image Added


    No exemplo acima, o Pré cadastro de pessoa nao foi exportado porque o "O campo Email não é um endereço de email válido."

    Nesta situação, o usuário poderá corrigir o campo e realizar o  reenvio desse log, através do Processo: Reenvio de dados:

    Image Added


    Expandir
    titleAtualização de dados [Atualizado]

    Os dados referentes a alunos, docentes e funcionários estão sujeitos a modificações após a exportação inicial. Quando essas alterações ocorrerem, ao realizar o processo de exportação novamente, a customização enviará ao Portal SESI apenas os campos que foram modificados.

    Vale ressaltar que os campos que foram alterados não serão exportados novamente.

    Estado
    colourGreen
    titleExemplo:

     Aluno na criação (Method =POST) não tinha registro de nome social. Atualizando o cadastro do aluno com a inclusão do nome social e realizado a exportação novamente, foi enviada a atualização (Method = PUT) com o nome social cadastrado (JULIO):

    Image Added  Image Added



    Aviso
    titleReenvio de turmas já exportadas

    [Novo!] Considerando a nova regra, onde o campo complementar: Turma SESI Educação, pode ser considerado:


    Para as Turmas que já foram enviadas com sucesso para o Portal SESI com o código da Turma (STURMA.CODTURMA), e o Regional necessite reenviar o registro alterando para o envio da informação existente no campo complementar Turma SESI Educação, será necessário:

    1. Alterar/incluir os registros das Turmas para que a integração entenda que o registro sofreu atualização e precisa ser reenviado ao Portal SESI, nesse reenvio serão consideradas as novas regras implementadas neste escopo.
      O fato de preencher o campo complementar Turma SESI educação já é uma alteração válida para o reenvio.
    2. Executar o processo de exportação de Turmas.
    Expandir
    titleAcesso ao Portal SESI via Portal do Aluno

    Foi incluído no Portal do aluno, um menu para que ele acesse o Portal SESI.

    Quando os alunos clicarem nesse link, eles serão direcionados automaticamente para o Portal SESI, onde serão autenticados automaticamente, sem a necessidade de inserir suas informações de login novamente.

    Image Added


    Expandir
    titleAcesso ao Portal SESI via Portal do Professor

    Também foi incluído no Portal do professor, um menu para que ele acesse o Portal SESI.

    Quando os professores clicarem nesse link, eles serão direcionados automaticamente para o Portal SESI, onde serão autenticados automaticamente, sem a necessidade de inserir suas informações de login novamente.

    Image Added


    Expandir
    titleInativação de Docentes

    Sempre que houver a necessidade de Inativação de um docente no Portal SESI, o usuário deverá seguir o processo para inativação, conforme descrito abaixo:

    • Acesse o Menu: TOTVS Educacional  |  Currículo e oferta | Professores  | Processos | Inativação de Professor - Portal SESI

    Image Added

    • Será apresentado na tela do lado esquerdo a lista de professores selecionados e que já foram exportados para o Portal SESI.
    • Ao Clicar em um registro do lado esquerdo, aparecerá do Lado direito da tela as filais que ele está vinculado.
    • Selecionar do lado direito em qual filial o docente será inativado.

    Image Added

    • Avançar a tela, os docentes e filiais selecionadas, serão apresentadas em árvore para que o usuário visualize a estrutura que faz parte da Inativação.

    Image Added

    • Após a execução do processo, a  data  final do vínculo do professor com turmas/disciplinas será alterada.

    Os registros desse processo são gravados no Monitor de log.

    Expandir
    titleInativação de Usuários (Docentes / funcionários)

    O processo para Inativação de usuários - Portal SESI, possibilita inativação por completo do usuário no Portal SESI. 

    O processo estará disponível no Menu: TOTVS Educacional | Sistema Industria | Integradores | Portal SESI:

    Image Added

    Ao ser acionado o processo apresentará  na tela um lookup com a lista de usuários já integrados como Ativo no Portal SESI, para que o usuário selecione o que será inativado.

    Image Added

    É permita a seleção de apenas um usuário por vez.

    Atenção a mensagem exibida na tela: 

    “ATENÇÃO:  Certifique-se que o usuário selecionado esteja correto. 

    Ao executar o processo, o mesmo será inativado por completo no Portal SESI.”

    Ao final da execução será exibido o log com o número de registros afetados, informando o sucesso da operação. Esse registro ficará gravado no Log Integração Portal SESI Educação.

    Esse processo gera duas ações:

    1. No SGE: O cadastro do usuário é alterado com a data da execução do processo (campo expiração de validade) e com o campo Ativo, desmarcado:

    Image Added


           2. Na próxima exportação de dados, o usuário será atualizado e enviado ao Portal SESI com o comando de inativação.


    Expandir
    titleOficinas - SESI Paraná
    Expandir
    titleExportação de Dados - Oficinas

    Acesse o menu: TOTVS Educacional | Sistema Indústria | Integrações | Integração Portal SESI. Dentro da opção, selecione o processo de Exportação de Dados do Portal SESI.

    O processo de Exportação de Dados do Portal SESI será modificado para incluir o envio das informações das Oficinas da Regional Paraná. Será adicionado um novo checkbox chamado "Oficinas" na interface, permitindo que o usuário marque quando desejar enviar esses dados.

    Este processo poderá ser executado manualmente pelo usuário, ou agendado.

    Image Added
     Ao executar o processo a customização irá considerar para envio as seguintes regras:

    1. Para que a Oficina seja enviada para o Portal SESI, é necessário que haja pelo menos um aluno matriculado nela e que sua data final + o número de “Dias para envio da Turma/Oficina Finalizada” (parâmetro) seja maior que a data corrente. Neste momento, serão enviados os dados da Oficina e seus respectivos professores: responsáveis e associados à Oficina. 
    2. O envio contempla apenas professores que já estão previamente integrados ao Portal SESI, devendo ter sido integrados por meio do processo atual.
    3. Serão enviadas apenas Oficinas do Tipo Formação Geral Básica (Ensino Médio)e Interseriado (Ensino Fundamental), definido no cadastro da oficina.

    Será utilizado o parâmetro “Dias para envio da Turma Finalizada”, que terá seu nome alterado para “Dias para envio da Turma/Oficina Finalizada” para o Regional Paraná. Ele armazena o  número de dias considerados após o final da Oficina para identificar se ela deverá ser enviada. Será utilizado como base a Data final da Etapa Principal da Oficina.

    Aviso
    titleImportante:
    • Antes de enviar uma Oficina (seja inclusão ou alteração) ao Portal SESI, verificar o status dos professores vinculados.
    • Professores com status inativo no Portal SESI não devem ser enviados.

    A mesma regra deve ser aplicada para o professor responsável pela Oficina. Porém, quando o responsável estiver inativo, será gerada mensagem no log informando que a Oficina não foi exportada por esse motivo. 

    Se não existir nenhum professor ativo vinculado à Oficina, ela deverá ser enviada com a lista de professores vazia. 

    Dica
    titleExemplo

    Dias para envio da Turma/Oficina Finalizada: 30 

    Data corrente de execução do processo: 10/01/2024

    Data calculada: 10/01/2024 - 30: 11/12/2023 (desconsidera as finalizadas até essa data)

    Oficina ABC - Data início: 01/10/2023 e Data fim: 02/12/2023 - Não enviada

    Oficina 321 - Data início: 01/12/2023 e Data fim: 11/12/2023 - Enviada

    Oficina DEF - Data início: 01/01/2024 e Data fim: 30/03/2024 - Enviada

    Ao ocorrer qualquer alteração nos dados das oficinas enviadas ou inclusão/exclusão de professores vinculados à sala oficina, os dados atualizados serão enviados ao Portal SESI ao rodar o processo de exportação novamente.

    Expandir
    titleExportação de Dados - Matrículas

    Os dados das oficinas na matrícula serão enviados para o Portal SESI quando o processo de exportação for executado ou quando uma matrícula em oficina for efetuada. 

      • Processo existente de Exportação de Dados disponível no menu: TOTVS Educacional  |  Sistema Indústria  |  Integrações  | Integração Portal SESI.
    • Ao realizar uma nova matrícula em Oficina, através dos menus: 
      • Portal Oficinas - Aluno: Oficinas | Inscreva-se
      • Portal Oficinas - Pedagogo: Matrícula na Oficina

    O processo atual de envio de matrículas do SGE para o Portal SESI será modificado para incluir informações das oficinas. Quando uma matrícula é enviada e contém informações de matrícula em oficina, essas informações serão enviadas na mesma requisição.

    A API de Matrícula atual será ajustada pelo Portal SESI para considerar uma nova lista chamada "Oficinas", permitindo o envio desses dados pelo SGE.

    Se não houver oficinas vinculadas, o processo de envio de matrícula continuará enviando apenas os dados da matrícula do aluno, conforme o fluxo padrão da integração do Portal SESI.

    Durante o ano, um aluno pode estar vinculado a mais de uma oficina, portanto, todas as oficinas associadas à matrícula do aluno devem ser informadas ao Portal SESI. Sempre que ocorrer uma matrícula no Portal Oficina, o processo será acionado para atualizar as informações da matrícula do aluno com todas as oficinas associadas.

    Serão consideradas apenas as oficinas do tipo Formação Geral e Básica e Interseriado.

    Expandir
    titleDados técnicos
    Expandir
    titlePré cadastro de Pessoa
    HTML
    <div class="post">POST</div>
    

    Deverá ser utilizado antes do envio de uma pessoa (Aluno/Responsável/Docente/Funcionários) para o Portal SESI na intenção de identificar se reaproveita algum cadastro existente ou cria o pré-cadastro retornando o iduser correspondente.

    Tabelas Afetadas: PPESSOA

    Authorization - Basic Auth

    Username <username>

    Token <token>

    Body

    Bloco de código
    languagec#
    titleRaw
    {
    		"idred": 7,
    		"regional": "AC",
    		"codigoExterno": 1234567,
    		"cpf": "862.873.376-05",
    		"nome": "Adriano Duarte Cardoso",
    		"nomeSocial": "",
    		"email": "[email protected]",
    		"dataNascimento": "22-04-2000",
    		"naturalidade": 4110706,
    		"nomeDaMae": "Ivone Duarte Cardoso"
    	},
    MensagemPSESI: {
    		codigo (int, obrigatório),
    		descricao (string, obrigatório)
    }
    RetornoPessoa: {
    		iduser (int, obrigatório)
    }

    Content

    • Idred: Identificador enviado de forma fixa o valor ‘7’.
    • Regional: Estado do cadastro da Coligada.
    • Código Externo: Código da Pessoa.
    • CPF: CPF da pessoa no SGE 
    • Nome: Nome da pessoa no SGE (Campo Obrigatório).

    • Nome social: Nome social da pessoa.
    • E-mail: Endereço de e-mail, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório). 

    Quando Aluno: 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.

    Quando Responsável: E-mail do cadastro de pessoa (PPESSOA.EMAIL) do Responsável é enviado. 

    Quando Professor: 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. 

    Quando Funcionário: E-mail do cadastro de pessoa (PPESSOA.EMAIL) do Funcionário é enviado. 

    • Data de Nascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório).
    • Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
    • Nome da Mae:  Nome da mãe do aluno. ( Obrigatório caso não possua CPF informado).

    Retorno

    Usuário Criado com Sucesso: HTTP Code 201 - Body:  RetornoPessoa

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    idUser

    Body | Json

    Sim

    Identificador do usuário

    Int32


    Usuário Atualizado com Sucesso: HTTP Code 200 - Body:  RetornoPessoa

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    idUser

    Body | Json

    Sim

    Identificador do usuário

    Int32


    Possíveis retorno de erro:

    Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Regra não atendida: HTTP Code 400 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Erro geral: HTTP Code 50x - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Importante: Caso já tenhamos o idUser para o Cadastro de Pessoa utilizaremos o que já tivermos gravado e não chamaremos a API de Pré-Cadastro da Pessoa.

    Expandir
    titleIntegração de Aluno / responsável
    HTML
    <div class="post">POST</div>
    

    Deverá ser utilizado o iduser retornado no serviço PessoaSGE para efetivar o cadastro do aluno informando o correspondente a pessoa do aluno e o correspondente ao Responsável, os quais serão enviados todos seus dados pertinentes, mesmo que se repitam alguns nesta primeira interação de criação de aluno.

    Tabelas Afetadas: SALUNO, PPESSOA

    Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

    Authorization - Basic Auth

    Username <username>

    Token <token>

    Body

    Bloco de código
    languagec#
    titleRaw
    {
    		"iduser": 9999999,
    		"idred": 7,
    		"regional": "MG",
    		"codigoExterno": 7654321,
    		"dadosCadastrais": {
    			"nome": "Rafaela Ribeiro Bravo",
    			"nomeSocial": "",
    			"email": "[email protected]",
    			"codigoExterno": 7654321,
    			"codUsuario": "14139508922",
    			"cpf": "141.395.089-22",
    			"senha": "MDQxMTE5zY=",
    			"emailcomplementar": null,
    			"sexo": "feminino",
    			"dataNascimento": "05-11-2010",
    			"idRaca": "2",
    			"raca": "Branca",
    			"naturalidade": 4124103,
    			"nomeDaMae": "Wanda Ribeiro Bravo"
    		},
    		responsavel: {
      		"iduser": 8888888,
      		"nome": "Wanda Ribeiro Bravo",
    		"nomeSocial": "",
      		"cpf": "187.685.859-18",
      		"codUsuario": "18768585918",
      		"email": "[email protected]",
     		"sexo": "feminino",
      		"codigoExterno": 7654321,
     		"senha": "MDQxMTE5zY=",
      		"dataNascimento": "05-11-1970",
    		"idRaca": "2",
    		"raca": "Branca",
    		"naturalidade": 4124103,
    		"nomeDaMae": "Sônia Maria Bravo"
    	}
    }
    
    

    Content

    • Iduser: Identificador da Pessoa Recuperado pelo serviço de Pré-Cadastro da Pessoa, do Portal SESI.
    • Idred: Identificador enviado de forma fixa o valor ‘7’.
    • Regional: Estado do cadastro da Coligada.
    • Código Externo: Código da Pessoa.
    • Nome: Nome do Aluno no SGE (Campo Obrigatório).

    • Nome social: Nome social do cadastro
    • E-mail: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório);
    • Código do usuário: Código do usuário no SGE.
    • CPF: CPF do Aluno no SGE 
    • Senha: Senha do usuário no SGE
    • E-mail complementar: Caso o e-mail O365 (SALUNOCOMPL.EMAILO365) esteja preenchido o e-mail do cadastro de pessoa (PPESSOA.EMAIL) do aluno é enviado como e-mail complementar, do contrário nenhum e-mail é enviado como complementar.
    • Sexo: Correspondendo a 'Feminino' I 'Masculino' (Campo Obrigatório);
    • Data de Nascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório).
    • Raça: Identificador da raça
    • Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
    • Nome da Mae:  Nome da mãe do aluno. ( Obrigatório caso não possua CPF informado).
    • Email: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa.

    Retorno

    Aluno Criado com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador da mensagem

    Int32

    descricao

    Body | Json

    Sim

    Descrição da mensagem

    String


    Aluno Atualizado com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador da mensagem

    Int32

    descricao

    Body | Json

    Sim

    Descrição da mensagem

    String


    Possíveis retorno de erro:

    Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Regra não atendida: HTTP Code 400 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Erro geral: HTTP Code 50x - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Importante: Caso já tenhamos enviado com o Aluno com Sucesso, será utilizado o serviço de Atualização do Aluno.


    Expandir
    titleAtualização do aluno
    HTML
    <div class="put">PUT</div>
    

    Body

    Bloco de código
    languagec#
    titleRaw
    {
    		"iduser": 9999999,
    		"idred": 7,
    		"regional": "MG",
    		"codigoExterno": 7654321,
    		"dadosCadastrais": {
    			"nome": "Rafaela Ribeiro Bravo",
    			"nomeSocial": "RAFAEL",
    			"email": "[email protected]",
    			"codigoExterno": 7654321,
    			"codUsuario": "14139508922",
    			"cpf": "141.395.089-22",
    			"senha": "MDQxMTE5zY=",
    			"emailcomplementar": null,
    			"sexo": "feminino",
    			"dataNascimento": "05-11-2010",
    			"idRaca": "2",
    			"raca": "Branca",
    			"naturalidade": 4124103,
    			"nomeDaMae": "Wanda Ribeiro Bravo"
    		},
    		responsavel: {
      		"iduser": 8888888,
      		"nome": "Wanda Ribeiro Bravo",
    		"nomeSocial": "",
      		"cpf": "187.685.859-18",
      		"codUsuario": "18768585918",
      		"email": "[email protected]",
     		"sexo": "feminino",
      		"codigoExterno": 7654321,
     		"senha": "MDQxMTE5zY=",
      		"dataNascimento": "05-11-1970",
    		"idRaca": "2",
    		"raca": "Branca",
    		"naturalidade": 4124103,
    		"nomeDaMae": "Sônia Maria Bravo"
    	}
    }
    Expandir
    titleDocente
    HTML
    <div class="post">POST</div>
    

    Deverá ser utilizado o iduser retornado no serviço PessoaSGE para efetivar o cadastro do docente informando o correspondente a pessoa do docente, o qual será enviado todos seus dados pertinentes, mesmo que se repitam alguns nesta primeira interação de criação de docente.

    Tabelas Afetadas: SALUNO, PPESSOA

    Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Professores

    Authorization - Basic Auth

    Username <username>

    Token <token>

    Body

    Bloco de código
    languagec#
    titleRaw
    {
    		"iduser": 10012345,
    		"idred": 7,
    		"regional": "MG",
    		"statusgeral": 1,
    		"codigoExterno": 1919191,
    		"escolas": [
    			{
    				"codigoIntegrador": "1234567",
    				"ativo": 1
    			}
    		],
    		"dadosCadastrais": {
    			"nome": "Tiago Silva Salles",
    			"nomeSocial": "",
    			"email": "[email protected]",
    			"codigoExterno": 1919191,
    			"codUsuario": "36718678171",
    			"cpf": "367.186.781-71",
    			"senha": "MTIzNffNzg=",
    			"emailcomplementar": null,
    			"sexo": "masculino",
    			"dataNascimento": "01-10-1978",
    			"idRaca": "10",
    			"raca": "Não declarado",
    			"naturalidade": 4124400,
    			"nomeDaMae": ""
    		}
      

    Content

    • Iduser: Identificador da Pessoa Recuperado pelo serviço de Pré-Cadastro da Pessoa, do Portal SESI.
    • Idred: Identificador enviado de forma fixa o valor ‘7’.
    • Regional: Estado do cadastro da Coligada.
    • Código integrador: Cadastro de Filial (DFILIAL.CAMPOLIVRE1)
    • Ativo: Correspondente ao status do usuario no SGE (Verificamos o GUSUARIO.STATUS para definição de Ativo (1) e Inativo(0).
    • Código Externo: Código da Pessoa.
    • Nome: Nome do professor no SGE (Campo Obrigatório).

    • Nome social: Nome social do cadastro
    • E-mail: Endereço de e-mail do professor, que será gravado no campo do cadastro da Pessoa. (Campo Obrigatório). 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.
    • Código do usuário: Código do usuário no SGE.
    • CPF: CPF do professor no SGE 
    • Senha: Senha do usuário no SGE
    • E-mail complementar: 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.
    • Sexo: Correspondendo a 'Feminino' I 'Masculino' (Campo Obrigatório);
    • Data de Nascimento: Data de Nascimento do professor no SGE (Campo Obrigatório).
    • Raça: Identificador da raça
    • Naturalidade: Naturalidade do professor no SGE (Campo Obrigatório).  (DCODIFICACAOMUNICIPIO.CODIGO: Quando preenchido pelo cadastro de Município enviaremos: Código do IBGE recuperado pela Codificação de Município da Classificação correspondente ao IBGE, informado nos parâmetros. Caso esteja preenchido por texto enviaremos de forma fixa “1000001”).
    • Nome da Mae:  Nome da mãe do professor. ( Obrigatório caso não possua CPF informado).
    • Email: Endereço de e-mail do professor, que será gravado no campo do cadastro da Pessoa.

    Retorno

    Docente Criado com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador da mensagem

    Int32

    descricao

    Body | Json

    Sim

    Descrição da mensagem

    String


    Docente Atualizado com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador da mensagem

    Int32

    descricao

    Body | Json

    Sim

    Descrição da mensagem

    String


    Possíveis retorno de erro:

    Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Regra não atendida: HTTP Code 403 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Erro geral: HTTP Code 50x - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Importante: Caso já tenhamos enviado com o Docente com Sucesso, será utilizado o serviço de Atualização do Docente.



    Expandir
    titleAtualização do Docente
    HTML
    <div class="put">PUT</div>
    

    Body

    Bloco de código
    languagec#
    titleRaw
    {
    		"iduser": 10012345,
    		"idred": 7,
    		"regional": "MG",
    		"statusgeral": 1,
    		"codigoExterno": 1919191,
    		"escolas": [
    			{
    				"codigoIntegrador": "1234567",
    				"ativo": 1
    			}
    		],
    		"dadosCadastrais": {
    			"nome": "Tiago Silva Salles",
    			"nomeSocial": "",
    			"email": "[email protected]",
    			"codigoExterno": 1919191,
    			"codUsuario": "36718678171",
    			"cpf": "367.186.781-71",
    			"senha": "MTIzNffNzg=",
    			"emailcomplementar": [email protected],
    			"sexo": "masculino",
    			"dataNascimento": "01-10-1978",
    			"idRaca": "10",
    			"raca": "Não declarado",
    			"naturalidade": 4124400,
    			"nomeDaMae": ""
    		}
    Expandir
    titleTurma
    HTML
    <div class="put">PUT</div>
    

    Deverá ser enviado as Turmas e Turmas/Disciplina Criando ou Atualizando - Sendo que na criação a chave é o conjunto idred|regional|turno|segmento|serie|turma e para atualização utilizar o idturma (a ser retornado pela API).

    Tabelas Afetadas: STURMA , STURMADISC

    Authorization - Basic Auth

    Username <username>

    Token <token>

    Body

    Bloco de código
    languagec#
    titleRaw
    {
    		"idturma": "223344EMNEM-M-3C/2024",
    		"idred": 7,
    		"regional": "MG",
    		"codigoIntegrador": "1234567",
    		"turno": 1,
    		"segmento": "18",
    		"dataInicio": "29-01-2024",
    		"dataFim": "11-12-2024",
    		"serie": "3",
    		"codTurma": "EMNEM-M-3C/2024",
    		"itinerario": {
    			"itinerario": "56"
    			"grupo": "55"
    		},
    		"turmaDisciplina": [
    			{
    				"idTurmaDisc": 86537,
    				"disciplina": "9",
    				"area": "5"
    			},
    			{
    				"idTurmaDisc": 86538,
    				"disciplina": "11",
    				"area": "5"
    			},
    			{
    				"idTurmaDisc": 86539,
    				"disciplina": "10",
    				"area": "5"
    			},
    			{
    				"idTurmaDisc": 86540,
    				"disciplina": "6",
    				"area": "20"
    			},
    			{
    				"idTurmaDisc": 86541,
    				"disciplina": "2",
    				"area": "20"
    			},
    			{
    				"idTurmaDisc": 86542,
    				"disciplina": "1",
    				"area": "10"
    			},
    			{
    				"idTurmaDisc": 86549,
    				"disciplina": "183",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86550,
    				"disciplina": "187",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86551,
    				"disciplina": "8",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86552,
    				"disciplina": "188",
    				"area": "10"
    			},
    			{
    				"idTurmaDisc": 90266,
    				"disciplina": "",
    				"area": "5"
    			},
    			{
    				"idTurmaDisc": 86543,
    				"disciplina": "3",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86544,
    				"disciplina": "24",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86545,
    				"disciplina": "25",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86546,
    				"disciplina": "77",
    				"area": "20"
    			},
    			{
    				"idTurmaDisc": 86547,
    				"disciplina": "184",
    				"area": "15"
    			},
    			{
    				"idTurmaDisc": 86548,
    				"disciplina": "186",
    				"area": "10"
    			}
    		]
    	}

    Content

    • Id. Turma: Identificador enviado de forma fixa o valor ‘7’.
    • Idred: Identificador enviado de forma fixa o valor ‘7’.
    • Regional: Estado do cadastro da Coligada.
    • Código integrador: Cadastro de Filial (DFILIAL.CAMPOLIVRE1).
    • Turno: Correspondendo à 'Manhã' | 'Noite' | 'Tarde' | 'Integral'.
    • Segmento: De/Para de Segmento correspondente ao Campo.
    • Data início: Data de Inicial da Turma formatado em “dd-MM-yyyy”.
    • Data fim: Data de Final da Turma formatado em “dd-MM-yyyy”.
    • Serie: De/Para de Serie correspondente ao Campo.
    • Código da turma: Código da Turma.
    • Grupo: De/Para de Área do Itinerário da Turma correspondente ao Campo.
    • Itinerário: De/Para de Itinerário correspondente ao Campo.
    • Id. Turmadisc: identificador da Turma/Disciplina.
    • Área: De/Para de Área - Grupo de Complemento correspondente ao Campo.

    Retorno

    Turma Atualizada com Sucesso: HTTP Code 200 - Body:  MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador da mensagem

    Int32

    descricao

    Body | Json

    Sim

    Descrição da mensagem

    String


    Turma Criada com Sucesso: HTTP Code 201 - Body:  MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador da mensagem

    Int32

    descricao

    Body | Json

    Sim

    Descrição da mensagem

    String


    Possíveis retorno de erro:

    Autenticação Inválida: HTTP Code 401 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Regra não atendida: HTTP Code 403 - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Erro geral: HTTP Code 50x - Body: MensagemPSESI

    Campo de Dados

    Tipo

    Obrig

    Descrição

    Schema

    codigo

    Body | Json

    Sim

    Identificador do erro

    Int32

    descricao

    Body | Json

    Sim

    Descrição do Erro

    string


    Importante: Todas as Turmas pertinentes a integração com Portal SESI educação que tiverem ao menos um aluno matriculado ou professor em turma/disciplina serão enviadas por completo.

    HTML
    <style>
    	.expand-control {
        	cursor: pointer;
        	text-decoration: none;
    	    margin-bottom: 10px;
    	    background-color: #ededed;
    	    height: 30px;
    	    font-size: 14px;
    	    padding: 5px;
    	}
    	.expand-control-text {
        	vertical-align: top;
    	    font-weight: bold;
    		color: #242424;
    	}
    	.post {
        	background-color: #378000;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.get {
        	background-color: #004fd6;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.put {
        	background-color: #ffa200;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.delete {
        	background-color: #cf0000;
    	    color: #ffffff;
    	    display: inline-block;
    	    padding: 5px;
    	    border-radius: 5px;
    		font-weight: bold;
    	}
    	.endereco{
    		display: inline-block;
    		padding: 5px;
    		font-weight: bold;
    	}
    </style>
    <!-- 
    EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
    <div class="post">POST</div>
    <div class="get">GET</div>
    <div class="put">PUT</div>
    <div class="delete">DELETE</div>
    
    O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
    <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
    -->
    Informações
    iconfalse
    titleOficinas
    Toggle Cloak
    Extra

    CloakfalseO Portal SESI Educação utiliza do Web Service de Consultas da Lib DN, onde é possível realizar execução de consultas TOTVS via Web API. A Documentação deste serviço pode ser acessada Informações
    iconfalse

    Toggle Cloak
    Extra

    CloakfalseO Portal SESI Educação utiliza do Web Service de Consultas da Lib DN, onde é possível realizar execução de consultas TOTVS via Web API. A Documentação deste serviço pode ser acessada Informações
    iconfalse

    Toggle Cloak
    FAQ [Novo!]

    CloakfalseForam exportados alunos matriculados em períodos letivos passados

    Verificar se os períodos letivos passados estão encerrados.

    Não aparece o anexo Instituição do MEC no anexo Dados Educacionais do cadastro de filiais

    Configurar os parâmetros do Censo para utilizar a Instituição do MEC por filial conforme a documentação. Para maiores detalhes consulte a documentação desse procedimento no TDN.

    Aluno fica com status Inativo no portal Sesi após exportação pelo SGE

    Alterar o status do usuário do aluno para Ativo no SGE e reenviar os dados para portal Sesi.

    Erro 500 ao testar API de integração

     Solicitar ao cliente alterar a tag CustomErros para Off no web.config (FrameHTML) e reiniciar o site IIS

     Realizar uma nova request e verificar a mensagem de erro retornada.

     Se houver erro de autenticação verificar se o alias configurado no web.config (FrameHTML) está correto.

     Verificar se a tag owin:AutomaticAppStartup está com o valor "true".

    Processo da customização apresenta erro de execução sem mensagem de retorno.

    Verificar pelo monitor de processos qual é o servidor que está executando o processos. A customização deve estar instalada nesse servidor.

    Diretor associado a filial não aparece na lista lookup no Cadastro de Perfis do Portal Sesi

    O cadastro diretor deve ser realizado através do anexo Dados Educacionais/Instituição do MEC no menu Diretores por instituição disponível no cadastro de Filiais. 

    Caso seja pelo menu Censo do módulo Educacional não será realizada a associação entre pessoa e filial e não listado no lookup.

    Mensagem - String or Binary Data Would Be Truncated  ao exportar aluno

    O problema foi corrigido a partir da versão 12.1.32.119 da customização  (download no link  https://tdn.totvs.com/x/Nv3qK)

    Verificar junto com o suporte de CNI ou Educar Brasil se o token de integração para validação de e-mail é válido.

     Se o banco for SQL Server e estiver na versão 2019 ou superior solicitar ao cliente rodar o seguinte comando na base de dados:

        DBCC TRACEON(460,-1).    Após a execução do comando pelo cliente, realizar o reenvio do registro para integração e analisar o erro com a mensagem retornada.

     Verificar se existe bloqueio na rede (firewall) para a acesso o Quick E-Mail Verification (Aba Validação de E-Mail no parâmetros da integração)

    Usuário não informado - 601 Autenticação Inválida

    Verificar com o pessoal da Educar Brasil se os dados de acesso ao Portal Sesi estão corretos (Usuario, Token, URL)

    Ao fazer login no Portal do Aluno no ambiente de homologação o usuário é redirecionado para o ambiente de produção

    Alterar as referencias ao portal do aluno nas configuração dos módulo educacional (SGE) de homologação. Para maiores detalhes consulte a documentação desse procedimento no TDN.

    Erro na validação de email. Motivo: Not found

    Verificar junto com o suporte de CNI ou Educar Brasil se o token de integração para validação de e-mail é válido.

    E-mail já utilizado

    Verifique se o email cadastrado é um email válido.

    Deve-se verificar se o e-mail informado já está sendo utilizado por outro usuário no SGE e/ou Portal SESI (é premissa que o e-mail seja de uso pessoal);

    E-mail não preenchido

    Verificar se o usuário a ser exportado possui e-mail válido

    Erros de Log - Erro na validação de email. Motivo: Low credit. Payment required

    Erro: [INTEDUCARBRASIL] Erro na validação de email. Motivo: Payment required{"success":"false","message":"Low credit. Payment required" 

    Verificar junto com o suporte de CNI se o token de integração para validação de e-mail é válido.

    Erros de Log - Erro: Responsável não enviado

    O responsável acadêmico do aluno menor de 18 anos está sem usuário cadastrado, será necessário gerar o usuário para o responsável acadêmico.

    Erros de Log - Erro: CPF do responsável não informado

    Falta informar o CPF do responsável acadêmico.

    Erros de Log - Erro: CPF inválido

    Necessário preencher o campo CPF do aluno.

    Erros de Log - Erro: E-mail Complementar inválido

    O email do aluno [pessoa.email] é invalido, necessário deixar o campo em branco ou informar um e-mail válido.

    Erros de Log - Erro: E-mail Complementar já cadastrado

    Verificar no Portal SESI Educação quais usuário estão com o mesmo e-mail cadastrado e proceder com o ajuste do cadastro do e-mail, ou vários alunos e responsáveis com o mesmo e-mail cadastrado.

    Erros de Log - Erro: E-mail do responsável não preenchido

    Necessário preencher o campo de e-mail do responsável acadêmico.

    Erros de Log - Erro: E-mail do responsável não pode ser igual ao e-mail do aluno

    O e-mail do aluno e responsáveis devem ser distintos, necessário ajustar os cadastros.

    Erros de Log - Erro: E-mail existente

    Hipótese 1:  E-mail está sendo utilizado por mais de um usuário no SGE (o caso mais comum é com o e-mail do responsável acadêmico)
     

    Passo 1: O interlocutor do SGE deve consultar o e-mail no banco do SGE e verificar a qual usuário de fato o e-mail pertence;

    • Se o usuário (dono do e-mail) estiver sincronizado com o seu e-mail:  

    O interlocutor deve corrigir o cadastro do usuário que apresentou erro por estar utilizando um e-mail já existente (deve inserir um e-mail válido e exclusivo para o usuário) e reenviar; 

    • Se o e-mail estiver sendo utilizado por um usuário que está sincronizado, mas que não é o dono do e-mail:  

    O interlocutor deve, primeiro, corrigir o cadastro do usuário (retirando o e-mail que pertence a outra pessoa) e reenviar o usuário com o seu e-mail para atualização no Portal SESI.

    Em seguida, deve-se reencaminhar o usuário que apresentou o erro “E-mail existente” (uma vez que o seu e-mail não está mais sendo utilizado por outra pessoa).  

    • Usuários do SGE que não estão sendo sincronizados ao Portal SESI, por utilizarem o mesmo e-mail:  

    Deve-se alterar os cadastros (com e-mail válido e exclusivo para cada usuário) e reencaminhar estes usuários ao Portal SESI.

    • Se o e-mail não estiver vinculado com mais de um usuário no SGE, seguir a Hipótese 2.

    Hipótese 2:  E-mail sendo utilizado por mais de um usuário no Portal SESI (a mensagem “e-mail existente” pode ser que o e-mail já está sendo utilizado por um usuário ativo ou inativo no Portal SESI).

    Para essa situação, será necessário realizar a abertura de uma demanda no Suporte do Portal Sesi Educação 

    Caso o problema não for resolvido, após as tratativas com o suporte do Portal Sesi, o interlocutor do regional deve marcar em cópia a equipe do SESI/DN (naguiar@naguiar@cni.com.br, [email protected] e [email protected])

    Erros de Log - Erro: Nome do responsável não informado

    Aluno sem responsável acadêmico cadastrado, necessário incluir no cadastro.

    Erros de Log - Erro: Senha do responsável não enviada

    Necessário gerar a senha do responsável acadêmico.

    Erros de Log - Erro: O e-mail informado para o aluno não é válido ou não está preenchido

    E-mail do aluno é invalido.

    Erros de Log - Erro: O e-mail informado para o responsável acadêmico não possui uma caixa de e-mail

    E-mail do responsável acadêmico é invalido.

    Erros de Log - Erro: Desculpe. Ocorreu um erro no consumo do webservice do Portal SESI Educação

    Erro: {PortalSesi} - Desculpe. Ocorreu um erro no consumo do webservice do Portal SESI Educação que impediu a integração. ERRO : {0} The remote server returned an error:(404) Not Found. 

    Reenviar o registros com erro, caso o erro persista será necessário verificar a disponibilidade e a conectividade do servidores do Totvs RM com os webservice de integração do Portal SESI Educação.