Projeto:FS008629 (AAEBUS) - Integração SGE com VTEX - Parte 2Nome do Cliente: Confederação Nacional da Indústria Manual Operacional da Customização - Integração Kit de Cursos para VTEX - SENAI
Objetivo
Este documento foi elaborado para orientar aos usuários-chave SENAI DN sobre os requisitos e funcionalidades da Integração TOTVS Educacional (SGE) e a Plataforma VTEX, possibilitando a montagem de Kit de cursos, ou seja, a montagem de oferta com mais de um curso (produto) disponíveis no TOTVS Educacional SGE e integração desse Kit de curso na plataforma VTEX para realização de compras.
Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários-chave para o Template Digital, SENAI DN.
Metodologia
Este material tem como base a visão prática e completa do Processo Customizado, da área Educacional através da da Customização FS008629 (AAEBUS) - Integração SGE com VTEX - Parte 2.
A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional (SGE). Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.
...
| title | Permissas |
|---|
...
Premissas
1 - 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 aparecerem nos seus respectivos lugares. 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.
...
1- Integração VTEX - Kit de Cursos
...
O Kit de Cursos possibilita a estruturação de oferta com mais de um curso (produto), para que sejam disponibilizados à venda a partir da Integração TOTVS Educacional (SGE) e a plataforma VTEX.
O acesso para cadastro de um Kit de Cursos está disponível em: TOTVS Educacional | Sistema Indústria |
...
Integração VTEX
...
...
Parâmetros Gerais Integração VTEX - E-mail: Neste item deverão ser parametrizados os dados necessários para envio automático de e-mail ao responsável pelo 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.
Desta forma, nos campos a seguir deverão ser informados os parâmetros:
[RA]: Registro Acadêmico do aluno;
[NOMEALUNO]: Nome do aluno;
[NOMECURSO]: Nome do curso de matrícula do aluno;
[NOMEHABILITACAO]: Nome da habilitação de matrícula do aluno;
[CODPERLET]: Código do período letivo de matrícula do aluno;
[NOMEFILIAL]: Nome da filial de matrícula do aluno;
[CODTURMA]: Código da Turma de matrícula do aluno;
[IDPEDIDO]: ID de pedido enviado pela VTEX na URL de matrícula do aluno;
E-mail: Neste parâmetro (tipo texto), o usuário deverá informar quais e-mails serão considerados no envio do e-mail para informativo de alunos/inscritos em turmas com vagas esgotadas. Ao clicar em adicionar o registro será exibido no grid abaixo. Ao clicar em limpar, o registro será removido da grid. Poderá ser informado mais de um e-mail.
...
| title | Processo para Consulta de Pagamentos VTEX |
|---|
O processo de consulta de pagamentos VTEX realiza a verificação de dados associados aos pagamentos relacionados às vendas (realizadas/canceladas), disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX.
...
Obter itens de feed: Ao consultar essa API será possível visualizar todos os pedidos existentes na fila considerando os status:
Confirmar Pedido: Após os dados do pedido serem salvos no Monitor de vendas, deverá ser enviado a confirmação do Pedido para que o mesmo seja removido da fila.
Consulta de pedido: Ao informar o número do pedido, serão retornados todos os dados referente ao mesmo.
...
| title | Monitor de Vendas - Pagamentos VTEX |
|---|
O processo de monitoramento de vendas pagamentos VTEX realiza o armazenamento de dados associados aos pagamentos provenientes de inscrições/vendas efetuadas na plataforma VTEX. A visualização da relação de pagamentos está disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas.
...
...
...
...
| title | Monitor de Vendas - Itens do Pedido |
|---|
A visualização da relação de Itens do Pedido, provenientes de inscrições/vendas efetuadas na plataforma VTEX estará disponível em: TOTVS Educacional | Sistema Indústria | Integração VTEX l Monitor de Vendas l Anexos l Itens do Pedido.
...
...
| title | Matrículas Pendentes - TOTVS Educacional (SGE) |
|---|
O processo de monitoramento 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).
Ao finalizar o processo de inscrição, quando verificada a baixa de pagamento, a plataforma VTEX processará a matrícula no TOTVS Educacional (SGE).
Quando houver pendência para o processamento de matrícula por falta de vagas na turma, a customização irá disparar um e-mail com mensagem de notificação para o responsável pelo curso.
Porém 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 no anexo de matrículas pendentes, localizado no monitor de vendas Itens do pedido.
Assim, o usuário poderá acessar/consultar os dados do candidato através dos Anexos: Itens do Pedido para realização das matrículas de forma manual, e ainda, se necessário associar o status dos registros: Matrícula já efetivada pelo usuário.
...
...
...
...
| title | Finalização de Inscrição/Matrículas - TOTVS Educacional (SGE) |
|---|
O processo de finalização de inscrição/matrículas valida as informações referentes à compra/pagamento na plataforma VTEX como: disponibilidade de vagas, seleção do parâmetro Gerar Lançamento na Área de Interesse ofertada do processo seletivo (venda online), geração de lançamentos financeiros, baixas e vinculação do responsável financeiro.
...
| title | Observação: |
|---|
Quando aplicado o recurso de envio de documentos para o cadastro do aluno, seja para as matrículas realizadas via web ou presencial (secretaria escolar), o TOTVS Educacional (SGE) manterá as rotinas padrões do produto (sem interferência de customização), que são:
Ao executar a venda, são realizadas as verificações relacionadas às ofertas disponíveis na plataforma VTEX, considerando:
As vagas disponíveis na turma podem ser verificadas no cadastro da Turma, através dos campos: Número máximo de alunos e Alunos matriculados.
Para as situações em que seja utilizado o boleto bancário como meio de pagamento, somente após a confirmação de pagamento, o candidato/inscrito será redirecionado para a etapa de matrícula.
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.
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 (uma vez que podem ser realizadas matrículas presenciais via secretaria escolar), será apresentada uma mensagem de alerta para que o candidato/inscrito aguarde o contato da secretaria escolar, como apresentamos no cenário a seguir.
...
l Kit de Cursos.
Este processo deve ser executado manualmente, onde será acionada a API VTEX: Create SKU KIT, para que sejam relacionados os cursos que irão compor os kits de cursos a serem integrados à plataforma VTEX.
Na tela inicial, deverão ser configurados os Dados do Kit e Dados do Curso, conforme:
Dados do Kit
Após registrar os campos Kit e Processo Seletivo, ao clicar em adicionar será exibido na tela a configuração do Kit de Curso conforme a opção selecionada pelo usuário.
Nesta tela também estará disponível a opção: Limpar, que permite a exclusão da configuração criada para o Kit de Curso da tela de processo.
Dados do Curso
Atenção: Caso a área de interesse tenha mais de uma turma vinculada, será exibido na lista uma turma por linha, mas será permitida apenas a inclusão de uma única turma por kit.
Após registrar a Área de Interesse, ao clicar em adicionar será exibida na tela a configuração da área de interesse associada ao Kit de Curso, conforme a opção selecionada pelo usuário.
Nesta tela também estará disponível a opção: Limpar, que permite a exclusão da configuração da área de interesse criada para compor Kit de Curso da tela de processo.
Após configurar o Kit de Curso, na parte inferior, através dos ícones: , o usuário poderá adicionar o Kit de Curso configurado para execução do processo, como também excluir um Kit de Curso configurado quando não desejar que o mesmo seja incluído no processo a ser executado. Validadas as informações, ao clicar em Avançar, o usuário será redirecionado à etapa seguinte do processo para que sejam configuradas as informações complementares/específicas do Kit de Cursos que está sendo criado.
Na etapa seguinte do processo, devem ser configuradas as informações complementares/específicas relacionadas ao Kit de Curso, tais como:
Vinculadas as informações complementares/específicas do Kit de Curso, ao clicar em Avançar, o usuário será redirecionado à etapa seguinte do processo para visualização da Estrutura criada para o Kit de Curso, conforme os vínculos/registros associados nas etapas anteriores.
Ao clicar em Executar, será processada a criação do Kit de Curso.
Alterar tela - Desenvolvendo função Excluir.
2. Anexo - Kit de Curso
A visualização da vinculação de um Processo Seletivo a um Kit de Curso, estará disponível em: TOTVS Educacional Processo Seletivo l Processo Seletivo l Anexos l Kit de Curso.
Assim, a partir da seleção de um cadastro de Processo Seletivo, em Anexos, ao selecionar o item: Kit de Curso, será apresentada a listagem do(s) Kit(s) de Curso(s) associado(s) ao mesmo.
Assim, os registros serão apresentados com as seguintes informações:
Tela registro
Ao clicar sobre um registro, o usuário terá acesso às demais informações associadas ao Kit de Curso, sendo elas:
Importante: Apenas os campos Descrição do Kit, URL do vídeo e URL da imagem estarão disponíveis para edição. Caso sejam alterados, a alteração será replicada para todos os registros que sejam do mesmo Kit e Processo Seletivo. Deverá ser acionadas as APIs descritas no Req.01 para atualização do registro.
Tela registro
Ao abrir o registro, estará disponível o anexo 'Cursos' que listará os cursos (áreas de interesse) vinculadas ao kit de cursos. Exibindo as informações abaixo:
Tela registro
Ao abrir o registro de áreas de interesse, estará disponível o anexo 'Turmas' que listará as Turmas (SKU) vinculadas a área de interesse do kit de cursos. Exibindo as informações abaixo:
Tela registro
3. Processo para Inativação de Kit de Cursos
O processo para inativação de kit de cursos já exportado à plataforma VTEX está disponível em: TOTVS Educacional l Processo Seletivo l Cadastro l Processo Seletivo l Anexos: Kit de Cursos l Kit de Cursos l Process: Inativação do Kit de Cursos. A execução se aplica a todos os cursos que compõem o mesmo, desde que não tenham matrículas e/ou pagamentos realizados ou pendentes.
Tela processo
Após selecionar o processo seletivo, em Anexos: Kit de Cursos selecione o(s) kit(s) de curso(s) que se deseja realizar a inativação. Em seguida, em Processos, selecione o item: Inativação de Kit de Cursos
Tela processo
Na etapa seguinte, será apresentada a tela para registro do motivo pelo qual o processo de inativação de kit de cursos será executado, acompanhado da mensagem padrão de informação: "Ao executar o processo de Inativação, o Kit selecionado e os demais produtos vinculados a ele serão desativados para exibição no ambiente VTEX, sem possibilidade de reativação. Deseja executar o processo? ".
Para execução, após vincular o motivo, clique em: Executar.
Tela processo
Importante: O processo de inativação de kit de curso se aplica a todos produtos/cursos vinculados ao registro mesmo.
Realizado o processo, o kit de curso não poderá ser reativado. Assim, caso o usuário desejar realizar a inclusão do Kit novamente, deverá ser executado o processo de Integração VTEX - Kit de Cursos demonstrado neste manual.
...
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:
"Aguarde o contato da instituição para finalização da sua matrícula".
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.
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.
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.
Ao realizar a venda de um curso através da plataforma VTEX, a customização irá realizar os seguintes processos:
...
...
| title | Observação: |
|---|
Para que o responsável financeiro seja o próprio aluno (ALUNO.CODCFO) o parâmetro (SPSPARAMETROSAREAOFERTADA.CADASTRAALUNOCOMORESPFINANC) deverá estar marcado na aba financeiro da área de interesse ofertada do processo seletivo.
A página do processo seletivo não permite que seja informado um responsável do tipo pessoa jurídica. No entanto, a customização poderá receber um CNPJ de responsável financeiro e fará o cadastro do cliente com base nos dados consultados no VTEX através da API.
...
| title | 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.
...
| title | Importante: |
|---|
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.
Após verificar o pagamento da inscrição, a customização irá realizar vincular os dados do pagamento à matrícula, bem como o status referente à baixa do lançamento financeiro (sucesso ou erro), data do processamento e mensagem de erro (quando houver).
...
| title | Anexos do Contrato Financeiro: Dados de Pagamento |
|---|
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, estarão associadas a um anexo ao Contrato Financeiro.
A partir do Anexo: Dados do Pagamento do Contrato Financeiro, é possível verificar os Dados do Pagamento, que estarão disponíveis em: TOTVS Educacional | Financeiro/Contábil | Contratos | Anexos l Dados do Pagamento.
...
...
...
| title | Reprocessamento da Baixa |
|---|
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, ao Contrato Financeiro foi adicionado o Reprocessamento de Baixa.
A partir do Processo: 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.
...
| title | Importante: |
|---|
...