Páginas filhas
  • Manual Operacional - Alteração nas Políticas Comerciais de Matrícula

Manual Operacional - Integrações SGE X CRM X ERP


Projeto: FS008682 - Alteração nas Políticas Comerciais de Matrícula

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 x CRM x ERP. 

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


Detalhamento do processo:

Caminho de acesso: TOTVS Educacional | Customização | CRM e ERP

CRM:


CAMPOS DE PARÂMETROS:

Os campos de parâmetros listados abaixo possibilitam a integração entre TOTVS Educacional X ERP X CRM.


WEB SERVICE (DADOS DE CONEXÃO WS – CRM e ERP):

Os campos abaixo permitem realizar a parametrização da conexão entre o TOTVS Educacional X CRM.

- URL Token: Campo de preenchimento obrigatório que tem como objetivo armazenar a URL da API do token.

- Client Id: Campo de preenchimento obrigatório que tem como objetivo armazenar usuário do token do LogicApps.

- Client Secret: Campo de preenchimento obrigatório e criptografado que tem como objetivo armazenar a senha do token do LogicApps.

- Recurso: Campo de preenchimento obrigatório que tem como objetivo armazenar Recurso do token do LogicApps.

- API CRM: Campo de preenchimento obrigatório que tem como objetivo permitir que o usuário indique a rota da API da nova integração com CRM.



SITUAÇÕES DE PRE MATRICULA:

Os campos abaixo permitem realizar a parametrização das situações de pré matricula para a integração entre o TOTVS Educacional X CRM.

- Coligada: Campo para selecionar a coligada da situação de matricula da tabela GCOLIGADA.

- Nível de Ensino: Campo para selecionar o nível de ensino da tabela STIPOCURSO.

- Situação de Pré-Matricula: Campo para selecionar situações de matricula da tabela SSTATUS.



SITUAÇÕES DE MATRÍCULA:

Os campos abaixo permitem realizar a parametrização das situações de matricula que indicam "Matricula" entre a integração entre TOTVS Educacional X CRM.

- Coligada: Campo para selecionar a coligada da situação de matricula da tabela GCOLIGADA.

- Nível de Ensino: Campo para selecionar o nível de ensino da tabela STIPOCURSO.

- Situação de Matricula: Campo para selecionar situações de matricula da tabela SSTATUS.



CANCELAMENTO DE MATRÍCULAS:

Os campos abaixo permitem realizar a parametrização da conexão entre o TOTVS Educacional X CRM.

- Status Cancelamento Pré-matrícula - Cancelado: Campo de parametrização com preenchimento obrigatório que indica o status de cancelamento que será correspondente ao status de cancelamento de pré-matrícula cancelado.

- Número dias p/ cancelamento da pré-matrícula: Campo de parametrização com preenchimento obrigatório que indica a quantidade de dias limite para que o cancelamento automático da pré-matrícula de um contrato que não foi efetivado (módulo vendas – CRM) seja concluído.

- Texto Padrão para cancelamento: Campo de parametrização com preenchimento obrigatório que tem por finalidade incluir o texto padrão que será enviado ao ERP no ato do cancelamento da pré-matrícula.



Novo! 

MOTIVO ALTERAÇÃO DE MATRICULA (MATRICULA RETORNO): 

Os campos abaixo permitem realizar a parametrização dos motivos de alteração de matricula para as "matriculas retorno" da integração entre TOTVS Educacional X CRM.

- Coligada: Campo para selecionar a coligada da situação de matricula da tabela GCOLIGADA.

- Nível de Ensino: Campo para selecionar o nível de ensino da tabela STIPOCURSO.

- Situação de Matricula: Campo para selecionar motivos de alteração de matrícula da tabela SMOTIVOALTMAT.



Novo! 

SITUAÇÃO DE MATRÍCULA (SAÍDA) - MESMA TURMA:

Os campos abaixo permitem realizar a parametrização das situações de matricula que indicam "Matricula de Retorno para Mesma Turma" entre a integração entre TOTVS Educacional X CRM.

- Coligada: Campo para selecionar a coligada da situação de matricula da tabela GCOLIGADA.

- Nível de Ensino: Campo para selecionar o nível de ensino da tabela STIPOCURSO.

- Situação de Matricula: Campo para selecionar situações de matricula da tabela SSTATUS.



Novo! 

SITUAÇÃO DE MATRÍCULA (SAÍDA) - NOVA TURMA:

Os campos abaixo permitem realizar a parametrização das situações de matricula que indicam "Matricula de Retorna para Nova Turma" entre a integração entre TOTVS Educacional X CRM.

- Coligada: Campo para selecionar a coligada da situação de matricula da tabela GCOLIGADA.

- Nível de Ensino: Campo para selecionar o nível de ensino da tabela STIPOCURSO.

- Situação de Matricula: Campo para selecionar situações de matricula da tabela SSTATUS.


ERP:


NOVOS CONTRATOS:

Caminho de acesso: TOTVS Educacional | Customização | ERP | Parâmetros.

Foi feita a alteração na tela de Integração com o ERP para a integração de contratos e adicionado campos necessários para a nova fase da integração.


Detalhamento do processo:

Foi disponibilizado um processo customizado para cancelamento de pré-matrícula, caso a matrícula não seja efetivada (situação de matricula alterado para matriculado) dentro de um determinado período, mesmo com turmas já iniciadas.

Caminho de acesso: TOTVS Educacional | Customização | CRM | Parâmetros de Integração SGE x CRM.

Na tela de parâmetros é possível incluir a quantidade de dias necessários para que a pré-matrícula seja cancelada, imagem abaixo:

OPÇÕES DE CANCELAMENTO:

Existem duas formas de realizar o cancelamento da pré-matrícula:

  • Manual (Cancelamento Instantâneo):

O processo pode ser executado manualmente, sem passar pela regra de validação de dias. Desta forma a matrícula será cancelada no ato da execução do processo. 

Caminho de acesso: TOTVS Educacional | Matrícula e Avaliação | Matrículas | Processos | Cancelar pré-contrato - Agendado


  • Agendado (Conforme regras):

O cancelamento no formato agendado considera a quantidade de dias parametrizadas na tela de parâmetro, sendo que:

Pré-matrícula antes da data início da turma: A contagem dos dias para cancelamento é realizada a partir da data início da turma, conforme número de dias parametrizado.

Pré-matrícula após início da turma: A contagem dos dias é realizada a partir da data da pré- matricula, conforme número de dias parametrizado.

IMPORTANTE: Após a alteração, é enviada a informação do cancelamento para o ERP, para que o pré-contrato possa ser cancelado neste sistema.

Detalhamento do processo:

Finalizada a matrícula do aluno, o SGE disponibiliza os dados de formalização de matrícula para o CRM. Após o envio da confirmação de matrícula para o ERP e retorno “OK” é enviada a confirmação da matrícula para o CRM através do método POST .

IMPORTANTE: O envio dessa informação faz a atualização do status do contrato.

Detalhamento do processo:

O método “inserirPreMatricula” tem como objetivo realizar a inclusão da pré-matrícula no SGE, no formato REST/JSON.

O método chama os serviços do produto padrão de matrícula e insere a pré-matrícula no SGE, de acordo com os dados disponibilizados pelo CRM.

A integração acontece no sentido CRM → SGE TOTVS e é responsável por enviar os dados do Pai, Mãe, Responsável Financeiro, Responsável Acadêmico, Aluno, Turma e Pré-Contrato.

Caso ocorra erro no processamento de alguma das entidades descritas neste requisito, é realizado rollback em toda operação. Ou seja, ao tentar incluir o Pai, Mãe, Responsável Acadêmico e Responsável Financeiro, o processo apresente algum erro no momento da inclusão, a operação será desfeita.

O processo customizado realiza as seguintes inserções:


REGRA DE VALIDAÇÃO:

No momento que o CRM aciona o webservice do SGE TOTVS, a customização verifica se existe cadastrado na base uma pessoa com: Nome, Data de nascimento, Estado natal e Cidade natal enviado na propriedade escolhida, que pode ser: Pai, Mãe, Responsável Acadêmico e Financeiro, Pessoa Do Aluno, Aluno, Curso, Curso/Matrícula no período Letivo e pré-contrato.

 Novo cadastro:  caso não exista, a Customização realiza a inclusão de uma pessoa com as informações contidas na propriedade escolhida através da funcionalidade padrão de inclusão.

 Cadastro já existente:  caso já exista cadastro de uma pessoa com os dados enviados, o sistema faz o vínculo dessa pessoa na criação do aluno da seguinte forma:

  • Pai: será vinculada ao campo SPESSOA.CODPESSOAPAI
  • Mãe: será vinculada ao campo SPESSOA.CODPESSOAMAE
  • Responsável acadêmico: será vinculada ao campo SALUNO.CODPESSOARACA
  • Responsável financeiro: será vinculado ao campo SALUNO.CODCFO
  • Pessoa/Aluno: Se porventura já exista o cadastro de uma pessoa, mas não exista um Aluno associado à esta pessoa (SALUNO.CODPESSOA), será incluído um Aluno vinculando à pessoa existente.

INCLUSÃO REFERENTE AO CURSO:

Caso o Aluno seja da Coligada SENAI ou IEL é incluído um curso de acordo com as informações dessa propriedade. A rotina acionada pela customização é a mesma disponível em TOTVS Educacional | Currículo e Oferta | Aluno | Anexos | Cursos/Habilitações | Inserir

IMPORTANTE: Para que seja permitido a inclusão do Curso/Habilitação, a Customização valida o número máximo de Alunos da turma e número de Alunos inscritos. Caso a inclusão deste curso/habilitação exceda o número de vagas, todo o processo será abortado. Este cálculo será a partir dos campos “Alunos inscritos” e “Máximo de Alunos” no cadastro da Turma.

INCLUSÃO DE MATRÍCULA NO PERÍODO LETIVO:

Caso o Aluno seja da Coligada SENAI ou IEL o processo “Matricular Aluno” disponível em TOTVS Educacional | Currículo e Oferta | Aluno | Anexos | Cursos/Habilitações | Processos, é executado com base nas informações dessa propriedade.

Se o Aluno inserido for da Coligada SESI  o processo “Matricular Aluno” disponível em TOTVS Educacional | Currículo e Oferta | Aluno | Processos, é executado com base nas informações dessa propriedade.

IMPORTANTE: Para que seja permitido a inclusão do Curso/Habilitação a Customização valida o número máximo de Alunos da turma e número de Alunos inscritos. Caso a inclusão deste curso/habilitação exceda o número de vagas, todo o processo será abortado. Este cálculo será a partir dos campos “Alunos inscritos” e “Máximo de Alunos” no cadastro da Turma.


Novo! 

MATRICULA RETORNO:

Ao receber a inclusão de matrículas de um aluno que já está matriculado no mesmo curso e período letivo informado na requisição, a customização deverá utilizar a mesma matrícula existente, alterando a situação de matrícula para pré-matrícula ao invés de criar uma nova pré-matrícula e gerando um novo pré-contrato no CRM. Esse processo será aplicado SOMENTE para os alunos que estejam com situação de matrícula devidamente parametrizada em Parâmetros de Integração CRM x SGE nas abas Situação de Matricula (Saída) - Mesma Turma e Situação de Matricula (Saída) - Nova Turma


Detalhamento do Processo:

Ao receber os dados, a API irá realizar as seguintes operações:

  • Quando retornar na mesma turma, a customização deverá validar se o parâmetro Situação de Matricula (Saída) - Mesma Turma, está preenchido.
  • Quando retornar em turma diferente a customização deverá validar se o parâmetro Situação de Matricula (Saída) - Nova Turma, está preenchido. Caso contrário, o processo será abortado e a matrícula de retorno não será realizada.
  • A matrícula no curso/habilitação deve ser alterada para status que indique "pré-matricula", de acordo com o parâmetro Situações de Pré-Matricula (SENAI/IEL).
  • A matrícula no período letivo também deve ser alterada com situação de matrícula que indique "pré-matricula", de acordo com o parâmetro Situações de Pré-Matricula (SESI/SENAI/IEL).
  • A matrícula na turma e nas turmas/disciplinas devem ser alteradas para status que indique "pré-matricula", de acordo com o parâmetro Situações de Pré-Matricula (SESI/SENAI/IEL). 


IMPORTANTE:

¹ Após receber a inclusão de matrícula no mesmo curso/período e alterar o status da matrícula existente, a customização irá gerar um novo Pré-Contrato no CRM, seguindo as mesmas regras do processo atual.

² O parâmetro Permite matricular o aluno em uma disciplina já aprovada deve estar marcado Parâmetros | Matrícula | Movimento 1/4.

³ Após o aluno cursar a disciplina e ser aprovado, será de responsabilidade da FIEP rodar o processo de apuração de resultados no período letivo novamente. Depois da conclusão do processo de apuração de resultados, o sistema irá identificar que o aluno foi aprovado na disciplina e irá alterar o Resultado Final da Matrícula no período letivo para Aprovado.


INCLUSÃO DOS DADOS DO PRÉ-CONTRATO:

A customização recebe do CRM os dados do pré-contrato no sistema ERP. Esses dados são armazenados em tabela customizada e terá as informações contidas no cadastro.

Caminho de acesso: TOTVS Educacional | Currículo e Oferta | Aluno | Anexos | matriculas no período letivo | Pré-Contrato CRM :

  • Modelo do Contrato: É enviado um valor válido conforme tabela dinâmica ZMODCONTRATOSTERMOSAX;
  • Valor total: Informa o valor total do contrato considerando os descontos.
  • Quantidade de Parcelas: É enviada a quantidade de parcela que será gerada para o pagamento;
  • Tipo de desconto: o tipo de desconto utilizado, caso exista: P – Percentual, V – Valor;
  • Valor de desconto: É enviado o valor do desconto, caso exista;
  • Observação do desconto: motivo da concessão do desconto;
  • Data de início do contrato: Deve estar dentro do período do mês vigente ou no futuro, respeitando o início da prestação do serviço;
  • Data fim do contrato: É enviada a data final do contrato;
  • Valor aplicado ao curso: Caso o valor do curso tenha sofrido alteração para a pré-matrícula é enviado o valor que foi aplicado;
  • Adesão Odonto: Caso o haja adesão ao plano escolar de odonto é enviado o valor 1 (true);
  • Item Odonto: Caso o haja adesão ao plano escolar de odonto deverá ser enviado o código do item odonto ofertado;
  • Valor Item Odonto: Caso Adesão Odonto seja 1 (verdadeiro) é enviada o valor do item odonto;
  • Item de venda aplicado: Deverá informar qual item de venda foi utilizado para geração do contrato;
  • Número Pré-Contrato: Informa o código do pré-contrato;
  • Status Pré-Contrato: “Pendente Efetivação”, “ Efetivado”, “Cancelado” – Campo de controle TOTVS.

IMPORTANTE: O campo STATUS foi criado para definir se o Pré-Contrato foi efetivado e o aluno matriculado. Quando o pré-contrato for criado ele fica com o status “Pendente de Efetivação” e após integrado com o sistema ERP é alterado para “Efetivado” e a tabela ZCONTRATOAX é carregada com as informações correspondentes, juntamente com o código do contrato no sistema ERP. Caso o contrato seja cancelado, o status é alterado para “Cancelado”.

VISÃO DOS DADOS DO PRÉ-CONTRATO:

Caminhos de acesso: TOTVS Educacional | Currículo e Oferta | Aluno | Anexos | Matriculas no período letivo | Anexos | Pré-Contrato CRM  Ou

TOTVS Educacional | Matrícula e Avaliação | Matriculas | Anexos | Pré-Contrato CRM


Detalhamento do processo:

Foi disponibilizado um processo customizado para envio dos dados de matrícula e pré-contrato para o ERP.

Obs: Esta alteração foi aplicada apenas para Pessoa Física – Matrícula. (Nacional/Estrangeira).

Caminho de acesso:  TOTVS Educacional | Matrícula e Avaliação | Matrículas | Processos | Integração de Contrato com sistema ERP.

VALIDAÇÕES DO PROCESSO:

  • Verifica se existe turma vinculada na matrícula;
  • Verifica se no cadastro da turma as datas de início e fim estão preenchidas;
  • Verifica se a data da matrícula é anterior ao mês atual e caso positivo verifica se o usuário tem permissão para executar a matrícula com data retroativa;
  • Verifica se o status da matricula no período letivo está cadastrada na parametrização “Status de Pré-Matriculado”;
  • Verifica se o contrato referente a matrícula foi enviado ao ERP anteriormente;
  • Verifica se o item de venda foi devidamente parametrizado na Matriz Aplicada.

Caso alguma das validações citadas acima, seja verdadeira, é apresentada uma mensagem ao usuário informando o motivo da inconsistência e o processo será interrompido. (Validações já existentes).

Se o processo não encontrar nenhuma inconsistência, é apresentado um “wizard” onde o usuário deve avançar todos os passos informando todas as obrigatoriedades antes de enviar o contrato ao ERP.

Na primeira etapa são apresentados os tipos de contratos.

ALTERAÇÕES DE NOMECLATURA

As nomenclaturas das opções de Pessoa Física foram alteradas para:

  • Pessoa Física –Rematrícula e Matrícula Acadêmica
  • Pessoa Física Estrangeira – Rematrícula e Matrícula Acadêmica

Caso o usuário selecione qualquer uma das opções acima e o aluno tenha pré-contrato no período letivo é exibida a mensagem: “O aluno possui pré-contrato no período letivo. Favor utilizar as opções de matrícula”

OPÇÕES DE MATRÍCULA

Opções de Pessoa Física:

  • Pessoa Física –Matrícula
  • Pessoa Física Estrangeira – Matrícula

Ao selecionar uma das opções acima (Pessoa Física /Matricula), o processo customizado realiza a busca do código do pré-contrato vinculado a pré-matrícula em tabela customizada. O código do pré-contrato é exibido no campo “Pré-Contrato”.

IMPORTANTE: Somente é possível avançar essa etapa se existir pré-contrato para o aluno em tabela customizada. Caso não exista o contrato, é exibida mensagem para o usuário informando que o aluno não tem pré-contrato vinculado.

Após avançar essa etapa é exibida a tela nativa do processo “Documentos entregues” conforme parametrização por curso.

O usuário deve informar os documentos que foram entregues pelo aluno conforme tela nativa de matrícula:


Após informar os documentos entregues, o usuário deve avançar a etapa e acionar o botão “Executar”, nesse momento a rotina customizada consome o webservice do ERP enviando ao ERP as informações de matrícula e contrato.

Após a conclusão do envio dos dados a situação de matrícula é alterada de pré-matrícula para matriculado (Conforme status de matricula definidos na parametrização customizada).

Para que a alteração seja realizada, deve ser preenchido o motivo da alteração de situação da matricula já existente em parametrização customizada.


VALIDAÇÕES DO PROCESSO DE ALTERAÇÃO:

Será realizada validação dos documentos obrigatórios para matrícula:

O status da matrícula é alterado para matriculado caso o aluno tenha entregue todos os documentos obrigatórios para matrícula. Caso negativo, a situação de matrícula não será alterada. O processo não é executado e será exibida mensagem para o usuário informando sobre o motivo do erro – Pendência de entrega de documentos.

Exceção: Caso o usuário tenha o perfil que permita matrícula mesmo na falta de entrega de documentos obrigatórios, o processo é executado e o status da matrícula é alterado para matriculado.

A parametrização dos perfis de usuário com essa permissão é realizada através de rotinas nativas do SGE.

Observações:

  • Foram mantidos todos os processos existentes para recuperação do contrato, parcelas do contrato e boleto no AX, conforme API’s já existentes;
  • O contrato é incluído na tabela ZCONTRATOAX, conforme informações da tabela de pré-contrato ZPRECONTRATOCRM;
  • Após a conclusão de todo o processo o status do pré-contrato em tabela customizada é alterado para “EFETIVADO”;
  • A confirmação de matrícula também é para o CRM (detalhado no próximo tópico);
  • Será gravado LOG da execução do processo em tabela customizada;

IMPORTANTE:  As alterações são realizadas somente nos processos de matrícula de pessoa física. Todos os outros processos continuarão conforme processo existente.


Detalhamento do processo:

A interface de log exibe os dados trafegados entre os sistemas SGE x ERP x CRM.

Caminho de acesso: TOTVS Educacional | Customização | CRM | Log de Integração CRM.