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 | |||||
---|---|---|---|---|---|
| |||||
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ção
|
Expandir | ||
---|---|---|
| ||
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. |
Expandir | ||
---|---|---|
| ||
Pré-requisitos Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração VTEX (ACE) - Envio Exportação de Matrícula 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 RemovedImage Added 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: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 Added Image Added 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 | ||
---|---|---|
| ||
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:
Será apresentada ao usuário uma visão com a relação de registros exportados.
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:
Foi criada a seguinte funcionalidade no Monitor:
|