Installing Tivoli Netcool/OMNIbus customization files

This topic describes how to install the ITCAM for Transactions integration modifications for Tivoli® Netcool/OMNIbus.

Before you begin

Before you start this task you need:

The ITCAMTversion_Omnibus.zip or ITCAMTversion_Omnibus.tar.gz that is included in this release. These files are located on the installation media in the Integration_Tools/omnibus folder.
The Netcool/Omnibus version 7.2.1 (or later) monitored by TBSM that is installed on the host.
Tivoli EIF probe that is installed on the host.
For UNIX systems, the NCHOME environment variable needs to be set in the environment. This variable is set automatically on Windows systems.
The user running tool has permission to modify files in the ${NCHOME}\omnibus\probes\{architecture} directory.
On UNIX systems, you need to change the omnibusUpdater.sh file permissions to executable.

About this task

IBM Tivoli Composite Application Manager for Transactions includes a tool for configuring Tivoli Netcool/OMNIbus alerts. It adds custom columns to the alerts.status table for the data. All of these custom columns start with the phrase CAM_. For example, CAM_Response_Time. Furthermore, the BSM_Identity for the alert is set so that alerts will correlate with the Services loaded from the DLA.

The ITCAMTversion_Omnibus.zip and ITCAMTversion_Omnibus.tar.gz files for integration include the latest .baroc files for this release. These files are:

kt3.baroc - Application Management Console
kt5.baroc - Web Response Time
kt6.baroc - Robotic Response Time
kto.rules - Transaction Tracking

Procedure

To install the Tivoli Netcool/OMNIbus customization:

Using your installation media, navigate to the Integration_Tools/omnibus directory and extract the ITCAMTversion_Omnibus.zip or ITCAMTversion_Omnibus.tar file that is included with this release.
Source the following script prior to running OmnibusUpdater.sh:
- For TBSM 4.2:
```
/etc/Tivoli/setup_tbsmrdrtk2.sh
```
- For TBSM 4.2.1 or later:
```
/$TBSM_HOME/XMLtoolkit/etc/Tivoli/setup_tbsmrdrtk2.sh
```
From the directory where you extracted the ITCAMTversion_Omnibus.zip or ITCAMTversion_Omnibus.tar file, run the following commands:
- To configure Tivoli Business Service Manager with a rules file, omnibusUpdater.cmd -l rules_file [-s Object Server]
- To configure Tivoli Business Service Manager with a baroc file on Windows systems, omnibusUpdater.cmd -b baroc_file_1 baroc_file_2 -u root [-s Object Server]
- To configure Tivoli Business Service Manager with a baroc file on UNIX systems, omnibusUpdater.sh -b baroc_file_1 baroc_file_2 -u root [-s Object Server]
Where:
- baroc_file_1 baroc_file_2 and rules_file are the file names for the customization files you want to install. The file names are delimited with a space. For example, to include all four ktn.baroc files in the command, specify them as kt3.baroc kt4.baroc kt5.baroc kt6.baroc.
- root is the default user for the Tivoli Netcool/OMNIbus ObjectServer. This root user is not the same as the system root user on UNIX systems.
- The script defaults to a server name of NCOMS. If the object server is named something other than NCOMS, you need to add the -s <Object Server> option to the command to specify the name of the object server, otherwise the update fails. For example, if the object server name is NCOMS_LDM, you must include -s NCOMS_LDM in the command line for the OmnibusUpdater script to run successfully.
Restart the Netcool/OMNIbus ObjectServer and the Probe service as described here: Starting and stopping TBSM components or services

Example

In this example the kt5.baroc and kt6.baroc files are processed for integration with Tivoli Netcool/OMNIbus:

C:\omni>omnibusUpdater.cmd -b kt5.baroc kt6.baroc -u root

Backing up C:\IBM\tivoli\netcool\omnibus\probes\win32\tivoli_eif.rules to
C:\IBM\tivoli\netcool\omnibus\probes\win32\tivoli_eif.rules.backup

Generating custom_mapping.rules file...
- Copied new custom_mapping.rules file to 
 C:\IBM\tivoli\netcool\omnibus\probes\win32
- Successfully updated the 
 C:\IBM\tivoli\netcool\omnibus\probes\win32\tivoli_eif.rules
 file to include the custom_mapping.rules file.

Generating object server SQL file...
- Generating object server update file...

Object Server database needs to be restarted so custom changes will take effect.

Processing Baroc file kt6.baroc...
- Generating kt6.rules file...
- Copied new kt6.rules file to C:\IBM\tivoli\netcool\omnibus\probes\win32
- Successfully updated the 
 C:\IBM\tivoli\netcool\omnibus\probes\win32\tivoli_eif.rules
 file to include the kt6.rules file.

The probe associated with the tivoli_eif.rules file must be restarted if it 
was modified so changes will take effect.

Updating object server database...

Modifications were attempted on the object server database.  Check update.output
to verify output

This command creates the custom_mapping.rules file, because this is the first time the tool is run.

For each of the baroc files (kt3.baroc, kt5.baroc, and kt6.baroc), the command also generates a corresponding ktn.rules file, and copies it to one of the following directories, depending on your operating system platform:

For Windows: C:\IBM\Tivoli\netcool\omnibus\probes\win32
For Linux: /opt/IBM/tivoli/netcool/omnibus/probes/linux2x86
For UNIX: /opt/IBM/tivoli/netcool/omnibus/probes/<platform>

This command also modifies the tivoli_eif.rules file in that directory to include the appropriate ktn.rules files. In addition, because this is the first time the tool is run, it generates an SQL file that it uses to update the ObjectServer database.

To verify the update, check the update.output file to make sure there were no errors during the update. For example, you might see one or more (as many as 10 lines) messages in the update.output file similar to the following example: (0 rows affected). This line means that the database commands to update the object server database were successful.

Be sure to restart the Object Server Database and NCO EIF Probe services.

What to do next

Continue with Installing Tivoli Business Service Manager customization files.