Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

O objetivo deste manual é descrever a integração entre o TOTVS Educacional com o BackOffice Protheus e suas maneiras sua forma de comunicação integração entre os seus processos e cadastrados. Atualmente temos três maneiras de  

Atualmente a integração entre os dois sistemas é com a utilização do EAI – Enterprise Application Integration. Essas maneiras são:

  • EAI 12.0Pacote de integração 1012: Nesse nesse pacote os lançamentos a receber e a pagar são gerados pelo TOTVS Educacional e enviado para o BackOffice Protheus para serem baixados quando é realizado o pagamento dos lançamentos pelo responsável financeiro do aluno. E os cadastros básicos são realizados no BackOffice e enviados para o TOTVS Educacional. Exceto o cadastro de cliente e fornecedor que podem ser realizados nos dois sistemas. Os cadastros básicos são: banco, centro de custo, moeda, natureza financeira, plano de contas, item contábil, classe de valor, e etc.Pacote de integração 1021: Nesse pacote os lançamentos a receber e a pagar são gerados pelo TOTVS Educacional e enviado para o BackOffice Protheus. Porém a baixa desses títulos . Porém a baixa desses títulos a receber e os títulos a pagar gerados pela integração do lado do RM, é realizada no TOTVS Educacional. Os cadastros básicos continuam sendo realizados no BackOffice Protheus. Exceto , exceto o cadastro de cliente e fornecedor que podem ser realizados nos dois sistemas.

Aviso
titleAtenção

A utilização da integração TOTVS Educacional x BackOffice Protheus no EAI 2.0

...

só poderá ser ativada quando todos os módulos do RM estiverem com seus adapters (mensagem única) convertido para o EAI 2.0. Isso quer dizer

...

que caso a base de dados tiver outras integrações entre os módulos do RM com os módulos do Protheus, todas as integrações devem estar migradas para o EAI 2.0. 

A liberação da integração do EAI 2.0 é realizada a partir da liberação de script para conversão da integração no EAI 1.0 para o EAI 2.0. 


Sistemas Envolvidos

  • TOTVS Processo Seletivo – Módulo Educacional que gerencia os processos seletivos das escolas e faculdades, possibilitando o ingresso de alunos nas instituições por meio de vestibulares. 

...

  • TOTVS Educacional – Módulo Educacional que gerencia escolas e faculdades (ensino básico e superior), por meio de ferramentas que permitem maior agilidade nos processos que envolvem os alunos, responsáveis, professores e os funcionários. 
  • TOTVS Gestão Financeira – Módulo Financeiro que gerencia , Gestão Contábil e Gestão de Estoque/Compras e Faturamento – Módulos que gerenciam as operações financeiras, contábeis e fiscais das escolas e faculdades, por meio de ferramentas que permitem maior agilidade nos processos que envolvem contas a pagar/receber, fluxo de caixa entre outros. 

  • BackOffice Protheus (Financeiro).

...

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.

...

      • TOTVS (Educacional, Processo Seletivo, Biblioteca, Financeiro, Contábil e Fiscal) -> PROTHEUS: Os dados são trafegados pelo fluxo normal até a fila de integração TBC, em que este irá consumir o WebService do EAI do Protheus para envio da(s) mensagem(s). Após a resposta do Protheus, o TOTVS Conector atualiza o registro com o status de processamento e demais dados, no monitor da fila de Mensagem Única. 
      • PROTHEUS -> TOTVS (Educacional, Processo Seletivo, Biblioteca, Financeiro, Contábil e Fiscal): O Protheus consume Protheus consume o WebService TOTVS Conector para recebimento de mensagens únicas. Sendo também responsável também responsável por encaminhar as mensagens para o TOTVS Conector, que processa e processa e encaminha o retorno de acordo com o tipo de comunicação definida (síncrona ou assíncrona).

Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formasda seguinte forma

    •  Síncrona: O sistema de origem gera uma mensagem de integração na fila e envia ao WebService de destino. O processo na origem aguarda o processamento da mensagem no destino e ao receber o retorno, atualiza o status do processamento na fila de integração. Assíncrona: O sistema de origem gera uma mensagem de integração na fila, envia ao WebService de destino e aguarda somente a confirmação de recebimento da mensagem. O processo na origem não fica parado aguardando o processamento da mensagem de destino.

Ao término do processamento da mensagem por parte do sistema de destino, este envia outra mensagem de retorno ao 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 

Aviso

Nas integrações entre o RM x Protheus as configurações devem seguir como determinado pelo Configurador EAI 2.0, e este sempre configura no método síncrono.

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

Instalação do Biblioteca RM

Atenção: Para instalar qualquer módulo da linha RM, é necessário instalar da Biblioteca RM o pacote 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  Para informações da instalação do TBC, consulte os documentos de apoio abaixo: 

...


Como Configurar 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: 

A seguir a listagem dos adapters da integração com a informação de envio e recebimento para cada sistema. Clique aqui para saber mais dos adapters do EAI 2.0 

Rotina

Mensagem

Envia
Descrição


Protheus
Recebe
RMCanal

Operação

Versão

Alias

Integração Pacote 1021 - EAI 1.0Integração EAI 2.0

do Protheus

Envia

Recebe

EnviaRecebe
ATFA012ASSETSAtivo FixoSim Não NãoSimEAITodas 1.001SN1 
UsaUsa
CTBA010ACCOUNTINGCALENDARCalendário ContábilSim Não NãoSimEAITodas1.000CTG 
UsaUsa
CTBA020ACCOUNTANTACCOUNTPlano de ContaSim Não NãoSimEAITodas2.
000
001CT1
UsaUsa
CTBA030COSTCENTERCentro de CustoSim Não NãoSimEAITodas2.000CTT 
Usa
CTBA040A
UsaCTBA040
ACCOUNTINGITEMItem Contábil
ACCOUNTINGITEM
Sim Não NãoSimEAITodas1.000CTD
UsaUsa
CTBA060CLASSVALUEClasse de ValorSim Não NãoSimEAITodas1.000CTH
UsaUsa
CTBA102ACCOUNTINGENTRYLançamento ContábilNãoSimSimSimEAITodas2.
000
001CT2
UsaUsa
CTBA140CURRENCYMoeda SimNão NãoSimEAITodas2.001CTO
Usa
Usa
FINA010FINANCIALNATURENatureza FinanceiraSimNãoNãoSimEAITodas2.000SED
Usa
FINA040
Usa
ACCOUNTRECEIVABLEDOCUMENT
FINA040
Lançamento a receber
ACCOUNTRECEIVABLEDOCUMENT
NãoSimSimNãoEAITodas2.
002
005SE1
UsaUsa
FINA050ACCOUNTPAYABLEDOCUMENTLançamento a pagar NãoSim 
EAITodas 2.001SE2 Usa
UsaFINA070ACCOUNTRECEIVABLEDOCUMENTDISCHARGE
Sim
Sim
NãoEAI
Atualização
Todas 2.001
-
SE2 
Usa
FINA130
Usa
BANK
FINA070
Banco
REVERSALOFACCOUNTRECEIVABLEDOCUMENTDISCHARGEFINA130BANK
SimNão
EAIExclusão2.000-UsaUsa
NãoSim
Não
EAITodas2.001SA6
UsaUsaFINA280
FINA460FINANCINGTRADINGNegociação (e cancelamento) de lançamento a receberNãoSim
FINANCINGTRADING
SimNãoEAIAtualização
1
2.
002
000FO1
-
INTXATU01
UsaUsaFINA280REVERSALOFFINANCINGTRADING                       
INTERNALIDLOADSincronização DE - PARANãoSimSimNãoEAI
Exclusão
Todas1.000-
Usa
MATA010
Usa
ITEM
FINA460FINANCINGTRADING
ProdutoSimNão
EAIAtualização1.002-UsaUsaFINA460REVERSALOFFINANCINGTRADING                    Sim
NãoSim
Não
EAI
Exclusão
Todas
1
4.
000
005SB1
-
MATA030
Usa
CUSTOMERVENDOR
Usa
Cliente
FINI070A
Sim
UPDATECONTRACTPARCEL                             
SimSim
Não
SimEAITodas
1
2.002SA1
-
MATA020
Usa
CUSTOMERVENDOR
Usa
Fornecedor
FINI150A
Sim
OURNUMBERBANKING                                 
SimSim
Não
SimEAITodas
1
2.
000
002SA2
-
MATA035
Usa
STOCKGROUP
Usa
Grupo de Produto
INTXATU01
Sim
INTERNALIDLOAD
NãoNãoSimEAITodas1.000
-
SBM
Usa
MATA070
Usa
BANK
MATA010
Banco
ITEM
Sim
Sim
NãoNãoSimEAITodas
3
2.
007
001SA6
SB1
QIEA030
Usa
UNITOFMEASURE
Usa
Unidade de medida
MATA020
Sim
CUSTOMERVENDOR
Não
Sim
NãoSimEAITodas2.
002
000
SA2
SAH
Usa
FINI070LST
Usa
LISTOFACCOUNTRECEIVABLESETTLEMENTS
MATA030
Baixa a receber
CUSTOMERVENDOR
NãoSimSimNãoEAITodas
2
1.
002
005FK1
SA1
FINI035LST
Usa
LISTOFCOMPLEMENTARYVALUE
Usa
Valores Acessórios
MATA035
Não
STOCKGROUP
SimSimNãoEAITodas1.000
SBM
FKC
Usa
AGRA045
UsaMATA070BANK
WAREHOUSELocal de EstoqueSimNão
EAITodas2.001SA6UsaUsaQIEA030UNITOFMEASURESimNão
NãoSimEAITodas
2
1.000NNR
SAH
MATA360
Usa
PAYMENTCONDITION
Usa
Condição de Pagamento
FINI070LST
Sim
LISTOFACCOUNTRECEIVABLESETTLEMENTS
NãoNãoSimEAITodas
1
2.000
-
SE4
Usa
MATA410
Usa
ORDER
FINI035LST
Pedido de Vendas
LISTOFCOMPLEMENTARYVALUE
Não
Não
SimSimNãoEAITodas
1
4.
000-UsaUsa
003SC5

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  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
AplicativoNome do aplicativo responsável pela integração entre os dois sistemas, presente somente no EAI 2.0Tabela RM
Tabela RMTabela de origem no RM onde os dados são enviados ou recebidos
Campos RMChave Primária RMCampos da tabela que são utilizado utilizados na montagem da chave interna no sistema RM
Valor RMValor Chave Primária RMValores dos campos da tabela que são utilizado são utilizados 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çãoNome na mensagem - adapter responsável por gerar e gerenciar o de-para, presente somente no EAI 2.0Sistema IntegradoNo sistema integrado com o RM, presente somente na integração 1021.
Identificador GlobalIdentificador enviado na mensagem - adapter como chave de integração no de-para entre o sistema RM  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


Documento para acessar os Parâmetros de Integração EAI 2.0

...

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

...

idMensagens - Adapters da Integração

...

idCUSTOMERVENDOR
labelCUSTOMERVENDOR

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.

...

idinforclifor

...

idprotheusclifor
labelProtheus

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

Image Removed

Base de dados | Dicionário | Bases de Dados

Image Removed

Grupo de Campos = Alterar o tamanho 

Image Removed

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

Image Removed

Editar ambas as Tabelas 

Image Removed

Localizar o campo ( A1_LOJA ) = Editar

Image Removed

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

Image Removed

( A1_COD ) = Editar

Image Removed

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

Image Removed

Inicializador Padrão em branco

Image Removed

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

Image Removed

Atualizações | Cadastros | Clientes 

Image Removed

Cliente enviado para Protheus

Image Removed

...

idrmclifor
labelRM
Aviso
titleGeração do Código do Cliente/Fornecedor

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.
Informações
titleNovidade EAI 2.0

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

Image Removed

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.

Image Removed

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

Image Removed

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

Image Removed

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

Image Removed

Cliente / Fornecedor cadastrado no RM

Image Removed

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.

Image Removed

No cadastro de coligada do RM deve ser configurado o campo Código Externo com o mesmo código do Grupo de Empresa do Protheus.

Assim, se tiver algum cadastro do RM relacionado a integração com o Protheus que não permite cadastro global, ao receber a mensagem de integração o RM irá realizar a replicação dos dados para todas as coligadas com código externo preenchido.

A replicação será conforme o tipo de compartilhamento configurado no Protheus, como por exemplo compartilhado compartilhado por empresa.

Deck of Cards
idMensagens - Adapters da Integração

Carga Inicial

Para utilização da rotina de carga inicial dos dados, acesse o documento Carga inicial dos dados de cadastro.

Configurador 
Configurador do EAI 2.0 deve ser executado por aqueles que desejam implantar a integração entre os sistemas RM x PROTHEUS.
Para utilização da rotina de configurador, acesse o documento RM x PROTHEUS - Configurador EAI 2.0.

...

iddeparaclifor
labelDe/para

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

...

Tabela RM

...

Campos RM

...

Valor RM

...

Valores Externos

...

Transação

...

FCFO

...

CODCOLIGADA|CODCFO

...

0|000000001

...

01||000000001|01|C

...

CUSTOMERVENDOR

...

FCFO

...

CODCOLIGADA|CODCFO

...

0|000000110

...

01||000000110|01|F

...

CUSTOMERVENDOR

...