Documentation Center

How to find the event information for an event

Find an event to view event details and metadata, and information that may help in identifying and resolving problems.

Procedure

  1. Generate a list with all events using RetrieveEventOverview. The user can navigate through the list and select an event based upon the metadata, such as the description.
    Requested metadata XML
    <ishfields>
       <ishfield name='EVENTID' level='progress'/>
       <ishfield name='EVENTTYPE' level='progress'/>
       <ishfield name='CREATIONDATE' level='progress'/>
       <ishfield name='MODIFICATIONDATE' level='progress'/>
       <ishfield name='DESCRIPTION' level='progress'/>
       <ishfield name='STATUS' level='progress'/>
       <ishfield name='USERID' level='progress'/>
       <ishfield name='MAXIMUMPROGRESS' level='progress'/>
       <ishfield name='CURRENTPROGRESS' level='progress'/>
    </ishfields>
  2. When one of the events is selected, the ProgressId of this event 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.