Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Deck of Cards
effectDuration0.5
idIntegração Mensagem única
effectTypefade
Card
defaulttrue
effectDuration0.5
idTestes de Integrações via XML
labelConceito Mensagem única

Conceito:


Durante o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes foram adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponível aos clientes. Esta expansão de ofertas permitiu que clientes de uma marca, antes limitados pelas opções com aquela “etiqueta”, pudesse agora compor o seu ambiente de TI utilizando produtos de origens diferentes (Ex.: BackOffice Protheus + TOTVS Obras e Projetos).

Com o objetivo de padronizar a integrações com os produtos TOTVS, foi definida uma nova diretriz para os projetos de integração: todos os produtos TOTVS devem se comunicar com uma mensagem XML única, evitando desta forma o processo de transformação de mensagens. Neste cenário, teríamos o seguinte quadro: 

  


Neste cenário, qualquer produto TOTVS trabalhará com o mesmo XML para uma mesma entidade, ou seja, supondo que tenhamos um XML correspondente à mensagem de CLIENTES, ela poderá ser enviada para qualquer um dos produtos que suporte o recebimento desta entidade.

Uma vez que os vários produtos TOTVS terão um “idioma” comum (o XML Único), as integrações entre estes produtos não exigirão mais que as mensagens sejam transformadas de um formato para outro. Com isto, será possível conectar diretamente dois produtos, sem a necessidade do TOTVS ESB, como no diagrama abaixo:



Card
effectDuration0.5
idIntegração via Mensagem única
labelPrincipais tabelas

Tabelas:


XXFDe/Para no banco de dados 
XX3Transações EAI
XX4Adapters EAI
Card
defaulttrue
idIntegração Via Mensagem única
labelAdapters

Adapters: 


Os Adapters são responsáveis por realizar o processamento das mensagens enviadas e recebidas, possibilitando a inclusão, alteração e exclusão de dados. Veja a Lista Completa dos Adapters utilizados na integração  EAI  (Enterprise Application Integration).


Dica
titleEXEMPLO

Veja o vídeo do processo de cadastro do Adapter em: 01. Cadastro do Adapter


 As integrações via Mensagem Única propõem dois modelos de envio e recebimento de mensagens: 

Síncronas:  No modelo de mensagens Síncronas a mensagem é enviada e o sistema que enviou aguarda o processamento da mensagem pelo receptor.
Assíncronas:   Já no modelo Assíncrono a mensagem é enviada e o sistema que a enviou não aguarda o seu processamento. Posteriormente a mensagem será processada no receptor.


Aviso
titleAtenção

O modelo de mensagem que será utilizado na integração deve ser avaliado com muito cuidado. Apesar do modelo síncrono parecer o mais adequado para uma integração, isto não é de todo verdade. Em um modelo síncrono deve ser levado em consideração o tempo de processamento: O processamento do sistema que envia, a velocidade do trânsito de dados da rede e o tempo de processamento e resposta do receptor. Isto pode acarretar um tempo de resposta ao usuário muito maior do que o normal, o que pode transformar a integração de solução ao problema. Já o modelo assíncrono, por não aguardar o retorno do processamento do receptor torna o processo mais rápido, porém, neste modelo de mensagem deve-se levar em consideração que o dado será gravado no sistema que envia a mensagem e que o processamento no receptor ocorrerá posteriormente. Desta maneira, em algumas situações os dados irão existir no sistema de envio, mas enquanto não forem processados no receptor eles não existirão lá.

Card
defaulttrue
effectDuration0.5
idIntegração Via Mensagem única
labelDe / Para de empresas

De/Para de Empresas/Filiais : 

O Cadastro de De/Para de empresas/filiais irá definir quais empresas e filiais serão integradas entre os dois sistemas.


Dica
titleEXEMPLO

Veja o vídeo do processo de cadastro do De/Para de Empresas/Filiais: 02. De Para de Empresas Filiais


No XML é necessário identificar a Aplicação de Origem, a Empresa e a Filial para cadastrar o De/Para. As tags a serem verificadas são:

  • SourceApplication = Aplicação de Origem (XXD_REFER)
  • CompanyId = Empresa (XXD_COMPA)
  • BranchId = Filial (XXD_BRANCH)
Card
defaulttrue
effectDuration0.5
idIntegração Mensagem única
labelDe/Para de Mensagem Única (XXF)

De/Para de Mensagem Única (XXF): 

Na maioria das vezes, os códigos dos registros utilizados nos sistemas que se comunicam via Mensagem Única não são os mesmos, a XXF é a tabela que ira guardar os códigos para relacionar os registros, por exemplo um cliente pode possuir o código  no Protheus, e no RM esse mesmo cliente possui o código C0100001. Por isso o sistema realiza o cadastro de um "De/Para de Mensagem Única"


Ao realizar a inclusão de um cadastro, o sistema verifica se já existe um "De/Para de Mensagem Única", caso já exista, o sistema entende que trata-se de uma alteração, caso não exista, trata-se de uma inclusão, então ele cria automaticamente o "De/Para de Mensagem Única" (XXF).

Dica
titleEXEMPLO

Veja o vídeo do processo de cadastro do De/Para de Mensagem Única (XXF): De Para de Mensagem Única


Caso trate-se de uma inclusão que referencia códigos de outros cadastros, esses códigos necessitam de um "De/Para de Mensagem Única", por exemplo, ao incluir um Pedido de Vendas você precisa referenciar um código de Produto e um código de cliente, mas, nesse momento, você não está incluindo o cliente ou o produto, você está incluindo o Pedido, portanto o cliente e o produto precisam ter um "De/Para de Mensagem Única" (XXF) cadastrado. 

Card
defaulttrue
effectDuration0.5
idTestes de Integrações via XML
labelConfigurando os WebServices

A configuração inicia-se habilitando o serviço HTTP e configurando a porta que todos os outros serviços dependentes deste irão utilizar para a publicação das informações:

  • Acesse o Wizard de configuração dos Serviços;
  • Em Servidor Internet (HTTP/FTP), verifique se o serviço de HTTP já existe, confirme se está habilitado e para qual porta está configurada. Pois estas são informações indispensáveis para o correto funcionamento dos WebServices e Portais.
  • Caso não tenha o Servidor Internet <HTTP> criado, é necessário seguir o procedimento abaixo:
Expandir
titleConfigurando HTTP/FTP
  • Realize o Download dos Arquivos de Portais (web_files) do Portal do Cliente;
  • Inclua uma pasta web dentro da Protheus Data do Sistema e insira os web_files;
  • Selecionar a opção: <HTTP> e clicar na barra superior <Editar> conforme exemplo;
  • O sistema apresentará a tela para Configuração da Seçãoonde os principais campos são:
    • Flag para Habilitar o Protocolo;
    • Path de Arquivos = Caminho da Pasta Web;
    • Ambiente = Nome do Ambiente;
    • Porta de Conexão = Porta de configuração dos Serviços;
Dica
titleImportante

Na configuração da Seção, inserimos como exemplo a porta 92, porém ela pode ser alterada caso prefira.

Caso definida a porta padrão do serviço HTTP que é a 80, não é necessário especificá-la na configuração do WS e Portais.

Basta confirmar e gravar as configurações


Expandir
titleWS TOTVS Linha Protheus Web Services
  • Realize as configurações básicas, campos importantes:
    • Módulo Web = WS - TOTVS Linha Protheus Web Services;
    • Nome da Instância = ws;
    • Diretório Raiz das Imagens (Web Path) = Diretório da Pasta Web onde o sistema irá criar a pasta "ws";
    • Selecione o Environment = Nome do Ambiente;
    • Flag para habilitar processos na inicialização do Servidor.
  • Realize a Configuração de Host x Empresas/Filiais, campos importantes:
    • Host = Server e porta dos Web Services (Deve ser informada a porta informada na Configuração HTTP/FTP);
    • Selecione a Empresa/Filial = Empresa e Filial de acesso (Para configuração Multifilial, consulte a respectiva aba).
    • Clique em "Relacionar" e em "Avançar".
  •  Realize a Configuração de Usuários, onde irá definir o número mínimo e máximo de usuários para acesso.

Finalizar e confirmar a configuração.

Card
defaulttrue
idIntegração Mensagem única
labelSoap UI

Ferramenta SoapUI: 

É uma ferramenta de mercado onde conseguimos simular o envio do XML na integração via Mensagem Única.

Utilizamos o Soap para enviar o arquivo XML, simulando o envio de outros sistemas (RM ou LOGIX por exemplo) para o Protheus.

Link para baixar o Soap: https://www.soapui.org/downloads/latest-release/


Integração WS protheus X Soap Ui:

No Ini do Appserver, busque o caminho do WS.

WEBSERVICELOCATION=http://localhost:92/ws

Acesse o WS via browser

Busque o EAISERVICE , e clique sobre.

Clique sobre a descrição do serviço;


Copie o endereço do .


Abra o Soap UI - Clique em File - New SOAP Project




Cole o endereço do WSDL no campo Initial WSDL, clique em OK.

Pronto o Soap está integrado com o Web Service do Protheus. 

 


Cole o XML entre as seguintes Tags:


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<tot:RECEIVEMESSAGE>
<tot:INMSG>
<![CDATA[

Cole aqui o XML

]]>

</tot:INMSG>
</tot:RECEIVEMESSAGE>
</soapenv:Body>
</soapenv:Envelope>


Nota
titleImportante:
  • A seguinte Tag tem que ser acrescentada:

<![CDATA[

]]>


  • Não esqueça de salvar o Novo Projeto, caso feche o sistema perde inclusive a integração.





Card
idIntegração Mensagem única
labelParâmetros

Parâmetros: 

  • MV_EAIMETH (não deve ser alterado)
  • MV_EAIUSER
  • MV_EAIPASS
  • MV_EAIURL2 (Endereço do WS para comunicação) - Podemos informar a Rota da integração neste parâmetro ou através da rotina CFGA020.  Saiba mais:  Roteamento EAI Protheus (CFGA020 - SIGACFG)
  • MV_EAIWS(Não Precisa ser alterado). 


Principais parâmetros da Integração RM TOP X Protheus:

A integração do Top RM com o Protheus envolve o módulo Gestão de Projetos (SIGAPMS), neste módulo não é necessário realizar alguns cadastros de De/Para na XXF e sim configurar alguns parâmetros. 

Segue a baixo a lista dos parâmetros que envolve as integrações deste módulo:

Link: Parâmetros da Integração


Card
idIntegração Mensagem única
labelFontes de Integração

Fontes de Integração:

Todos os fontes de integração contém a letra " I", exemplos:

Cadastro de cliente MATI030

No TFS os fontes do módulo Faturamento estão localizados na pasta Materiais - Mensagem única:




Card
idIntegração Mensagem única
labelComo extrair XML do Protheus

Extraindo o XML do Protheus:


Acesse o ambiente SIGACFG, Menu: Ambiente - Schedule - opção EAI


Na integração do Software com o Protheus, são criados os arquivos de transações:

Selecione o arquivo que integrou e para extrair clique na lupa  , ira apresentar as opções  escolha qual XML deseja extrair.

Visualizar mensagem Origem: XML que o Software envia para o Protheus.

Visualizar mensagem de Resposta: XML que o Protheus envia para o Software.



Nota
titleImportante:

Através da tag <Product> consegue visualizar o Software que esta recebendo ou enviando. Exemplo:

XML de envio (original): <Product version="12.1.18.0" name="RM"/>

XML de resposta:<Product version="12" name="PROTHEUS"/>




Card
idIntegração Mensagem única
labelOutras Documentações

Documentações para apoio:




Card
idIntegração Mensagem única
labelExemplos de XML

Exemplo de XML para testes:


AdapterRotina Protheus/ IntegraçãoArquivo
CUSTOMERVENDORMATA030 / MATI030XML_CLIENTE
SALESORDERMATA410 / MATI410
PROJECPMSA200 / PMSI200XML_PROJECT
SUBPROJECTPMSA201/ PMSI201XML_SUBPROJECT
STEPPROJECTPMSA201A/PMSI201AXML_STEPPROJECT
TASKPROJECTPMSA203/PMSI203XML_TASKPROJECT