Abaixo as principais funções do EAI Protheus e dicas de uso:

Âncora
_Toc403759540 _Toc403759540

Classe FWEAI

         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
_Toc403759553 _Toc403759553

Static Function IntegDef

Veja os tópicos IntegDef em rotinas MVC Protheus e IntegDef em rotinas Não-MVC Protheusa definição da IntegDef aqui.

Âncora
_Toc403759554 _Toc403759554

FWIntegDef

Função de geração de mensagem Única de forma manual, acionando a IntegDef do programa indicado.
FWIntegDef( cSourceCode, cTypeMessage, cType, cXml, cFunName, lOnlyReturn, cVersion )
Parâmetros:

Âncora
_Toc403759555 _Toc403759555

FWEAIBusEvent

Cria bloco de XML referente a Business Event da Business Message da Mensagem Única
FWEAIBusEvent( cEntity, nOperation, aKeys )
Parâmetros:

Exemplo:
cXMLRet := FWEAIBusEvent( "ITEM", 5, { { "Code", SB1->B1_COD } } )
Retorno:
XML a ser utilizado:
<BusinessEvent>
<Entity>ITEM</Entity>
<Event>delete</Event>
<Identification>
<key name="code">0000000001</key>
</Identification>
</BusinessEvent>

Âncora
_Toc403759556 _Toc403759556

FWEAIBusRequest

Cria bloco de XML referente à Business Request da Business Message da Mensagem Única
FWEAIBusRequest( cRequest )

Parâmetros:

Exemplo:
cXMLRet := FWEAIBusRequest( "AccountBalance" )

Retorno:
XML a ser utilizado :
<BusinessRequest>
<Operation>AccountBalance </Operation>
</BusinessRequest>

Âncora
_Toc403759557 _Toc403759557

FWEAILOfMessages

Função para geração de múltiplas mensagens de retorno na Response Message da mensagem única
FWEAILOfMessages( aMessages )
Parâmetros:

Exemplo:
aMessages := {}
aAdd( aMessages, { 'Estado nao existe' , 1, '001' } )
aAdd( aMessages, { 'CNPJ invalido' , 1, 'A10' } )
aAdd( aMessages, { 'Nao informado tipo', 2, '500' } )
cRet := FWEAILOfMessages( aMessages )
// cRet será
//<Message type="error" code="001">Estado nao existe</Message>
//<Message type="error" code="A10">CNPJ invalido</Message>
//<Message type="warning" code="500">Nao informado tipo</Message>

Âncora
_Toc403759558 _Toc403759558

FWEAIEMPFIL

Verifica e retorna o de/para de empresa filial no Protheus para o CompanyId e BranchId das Mensagem Única no recebimento .
FWEAIEMPFIL( cCompanyID, cBranchId, cProduct,lExternal )

Parâmetros:

Retorno:
Vetor com { Empresa , Filial } ou vazio, caso a informação não seja encontrada. 

Exemplo:

Buscando o par de grupo/filial do Protheus através dos dados recebidos do RM:

aEmpFil := FwEaiEmpFil('01','0001','RM') → Caso seja encontrado correspondente no cadastro de adapters de grupos e filiais irá retornar o grupo e filial do Protheus

Buscando o par de empresa/filial do RM no Protheus 

aEmpFil := FwEaiEmpFil('18','D MG 01','RM',.T.) → Caso seja encontrado correspondente no cadastro de adapters de grupos e filiais irá retornar o grupo e filial do RM.

Âncora
_Toc403759559 _Toc403759559

CFGA070Int

Obtém um código interno da tabela de/para através de um código externo
CFGA070Int( cRefer, cAlias, cField, cValExt,cTable )
Parâmetros:

Retorno:
Código Externo

Âncora
_Toc403759560 _Toc403759560

CFGA070Ext

Obtém um código externo da tabela de/para através de um código interno
CFGA070IntCFGA070Ext( cRefer, cAlias, cField, cValInt,cTable)
Parâmetros:

Retorno:
Código Externo

Âncora
_Toc403759561 _Toc403759561

CFGA070Mnt

Faz a Inclusão /Alteração / Exclusão dos dados na tabela de/para
CFGA070Mnt( cRefer, cAlias, cField, cValExt, cValInt, lDelete, nOrdem,cTable,cOwnerMsg )

Parâmetros:

O Delete dos registros pode ser realizado de duas maneiras diferentes.

• Ao chamar a função para excluir os de-para e não passar a variável cRefer (a marca), todos os registros que possuem aquele InternalId, independente de qual foi a marca geradora, serão apagados. Exemplo de chamada:
  
  • CFGA070Mnt( , 'SA1', 'A1_COD', , '18|D MG 01002|01|C', .T. ) - Neste caso, serão excluídos da tabela XXF todo InternalId da tabela SA1, de chave A1_COD que possuam o código 18|D MG 01002|01|C, independente da marca que o gerou;
• Pode-se excluir exclusivamente o de-para de uma única marca, deste modo, esta deve ser passada na chamada da função:
  • CFGA070Mnt('RM' , 'SA1', 'A1_COD', , '18|D MG 01002|01|C', .T. ) - Desta maneira, somente serão excluídos os de-para de código interno 18|D MG 01002|01|C que foram gerados em uma integração com o produto RM.

Âncora
_Toc403759561 _Toc403759561

SetRotInteg

Ajusta a rotina de integração no EAI (o GetRotInteg()), quando a rotina chamada não é a rotina de contexto da integração. Ao utilizar esta rotina, após a chamada da integração é aconselhável utilizá-la para voltar o GetRotInteg() ao estado original.
SetRotInteg( cFunction )

Parâmetros:

Exemplo

SetRotInteg('CTBA030')

Âncora
_Toc403759561 _Toc403759561

GetRotInteg

Devolve a rotina de contexto de integração na Mensagem Única
GetRotInteg( )

Exemplo

cRotina:=GetRotInteg()

Âncora
_Toc403759561 _Toc403759561

_NoTags

Ajusta uma string trocando os caracteres de controle do XML por suas entidades de referência
_NoTags( cTexto)

Parâmetros:

Exemplo

cRetorno:=_NoTags( 'Quero enviar Pais&Filhos ->"Novo Texto" ')

cRetorno assumirá

Quero enviar Pais&amp;Filhos-&gt;&quot;Novo Texto&quot;

Âncora
_Toc403759561 _Toc403759561

FWHasEai

Verifica se uma rotina possui configuração de EAI
FWHasEAI( cFunction, lVerifySend, lVerifyRec, lVerifyUMess,lRestArea )

Parâmetros:

          Se todos os parâmetros forem omitidos, será verificado apenas se há uma configuração de EAI para a rotina independentemente de se ter o envio ou recebimento habilitados.

Exemplo

lRetorno:=FWHasEai('MATA020',.T.,,.T.) //verifica se existe a mensagem única do fonte MATA020 cadastrada para envio

Âncora
_Toc403759559 _Toc403759559

FwEAiSndTo

Função que retorna  para qual produto cadastrado no Roteamento EAI a mensagem está sendo enviada

FwEaiSndTo( )

Retorno:

Produto cadastrado na rota (DATASUL, RM, etc.)

Obs: Caso não exista rota cadastrada é retornado uma string vazia.

Âncora
_Toc403759559 _Toc403759559

FwAdapterVersion

Função que retorna a versão de uma dado adapter cadastrado. 

FwAdapterVersion( cRotina, cModel)

Parametros:

Retorno:

Versão cadastrada na XX4, Exemplo : "2.003"

Obs: Caso o adapter não esteja cadastrado o retorno será vazio

Âncora
_Toc403759559 _Toc403759559

FwAdapterInfo

Função que retorna Informações de um determinado adapter

FwAdapterInfo( cRotina, cModel)

Parametros:

Retorno:

Array com os dados conforma cadastrado na XX4. utilizando fwadaptereai.ch atualizado pode se usar os seguintes defines para acessar as informações

Obs: Caso o adapter não esteja cadastrado o retorno será um array vazio