Manual Operacional - Integrações

Benner, CRM e Office

O manual a seguir visa detalhar a solução proposta para Integrações dos sistemas Benner, CRM e Office com TOTVS.

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.

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:

Image Removed
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.

Image Removed
Figura 19 – Cadastro da situação de matrícula

Detalhamento dos campos

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.

Image Removed
Figura 20 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.

Image Removed
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.

Image Removed
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:

Image Removed
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).

Apurado o número de vagas das turmas, será gerado arquivo XML a ser retornado pelo WebService. É importante ressaltar que para o mesmo item de venda poderão ser apuradas mais de uma turma no período, por este motivo, o arquivo XML possuirá uma estrutura de repetição na turma.

Image Removed
Figura 24 – Retorno do WebService com erro

Image Removed
Figura 25 – Retorno do WebService com Sucesso

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:
Image Removed
Figura 26 – Campo complementar Retorno
Image Removed
Figura 27 – Campo complementar DATAATUALIZACAO
Image Removed
Figura 28 – Campo complementar ESCOLARIDADEMINIMA
Image Removed
Figura 29 – Campo complementar IDADEMINIMA
Image Removed
Figura 30 – Campo complementar IDADEMAX
Image Removed
Figura 31 – Campo complementar JUSTIFICATIVA
Image Removed
Figura 32 – Campo complementar OBJETIVOS
Image Removed
Figura 33 – Campo complementar OBJGERAL
Image Removed
Figura 34 – Campo complementar OBJESP
Image Removed
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:
O processo customizado irá enviar a atualização de apenas um produto (item de venda) por vez.
É 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.

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.

Image Removed
Figura 36 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.

Image Removed
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.

Image Removed
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:

Image Removed
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.

Image Removed
Figura 40 – Retorno do WebService com Sucesso

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:

Image Removed
Figura 41 – Campo complementar Email

Image Removed
Figura 42 – Campo complementar Senha

Expandir

title	Parâmetros da Integração CRM - WebServiceCustomização

Detalhamento

Pré-requisitos

Não se aplica.

Descrição do processoFoi 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:
Image Removed
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.

Image Removed
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

Expandir

title	Parâmetros da Integração CRM – Situação de Matricula

ZPARAMCRMSTATUSMATRICULA

Campo

Descrição

Observações

CODCOLIGADA

Código da Coligada

Preenchimento obrigatório

CODSTATUS

Código do status

Preenchimento obrigatório

Expandir

title	Consulta turmas com Matrícula em Aberto

Expandir

title	Dados da ocorrência para o item de venda

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)

Expandir

title	Professores e Técnicos de Ensino

Expandir

title	E-mail, senha inicial do professor/aluno

:

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

Image Added

CRM:

CAMPOS DE PARÂMETROS:

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

Image Added

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.

Image Added

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.

Image Added

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.

Image Added

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.

Image Added

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.

Image Added

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.

Image Added

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.

Image Added

ERP:

NOVOS CONTRATOS:

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

Image Added

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.

Image Added

Expandir

title	Processo Cancelamento de Pré Matrícula

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.

Image Added

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

Image Added

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

Image Added

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.

Expandir

title	Processo Formalização de Matrícula para o CRM

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.

Expandir

title	Processo Geração de Pré-Matrícula e Pré-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:

Image Added

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:

Image Added

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:

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.

Image Added

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:

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

Image Added

Expandir

title	Integração Contrato ERP

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.

Image Added

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:

Image Added

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.

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.

Image Removed
Figura 43 - Novo projeto SOAP
Defina um nome para o projeto e informe o caminho do WSDL do WebService.

Image Removed
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.

Image Removed
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:

Image Removed
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.

Image Removed
Figura 47 – Retorno do WebService com Erro

Image Removed
Figura 48 – Retorno do WebService com SucessoNão será realizada carga de dados inicial. O processo customizado deverá ser executado para que os dados alterados na matriz curricular sejam espelhados no CRM.

Expandir

title	Interface de LOG

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.

Image Added

Expandir

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.

Image Removed

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.

Aviso

title	Importante:

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Manual Operacional - Integrações

SGE X CRM X ERP

ZPARAMCRMWEBSERVICE

Campo

Descrição

Observações

ZPARAMCRMSTATUSMATRICULA

Campo

Descrição

Observações

CRM:

ERP:

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Manual Operacional - Integrações

SGE X CRM X ERP

ZPARAMCRMWEBSERVICE

Campo

Descrição

Observações

ZPARAMCRMSTATUSMATRICULA

Campo

Descrição

Observações

CRM:

ERP: