Histórico da Página
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:
- EAI 1.0
- Pacote de integração 1012: 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 é 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.
- EAI 2.0
Nessa integração terá o mesmo comportamento do pacote de integração 1021 presente no EAI 1.0. Isso quer dizer que 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 é 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.
Aviso title Atenção A utilização da integração TOTVS Educacional x BackOffice Protheus no EAI 2.0 caso na base de dados tiver outras integrações entre os módulos do RM com os módulos do Protheus, a integração com o EAI 2.0 só poderá ser ativada quando todos os módulos do RM estiverem com seus adapters (mensagem única) convertida 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.
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
- 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 – Módulo Financeiro que gerencia as operações financeiras 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) -> 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): 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 ou assíncrona).
Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formas:
- 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 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:
- 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:
Rotina | Mensagem | Envia | Recebe | Canal | Operação | Versão | Alias | Integração Pacote 1021 - EAI 1.0 | Integração EAI 2.0 |
ATFA012 | ASSETS | Sim | Não | EAI | Todas | 1.001 | SN1 | Usa | Usa |
CTBA010 | ACCOUNTINGCALENDAR | Sim | Não | EAI | Todas | 1.000 | CTG | Usa | Usa |
CTBA020 | ACCOUNTANTACCOUNT | Sim | Não | EAI | Todas | 2.000 | CT1 | Usa | Usa |
CTBA030 | COSTCENTER | Sim | Não | EAI | Todas | 2.000 | CTT | Usa | Usa |
CTBA040 | ACCOUNTINGITEM | Sim | Não | EAI | Todas | 1.000 | CTD | Usa | Usa |
CTBA060 | CLASSVALUE | Sim | Não | EAI | Todas | 1.000 | CTH | Usa | Usa |
CTBA102 | ACCOUNTINGENTRY | Não | Sim | EAI | Todas | 2.000 | CT2 | Usa | Usa |
CTBA140 | CURRENCY | Sim | Não | EAI | Todas | 2.001 | CTO | Usa | Usa |
FINA010 | FINANCIALNATURE | Sim | Não | EAI | Todas | 2.000 | SED | Usa | Usa |
FINA040 | ACCOUNTRECEIVABLEDOCUMENT | Sim | Sim | EAI | Todas | 2.002 | SE1 | Usa | Usa |
FINA050 | ACCOUNTPAYABLEDOCUMENT | Não | Sim | EAI | Todas | 2.001 | SE2 | Usa | Usa |
FINA070 | ACCOUNTRECEIVABLEDOCUMENTDISCHARGE | Sim | Sim | EAI | Atualização | 2.001 | - | Usa | Usa |
FINA070 | REVERSALOFACCOUNTRECEIVABLEDOCUMENTDISCHARGE | Sim | Não | EAI | Exclusão | 2.000 | - | Usa | Usa |
FINA130 | BANK | Sim | Não | EAI | Todas | 2.001 | SA6 | Usa | Usa |
FINA280 | FINANCINGTRADING | Sim | Não | EAI | Atualização | 1.002 | - | Usa | Usa |
FINA280 | REVERSALOFFINANCINGTRADING | Sim | Não | EAI | Exclusão | 1.000 | - | Usa | Usa |
FINA460 | FINANCINGTRADING | Sim | Não | EAI | Atualização | 1.002 | - | Usa | Usa |
FINA460 | REVERSALOFFINANCINGTRADING | Sim | Não | EAI | Exclusão | 1.000 | - | Usa | Usa |
FINI070A | UPDATECONTRACTPARCEL | Sim | Não | EAI | Todas | 1.002 | - | Usa | Usa |
FINI150A | OURNUMBERBANKING | Sim | Não | EAI | Todas | 1.000 | - | Usa | Usa |
INTXATU01 | INTERNALIDLOAD | Não | Sim | EAI | Todas | 1.000 | - | Usa | Usa |
MATA010 | ITEM | Sim | Não | EAI | Todas | 3.007 | SB1 | Usa | Usa |
MATA020 | CUSTOMERVENDOR | Sim | Sim | EAI | Todas | 2.002 | SA2 | Usa | Usa |
MATA030 | CUSTOMERVENDOR | Sim | Sim | EAI | Todas | 2.002 | SA1 | Usa | Usa |
MATA035 | STOCKGROUP | Sim | Não | EAI | Todas | 1.000 | SBM | Usa | Usa |
MATA070 | BANK | Sim | Não | EAI | Todas | 2.001 | SA6 | Usa | Usa |
QIEA030 | UNITOFMEASURE | Sim | Não | EAI | Todas | 2.000 | SAH | Usa | Usa |
FINI070LST | LISTOFACCOUNTRECEIVABLESETTLEMENTS | Não | Sim | EAI | Todas | 1.000 | - | Usa | Usa |
FINI035LST | LISTOFCOMPLEMENTARYVALUE | Não | Sim | EAI | Todas | 1.000 | - | Usa | Usa |
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.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 RM | Tabela 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 na montagem da chave interna no sistema RM |
Valor RM | Valor Chave Primária RM | Valores dos campos da tabela que são utilizado na montagem da chave interna no sistema RM |
Valores Externos | Valor 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.0 | |
Sistema 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 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
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|