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 | ||||
---|---|---|---|---|
| ||||
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. 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. Detalhamento do processo A interface customizada estará disponível em: TOTVS Educacional | Customizações | Integração SALESFORCE | Parâmetros A partir dela, o usuário poderá configurar os seguintes parâmetros: Dados de Conexão – WS, deve ser informado os dados:
Status de Matrícula – Inativar 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 Suspenso: Usuário define o código da Situação de Matrícula 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. Modalidades de Curso - Técnicas e EJA: 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. A FIEC poderá incluir novas modalidades de acordo com a necessidade.
|
Expandir | |||||
---|---|---|---|---|---|
| |||||
Pré-requisitos Armazenar as informações referentes ao serviço do CRM, que serão importadas para o SGE. Tais informações serão utilizadas no envio do pedido de venda do SGE para o Protheus. Detalhamento do processo A interface customizada estará disponível em: TOTVS Educacional | Customizações | Integração SALESFORCE | Serviço CRM A interface exibirá os seguintes campos:
olha o filtro desejado e clique em Executar
|
Expandir | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Pré-requisitos Não se aplica. Detalhamento do processo Ao executar a chamada do webservice, se for inclusão de um serviço novo, o processo irá:
Detalhamento do processo ![]() Ao executar a chamada do webservice, se for atualização inclusã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. 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. Só será possível alterar o status do serviço no CRM, a ativação/inativação não irá ocorrer no SGE. novo, o processo irá:
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.
|
Linha do Serviço CRM | Nível de Ensino SGE | Código do Nível de Ensino SGE | Coligada |
Educação Básica | Educação Básica | 1 | 2-SESI |
Educação Continuada | Educação Continuada | 3 | 2-SESI |
Educação Profissional e Tecnológica | Educação Profissional | 1 | 3-SENAI |
Educação Superior | Educação Superior | 2 | 3-SENAI |
Serviços de Educação | Educação Profissional | 1 | 3- SENAI |
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 SGEA 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.
Expandir | ||
---|---|---|
| ||
Cadastro do Curso já realizado - Anexo - Serviço do Curso -Habilitação - Matriz Curricular -Anexo - Matriz Aplicada Anexo -Gratuidade de Curso. 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 Cadastro da Matriz Aplicada
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. 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. Agendamento/Exportação
|
Expandir | ||
---|---|---|
| ||
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.
|
Bloqueio na Criação de Turmas de Curso Não Gratuitos no SGE
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.
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 informação do Serviço/Produto vinculado ao cadastro do curso no anexo customizado
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:
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 Alteração de Situação de Matrícula - Inativar Contrato e Atualização de Vagas na Turma
Aluno ter contrato no educacional (SGE).
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.
Visão do contrato ativo antes de ser cancelado.
Visão contrato após ser cancelado.
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:
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 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
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.
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:
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
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:
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:
Campos na identificação do LOG.
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..