EVENT data segment definitions

The EVENT data segment contains event information used in event processing. The pipeline only processes incoming data in this data segment, if Event Manager is enabled for your system.

CAUTION:
You can only use one <EVENT> segment per UMF_ENTITY input document. If you insert multiple <EVENT> segments in the same UMF_ENTITY, the system ignores the event data, which will result in event data loss. If you need to send multiple event records for the same entity, divide the event information into multiple UMF_ENTITY input documents, making sure that there is only one <EVENT> segment per UMF_ENTITY.
Tag Name Field Type Data Type Required Explanation
EVENT_TYPE Key Attribute VarChar(100) Yes

A unique code that indicates the type of user-defined event.

Examples of event types include WIRE_TRANSFER or CC_PURCHASE.

EVENT_REF   VarChar(100) Yes A unique identifier assigned to the event by the client system. For example, a transaction number from the client system.
EVENT_LOC   VarChar(100) No A free-form text field that indicates the location where the event occurred.
EVENT_MEMO1   VarChar(512) No A free-form text field that can contain any extra notation or comment from the client system.
EVENT_MEMO2   VarChar(512) No A free-form text field that can contain any extra notation or comment from the client system.
EVENT_START_DT   Date Yes The starting date and time of the event.
EVENT_END_DT   Date Yes The ending date and time of the event. (This date and time can be the same as the start date and time.)
EVENT_QTY   Decimal(18,2) Yes The quantity involved in this event.
EVENT_UNIT_VALUE   Decimal(18,2) Yes

The value of a single unit of the event type in this transaction.

For money transaction events, this value is equal to 1. For example, if the unit of measure is in U.S. dollars, the unit value is 1, which equals $1USD.

EVENT_VALUE   Decimal(18,2) Yes

The total value of this event.

For example, if the event is a wire transfer of $500USD, the value is 500.

EVENT_STATUS   VarChar(100) Yes
Value that indicates the status of this event. Default values include:
  • PENDING
  • CONFIRMED
  • ERROR