Documentation Center

How to get the event information for an EventId

You can get event information for an EventId of a background process in Event Monitor. You can retrieve information of the event and the event details.

Procedure

  1. In order to get the event information, you need the unique identifier of the event (= ProgressId). So, first the EventId which is returned by the background process, must be converted into ProgressId using the method GetProgressId.
  2. Then the ProgressId can be used to retrieve the information of the event and the event details with the method RetrieveEventsByProgressIds
  3. For each of the event details you can get more metadata (including the event data) by calling GetEventDetail with the unique identifier of the event detail (= DetailId)
    <ishfields>
      <ishfield name='EVENTID' level='detail'/>
      <ishfield name='CREATIONDATE' level='detail'/>
      <ishfield name='STATUS' level='detail'/>
      <ishfield name='ACTION' level='detail'/>
      <ishfield name='DESCRIPTION' level='detail'/>
      <ishfield name='EVENTDATATYPE' level='detail'/>
      <ishfield name='EVENTDATASIZE' level='detail'/>
      <ishfield name='HOSTNAME' level='detail'/>
      <ishfield name='PROCESSID' level='detail'/>
      <ishfield name='THREADID' level='detail'/>
    </ishfields>
  4. You can use GetEventDetail to get the event data of an event detail. However, if the event data is large, we advice you to get the event data in chunks using GetNextEventDetailDataChunk.