Adding columns to seasonal and related event reports

You can add columns to seasonal event reports and related events reports by updating the aggregated field configuration.

Before you begin

Make sure that the Historical Event database view that contains the data used to generate these reports contains the Acknowledged field. If this is not the case, then you must create a Historical Event database view and add the Acknowledged field to that view.

In Netcool® Operations Insight® 1.4.1.2 and later (corresponding to Netcool/Impact 7.1.0.13 and later) it is recommended to use the Event Analytics Configuration Wizard instead of the ./nci_trigger command to edit properties in the NOI Shared Configuration properties file.

About this task

To update the rollup configuration, complete the following steps.

Procedure

  1. Generate a properties file containing the latest Event Analytics system settings.
    1. Navigate to the directory $IMPACT_HOME/bin.
    2. Run the following command to generate a properties file containing the latest Event Analytics system settings.
      nci_trigger server_name username/password NOI_DefaultValues_Export
       FILENAME directory/filename
      Where:
      • server_name is the name of the server where Event Analytics is installed.
      • user name is the user name of the Event Analytics user.
      • password is the password of the Event Analytics user.
      • NOI_DefaultValues_Export is a Netcool/Impact policy that performs an export of the current Event Analytics system settings to a designated properties file.
      • directory is the directory where the properties file is stored.
      • filename is the name of the properties file.
      For example:
      nci_trigger NCI impactadmin/impactpass NOI_DefaultValues_Export
       FILENAME /tmp/properties.props
  2. Update the properties file that you generated.
    1. Specify the number of columns you want to add to the reports:
      • Increase the value of the number_of_rollup_configuration=2 parameter for seasonal events.
      • Increase the value of the reevent_number_of_rollup_configuration=2 parameter for related events.
      For example, to add one column to the reports, increase the parameter value by one from 2 to 3.
    2. For a new rollup column, add property information.
      • For a new Seasonal Event reports column, add the following properties.
        rollup_<rollup number>_column_name=<column name>
        rollup_<rollup number>_display_name=<column_name>_<type>
        rollup_<rollup number>_type=<type>
      • For a new Related Events reports column, add the following properties.
        reevent_rollup_<rollup number>_column_name=<column name>
        reevent_rollup_<rollup number>_display_name=<column_name>_<type>
        reevent_rollup_<rollup number>_type=<type>
        reevent_rollup_<rollup number>_actionable=<true/false>
        
      <rollup number>
      Specifies the new column rollup number.
      <column name>
      Specifies the new column name. The column name must match the column name in the history table.
      <display name>
      Specifies the new column display name. The display name must match the column name in the report.
      <type>
      Specifies one of the following types:
      MAX
      The maximum value observed for the column. If no value is observed, the value defaults to the minimum value of an integer.
      MIN
      The minimum value observed for the column. If no value is observed, the value defaults to the maximum value of an integer.
      SUM
      The sum of all of the values observed for the column.
      NON_ZERO
      A counting column that counts nonzero occurrences of events. This column can be useful to track the proportion of actioned events, or how many events had an associated ticket number.
      DISTINCT
      The number of distinct values that are seen for this key-value pair.
      EXAMPLE
      Displays the first non-blank example of a field that contained this key. The EXAMPLE type is useful when you are running seasonality on a field that can't be accessed, such as ALERT_IDENTIFIER, and you want an example human readable SUMMARY to demonstrate the type of problem.
      Note: You cannot change the <type> property of a rollup column once the configuration has been updated. You must add a new rollup column and specify a different <type> (with a new <display name> if you are keeping the old rollup).
      actionable=<true/false>
      If this property is set to true for a rollup, the rollup is used to determine the probable root cause of a correlation rule. This root cause determination is based on the rollup that has the most actions that are taken against it. For example, if Acknowledge is part of your rollup configuration and has a property value of actionable=true, then the event with the highest occurrence of Acknowledge is determined to be the probable root cause. Probable root cause determination uses the descending order of the actionable rollups, that is, the first actionable rollup is a higher priority than the second actionable rollup. Only four of the possible <type> keywords are valid for root cause: MAX, MIN, SUM, NON_ZERO.
      If this property is set to false for a rollup, the rollup is not used to determine the probable root cause of a rule. If all rollup configurations have a property value of actionable=false, the first event that is found is identified as the parent.
      To manually change a root cause event for a correlation rule, see Selecting a parent event for a correlation rule.
  3. Import the modified properties file into Event Analytics.
    1. Ensure you are in the directory $IMPACT_HOME/bin.
    2. Run the following command to perform an import of Event Analytics system settings from a designated properties file.
      nci_trigger server_name username/password NOI_DefaultValues_Configure
       FILENAME directory/filename
      Where:
      • server_name is the name of the server where Event Analytics is installed.
      • user name is the user name of the Event Analytics user.
      • password is the password of the Event Analytics user.
      • NOI_DefaultValues_Configure is a Netcool/Impact policy that performs an import of Event Analytics system settings from a designated properties file.
      • directory is the directory where the properties file is stored.
      • filename is the name of the properties file.
      For example:
      nci_trigger NCI impactadmin/impactpass NOI_DefaultValues_Configure
       FILENAME /tmp/properties.props

Results

The rollup configuration is updated.

Example

Example 1. To add a third column to the Seasonal Event report, change the rollup configuration value to 3, and add the properties.
number_of_rollup_configuration=3
rollup_1_column_name=SEVERITY
rollup_1_display_name=SEVERITY_MIN
rollup_1_type=MIN
rollup_2_column_name=SEVERITY
rollup_2_display_name=SEVERITY_MAX
rollup_2_type=MAX
rollup_3_column_name=TYPE
rollup_3_display_name=TYPE_MAX
rollup_3_type=MAX
Example 2. The configuration parameters for a default Related Events report.
reevent_rollup_1_column_name=ORIGINALSEVERITY
reevent_rollup_1_display_name=ORIGINALSEVERITY_MAX
reevent_rollup_1_type=MAX
reevent_rollup_1_actionable=true
reevent_rollup_2_column_name=ACKNOWLEDGED
reevent_rollup_2_display_name=ACKNOWLEDGED_NON_ZERO
reevent_rollup_2_type=NON_ZERO
reevent_rollup_2_actionable=true
reevent_rollup_3_column_name=ALERTGROUP
reevent_rollup_3_display_name=ALERTGROUP_EXAMPLE
reevent_rollup_3_type=EXAMPLE
reevent_rollup_3_actionable=false

What to do next

To add columns to the Seasonal Event reports, Historical Event portlet, Related Eventreports, or Related Event Details portlet complete the following steps:

  1. Log in to the Tivoli® Netcool/Impact UI.
  2. Go to the Policies tab.
  3. Open the policy that you want to modify. You can modify one policy at a time.
    • For Historical Events, open the SE_GETHISTORICALEVENTS policy.
    • For Seasonal Events, open the SE_GETEVENTDATA policy.
    • For related events groups, open one of the following policies.
      • RE_GETGROUPS_ACTIVE
      • RE_GETGROUPS_ARCHIVED
      • RE_GETGROUPS_EXPIRED
      • RE_GETGROUPS_NEW
      • RE_GETGROUPS_WATCHED
      Note: Each policy is individually updated. To update two or more policies, you must modify each policy individually.
    • For related events, open one of the following policies.
      • RE_GETGROUPEVENTS_ACTIVE
      • RE_GETGROUPEVENTS_ARCHIVED
      • RE_GETGROUPEVENTS_EXPIRED
      • RE_GETGROUPEVENTS_NEW
      • RE_GETGROUPEVENTS_WATCHED
      Note: Each policy is individually updated. To update two or more policies, you must modify each policy individually.
    • For related events details group instances table, open the following policy:
      • RE_GETGROUPINSTANCEV1
  4. Click the Configure Policy Settings icon.
  5. Under Policy Output Parameters, click Edit.
  6. To create a custom schema definition, open the Schema Definition Editor icon.
  7. To create a new field, click New.
  8. Specify the new field name and format.
    • The new field name must match the display name in the configuration file.
    • The format must match the format in the AlertsHistory Table.
    • The format must be appropriate for the rollup type added. For example, for numerical types such as SUM or NON_ZERO use a numeric format. Use String for DISTINCT, if the base column is String.
    • Refresh the SE_GETHISTORICALEVENTS_Db2 table, or other database model, before you run Event Analytics with the added Historical Event table fields.
    • For the RE_GETGROUPS_ policies, only rollup columns with a <type> value of MAX, MIN, SUM, NON_ZERO are supported. Therefore, add only numeric fields to the schema.
  9. To complete the procedure, click Ok on each of the open dialog boxes, and Save on the Policies tab.
    Note: Columns that are created for the Related Event Details before Netcool Operations Insight release 1.4.0.1 are displayed as designed. Configurations and groups that are created after you upgrade to Netcool Operations Insight release 1.4.0.1, display the events from the historical event. By adding columns to the Related Event Details, you can display additional information such as the owner ID or ticketnumber.
You can also add the following columns for group instances in the Related Event Details:
  • SERVERSERIAL
  • SERVERNAME
  • TALLY
  • OWNERUID

By default, the previously listed columns are hidden for group instances in the Related Event Details. To display these columns in the Related Event Details, you need to edit the Policy_RE_GETGROUPINSTANCEV1_RE_GETGROUPINSTANCEV1.properties file, which is located in the following directory: $IMPACT_HOME/uiproviderconfig/properties.

Specifically, set the following properties in the Policy_RE_GETGROUPINSTANCEV1_RE_GETGROUPINSTANCEV1.properties file from their default values of true to the values false (or comment out the field or fields):

SERVERSERIAL.hidden=true
SERVERNAME.hidden=true
TALLY.hidden=true
OWNERUID.hidden=true
For example,
OWNERUID.hidden=false
Or, for example,
#OWNERUID.hidden=true