Projeto: FS008537 (AACPD0) - Integração VTEX - Informações Financeiras
FS008837 -Integração VTEX - Link de matrícula / Envio de e-mail
Nome do Cliente: Confederação Nacional da Indústria - SENAI
Permitir a integração das vendas realizadas através da plataforma VTEX com o SGE, considerando as parametrizações existentes no Processo Seletivo.
O escopo dispõe das seguintes funcionalidades:
Refletir no SGE todos os pedidos gerados na plataforma VTEX com todos os seus dados de pagamento.
- Vincular as matrículas realizada aos seus pedidos no Monitor de Vendas;
- Gravar os dados de Matrículas Pendentes - SGE (caso tenha ocorrido algum erro durante o processo). Possibilitando assim, que a secretaria entre em contanto com o aluno e finalize a matrícula de forma manual.
- Vincular o pedido gravado no monitor de vendas ao contrato de matrícula de aluno;
- Controle de Matrícula em Turma com Vagas Esgotadas;
- Envio de E-mail - Turmas com Vagas Esgotadas (envio para o responsável do Curso);
- Gerar o Responsável Financeiro e vinculá-lo ao contrato gerado (quando não for o próprio aluno (parâmetro disponível na aba financeiro da área de interesse ofertada do PS);
- Baixar Lançamentos Financeiros (Baixa automática da 1° parcela);
- Reprocessamento de Baixa automática (reprocessar a baixa do lançamento financeiro para os casos de erro no processamento da baixa ao finalizar inscrição/matrícula do aluno.
Importante: Não está previsto neste escopo a adequação das integrações entre SGE e BackOffice (Protheus, Dynamics, etc.).
O regional precisará se adequar para que as informações financeiras sejam enviadas aos BackOffices correspondentes.
Liberação dos Anexos Customizados na Árvore de Perfil:
Os anexos da customização - Integração VTEX devem ser liberados nas permissões de perfil dos usuários para visualização e acesso às funcionalidade.
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.
A Integração VTEX foi desenvolvida com parâmetros customizados para o registro de informações de dados específicos e necessários para a operação.
A interface para configuração desses parâmetros está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX | Parâmetros.
Novo!
Aos Parâmetros da Integração VTEX, foi inserido um novo parâmetro: URL do Processo Seletivo, no qual deverá ser vinculada a URL base do Portal, incluindo a barra no final.
Este registro é essencial para atendimento os Regionais que possuem vários servidores diferentes para o portal.
O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: Parâmetros Gerais.
Atenção
A a URL do Processo seletivo deverá ter essa estrutura sem a / ao final.
Aos Parâmetros da Integração VTEX, na aba: Dados Financeiros, deverão ser vinculadas as formas de pagamento já cadastradas no SGE que serão utilizadas no processo de baixa automática de lançamentos financeiros no TOTVS Educacional.
O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: Dados Financeiros.
Na interface, os parâmetros serão armazenados por contexto (Coligada, Filial e Nível de Ensino), para os quais o usuário deverá efetuar as seguintes parametrizações:
Novo!
Para integração nativa entre RM e Protheus no mesmo momento em que é enviado o meio de pagamento de acordo com a forma de pagamento (boleto, pix, cartão de crédito ou débito), a customização também irá enviar o Motivo da Baixa com os códigos correspondentes informados nos parâmetros. Esta informação não fica armazenada em tabelas do RM, ela é preenchida no momento em que a baixa acontece é enviada diretamente para o Protheus através do XML da integração.
Não foi realizado tratamento para integrações que não sejam a nativa (outros backoffices ou Protheus) .
Nesta aba é possível parametrizar todos os dados necessários para o usuário definir um textão padrão do envio automático de e-mail (para o responsável do curso) , nos casos em que o número de vagas disponíveis para a oferta de curso tenha se esgotado e existam candidatos/inscritos com pendência de matrícula.
O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: E-mail
Campos a serem preenchidos:
O SGE não garante o recebimento do e-mail, já que não é possível saber se o endereço do destinatário existe ou se a caixa está cheia, impedindo o recebimento. Será possível mapear apenas o envio.
Nesta aba, é possível parametrizar todos os dados necessários para o usuário definir um textão padrão do envio automático de e-mail, nos casos em que o aluno que ainda não efetivou sua matrícula e/ou para aqueles que tiveram erro durante o processo de matrícula.
O acesso está disponível em: TOTVS Educacional l Sistema Indústria | Integração VTEX l Parâmetros l Aba: E-mail Link de Matrícula.
Novo!
Foram adicionados dois novos campos para configuração de envio de e-mail:
Exemplo de Agendamento Automático:
O processo está configurado para exportar, a cada duas horas, os dados para VTEX, incluindo o e-mail para aluno com o link de matrícula.
Após duas horas (na próxima execução do processo), ele será ajustado para identificar se poderá enviar o e-mail neste momento. Caso o intervalo de horas para o envio de email ainda não tenha sido atingido (superior a 2 horas), ele não poderá ser enviado neste processamento. Além disso, caso o número máximo de envio de e-mail seja atingido, o email também não poderá ser enviado.
O período de intervalo em horas, o número máximo de envio e a recorrência de agendamento serão definidas por parâmetros:
Além disso foi criado uma nova tag para concatenação dos cursos e link da matrícula dos mesmo para (Parametros|E-mail Link de Matrícula|Template e-mail), mantendo as tags individuais das mesmas.
Este parâmetro é armazenado por Filial.
O parâmetro e-mail link de matrícula faz parte do Projeto FS008837.
O processo de consulta de pagamentos VTEX, disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX | Consulta Pagamentos, identifica os dados associados aos pagamentos das vendas realizadas e/ou canceladas.
O processo poderá ser executado manualmente ou agendado, conforme a necessidade.
Através desse processo é possível visualizar todos os pedidos existentes na fila, considerando os seguintes status:
O processo de Consulta de Pagamentos VTEX, busca as informações de vendas de pedidos realizados na loja e armazena os dados no Monitor de vendas. São consultados dados de pagamentos da política comercial B2C e B2B.
[Novo!]
Para pedidos que sejam do Seller que status dele seja Pronto para Manuseio ou Pagamento aprovado, o mesmo terá o status Pedido Confirmado.
Após os dados do pedido serem consultados e salvos no monitor de vendas (detalhado no item abaixo), é enviado uma confirmação do pedido ao VTEX para que o mesmo seja removido do Feed de Pedidos.
O pedido só volta para o feed caso tenha alguma atualização nos dados, como mudança de status, por exemplo. Ao retornar para o feed, o pedido é identificado pela customização e atualizado no monitor de vendas.
Através do Monitor de Vendas, disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas, é possível visualizar os dados associados aos pagamentos provenientes de inscrições/vendas efetuadas na plataforma VTEX.
A tela do Monitor de Vendas, reúne as seguintes informações:
Aba Identificação:
Nesta aba estão relacionados os dados relacionados ao pedido, tais como:
Os campos Status Protheus e Nome do Seller, são exclusivos do SENAI DN.
Aba Dados Cliente:
Nesta aba estão listados os dados relacionados ao Responsável Financeiro vinculado ao pedido, tais como:
A aba 'Dados do Cliente', poderá ser editada pra atualização do cadastro.
A edição dos dados na aba Dados do Cliente, só poderá ser realizada por um usuário com as devidas permissões. Essa permissão é defina na árvore nativa de Perfis. Conforme exemplo abaixo:
Sempre que houver alteração nos dados do cliente (conforme citado acima), será gravado no Anexo Histórico de Alteração de Dados - Cliente.
O acesso está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas l Anexos: Histórico de Alteração de Dados do Cliente.
Será apresentado na grid uma linha para cada registro alterado., conforme os campos:
Ao registro de Pedidos do Monitor de Vendas, é possível acompanhar os dados vinculados ao pagamento dos pedidos.
O acesso está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas l Anexos: Pagamentos.
Neste anexo estão relacionados os seguintes dados:
Ao registro de Pedidos do Monitor de Vendas, é possível verificar um ou mais itens relacionados ao pedido.
O acesso está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas l Anexos: Itens do Pedido.
Neste anexo estão relacionados os seguintes dados:
Para pedidos realizados por Seller/Parceiro, onde não está disponível o SKU (Turma), não será possível informar o link de matrícula e o campo ficará oculto.
Estes casos serão sinalizados pela marcação da campo checkbox: Pedido DR/Parceiro, localizado na aba: Identificação.
O processo de Envio de E-mail (Link de Matrícula) permite enviar ou reenviar o e-mail com o link da matrícula aos alunos que ainda não completaram o processo ou àqueles que enfrentaram problemas ao tentar finalizá-lo.
Esse recurso está disponível no menu: TOTVS Educacional | Sistema Indústria | Integração VTEX | Envio de E-mail com Link de Matrícula.
Novo!
Ao executar o processo serão consideradas as seguintes novas regras de envio:
Só serão enviados e-mails para pedidos com status faturado, campos matrícula efetivada desmarcado e URL de matrícula preenchido no campo link de matrícula.
Esse processo poderá ser agendado, conforme recurso nativo, executado manualmente pelo Menu citado acima, ou diretamente pela tela do Monitor de Vendas.
Novo!
O Monitor de Vendas foi atualizado para enviar informações sobre o link de matrícula no Pedido, em vez de no item, agrupando todos os links de matrícula em um único e-mail. O novo menu estará disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX | Monitor de Vendas | Processos | Envio de E-mail - Link de Matrícula.
Ao executar o processo serão consideradas as seguintes novas regras de envio:
1- Para os pedidos com mais de um item vinculado, cada item irá possuir um link de matrícula, porém os links serão encaminhados em um único e-mail de forma agrupada por pedido.
Exemplo:
Ao exibir o link de matrícula a customização deverá concatenar o link com o nome do curso, para facilitar a visualização do aluno.
2- Para pedidos originais de Plano de assinatura, o processo não enviará o e-mail.
Ao final da realização do processo, será exibido um log com os e-mails enviados e eventuais erros apresentados. O usuário deverá corrigir a informação e realizar novamente o processo de envio.
O registro de log será modificado para refletir o envio de e-mails por pedido e não mais por itens. Apesar da alteração, a funcionalidade permanecerá inalterada.
Para pedidos de Pessoa Física (B2B), a alteração do status do pedido para "entregue" ocorre quando a matrícula é efetivada no SGE, após o aluno realizar a matrícula através do VTEX.
Já nos pedidos de Pessoa Jurídica, a venda é realizada no VTEX, mas o comprador não tem a opção de efetuar a matrícula. Nesse caso, as informações da venda são enviadas ao SGE por meio do processo de Consulta de Pagamentos VTEX. Portanto, é esse processo de consulta que acionará a alteração do status do pedido para "entregue" no VTEX.
Para que o uma Inscrição/Matrículas seja finalizada, será realizada algumas validações referentes à compra/pagamento na plataforma VTEX, tais como:
Ao avançar para a etapa de matrícula após a confirmação de pagamento, a customização irá validar/contabilizar o número de vagas da turma de oferta com o número de matrículas já realizadas.
As vagas disponíveis na turma podem ser verificadas no cadastro da Turma, disponível em: TOTVS Educacional l Currículo e Oferta l Turmas l Aba: Identificação l Campos: Número Máximo de Alunos e Alunos Matriculados.
Havendo disponibilidade de vagas, a matrícula será efetivada/concluída no TOTVS Educacional (SGE).
Porém, se já atingido o número de candidatos/inscritos às vagas ofertadas, será apresentada uma mensagem de alerta para que o candidato/inscrito aguarde o contato da secretaria escolar, como apresentamos no cenário a seguir.
O controle de matrículas em turma com vagas esgotadas, reúne as informações referentes à compra/pagamento na plataforma VTEX do candidato/inscrito que não teve a sua matrícula efetivada no TOTVS Educacional (SGE), devido a indisponibilidade de vagas da turma de oferta de curso. Os dados armazenados durante a inscrição serão utilizados pela secretaria escolar no processo manual de efetivação da matrícula.
EXEMPLO:
Turma: APP.CPI.001.I (Aperfeiçoamento Profissional em Costureiro Industrial do Vestuário).
Vagas: 03
Relação de Candidatos/Inscritos:
Diante o cenário, temos:
O candidato/inscrito 01 aguarda a confirmação de pagamento para que possa prosseguir à sua matrícula.
Os demais candidatos/inscritos 02 e 03 tiveram as matrículas efetivadas no TOTVS Educacional (RM) por terem realizado pagamento via cartão de crédito.
Assim, o candidato 04 que compareceu a secretaria escolar, teve também a sua matrícula efetivada no TOTVS Educacional (RM), uma vez que no momento do seu comparecimento, o candidato/inscrito 01 ainda não prosseguiu à efetivação da matrícula devido ao período de confirmação/compensação do pagamento realizado via boleto bancário.
Considerando que as vagas da turma foram assim preenchidas, após o período de confirmação/compensação do pagamento do boleto bancário, ao prosseguir à finalização de sua matrícula, será apresentada ao candidato/inscrito 01 a mensagem (padrão) de alerta:
"Matricula: Infelizmente não foi possível concluir sua matricula, aguarde contato da nossa equipe de atendimento. Qualquer dúvida entre em contato através do nosso fale conosco."
Desta forma, a customização armazenará através do Monitor de Vendas, os dados cadastrais do aluno, bem como os dados e status de matrícula, pagamentos e responsável financeiro.
Já o responsável pelo curso será notificado via e-mail que proceda à verificação da pendência de matrícula para este candidato/inscrito (descrito no próximo item).
Analisada a situação, a secretaria escolar, poderá utilizar os dados armazenados durante a inscrição no processo manual de efetivação da matrícula.
Realizada uma venda via plataforma VTEX relacionada a oferta de turma cujas vagas já tenham sido preenchidas no TOTVS Educacional (SGE), será disparado um e-mail de notificação ao o endereço definido na parametrização de e-mail da customização. (Aba 'E-mail' descrito no item 'parâmetros').
O envio de e-mail ao responsável do curso visa a notificação de matrículas pendentes em turma com vagas esgotadas no TOTVS Educacional (SGE), para que a secretaria escolar possa realizar manualmente as matrículas necessárias.
A partir do recebimento do e-mail de notificação, o responsável deverá entrar em proceder à conclusão da matrícula no TOTVS Educacional (SGE), considerando que o aluno já efetuou o pagamento correspondente à oferta do curso.
O controle de matrículas pendentes por erro no TOTVS Educacional (SGE), é realizado a partir dos dados da inscrição do candidato/inscrito, incluindo os dados do pagamento realizado na plataforma VTEX que estarão disponíveis para que a secretaria escolar realize manualmente a efetivação da matrícula para que sejam utilizados pela secretaria escolar no processo manual de efetivação da matrícula.
O Monitor de vendas pagamentos VTEX, também realiza o armazenamento de dados/status associados às inscrições/vendas que não possuem vínculo de matrículas registrados no TOTVS Educacional (SGE).
Sempre que houver alguma pendência para o processamento de matrícula por falta de vagas na turma ou algum outro motivo de erro, essa matrícula pendente será gravada no Anexo Matrículas na tela do Itens do Pedido e exibido a mensagem padrão ao usuário:
"Matricula: Infelizmente não foi possível concluir sua matricula, aguarde contato da nossa equipe de atendimento. Qualquer dúvida entre em contato através do nosso fale conosco."
Novo!
Atualmente o anexo de matrículas é preenchido no Monitor de Vendas apenas para as matrículas que apresentaram algum erro. A integração foi ajustada para garantir que todas as matrículas sejam gravadas no anexo ‘Matrículas’, independentemente do status.
Além disso a flag ‘Matrícula Efetivada’, foi ajustada a regra para que esteja disponível para marcações manuais pelo usuário, quando ele não estiver preenchido, independente do status do pedido (Matrícula Pendente, Matrícula Finalizada).
Após marcado, o status do pedido será alterado para “Matrícula Finalizada” e o campo não poderá mais ser desmarcado.
Ao marcar o “Matrícula Efetivada”, será exibida mensagem de confirmação para o usuário, já que a ação não poderá ser desfeita.
No caso das matrículas efetivadas pela loja VTEX, as regras do escopo original permanecerão inalteradas, com a flag "Matrícula Efetivada" sendo marcada automaticamente.
Na tela é possível visualizar:
Pendente: Pagamento realizado no VTEX sem matrícula gerada no SGE;
Pendente com Erro: Pagamento realizado no VTEX, sem matrícula gerada no SGE;
Vaga indisponível: Pagamento realizado no VTEX, sem matrícula no SGE por falta de vagas;
Baixa Pendente: Pagamento realizado no VTEX, matrícula gerada no SGE com baixa de lançamento pendente;
Matrícula Finalizada: Pagamento realizado no VTEX, matrícula gerada no SGE com lançamento baixado.
Após a conferência de dados e realizada a matrícula pelo usuário, para permitir a gestão e controle interno do usuário, serão automaticamente preenchidos os campos:
Caso seja apresentado erro para o processamento da matrícula e que o erro não esteja relacionado ao número de vagas já preenchidas na turma de oferta, a customização irá gravar uma mensagem de erro na aba 'Mensagem' do anexo de matrículas:
Para que a secretaria escolar realize manualmente a efetivação da matrícula, o usuário do SGE poderá acessar/consultar os dados do candidato através da Aba 'Dados do Aluno':
Após a efetivação da matricula do aluno, para que se tenha um gestão eficaz das matriculas que estavam como "pendentes", o usuário deverá marcar manualmente a flag: Matricula Efetivada.
Quando o campo 'Matrícula Efetivada' for marcado: Usuário Responsável será preenchido automaticamente com o login do usuário responsável pele efetivação. Neste momento, será acionada API do VTEX para alteração do status do pedido para 'entregue', conforme imagem abaixo:
As matrículas executadas com sucesso também são registradas no anexo 'Matrículas' do Item de Pedido do Monitor de Vendas.
Na tela é possível visualizar:
Após a conferência de dados e realizada a matrícula pelo usuário, para permitir a gestão e controle interno do usuário, serão automaticamente preenchidos os campos:
Para que a secretaria escolar visualize os dados da matrícula, poderá acessar/consultar os dados do candidato através da aba 'Dados do Aluno'.
Para que o uma Inscrição/Matrículas seja finalizada, será realizada algumas validações referentes à compra/pagamento na plataforma VTEX como:
Para matrículas realizadas com sucesso, a customização executa ás seguintes ações:
A geração de dados financeiros e pagamentos realiza a efetivação dos cadastros dos dados financeiros ao contrato do aluno e processa as baixas de lançamentos realizados provenientes da venda de cursos, conforme a configuração financeira do processo seletivo no TOTVS Educacional (SGE) para venda na plataforma VTEX.
Todos os processos descritos acima estão condicionados à parametrização nativa do Processo Seletivo, disponível em: TOTVS Educacional| Processo Seletivo | Área de Interesse Ofertada. Como por exemplo:
Para os Processos Seletivos cujas ofertas configurem que o responsável financeiro não seja o próprio aluno, o cadastro do responsável financeiro será realizado a partir dos dados do cliente informado no momento de compra na plataforma VTEX e vinculado ao contrato gerado. Este cadastro considera a verificação, validação e unicidade do CPF//CNPJ, validando a existência de um cadastro cliente/fornecedor no SGE e, caso não exista, será realizada criação do mesmo.
O cadastro do responsável financeiro será realizado considerando as seguintes informações:
A página do processo seletivo não permite que seja informado um responsável do tipo pessoa jurídica. No entanto, será possível receber um CNPJ de responsável financeiro o mesmo será incluído no cadastro do cliente com base nos dados consultados.
Observação:
Para que o responsável financeiro seja o próprio aluno o parâmetro deverá estar marcado na aba financeiro da área de interesse ofertada do processo seletivo; conforme imagem abaixo. Neste cenário NÃO há ação customizada, o cadastro é feito de forma nativa.
A baixa de lançamentos financeiros e pagamentos é executada após a geração do contrato e lançamento financeiro da primeira parcela, visto que as matrículas que virão da VTEX para o SGE, já terão o pagamento confirmado na Plataforma.
A realização das baixas dos lançamentos financeiros serão realizadas no TOTVS Educacional (SGE), de acordo com as informações referentes à forma de pagamento (Boleto Bancário, PIX, Cartão de Crédito ou Débito), data de pagamento e valor pago. Para identificar o registro da forma de pagamento que será utilizado na baixa são consultados os parâmetros 'Dados Financeiros'.
Observação:
Demais informações necessárias para para a baixa (conta caixa e moeda, por exemplo) deverão estar parametrizadas com valores defaults no TOTVS Educacional (SGE), sem necessidade da customização preencher tais campos.
O regional que optar pelo pagamento através do TOTVS Educacional (SGE), funcionalidade nativa, a customização não irá efetuar a baixa do lançamento financeiro automaticamente ao finalizar o processo de matrícula. Esse processo será automatizado apenas quando utilizar a integração do VTEX e a área de interesse do processo seletivo estiver parametrizada para gerar lançamento.
Se o contrato possuir uma bolsa, os lançamentos financeiros são gerados considerando o desconto em todas as parcelas do plano de pagamento e não somente na 1° parcela;
Caso o TOTVS Educacional (SGE) possua integração com Protheus ou utilize o financeiro do TOTVS Educacional, a comunicação com o sistema financeiro utilizará as regras já existentes de integração, porém para integração com outros sistemas como AX, Dynamics e outros poderão ser necessárias alterações/implementações para atender essas especificidades. Tais alterações não serão tratadas neste escopo.
Caso seja apresentado erro no momento da baixa de lançamento financeiro, a informação também será gravada nos dados do contrato (anexos) que poderá ser consultado para execução do processo reprocessamento da baixa (descrito no próximo item).
Para as situações em que, ao finalizar a inscrição/matrícula no TOTVS Educacional (SGE), proveniente de vendas de ofertas na plataforma VTEX, sejam apresentados erros no processamento de baixa no contrato financeiro é possível realizar o Reprocessamento da Baixa.
No processo de Reprocessamento de Baixa, será reexecutada a baixa do lançamento financeiro, que por sua vez, armazenará um novo retorno.
Este processo está disponível em: TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos l Dados do Pagamento l Processos l Reprocessamento Baixa.
Caso a baixa do lançamento não tenha ocorrido com sucesso, será gravado na aba histórico o status de erro.
Aba: Histórico:
A aba de histórico será preenchida na inclusão do registro e para cada tentativa de processamento, caso a baixa não tenha ocorrido com sucesso na inclusão. Os campos serão:
O armazenamento das informações relacionadas aos dados financeiros dos pagamentos referentes às matrículas efetuadas no TOTVS Educacional (SGE), provenientes de vendas de ofertas na plataforma VTEX, são associadas a um anexo ao Contrato Financeiro.
O anexo está disponível em: TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos l Dados do Pagamento.
Nele serão apresentados os dados do pagamento realizados na plataforma VTEX, preenchidos automaticamente a partir da conclusão da inscrição/matrícula do aluno.
Aba: Identificação:
Matrícula Manual: Para matrículas que não tenham sido realizadas de forma automática, o usuário deverá inserir de forma manual esse registro. Será exibido na lista, itens de pedidos relacionados aquela determinada matrícula.
Para matrículas manuais, não há preenchimento do campo.
Aba: Histórico:
A aba de histórico será preenchida na inclusão do registro e para cada tentativa de processamento, caso a baixa não tenha ocorrido com sucesso na inclusão. Os campos serão: