O objetivo deste manual é descrever a integração entre o TOTVS Educacional com o BackOffice Protheus e sua forma de integração entre os seus processos e cadastrados.
Atualmente a integração entre os dois sistemas é com a utilização do EAI – Enterprise Application Integration.
- EAI 2.0: 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 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 o cadastro de cliente e fornecedor que podem ser realizados nos dois sistemas.
Atençã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 Gestão Bibliotecária – Módulo Educacional que gerencia as bibliotecas das escolas e faculdades (com diferentes unidades bibliotecárias).
- 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, 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).
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:
- 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 o WebService TOTVS Conector para recebimento de mensagens únicas. Sendo também responsável por encaminhar as mensagens para o TOTVS Conector, que processa e encaminha o retorno de acordo com o tipo de comunicação definida (síncrona).
Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada da 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.
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.
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 a 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).
Configurando WS do RM
Para informações da instalação do TBC, consulte os documentos de apoio abaixo:
- Para instalação do TBC através do host acesse o documento Como Expor os Web Services do RM através do Host
- Para Instalação do TBC através do IIS acesse o documento Instalação do TBC no IIS
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:
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 as mensagens envolvidas nessas integrações, seguem as informações presentes no de-para e as observações devidas em cada uma.
Integração EAI 2.0 | Observação |
Aplicativo | Nome do aplicativo responsável pela integração entre os dois sistemas |
Tabela RM | Tabela de origem no RM onde os dados são enviados ou recebidos |
Campos RM | Campos da tabela que são utilizados na montagem da chave interna no sistema RM |
Valor RM | Valores dos campos da tabela que são utilizados na montagem da chave interna no sistema RM. |
Valores Externos | 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 |
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". |
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
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.
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.