Abaixo as principais funções do EAI Protheus e dicas de uso:
Âncora |
---|
| _Toc403759553 |
---|
| _Toc403759553 |
---|
|
Static Function IntegDefVeja os tópicos IntegDef em rotinas MVC Protheus e IntegDef em rotinas Não-MVC Protheus.
Â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:
- cSourceCode – Nome do fonte onde se encontra a rotina static IntegDef
- cTypeMessage – Tipo da mensagem (BusinessMessage, etc)
- cType – Tipo da transação (Envio ou recebimento)
- cXml – Xml a ser tratado (normalmente só para recebimento)
- cFunName – Função chamadora da rotina. Quando a mensagem é disparada de um fonte diferente da rotina chamada no Menu, pode usar este recurso para forçar a rotina de tratamento do EAI
- lOnlyReturn – Utilizável somente quando a mensagem é enviada – Define que será gerada apenas a mensagem da IntegDef, e seu envio não será realizado. Desta maneira, não será gerado todo o corpo da Mensagem Única.
Âncora |
---|
| _Toc403759555 |
---|
| _Toc403759555 |
---|
|
FWEAIBusEvent
Cria bloco de XML referente a Business Event da Business Message da Mensagem Única
FWEAIBusEvent( cEntity, nOperation, aKeys )
Parâmetros:
- cEntity - Entidade da mensagem
- nOperation - Operação: 3 ou 4 = upsert / 5 = delete
- aKeys - Vetor bidimensional com campos no formato {Campo, Conteúdo}
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:
- cRequest - Nome da requisição
Exemplo:
cXMLRet := FWEAIBusRequest( "AccountBalance" )
Retorno:
XML a ser utilizado :
<BusinessRequest>
<Operation>AccountBalance </Operation>
</BusinessRequest>
Âncora |
---|
| _Toc403759557 |
---|
| _Toc403759557 |
---|
|
FWEAILOfMessagesFunção para geração de múltiplas mensagens de retorno na Response Message da mensagem única
FWEAILOfMessages( aMessages )
Parâmetros:
- aMessages - Vetor bidimensional com os dados para a criação da mensagem no formato:
- [1] Caracter - Mensagem
- [2] Numérico - Tipo da mensagem: 1=error ou 2=warning
- [3] Caracter - Codigo de Erro da mensagem conforme a mensagem
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 o de/para de empresa filial no Protheus para o CompanyId e BranchId das Mensagem Única no recebimento
FWEAIEMPFIL( cCompanyID, cBranchId, cProduct )
Parâmetros:
- cCompanyID - Codigo da companhia (CompanyID) recebido no XML da mensagem
- cBranchId - Codigo da unidade (BranchID) recebido no XML da mensagem
- cProduct - Codigo do produto (Product) recebido no XML da mensagem
Retorno:
Vetor com { Empresa, Filial }
Â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:
- cRefer - Referencia. Normalmente a "marca" da mensagem: PROTHEUS / LOGIX / RM / DATASUL, etc.
- cAlias - Alias do de/para (SA1, SA2, etc.)
- cField - É a campo de referencia do De/para (A1_COD, B1_COD, etc. )
- cValExt - Código externo para busca do código interno
- cTable - Nome físico da tabela de dados ao qual o de-para se refere. Não é necessário que seja passado. Seu valor default é o RetSqlName do cAlias.
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
CFGA070Int( cRefer, cAlias, cField, cValInt,cTable)
Parâmetros:
- cRefer - Referencia. Normalmente a "marca" da mensagem: PROTHEUS / LOGIX / RM / DATASUL, etc.
- cAlias - Alias do de/para (SA1, SA2, etc.)
- cField - É a campo de referencia do De/para (A1_COD, B1_COD, etc. )
- cValInt - Código interno para busca do código externo
- cTable - Nome físico da tabela de dados ao qual o de-para se refere. Não é necessário que seja passado. Seu valor default é o RetSqlName do cAlias.
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 )
Parâmetros:
- cRefer - Referencia. Normalmente a "marca" da mensagem: PROTHEUS / LOGIX / RM / DATASUL, etc.
- cAlias - Alias do de/para (SA1, SA2, etc.)
- cField - É a campo de referencia do De/para (A1_COD, B1_COD, etc. )
- cValExt - Código externo para gravacao
- cValInt - Código externo para gravaçao
- lDelete - Indica a deleção do registro
- nOrdem - Ordem para busca
- cTable - Nome físico da tabela de dados ao qual o de-para se refere. Não é necessário que seja passado. Seu valor default é o RetSqlName do cAlias.