Page Comparison

msg_id

number

No

Unique identifier, primary key.

msg_timestamp

datetime

No

Message timestamp, generated by source system.

This timestamp determines processing order of messages.

Source system, part of TraceHeader

TraceHeaderProcessor.TRACE_HEADER

receive_timestamp

datetime

No

Timestamp when message arrives to integration platform, generated by CleverBusOpenHub.

Automatically generated when input request arrives.

service_name

string

No

Service name, e.g. customer

Implements org.openhubframework.cleverbusopenhub.core.entity.ServiceExtEnum interface

Source system

AsynchConstants.SERVICE_HEADER

operation_name

string

No

Operation name, e.g. createCustomer

Source system

AsynchConstants.OPERATION_HEADER

object_id

string

Yes

Object ID that is impacted by processing of this message. For example when this message updates customer object then it can be customer ID.

This values serves for searching messages which impact identical object. When there are two messages in processing queue, both want to change identical object, then first message will be skipped and second one will be processed.

Entity type (implements org.openhubframework.cleverbusopenhub.api.entity.EntityTypeExtEnum interface).

In general it's enough to detect identical changed data by objectId and operation name but there are few different operations which can change the same data (e.g. setCustomer, setCustomerExt).
If defined then it will be used for "obsolete operation call" detection instead of operation name.

correlation_id

string

No

ID generated by source system that is important for pairing request and asynchronous response in source system.

Combination correlation_id and source_system is unique.

Source system, part of TraceHeader

TraceHeaderProcessor.TRACE_HEADER

Process identifier serves for pairing messages of same process.

Source system, part of TraceHeader

TraceHeaderProcessor.TRACE_HEADER

payload

string (XML)

No

Message payload

The whole input request, e.g. SOAP envelope including headers and body

source_system

string (enum)

No

Source system (implements org.openhubframework.cleverbusopenhub.core.entity.ExternalSystemExtEnuminterface)

Source system, part of TraceHeader(applicationID)

TraceHeaderProcessor.TRACE_HEADER

state

string (enum)

No

Message state (enum value:

• NEW: new saved message
• PROCESSING: message is being processed
• OK: successfully processed message
• PARTLY_FAILED: last processing ended with error, there will be next try
• FAILED: finally failed message, no next processing
• WAITING: parent message that waits for child messages
• WAITING_FOR_RES: message that waits for confirmation/response from external system
• CANCEL: message was canceled by external system or by administrator. This state isn't set by this application.
• POSTPONED: message is postponed because there was another message that was processed at the same time with same funnel values.

failed_count

number

No

Count of unsuccessful tries. Default value is 0.

failed_error_code

string

Yes

Error code when message processing failed (implements org.openhubframework.cleverbusopenhub.core.common.exceptions.ErrorExtEnum interface)

failed_desc

string

Yes

Error description when message processing failed.

last_process_timestamp

datetime

Yes

Timestamp when this message was lasttime updated.

Field for saving custom data, suitable for sharing information between more tries of processing.

Reference to parent message (parent-child binding).

Useful for parent-child binding, ChildMessage#createMessage

string

(SOFT)

Binding type defines how tightly child message does influence parent message:

• HARD: result of child message influences result of parent message (for example when child message ends in FAILED state then parent message will in FAILED state too)
• SOFT: result of child message has no effect to parent message

Useful for parent-child binding only, see asynch-child component.

Funnel value is for finding out if two or more concurrent messages impact identical target object. Funnel value can be anything, e.g. customer ID, subscriber mobile number, custom string etc.

This value is for msg-funnel component use.

Funnel identifier that specifies unique point during message processing. Messages are checked and filtered out to this point.

This value is for msg-funnel component use.

When this flag is true then mesage is processed in guaranteed order.

Messages in FAILED state are taking into consideration for guaranteed order by default. If FAILED state should be excluded then this flag will be true.

Value of this attribute has sense only when guaranteed_order is true.