Âncora | ||||
---|---|---|---|---|
|
A camada do EAI Protheus compreende uma série de ferramentas para auxiliar o envio e recebimento de mensagens e o seu gerenciamento.
Âncora | ||||
---|---|---|---|---|
|
O Schedule Protheus é utilizado para o envio e recebimento de mensagens d0 EAI no modelo Assíncrono. Mensagens do tipo síncrona não necessitam de schedule Protheus configurado.
A fila de integrações do EAI (tabela XX3) guarda as mensagens enviadas e recebidas pelo EAI Protheus.
Para entender os termos e a configuração do Schedule Protheus consulte o artigo disponível no TDN clicando aqui.
Âncora | ||||
---|---|---|---|---|
|
Quando um evento de integração é disparado no Protheus, o adapter cadastrado é chamado para executar o envio da mensagem. A rotina de processamento gera o XML de integração, e esta mensagem é gravada na tabela XX3 (a fila de mensagens do EAI Protheus). De acordo com a recorrência cadastrada para a rotina de transmissão das mensagens do EAI esta fila é lida e os registros que se encontram em condições de envio são enviados para o sistema receptor. Um registro está em condições de envio se respeitar as condições a seguir:
Image Removed
Âncora | ||||
---|---|---|---|---|
|
Image Added
Status das mensagens na fila do EAI Protheus
Uma rotina que já tenha o seu número de execuções maior ou igual a 4 somente será reprocessada caso exista intervenção do usuário, através do botão 'tentar novamente'. Desta maneira, o número de tentativas da mensagem é reiniciado e o status da mensagem retorna para 'Aguardando execução'. Este processo somente pode ser realizado em mensagens assíncronas e que estejam nos status de 'Falhou' ou 'Bloqueado'.
Image Removed
Âncora | ||||
---|---|---|---|---|
|
Image Added
Detalhe da barra de botões da interface do EAI, no Schedule Protheus. O primeiro botão destacado é o botão de 'tentar novamente'.
Para que o envio das mensagens assíncronas seja realizado, é necessário que seja realizado o cadastramento, no Schedule Protheus, da rotina FWEAI. Esta rotina é responsável pelo envio e recebimentos das mensagens na fila do EAI. Caso necessário, pode ser realizado o agendamento da rotina FWEAISEND. Esta rotina é exclusiva para o envio das mensagens da fila do EAI. O agendamento desta rotina é realizado por Empresa cadastrada no sistema. No envio da mensagem, um canal de comunicação é aberto com o webservice do produto integrado, e esta comunicação é encerrada após o recebimento da mensagem de retorno (no caso das Mensagens Única Totvs, após o recebimento da ReceiptMessage, indicando que que o processo ocorreu corretamente) ou por timeout (mensagem com status de falha).
Posteriormente, o outro sistema integrado poderá gerar uma outra mensagem de resposta (no caso das Mensagens Única Totvs, será gerada uma ResponseMessage) após o processamento da mensagem. Esta mensagem será gravada na fila do EAI e seu comportamento será idêntico ao destacado no tópico recebimento de mensagens assíncronas.
Âncora | ||||
---|---|---|---|---|
|
Neste tipo de transação uma mensagem é enviada de outro sistema para o EAI Protheus. A camada de Webservices realiza a gravação desta mensagem na tabela XX3 (fila de mensagens do EAI Protheus). De acordo com a recorrência cadastrada para a rotina de recebimento esta fila é lida e as respectivas rotinas de processamento das mensagens são disparadas. Para que uma rotina tenha o seu processo de recebimento iniciado ela deve estar em condições de recebimento, respeitando os seguintes pontos:
Uma rotina que já tenha o seu número de execuções maior ou igual a 4 somente será reprocessada caso exista intervenção do usuário, através do botão 'tentar novamente'. Desta maneira, o número de tentativas da mensagem é reiniciado e o status da mensagem retorna para 'Aguardando execução'. Este processo somente pode ser realizado em mensagens assíncronas e que estejam nos status de 'Falhou' ou 'Bloqueado'. O detalhe deste botão pode ser visualizado na figura acima.
Para que o recebimento das mensagens assíncronas seja realizado, é necessário que seja realizado o cadastramento, no Schedule Protheus da rotina FWEAI. Esta rotina é responsável pelo envio e recebimentos das mensagens na fila do EAI. Caso necessário, pode ser realizado o agendamento da rotina FWEAIRECE. Esta rotina é exclusiva para o recebimento das mensagens da fila do EAI. O agendamento desta rotina é realizado por Empresa cadastrada no sistema.
Se uma mensagem assíncrona encontra-se na fila e ela for uma mensagem recebida pelo Protheus o adapter é chamado para processamento da mesma .Nas Mensagens Única TOTVS essa Receive pode ser do tipo Business (uma mensagem de algo a ser processado no Protheus) ou ainda uma ResponseMessage (uma mensagem de resposta de um evento enviado a outro ERP). Caso essa mensagem seja uma Business, será realizado o seu processamento e após isto, será gravada uma nova mensagem na fila do EAI Protheus com a resposta para o outro sistema.
Âncora | ||||
---|---|---|---|---|
|
Estão disponíveis para agendamento no Schedule Protheus as seguintes rotinas do EAI:
O processo de envio somente é inicializado após o término do processamento de todas as mensagens recebidas que estão na fila em condições de serem processados.
Âncora | ||||
---|---|---|---|---|
|
No envio de mensagens síncronas o comportamento do EAI é mais simples. Após iniciar a integração, um canal de comunicação com o webservice do produto integrado é aberto, e a mensagem enviada no mesmo momento. A comunicação é encerrada após o recebimento da resposta ou por timeout.
Âncora | ||||
---|---|---|---|---|
|
As rotinas que são responsáveis por realizar o processamento das mensagens enviadas e recebidas são cadastradas no ambiente do Configurador Protheus. Em Ambiente/Schedule/Adapter E.a.i, no Cadastro de Adapter EAI (APCFG20) é possível incluir, alterar e excluir um adapter no Protheus.
Tela do browse do Cadastro de Adapters
O adapter APCFG060 é nativo do próprio EAI Protheus, e seu cadastro é realizado automaticamente. Mesmo que este adapter seja excluído pelo usuário ele será recriado automaticamente. Este adapter é utilizado nas mensagens de EAI que utilizam a arquitetura da Mensagem Única TOTVS.
Parte superior do Cadastro de Adapters no Protheus
São campos importantes deste cadastro:
O conteúdo destas tags pode conter dois valores: E – Para exclusivo e C para compartilhado.
Âncora | ||||
---|---|---|---|---|
|
Aviso | ||||
---|---|---|---|---|
| ||||
Esta melhoria está disponível somente a partir da lib label 06042015 do Protheus. |
É possível, para adapters do tipo Mensagem Única Totvs (campo XX4_UNMESS = 1-Sim) com canal de Envio EAI (campo XX4_CHANEL =2-EAI) o envio de mensagens para mais de um destino e também o envio de ResponseMessage (respostas de mensagens assíncronas) para valores diferentes dos especificados nos parâmetros MV_EAIURL2, MV_EAIMETH, MV_EAIWS, MV_EAIPASS e MV_EAIUSER (para detalhes sobre estes parâmetros, veja o tópico parâmetros importantes do EAI Protheus.).
Cada rota de EAI é definida pelo produto integrado (nas Mensagens Únicas Totvs este valor é conteúdo do atributo name, da tag Product) e pela aplicação de origem integrada (valor da tag SourceApplicationdo Xml). Desta maneira cada registro cadastrado na tabela XX4 (cadastro de adapters) pode possuir somente uma rota destinada ao par Produto/aplicação de Origem.
No exemplo abaixo podemos ver onde esta informação é trafegada no Xml da Mensagem Única TOTVS: Image Removed
Âncora | ||||
---|---|---|---|---|
|
Image Added
Exemplo de cabeçalho de trecho do Xml de Mensagem Única TOTVS
No exemplo acima, teríamos o produto integrado RM, com a aplicação origem sendo PR11_BRA. Os valores acima são fictícios.
Vejamos agora a imagem do novo cadastro de adapters:
Nova tela do cadastro de adapters do Protheus
Como funciona o roteamento no Protheus?
No grid de roteamento cadastramos as informações sobre o produto integrado no campo Produto (XB0_PROD), onde informamos o produto do roteamento. No campo Aplicação Ori. (XB0_SOUIRCE) indicaremos a aplicação origem do produto integrado.
No campo Envia (XB0_SENDER) iremos informar se aquela rota é para envio e recebimento (1=Sim) ou somente para a geração da ResponseMessage (2=Não). E qual o comportamento do EAI para ambos os casos?
Quando é disparada uma integração no Protheus o EAI busca neste grid de roteamento informações de todas as rotas cadastradas com Envia=1-Sim. Ele então faz o disparo da integração para cada rota cadastrada. Rotas configuradas com o campo Envia=2-Não não são enviadas. Como não é possível, em múltiplos envios, realizar controles de transação entre todos os sistemas e também pelo alto tempo de resposta quando existem vários sistemas integrados, para que seja possível cadastrar mais de uma rota de envio o adapter deve estar configurado, no campo Método (XX4_METODO), com a opção 2=Assíncrono. Caso não seja encontrada nenhuma rota de envio, o processo padrão é executado (envio utlizando os parâmetros).
Mensagens com mais de uma rota são geradas na fila do EAI Protheus com um único diferencial, o seu UUID (Universally Unique Identifier). É gerada uma nova mensagem na fila por rota de envio, que são depois processadas normalmente pelo Schedule Protheus.
Quando o Protheus recebe uma Mensagem Única TOTVS síncrona nada muda no processo. A ResponseMessage é devolvida para quem enviou a mensagem.
Já no recebimento de uma Mensagem Única TOTVS assíncrona, o processo torna-se diferente. A BusinessMessage é recebida no Protheus, gravada na fila de mensagens do EAI (tabela XX3) e é gerada a ReceiptMessage, que é devolvida para quem enviou a mensagem. Após o processamento da mensagem na fila do EAI é gerada então uma ResponseMessage. Para enviar esta mensagem, o EAI Protheus busca no adapter relacionado se existe alguma rota cadastrada (independentemente do valor do campo Envia) com o produto e aplicação de origem recebidos na mensagem. Caso seja encontrada rota, a ResponseMessage é enviada para esta rota. Caso não seja encontrada são utilizados para o envio os valores contidos nos parâmetros MV_EAIURL2, MV_EAIMETH, MV_EAIWS, MV_EAIPASS e MV_EAIUSER.
O campo Url (XB0_URL) contém o endereço de webservices do EAI para o qual será enviada a mensagem.
O campo Client Ws (XB0_WS) contém o nome do client de webservices utilizado para esta integração. Ele já vem com o valor default wseaiservice, que é client interno do EAI de controle do Framework Protheus. Caso seja necessário a criação de outro client, este deve ser compilado no repositório de dados Protheus com um nome diferente do client padrão, e o nome da classe deve ser colocada neste campo.
No campo Método (XB0_METH) deve ser incluído o nome do método de webservices que será consumido no envio da mensagem. Este campo já vem com o valor padrão receiveMessage, que é o método padrão do EAI TOTVS.
Os campos Usuário WS (XB0_USR) e Senha Ws (XB0_PSW) devem ser alterados quando existe autenticação de webservices pelo outro EAI. Caso não exista esta necessidade estes campos podem continuar vazios. O EAI TOTVS Mensagem Única trabalha com autenticação do tipo basic, conforme a RFC (Request for Comments) 2617.
Basicamente, quando possuímos rotas cadastradas, os valores dos parâmetros a seguir são substituídos pelos seguintes campos:
Vamos mostrar como cadastrar as rotas para um adapter de Mensagem Única TOTVS. Vamos utilizar para este exemplo o adapter FINA010 (Cadastro de Naturezas).
Parte superior do cadastro de adapters, onde cadastramos a rotina FINA010
No exemplo acima, cadastramos a mensagem como síncrona. Neste caso, poderemos somente cadastrar uma rota de envio (mas podemos cadastrar mais de uma rota de resposta)
Vamos agora cadastrar as rotas no grid de roteamento:
´
Rotas cadastradas para o adapter
Veja que cadastramos mais de uma rota para um adapter síncrono. Mas somente uma é rota de envio. As demais são apenas rotas de resposta.
Pelo exemplo acima, quando realizarmos qualquer operação de inclusão, alteração ou exclusão de registros do cadastro de naturezas o EAI Protheus irá enviar a Mensagem Única TOTVS síncrona para o produto DATASUL, no endereço listado na primeira linha. Quando for necessário gerar uma ResponseMessage de uma Mensagem Única TOTVS assíncrona que tenha chegado no Protheus, ele irá buscar dentre as três linhas deste grid qual é o produto e aplicação de origem contidos na mensagem original recebida pelo Protheus. Caso seja encontrado, a mensagem será disparada para a rota cadastrada.
Vamos agora cadastrar o adapter MATA070 (BANK) com mais de uma rota de envio.
Adapter com mais de uma rota de envio
Detalhe do roteamento
Vemos no exemplo acima que cadastramos mais de uma rota de envio. Neste caso ao iniciar uma integração no Protheus, o EAI irá buscar na tabela de rotas quais rotas existem disponíveis para envio. Será gerada uma mensagem única por rota de envio. Neste nosso exemplo, serão geradas duas mensagens na fila do EAI, uma endereçada para o produto RM e outra endereçada para o produto DATASUL. As mensagens são iguais, diferenciadas apenas pelo seu UUID. Depois de geradas na fila, as mensagens seguem o fluxo padrão descrito na seção envio de mensagens assíncronas.
Quando for necessário gerar uma ResponseMessage de uma Mensagem Única TOTVS assíncrona que tenha chegado no Protheus, ele irá buscar dentre as três linhas deste grid qual é o produto e aplicação de origem contidos na mensagem original recebida pelo Protheus. Caso seja encontrado, a mensagem será disparada para a rota cadastrada.
Caso não exista rota cadastrada no adpater, o seu comportamento padrão não será alterado.
Na parte inferior deste cadastro existe um último grid de Tags para Busca. É possível incluir neste campo tags nas quais se deseja pesquisar o valor, e o valor destas tags é gravada concatenada com '|', posteriormente no campo XX3_REFER, no mesmo registro da mensagem.
Âncora | ||||
---|---|---|---|---|
|
No EAI Protheus existe a possibilidade de se cadastrar, para as Mensagens Únicas TOTVS, um relacionamento entre a Empresa e Filial de processamento que chegou na mensagem com uma existente no Protheus. Isto se deve ao fato de que, na Mensagem Única TOTVS os valores trafegados na mensagem são sempre do sistema que enviou a mensagem, cabendo ao sistema receptor a tradução das informações trafegadas. Desta forma é enviada na mensagem o valor do correspondente a Empresa e Filial do sistema que originou a mensagem o que, em muitas vezes, não coincide com o código destas entidades no Protheus.
Vamos observar os campos deste cadastro, no menu Ambiente/Schedule/Emp.Fil Msg. Unica (APCFG050):
Figura 5 - Tela do cadastro de De/para de Empresas e FiliaisDe
Estes valores podem ser encontrados no cabeçalho da mensagem. Veja a imagem do cabeçalho aqui.
A transformação dos valores recebidos para os valores de contexto do Protheus é realizada automaticamente pelo EAI Protheus. Como isto é realizado pode ser verificado no tópico Montagem de ambientes no recebimento das mensagens pelo EAI Protheus.
Âncora | ||||
---|---|---|---|---|
|
De acordo com as definições da Mensagem Única TOTVS os valores transitados nas mensagens refletem sempre os códigos dos produtos que as enviam. Por este motivo existe um facilitador que pode ser utilizado pelas Mensagens Únicas TOTVS. Através do cadastro de De/Para de mensagens é possível realizar o relacionamento dos códigos recebidos e associar com os códigos internos do Protheus.
Vamos verificar os campos deste cadastro, no menu Ambientes/Schedule/De.Para Msg.Unica (APCFG070):
Tela do Cadastro de De/Para de Mensagem Única TOTVS
Os campos do formulário deste cadastro são:
O grid deste cadastro possui dois campos:
Normalmente não há necessidade de manipulação deste cadastro pelo usuário. Os adapters da Mensagem Única TOTVS realizam a manutenção e consulta do mesmo.
Importante: O preenchimento do formulário deste cadastro é definido para cada mensagem no Protheus, e a regra para os campos Tabela, Alias, Campo, Valor Externo e Valor Interno é definida pelo criador da mensagem. O acesso e manipulação das informações deste facilitador não são realizados pela camada do EAI Protheus e sim pela camada do adapter. A utilização ou não deste recurso pelo adapter é de responsabilidade da equipe que o criou.
As rotinas utilizadas internamente pelos adapters para realizar a manipulação destes registros são demonstradas no tópico funções utilizáveis no EAI Protheus.
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
O EAI Protheus utiliza alguns parâmetros de sistema para definir o comportamento da integração. Estes parâmetros são listados abaixo:
Âncora | ||||
---|---|---|---|---|
|
A classe FWEAI é a classe responsável por criar os objetos principais do EAI Protheus. Para verificar o funcionamento desta classe, acesse a sua documentação no TDN clicando aqui.
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
O EAI Protheus permite o processamento das mensagens recebidas na empresa e filial indicadas no cabeçalho da mensagem.
Para mensagens do envelope TOTVSIntegrator o valor recebido nas tags DocCompany (empresa) e DocBranch (filial) são consultados e seus valores utilizados para determinar ao EAI Protheus qual será o par Empresa/Filial no qual o ambiente será criado. Caso o valor destas tags sejam inválidos no contexto do Protheus (empresa e filial inexistente ou inválidas) é retornado uma mensagem de SoapFault para o sistema que enviou a mensagem.
Para mensagens da arquitetura de Mensagem Única TOTVS (TOTVSMessage) estes valores são recebidos nas tags CompanyId (Empresa) e BranchId (Filial). Estas tags estão no path /TOTVSMessage/MessageInformation do XML recebido. Para as Mensagens Única TOTVS existe um comportamento adicional para a montagem de ambientes. Primeiramente é verificado se o par empresa/filial recebido na mensagem existe no De-para de Empresas no Protheus (tabela XXD). Caso seja encontrado o relacionamento de de-para no Protheus o ambiente é montado com os valores encontrados. Caso não seja encontrado o relacionamento é realizada a tentativa de montagem de ambiente com os valores recebidos diretamente na mensagem. Em ambos os casos (encontrando o relacionamento e não encontrando-o) a empresa e filial são validadas, e em caso de não possibilidade de processamento é retornada um SoapFault para o sistema que enviou a mensagem.
Âncora | ||||
---|---|---|---|---|
|
O Ponto de entrada EAICHGEMP é um ponto de entrada utilizado, no recebimento das mensagens únicas pelo EAI Protheus para que seja possível dizer para qual empresa e filial o ambiente deverá ser aberto. O array PARAMIXB enviado neste ponto de entrada recebe possui cinco elementos:
O retorno esperado deste ponto de entrada é um array de duas posições, sendo a primeira posição o valor da empresa/grupo e a segunda posição o valor completo da filial. Exemplo de retorno esperado do ponto de entrada = {'18',' D MG 01'}. A empresa e filial retornados no array devem ser válidas no contexto do Protheus.
Caso seja retornado um array vazio neste ponto de entrada, o EAI segue o caminho descrito no tópico Montagem de ambientes no recebimento das mensagens pelo EAI Protheus.
Status do documento | Concluído |
---|---|
Data | 14/05/2015 |
Versão | 1.1 |
Versão anterior | 1.0 |
Autores |
Índice resumido | ||||||
|
Índice | ||||||
|