Explicativo sobre as integrações EAI do Protheus com destino a sistemas de terceiros

Produto:

Protheus

Versões:

A partir da 12.1.27

Ocorrência:

Explicativo sobre a integração EAI Protheus (SIGAFAT) com destino à outros sistemas

Ambiente:

Faturamento (SIGAFAT)

Índice



1. Conceito

A integração ocorre via XML ou JSON do Protheus para outro sistema:


2. Configurações e integração

1 - Ir na rotina "Cadastro de Rotas EAI (APCFG021)"


2 - Criar uma nova rota (não utilizar a padrão do Protheus) e Informar o código da sua Rota e o método de envio, sendo:

  • SOAP se a integração EAI for por XML
  • REST se a integração EAI for por JSON

OBS: O produto e aplicação pode ser definido a gosto do sistema origem, não há regras sobre ele.


3 - Caso tenha escolhido "SOAP" preencher a aba inferior "SOAP" com o "Endereço (XAH_URL)" (Avaliar qual é o endereço, o suporte não oferece apoio na configuração completa da implementação entre dois sistemas)

Exemplo: http://localhost:99/ws/EAISERVICE.apw?                                                     


4 - Caso tenha escolhido "REST" preencher a aba inferior "REST" com o "Endereço (XAI_URL)" (Avaliar qual é o endereço, o suporte não oferece apoio na configuração completa da implementação entre dois sistemas)

Exemplo: http://localhost:8085/rest  

Quando por exemplo, o Protheus A está enviando para o Protheus B e Protheus C ao mesmo tempo, o campo "XX4_METODO (Método)" do Protheus Origem (A) fica como "2 - Assíncrono" e os Protheus Destino (B e C) ficam com o valor "1 - Síncrono" no Adapter.


Com isso, basta informar mais de uma rota no Adapter:


Essa etapa, deve cadastrar o Adapter da rotina que deseja integrar. Exemplo:

  • Cadastro de cliente = Cadastro do Adapter CRMA980 ou MATA030
  • Cadastro de vendedor = Cadastro do Adapter MATA040



1 - Ir na rotina "Adapters EAI (CFGA020)"


2 - Incluir o Adapter com a rotina desejada:

  • "Mensagem Unica (XX4_UNMESS)" = '1 - Sim'
  • "Rotina* (XX4_ROTINA)" = fonte da rotina (que integrará, exemplos de fontes dentro da caixa azul, no tópico "Conceito" na ilustração)
  • "Envia (XX4_SENDER)" = '1 - Sim'
  • "Recebe (XX4_RECEIV)" = '1 - Sim'
  • "Método (XX4_METODO)" = '1 - Sincrono' ('2 - Assíncrono' no Protheus Origem se tiver mais que uma rota a ser enviada)
  • "Operação (XX4_TPOPER)" = '1 - Todas'
  • "Canal Envio (XX4_CHANEL)" = '3 - EAI - PAD. APP'
  • "Versão Envio (XX4_SNDVER)" = Gatilhado automaticamente (após escolher a "Rotina* (XX4_ROTINA)")
  • "Formato (XX4_FORMAT)" = 'XML' ou 'JSON' (Avaliar como está sendo implementado a integração, o suporte não oferece apoio na configuração completa da implementação entre dois sistemas)


  • DEMAIS CAMPOS = Preencher de acordo com sua necessidade de implementação. Os campos citados acima são os necessários para um teste básico e limpo, recomendamos que apenas sejam alterados os campos acima previamente.

3 - Na tabela inferior "Roteamento de mensagens", selecionar no campo "Produto" o código da rota anteriormente cadastrado no passo (1)


4 - Na tabela inferior "Roteamento de mensagens", selecionar no campo "Envia" o valor "Sim"

1 - Ir na rotina "Schedule (CFGA010)"


2 - Expandir a árvore lateral esquerda "Agendamentos" e incluir


3 - Cadastrar a rotina "FWEAI" e cadastrar as empresas/filiais existentes no seu Protheus


4 - Ir no botão de recorrências e colocar o padrão de recorrência como "Sempre ativo" e o intervalo de recorrência "Sem data de término", confirmar e salvar o cadastro do serviço


5 - Clicar no botão lateral esquerdo "Agendamentos" e verificar se o serviço "FWEAI" está com a legenda verde (Habilitado)

1 - Ir na rotina "Schedule (CFGA010)"


2 - Clicar na opção lateral esquerda "Schedule" e inicie todos os dois serviços (esse processo leva em torno de 1 minuto)


3 - Expandir a árvore lateral "Agent", ir na opção "Monitor", selecionar o Agent e iniciar o serviço

Com o Protheus que envia configurado, basta inserir um registro na rotina/fonte que o Adapter foi cadastrado. Exemplo:

  • Tendo um Adapter do (CRMA980 ou MATA030 - Cliente), cadastrando um cliente no Protheus (MATA030 ou CRMA980), gerará o registro de integração EAI "CUSTOMERVENDOR".
  • Tendo um Adapter do (MATA040 - Vendedor), cadastrando um vendedor no Protheus (MATA040), gerará o registro de integração EAI "SELLER".


Ao salvar o registro no Protheus (tópico 5), será gerado no Protheus (Enviador) um registro na tabela XX3 de logs de envio EAI.

Os valores do campo 'XX3_STATUS' de quando a mensagem sai do Protheus e chega até o outro sistema são: 2, 3 e 7:

  • Caso na tentativa de integração o XX3_STATUS fique com algum valor acima, orientamos que contate a Equipe do Produto destino para melhor análise do motivo do sistema destino não estar aceitando a integração.


O campo XX3_TRANS mostra o EAI (JSON ou XML) que está sendo enviado e o campo XX3_RETURN mostra o EAI (JSON ou XML) de retorno (resposta do outro sistema ou da tentativa).



3. Exemplo de integração Protheus → Protheus


4. Exemplo de integração Protheus → Sistema destino