Histórico da Página
Manual Operacional - Integrações SGE X CRM X ERP
O manual a seguir visa detalhar a solução proposta para Integrações dos sistemas Benner, CRM e Office com TOTVS.
| title | Parâmetros da Integração |
|---|
Pré-requisitos
Não se aplica.
Descrição do processo
Foi desenvolvido um cadastro customizado, onde será possível informar os parâmetros referentes ao processo de integração com o CRM.Este cadastro ficará disponível através do menu Customização | Inregração CRM | WebService CRM, conforme imagem abaixo:
Figura 16 - Menu customização
Ao acionar esta opção, será apresentada uma tela de cadastro, padrão do CorporeRM onde será exibido os seguintes campos:
- Endereço Ws CRM: Neste campo deverá ser informado o endereço do WebService que será utilizado para a atualização do Produto no CRM.
- Chave: Deverá ser informado o valor da Chave utilizada na autenticação do WebService.
Figura 17 - Cadastro do Responsável
Detalhamento dos campos
ZPARAMCRMWEBSERVICE
Campo
Descrição
Observações
CODCOLIGADA
Código da Coligada
Preenchimento obrigatório
ENDERECOWS
Endereço do WebService CRM
Preenchimento obrigatório
CHAVEWS
Chave criptografada utilizada na autenticação do WebService CRM
Preenchimento obrigatório
| title | Parâmetros da Integração CRM – Situação de Matricula |
|---|
Pré-Requisitos
Não se aplica.
Descrições do Processo
Foi desenvolvido um cadastro customizado, onde será possível informar os parâmetros referentes ao processo de integração com o CRM.Este cadastro ficará disponível através do menu "Customização | Inregração CRM | Situação de Matrícula", conforme imagem abaixo:
Figura 18 - Menu customização
Ao acionar esta opção, será apresentada uma visão de dados, padrão do CorporeRM que apresentará de acordo com o filtro selecionado as situações de matrícula que serão consideradas como matriculado na apuração de vagas.
Para informar uma nova situação, o usuário deverá acionar o botão "Novo", onde será apresentada uma tela exibindo o campo Cod. Status, que apresenta todas as situações previamente cadastradas na tabela SSTATUS.
Figura 19 – Cadastro da situação de matrícula
Detalhamento dos campos
ZPARAMCRMSTATUSMATRICULA
Campo
Descrição
Observações
CODCOLIGADA
Código da Coligada
Preenchimento obrigatório
CODSTATUS
Código do status
Preenchimento obrigatório
| title | Consulta turmas com Matrícula em Aberto |
|---|
Pré - requisitos
Não se aplica.Descrições do Processo
Foi disponibilizado pela customização um WebService que será responsável por retornar as turmas com Matrícula em Aberto no TOTVS Educacional.Uma vez o WebService instalado e devidamente configurado, conforme descrito no início deste documento, o sistema CRM, deverá configurar suas conexões que devem apontar para o diretório em que foi configurado o WebService.
Abaixo segue uma demonstração básica desta configuração utilizando o programa openSource denominado "SoapUI" e que poderá ser utilizado para realizar testes de conexão com o TOTVS.
Para isso, o serviço do RM.Host no servidor de aplicação deverá estar ativo e o arquivo Web.config devidamente configurado.
Para mais detalhes do SoapUI, acesse: http://www.soapui.org/
Para baixar o programa acesse: http://sourceforge.net/projects/soapui/files/
Acesse o menu "File | New SOAP Project", para informar a conexão com o WebServices.
Figura 20 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.
Figura 21 - Diretório do WebService com WSDL
Será apresentado na árvore do projeto todos os WebMetodos disponíveis no WebService e para cada método, será necessário informar o usuário e senha de conexão do Corpore, e o tipo de senha deverá ser "PasswordText", conforme figura abaixo.
Figura 22 - Configuração do Usuário e Senha
O sistema CRM ao realizar a consulta no WebService deverá informar o item de Venda conforme imagem abaixo:
Figura 23 – Chamada do método ConsultaVagas
Na consulta, a customização, encontrará a Matriz Aplicada vinculada ao item de venda enviado.
Através da Matriz Aplicada será verificado na Matriz curricular se o controle de alunos do curso está parametrizado para ser feito por "Turma", conforme regra definida pelo SESI/SENAI. Caso não esteja, será gerado XML de erro e o processo finalizado.
Caso contrário, para cada turma vinculada a Matriz Aplicada será apurado:
- O número máximo de alunos permitido para a turma (STURMA.MAXALUNOS)
- O número de alunos matriculados na turma. Para este cálculo será levado em consideração a situação de matricula parametrizada conforme rotina descrita no item 6 deste documento. Somente as situações parametrizadas serão consideradas. (Contador de alunos na SMATRICPL)
- E por último, o número de vagas disponíveis para a turma (NUMMAXALUNO - NUMALUNOSMATRIC).
Figura 24 – Retorno do WebService com erro
Figura 25 – Retorno do WebService com Sucesso
PARÂMETROS DAS INTEGRAÇÕES
Caminho de acesso: TOTVS Educacional > Customização> Integração SGE x CRM
CAMPOS DE PARÂMETROS:
Os campos de parâmetros listados abaixo possibilitam a integração entre TOTVS Educacional X ERP X CRM.
Caminho de acesso: TOTVS Educacional > Customização>Integração SGE X CRM> Parâmetros da Integração SGE 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.
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.
NOVOS CONTRATOS:
Caminho de acesso: TOTVS Educacional > Customização> Parametrização das integrações
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.
| title | Dados da ocorrência para o item de venda |
|---|
Pré - requisitos
O Parâmetros da Integração CRM - WebService, deve ser executado com sucesso.
Para o perfeito funcionamento desta rotina, deverá ser criado na tabela complementar de Curso, os campos RETORNO e DATAATUALIZACAO, ESCOLARIDADEMINIMA, IDADEMINIMA, IDADEMAX, JUSTIFICATIVA, OBJETIVOS, OBJGERAL, OBJESP, COMPGERAL conforme imagens abaixo: 
Figura 26 – Campo complementar Retorno 
Figura 27 – Campo complementar DATAATUALIZACAO 
Figura 28 – Campo complementar ESCOLARIDADEMINIMA
Figura 29 – Campo complementar IDADEMINIMA 
Figura 30 – Campo complementar IDADEMAX
Figura 31 – Campo complementar JUSTIFICATIVA 
Figura 32 – Campo complementar OBJETIVOS
Figura 33 – Campo complementar OBJGERAL 
Figura 34 – Campo complementar OBJESP
Figura 35 – Campo complementar COMPGERAL
Descrições do Processo
No TOTVS Educacional assim que for criada e/ou atualizada a Matriz Aplicada ou o Anexo customizado de Dados do Contrato (implementado através da Especificação de Customização FS007270), será consumido método a ser disponibilizado no WebService do CRM enviando os dados complementares vinculados ao item de venda.O processo customizado será disparado através do botão salvar de qualquer um dos dois cadastrados mencionados acima.
O endereço webservice a ser consumido, assim como a chave para autenticação, deverão estar previamente parametrizados através do item 5 deste documento.
Os dados complementares vinculados ao item de venda a serem enviados para o CRM serão extraídos da Matriz Aplicada a qual o item de venda está vinculado.
O método a ser consumido será o AtualizarProduto, sendo enviadas as informações abaixo:
WEBSERVICE CRM: PRODUTOSOAP
Método: AtualizarProduto
Parâmetro
Descrição
Tipo
Requerido
Origem da Informação no TOTVS
produtoId
Número identificador do produto no AX
String
Not Null
Anexos de Dados Contratuais, campo Item de Venda
nomeDoProduto
Descrição do Item no AX
String
Not Null
SCURSO.NOME
casa
informar 2 para SESI, 3 para SENAI
Int
Not Null
GCOLIGADA.CODCOLIGADA (coligada 2 – Sesi,
coligada 3 – SENAI)
listaDePreco
Nome da Unidade
String
Not Null
GFILIAL.NOME
linhaDeAcao
Descrição da Linha de Ação do Programa (extraído do centro de responsabilidade do Item, enviado pelo AX)
String
Not Null
Através do terceiro nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME
familiaDoProduto
Descrição do Sub-Programa(extraído do centro de responsabilidade do Item, enviado pelo AX)
String
Not Null
Através do quarto nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME
classeDoProduto
Descrição da Modalidade(extraído do centro de responsabilidade do Item, enviado pelo AX)
String
Not Null
Através do quinto nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME
linhaDoProduto
Descrição da Área de Atuação(extraído do centro de responsabilidade do Item, enviado pelo AX)
String
Not Nul
Através do sexto nível do SHABILITACAOFILIAL.CODCCUSTO, busca GCCUSTO.NOME
tipo
fixo "Educação"
String
Not Null
fixo "Educação"
descrição
Texto como referência adicional para identificar o Produto/Item/Ocorrência.
String
Not Null
SCURSO.NOME
obrigatoriedades
campo com texto informando Escolaridade Mínima, Idade Mínima e Máxima para realizar o curso,
String
Not Null
Escolaridade Mínima = SCURSOCOMPL.ESCOLARIDADEMINIMA; Idade Mínima = SCURSOCOMPL.IDADEMIN
Idade Máxima = SCURSOCOMPL.IDADEMAX
grupoDeUnidadeDeMedidas
fixo "Unidade Padrão"
String
Not Null
fixo "Unidade Padrão"
unidadeDeMedidaPadrao
fixo "Unidade Principal"
String
Not Null
fixo "Unidade Principal"
ofereceDecimais
fixo 0
String
Not Null
fixo 0
dataInicio
Data de inicio do curso
Date
Not null
SGRADE.DTINIICIO
dataFim
Data de fim do curso
Date
Not null
SGRADE.DTFIM
justificativa
Justificativa do curso
Texto
Null
SCURSOCOMPL.JUSTIFICATIVA
objetivo
Objetivo do curso
Texto
Null
Se SESI:
SCURSOCOMPL.OBJETIVO
Se SENAI:
SCURSOCOMPL OBJGERAL
objetivoEspecifico
Objetivo especifico do curso
Texto
Null
Se SENAI:
SCURSOCOMPL OBJESPECIFICO
descricaoCurso
Descrição do Curso
Texto
Null
SHABILITACAOFILIAL.DESCRICAOCURSO
competenciaGeral
Competencia Geral do Curso
Texto
Null
Competência Geral (SCURSOCOMPL..COMPGERAL)
cargaHoraria
Carga horária do curso
Numerico
Not null
Carga Horária (SGRADE.CARGAHORARIA)
É importante ressaltar que para um item de venda poderá existir N matrizes aplicadas no mesmo curso.
O método AtualizarProduto retorna o status da atualização e uma mensagem de erro caso exista, este retorno assim como a data e hora da atualização, será armazenado em campo complementar do curso (SCURSOCOMPL.DATAATUALIZACAO, SCURSOCOMPL.RETORNO). É importante ressaltar que somente o registro da última atualização estará armazenado.
| title | Professores e Técnicos de Ensino |
|---|
Pré - requisitos
O Parâmetros da Integração CRM - WebService, deve ser executado com sucesso.Descrições do Processo
Foi disponibilizado pela customização um WebService que será responsável por sincronizar os dados das "pessoas" cadastradas no sistema Benner.Uma vez o WebService instalado e devidamente configurado, conforme descrito no início deste documento, o sistema CRM, deverá configurar suas conexões que devem apontar para o diretório em que foi configurado o WebService.
Abaixo segue uma demonstração básica desta configuração utilizando o programa openSource denominado "SoapUI" e que poderá ser utilizado para realizar testes de conexão com o TOTVS.
Para isso, o serviço do RM.Host no servidor de aplicação deverá estar ativo e o arquivo Web.config devidamente configurado.
Para mais detalhes do SoapUI, acesse: http://www.soapui.org/
Para baixar o programa acesse: http://sourceforge.net/projects/soapui/files/
Acesse o menu "File | New SOAP Project", para informar a conexão com o WebServices.
Figura 36 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.
Figura 37 - Diretório do WebService com WSDL
Será apresentado na árvore do projeto todos os WebMetodos disponíveis no WebService e para cada método, será necessário informar o usuário e senha de conexão do Corpore, e o tipo de senha deverá ser "PasswordText", conforme figura abaixo.
Figura 38 - Configuração do Usuário e Senha
O sistema Benner ao chamar o método InserePessoa, deverá informar um Xml contendo todas as informações nescessárias para inclusão de uma pessoa no TOTVS.
Para mais detalhes dos campos a serem enviados, consulte o documento de especificação "FS007273 – Integrações Benner,CRM e OFFICE" no requisito 21 e página 22.
Abaixo segue um exemplo da chamada ao WebSerivce:
Figura 39 – Chamada do método InserePessoa
Consumido o método, a customização verificará se os parâmetros passados são válidos. Se os parâmetros não forem válidos, será gerado XML de erro e o processo finalizado.
Se os parâmetros forem válidos, a customização verificará se o CPF se a pessoa já está cadastrada na tabela padrão do TOTVS.
Se existir, o processo customizado irá atualizar o registro da pessoa. Caso contrário, ou seja, a pessoa não exista, o processo customizado irá inserir um novo registro na tabela PPESSOA.
Tanto para inclusão quanto atualização, será utilizada funcionalidade padrão do TOTVS sendo validadas todas as regras de negócio do ERP Padrão.
Figura 40 – Retorno do WebService com Sucesso
| title | E-mail, senha inicial do professor/aluno |
|---|
Pré - requisitos
O Parâmetros da Integração CRM - WebService, deve ser executado com sucesso.Para o perfeito funcionamento desta rotina, deverá ser criado nas tabelas complementares de Aluno e Professor, os campos EMAIL e SENHA, conforme imagem abaixo:
Figura 41 – Campo complementar Email
Figura 42 – Campo complementar Senha
Descrições do Processo
Foi disponibilizado pela customização um WebService que será responsável por sincronizar os dados do endereço de e-mail e senha cadastrados no sistema OFFICE.Uma vez o WebService instalado e devidamente configurado, conforme descrito no início deste documento, o sistema OFICE, deverá configurar suas conexões que devem apontar para o diretório em que foi configurado o WebService.
Abaixo segue uma demonstração básica desta configuração utilizando o programa openSource denominado "SoapUI" e que poderá ser utilizado para realizar testes de conexão com o TOTVS.
Para isso, o serviço do RM.Host no servidor de aplicação deverá estar ativo e o arquivo Web.config devidamente configurado.
Para mais detalhes do SoapUI, acesse: http://www.soapui.org/
Para baixar o programa acesse: http://sourceforge.net/projects/soapui/files/
Acesse o menu "File | New SOAP Project", para informar a conexão com o WebServices.
Figura 43 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.
Figura 44 - Diretório do WebService com WSDL
Será apresentado na árvore do projeto todos os WebMetodos disponíveis no WebService e para cada método, será necessário informar o usuário e senha de conexão do Corpore, e o tipo de senha deverá ser "PasswordText", conforme figura abaixo.
Figura 45 - Configuração do Usuário e Senha
O sistema OFFICE ao chamar o método AtualizaEmail, deverá informar um Xml contendo todas as informações nescessárias para inclusão/Atualização dos campos e-mail e senha de uma pessoa no TOTVS.
Para mais detalhes dos campos a serem enviados, consulte o documento de especificação "FS007273 – Integrações Benner,CRM e OFFICE" no requisito 22 e página 28.
Abaixo segue um exemplo da chamada ao WebSerivce:
Figura 46 – Chamada do método AtualizaEmail
Consumido o método, será verificado se os parâmetros passados são válidos. Se os parâmetros não forem válidos, será gerado XML de erro e o processo finalizado.
Se parâmetros válidos, entre os parâmetros o método receberá um arquivo no formato XML, com layout conforme definido. O processo customizado irá verificar se Tag "RA" está preenchida. Se sim, através da coligada e do RA, o aluno será localizado no cadastro padrão do TOTVS Educacional e os campos complementares e-mail (SALUNOCOMPL.EMAIL) e senha inicial (SALUNOCOMPL.SENHA) atualizados de acordo com informação do registro no arquivo.
Caso contrário, ou seja, Tag "RA" não preenchida, através da coligada e do CPF, o professor será localizado no cadastro padrão do TOTVS Educacional e os campos complementares e-mail (SPROFESSORCOMPL.EMAIL) e senha inicial (SPROFESSORCOMPL.SENHA) atualizados de acordo com informação do registro no arquivo.
Não encontrando o registro no TOTVS, será gerado erro no arquivo de retorno.
Figura 47 – Retorno do WebService com Erro
Figura 48 – Retorno do WebService com Sucesso
| title | Processo Enviar dados da Matriz Curricular para CRM |
|---|
Pré - Requisitos
O processo customizado utilizará o webservice já existente de envio de informações para o CRM.
Descrição do Processo
Foi implementado um novo processo customizado na Integração SGE X CRM atual, que enviará para o CRM os dados alterados no item de venda através da Matriz Curricular no SGE.
O processo customizado Enviar Dados da Matriz Curricular estará disponível em: TOTVS Educacional | Customização | Integração SGE X CRM.
O processo será executado de forma manual ou por agendamento de job, onde serão enviados os dados alterados na Matriz Curricular no SGE, desde de a última execução do processo. Ao executar o processo, a customização enviará os dados alterados na Matriz Aplicada, no cadastro do Item de Venda, no anexo Dados ERP e na Filial, para serem atualizados no CRM.
| title | Importante: |
|---|
Import HTML Content
Visão Geral
Conteúdo das Ferramentas