Histórico da Página

...

• MessageInformation - version: Identifica qual a versão daquela mensagem de negócio. Uma mensagem de Item, por exemplo, pode sofrer alterações no decorrer do tempo, sendo que cada uma destas alterações irá afetar esta informação;
• UUID: Identificador único desta mensagem e que não pode ser igual ao UUID de qualquer outra mensagem em qualquer um dos aplicativos participantes da integração;
• Type: Identifica o tipo da mensagem (BusinessMessage, ReceiptMessage ou ResponseMessage);
• Transaction: Identificador do tipo de transação da mensagem. Esta informação será utilizada pelos aplicativos para definir como os dados serão processados no recebimento;
• StandardVersion: Identifica a versão do padrão TOTVS, ou seja, do formato utilizado nas áreas genéricas da mensagem TOTVS. Caso o padrão TOTVS seja alterado, este valor será alterado;
• SourceApplication: Identifica a instancia dos aplicativos TOTVS que gerou a mensagem. Uma instância representa uma instalação/configuração daquele aplicativo/produto. Caso duas instancia do mesmo aplicativo participem da mesma integração, cada um deverá ser identificado de forma única;
• CompanyId: Identificador da empresa que gerou a mensagem. Esta informação é apenas documentacional e não deve ser utilizada para o processamento da mensagem já que não existe garantia da sua existência na mensagem. Quando a informação da empresa for relevante para o negócio, é preciso buscar esta informação do conteúdo da mensagem de negócio;
• Product: Identifica o produto e versão que originou a mensagem. Neste caso, o valor pode ser o igual, mesmo em instâncias diferentes do mesmo aplicativo;
• GeneratedOn: Identifica o timestamp de geração desta mensagem.

BusinessMessage – Event

...

As mensagens de eventos de negócio basicamente descrevem o evento ocorrido, como no exemplo abaixo:

Onde:

• Entity: Identifica qual foi a entidade de negócio que sofreu o evento;
• Event: Qual foi o evento associado à mensagem (pode ser upsert – inclusão/alteração – ou delete – eliminação);
• Identification/Keys: campos-chave para identificação do registro impactado pela alteração;
• BusinessContent: XML com informações sobre o evento, normalmente contendo todas as informações pertinentes àquela entidade.

BusinessMessage – Request

...

As mensagens de request descrevem qual função se deseja executar e os parâmetros necessários, como no exemplo abaixo:

Onde:

• Operation: Identifica qual a operação que se deseja executar;
• BusinessContent: XML com informações necessárias para o processamentos, normalmente parâmetros de entrada.

ResponseMessage

...

As mensagens de resposta contém informações sobre o resultado do processamento de uma BusinessMessage, como no exemplo abaixo:

Onde:

• ReceivedMessage: Segmento com informações sobre a mensagem original (BusinessMessage) que deu origem à esta resposta
  • SentBy: Indica qual foi a instancia que gerou a mensagem original;
  • UUID: Identificador universal da mensagem de origem;
  • MessageContent: XML da mensagem original (opcional).
• ProcessingInformation: Segmento com informações sobre o resultado do processamento
  • ProcessedOn: Timestamp de quando a mensagem foi processada pelo destino
  • Status: Situação final do processamento (OK ou ERROR)
  • ListOfMessages: Lista de mensagens (erro ou aviso) retornadas no processamento.
• ReturnContent: XML com as informações de negócio retornadas no processamento.

ReceiptMessage

...

As informações contidas nas mensagens de recibo são genéricas e focam especificamente nos dados de recebimento da mensagem.

Onde:

• ReceivedMessage: Segmento com informações sobre a mensagem original (BusinessMessage) que deu origem à esta resposta.
  • SentBy: Indica qual foi a instancia que gerou a mensagem original;
  • UUID: Identificador universal da mensagem de origem;
  • MessageContent: XML da mensagem original (opcional).
• ReceiptData: Segmento com informações sobre o recebimento da mensagem
  • ReceivedOn: Timestamp do recebimento da mensagem;