FWEAI

Classe: FWEAI

Compatível Países: Todos

Sistemas Operacionais: Todos

Compatível às Bases de Dados: Todos

Nível de Acesso: Nível 1 (Acesso Clientes)

Idiomas: Português, Inglês, Espanhol

Versão 1.0

FWEAI
Descrição
Esta classe tem como objetivo permitir a integração entre
o Microsiga Protheus e quaisquer produtos que software
utilizando TOTVS ESB como meio de integração.
New
Sintaxe
FWEAI():New()-> NIL

Descrição
Método construtor da classe

Exemplo
oFWEAI := FWEAI():New()
Activate
Sintaxe
FWEAI():Activate()-> NIL

Descrição
Método de ativação da classe
Exemplo
oFWEAI:Activate()
Deactivate
Sintaxe
FWEAI():Deactivate()-> NIL

Descrição
Método que permite a desativacao da classe

Exemplo
oFWEAI:Deactivate()
ClassName
Sintaxe
FWEAI():ClassName()-> NIL

Descrição
Método que retorna o nome da classe.

Exemplo
oFWEAI:ClassName()
AddLayout
Sintaxe
FWEAI():AddLayout(< cIdentifier >, < cVersion >, <
cFunctionCode >, < cLayout >)-> NIL

Descrição
Método que adiciona uma transação.

Parâmetros
 Nome Tipo Descrição Default Obrigatório Referência

cIdentifier Caracteres Identificação X

da transação.

cVersion Caracteres Versão da X

transação.

cFunctionCo Caracteres Função que X

de será
executada.

cLayout Caracteres XML da X

transação.

Exemplo
oFWEAI:AddLayout( "ID", "1.0", "u_teste", "000001" )
GetDocCompany
Sintaxe
FWEAI():GetDocCompany()-> cDocCompany

Descrição
Método de retornA a empresa utilizada.

Retorno
cDocCompany Empresa utilizada.

Exemplo
cCompany := oFWEAI:GetDocCompany()
GetDocBranch
Sintaxe
FWEAI():GetDocBranch()-> cDocBranch

Descrição
Método de retorna da filial utilizada.

Retorno
cDocBranch Filial utilizada.

Exemplo
cBranch := oFWEAI:GetDocBranch()
GetDocIdentifier
Sintaxe
FWEAI():GetDocIdentifier()-> cDocIdentifier

Descrição
Método de retorno da identificação da transação.

Retorno
cDocIdentifier Identificador da transação. Só é atribuido
valor após a utilização do método Save().

Exemplo
cID := oFWEAI:GetDocIdentifier()
GetFuncExec
Sintaxe
FWEAI():GetFuncExec(< nIndice >)-> Função

Descrição
Método de retorno da função a ser executada de um
layout.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

nIndice Numérico Posição do X

layout que
deseja
retornar a
função.
Retorno
Função a ser executada para o layout passado como
parametro.

Exemplo
cFunction := oFWEAI:GetFuncExec( 2 )
GetFuncExec
Sintaxe
FWEAI():GetFuncExec(< nIndice >)-> Função

Descrição
Método de retorno da função a ser executada de um
layout.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

nIndice Numérico Posição do X

layout que
deseja
retornar a
função.

Retorno
Função a ser executada para o layout passado como
parametro.

Exemplo
cFunction := oFWEAI:GetFuncExec( 2 )
GetLayouts
Sintaxe
FWEAI():GetLayouts()-> Array

Descrição
Método de retorno dos layouts adicionados.

Retorno
Array com todos os layouts adicionados.

Exemplo
aLayouts := oFWEAI:GetLayouts()
GetTransactions
Sintaxe
FWEAI():GetTransactions(< nIndice >)-> XML

Descrição
Método de retorno do XML que será passado como
parâmetro para a execução de um layout.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

nIndice Numérico Posição do X

layout que
deseja
retornar o
XML.

Retorno
XML que será passado como parâmetro para a execução
de um layout.

Exemplo
cXML := oFWEAI:GetTransactions( 2 )
GetUUID
Sintaxe
FWEAI():GetUUID()-> cUUID

Descrição
Método de retorno do código UUID.

Retorno
cUUID Código gerado da transação.

Exemplo
cUUID := oFWEAI:GetUUID()
BuildXML
Sintaxe
FWEAI():BuildXML()-> cXML

Descrição
Método de retorno do XML gerado após salvar a
transação.

Retorno
cXML XML gerado após salvar a transação.

Exemplo
cXML := oFWEAI:BuildXML()
BuildEAI
Sintaxe
FWEAI():BuildEAI()-> NIL

Descrição
Constroi XML para Mensagem Protheus
GetResultSync
Sintaxe
FWEAI():GetResultSync()-> cXML

Descrição
Método de retorno do XML gerado após a execução da
transação sincrona em caso de erro e sucesso na
transação.

Retorno
cXML XML gerado após a execução da transação sincrona

Exemplo
cXML := oFWEAI:GetXMLResult()
OpenTable
Sintaxe
FWEAI():OpenTable()-> NIL

Descrição
Método de abertura da tabela de fila de transações XX3. Se
atributo cDocCompany não estiver em branco abre com a
empresa contida nele, se não pega da variavel cEmpAnt.

Exemplo
oFWEAI:OpenTable()
SetDocFederalID
Sintaxe
FWEAI():SetDocFederalID(< cDocFederalID >)-> NIL

Descrição
Método de atribuição do CNPJ/CPF/RUT do cliente
proprietário da transação.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cDocFederalI Caracteres CNPJ/CPF/R X

D UT do cliente
proprietário
da transação.

Exemplo
oFWEAI:SetDocFederalID( "Id do cliente" )
SetDocName
Sintaxe
FWEAI():SetDocName(< cDocName >)-> NIL

Descrição
Método de atribuição do nome do cliente proprietário da
transação.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cDocName Caracteres Nome do X

cliente
proprietário
da transação.
Exemplo
oFWEAI:SetDocName( "Nome do cliente" )
SetDocType
Sintaxe
FWEAI():SetDocType(< cDocType >)-> NIL

Descrição
Método de atribuição do tipo da transação.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cDocType Caracteres Código do X

tipo da
transação 1
(Sincrona) ou
2
(Assincrona).

Exemplo
oFWEAI:SetDocType( "Tipo da transação" )
SetFuncCode
Sintaxe
FWEAI():SetFuncCode(< cFuncCode >)-> NIL

Descrição
Método de atribuição da transação global.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

 cFuncCode Caracteres Transação X
global.

Exemplo
oFWEAI:SetFuncCode( "Clientes" )
SetFuncDescription
Sintaxe
FWEAI():SetFuncDescription(< cFuncDescription >)-> NIL

Descrição
Método de atribuição da descrição da transação global.

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cFuncDescri Caracteres Descrição da X

ption transação
global.

Exemplo
oFWEAI:SetFuncDescription( "Descrição da transação" )
SetResultSync
Sintaxe
FWEAI():SetResultSync(< cXML >)-> NIL

Descrição
Método de atribuicao do XML gerado após a execução da
transação sincrona
Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cXML Caracteres XML gerado X

após a
execução da
transação
sincrona

Exemplo
cXML := oFWEAI:SetXMLResult()
Save
Sintaxe
FWEAI():Save()-> Resposta

Descrição
Método de persistência da transação, só pode ser utilizado
após a chamada do método Activate().

Retorno
Resposta do serviço, usada quando a transação for
sincrona.

Exemplo
xResponse := oFWEAI:Save()
Read
Sintaxe
FWEAI():Read()-> NIL

Descrição
Método que realiza a leitura de um registro da tabela de
transacoes EAI, só pode ser utilizado após a chamada do
método Activate().

Exemplo
lReturn := oFWEAI:Read()
Update
Sintaxe
FWEAI():Update()-> Confirmação

Descrição
Método que atualiza a transação, só pode ser utilizado
após a chamada do método Activate().

Retorno
Confirmação do update

Exemplo
lReturn := oFWEAI:Update()
Delete
Sintaxe
FWEAI():Delete()-> Confirmação

Descrição
Método que deleta transação, só pode ser utilizado após a
chamada do método Activate().

Retorno
Confirmação da deleção.

Exemplo
lReturn := oFWEAI:Delete()
BuildReceipt
Sintaxe
FWEAI():BuildReceipt()-> NIL

Descrição
Constroi XML para Mensagem Unica de Receipt
BuildResponse
Sintaxe
FWEAI():BuildResponse()-> NIL

Descrição
Constroi XML para Mensagem Unica de Response
BuildBusiness
Sintaxe
FWEAI():BuildBusiness()-> NIL

Descrição
Constroi XML para Mensagem Unica de Business
SetTypeMessage
Sintaxe
FWEAI():SetTypeMessage(< cTypeMessage >)-> NIL

Descrição
Define o tipo de mensagem do EAI

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cTypeMessa Caracteres Tipo de X

ge mensagem
SetSendChannel
Sintaxe
FWEAI():SetSendChannel(< cChannel >)-> NIL

Descrição
Define o tipo de canal de envio EAI ou ESB

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cChannel Caracteres Tipo de canal X

ResetLayouts
Sintaxe
FWEAI():ResetLayouts()-> NIL

Descrição
Reinicia os layouts
ChkSendChannel
Sintaxe
FWEAI():ChkSendChannel()-> NIL

Descrição
Verifica a disponibilidade do canal de envio ESB ou EAI
GetXML
Sintaxe
FWEAI():GetXML()-> NIL

Descrição
Método de retorna o XML da Mensagem
SetType
Sintaxe
FWEAI():SetType(< cType >)-> NIL

Descrição
Define o tipo da mensagem

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cType Caracteres Tipo de X

mensagem

SetRefer
Sintaxe
FWEAI():SetRefer(< cRefer >)-> NIL

Descrição
Define os dados de referência para busca

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cRefer Caracteres Chave de X

busca

SetAdapter
Sintaxe
FWEAI():SetAdapter(< cAdapter >)-> NIL

Descrição
Define o nome do adapter que será utilizado

Parâmetros

Nome Tipo Descrição Default Obrigatório Referência

cAdapter Caracteres Nome do X

Adapter EAI