Histórico da Página
...
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 | ||
---|---|---|
| ||
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 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 a 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 |
Descrição | Protheus |
RM | Canal | Operação | Versão | Alias |
do Protheus | ||||||||||
Envia | Recebe | Envia | Recebe | |||||||
ATFA012 | ASSETS | Ativo Fixo | Sim | Não | Não | Sim | EAI | Todas | 1.001 | SN1 |
CTBA010 | ACCOUNTINGCALENDAR | Calendário Contábil | Sim | Não | Não | Sim | EAI | Todas | 1.000 | CTG |
CTBA020 | ACCOUNTANTACCOUNT | Plano de Conta | Sim | Não | Não | Sim | EAI | Todas | 2. |
001 | CT1 |
CTBA030 | COSTCENTER | Centro de Custo | Sim | Não | Não | Sim | EAI | Todas | 2.000 | CTT |
CTBA040A |
ACCOUNTINGITEM | Item Contábil |
Sim | Não | Não | Sim | EAI | Todas | 1.000 | CTD |
CTBA060 | CLASSVALUE | Classe de Valor | Sim | Não | Não | Sim | EAI | Todas | 1.000 | CTH |
CTBA102 | ACCOUNTINGENTRY | Lançamento Contábil | Não | Sim | Sim | Sim | EAI | Todas | 2. |
001 | CT2 |
CTBA140 | CURRENCY | Moeda | Sim | Não | Não | Sim | EAI | Todas | 2.001 | CTO |
FINA010 | FINANCIALNATURE | Natureza Financeira | Sim | Não | Não | Sim | EAI | Todas | 2.000 | SED |
FINA040 |
ACCOUNTRECEIVABLEDOCUMENT |
Lançamento a receber |
Não | Sim | Sim | Não | EAI | Todas | 2. |
005 | SE1 |
FINA050 | ACCOUNTPAYABLEDOCUMENT | Lançamento a pagar | Não | Sim |
Sim |
Não | EAI |
Todas | 2.001 |
SE2 |
FINA130 |
BANK |
Banco |
Sim | Não |
Não | Sim |
EAI | Todas | 2.001 | SA6 |
FINA460 | FINANCINGTRADING | Negociação (e cancelamento) de lançamento a receber | Não | Sim |
Sim | Não | EAI | Atualização |
2. |
000 | FO1 |
INTXATU01 |
INTERNALIDLOAD | Sincronização DE - PARA | Não | Sim | Sim | Não | EAI |
Todas | 1.000 | - |
MATA010 |
ITEM |
Produto | Sim | Não |
Não | Sim | EAI | Todas | 4.005 | SB1 | |
MATA030 | CUSTOMERVENDOR | Cliente | Sim | Sim | Sim | Sim |
EAI | Todas |
2.002 | SA1 |
MATA020 |
CUSTOMERVENDOR |
Fornecedor |
Sim |
Sim | Sim |
Sim | EAI | Todas |
2. |
002 | SA2 |
MATA035 |
STOCKGROUP |
Grupo de Produto |
Sim |
Não | Não | Sim | EAI | Todas | 1.000 |
SBM |
MATA070 |
BANK |
Banco |
Sim |
Não | Não | Sim | EAI | Todas |
2. |
001 | SA6 |
QIEA030 |
UNITOFMEASURE |
Unidade de medida |
Sim |
Não |
Não | Sim | EAI | Todas | 2. |
000 |
SAH |
FINI070LST |
LISTOFACCOUNTRECEIVABLESETTLEMENTS |
Baixa a receber |
Não | Sim | Sim | Não | EAI | Todas |
1. |
005 | FK1 |
FINI035LST |
LISTOFCOMPLEMENTARYVALUE |
Valores Acessórios |
Não |
Sim | Sim | Não | EAI | Todas | 1.000 |
FKC |
AGRA045 |
WAREHOUSE |
Local de Estoque |
Sim | Não |
Não | Sim |
EAI | Todas |
1.000 |
NNR |
MATA360 |
PAYMENTCONDITION |
Condição de Pagamento |
Sim |
Não | Não | Sim | EAI | Todas |
2.000 |
SE4 |
MATA410 |
ORDER |
Pedido de Vendas |
Não |
Sim | Sim | Não | EAI | Todas |
4. |
003 |
SC5 |
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.0 | Integração 1021 | Observação |
Aplicativo | Nome do aplicativo responsável pela integração entre os dois sistemas, presente somente no EAI 2.0 | |
Tabela RM | Tabela RMTabela de origem no RM onde os dados são enviados ou recebidos | |
Campos RM | Chave Primária RM | Campos da tabela que são utilizado utilizados na montagem da chave interna no sistema RM |
Valor RMValor Chave Primária RM | Valores dos campos da tabela que são utilizado são utilizados na montagem da chave interna no sistema RM. | |
Valores ExternosValor Chave Integração | Valores 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.0Sistema Integrado | No 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 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
...
id | Mensagens - Adapters da Integração |
---|
...
id | CUSTOMERVENDOR |
---|---|
label | CUSTOMERVENDOR |
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.
...
id | inforclifor |
---|
...
id | protheusclifor |
---|---|
label | Protheus |
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
...
id | rmclifor |
---|---|
label | RM |
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 | ||
---|---|---|
| ||
Carga Inicial
Para utilização da rotina de carga inicial dos dados, acesse o documento Carga inicial dos dados de cadastro.
Configurador
O 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.
Aviso | ||
---|---|---|
| ||
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:
|
Informações | ||
---|---|---|
| ||
Na integração EAI 2.0 no cadastro do cliente/fornecedor do TOTVS Gestão Financeira tem três campos novos que são:
|
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
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.
...
id | deparaclifor |
---|---|
label | De/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
...