| Field | documentation | maxLength | Product | FieldERP | Req. | Type | Length | Description |
|---|
| MessageInformation | | |
|
|
|
|
|
|
| UUID |
Define um identificador universal para esta
mensagem. Duas mensagens não podem ter o mesmo
UUID e este valor permanece sempre o mesmo, seja
no aplicativo que gera a mensagem, seja no que
recebe.
| |
|
|
|
|
|
|
| Type |
Identifica o tipo de mensagem: a. Business
Message: Mensagem “real”, sobre um evento
ocorrido (quando for de saída) ou de atualização
do produto (quando entrada). Pode ser de dois
subtipos (ver atributos da tag BusinessMessage):
i. Transaction: Mensagem utilizada para fins de
replicação de dados que contém um evento
ocorrido no sistema (upsert ou delete). Se
recebido, resulta na execução da operação sobre
na base de dados. Se Enviado, significa que o
sistema de origem está notificando esta
operação. Transactions refletem a atividade de
uma aplicação (CrUD) tendem a ser utilizadas de
forma assíncrona. ii. Request: Mensagem
utilizada para solicitar a execução de um
procedimento. Este procedimento pode ser uma
consulta (getOrders, countCustomers), cálculo
(calculateTaxes) ou atualização do banco de
dados (updateAverageCost). Requests promovem o
compartilhamento de serviços e tendem a ser
utilizados de forma síncrona. b. Receipt: Quando
a mensagem for recebida de forma assíncrona, o
produto devolve um recibo com status de
recebimento e com o UUID de rastreabilidade da
mensagem dentro do produto que recebeu c.
Response: Mensagem retornada pelo processamento
da Business Message. Pode trazer apenas o status
(OK ou não), a lista de erros (se houver) ou
informações relevantes (como número de pedido
gerado, por exemplo). Pode ser devolvida na
chamada de uma business message (quando
síncrono) ou enviada de forma assíncrona.
| |
|
|
|
|
|
|
| Transaction |
Identifica o nome da transação que esta mensagem
contém. Exemplo: Branch.
| |
|
|
|
|
|
|
| ContextName |
Campo opcional que identifica o(s) contexto(s) associado(s)
a transação. O contexto pode ser o módulo que gerou a
mensagem, pode identificar a integração entre aplicativos,
enfim, pode ser qualquer informação que permita delimitar
a mensagem, de modo a orientar o roteamento da mensagem
ou o recebimento.
Exemplos: Financeiro, Datasul CRM, Manufatura, APS-Logix, etc.
| |
|
|
|
|
|
|
| StandardVersion | | |
|
|
|
|
|
|
| SourceApplication |
Identifica, dentre os aplicativos integrados,
qual instância gerou a mensagem.
| |
|
|
|
|
|
|
| CompanyId | Representa o id da empresa do usuário que enviou a mensagem. | |
|
|
|
|
|
|
| BranchId | Representa o id do estabelecimento do usuário que enviou a mensagem. | |
|
|
|
|
|
|
| UserId | Representa o id do usuário que enviou a mensagem. | |
|
|
|
|
|
|
| CompanySharingMode | Indica o modo de compartilhamento no nível da Empresa. C para Compartilhada e E para Exclusiva. | |
|
|
|
|
|
|
| BusinessUnitySharingMode | Indica o modo de compartilhamento no nível da Unidade de Negócio. C para Compartilhada e E para Exclusiva. | |
|
|
|
|
|
|
| BranchSharingMode | Indica o modo de compartilhamento no nível da Filial. C para Compartilhada e E para Exclusiva. | |
|
|
|
|
|
|
| Product |
Define qual o produto que originou esta
mensagem. Não confundir o produto com a
instância (atributo de TOTVSMessage).
| |
|
|
|
|
|
|
| GeneratedOn |
Registra a data e hora em que a mensagem foi
gerada. Observe que este campo é do tipo
datetime e que é sugerido que se acrescente a
identificação do fuso horário. Caso a informação
de fuso não esteja presente, os sistemas
entenderão o horário como GMT-0.
| |
|
|
|
|
|
|
| DeliveryType | Forma de entrega da mensagem que foi gerada. Será definida por quem entrega a mensagem. | |
|
|
|
|
|
|
| | |
|
|
|
|
|
|
| CustomInformation | | |
|
|
|
|
|
|
| ReceivedMessage | | |
|
|
|
|
|
|
| ProcessingInformation | | |
|
|
|
|
|
|
| | |
|
|
|
|
|
|
| CustomInformation | | |
|
|
|
|
|
|
| ReceivedMessage | | |
|
|
|
|
|
|
| ReceiptData | | |
|
|
|
|
|
|
| Table | | |
|
|
|
|
|
|
| Created | | |
|
|
|
|
|
|
| MessagePayload | | |
|
|
|
|
|
|