Páginas filhas
  • Manual Operacional - Integração VTEX - Envio de Matrícula para ACE

Versões comparadas

Chave

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

Manual Operacional - Integração VTEX - Envio de Matrícula para ACE

...

Projeto:FS009084 - Integração VTEX - Envio de Matrícula para ACE

Nome do cliente: FIEP


Objetivo

Este manual visa demonstrar as funcionalidades implementadas e as regras aplicadas a elas, para possibilitar a Integração do TOTVS Educacional SGE  VTEX x ACE x ERP. 

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


Expandir
titleParametros

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração VTEX - Envio de Matrícula para ACE.

Disponível em: Serviços Globais | Perfil | Educacional | Customização | Integração VTEX (ACE) | Parâmetros

Image Modified

Após serem liberados nas permissões de perfil dos usuários teremos acesso as customizações no módulo Educacional através do caminho: TOTVS Educacional| Customização | Integração VTEX (ACE) | Parâmetros

Image Modified

Identificação

Image Modified

  • Modelo Contrato: A entrada do tipo lookup é onde se insere o código do Modelo de Contrato (Pessoa Física) a ser utilizado no processo de exportação de contratos da VTEX para o ACE, e no processo de criação de contrato no ERP. Este parâmetro será registrado por Coligada e Nível de Ensino, aplicando-se a todas as filiais.
  • Canal de Vendas: campo do tipo texto (livre digitação) para usuário informar o código que deve ser enviado para o ACE referente ao canal de vendas VTEX (Futuro digital).
  • Número de tentativas de reenvio: campo numérico para o usuário informar o número máximo de tentativas que a customização deverá tentar realizar automaticamente a Exportação de Contratos VTEX para ACE dos registros com status de erro.


Informações
titleImportante

Para o correto funcionamento da customização, todos os dados deverão ser parametrizados corretamente.

Expandir
titleBloqueio de Lançamentos Financeiros VTEX

Detalhamento do processo

O Processo Seletivo VTEX, criado pela FIEP, não permitirá a manipulação da flag nativa Gerar lançamento, encontrada em: TOTVS Educacional | Processo Seletivo | Cadastros | Processo Seletivo/Venda Online de Cursos | Anexos | Área de Interesse Ofertada | Venda Online de Cursos | Financeiro | Gerar Lançamento. Essa opção permanecerá desabilitada, pois uma vez que as matrículas sejam efetivadas na VTEX, não serão gerados lançamentos financeiros durante a inclusão do contrato no SGE. A geração dos lançamentos e a sua baixa ocorrerão posteriormente no ERP, após o envio dos dados por meio da API do ACE.

Image Modified


Expandir
titleExportação de Contratos VTEX para ACE

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração VTEX (ACE) - Exportação de Contratos VTEX para ACE.

Disponível em: Serviços Globais | Perfil | Educacional | Customização | Integração VTEX (ACE) | Exportação de Contratos VTEX para ACE

Image Modified


Detalhamento do processo

Foi criado um processo customizado, disponível em Educacional > Customização > Integração VTEX (ACE) > Exportação de Contratos VTEX para ACE,  para o envio dos contratos de matriculas vindas do VTEX para o ERP através do ACE. 

Image Modified


Image Modified

O processo de compra do curso e pagamento será realizado pelo aluno através da plataforma VTEX. Após concluir o preenchimento dos dados do processo seletivo no portal do SGE, o aluno será automaticamente pré-matriculado no SGE, de acordo com o processo atual de integração do VTEX e seus parâmetros definidos.

Durante a execução do processo de Exportação de Contratos, a customização acionará a nova API do ACE (campos detalhados abaixo) para envio dos dados correspondentes. Após receber os dados de matrícula, o ACE enviará automaticamente para o ERP as informações necessárias para gerar e efetivar o contrato, seus lançamentos e boletos. É de responsabilidade da FIEP disponibilizar essas APIs para integração.

O ERP retornará os dados do contrato criado para o ACE, que deverá retornar para o SGE, na própria requisição, se a efetivação do contrato foi realizada com sucesso ou erro. Neste momento, o SGE deverá criar o contrato (Anexo Contrato ERP/AX) e alterar a situação de matrícula do aluno para Matriculado, conforme detalhado no item HU.04.

Uma mesma venda/pedido no VTEX pode ter mais de um curso associado. Cada curso corresponde a um item do mesmo pedido. As matrículas e os contratos serão gerados no SGE por curso (uma matrícula para cada item do pedido). Portanto, para cada matrícula identificada, será realizado o envio para o ACE (requisição) das informações relacionadas ao item do pedido referente à matrícula. 

Para as vendas originadas de processo seletivo VTEX, é obrigatória a criação de um contrato no SGE, com plano de pagamento (parcela única ou várias parcelas)  para ter o controle das parcelas que deverão ser pagas. Apenas para modalidades do tipo Técnico e Pós-Graduação é permitido mais de uma parcela no plano de pagamento. Para as demais modalidades, será sempre parcela única essa regra é uma premissa do VTEX.

O contrato será criado automaticamente (processo nativo - parametrização processo seletivo) com as respectivas parcelas do plano de pagamento. É possível parametrizar para não gerar automaticamente os lançamentos referentes às parcelas do contrato, já que a FIEP não utiliza o financeiro do SGE (para FIEP, todos os processos seletivos do VTEX terão o parâmetro de geração de lançamentos desabilitado automaticamente - HU.02).

No VTEX, o aluno pode pagar a primeira mensalidade do curso (modalidade Técnico e Pós-Graduação) ou o valor total do curso (demais modalidades). Em ambos os casos, é considerada uma parcela única no VTEX, independentemente da forma de pagamento. Por este cenário, será enviada sempre uma única parcela paga para o ACE, e as parcelas (mensalidades) que precisam ser pagas, quando o curso não foi pago totalmente (modalidade Técnico e Pós-Graduação). 

Para identificação das parcelas pendentes de pagamento, será utilizado contrato gerado pelo processo nativo, associado à matrícula (SCONTRATO). Ele possui todas as parcelas previstas para o aluno, com seus respectivos valores e vencimentos. 

Importante: Será de responsabilidade da FIEP criar os planos de pagamentos para vincular no processo seletivo VTEX e manter as datas de vencimento das parcelas atualizadas conforme necessidade. Esta é uma premissa do processo atual da Integração VTEX e Processo Seletivo. As informações do plano serão disponibilizadas no processo de compra do aluno no VTEX. Deverão ser utilizados os recursos nativos para a gestão dos planos, já que não está prevista nenhuma customização para tratamento de datas de vencimento (no plano ou no envio dos dados para o ACE). 

Os Processos Seletivos com o campo Oferta VTEX desmarcado não serão considerados neste processo. Ao final do processamento, os registros de log serão gravados e disponibilizados no Monitor de log (HU.07).

Não será gerado identificador único do pedido para envio ao ACE. A identificação, se necessária, poderá ser feita através do “Order Id” do pedido do VTEX, que fica armazenado no Monitor de Vendas e será enviado para o ACE através do campo OnlinePaymId.order_id.

Expandir
titleMonitor de Log

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração VTEX - Envio de Matrícula para ACE.

Disponível em: Serviços Globais | Perfil | Educacional | Customização | Integração VTEX (ACE) | Monitor de Log

Image Modified


Detalhamento do processo

Foi criada uma interface de Log para armazenar informações e status dos dados que foram exportados do SGE VTEX para o ACE, referentes a exportação de contrato de matrículas. 

O histórico das exportação de dados para o ACE serão registrados e poderão ser acessados pelo caminho:

  • Menu customização: TOTVS Educacional| Customização | Integração VTEX (ACE) | Monitor de Log.

Image Modified

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

Image Modified

  • Id Log: Identificador sequencial de Log.
  • Data de Criação: Data de Criação do registro.
  • Data da última alteração: Data da última alteração do registro.
  • Status: Situação da Integração (Sucesso ou Erro).
  • Id. Job: Ultimo job executado que resulto criação ou alteração do log.
  • Descrição do módulo: Descrição que permite identificar o módulo.
  • Cód. Filial: Código da Filial associada ao registro.
  • Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação Moodle).
  • Campos Chave: Descrição dos campos utilizados para gerar o registro integrado.
  • Valores Chave: Chave primária do registro integrado.
  • Última mensagem do item de log: Ultima mensagem do item do log.
  • Download de arquivos associados: Permitirá o download de arquivo associado ao logo caso exista.


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:


Image Modified

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


Foi criada a seguinte funcionalidade no Monitor:

  1. Exportação de Contratos VTEX para ACE