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.

...

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


Expandir
titleParametrosParâmetros

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

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

IdentificaçãoImage Removed

Image Added

  • Endereço da API ACE: Campo do tipo texto para usuário informar a URL da API do ACE que será acionada pela customização para fazer a conexão com o ERP.
  • Usuário: Campo do tipo texto para o usuário informa o usuário da autenticação na API do ACE.
  • Senha: Campo do tipo texto para o usuário informa a senha da autenticação na API do ACE.
  • 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
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


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. 


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 VTEX para ACE, a customização acionará uma API do ACE 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. 

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 (DETALHAR APOS REQ 4).

Aviso
titleAviso

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

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

Após envio dos dados para o ACE, ele deverá retornar para o SGE, em caso de sucesso, os dados do contrato gerado. 

Neste momento, a customização deverá: 

  • Alterar a situação de matrícula do aluno para matriculado, conforme status de matrícula definido em: Customização | ERP | Parâmetros | Aba Status de Matriculado.
    • Este processo irá disparar automaticamente o envio para o CRM, que será alterado para enviar também o canal de vendas
  • Incluir o contrato gerado no ERP no Anexo Contrato ERP da matrícula no período letivo (tabela ZCONTRATOAX).


Ao final do processamento, os registros de log serão gravados e disponibilizados no Monitor de log (Educacional > Customização > Integração VTEX (ACE) > Monitor de Log). 

Aviso
titleImportante

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)

Expandir
titleIntegração de Contrato com sistema ERP

Detalhamento do processo

O processo atual de Integração de Contrato ERP foi alterado para tratar as matrículas originadas no Processo Seletivo/VTEX.

Foi criado um novo tipo de contrato chamado “Contrato VTEX”, que ao acionar o processo para uma matrícula do VTEX, o tipo de contrato VTEX será selecionado automaticamente e todos outros tipos e campos ficarão desabilitados na interface

Image Added

Ao clicar em Avançar, a customização irá acionar novamente ou pela primeira vez o processo para enviar as informações do Contrato para o ERP através do ACE, para os os registros que não foram integrados corretamente através do processo "Exportação de Contratos VTEX para ACE (Customização > Integração VTEX (ACE))".

O status da execução (sucesso ou erro) será registrada no Monitor de Log.

Aviso
titleAtenção

Caso o usuário selecione o tipo de contrato "Contrato VTEX" para matriculas que não vieram do VTEX o processo não deixará o usuário avançar para a próxima etapa e mostrará um ícone de erro com a mensagem do motivo.

Image Added


Para todos os demais contratos, que não são originados do VTEX, o processo de efetivação do contrato não sofreram nenhuma alteração.

Expandir
titleEnvio de Alteração de Situação de Matricula para CRM

Detalhamento do processo

Atualmente, quando um aluno tem sua situação de matrícula alterada para Matriculado, a customização de Integração com o CRM envia os dados da matricula do aluno para o CRM.

Este processo foi alterado para, além dos campos enviados, enviar a informação do canal de vendas, do parametro dentro de Customização > Integração VTEX (ACE) > Parâmetros, para o campo SistemasExterno do XML do CRM.

O novo campo só será preenchido para matrículas de compras do VTEX. Para as demais matrículas enviadas para o CRM, o campo ficará em branco.

Aviso
titleImportante

A situação de matrícula do aluno no período letivo pode ser alterada através das interfaces nativas do TOTVS Educacional em dois locais diferentes sendo eles: TOTVS Educacional | Currículo e Oferta |Alunos | Anexos | Matrícula no Período Letivo | Processos | Alterar Situação de Matrícula ou TOTVS Educacional | Matricula Avaliação | Matrícula no Período Letivo | Processos | Alterar Situação de Matrícula.

Além desses pontos, existem outros processos que alteram automaticamente a situação de matrícula do aluno.

Sempre que isso acontecer e a nova situação de matrícula for Matriculado, o processo será acionado.

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


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.

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

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


  • 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