Properties and command line options

You use properties to define the operational environment of the gateway. You can override the default property values by editing the properties file or using the property's command line options.

The following tables describe the main properties required to configure the Java Gateway for JDBC 2. For information about additional generic Tivoli Netcool/OMNIbus gateway properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

The following sections describe the properties used to configure the gateway:

Common Tivoli Netcool/OMNIbus properties

The Common Tivoli Netcool/OMNIbus lists the available common properties.

Table 1. Common Tivoli Netcool/OMNIbus properties
Property name	Command line option	Description
ConfigKeyFile `string`	-configkeyfile `string`	Use this property to specify the encryption key used with the encrypted data. Use this property in conjunction with the ConfigCryptoAlg property and the nco_aes_crypt utility supplied with Tivoli Netcool/OMNIbus. The default is "".
MaxLogFileSize `integer`	-maxlogfilesize `integer`	Use this property to specify the size (in bytes) that the gateway allocates for the log file. When the log file reaches this size, the gateway renames the log file by appending the suffix `.old` and creates a new log file. The default is 0.
MessageLevel `string`	-messagelevel `string`	Use this property to specify the reporting level of the log file messages. The default is warn.
MessageLog `string`	-messagelog `string`	Use this property to specify the location of the message log file. The default is '$OMNIHOME/log/G_JDBC2.log'.
Name `string`	-name `string`	Use this property to specify the name of the current gateway instance. If you want to run multiple gateways on one machine, you must use a different name for each instance. The default is 'G_JDBC2'.
PropsFile `string`	-propsfile `string`	Use this property to specify the location of the gateway properties file. The default is $OMNIHOME/etc/G_JDBC2.props.
Gate.Type `string`	N/A	This property defines the gateway type which is `jdbc2`. This property should not be altered.

JDBC Gateway properties

Table 2 lists the available JDBC gateway properties.

Table 2. JDBC Gateway properties
Property name	Command line option	Description
Gate.Jdbc.ActionCodeField `string`	-jdbcactioncodefield `string`	Use this property to specify the column name for action code information when the gateway is in audit mode. The default is ACTIONCODE.
Gate.Jdbc.ActionTimeField `string`	-jdbcactiontimefield `string`	Use this property to specify the column name for the action time information when the gateway is in audit mode. The default is ACTIONTIME.
Gate.Jdbc.Connections `integer`	-jdbcconnections `integer`	Use this property to specify the number of connections to the target database. The default is 3.
Gate.Jdbc.DeletedAtField `string`	-jdbcdeleteatfield `string`	Use this property to specify the field in the target table that is used to record the time of deletion of an alert. This property is only required when running the gateway in reporting mode. The default is DELETEDAT.
Gate.Jdbc.Details TableName `string`	-jdbcdetailstablename `string`	Use this property to specify the name of the target database table for storing data from the `alerts.details` ObjectServer table. The default is REPORTER_DETAILS.
Gate.Jdbc.Driver `string`	-jdbcdriver `string`	Use this property to specify the JDBC driver. The default is "".
Gate.Jdbc.DriverPasswordPropertyName `string`	-jdbcdriverpasswordpropname `string`	Use this property to specify the driver property key to the value configured in the Gate.Jdbc.Password property for the JDBC connection. If no value is specified for this property, the gateway will use the default value. The default is password.
Gate.Jdbc.DriverUserPropertyName `string`	-jdbcdriveruserpropname `string`	Use this property to specify the driver property key to the value configured in the Gate.Jdbc.Username property for the JDBC connection. If no value is specified for this property, the gateway will use the default value. The default is user.
Gate.Jdbc.DupIgnore `string`	-jdbcdupignore `string`	Use this property to specify what fields to ignore when de-duplicating alert updates. This property can take multiple values, each separated by a space. The default is LastModified StateChange.
Gate.Jdbc.FatalErrors `string`	-jdbcfatalerrors `string`	Use this property to specify which `SQLSTATE` prefixes are considered fatal when processing a batch of alerts. This property can take multiple values, each separated by a space. The default is 0A 42.
Gate.Jdbc.Initialization String `string`	-jdbcinitializationstring `string`	Use this property to specify an SQL initialization string to execute on connection to the target database. The default is "".
Gate.Jdbc.InitializationTimeout `integer`	-initializationtimeout `integer`	Use this property to configure the timeout (in seconds) for the Gate.Jdbc.InitializationString operation. The default is 10.
Gate.Jdbc.InitializeAllSessions `string`	-jdbcinitallsessions (This is equivalent to Gate.Jdbc.InitializeAllSessions with a value of true.) -jdbcinitonesession (This is equivalent to Gate.Jdbc.InitializeAllSessions with a value of false.)	Use this property to configure the scope of Gate.Jdbc.InitializationString operation in all sessions or just one session. The initialization that the amend table schema should be executed in one session, because duplicating action of such is a violation in most databases, the SQL exception will trigger the gateway to exit. The default is true.
Gate.Jdbc.JavaSystemPropsFile `string`	-jdbcjavasystempropsfile `string`	Use this property to specify the file containing the Java system properties used in JDBC connection. The default is "". Notes: Do not use this file to hold Java System properties that are meant to be immediately applied when the JVM starts up. Use instead the Gate.Java.Arguments property. Do not configure the same property in the Gate.Java.Arguments property and as the Java system properties file name, otherwise the value in the file will supersede it. See Supporting configuration files.
Gate.Jdbc.JdbcPropsFile `string`	jdbcjdbcpropsfile `string`	Use this property to specify the file containing driver properties for the JDBC connection. See Supporting Configuration Files. The default is "".
Gate.Jdbc.Journal TableName `string`	-jdbcjournaltablename `string`	Use this property to specify the name of the target database table for storing data from the `alerts.journal` ObjectServer table. The default is REPORTER_JOURNAL.
Gate.Jdbc.MaxBatchSize `integer`	-jdbcmaxbatchsize `integer`	Use this property to specify the maximum number of rows to process in a batch. The default is 250.
Gate.Jdbc.Mode `string`	-jdbcmode `string` -jdbcaudit (This is equivalent to Gate.Jdbc.Mode with a value of AUDIT.) -jdbcreporter (This is equivalent to Gate.Jdbc.Mode with a value of REPORTING.)	Use this property to specify the mode of operation of the gateway. This property takes the following values: AUDIT: The gateway runs in audit mode. REPORTING: The gateway runs in reporting mode. The default is REPORTING.
Gate.Jdbc.Partitioning Field `string`	-jdbcpartitioningfield `string`	Use this property to specify the field to use for partitioning. The default is "".
Gate.Jdbc.Password `string`	-jdbcpassword `string`	Use this property to specify the password for the target database. The default is "". Note: If you want to encrypt this password, use the nco_aes_crypt utility supplied with Tivoli Netcool/OMNIbus. For more information, see FIPS mode and encryption.
Gate.Jdbc.PreconnectionWait `integer`	-jdbcpreconnectionwait `integer`	Use this property to configure the wait interval (in milliseconds) for consecutive JDBC connection attempt to avoid spurious login issue caused by resource contention in the target’s authentication service. The default is 1000.
Gate.Jdbc.Reconnect Timeout `integer`	-jdbcreconnecttimeout `integer`	Use this property to specify the time (in seconds) that the gateway waits before attempting to reconnect to the target database after losing the connection. The default is 30.
Gate.Jdbc.ResyncFilter `string`	-jdbcresyncfilter `string`	Use this property to specify a filter for restricting open events in the target database when the gateway is operating in bidirectional resynchronization mode. The default is "".
Gate.Jdbc.ResyncMode `string`	-jdbcresyncmode `string` -jdbcresyncnone (This is equivalent to Gate.Jdbc.ResyncMode with a value of NONE.) -jdbcresyncuni (This is equivalent to Gate.Jdbc.ResyncMode with a value of UNI.) -jdbcresyncbi (This is equivalent to Gate.Jdbc.ResyncMode with a value of BI.) -jdbcresyncauto (This is equivalent to Gate.Jdbc.ResyncMode with a value of AUTO.)	Use this property to specify a resynchronization mode for the gateway. This property takes the following values: NONE: The gateway does not perform resynchronization. UNI: The gateway operates in unidirectional resynchronization mode. BI: The gateway operates in bidirectional resynchronization mode. AUTO: The gateway operates in unidirectional resynchronization mode by default. If its alert cache is empty on startup, which normally only occurs the first time it is run, the gateway operates in bidirectional resynchronization mode. The default is AUTO.
Gate.Jdbc.RetryErrors `string`	-jdbcretryerrors `string`	Use this property to specify which `SQLSTATE` prefixes will cause the current batch of alerts to be retried. This property can take multiple values, each separated by a space. The default is 08 28 40 HYT.
Gate.Jdbc.SerialField `string`	-jdbcserialfield `string`	Use this property to specify the serial field in the target database when the gateway is running in audit mode. The value that will populate the target database comes from the `ServerSerial` field. This is for delete records when the serial field is set to `NOT NULL`. The default gateway behaviour is that `SERIAL` is allowed to be `NULL` and this property does not need to be specified. The default is "".
Gate.Jdbc.Server NameField `string`	-jdbcservernamefield `string`	Use this property to specify the field in the target table that contains the server name. The default is SERVERNAME.
Gate.Jdbc.Server SerialField `string`	-jdbcserverserialname `string`	Use this property to specify the field in the target table that contains the server serial. The default is SERVERSERIAL.
Gate.Jdbc.SqlTimeout `integer`	-sqltimeout `integer`	Use this property to configure the timeout (in seconds) for SQL operations. The default is 600. Note: 600 seconds is used for backward compatibility as the legacy implementation was using the same hardcoded timeout value.
Gate.Jdbc.Status TableName `string`	-jdbcstatustablename `string`	Use this property to specify the name of the target database table for storing data from the `alerts.status` ObjectServer table. The default is REPORTER_STATUS.
Gate.Jdbc.SuppressDeletes `boolean`	-jdbcsuppressdeletes `boolean`	Use this property to suppress deleted events from the ObjectServer. The following values are valid: TRUE : The gateway suppresses deleted events. FALSE : The gateway does not suppress deleted events. The default is FALSE.
Gate.Jdbc.TestCount `integer`	-jdbctestcount `integer` -jdbcnotest	Use this property to specify the number of internal events the gateway generates to test the JDBC connection. This property specifies the number of test alerts to create, update, journal then delete, populating the target database in the process. The default is 0. You can use the -jdbcnotest command line option to set the Gate.Jdbc.TestCount value to 0. This turns off test alerts. Note: The simulated alerts use the server name `JDBC_TEST`.
Gate.Jdbc.Url `string`	-jdbcurl `string`	Use this property to specify the URL of the target database. The default is "".
Gate.Jdbc.Username `string`	-jdbcusername `string`	Use this property to specify the user name for the target database. The default is "". Note: For more information about configuring this property see the following configuration section:Configuring the database connection.
Gate.Jdbc.UnknownErrors `string`	-jdbcunknownerrors `string`	Use this property to specify how the gateway handles unknown SQL errors. This property takes the following values: ABORT: The gateway aborts the operation. IGNORE: The gateway ignores the error message. RECONNECT: The gateway attempts to reconnect to the target database. RETRY: The gateway retries the operation that caused the error message. The default is RECONNECT.

Gateway Reader-Writer properties

Table 3 lists the available gateway reader-writer properties.

Table 3. Gateway Reader-Writer properties
Property name	Command line option	Description
Gate.RdrWtr.DetailsTable Name `string`	-detailstblname `string`	Use this property to specify the name of the status table that the gateway reads. The default is alerts.details.
Gate.RdrWtr.Password `string`	-password `string`	Use this property to specify the password associated with the user specified by the Gate.RdrWtr.Username property. You must specify this password when connecting to the ObjectServer in secure mode. The default is "". Note: When connecting to the ObjectServer in secure mode the password may be in plain text, but if you want to encrypt this password, use the nco_aes_crypt utility supplied with Tivoli Netcool/OMNIbus. For more information, see FIPS mode and encryption.
Gate.RdrWtr.Server `string`	-rdrwtrserver `string`	Use this property to specify the name of the ObjectServer from which the gateway reads alerts The default is NCOMS.
Gate.RdrWtr.Username `string`	-username `string`	Use this property to specify the user name used to authenticate the ObjectServer connection. This property is used with the Gate.RdrWtr.Password property. The default is root. Note: When connecting to the ObjectServer in secure mode you must specify this property.