Customizing event management tools

Edit online

The tools in the Event Viewer and AEL search for event data based on fields from the Netcool®/OMNIbus ObjectServer. The fields are specified by URLs that are called when the Operations Analytics - Log Analysis product is started from the tools. You can change the URLs in the tools from the default event fields to search on fields of your choice.

For example, the Search for similar events > 15 minutes before event tool filters events on the AlertGroup, Type, and Severity fields. The default URL is:

$(SERVER)/integrations/scala/Search?queryFields=AlertGroup,Type,Severity&queryValuesAlertGroup={$selected_rows.AlertGroup}&queryValuesType={CONVERSION($selected_rows.Type)}&queryValuesSeverity={CONVERSION($selected_rows.Severity)}&firstOccurrences={$selected_rows.FirstOccurrence}&timePeriod=15&timePeriodUnits=minutes

About this task

You can change the URLs in the following ways:

Change the scalaIntegration.xml configuration file and apply the changes with the Web GUI runwaapi command that is included in the Web GUI Administration API (WAAPI) client.
Change the tool configuration in the Web GUI Administration console page.

Procedure

As an example, the following steps show how to use each method to change the URLs in the Search for similar events > 15 minutes before event tool to search on the AlertKey and Location event fields.

To change the URLs in the scalaIntegration.xml configuration file:
1. In WEBGUI_HOME/extensions/LogAnalytics/scalaIntegration.xml, or the equivalent XML file if you use a different file, locate the following <tool> element:
```
<tool:tool name="scalaSearchByEvent15Minutes">
```
2. Change the URL in this element as follows.
  The changes are shown in bold text:
```
<tool:cgiurl foreach="true" windowforeach="false" target="_blank" method="GET" url="$(SERVER)/integrations/scala/Search?queryFields=AlertKey,Location&queryValuesAlertKey={$selected_rows.AlertKey}&queryValuesLocation={$selected_rows.Location}&firstOccurrences={$selected_rows.FirstOccurrence}&timePeriod=15&timePeriodUnits=minutes">
</tool:cgiurl>
```
3. Use the runwaapi command to reinstall the tools:
```
runwaapi -file scalaIntegration.xml
```
4. Reinstall the following tool menus to the Event Viewer or AEL alerts menu item:
  - scalaStaticDashboard
  - scalaSimilarEvents
  - scalaEventByNode
  - scalaKeywordSearch
To change the URLs on the Administration page:
1. In the Web GUI, click Administration > Event Management Tools > Tool Creation. Then, on the Tool Creation page, locate the scalaSearchByEvent15Minutes tool.
2. Change the URL as follows.
  The changes are shown in bold text:
```
$(SERVER)/integrations/scala/Search?queryFields=AlertKey,Location&queryValuesAlertKey={$selected_rows.AlertKey}&queryValuesLocation={$selected_rows.Location}&firstOccurrences={$selected_rows.FirstOccurrence}&timePeriod=15&timePeriodUnits=minutes
```
3. Refresh the Event Viewer or AEL so that the changes to the tool URL are loaded.

What to do next

The Gateway for Message Bus uses a lookup table to convert the Severity, Type, and Class event field integer values to strings. After a tool is changed or created, use the CONVERSION function to change these field values to the strings that are required by Operations Analytics - Log Analysis.

Change the other tools in the menu so that they search on the same field. It is more efficient to change the configuration file and then use the runwaapi command than to change each tool in the UI. The following table lists the names of the event management menu items and tools that are displayed in the Tool Creation and Menu Configuration pages.

Table 1. Web GUI menu and tool names
Menu item	Menu item name	Tool	Tool name
Search for events by node	scalaEventByNode	15 minutes before event	scalaSearchByNode15Minutes
		1 hour before event	scalaSearchByNode1Hour
		1 day before event	scalaSearchByNode1Day
		1 week before event	scalaSearchByNode1Week
		1 month before event	scalaSearchByNode1Month
		1 year before event	scalaSearchByNode1Year
		Custom ...	scalaSearchByNodeCustom
Search for similar events	scalaSimilarEvents	15 minutes before event	scalaSearchByEvent15Minutes
		1 hour before event	scalaSearchByEvent1Hour
		1 day before event	scalaSearchByEvent1Day
		1 week before event	scalaSearchByEvent1Week
		1 month before event	scalaSearchByEvent1Month
		1 year before event	scalaSearchByEvent1Year
		Custom ...	scalaSearchByEventCustom
Show event dashboard by node	scalaStaticDashboard	15 minutes before event	scalaEventDistributionByNode15Minutes
		1 hour before event	scalaEventDistributionByNode1Hour
		1 day before event	scalaEventDistributionByNode1Day
		1 week before event	scalaEventDistributionByNode1Week
		1 month before event	scalaEventDistributionByNode1Month
		1 year before event	scalaEventDistributionByNode1Year
		Custom ...	scalaEventDistributionByNodeCustom
Show keywords and event count	scalaKeywordSearch	15 minutes before event	scalaSetSearchFilter15Minutes
		1 hour before event	scalaSetSearchFilter1Hour
		1 day before event	scalaSetSearchFilter1Day
		1 week before event	scalaSetSearchFilter1Week
		1 month before event	scalaSetSearchFilter1Month
		1 year before event	scalaSetSearchFilter1Year
		Custom ...	scalaSetSearchFilterCustom

The Show event dashboard by node and Show keywords and event count tools start the OMNIbus Static Dashboard and OMNIbus Keyword Search custom apps in Operations Analytics - Log Analysis. For more information about customizing the apps, see Customizing the Apps.