Summary

Each gateway works in a different way to provide an interface to the ObjectServer. Use this summary information to learn about the Gateway for Message Bus.

You can configure the gateway to operate in one of two modes of operation: standard mode or IBM Operations Analytics - Log Analysis (LA) mode. Table 1 organizes the summary information according to these two modes.
Table 1. Summary information

Summary information for gateway standard mode and LA mode operation

Gateway target

XML event consumers

Gateway executable file name

nco_g_xml

Gateway jar file

$OMNIHOME/gates/java/nco_g_xml.jar

Gateway supported on

For details of supported operating systems, see the following Release Notice on the IBM Software Support website:

https://www.ibm.com/support/pages/node/239681

Requirements

A currently supported version of Tivoli Netcool/OMNIbus

common-transformer-11

common-transportmodule-40

Note: If you have the gateway installed on Windows, do not upgrade to Transport Module 40.0. There is currently a known issue whereby the gateway cannot run on version 40.0 of the Transport Module on Windows platforms.

gateway-libngjava-9

common-sslutility-1 (This requirement applies only for UNIX operating system platforms that the gateway supports.)

Java™ Runtime Environment (JRE) 1.8

The MQTT transport requires the file: wmqtt.jar. To obtain and use this JAR file, perform the following steps:

  1. Download the JAR file from the following site:

    http://www-01.ibm.com/support/docview.wss?rs=203&uid=swg24006006

  2. Copy the JAR to the following directory:

    $OMNIHOME/java/jars

  3. Include the JAR file in probe classpath by editing either nco_p_message_bus.env for UNIX platforms, or nco_p_message_bus.bat for Windows platforms.

Examples:

On UNIX platforms, at the foot of the nco_p_message_bus.env file, include the following lines:

WMQTT_JAR=${OMNIHOME}/java/jars/wmqtt.jar
CLASSPATH=${CLASSPATH}:${WMQTT_JAR};

On Windows platforms, in the nco_p_message_bus.bat replace the following line:

set MESSAGEBUS_CLASSPATH=%TRANSFORMER_CLASSPATH%; %TRANSPORT_CLASSPATH%; %JACKSON_CLASSPATH%

with the following lines:

set WMQTT_CLASSPATH=%JARS_DIR%/wmqtt.jar

set MESSAGEBUS_CLASSPATH=%TRANSFORMER_CLASSPATH%; %TRANSPORT_CLASSPATH%; %JACKSON_CLASSPATH%; %JETTY_CLASSPATH%; %WMQTT_CLASSPATH%

Windows configuration considerations

The libngjava_r.1.dll library is located in C:\IBM\Tivoli\Netcool\omnibus\platform\win32\lib

IBM Java path variable should be set to C:\IBM\Tivoli\Netcool\platform\win32\jre_1.8.0\jre

Within the configuration files and property files supplied with the gateway, you must manually change the environment variables names from $OMNIHOME to %OMNIHOME%

Multicultural support

Available

IP environment

IPv4 and IPv6

Current version of the gateway for standard mode operation

 

14.0 (patch name: gateway-nco-g-xml-14)

Current version of the gateway for LA mode operation

 

9.0 (patch name: gateway-nco-g-xml-9)

Note: Package version 7.0 is the minimum version for running the gateway with OMNIbus Insight Pack Version 1.3.0.2 and Network Manager Insight Pack Version 1.3.0.0 deployed against IBM Operations Analytics - Log Analysis.

Configuration files for the gateway standard mode operation

 

Map definition file:

$OMNIHOME/gates/xml/xml.map

Properties file:

$OMNIHOME/gates/xml/G_XML.props

Table replication definition file:

$OMNIHOME/gates/xml/xml.reader.tblrep.def

Environment (.env) file for Unix:

On Netcool/OMNIbus 8.1

$OMNIHOME/platform/<arch>/bin64/nco_g_xml.env

Startup command file

$OMNIHOME/gates/xml/xml.startup.cmd

Transport module configuration files for the gateway standard mode operation

 

The following list identifies the transport properties files related to the different transport modules. Thus, you would use the jmsTransport.properties file if your transport module is JMS, the mqttTransport.properties file if your transport module is MQTT, and so forth.

Note: All configuration files are in the following location:

$OMNIHOME/java/conf/

JMS - jmsTransport.properties

Data file - fileTransport.properties

MQTT - mqttTransport.properties

Multi-Channel HTTP - multiChannelHttpTransport.properties

HTTP and HTTPS - httpTransport.properties

Socket - socketTransport.properties

Kafka - kafkaTransport.properties, kafkaClient.properties, and kafkaConnectionProperties.json

Pulsar - pulsarTransport.properties, pulsarClient.properties, pulsarConsumer.properties, pulsarProducer.properties, and pulsarConnectionProperties.json

Note: The gateway supports Java Message Service (JMS) API 1.1 and target applications that use later versions provided they maintain backward compatibility as currently expected by the JMS specification.

Transformer module Extensible Markup Language (XML) configuration files for the gateway standard mode operation

 

$OMNIHOME/java/conf/transformers.xml

Transformer module Extensible Stylesheet Language Transformations (XSLT) configuration files for the gateway standard mode operation

 
  • $OMNIHOME/java/conf/cbe2nvpairs.xsl
  • $OMNIHOME/java/conf/netcool2cbe.xsl
  • $OMNIHOME/java/conf/netcool2nvpairs.xsl
  • $OMNIHOME/java/conf/netcool2wef.xsl
  • $OMNIHOME/java/conf/netcool2json.xsl
  • $OMNIHOME/java/conf/wbe2nvpairs.xsl
  • wbepl2nvpairs.xsl
  • wbm2nvpairs.xsl
  • $OMNIHOME/java/conf/wef2nvpairs.xsl

Configuration files for the gateway LA mode operation

 

Properties file:

$OMNIHOME/gates/xml/scala/G_SCALA.props

Table replication definition file:

$OMNIHOME/gates/xml/scala/xml.reader.tblrep.def

Environment (.env) file:

$OMNIHOME/platform/linux2x86/bin/nco_g_xml.env

$OMNIHOME/platform/linux2x86/bin64/nco_g_xml.env

Startup command file:

$OMNIHOME/gates/xml/scala/xml.startup.cmd

 

Map definition files:

$OMNIHOME/gates/xml/xml.map

Use the xml.map file if your gateway is running with Network Manager Insight Pack Version 1.3.0 and higher deployed against IBM Operations Analytics - Log Analysis.

$OMNIHOME/gates/xml/scala/xml1300.map

Use the xml1300.map file if your gateway is running with OMNIbus Insight Pack Version 1.3.0.0 and Version 1.3.0.1 and higher and Network Manager Insight Pack Version 1.3.0.0 and higher deployed against IBM Operations Analytics - Log Analysis.

$OMNIHOME/gates/xml/scala/xml1302.map

Use the xml1302.map file if your gateway is running with OMNIbus Insight Pack Version 1.3.0.2 and higher and Network Manager Insight Pack Version 1.3.0.0 and higher deployed against IBM Operations Analytics - Log Analysis.

Transport module properties file for the gateway LA mode operation

 

$OMNIHOME/gates/xml/scala/scalaTransport.properties

Transformer module XML configuration file for the gateway LA mode operation

 

$OMNIHOME/gates/xml/scala/scalaTransformers.xml

Transformer module XSLT configuration file for the gateway LA mode operation

 

$OMNIHOME/java/conf/netcool2scala.xsl

SSL configuration utility for the gateway LA mode operation

 

nc_httpcertimport

Note: The nc_httpcertimport utility is supported on all UNIX operating system platforms that the gateway supports. The nc_httpcertimport utility is not supported on Windows operating systems.