User Guide › Design › Data Acquisition › Event Management

Event Management

The Event Viewer is used to search and view raw data events. The Event Viewer enables viewing, printing and exporting the events retrieved from adapters, “received” business logic events (retrieved from committed metrics), “sent” business logic events (sent to metrics) and corrected events.

The Event Viewer can also be used from the Business Logic Scope to show received and sent events.

The Event Viewer is used to quickly find data gaps and check the data integrity. It is also used when customers require the documentation of all information flowing into the system. Using the Event Viewer, a report based on the events can be created.

Overview

Insight’s Event management feature enables manipulation of raw data events. Users can select and view business data using a number of different report filters. Sometimes however, the raw data will lead to a seemingly incorrect result or problem. Event Management enables editing data in order to correct seemingly erroneous data reporting errors.

Consider for example, the following situation:

• Metric – measures time to close a ticket.
• Target – Close 95% of tickets within 2 hours
• Result – 90% of tickets meet the target.
• Actions – Drill down into the Report’s raw data to view 10 events. Nine of these events were closed within the target; one was closed after 3 hours.
• Check – After a quick check, we see that the ticket was indeed closed within the 2 hours limit, but the ticket was updated after 3 hours by the technician.
• Result – Use Event Management to edit the data to accurate reflect the actual results.

The table below lists the Raw Data events available in Insight, the states available to each, possible sources and an explanation.

Note: Each event type can be in one or more states:

Event Management Screen

The Event Management window enables searching for raw data events and viewing them. In addition, you can print and export events retrieved from adapters, “received” business logic events (retrieved from committed metrics), “sent” business logic events (sent to metrics) and corrected events (i.e., events that have been replaced, added or deleted manually via corrections and update and delete individual raw data records, i.e., the following:

• Events retrieved from adapters
• Business Logic Events (sent and received)
• Business Logic Events sent to metrics
• Business Logic Events from committed metrics
• Corrected events

Permissions / Access Control

The following table and figure show the permissions required to use the Event Management functions.

Viewing Events

Searching for events is a two-part process. The first part is to select the search criteria. The second is to sort and group the events.

You can search for an event by Timestamp, Event Type, Resource and Destination Metric.

1. To open the Event Management window click Design, Data Acquisition, Event Management. The Event Management windows opens.
2. Select the desired filter parameters and click the Search button. The window displays a list of Events corresponding to the search criteria.
3. Follow the instructions below to search for events.

To search for events:

1. In the Event Management page, expand the search form and select the search option/s:
   1. In Timestamp, select:
   • Time Range: A range of time defined from a certain day to a certain day.
   • Last: A range of time over the last X number of hours, days, weeks months, quarters and years.
   • From Beginning: A range of time defined as of the beginning of the hour, day, week month, quarter and year.
   1. In Event Type, select the event type from the Available list and move to the Included list.
   2. In Resource:
   • Click Add to select resources to the search. The Find Resources page is displayed to tod.

     If required, filter the list of resources displayed by entering search criteria in one or more of the available fields.

     -OR-

     Select a letter from the alphabetical list to search for all resources that begin with that letter.

     Click Search. The search results are displayed under the search field.

     Select the resource(s) that you want included in the search and click OK. The resource is displayed in the Resource box.

   -OR-

   • Click Remove to clear resources from the search.
   1. In Destination Metric:
   • Click Add to select destination metrics to the search. A Find page is displayed.

     Select a metric(s) from the available contract(s) under the available contract party/parties and click OK.

   -OR-

   • Click Remove to clear destination metrics from the search.
2. Click Search. The results are displayed below the search area. For more information on the search results grid, see Using Search Results Grids.

The search results include the following information about each event:

• The event ID
• The event type
• The event source name
• The event source type
• The resource
• The timestamp
• The event's created date

Event Parameters

The Event Management window includes the Details column (see subsection following) in addition to the following attributes:

Event States

Each Event exists in a specific state. The table below lists possible Event states and an explanation of each.

Event Management: Details

In addition to the parameters listed above, the Event Management Window lists Details of events. The Details column shows a compacted description of the event fields and their values.

A full version of Event Details is shown in the Details pane (on the far right).

Editing Events

Events can be edited from within the Details pane when:

• The Original event is in one of the following states: “Original” or “Correction”
• The Event Management – “Update” role permissions has been assigned to the user (see Permissions, above).

The following event attributes can be edited:

• Resource
• Time Stamp
• Event Type Data Fields

Note: The Event Type cannot be changed.

Event Operations

The following operations can be performed on Insight events.

• Correct – Allowed only on events with the following statuses:
  • Original
  • Correction
• Exclude –Allowed only on events with the following status:
  • Original
• Revert –Allowed only on events with the following status:
  • Overridden
• Delete –Allowed only on events with the following status:
  • Correction

Notes:

• Delete & Revert perform similar operations:
• Revert returns an Overridden event to its Original state and deletes the corresponding Correction.
• Delete deletes the Correction and returns the corresponding Overridden event to its Original state.

To Edit an Event

1. Click the event to be edited. The Details panel opens.
2. Click the Edit button. The parameters that can be edited appear as entries in a text entry field.
3. Edit the parameter/s as required and click the Correct button to correct (i.e., save, the new value/s in memory only).

Editing Constraints

The following restrictions/constraints apply when editing an Event:

• The timestamp cannot be earlier than the purge data line (system configuration parameter “pslwriter/raw_data_pdl”), if defined.
• The timestamp cannot be later than the max date (if defined). This is used when table t_raw_data has database partitioning defined.
• The encoded field data is not longer than 4000 characters eg "The total encoded field data is {0} characters too long". (Force the user to truncate his text after telling how many characters are over the limit.)
• The resource, timestamp and event type are mandatory.

Committing Changes

To commit changes, Follow these steps::

1. Press the “Correct” button.
2. To commit changes (if any) press the “Commit” button.
3. The tree in the left side panel is not immediately updated (even the totals) until a Commit is done.
4. The changes are committed and appear in all new calculations using this data.

Event States After Editing

The table below lists the changes to an Event’s state following editing.

Note: Corrections are stored in memory; they are not saved to the database. To save to the database, click Commit; a recalculation will be performed as well.

Corrections and Event Singularity

A singular event is one that occurs exactly one time. Instead of adding a new event to an existing set of events, new information replaces the current information and a single event remains.

Example: President of the USA. There is only one. A different person eventually occupies the office (new information, new date, etc.) but there is only one at any given time.

Loading a singular event after a correction has been defined

Corrections take precedence over event singularity, even if the adapter with "update" event singularity was run with the original data after the correction was done.

Corrections take precedence over an automatically changed action (event singularity).

When an event is in state "Original", and the event must be updated due to event singularity, it is updated and keeps the state "Original"

When an event is in state "Excluded", and the event is updated due to event singularity, the event is updated and the state "Excluded" is maintained.

For corrected events, two events exist: "Overridden", and "Correction". When running a corresponding adapter, the "Overridden" event may have its details updated (and remain "Overridden"): the "Correction" remains as is.

The Event Singularity mechanism only checks in the database for events inserted by the current adapter (i.e., state Original/Overridden/Excluded). It does not look at events whose source is "Correction", or events inserted by other adapters.

To correct events with an event singularity defined on the adapter

No checking is done for Event Singularity performing a Correction. The Correction mechanism does not provide Event Singularities with "Add". This means that it is possible to correct two separate events to have the same data. The event singularity defined on the original adapter is not referenced.

Additional Editing Information

The controls shown during Edit correspond to the field structure of the Event Type that you have selected.

The Resource name of the event being edited is displayed next to “Resources” parameter name.

1. Click the button next to it (see figure below) to display the “Select Resources” popup. You can select any Resource within the system.

   Note: The resource name shown is the actual resource name (i.e. after translation). Therefore within the Edit Details pane, a preexisting resource is required.

   Note: When the Event type structure has more fields than are defined in the raw data event, those fields are shown as “null” in view mode. In edit mode these edit boxes are empty (see figure above).

   Note: When the Event type structure has fewer fields than are defined in the raw data event, the additional fields are shown in view mode (as type “unknown”), but disappear within edit mode.

When correcting an event, its structure will corresponding to the latest Event Type structure.

Default Data Structure

The Event type individual fields are optional. If a user presses the “Correct” button, without first entering a value for optional fields, the value of the optional fields will be set automatically using the following conventions:

Event Comparison

Event Comparison enables the user to view “Overridden” events and their corresponding “Correction” events.

To compare an event

1. Locate and click any event that is not is it Original state.
2. Expand the Details pane.
3. Click the Compare button; the Event Comparison window appears. You can view the compared events side-by-side. Differences are highlighted.

Reports: Editing Event Data

Insight enables editing Event data within a Reports’s Analysis tab. This enables modifying data “on the fly” in order to correct errors when viewing a report.

To edit data

1. Generate a report (or open an existing one).
2. Right click on the chart and drill down to the data to be changed.
3. Right click on the chart and select “View Raw Data”.

OR

1. Generate a report (or open an existing one).
2. Click the Analysis tab. The screen displays the Reports parameters.
3. Select the desired parameter (more than one may be present – see figure below: parameters are outlined in red).
4. Click the arrow next to the corresponding “View Raw Data and Root-Cause Comments”. The Raw Data is displayed.
5. An “Open Event Management” icon is displayed on each row corresponding to a raw data event (as opposed to intermediate data). The state of these events is shown.
6. Click an Event’s “Open Event Management” icon. The “Event Management” window opens to the same Raw Data result set displayed in the current Report. The Event selected above is the one selected in the “Event Management” environment that is now open.
7. Edit, Correct and Commit the data as required (see Committing Changes, below)

Calculation Status

The calculation status of a report is given by the Calculation Status icon located at the top the Report (in all tabs).

The Calculation Status can be any of the following:

Calculation Delay

After the “Commit” button is pressed (or after Data is loaded via an Adapter or DLF), there is a period during which the information shown in the Data and the Chart tabs is different than the data displayed in the Analysis tab.

During this period, the Report status may initially be shown as “Complete”, instead of “Not Calculated”. This is because the ACE engine has not yet processed the changes.

Note: If the last calculation date is earlier than the date/time of an Event Management “Commit”, but the status is still “Complete”, the ACE engine has not yet started processing these changes.

Note: Following this, the calculation status is shown as “Not Calculated”, “” or “”. Once the recalculation is completed the status becomes “Complete”; information in the Data and Chart tabs then matched the data in the Analysis tab.

The Commit message box therefore includes a warning to the user that “Reports dependant on this data may not be immediately updated”.

Committing Changes

Changes that have been made to data must be committed in order for them to take effect.

1. Go to the Event Management main window; select the data to be committed. This is all data that is in the state: Pending.
2. Click the Commit button to commit the corrected entry to the database. The Commit Corrections dialog opens.
3. Enter the justification for making the change and click “Commit”. The change will be committed and will appear in all new calculations using this data.

   Note: All pending data changes in the current user session are committed.

   Note: In the event of an error, no data will be committed

   Note: Data is committed in the order in which it was modified.

   Note: Changes are logged in the Audit Trail.

   Note: The Calculation Engines (ACE 1 and ACE2) are notified that they can do a recalculation for each change.

4. If you do not "Commit" button all changes are lost if any of the following occur:
   • The "Cancel" button is pressed (a warning message will appear)
   • A new search is initiated
   • The current user session is lost (including navigating away from the page).

Audit Trail

The Audit Trail contains a description of all changes made to Event Management data. This includes the Create Date of the changes, the User who made them, the Justification and an automatically generated Description of the actual changes made to each EventID involved.

To View the Audit Trail

• Open the Event Management screen.
• Click the button labeled Audit Trail (bottom left screen); the Audit trail window opens.