Páginas filhas
  • Manual Operacional da Customização - Integração Loja Click SESI/SENAI

Projeto: FS008733 - Integração SGE x Loja Click SESI/SENAI

Nome do cliente: FIEP


Objetivo

O objetivo deste documento de especificação é descrever as funcionalidades que serão desenvolvidas para possibilitar a Integração do TOTVS Educacional (SGE) x Loja Click SESI/SENAI.


Público Alvo
Este manual é destinado aos colaboradores selecionados como multiplicadores e usuários-chave para o Programa SGE.


Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Loja Click SESI/SENAI.  Disponível em: Serviços Globais | Perfil | Educacional | Customização | Integração Loja Click

Para mais detalhes de como liberar no perfil dos usuários, acesse o Manual de Instalação de Customizações na seção Liberando Acesso aos Menus.

Detalhamento do processo

O objetivo deste processo é detalhar como o TOTVS Educacional (SGE) realizará a integração com a Loja Click de acordo com os Dados de Integração, Dados de Situação de Matrícula e Parâmetros Gerais.

Para isso foi criada uma parametrização onde o usuário definirá os valores utilizados pela integração; A interface customizada estará disponível em: TOTVS Educacional | Customizações | Integração Loja Click| Parâmetros.

Ao clicar no menu de acesso será aberta a tela de parâmetros que possui três abas de configurações: Dados de Integração, Dados de Situação de Matrícula e Parâmetros Gerais, conforme descrição abaixo. 

Na Aba Dados de Integração, deve ser informado os dados:

Estes parâmetros deverão ser armazenados de forma Global

  • Endereço Webservice Broker: Neste parâmetro o usuário deverá informar o endereço de acesso ao Webservice disponibilizado pelo  Broker.
  • Usuário Token: Neste parâmetro o usuário deverá informar o token de acesso ao Webservice disponibilizado pelo Broker.


Na Aba  Dados de Situação de Matrícula, deve ser informado os dados: 

Estes parâmetros deverão ser armazenados por Nível de Ensino e valerá para todas as filiais.

  • Status de Pré Matrícula: será do tipo lookup e o usuário deverá selecionar um item do cadastro de situação de matrícula ex: (Pré Matriculado) que será utilizado no momento da importação de matrícula da Loja Click SESI/SENAI para o TOTVS Educacional (SGE).
  • Status de Matrícula: será do tipo lookup e o usuário deverá selecionar um item do cadastro de situação de matrícula ex: (Matriculado) que será utilizado no momento da efetivação do contrato no ERP, para o TOTVS Educacional (SGE) enviar para o Broker a confirmação de matrícula.


Na Aba Parâmetros Gerais, deve ser informado os dados: 

Estes parâmetros deverão ser armazenados por Coligada.

  • Campo Usuário da Integração: Será do tipo lookup e ficará a cargo do usuário informar o código do  usuário padrão loja, que será criado pela FIEP, para identificar o cadastro oriundos da Loja Click SESI/SENAI, que  deverão ser enviados ao TOTVS Educacional (SGE).
  • Campo - Número tentativas de reenvio: Neste campo o usuário deverá informar o número máximo de tentativas que a customização deverá tentar realizar a Efetivação do Contrato ERP dos registros com status de erro.

Fluxo do processo

Neste processo será detalhado como as informações de matrículas (vendas) de alunos realizadas na Loja Click SESI/SENAI, serão importadas para o TOTVS Educacional (SGE) como Matrículas.


Detalhamento do processo

Para que o registro de matrícula do aluno seja criado no TOTVS  Educacional (SGE), a Loja Click SESI/SENAI deverá enviar os dados necessários, para efetivação da matrícula.

Observação: Será de responsabilidade da FIEP informar para o E-Commerce os dados de oferta de turmas que precisam ser cadastrados na loja.

Após receber os dados, será executada a funcionalidade nativa do TOTVS Educacional (SGE), para  efetuar a criação do registro de matrícula do aluno, sendo validadas todas as regras de negócio padrão do SGE. Os serviços deverão preencher os seguintes anexos: Curso/Habilitação,  Matrícula no Período letivo, Matrícula nas Disciplinas, realizar a efetivação do pré-contrato e vínculo do aluno no TOTVS Educacional (SGE) para o ERP. 

Após receber os dados de venda da Loja, será executada a funcionalidade nativa do TOTVS Educacional (SGE), para  efetuar a criação do registro de matrícula do aluno, sendo validadas todas as regras de negócio padrão do SGE, para matricular o aluno para a mesma Unidade e Nível de Ensino enviada pela Loja Click SESI/SENAI, nas situações abaixo.

Será executada as seguintes operações, conforme detalhado na documentação da API.

  • Cadastrar Dados Básicos do Responsável Financeiro
  • Cadastrar Dados Básicos do Aluno
  • Preencher Dados de Matrícula
      • Matricular no Curso/Habilitação (SENAI/IEL)
      • Matricular no Período Letivo (SENAI/IEL/SESI)
      • Matricular em Disciplinas (SENAI/IEL/SESI) - Todas as disciplinas da matriz aplicada da turma no período letivo (semestre)  enviado.
      • Gerar Pré Contrato CRM
      • Efetivar Pré Contrato ERP
  • Atualização de Dados do Aluno Loja CLICK SESI/SENAI 

Ao ser executado o processo de Importação de Matrícula a customização deverá efetivar a matrícula dos alunos, realizando as seguintes regras de validação, nas situações abaixo:

  1. Se for um aluno novo no curso, deverão ser efetuados os três passos acima: matricular no curso/habilitação, período letivo e matrícula em  disciplinas.
  2. Se for um aluno que está retornando para o mesmo curso (matrícula de retorno), em outro período letivo (vigente), ele será matriculado no novo período letivo e matrícula em disciplinas. 
  3. Se o aluno já tiver realizado o curso/habilitação no mesmo período letivo, será realizada apenas a matrícula em disciplinas. 

Para o SESI, não se aplica a matrícula no curso/habilitação, matricula-se diretamente no período letivo, incluindo o curso, série e disciplinas.

O envio dos alunos e matrículas para o Moodle ocorrerão pela integração existente entre SGE e Moodle. A partir do momento que a matrícula do aluno for realizada no TOTVS Educacional (SGE), os alunos  serão tratados da mesma forma como tratamos os registros originados do SGE e enviados para o Moodle respeitando as parametrizações da customização atual.

Não está previsto neste escopo tratamento do envio dos alunos e matrículas diretamente da loja para o Moodle. 

Para cada matrícula/venda enviada será necessário realizar toda integração de matrícula e efetivação de contrato no SGE.

Ao final da integração, a API criada retornará ao Broker avisando que a matrícula ocorreu com sucesso ou erro, os registros serão gravados em tabela customizada de log,

Descrição do processo

Este requisito detalha a funcionalidade de Monitor de Logs da Integração.

Detalhamento do processo

Nesta interface o usuário poderá consultar os LOGs das operações de exportação executadas pela integração do TOTVS Educacional com a Loja Click.
Os históricos das exportações de dados para a Loja FIEP serão registrados e poderão ser visualizadas no menu TOTVS Educacional | Customização | Integração Loja Click| Monitor de Log.



Será apresentada ao usuário uma visão com a relação de registros importados e exportados.

  • Id Log: Identificador sequencial de Log.
  • Campos Chave: Descrição dos campos utilizados para gerar o registro integrado.
  • Valores Chave: Chave primária do registro integrado.
  • Status: Situação da Integração (Sucesso ou Erro).
  • Funcionalidade: Tipo de Processo que está sendo feito.
  • Módulo: Tipo da integração que está sendo feita.
  • Data de Criação: Data de Criação do registro.
  • Data da última alteração: Data da última alteração do registro.



Ao acessar o anexo de um registro será possível o usuário visualizar todos os registros relacionados ao cadastro integrado selecionando a opção Item de Log. Estarão disponíveis os seguintes campos:

  • Id. Item Log: Identificador sequencial de log.
  • Id. Log: Identificador sequencial de log.
  • Mensagem: Mensagem com o status da integração do item.
  • Status: Situação da integração do item selecionado.
  • Dados Enviados: Relação dos dados enviados para integração.
  • Dados Recebidos: Relação dos dados recebidos.
  • Data de Criação: Data de criação do registro.
  • Data da última Alteração: Data da última alteração do registro.


Não será possível incluir, editar ou excluir informações através dessa interface.

Os dados informados nesta interface serão armazenados em tabela customizada por coligada.

Pré-requisitos

O processo customizado para reprocessamento de dados irá ocorrer apenas para a funcionalidade de Efetivação de Contrato em caso de erro ou indisponibilidade do ERP para a API do SGE.

Detalhamento do processo

O processo estará disponível na interface de Monitor de Log no menu: Processos | Reprocessamento de Dados. Que ao ser executado tentará realizar a exportação do registro novamente, armazenando o novo retorno. 

Será permitido o usuário selecionar apenas registros da funcionalidade de Efetivação de Contrato ERP, quando o mesmo estiver com o status de (Cancelado, Erro ou Pendente) e poderá ser executado manualmente. Ou caso o usuário não selecione nenhum registro na visão do Monitor de Logs, ele poderá executar ou agendar o reenvio, o processo processará todos os registros de Efetivação de Contrato com os status Erro ou Pendente. Para as demais funcionalidades o processo customizado não irá reprocessar os dados, uma vez que os mesmos serão executados novamente pelo Broker.

Ao ser acionado o processo customizado de reprocessamento de dados da Efetivação do Contrato ERP, a customização tentará realizar novamente o envio das informações ao ERP, caso consiga o status do registro passará para (Sucesso) e avisará ao Broker através de uma API que a efetivação do contrato foi realizada com sucesso.

O processo de reenvio automático será executado até atingir o número máximo de tentativas parametrizado. Caso o parâmetro esteja vazio a customização não realizará nenhuma tentativa de reenvio automaticamente. 

Caso seja atingido o número máximo de tentativas de reenvio e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado, sendo o registro não integrado com o ERP.  

Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio. 

O reenvio será realizado conforme regras definidas no requisito da funcionalidade de Efetivação de Contrato ERP.