Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 129

changes.mady.by.user Vinicius Domingues da Silva Fonseca

Gravado em

comparado com

Nova versão 130

changes.mady.by.user Vinicius Domingues da Silva Fonseca

Gravado em

Chave

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

Com o objetivo de padronizar a integrações com outros produtos, foi definida uma nova diretriz para os projetos de integração: os produtos podem se comunicar com uma mensagem XML ou Json única, evitando desta forma o processo de transformação de mensagens.


Neste cenário, teríamos o seguinte quadro:

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

Uma vez que os vários produtos terão um “idioma” em comum, o Xml/Json único, as integrações entre estes produtos não exigirão mais que as mensagens sejam transformadas de um formato para outro.

...

Deck of Cards
idponto2
Card
labelConfiguração RESTful

Para realizar a integração EAI utilizando arquivos Json, é necessário ter um REST funcionando no ambiente.

Para configurar o REST siga as orientações do vídeo: Configuração do REST

Exemplo de configuração do REST: Exemplo de REST

Card
defaulttrue
effectDuration0.5
idTestes de Integrações via XML
labelConfiguração 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
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:
    1. Flag para Habilitar o Protocolo
    2. Path de Arquivos = Caminho da Pasta Web
    3. Ambiente = Nome do Ambiente
    4. 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:
    1. Módulo Web = WS - TOTVS Linha Protheus Web Services
    2. Nome da Instância = ws
    3. Diretório Raiz das Imagens (Web Path) = Diretório da Pasta Web onde o sistema irá criar a pasta "ws"
    4. Selecione o Environment = Nome do Ambiente
    5. Flag para habilitar processos na inicialização do Servidor

  • Realize a Configuração de Host x Empresas/Filiais, campos importantes:
    1. Host = Server e porta dos Web Services (Deve ser informada a porta informada na Configuração HTTP/FTP)
    2. Selecione a Empresa/Filial = Empresa e Filial de acesso (Para configuração Multifilial, consulte a respectiva aba)
    3. 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
titleAppServer.ini

[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
titleEXEMPLO

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

Aviso
titleAlerta de risco

Fique atento ao utilizar o parâmetro de configuração com a chave Security=0, pois isso fará com que as integrações (APIs) não exijam autenticação, consequentemente dados do seu ambiente poderão ser consultados sem qualquer controle de autorização.

...

Card
labelTestando com WebServices

Escolha sua ferramenta preferida para testes:

Expandir
Deck of Cards
iddeck2
Card
defaulttrue
idIntegração Mensagem única
labelConfiguração do SoapUI

SoapUI

O SOAPUI é uma ferramenta de mercado onde conseguimos simular o envio do Xml/Json na integração via Mensagem Única, simulando o envio de outros sistemas para o Protheus.
Ou seja, ao invés de termos que instalar o outro sistema e aprender como fazer o processo neles, nós pegamos um Xml/Json de modelo enviamos para o Protheus usando esta ferramenta.

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

Dica
titleEXEMPLO

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
titleImportante:

Caso a integração seja via arquivo Xml, a seguinte Tag deve ser acrescentada:

Bloco de código
titleTags SOAPUI
<![CDATA[

(XML Conteúdo que irá dentro da TAG)

]]>
Card
labelPOSTMAN

...


Expandir
titleTestando XML - WebServices
Deck of Cards
idTestes
Card
labelTestes EAI (Xml)


Image Modified

Deck of Cards
idTestes 2
Card
labelTeste de Recebimento (Xml)

Este teste permite testar o recebimento da Mensagem Única de outro sistema para o Protheus.

Para iniciar os testes é necessário que tenha realizado as etapas:

  1. Cadastro do Adapter
  2. De/Para de Empresas e Filiais
  3. De/Para de Mensagem Única (Se for o teste da rotina MATA410)
  4. Configurando os Web Services
  5. Configurando o SOAPUI


Simulação da integração:


Aviso
titleExemplos de XML

Exemplos de XML para testes de integração EAI:

Card
labelTeste de Envio (Xml)

Integração EAI Protheus (SIGAFAT) com destino à outros sistemas


Expandir
titleTestando JSON - RESTful
Deck of Cards
idteest
Card
idIntegração Mensagem única
labelTestes EAI (JSON)

Image Modified

Deck of Cards
idEAI Json
Card
labelTeste de Recebimento (Json)

Este teste permite testar o recebimento da Mensagem Única de outro sistema para o Protheus.

Para iniciar os testes é necessário que tenha realizado as etapas:

  1. Cadastro do Adapter
  2. De/Para de Empresas e Filiais
  3. Exemplo de REST
  4. Configuração do REST
  5. Configurando o SOAPUI


Dica
titleObservação
  • 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.
Aviso
titleImportante
Card
idIntegração Mensagem única
labelTeste de Envio (Json)

Este teste permite testar o envio da Mensagem única do Protheus para outro sistema.

Para iniciar os testes é necessário que tenha realizado as etapas:

  1. Cadastro de Rotas EAI
  2. Cadastro do Adapter
  3. Cadastro do Schedule
  4. Cadastro do Agent
  5. Teste de Envio




4 - Testando



Dica
titleSaiba mais