Deploying the Netcool/OMNIbus probe for Message Bus

Netcool/OMNIbus events can be generated from Agile Service Manager status. You use the IBM Tivoli Netcool/OMNIbus Message Bus probe (nco_p_message_bus) to receive status from Agile Service Manager and generate corresponding events in Netcool/OMNIbus.

About this task

The Netcool/OMNIbus Message Bus probe must be configured to receive status from Agile Service Manager in JSON format via HTTP, and generate corresponding events in the Netcool/OMNIbus Event Viewer. These events are then fed back to the Agile Service Manager via the Netcool/OMNIbus XML Gateway, which updates the Agile Service Manager status via the Event Observer with the eventId.

The following diagram depicts how the Netcool/OMNIbus Message Bus probe and the XML Gateway work together with the Agile Service Manager Event Observer to keep the event status between Agile Service Manager and Netcool/OMNIbus synchronized.

Specifically, this diagram shows how the data flow from Agile Service Manager status generates Netcool/OMNIbus events. When Netcool/OMNIbus is the source of events, however, the data flow from the Event Observer to the topology service not only updates the status eventId with ServerName/ServerSerial, but generates the status itself.

1. Download and install the Netcool/OMNIbus probe for Message Bus using the IBM Installation Manager.

   Location

   The default OMNIHOME install location is /opt/IBM/tivoli/netcool/omnibus

2. Use the following information to configure the probe properties file so that it can receive Agile Service Manager status.

   Probe properties file

   Create and edit the probe property file.

   In the following example, a non-default property file is used, which requires the -propsfile option when running the probe.

   cd $OMNIHOME/probes/linux2x86/
   cp message_bus.props asm_message_bus.props

   Edit the asm_message_bus.props file as in the following example:

   # Tell the probe to expect json over REST
   MessagePayload  : 'json'
   TransformerFile : ''
   TransportFile   : '$OMNIHOME/java/conf/probe_httpTransport.properties'
   TransportType   : 'HTTP'
   
   # Tell the probe how to parse the json payload, such that each member of its variable-length 
   # _status array is processed as a separate message, with top-level properties also included
   MessageHeader                    : 'json'
   MessagePayload                   : 'json._status'
   
   # standard probe properties
   MessageLog                       : '$OMNIHOME/log/asm_probe.log'
   RulesFile                        : '$OMNIHOME/probes/linux2x86/asm_message_bus.rules'

3. Use the following information to configure the probe transport file.

   Probe transport file

   Create and edit the probe transport file.

   The name of the probe transport file must match the name given in the probe properties, in this example 'probe_httpTransport.properties'

   Create a new file if necessary:

   cd $OMNIHOME
   cp java/conf/httpTransport.properties java/conf/probe_httpTransport.properties

   This file needs to specify at least the URL of the probe, where it will accept JSON status as input; for example:

   serverPort=http:18080

   This port number is required when registering the probe URL.

4. Copy the probe rules file included in the Agile Service Manager installation from the following location: $ASM_HOME/integrations/omnibus/asm_message_bus.rules to the location specified in the probe properties file RulesFile property in step 2 (in this case $OMNIHOME/probes/linux2x86/asm_message_bus.rules).
5. Start the probe using Netcool/OMNIbus procedures, as documented in the Netcool/OMNIbus probes and gateways knowledge center.
6. Register the probe URL to which status is exported using the port configured in step three. Run the script included in $ASM_HOME/bin, as in the following example:

   ./topology_service_register_probe.sh -url http://<your.hostname>:18080

   See the Probe for Message Bus reference topic for an example ASM_EVENT_SINK management artifact.
7. Deploy the Netcool/OMNIbus 'asm_resource_deletion' trigger into Netcool/OMNIbus by loading the $ASM_HOME/omnibus/integrations/asm.sql file into the Netcool/OMNIbus Object Server. For example:

   ./bin/nco_sql -U root -S ASM_AGG_P -input /opt/ibm/netcool/asm/integrations/omnibus/asm.sql

   Tip: You may receive an asm_resource_deletion error message, as in the following example, when Agile Service Manager event triggers are first created in Netcool/OMNIbus. This warning is caused by the process that first removes existing triggers before recreating them. During its first run it will not encounter any existing triggers, and so will display an error message. You can ignore this message.

   ERROR=Object not found on line 20 of statement
   '-----------------------------------------------------------------------...', at
   or near 'asm_resource_deletion'
   ERROR=Object not found on line 1 of statement 'drop table
   alerts.asm_deleted_resources;...', at or near 'asm_deleted_resources'
   (0 rows affected)
   (0 rows affected)