Projeto: FS008432 – Integrações com Salesforce/Perseus
Nome do cliente: FIEC
Objetivo
Este documento foi elaborada para informar aos multiplicadores e usuários-chave da área Educacional sobre as funcionalidades que possibilitarão a integração do SGE com o Moodle. Também tem como objetivo habilitá-los a usarem as funcionalidades associadas a esses processos no SGE – SISTEMA DE GESTÃO ESCOLAR (TOTVS Educacional), bem como capacitar novos multiplicadores e usuários finais. Para isso, será apresentada uma visão prática do processo e cadastros educacionais, explorando os conceitos utilizados e as funcionalidades do Sistema. O material orienta a execução das atividades para garantir que todo o Processo Educacional mapeado durante o Programa seja contemplado.
Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários-chave da área Educacional do SESI e SENAI (DR-FIEC)
Metodologia
Este material tem como base a visão prática e completa do Processo Customizado da área Educacional através da Customização – Integração SGE x SALESFORCE FS008432. A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional. Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.
Expandir |
---|
title | Parâmetros da Customização |
---|
|
Pré-requisitos Os anexos de retorno 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. Image Modified
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: Módulo Educacional -Educacional-Aba Customização. ![](/download/attachments/646684182/worddav4f2a9b3be3264ccc97e937b3f16200a7.png?version=1&modificationDate=1635347567750&api=v2)
Detalhamento do processo A interface customizada estará disponível em: TOTVS Educacional | Customizações | Integração SALESFORCE | Parâmetros
![](/download/attachments/646684182/worddav821613a73d5fa702ef9440425c97c78c.png?version=1&modificationDate=1635347567847&api=v2)
![](/download/attachments/646684182/worddav6d963be7462f0c0ddbde35e7d8d8c418.png?version=1&modificationDate=1635347568043&api=v2)
A partir dela, o usuário poderá configurar os seguintes parâmetros: Dados de Conexão – WS, deve ser informado os dados: - Endereço WebService: informar o endereço de acesso ao WebService disponibilizado pelo Perseus.
- Usuário: informar o Usuário de acesso ao WebService disponibilizado pelo Perseus.
- Senha: informar a senha de acesso ao WebService disponibilizado pelo Perseus.
Aviso |
---|
Durante o refinamento do escopo, foi identificado que seria necessário utilizar o Webservice do Perseus ao invés do Webservice do SALESFORCE, fazendo a comunicação de dados do SGE com Perseus. Desta forma, o Perseus será responsável em realizar o envio de dados para o SALESFORCE. |
Status de Matrícula – Matrícula Será exibida uma visão onde o usuário deverá informar o (s) Status de Matrícula que serão considerados no processo de matrícula para envio ao SALESFORCE. Ao clicar em incluir, o campo exibido será do tipo lookup que ao selecionar a customização retornará todos os Status de matrícula (SSTATUS) cadastrados para aquele Nível de EnsinoInativar Contrato Cancelado: Usuário define o código da Situação de Matrícula que será utilizada para cancelar um contrato no Salesforce. Status de Matrícula – Inativar Contrato Serão criados dois parâmetros para que o usuário defina os Status de matrícula (Suspenso: Usuário define o código da Situação de Matrícula ) que a customização deverá considerar no processo de inativar contrato na Integração com o SALESFORCE. São eles: ● Situação de Matrícula - Cancelado: O campo será do tipo lookup que ao selecionar a customização retornará todos os Status de matrícula (SSTATUS) cadastrados pelo Nível de Ensino. ● Situação de Matrícula – Suspenso: O campo será do tipo lookup que ao selecionar a customização retornará todos os Status de matrícula (SSTATUS) cadastrados pelo Nível de Ensino. Os parâmetros "Status de Matrícula – Matrícula", "Status de Matrícula – Inativar Contrato" e Integração habilitada deverão ser parametrizados por Coligada e Nível de Ensino. Lembrete que será utilizada para suspender um contrato no Salesforce. Status de Matrícula Inicial - Importação Salesforce: Usuário define o código da Situação de Matrícula que será utilizada para matricular o aluno no SGE pelo processo de Importação de Matrícula. Os parâmetros "Status de Matrícula – Matrícula", "Status de Matrícula – Inativar Contrato" e Integração habilitada deverão ser parametrizados por Coligada e Nível de Ensino.
Modalidades de Curso - Técnicas e EJA Será exibida uma visão onde o : O usuário deverá informar a(s) Modalidade(s) de Curso(s) cadastro nativo (SMODALIDADECURSO). Para todos os cursos que estiverem vinculados às modalidades informadas neste parâmetro, no envio da Matriz Curricular /Plano de Curso a customização irá enviar para o SALESFORCE a modalidade "Técnico". Para as modalidades que não estiverem parametrizadas, será enviado "Curta e Média duração". Essa classificação é utilizada no SALESFORCE para agrupamento dos planos de pagamento. Ao clicar em incluir, será exibido o seguinte campo:Modalidades Técnicas e EJA: será do tipo lookup e ficará a cargo do usuário selecionar a modalidade do cadastro nativo (SMODALIDADECURSO)agrupamento dos planos de pagamento. A FIEC poderá incluir novas modalidades de acordo com a necessidade. Observação: Nota |
---|
Inicialmente serão as modalidades dos Cursos Técnicos SENAI e futuramente, a FIEC deseja incluir as modalidades do SESI. | ImportanteTodos os campos serão de preenchimento obrigatório e gravados em tabela customizada.A parametrização será de responsabilidade do cliente.Para o correto funcionamento da customização, todos os dados deverão ser parametrizados corretamente.Os protótipos são meramente ilustrativos, podendo variar ao longo do desenvolvimento de acordo com a ferramenta TOTVS.Essa parametrização será realizada por coligada e Nível de Ensino.
|
Expandir |
---|
title | Cadastro de Serviços CRM |
---|
|
- Código do Serviço: Será preenchido com o código do serviço enviado pelo CRM.
- Descrição do Serviço: Será preenchido com o nome do serviço enviado pelo CRM.
- Produto Protheus: Será preenchido com código do produto Protheus enviado pelo CRM.
- Prefixo: Será preenchido com o prefixo enviado pelo CRM.
- Natureza Financeira: Será preenchido com o código da natureza enviado pelo CRM.
- Ativo/Inativo: Será preenchido com status do serviço enviado pelo CRM.
Importante Os campos Código e Descrição do Serviço CRM serão bloqueados para edição/exclusão através dessa interface, os demais campos deverão ficar liberados para edição.
|
Anexo de Serviço do Curso- CRM/SALESFORCE
3.1 Objetivo
Será criado um anexo customizado para armazenar o vínculo do serviço CRM ao Curso do SGE. Os serviços serão criados pelo processo customizado no SGE, replicando o cadastro do CRM/SALESFORCE.
A criação do anexo customizado Serviço/Produto, estará disponível na interface nativa de Cursos e poderá ser acessado em: TOTVS Educacional | Currículo e Oferta | Cursos | Anexos.
Lookup são os ...Campo Serviço/Produto: O campo será do tipo lookup e exibirá o código e a descrição do Serviço CRM vinculado ao cadastro do curso. Esse serviço será importado pelo webservice. O vínculo do serviço é necessário para definição do serviço do plano de pagamento que será utilizado para geração de títulos no Protheus, carregando assim as informações do Produto, Natureza Financeira e Prefixo para os títulos gerados. O serviço CRM só será importado para o SGE se possuir produto Protheus informado. Será vinculado apenas um serviço ao curso no SGE
3.2 Exportação do curso para o Perseus
Para ofertar o Curso e exportá-lo para o Perseus, serão necessários os seguintes passos:
- Cadastrar o Curso no SGE;
- Cadastrar a Matriz Aplicada do Curso (oferta do curso por turno e filial)
- Exportar o Curso/Matriz para Perseus
- Cadastrar serviço no CRM referente ao Curso no Protheus.
- Desbloquear o produto do Protheus referente ao serviço CRM.
- Importar os Serviços do CRM/Perseus para o cadastro customizado de serviços CRM do SGE e o vínculo com o Curso. Este passo será automatizado pelo processo descrito no Req.03. a. A importação também preencherá a Natureza financeira, Código do produto Protheus e Prefixo, desde que sejam enviadas no serviço. São dados necessários para integração com Protheus.
- Importar o Plano de pagamento padrão da Matriz Aplicada.
- Cadastrar turmas no SGE.
- Exportar as Turmas para o Perseus
- Se existir preço específico por turma, o preço deverá ser definido no SALESFORCE e devolvido ao SGE e associado à turma, através do Webservice. Neste caso, será criado um plano de pagamento específico para a turma.
- Nas interfaces do SGE onde o usuário seleciona o plano de pagamento, será criado filtro (req.08) para mostrar apenas planos de pagamento da turma. Quando existir plano na turma selecionada, mostrar apenas os específicos. Caso contrário, mostrar os planos da matriz, excluindo os que são de uma turma específica.
Após os passos acima, as turmas que forem criadas poderão ser enviadas ao SALESFORCE. Se for necessário inativar o serviço, essa ação deverá ser realizada no CRM e está prevista atualização desta informação no SGE, através do webservice definido no Serviço para atualização de Serviço/Produto CRM/SGE) deste documento.
Serviço para atualização de Serviço/Produto CRM/SGE
4.1 Objetivo
Foi criado um Webservice do SGE para receber inclusão de serviços do CRM, seu vínculo com o produto do Protheus e realizar o vínculo do Serviço como o Curso do SGE. Será possível também o CRM enviar a atualização do status do serviço (inativar/ativar), para o SGE.
Quando desativados, as matrizes aplicadas associadas ao serviço alterado serão bloqueadas no SGE para recebimento de matrículas e criação/envio de turmas ao SALESFORCE. Detalhando a criação de um Webservice Inclusão de Serviços Educacionais/CRM que ficará disponível para ser chamado pelo CRM, sempre que um serviço/produto for incluído, inativado ou reativado, para que essa informação seja repassada ao SGE. O serviço importará também o vínculo com o curso do SGE, preenchendo o anexo customizado.
Para acessar, clicamos em: TOTVS Educacional |Customização |Integração SALESFORCE|Serviço CRM, para o serviço do webservice CRM.
Preencher os dados necessários do Serviço CRM, para integração com Protheus
Ao executar a chamada do webservice, se for inclusão de um serviço novo, o processo irá:
● Incluir o Serviço CRM no SGE (cadastro customizado).
● Preencher todos os dados do serviço:
- Código do produto do Protheus (obrigatório),
- Código da Natureza Financeira do Protheus
- Prefixo
- Status
● Vincular o Serviço CRM no anexo customizado do Curso
Ao executar a chamada do webservice, se for atualização de um serviço existente será permitido alterar o status e o processo deverá identificar o serviço CRM no SGE através do código e atualizar seu status no cadastro customizado.
O código do produto Protheus é obrigatório para inclusão do serviço CRM no SGE. Caso as informações do Protheus (produto, natureza financeira e prefixo) não sejam enviadas, será necessário cadastrá-las manualmente através do cadastro de serviço CRM customizado. Os cadastros de Produtos e Natureza Financeira do CRM precisam estar equivalentes aos cadastros do Protheus/SGE, com os mesmos códigos, para que seja possível efetuar o de-para entre os cadastros/sistemas. Os cadastros de Produtos e Natureza são integrados entre Protheus e SGE exatamente como forem importados do CRM, no momento do envio do Pedido de Venda (integração Protheus).
É importante que o Webservice seja acionado pelo CRM apenas para envio de serviços relacionados à mensalidades/cursos. Demais serviços já deverão estar disponíveis no SGE, como por exemplo: segunda via de histórico, taxa de material escolar, multa rescisória, dentre outros.
O Nível de ensino do SGE é definido por coligada e corresponde à Linha do Serviço do CRM (geral - SESI e SENAI).
O CRM deverá enviar o código de nível de ensino existente no SGE, realizando antes do envio, o 'DE-PARA correspondente à Linha do Serviço (CRM), por coligada no SGE.
Abaixo, segue base do DE-PARA CRM x SGE para envio dos códigos.
![](/download/attachments/646684182/worddav865c06854c59ed99941e9de20d6bf0f1.png?version=1&modificationDate=1635347568553&api=v2)
Quando o serviço do CRM for atualizado com status inativo, não serão atualizadas as matrizes curriculares dos cursos relacionados, já que se fossem inativadas, não seriam permitidas novas matrículas para as turmas já existentes.
Por isso, foi criado um novo requisito para bloquear a criação de novas turmas no SGE quando o serviço do CRM (cadastro customizado) estiver inativo. Caso seja necessário ativar um Serviço/Produto novamente no CRM, o webservice do SGE irá receber o status ativo e alterar o status no cadastro do serviço CRM. Feito isso, poderão ser criadas novas turmas de oferta no SGE. No final de cada processamento, os dados enviados na API serão registrados na tabela de log, e poderão ser visualizados pelo usuário através da interface de Monitor de Log. Não será permitido reprocessamento de registro (reenvio) através do SGE.
Importante
De acordo com processo da FIEC, só é possível desativar um serviço no CRM quando todas as turmas ofertas estiverem finalizadas (período de matrícula finalizado).
Após desativação do serviço, a matriz curricular no SGE ficará inativa, bloqueando novas matrículas (em turmas já existentes) e criação de novas turmas.
- Só será possível alterar o status do serviço no CRM, a ativação/inativação não irá ocorrer no SGE.
- A alteração do produto, natureza financeira e prefixo será definido na integração do Protheus. ▪ O código do produto Protheus é obrigatório para inclusão do Serviço no SGE. Será de responsabilidade da FIEC identificar o momento correto do envio do serviço para o SGE.
- A API será disponibilizada junto às demais APIs nativas do SGE e ficará na mesma estrutura da instalação do Portal Educacional.
- A autenticação é feita através de token.
Processo Customizado Exportação de Curso / Matriz Aplicada
5.1 Premissa
Cadastro do Curso já realizado - Anexo - Serviço do Curso -Habilitação - Matriz Curricular -Anexo - Matriz Aplicada Anexo -Gratuidade de Curso.
5.2 Objetivo
O objetivo deste requisito é possibilitar o envio dos dados de criação de novos cursos no cadastro Currículo e Oferta | Estrutura Curricular | Cursos do TOTVS Educacional para o Perseus/SALESFORCE
5.3 Cadastro do Curso
Cadastrar o curso
Clicar em Anexos –Serviço do Curso
Incluir o Serviço/Produto do Curso ![](/download/attachments/646684182/worddav9512702dcbde000cb9704a3f17477a86.png?version=1&modificationDate=1635347568767&api=v2)
5.4 Cadastro da Matriz Aplicada
No SGE as matrizes aplicadas possuem a informação do turno. O CRM não precisa de informações de turno para definir os preços dos cursos, no entanto, para realizar a precificação da matriz ou turma por turno no CRM, será necessário realizar o cadastro de Matriz Aplicada vinculada ao Curso no SGE, para cada turno e unidade/filial.
O cadastro deverá ser feito no caminho TOTVS Educacional | Currículo e Oferta | Matrizes Curriculares | Anexos | Matriz Aplicada.
Na Matriz Curricular-Anexos -Matriz Aplicada
Em Matriz Aplicada –Anexos- Gratuidade do curso, informar se o curso será gratuito ou não.
Informar se curso será gratuito ou não
Para identificar os Cursos Gratuitos e Não Gratuitos, foi criado um novo campo complementar no cadastro da Matriz Aplicada que será ofertado no nível de unidade/filial, possibilitando que o usuário informe se é gratuito ou não.
Para cursos gratuitos, é necessário informar no cadastro do Curso Habilitação do Aluno ou na matrícula do aluno no Período Letivo que é gratuita (campo complementar Condição do Aluno), para que essa informação não seja enviada para produção, através da solução integradora.
Toda estrutura de oferta criada para o curso/matriz aplicada que estiver definido como Gratuito este não será considerado para o envio ao Perseus.
Será enviado para integração apenas o curso/matriz aplicada que estiver definido como Não Gratuito e será integrado no Perseus.
Após o processamento, o Perseus retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro. Ao final do processamento, os registros serão gravados em tabela customizada de log.
5.3 Exportação de Cursos
Será criada uma nova interface customizada Exportação de Cursos para o correto funcionamento desta integração. Estará disponível em: TOTVS Educacional | Customizações | Integração SALESFORCE | Exportação de Cursos.
![](/download/attachments/646684182/worddav7ce07d00fc8bbef2b85a33b8287aa439.png?version=1&modificationDate=1635347569077&api=v2)
5.4 Agendamento/Exportação
Esse processo poderá ser executado manualmente ou agendado conforme demanda da FIEC, e será responsável por realizar a exportação dos dados de cursos do SGE para o Perseus, que posteriormente será responsável por enviá-los ao SALESFORCE. Abaixo, segue tela com opções de agendamento.
Bloqueio na Criação de Turmas de Curso Não Gratuitos no SGE
6.1 Objetivo
Bloquear a criação de turmas no SGE, para as matrizes aplicadas de cursos Não Gratuito quando não houver vínculo do serviço CRM no Curso ou quando o serviço vinculado estiver inativo no cadastro customizado do Serviço CRM no SGE.
Uma turma poderá ser cadastrada através das interfaces nativas do SGE, que estará disponível em dois locais diferentes sendo eles:
- TOTVS Educacional | Currículo e Oferta | Turmas e Turmas/Disciplinas ou;
![](/download/attachments/646684182/worddav024d636f00c6adb06fbbebc7b261468a.png?version=1&modificationDate=1635347569213&api=v2)
- No assistente para criação de turmas e turmas/disciplinas, em: Totvs Educacional | Atividades Acadêmicas | Assistentes | Cadastro de turma e turma/disciplina.
Quando o usuário for realizar a inclusão de uma turma referente a um curso Não Gratuito no SGE (campo complementar da matriz aplicada), a customização deverá validar se existe serviço CRM vinculado ao Curso e seu status estiver ativo. O vínculo será verificado através do anexo customizado Anexo de Serviço do Curso - CRM/SALESFORCE.
Caso o vínculo esteja correto, será possível cadastrar novas turmas. Caso contrário, não será permitido realizar a criação da turma e será exibido uma mensagem de alerta conforme exemplo:
Importante
▪ Será de responsabilidade da FIEC, desbloquear para oferta o produto do Protheus referente ao serviço no CRM.
▪ Um mesmo serviço CRM poderá estar vinculado a vários cursos do SGE. Caso o serviço CRM esteja inativo, a criação das turmas de todas as matrizes aplicadas vinculadas a este serviço serão bloqueadas.
Processo Customizado Exportação de Turma
7.1 Premissas
Ter a turma cadastrada no SGE.
7.2 Objetivo
Exportar a criação e atualização das Turmas do SGE para o Perseus, contendo todas as informações necessárias para que o Perseus efetue a criação das Turmas (produtos) no SALESFORCE.
Este processo customizado possibilita o envio dos dados de criação e atualização de novas turmas no cadastro Currículo e Oferta | Oferta | Turmas do TOTVS Educacional para o Perseus/SALESFORCE.
Estando disponível em: TOTVS Educacional | Customizações | Integração SALESFORCE| Exportação de Turmas.
Selecione Exportação da Turma
O Processo de Exportação de Turma,Clique em Executar
Aguarde a execução do processo de Exportação de Turma ![](/download/attachments/646684182/worddav427fdc21b459f12a7577d3964757925d.png?version=1&modificationDate=1635347569620&api=v2)
7.3 Agendamento/Exportação
Esse processo poderá ser executado manualmente ou agendado conforme demanda da FIEC, e será responsável por realizar a exportação dos dados das turmas do SGE para o Perseus, que posteriormente será responsável por enviá-los ao SALESFORCE. Abaixo, segue tela com opções de agendamento.
A customização acionará o método do Webservice Perseus sempre que o processo for executado, para envio das turmas, incluídas e atualizadas desde a última execução ou que estejam pendentes de integração.
A exportação de Turma ocorrerá se atender às seguintes regras:
- *Deverá ter o campo de Número Máximo de Alunos preenchido.
*Deverá ter informação da Data Inicial preenchida, pois essa data vai determinar a abertura de matrículas no SALESFORCE
*Deverá ter informação da Data Final preenchida, pois essa data vai determinar data limite para encerramento de matrículas no SALESFORCE
![](/download/attachments/646684182/worddavbf682e59e5e544441756fabfcc73aaa7.png?version=1&modificationDate=1635347569927&api=v2)
Deverá ter informação do Serviço/Produto vinculado ao cadastro do curso no anexo customizado ![](/download/attachments/646684182/worddav9512702dcbde000cb9704a3f17477a86.png?version=1&modificationDate=1635347568767&api=v2)
- A matriz curricular da turma ofertada deverá estar com status igual Ativa ou Atual para a turma ser integrada no SALESFORCE
![](/download/attachments/646684182/worddavb479f50aa86f4cf9d330354a97a5c2d4.png?version=1&modificationDate=1635347568863&api=v2)
Todas as turmas criadas atendendo os critérios acima serão enviadas, a customização deverá enviar apenas o cadastro de Turma (sem disciplinas).
Após desativação do serviço, a matriz curricular no SGE ficará inativa, bloqueando novas matrículas (em turmas já existentes) e criação de novas turmas.
A Turma será enviada como Ativa, porém existem alguns critérios que desativam as turmas. Nestes casos, precisamos enviar os registros dessas turmas com status Inativo na integração, conforme critérios abaixo:
- Quando a Data início do período de matrícula da turma não estiver sido atingida - Período de matrícula ainda não iniciado (período definido na configuração de matrícula da parametrização por Curso).
- Quando a Data final do período de matrícula da turma for atingida - Turma encerrada para matrícula (período definido na configuração de matrícula da parametrização por Curso).
- Quando a capacidade máxima da turma for atingida - Turma cheia. Através dos critérios acima, o SALESFORCE poderá controlar a oferta das Turmas (Produto), bloqueando a oferta de vendas, se necessário.
Os registros de turmas serão exportados (inclusão e alteração) até que a data final da turma, seja atingida. Após esse período, a turma não será mais enviada para este processo. Após o processamento, o Perseus retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro. Ao final do processamento, os registros serão gravados em tabela customizada de log.
Importante De acordo com processo da FIEC, só é possível desativar um serviço no CRM quando todas as turmas ofertas estiverem finalizadas (período de matrícula finalizado). Processo de Importação de Vendas - Matrículas SALESFORCE (EM ESPECIFICAÇÃO)
Em especificação
Processo de Alteração de Situação de Matrícula - Inativar Contrato e Atualização de Vagas na Turma
9.1 Premissas
Aluno ter contrato no educacional (SGE).
9.2 Objetivo
Exportar do SGE para o SALESFORCE os dados de cancelamento ou suspensão de contrato e atualização de vagas na turma, sempre que a situação de matrícula do aluno no período letivo for alterada para um status parametrizado que exige alteração contratual e libere a vaga do aluno na turma.
Ao alterar a situação de matrícula do aluno no período letivo para uma das situações parametrizadas na aba Status de Matrícula – Inativar Contrato,o processo customizado identificará a modificação e acionará os serviços do SALESFORCE, enviando o registro para que o contrato do aluno seja Cancelado ou Suspenso no SALESFORCE e atualizar a turma com a quantidade de alunos matriculados.
Abaixo veremos o exemplo de alteração de situação de matricula de um aluno e o cancelamento do contrato após a alteração da situação de matricula.
Selecione a matricula do aluno no Período Letivo. Clique em Processos –Alterar situação de matrícula.
Informe o motivo de alteraçãoSelecione a nova situação de matricula Cancelado ou Suspenso
Clique em executar
Aguarde a execução do processo
Após a execução do processo o contrato será cancelado.
9.3 Visão da tela de contrato antes e após o cancelamento.
Visão do contrato ativo antes de ser cancelado. ![](/download/attachments/646684182/worddav60336aa5fdaeae5b004bacc575811412.png?version=1&modificationDate=1635347570623&api=v2)
Visão contrato após ser cancelado. ![](/download/attachments/646684182/worddav49003497b18a58a21a8f663758d989dc.png?version=1&modificationDate=1635347570800&api=v2)
A integração de Cancelamento do Contrato Financeiro de matrículas de alunos que já foram integrados no SALESFORCE e tiveram a situação de matrícula alterada no SGE. Os registros alterados serão exportados no mesmo processo de Exportação de matrículas do SGE para o SALESFORCE.
A customização acionará os métodos do Webservice SALESFORCE, sempre quando a situação de matrícula do aluno for alterada, para envio dos dados correspondentes.
A exportação de Cancelamento do Contrato Financeiro, ocorrerá se atender às seguintes regras:
- A integração do cancelamento do contrato irá ocorrer apenas no momento que a situação de matrícula do aluno for um valor existente nos parâmetros que indicam Inativação de Contrato (aba Status de Matrícula – Inativar Contrato) independente se o contrato/venda se originou no SGE ou no SALESFORCE.
- O registro do contrato do aluno no SGE deverá estar com status de Cancelado.Os status deverão ser parametrizados como Inativar Contrato. Quando for realizada alteração de situação de matrícula no período letivo, para um dos status parametrizados (Cancelado, Evadido, Desistente, Falecido, Trancado e etc.), a customização irá enviar para o SALESFORCE o registro do contrato financeiro do aluno, para que o mesmo seja Cancelado ou Suspenso no SALESFORCE.
Situação de matrícula: Cancelado
Na situação de matricula –Cancelado ou Suspenso, na aba status no Período Letivo marcar a flag –CANCELA CONTRATO FINANCEIRO
- Para os casos de alunos que estiverem Pré-Matriculados e desistiram do curso ou não realizaram o pagamento do boleto de matrícula dentro do prazo estipulado pela FIEC, o usuário terá que alterar a situação do aluno no SGE para Cancelado, para que ele libere a vaga na turma do SGE ,atualizando o campo Alunos Matriculados na turma.
Para alterar o status do aluno clique em Processos
Alteração da Situação de Matricula do Aluno Pré-Matriculado
Informe o novo status do aluno ![](/download/attachments/646684182/worddav75a1c583a1a3c134472c28654cdc6b94.png?version=1&modificationDate=1635347571123&api=v2)
- Após o usuário alterar a situação do aluno no SGE para Cancelado, a turma liberará a vaga na turma do SGE atualizando o campo Alunos Matriculados na turma.
Aqui podemos ver o N° de alunos antes da alteração da situação do aluno Pré-Matriculado para cancelado
Aqui podemos ver o N° de alunos após alterar a situação do aluno Pré-Matriculado para Cancelado –Vaga disponível atualizado.
A atualização das vagas da turma ocorrerá sempre que o status de matrícula do período letivo for alterado para um dos valores parametrizados (Cancelamento ou Suspensão).
Importante
Para os processos de alteração de Matrícula pelo menos uma situação de matrícula, por exemplo: Cancelado, Evadido etc. deve estar parametrizado. A parametrização será de responsabilidade da FIEC.
O cancelamento do contrato será realizado apenas no SGE e o status integrado no SALESFORCE, não está contemplado cancelamento diretamente no SALESFORCE
O caminho para execução deste processo está disponível em:
TOTVS Educacional| Matricula e Avaliação| Menu Mais…| Confirmação de matrícula por pagamento (recurso nativo no RM).
Selecionar Matricula e Avaliação –Mais... –Confirmação de matrícula por pagamento
Após o processamento, o SALESFORCE retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro. Ao final do processamento, os registros serão gravados em tabela customizada de log.
Anexo Dados Complementares do Contrato
10.1 Objetivo
Foi criado um anexo customizado no cadastro de contratos do SGE, para armazenar as informações da compra pelo E-Commerce e outros campos referente ao cálculo de multa rescisória do contrato e crédito do aluno (tratados pelo escopo da integração com Protheus.)
Detalhamos a criação de um anexo customizado Dados Complementares do Contrato, que estará disponível na interface nativa de Contratos e poderá ser acessado em: TOTVS Educacional | Financeiro/Contábil | Contratos| Anexos, para armazenar as informações referente a compra realizada pelo E- Commerce e cálculo de multa rescisória e crédito do aluno, caso existam para aquele contrato.
Os dados da compra serão preenchidos automaticamente pela customização através do processo de importação de Vendas/Matrículas do SALESFORCE para o SGE, detalhado no Processo de Importação de Vendas - Matrículas SALESFORCE. (EM ESPECIFICAÇÃO)
Selecionar o contrato do aluno - Anexos
Clicar em Anexos-Dados complementares do Contrato
Informações da compra pelo E-Commerce serão preenchidos automaticamente através da customização
Além dos campos definidos pela integração do Protheus serão criados mais quatro campos sendo eles:
- Data da Compra: Campo preenchido pela integração com a data da venda (oportunidade fechada), o mesmo não poderá ser editado pela interface.
- E-commerce: Campo preenchido pela integração com Sim ou Não, o mesmo não poderá ser editado pela interface.
- ID Oportunidade Venda: Campo preenchido pela integração com o identificador da oportunidade gerada pelo SALESFORCE, o mesmo não poderá ser editado pela interface.
- Recebe Boleto por E-mail: Campo preenchido pela integração com Sim ou Não, o mesmo não poderá ser editado pela interface. Os campos listados serão preenchidos automaticamente através das rotinas de importação e exportação de matrículas, conforme definido neste escopo.
Observação: Os campos referentes ao cálculo da multa não serão tratados neste manual e serão detalhados no escopo da integração com Protheus.
Requisito em especificação (Será atualizado e incluído novos campos ) ATUALIZAR QUANDO ESTIVER LIBERADO
Interface de Log
11.1 Objetivo
O objetivo da Interface de Log é armazenar informações e status dos dados que foram exportados do SGE para o SALESFORCE.
Para armazenamento das informações foi criado no menu do TOTVS Educacional uma interface customizada, sendo o Monitor de LOG. Nesta interface customizada será possível realizar consultas dos Logs de todas as operações de exportação executadas pela integração do TOTVS Educacional com SALESFORCE. Será utilizada a funcionalidade de Log genérico padrão.
Os históricos das exportações de dados para o Protheus serão registrados e poderão ser visualizados no menu TOTVS Educacional | Customização | Integração SALESFORCE | Monitor de Log
Na tela de log estarão disponíveis os seguintes campos:
▪ Id Log: Identificador sequencial de Log;
▪ Campos Chave: Descrição dos campos utilizados para gerar o registro integrado;
▪ Valores Chave: Chave primária do registro integrado;
▪ Status: Situação da Integração (Sucesso ou Erro);
▪ Funcionalidade: Tipo de Processo que está sendo feito
Exemplo: Exportação de Curso
▪ Módulo: Tipo da integração que está sendo feita;
▪ Data de Criação: Data de Criação do registro;
▪ Data da última alteração: Data da última alteração do registro.
Visualização do monitor de Log
Será apresentada ao usuário uma visão com a relação de registros importados e exportados. Não será possível incluir, editar ou excluir informações através dessa interface.
O campo processo será exibido de acordo com o respectivo código:
- Exportação de Curso/Matriz Aplicada
- Exportação de Turma
- Exportação de Alteração/Situação de Matrícula
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.
Visualização do monitor de Log com o Item do Log
Estarão disponíveis os seguintes campos:
- Id. Item Log: Identificador sequencial do item 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;
Campos na identificação do LOG.
Processo para Reenvio de Dados
12.1 Objetivo
O Processo de reenvio de dados é permitir o envio para o Protheus dos registros não foram exportados corretamente. Esse processo poderá ser executado manualmente ou poderá ser agendado, por registro com status de cancelado, erro ou pendente e a integração efetuará a exportação dos registros novamente.
A funcionalidade estará disponível na tela de Monitor de Logs, menu Processos | Reenvio de Registros.
Será permitido o usuário selecionar apenas um registro quando o mesmo estiver com o status de Cancelado, Erro ou Pendente
e poderá ser executado manualmente. Ou caso o usuário não selecione nenhum registro na visão do Monitor de Logs, ele poderá executar ou agendar o reenvio, o processo processará novamente todos os registros com os status Erro ou Pendente. Ao ser acionado o processo customizado de reenvio de dados a customização tentará realizar novamente o envio das informações ao Protheus, caso consiga o status do registro passará para Sucesso.
Selecionar apenas um registro quando o mesmo estiver com o status de Cancelado, Erro ou Pendente
Clicar em Reenvio Registros com erro
O processo de reenvio automático será executado até atingir o número máximo de tentativas parametrizado. Caso o parâmetro esteja vazio a customização não realizará nenhuma tentativa de reenvio automaticamente. Caso seja atingido o número máximo de tentativas de reenvio e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado, sendo o registro não integrado com o Protheus.
Após selecionar o log que será reenviado, abrirá uma tela de processo, clique em Executar
Aguarde o processo ser executado
Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio. O reenvio será realizado conforme regras definidas nos requisitos originais de cada funcionalidade de exportação..
![](/download/attachments/646684182/worddav689c6b7f91c5f1a6fa37681a6e9117c0.png?version=1&modificationDate=1635347572847&api=v2)