Fábrica de Software TOTVS BH

Atalhos

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

Versões comparadas

Versão antiga 58

changes.mady.by.user Vanessa de Sousa Carvalho

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Fernando Costa Ribeiro

Gravado em

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 SGE x Portal SESI . A integração com o TOTVS Educacional Portal SESI é responsável pela exportação dos registrossincronizaçã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.

...

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

...

Expandir
titleParâmetros da Integração
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 


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.



  • 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 já finalizada será considerada na exportação.

Card
labelReconhecimento de Saberes
Table Excerpt
nameparametrosrecsabes

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

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

Gerando...

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

É importante utilizar um usuário exclusivo.

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

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


  • Competências reconhecidas:  Utilizado para alterar a situação das disciplinas certificadas no Reconhecimento de Saberes;
  • Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência Reconhecida automaticamente pelo processo.


  • Competências não reconhecidas: Utilizado para alterar a situação das disciplinas reprovadas no Reconhecimento de Saberes
  • Motivo da alteração: Utilizado no Motivo Alteração, ao alterar a situação de matrícula para situação Competência não Reconhecida automaticamente pelo processo.


  • Matricula no período letivo: Utilizado para alterar a situação da Matrícula no Período Letivo ao receber o retorno do Reconhecimento de Saberes e para identificação da matrícula em itinerário a ser considerada como Matriculado;
  • Motivo de alteração: Utilizado no Motivo Alteração, ao alterar a situação da Matrícula no Período Letivo automaticamente pelo processo.



Card
labelCursos (Segmentos)
Table Excerpt
nameparametroscursos

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


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

Cursos (Segmentos).gif

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.


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

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

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

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


           


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:

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



Aviso

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

Se o usuário do aluno estiver Inativo, o processo customizado já envia para o Portal SESI como Inativo.

Card
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: Endereço de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil;

TOKEN: Token de acesso à API para  consulta de e-mail, disponibilizado pela Educar Brasil.

Intervalo de horas: Este campo será considerado para validar novamente o e-mail na QuickeMail (somente daqueles que  não tenham sido considerados "válidos") respeitando o intervalo de horas definido no parâmetro. 



Card
labelFuncioná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.

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

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

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

  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.

Aviso

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

Card
labelAutenticação SSO
Table Excerpt
nameparametrossso

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

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


Abaixo descrição dos campos para conhecimento:

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

*Arquivo disponibilizado pelo Portal SESI.

...

Expandir
titleProcesso de Exportação

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.


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

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. 
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
  • 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.
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”.
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
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á exportadas.

Verificar as regras de envia 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 email 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


Informações
  • Esse processo poderá ser agendado conforme recurso nativo.
  • O envio acontecerá de forma assíncrona, ou seja, ele não deve bloquear outras operações.; sendo executado em segundo plano. 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.


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


...

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 Modified

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

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

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


 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.


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.

...