O objetivo deste manual é descrever a integração entre o TOTVS Educacional com o BackOffice Protheus e suas maneiras de comunicação entre os seus processos e cadastrados. Atualmente temos três maneiras de integração entre os dois sistemas com a utilização do EAI – Enterprise Application Integration. Essas maneiras são:

Você pode estar pensando qual a diferença entre o EAI 1.0 do EAI 2.0? Antes de responder a essa pergunta vamos explicar melhor os módulos envolvidos do TOTVS Educacional e como a integração é realizada.

Sistemas Envolvidos

Integração

Melhoria na integração dos sistemas TOTVS Educacional, TOTVS Processo Seletivo, TOTVS Gestão Bibliotecária e o BackOffice do Protheus (Financeiro), por meio da mensagem única.

Atualmente já existe uma integração entre os produtos, mas que é restrita a troca de algumas outras informações que são enviadas pelo Protheus. Feito a reestruturação e adequação com a  criação desta nova integração para envio de informações do TOTVS Educacional para o Protheus.

Definição de Mensagem Única – TotvsMessage 

Com o objetivo de padronizar as integrações com os produtos, foi definida a utilização da diretriz para os projetos de integração que todos os produtos devem trabalhar com a mensagem XML única, evitando desta forma, o processo de transformação de mensagens.

Neste cenário, temos o seguinte quadro:

Qualquer dos produtos são executados com o mesmo XML para uma mesma entidade, ou seja, caso um arquivo XML corresponda a mensagem de clientes, pode ser enviado para qualquer um dos produtos que suporte o recebimento desta entidade, como no diagrama abaixo:

A mensagem única torna uniforme a execução destes arquivos XML pelos aplicativos, principalmente para a capacidade de rastreamento.

Todos os processos devem respeitar o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS.

Este fluxo pode ocorrer nos seguintes sentidos: 

Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formas: 

Ao término do processamento da mensagem por parte do sistema de destino, este envia outra mensagem de retorno ao sistema de origem com status do processamento. Lembrando que as mensagens assíncronas podem ser processadas (status pendente) ou reprocessadas (status erro) manualmente por meio do monitor da fila de integração.

Pré-requisitos instalação/implantação/utilização

Atenção: Para instalar qualquer módulo da linha RM, é necessário instalar da Biblioteca RM o pacote que contém a maioria dos arquivos necessários para o funcionamento de todos os módulos, inclusive do TBC.

(Mais detalhes acesso o documento Orientações para instalar BibliotecaRM). Os pré-requisitos instalação/implantação/utilização da integração pacote 1012 no EAI 1.0 clique aqui


Configurando WS do RM

Para  informações da instalação do TBC, consulte os documentos de apoio abaixo: 


Instalação do Protheus V12 e configuração do AppServer e Dbaccess

Acesse os documentos de apoio abaixo para instalação e configuração.


Como Configurar EAI do Protheus

Para a configuração do EAI acesso documento Configuração EAI Protheus 

Configurar ( RM e Protheus ) para utilizar a Integração, campos complementares, parâmetros e cadastros obrigatórios 

Acesso documento de apoio Configurações da Integração - Mensagem única TOTVS Educacional e Protheus  

Adapters da Integração:

Rotina

Mensagem

Envia

Recebe

Canal

Operação

Versão

Alias

Integração Pacote 1021 - EAI 1.0Integração EAI 2.0
ATFA012ASSETSSim Não EAITodas 1.001SN1 UsaUsa
CTBA010ACCOUNTINGCALENDARSim Não EAITodas1.000CTG UsaUsa
CTBA020ACCOUNTANTACCOUNTSim Não EAITodas2.000CT1UsaUsa
CTBA030COSTCENTERSim Não EAITodas2.000CTT UsaUsa
CTBA040ACCOUNTINGITEMSim Não EAITodas1.000CTDUsaUsa
CTBA060CLASSVALUESim Não EAITodas1.000CTHUsaUsa
CTBA102ACCOUNTINGENTRYNãoSimEAITodas2.000CT2UsaUsa
CTBA140CURRENCY SimNão EAITodas2.001CTOUsaUsa
FINA010FINANCIALNATURESimNãoEAITodas2.000SEDUsaUsa
FINA040ACCOUNTRECEIVABLEDOCUMENTSimSimEAITodas2.002SE1UsaUsa
FINA050ACCOUNTPAYABLEDOCUMENT NãoSim EAITodas 2.001SE2 UsaUsa
FINA070ACCOUNTRECEIVABLEDOCUMENTDISCHARGESimSimEAIAtualização2.001-UsaUsa
FINA070REVERSALOFACCOUNTRECEIVABLEDOCUMENTDISCHARGESimNãoEAIExclusão2.000-UsaUsa
FINA130BANKSimNãoEAITodas2.001SA6UsaUsa
FINA280FINANCINGTRADINGSimNãoEAIAtualização1.002-UsaUsa
FINA280REVERSALOFFINANCINGTRADING                       SimNãoEAIExclusão1.000-UsaUsa
FINA460FINANCINGTRADINGSimNãoEAIAtualização1.002-UsaUsa
FINA460REVERSALOFFINANCINGTRADING                    SimNãoEAIExclusão1.000-UsaUsa
FINI070AUPDATECONTRACTPARCEL                             SimNãoEAITodas1.002-UsaUsa
FINI150AOURNUMBERBANKING                                 SimNãoEAITodas1.000-UsaUsa
INTXATU01INTERNALIDLOADNãoSimEAITodas1.000-UsaUsa
MATA010ITEMSimNãoEAITodas3.007SB1UsaUsa
MATA020CUSTOMERVENDORSimSimEAITodas2.002SA2UsaUsa
MATA030CUSTOMERVENDORSimSimEAITodas2.002SA1UsaUsa
MATA035STOCKGROUPSimNãoEAITodas1.000SBMUsaUsa
MATA070BANKSimNãoEAITodas2.001SA6UsaUsa
QIEA030UNITOFMEASURESimNãoEAITodas2.000SAHUsaUsa
FINI070LSTLISTOFACCOUNTRECEIVABLESETTLEMENTSNãoSimEAITodas1.000-UsaUsa
FINI035LSTLISTOFCOMPLEMENTARYVALUENãoSimEAITodas1.000-UsaUsa

Tabelas De-Para

Todas as movimentações de mensagens, com algumas exceções, tanto para envio quanto para recebimento, resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações. 

Considerando as mensagens envolvidas nessas integrações, seguem as informações presentes no de-para em ambas integrações e as observações devidas em cada uma. Tabela das diferenças do de-para entre as integrações 1021 e EAI 2.0

Integração EAI 2.0Integração 1021Observação
Aplicativo
Nome do aplicativo responsável pela integração entre os dois sistemas, presente somente no EAI 2.0
Tabela RMTabela RMTabela de origem no RM onde os dados são enviados ou recebidos
Campos RMChave Primária RMCampos da tabela que são utilizado na montagem da chave interna no sistema RM
Valor RMValor Chave Primária RMValores dos campos da tabela que são utilizado na montagem da chave interna no sistema RM
Valores ExternosValor Chave IntegraçãoValores dos campos da tabela do sistema que está sendo integrado com o sistema RM
Transação
Nome na mensagem - adapter responsável por gerar e gerenciar o de-para, presente somente no EAI 2.0

Sistema IntegradoNo sistema integrado com o RM, presente somente na integração 1021.
Identificador Global
Identificador enviado na mensagem - adapter como chave de integração no de-para entre o sistema RM  e o sistema de destino. Caso esse identificador estiver vazio, a integração envia o valor presente no campo "Valor RM". Presente somente no EAI 2.0.

Seguir a descrição de cada adapters da integração e sua responsabilidade

A mensagem CUSTOMERVENDOR é responsável por enviar e receber os dados do cliente e do fornecedor entre a integração TOTVS Educacional com BackOffice Protheus. A mensagem no Protheus atende as rotinas MATA020 e MATA030. A versão utilizada na integração é a 2.002 com o tipo de envio síncrono. Os cadastros do cliente e do fornecedor podem ser realizados no RM no TOTVS Gestão FInanceira e no BackOffice Protheus.

O cadastro de cliente/fornecedor é utilizado por ambos os lados e podem ser realizados no BackOffice Protheus ou no TOTVS Gestão Financeira. 

Nas abas abaixo descreve as configurações necessárias para a utilização da mensagem com as suas particularidades.

Configurar Protheus para uso do cadastro de Cliente / Fornecedor  no Módulo ( SIGACFG )

Base de dados | Dicionário | Bases de Dados

Grupo de Campos = Alterar o tamanho 

Dicionário de Dados deve localizar as Tabelas ( SA1 e SA2 )

Editar ambas as Tabelas 

Localizar o campo ( A1_LOJA ) = Editar

Aba ( Opções ) deve preencher o Inicializador Padrão  = “01”

( A1_COD ) = Editar

Se o Inicializador Padrão estiver preenchido deve ser deletado a informação para ficar em branco, como mostra a segunda print abaixo.

Inicializador Padrão preenchido

Inicializador Padrão em branco

Verificando cadastro do Cliente / Fornecedor no Protheus no Módulo ( SIGAFIN ) 

Atualizações | Cadastros | Clientes 

Cliente enviado para Protheus


A geração do código do cliente/fornecedor na integração 1021 é gerado de acordo com a parametrização do TOTVS Gestão Financeira. 

A geração do código do cliente/fornecedor na integração EAI 2.0 é gerado de duas formas, que são:

  • Utilização do parâmetro “Usar código sequencial (se máscara for numérica) ”: O código do cliente/fornecedor não tem alteração referente a integração 1021. O TOTVS Gestão Financeira irá gerar o código automaticamente.
  • Sem a utilização do parâmetro “Usar código sequencial (se máscara for numérica) ”: O código do cliente/fornecedor será criado automaticamente pelo TOTVS Gestão Financeira. O usuário deverá informar somente o código externo do cadastro. A criação do código do cliente/fornecedor será no seguinte formato separado por ponto e vírgula:
    • Código da loja + C para cliente ou F para fornecedor + Código Externo + Código Filial Integração.

Na integração EAI 2.0 no cadastro do cliente/fornecedor do TOTVS Gestão Financeira tem três campos novos que são:

  • Código da Loja: Campo correspondente ao código da loja presente no BackOffice Protheus. Desta forma, para o preenchimento desse campo teve a criação do parâmetro de integração CODLOJADEFAULT, por padrão terá o valor "01" conforme o campo "LOJA" presente nas tabelas SA1 e SA2.
  • Código Externo: Campo correspondente ao código do cliente ou do fornecedor cadastrado no BackOffice Protheus. Deve informar preferencialmente o próximo código correspondente ao código no Protheus
  • Código da Filial de Integração: Campo responsável por armazenar a filial do cliente/fornecedor quando o cadastro do cliente ou do fornecedor do BackOffice Protheus quando o compartilhamento for exclusivo por filial


A utilização do parâmetro “Usar código sequencial (se máscara for numérica) ” o campo "Cliente/Fornecedor" ficará desabilitado no cadastro do cliente/fornecedor.

A definição da máscara vazia no Financeiro e no Educacional, para o cadastro do Cliente/Fornecedor, ao gerar um responsável financeiro no cadastro de Alunos, internamente, será adotada uma máscara numérica com 09 posições. O sistema permite a alteração da máscara para vazio, quando integrado, porém, não será permitido a alteração de nulo para outro valor.

Parâmetro para cadastro da máscara de cliente:

Acesse: Módulo Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira / 02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Cliente / Fornecedor / Máscara do código

E acesse também o Módulo TOTVS Educacional / Configurações/ Parâmetros / 15.02 - Tesouraria / Geral 1/2 / Responsável Financeiro / Máscara do código de Cliente/Fornecedor.


Cenário em que o Protheus tiver um compartilhamento por Empresa, o TOTVS Gestão Financeira deve ser parametrizado para utilizar clientes globais. Para isso acesse: Módulo Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira 
02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Cliente / Fornecedor / Default Cli/For Globais

A configuração para cliente global é realizada somente caso o Protheus tenha um compartilhamento por Empresa.

Cadastro do Cliente Fornecedor do RM no TOTVS Gestão Financeira 

Cliente / Fornecedor cadastrado no RM

Acesse Integrações opção "Integração Protheus" para vincular um fornecedor para no cadastro do cliente para geração de lançamento a pagar.

Todas as movimentações da mensagem CUSTOMERVENDOR tanto no seu envio quanto para o seu recebimento, resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações. Desta forma, o sistema de origem envia seu código de identificação do cliente/fornecedor para o sistema de destino juntamente com seu  código de identificação. 

De-Para na integração 1021

Tabela RM

Chave Primária RM

Valor Chave Primária RM

Sistema Integrado

Valor Chave Integração

FCFO

CODCOLIGADA|CODCFO

0|000000001

PROTHEUS

01||000000001|01|C

FCFO

CODCOLIGADA|CODCFO

0|000000110

PROTHEUS

01||000000110|01|F

De-Para na integração EAI 2.0

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

FCFO

CODCOLIGADA|CODCFO

0|000000001

01||000000001|01|C

CUSTOMERVENDOR

B96F1F8B-CAD3-484B-9903-1FB2BE635888
TOTVS Educacional x BackOffice Protheus

FCFO

CODCOLIGADA|CODCFO

0|000000110

01||000000110|01|F

CUSTOMERVENDOR