Card |
---|
effectDuration | 0.5 |
---|
id | Integração via Mensagem única |
---|
label | Principais tabelas |
---|
| Tabelas
XXD | De/Para de Empresas/Filiais Filiais Mensagem única | XXF | De/Para no banco de dados Conteúdos Mensagem Única |
---|
XX3 | Transações EAIE.A.I. | XX4 | Adapters EAIE.A.I. |
---|
|
Card |
---|
default | true |
---|
id | Integração Via Mensagem única |
---|
label | Adapters |
---|
| 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 Veja a Lista Completa dos Adapters utilizados na integração EAI integração E.A.I (Enterprise Application Integration).
As integrações via Mensagem Única propõem dois modelos de envio e recebimento de mensagens: Síncronas: A mensagem é enviada e o sistema que enviou aguarda o processamento da mensagem pelo receptor. Assíncronas: A mensagem é enviada e o sistema que a enviou não aguarda o seu processamento. Posteriormente a mensagem será processada no receptor.
Aviso |
---|
| 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 |
---|
default | true |
---|
effectDuration | 0.5 |
---|
id | Integração Via Mensagem única |
---|
label | De / Para de empresas |
---|
| De/Para de Empresas/FiliaisO Cadastro de De/Para de empresas/filiais irá definir quais empresas e filiais serão integradas entre os dois sistemas.
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 |
---|
default | true |
---|
effectDuration | 0.5 |
---|
id | Integração Mensagem única |
---|
label | De/Para de Mensagem Única (XXF) |
---|
| De/Para de Mensagem Única 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 |
---|
| Veja o vídeo do processo de cadastro do De/Para de Mensagem Única (XXF): De Para de Mensagem Única O vídeo está no Google Drive do Suporte FAT / SERV / JUR, caso execute no navegador Google Chrome, a qualidade do vídeo pode ficar mais baixa, sendo esse o caso, é possível fazer o Download do arquivo para superior qualidade. |
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 |
---|
default | true |
---|
effectDuration | 0.5 |
---|
id | Testes de Integrações via XML |
---|
label | Configurando os WebServices |
---|
| Configurando Web Services:
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 |
---|
title | Configurando 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 |
---|
| 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 |
---|
title | WS 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. |
Após as configurações acima, o sistema irá inserir as informações de acesso aos Web Services no arquivo AppServer.ini do Protheus, verifique se as informações estão de acordo com o exemplo abaixo, caso não estejam realize ajustes (Lembrando que a Porta e o Nome do Ambiente serão os que preencheu durante a configuração):
Expandir |
---|
| [HTTP] ENABLE=1 PORT=81
[localhost:92/ws] ENABLE=1 PATH=c:\seuambiente\Protheus_Data\web\ws ENVIRONMENT=12.1.025 INSTANCENAME=ws RESPONSEJOB=JOB_WS_9901 DEFAULTPAGE=wsindex.apw
[JOB_WS_9901] TYPE=WEBEX ENVIRONMENT=12.1.025 INSTANCES=1,1 SIGAWEB=WS INSTANCENAME=ws ONSTART=__WSSTART ONCONNECT=__WSCONNECT LOGPROFILE = 0 PREPAREIN=99,01 SECURITY=0 |
Dica |
---|
| Veja o vídeo do processo de configuração dos Web Services: Configurando os Web Services O vídeo está no Google Drive do Suporte FAT / SERV / JUR, caso execute no Navegador do Chrome, a qualidade do vídeo pode ficar mais baixa, sendo esse o caso, é possível fazer o Download do arquivo e a qualidade será bem melhor. A partir da release 12.1.33, torna-se obrigatório o uso da chave SECURITY = 0 na configuração dos WebServices no appserver.ini do AppServer: https://tdn.totvs.com/x/aiErI |
|
Card |
---|
default | true |
---|
id | Integração Mensagem única |
---|
label | Soap UI |
---|
| SoapUI: É uma ferramenta de mercado onde conseguimos simular o envio do XML na integração via Mensagem Única. Utilizamos o SoapUI 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/
Dica |
---|
| Veja o vídeo do processo de configuração do SOAPUI: Configurando a ferramenta SoapUI O vídeo está no Google Drive do Suporte FAT / SERV / JUR, caso execute no navegador Google Chrome, a qualidade do vídeo pode ficar mais baixa, sendo esse o caso, é possível fazer o Download do arquivo para superior qualidade. |
Nota |
---|
| - A seguinte Tag tem que ser acrescentada:
<![CDATA[
(XML Conteúdo que irá dentro da TAG)
]]>
- Não esqueça de salvar o Novo Projeto, caso feche o sistema perde inclusive a integração.
|
|
Card |
---|
id | Integração Mensagem única |
---|
label | Parâ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).
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 tabela XXF e sim configurar alguns parâmetros. Lista dos parâmetros que envolve as integrações deste módulo: Parâmetros da Integração
|
Card |
---|
id | Integração Mensagem única |
---|
label | Fontes de Integração |
---|
| Fontes de Integração:Todos os fontes de integração contém a letra "I" no final do nome da rotina, fontes com processamento a parte em JSON possuem a letra "O" sem seguida da letra "I" de integração, exemplos: Caminho no TFS: Master → Fontes → Materiais → Mensagem Unica: Faturamento (SIGAFAT): - FATI140
Categoria de Produtos
- FISI010
Muncípios
- MATI030
Clientes
- MATI030B
Clientes - Função de integração para tratar a mensagem CUSTOMERVENDOR onde recebe-se o CPF/CPNJ e é retornado o CPF/CPNJ com Código/Loja/Nome Fantasia/Nome
- MATI030O
Clientes - Função de integração EAI para receber JSON
- MATI040
Vendedores
- MATI040O
Vendedores - Função de integração EAI para receber JSON
- MATI050
Transportadoras
- MATI070
Bancos
- MATI090
Moedas
- MATI360
Condição de Pagamento
- MATI360O
Condição de Pagamento - Função de integração EAI para receber JSON
- MATI410
Pedidos de Venda
- MATI410B
Rastreabilidade de Pedidos Venda\Compra com o Objeto Eai(FwObjEai)
- MATI410BO
Rastreabilidade de Pedidos Venda\Compra com o Objeto Eai(FwObjEai) em JSON
- MATI410EC1
Pedidos de Venda - Função de integração para tratar informações de Vendas/Pedido Varejo
- MATI410EC2
Pedidos de Venda - Função de integração para tratar informações de Vendas/Pedido Varejo em JSON
- MATI410O
(Pedidos de Venda em para receber JSON
- MATI411
Faz o relacionamento da SC5 e SC6
- MATI461
Geração do documento de saída
- MATI461O
Geração do documento de saída para receber em JSON
- MATI490O
Comissão de Vendas
- OMSI010
Tabela de Preços
- OMSI010O
Para receber tabela de preços em JSON
Gestão de Serviços (SIGAPMS): - PMSI200
- PMSI200A
- PMSI200B
- PMSI201
- PMSI201A
- PMSI203
|
Card |
---|
id | Integração Mensagem única |
---|
label | Como extrair XML do Protheus |
---|
|
Acesse o ambiente SIGACFG: Ambiente - Schedule - opção EAI
Na integração do Software com o Protheus, são criados os arquivos de transações:
1 - Selecione o arquivo que integrou e para extrair clique na lupa . Será exibido as opções para extrair: - Visualizar mensagem original: XML que o aplicativo de integração envia para o Protheus.
- Visualizar mensagem de resposta: XML que o Protheus envia para a outra aplicação de integração.
Nota |
---|
| 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 |
---|
id | Integração Mensagem única |
---|
label | Outras Documentações |
---|
| Documentações para apoio:
|
Card |
---|
id | Integração Mensagem única |
---|
label | Exemplos de XML |
---|
| Exemplo de XML para testes:
Adapter EAIE.A.I. - (XX4_MODEL) | Rotina normal | Rotina de integração correspondente - (XX4_ROTINA) | Arquivo .xml para downloadtestes - Download |
---|
CUSTOMERVENDOR | MATA030 | MATI030 | XML_CLIENTE | SALESORDER/ORDER | MATA410 | MATI410 | | PROJECT | PMSA200 | PMSI200 | XML_PROJECT | SUBPROJECT | PMSA201 | PMSI201 | XML_SUBPROJECT | STEPPROJECT | PMSA201A | PMSI201A | XML_STEPPROJECT | TASKPROJECT | PMSA203 | PMSI203 | XML_TASKPROJECT |
|
Card |
---|
id | Integração Mensagem única |
---|
label | Exemplos de Testes (Json) |
---|
| Exemplos de Testes (Json):Para iniciar os testes é necessário que tenha realizado as etapas: - Cadastro do Adapter
- De/Para de Empresas e Filiais
- Exemplo de REST
- Configuração do REST
- Configurando o SOAPUI
Dica |
---|
| O vídeo está no Google Drive do Suporte FAT / SERV / JUR, caso execute no navegador Google Chrome, a qualidade do vídeo pode ficar mais baixa, sendo esse o caso, é possível fazer o Download do arquivo para superior qualidade. |
Aviso |
---|
| Caso seja necessário a utilização de um Json enviado pelo cliente no teste, é necessário criar um De/Para de Mensagem única para os códigos referenciados no cadastro. Exemplo: Código de Vendedor no campo A1_VEND, é necessário criar um de/para de mensagem única usando o " VendorInformationInternalID" como "Valor Externo" e no "Valor interno" é preciso informar a empresa, a filial e o código do vendedor como neste exemplo. |
Exemplos de Arquivos Json para teste:
|
Card |
---|
default | true |
---|
effectDuration | 0.5 |
---|
id | LogID |
---|
label | Log de integração |
---|
| Como gerar log registro de integração
1 - Vá em seu appserver.ini na chave/bloco que carrega o nome do JOB do WebServices [JOB_WS_XXXX] 2 - Inclua uma linha: "PROFILE=1" e depois salve o arquivo (Atalho: CTRL + S).
3 - Ao integrar/tentar integrar, será gerado um arquivo .txt de log na pasta protheus > protheus_data > wsprofiler:
OBS: Para não gerar um log a cada interação, basta deixar: "PROFILE=0"
|
Card |
---|
default | true |
---|
effectDuration | 0.5 |
---|
id | DifficultiesID |
---|
label | Possíveis cenários |
---|
| Expandir |
---|
title | A Entidade 'CUSTOMERVENDOR' não está mapeada para esta Integração. |
---|
| Mensagem exibida quando integrações não conseguem visualizar o Adapter "CUSTOMERVENDOR" no Protheus.
"A Entidade 'CUSTOMERVENDOR' não está mapeada para esta Integração."
Possíveis soluções: 1 - Atualizar os fontes de integração 2 - Revisar as configurações do adapter: - XX4_UNMESS = "1 - Sim" (Mensagem Unica)
- XX4_ROTINA = "MATA030" ou "CRMA980" (Rotina) | Funciona ambas independente do valor do parâmetro MV_MVCSA1
- XX4_MODEL = "CUSTOMERVENDOR" (Mensagem*)
- XX4_SENDER = "1 - Sim" (Envia)
- XX4_RECEIV = "1 - Sim" (Recebe)
- XX4_TPOPER = "1 - Todas" (Operação)
- XX4_CHANEL = "3 - EAI - PAD. APP." (Canal Envio)
- XX4_SENDER = "2.005+" | Dessa versão específicada ou superior
- XX4_FORMAT = "XML" (Formato)
- XX4_SAVLOG = "1 - Sim" (Salva log)
OBS: A versão de Envio deve coincidir entre Protheus e RM. Se necessário atualize o adapter do RM/Ambiente que recebe a integração no RM. É necessário que o adapter do lado da aplicação da integração esteja atualizado também.
|
Expandir |
---|
title | Help: ATENÇÃO! - Problema: Verificar problema no Monitor EAI |
---|
| Mensagem exibida ao tentar manipular um registro no cadastro de clientes
Possíveis soluções: 1 - Deixar o campo "Salva log (XX4_SAVLOG)" como "1 - Sim".
|
|
|