Document control page

Table 1. Document modification history
Document version Publication date Comments

SC14-7650-00

February 25, 2011

 First IBM publication.

SC14-7650-01

December 2, 2011
The following properties were updated in Properties and command line options :
  • Gate.Reader.DetailsTableName
  • Gate.Mapper.ForwardHistoricDetails
  • Gate.Mapper.ForwardHistoricJournals
  • Gate.Reader.JournalTableName

Table replication definition file updated.

SC14-7650-02

April 6, 2012

Installing the gateway updated.

Configuring HTTPS/SSL connections between the gateway and Message Bus updated.

SC14-7650-03

May 11, 2012

Configuring HTTPS/SSL connections between the gateway and Message Bus updated.

SC14-7650-04

November 30, 2012

Guide updated for Netcool/OMNIbus V7.4 release.

Installing the gateway updated.

SC14-7650-05

March 13, 2014

Support for SCA-LA added.

Summary updated.

Integrating with SCA-LA added.

Explanations added to the descriptions of the following properties in Properties and command line options whose default values depend on whether you are running the gateway in XML mode or SCA-LA mode:
  • Gate.MapFile
  • Gate.StartupCmdFile
  • Gate.Reader.TblReplicateDefFile
  • Gate.XMLGateway.TransformerFile
  • Gate.XMLGateway.TransportFile
  • Gate.XMLGateway.TransportType

Description of the scalaTransport.properties file added to Configuring transport module properties files.

Running the gateway updated.

SC14-7650-06

April 1, 2014

Summary updated.

Note added to the description of the Gate.Java.Arguments property in Properties and command line options

Preventing unbound reads from files or sockets being exploited in a denial of service attack added.

Description for the new readTimeout property added to the SCA-LA transport properties table in Configuring transport module properties files.

SC14-7650-07

June 12, 2014

Summary updated.

SC14-7650-08

March 12, 2015

The term SCA-LA has been replaced by IBM Operations Analytics - Log Analysis.

Gateway for Message Bus updated.

Summary updated. An additional map definition file, xml1300.map, is now listed in the "Configuration files for gateways operating with IBM Operations Analytics - Log Analysis" table entry.

64 bit support added.

Gateway dependencies updated.

Installing probes and gateways on Tivoli Netcool/OMNIbus V8.1 added.

Added instructions for installing the gateway on Tivoli Netcool/OMNIbus Version 8.1.

SC14-7650-08

March 12, 2015

Properties and command line options updated.

Updates were made to these properties: Name, PropsFile, Gate.MapFile, Gate.StartupCmdFile, Gate.Reader.Password, Gate.Reader. TblReplicateDefFile, Gate.XMLGateway. DateFormat, Gate.XMLGateway. TransformerFile, Gate.XMLGateway. TransportFile, and Gate.XMLGateway. TransportType, Gate.Java.Arguments, Gate.Java.ClassPath, Gate.Java.Debug, and Gate.Java.Library Path.

Preventing unbound reads from files or sockets being exploited in a denial of service attack updated to replace the term SCA-LA with IBM Operations Analytics - Log Analysis. Also, updates to clarify Java arguments versus gateway properties.

SC14-7650-08

March 12, 2015

Integrating with IBM Operations Analytics - Log Analysis updated to discuss the xml1300.mapdefinition file.

Added a section to Troubleshooting the IBM Operations Analytics - Log Analysis integration that discusses when it might be necessary to edit the NmosObjInst field in the xml1300.map definition file.

SC14-7650-09

December 10, 2015

Gateway for Message Bus updated.

Summary updated. An additional map definition file, xml1302.map, is now listed in the summary table.

Properties and command line options updated with the following properties added to the common properties table:

  • ConfigCryptoAlg
  • ConfigKeyFile

The availability of these properties has been extended so that in addition to being used with the gateway they can also be used in the transport module.

Integrating with IBM Operations Analytics - Log Analysis updated to discuss the xml1302.map definition file.

SC14-7650-09

December 10, 2015

Configuring HTTPS/SSL connections between the gateway and Message Bus updated.

Added Using the nc_httpcertimport utility

Added Encrypting gateway and transport module properties

Added property descriptions for the socketTransport.properties file.

You can configure the gateway to operate in one of two modes of operation: standard mode or IBM Operations Analytics - Log Analysis (LA) mode. A number of sections in the guide have been updated to account for these two modes of operation.

SC14-7650-10

May 31, 2017

Guide updated for Version 8 of the gateway.

Setting the path to the JRE libraries was updated .

Configuring transport module properties files was updated to reflect the support for encrypted passwords with the Transport Module.

The following properties were added to the HTTP/HTTPS transport to support the new functionality added to send batched events from the gateway to the object server:
  • batchHeader
  • batchFooter
  • bufferFlusher
  • bufferSize
  • httpTimeout
  • retryLimit
  • retryWait

Note added to the transport properties files to state that all property values must be unquoted.

SC14-7650-11

August 18, 2017

Configuring the SSL transport for the IBM Operations Analytics - Log Analysis updated to include information about exporting the server certificate from the SCALA server.

SC14-7650-12

April 12, 2018

Summary updated.

The following properties were added to the HTTP Transport:

  • password
  • username

Support for integrating with Kafka added.

Integrating the gateway with Kafka added.

SC14-7650-13

October 11, 2018
Kafka details in the following topics updated:

SC14-7650-14

April 19, 2019

Guide updated for Version 10 of the gateway.

Summary updated.

The following properties were added to the properties file:

  • Gate.XMLGateway.TransformerInputType
  • Gate.XMLGateway.PublishTraceOn

The following properties were added to the HTTP Transport:

  • useNullHostnameVerifier
  • batchSeparator
  • concurrentRequestThreads

The following topic added: Configuring the gateway to produce JSON data.

Version 10 addresses the following APAR and test fix mergeup:
  • IJ09147: Provides support for ON INSERT ONLY functionality in the gateway map file.
  • PATCH gateway-libngjava-7: Merge up test fixes in release 7 for GA release 8. Test fix includes improvements on string handling optimization and enhancement on exception logging.

SC14-7650-15

March 20, 2020

Guide updated for Version 11 of the gateway.

A description for Gate.XMLGateway.MessageKey was added to Gateway-specific properties.

The following topic was updated: Integrating the gateway with Kafka.

The probe makes use of the following new features in the Kafka transport:

  • Kafka producer uses the following settings if they are not configured in the client configuration:
    max.block.ms=20000
request.timeout.ms=30000
  • Kafka producer sends message with the message key assigned by the application.
  • New properties in the kafkaTransport.properties file for Kafka Liveness check.
  • Kafka producer periodically checks Kafka liveness.
  • Kafka producer halts outbound messaging as soon as the Kafka target is internally detected to be unreachable.
  • Kafka producer resends failed messages after reconnecting to the Kafka target.
  • Kafka producer reconnection is initiated by the gateway after hitting TransportSendMsgException.
  • Zookeeper watch service is disabled in the producer mode.

Known issues with the Gateway for Message Bus added.

Version 11 also addresses the following APAR:
  • IJ17528: Fixed issue whereby UTC data is not converted to the date-time format configured in Gate.XMLGateway.DateFormat. This change introduces the following new behavior: When no value is set for Gate.XMLGateway.DateFormat, all UTC data will be in millisecond units in outbound messages for JSON and XML use cases.

SC14-7650-16

February 11, 2021

Updated for version 12.

Summary Table updated.

The dependency bundle updated: gateway-libngjava-9, common-transportmodule-27

Integrating the gateway with Kafka updated.

Descriptions for the following properties added to Properties and command line options:

  • Gate.XMLGateway.ForwardKeyValuePairs
  • Gate.XMLGateway.ForwardMappedFields
  • Gate.XMLGateway.ReplaceXmlInvalidChars
  • Gate.XMLGateway.XmlInvalidCharsFormatter
  • Gate.XMLGateway.MessageKey

Version 12 addresses the following enhancement request:

RFE 136634: Send dynamic values populating from the ObjectServer field in the JMS Header (multiple fields) for JMS Gateway.

This version also addresses the following APAR:

APAR IJ27815: The XSLT process hits exception upon alert data that contains characters invalid to the XML standard.

SC14-7650-17

July 15, 2021

Updated for version 13.

Summary Table updated.

Dependency bundle updated: common-transportmodule-30.

Support for the Multi-Channel HTTP transport added.

Integrating the gateway with Microsoft Azure Event Hubs added.

Version 13 addresses the following enhancement requests:

RFE 147505: Post event data to Azure Event Hubs

RFE 145731/147287: Support for custom headers in Multi-Channel HTTP Transport

SC14-7650-18

September 30, 2021

Updated for version 14.

Summary Table updated.

Dependency bundle updated: common-transportmodule-31.

Support for the Pulsar transport added.

Integrating the gateway with Apache Pulsar added.

The following topics updated:

SC14-7650-19

December 6, 2023

Known issues with the Gateway for Message Bus updated.
Note: The IBM Tivoli Netcool/OMNIbus Gateway for Message Bus was previously documented in the IBM® Tivoli® Netcool/OMNIbus Message Bus Integration Version 6.0 reference guide (SC23-8594-00).