Manual Operacional - Integração VTEX - Envio de Matrícula para ACE
Projeto:
- FS009084 - Integração VTEX - Envio de Matrícula para ACE
- FS009162 - Integração VTEX - Ajuste de Matrícula Após Início da Turma
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.
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
- 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.
- Qtd. de dias após o inicio da disciplina em andamento: Indica a quantidade de dias limite para que o aluno seja matriculado na turma/disciplina que está em andamento. Essa quantidade será calculada com base na data inicial da turma/disciplina, determinando se o aluno poderá ou não se matricular na disciplina.
Importante
Para o correto funcionamento da customização, todos os dados deverão ser parametrizados corretamente.
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.
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.
Ajuste de Matrícula Após Início da Turma
Durante a execução do processo de Exportação de Contratos VTEX para ACE o processo irá considerar as matrículas que foram efetivadas pelo portal do processo seletivo (VTEX) e fazer o seguinte ajuste:
- O processamento identifica as turmas iniciadas e verifica as datas iniciais e finais das turmas/disciplinas.
- Para a turma disciplina onde a pré-matrícula foi realizada após a data de início da turma/disciplina, a disciplina referente à essa turma/disciplina será excluída na matrícula do aluno e o valor do contrato será recalculado considerando apenas as disciplinas matriculadas (mantidas na grade do aluno).
Detalhamento da Regra de Exclusão das Disciplinas
- Se a data da matrícula for menor que a data de início da turma (turma não iniciada), o processo irá seguir conforme escopo FS009084 - Integração VTEX - Envio de Matrícula para ACE sem a exclusão das disciplinas.
- Se a data da matrícula for maior que a da turma (turma iniciada), as disciplinas serão verificadas para remover e recalcular o valor do contrato. Os passos seguintes serão executados:
- Excluir as matrículas nas turmas / disciplinas em que a data de matrícula é maior que a data de início da turma/disciplina somado à quantidade de dias informado no parâmetro, ou se data de matrícula somada à quantidade de dias informado no parâmetro for maior que data final da turma/disciplina.
Recalcular Parcelas Contrato
Durante o processo de envio dos contratos VTEX para o ACE, ajustes são realizados no sistema RM (Ajuste de Matrícula Após Início da Turma). Nesta etapa, o valor do contrato será recalculado com base na carga horária das disciplinas em que o aluno permanecerá pré-matriculado.
O novo valor será proporcional à carga horária das disciplinas da matrícula.
Regra Calculo
A quantidade de parcelas será recalculada de acordo com as seguintes regras:
- A primeira parcela não será alterada, pois corresponde ao valor pago no VTEX.
- A partir da data de matrícula, serão identificadas e excluídas do contrato as parcelas com vencimento anterior ou no mês da matrícula.
- O novo valor será redistribuído entre as parcelas restantes a vencer do contrato.
Após a atualização das parcelas com os novos valores, as alterações serão registradas na tela de Histórico de Parcelas Ajustadas.
Durante a execução do processo de Exportação de Contratos VTEX para ACE e após o ajuste das matrículas em disciplinas que não tem a data válida 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.
Aviso
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).
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).
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.
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.
Atençã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.
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.
Detalhamento do processo
Anexo customizado criado na interface de contratos para registrar o histórico de alteração de parcelas do plano de pagamento do processo seletivo (VTEX), disponível no menu:
TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos | Histórico de Parcelas Ajustadas.
Ao acessar a interface será apresentado os seguintes campos:
- Número da Parcela do contrato.
- Valor original: será exibido o valor das parcelas antes da atualização.
- Valor Atual: será exibido o valor das parcelas após a atualização. Para as parcelas excluídas, será exibido o valor zero.
- Motivo: Poderá ser um dos três:
- Data de vencimento da parcela anterior à data da matrícula,
- Mês de vencimento da parcela igual a data de matrícula ou
- Parcela a vencer com valor reajustado.
- Data da alteração: data em que o contrato foi ajustado através do processo de ajuste de matrícula.
- Usuário execução: Será exibido o usuário que realizou o ajuste de matrículas.
Para cada parcela ajustada do contrato, será gerado um registro nesta interface quando rodar o processo customizado que atualiza as parcelas do plano de pagamento de acordo com a matrícula em disciplinas do aluno.
Importante
Não será permitido a inclusão, edição e/ou exclusão do histórico de atualização, o anexo será preenchido automaticamente pelo processo customizado e estará disponível somente para visualização, através desta interface (visão).
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:
- Exportação de Contratos VTEX para ACE
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas