`tpf_bev_evtmsg`

Defines the structure that contains a list of the event message components for an event message business event. Each index in the list represents a specific part of the event message.

tpf_bev_evtmsg is the structure that is used to represent the event message for the external interfaces:

Application enrichment program
Dispatch enrichment program
Event error program
Event custom data format program

Structure format

typedef struct tpf_bev_evtmsg
{
   char                 emVersion;
   #define TPF_BEV_EVTMSG_STRUCT_VERSION    1
   char                 spare1[7];
   char                 *emSchema;
                                        
   tpf_bev_evtmsg_item  emItemList[TPF_BEV_EVTMSG_NUM_ITEM_LIST];

} tpf_bev_evtmsg;

typedef struct tpf_bev_evtmsg_item
{
   unsigned int         emItemSize;
   unsigned int         spare1; 
   void                *emItem;

} tpf_bev_evtmsg_item;



Symbolic names for emItemList indexes:
    TPF_BEV_EVTMSG_FULLMSG
    TPF_BEV_EVTMSG_HEADER
    TPF_BEV_EVTMSG_ECBCTX
    TPF_BEV_EVTMSG_USRCTX
    TPF_BEV_EVTMSG_EVTDATA

Symbolic names for the root elements for each of the event message items:
    TPF_BEV_EVTMSG_ROOT_FULLMSG
    TPF_BEV_EVTMSG_ROOT_HEADER
    TPF_BEV_EVTMSG_ROOT_ECBCTX
    TPF_BEV_EVTMSG_ROOT_USRCTX
    TPF_BEV_EVTMSG_ROOT_EVTDATA

Structure fields and symbolic names

emVersion: The version for this structure.
emSchema: A pointer to the address of the DFDL schema file that describes the format of this event message. The DFDL schema file is specified by the <esEventMessageFormat> element in the business event specification for this event.
You can use a DFDL schema file with the root element names (TPF_BEV_EVTMSG_ROOT_*) to initialize a DFDL API handle by using the tpf_dfdl_initialize_handle function. Then you can use z/TPF DFDL APIs to manage the complete event message or a component of the event message.
emItemList: The array of the tpf_bev_evtmsg_item structures that contain the sizes and addresses of the structures that form the event message.
emItemSize: The size of the structure that forms the event message. If this item is not included in the event message, the size is 0.
emItem: A pointer to the address of the structure that forms the event message. If the event item is not included in the event message, the address is NULL.
TPF_BEV_EVTMSG_FULLMSG: The index into the emItemList array that represents the complete event message and is contained in contiguous storage. This index is set up only before business event processing calls the event custom data format program and is only valid for use by the event custom data format program. For all other user written programs, the size and address of this item are 0.
TPF_BEV_EVTMSG_HEADER: The index into the emItemList array that represents the event header.
TPF_BEV_EVTMSG_ECBCTX: The index into the emItemList array that represents the event ECB context.
TPF_BEV_EVTMSG_USRCTX: The index into the emItemList array that represents the event user context.
TPF_BEV_EVTMSG_EVTDATA: The index into the emItemList array that represents the event data. For a signal event, this is the data that is passed by the application that uses the tpf_bev_signal function. For a data event, this is a data event data that includes the data event data header and data collected by data event processing.