Properties and command line options

The following tables describe the properties and command line options that are applicable to the Java Gateway for ServiceNow. They cover the properties specific to the gateway and those provided by the gateway's operational environment. Specifically, the tables provide these categories of properties: properties specific to the Java Gateway for ServiceNow, gateway framework properties, and generic Tivoli Netcool/OMNIbus properties.

Table 1 lists and describes the properties specific to the Java Gateway for ServiceNow that are defined in the G_SERVICENOW.props properties file. The default values in Table 1 are the default values as specified in the G_SERVICENOW.props properties file.

See Gateway operation for more details on the properties specific to the Java Gateway for ServiceNow properties. The details include how the properties specific to the Java Gateway for ServiceNow relate to each other, depending on the values specified.

The descriptions that follow make use of the following terms:

Outbound -- Specifies the data flow sent from the gateway to the ServiceNow instance database.
Inbound -- Specifies the data flow received by the gateway from the ServiceNow instance database.

Table 1. Gateway specific properties
Property name	Command Line option	Description
Gate.ServiceNow.AlternateIndexField `string`	-`servicenowalternateindexfield` `string`	Use this property to specify the name of a column in the ServiceNow target table that can be used as an alternate index. This column name implies that the values in the ServiceNow instance database are unique within the scope of records that the gateway queries. Note that the Gate.ServiceNow.QueryPolicy property controls how the gateway queries the ServiceNow instance database by using a scoping clause. The name of the ServiceNow target table is specified in the Gate.ServiceNow.TableName property. The default column name in the ServiceNow target table is `correlation_id`.
Gate.ServiceNow.AlternateIndexPolicy `string`	-`servicenowalternateindexpolicy` `string`	Use this property to specify how the gateway sets the alternate index field. The property takes one of the following values: internal: Instructs the gateway to internally set the alternate index for the ServiceNow target table to the name of the originating ObjectServer and the serial number of the alert on the originating ObjectServer. Specifying internal causes the gateway to generate a value that can be used for the column specified in the Gate.ServiceNow.AlternateIndexField property. custom: Indicates that the value of the Gate.ServiceNow.AlternateIndexPolicy property should be set in the `StatusMap` (defined in the servicenow.map map definition file). You must ensure a unique value for each ticket in the Gate.ServiceNow.AlternateIndexField. Specifying custom means that the user takes responsibility for ensuring that the value used within the Gate.ServiceNow.AlternateIndexField property is unique for each ticket, by specifying the alternate index field in the servicenow.map definition file as described above. The default operational behavior for the way the gateway sets the alternate index field value is specified by the value `internal`.
Gate.ServiceNow.AuthenticationType `string`	`-servicenowauthenticationtype` `string`	Use this property to specify the type of authentication to use with ServiceNow. Valid values are: `Basic` `OAuth2` The default is `Basic`. If you set this property to `OAuth2` use the Gate.ServiceNow.ClientId and Gate.ServiceNow.ClientSecret properties to specify the values auto-generated by the ServiceNow instance. See Authentication.
Gate.ServiceNow.ClientId `string`	`-servicenownclientid` `string`	If you set the Gate.ServiceNow.AuthenticationType property to `OAuth2`, specify the Client ID auto-generated by the ServiceNow instance. The default is `""`
Gate.ServiceNow.ClientSecret `string`	`-servicenownclientsecret` `string`	If you set the Gate.ServiceNow.AuthenticationType property to `OAuth2`, specify the Client Secret auto-generated by the ServiceNow instance. The default is `""`
Gate.ServiceNow.Connections `integer`	`-servicenowconnections` `integer`	Use this property to set the number of simultaneous connections the gateway makes with ServiceNow. The default value is `3`.
Gateway.ServiceNow. CreationErrorCode `string`	-`servicenowcreationerrorcode` `string`	Use this property to mark any alert subjected to ticket creation that receives a positive reply from the ServiceNow gateway but does not complete the final state of receiving or updating targetID to the alert. The default is 'CREATION-FAILURE'.
Gate.ServiceNow.DateAndTimeFormat `string`	-`servicenowdateformat` `string`	Use this property to specify the format for the outbound date and time data so that it is compatible with the format specified for the associated ServiceNow system properties. The default value is `yyyy-MM-dd HH:mm:ss`. See Controlling how the gateway handles outbound data management for additional information about this property and its relationship to ServiceNow system properties.
Gate.ServiceNow.DropFirstNotification `boolean`	-`servicenowdropfirstnotification` `boolean`	Use this property to specify whether the gateway should process the first notification it receives following the creation of a ticket by the ServiceNow instance. The property takes one of the following values: `true`: The gateway should not process the first notification that it receives following the creation of a ticket by the ServiceNow instance. `false`: The gateway should process the first notification that it receives following the creation of a ticket by the ServiceNow instance. The default value is `true`.
Gate.ServiceNow.ErrorCodeColumn `string`	-`servicenowerrorcodecolumn` `string`	Use this property to specify the name of the column in an ObjectServer table to be used for storing gateway error codes. The default name of the column is `ServiceNowErrorCode`.
Gate.ServiceNow.Host `string`	-`servicenowhost` `string`	Use this property to specify the name (or IP address) of the host server on which the ServiceNow instance is running. You must configure this property in order for the gateway to operate. The gateway uses the host server name (or IP address) specified in this property to form the URLs used to communicate with the ServiceNow instance. The default value is `""`.
Gate.ServiceNow.ModifCounterField `string`	-`servicenowmodifcounterfield` `string`	Use this property to specify the name of the field in the ServiceNow ticket that holds the counter of modifications associated with the ticket. The default field name is `sys_mod_count`.
Gate.ServiceNow.OutboundManagedTypes `string`	-`servicenowoutboundmanagedtypes` `string`	Use this property to specify which types of data the gateway should use as part of its outbound data management operations. For example, `type1;type2;type3`. Note: This property is active only if you specify the value `custom` for the Gate.ServiceNow.OutboundManagement property. The default value is `""`.
Gate.ServiceNow.OutboundManagement `string`	-`servicenowoutboundmanagement` `string`	Use this property to specify how the gateway manages outbound data. The property takes one of the following values: `default`: The gateway performs the default outbound data management behavior. Currently, this behavior is limited to field width checking for specified types. When this property is set to `default`, the following are the built in types for which field width checking is performed: `integer` `string` `journal` `journal_input` `journal_list` `disable`: Switches off all outbound data management. `custom`: The gateway performs the custom outbound data management behavior. Currently, this is limited to field width checking for the types specified by the Gate.ServiceNow.OutboundManagedTypes property. The default value is `default`.
Gate.ServiceNow.NoRetryCodes `string`	-`servicenownoretrycodes` `string`	Use this property to configure the gateway to not retry `REST` queries against ServiceNow after receiving specific HTTP response codes returned from queries. The response codes indicate that specific errors have occurred and by not retrying the gateway may save time and resource to process remaining records. These errors should be addressed and resolve accordingly. The default value is `403,404,429,401`. To completely disable this functionality, uncomment the property and specify `''` (two single quotes).
Gate.ServiceNow.Password `string`	-`servicenowpassword` `string`	Use this property to specify the password for the service account that the gateway uses to access the ServiceNow instance. This service account must be created in ServiceNow and consist of a username and password. Use this property in conjunction with the Gate.ServiceNow.Username property. The default value is `""`. See Authenticating the gateway with ServiceNow for additional information about this property and its relationship to defining suitable ServiceNow user roles.
Gate.ServiceNow. PollingAdjustment `integer`	-`pollingadjustment` `integer`	Use this property to specify the adjustment (in seconds) that the gateway makes to allow for a difference in the time kept by the gateway clock and the ServiceNow clock. When Gate.ServiceNow. PollingAdjustment is less then zero, and Gate.ServiceNow. UpdateQueryStartTime is greater than zero, the magnitude (the absolute value) of Gate.ServiceNow. PollingAdjustment must be less than or equal to Gate.ServiceNow. UpdateQueryStartTime in order to prevent miscalculation that places upper bound of query window behind lower bound. If the condition is not complied, then gateway will throw exception and exit. Note: For details about configuring this property, see Configuring the PollingAdjustment property.
Gate.ServiceNow.PollingInterval `integer`	-`servicenowpollinginterval` `integer`	Use this property to specify how often (in seconds) the gateway should query the ServiceNow instance to check for updates to tickets. The default query interval is `17` seconds.
Gate.ServiceNow.PreCreateChecks `string`	-`servicenowprecreatechecks` `string`	Use this property to specify how the gateway should perform checks before creating a new ticket in the ServiceNow target table. The property takes one of the following values: `default`: The gateway performs, where possible, default pre-create record check operations. Currently, the default behavior centers around checking the integrity of the Gate.ServiceNow.AlternateIndexField property and any associated value presented as part of a create record request. Note: If the Gate.ServiceNow.AlternateIndexField property is an empty string, then it effectively disables any pre-create record check operations associated with that property. The gateway supplies a warning message associated with this condition during gateway start up. `disable`: Disables any pre-create check. In other words, the gateway is prevented from performing any pre-create check operations. The default checking behavior value is `default`.
Gate.ServiceNow.Proxy `string`	-`servicenowproxy` `string`	Use this property to connect the gateway to the ServiceNow instance by an HTTP proxy server. There are four ways to configure the property: Gate.ServiceNow.Proxy : 'hostname' # Hostname only, port will be 80 Gate.ServiceNow.Proxy : 'hostname:port' # Hostname and port specification Gate.ServiceNow.Proxy : 'user:password@hostname' # Hostname and authentication specification, port will be 80. Gate.ServiceNow.Proxy : 'user:password@hostname: port' # Hostname, authentication and port specification. Where `hostname` refers to the proxy hostname, `user` is the proxy username, and `password` is the proxy password.
Gate.ServiceNow.QueryPolicy `string`	-`servicenowquerypolicy` `string`	Use this property to control how the gateway must query the ServiceNow instance database. Specifically, the gateway performs all queries on the ServiceNow instance database using a scoping clause that includes the following: `sys_create_by=sngw_user` Where `sys_create_by` is a ServiceNow instance database field. `sngw_user` is the value specified in the Gate.ServiceNow.Username property. Thus, the only tickets in the ServiceNow instance database that are of interest to the gateway are those tickets that the gateway itself creates. The default query policy value is `Account`. Note: Currently, this property supports only a query policy with the value `Account`.
Gateway.ServiceNow. ReclaimIncident `integer`	-`servicenowreclaimincident` `integer`	Use this property to control the ticket reclaim process for outbound processing. Set the Gate.ServiceNow. ReclaimIncident property to 0 to disable. Set to the Gate.ServiceNow. ReclaimIncident property to 1 to conditionally enable if the ticket is marked with CreationErrorCode. Set to the Gate.ServiceNow. ReclaimIncident property to 2 to always enable. The default is 0.
Gate.ServiceNow.RetryLimit `integer`	-`servicenowretrylimit` `integer`	Use this property to specify the maximum number of retries the gateway should make on an operation (for example, forwarding an event to the ServiceNow instance) that failed. The minimum value that can be set for this property is 1. The default value of `3` means the gateway will make up to three attempts for a failed operation.
Gate.ServiceNow.RetryWait `integer`	-`servicenowretrywait` `integer`	Use this property to specify the number of seconds the gateway should wait before retrying an operation (for example, forwarding an event to the ServiceNow instance) that failed. The default value is `7` seconds.
Gate.ServiceNow.SysIdField `string`	-`servicenowsysidfield` `string`	Use this property to specify the name for the ServiceNow target table column that holds the globally unique identifier (GUID) for each ServiceNow ticket. The values for the GUID column are crucial to the operation of the gateway as they are often used to form the URLs which the gateway uses to communicate with the ServiceNow instance. The default value for the GUID column name is `sys_id`.
Gate.ServiceNow.TableName `string`	-`servicenowtablename` `string`	Use this property to specify the name of the ServiceNow target table. The gateway uses this target database table to create tickets and to retrieve data about these tickets. The default name for the ServiceNow target table is `incident`.
Gate.ServiceNow.TicketIdField `string`	-`servicenowticketidfield` `string`	Use this property to instruct the gateway to use the specified column (which must be a unique ticket identifier) in the ServiceNow target table as the internal ticket identifier. The default column name is `sys_id`.
Gate.ServiceNow.UpdateFields `string`	-`servicenowupdatefields` `string`	In addition to the six automatically included columns, use this property to specify which columns to retrieve record field information from the ServiceNow target table when polling for updates. The following list identifies these six other columns: `sys_created_by` `sys_created_on` `sys_updated_on` `sys_id` `sys_updated_by` `sys_mod_count` The default value for this property specifies two columns: `state;number`. Note: If you define the name of a column in the ServiceNow target table that can be used as an alternate index (the Gate.ServiceNow.AlternateIndexField property), that column is also automatically included as a retrieval column.
Gate.ServiceNow.UpdateQueryStartTime `integer`	-`servicenowupdatequerystarttime` `integer`	The range of Gate.ServiceNow. UpdateQueryStartTime is 0 to 10,000 minutes.
Gate.ServiceNow.Username `string`	-`servicenowusername` `string`	Use this property to specify the username for the user account that the gateway uses to access the ServiceNow instance. This user account must be created in ServiceNow and consist of a username and password. Use this property in conjunction with the Gate.ServiceNow.Password property. The default value is `""`. See Authenticating the gateway with ServiceNow for additional information about this property and its relationship to defining suitable ServiceNow user roles.

Table 2 lists and describes the properties provided by the gateway framework.

Table 2. Gateway framework properties
Property name	Command Line option	Description
Gate.Cache.NotificationMap `string`	-`cachenotificationmap` `string`	Use this property to specify the JavaScript file to use for alert notifications. The default value is $OMNIHOME/gates/servicenow/ servicenow.notification.js.
Gate.Cache.GenericScript `string`	`-cachegenericscript` `string`	Use this property to specify the JavaScript file to use for alert modifications. The default value is `$OMNIHOME/gates/servicenow/servicenow.generic.js`
Gate.Cache.ResyncMode `string`	-`cacheresyncmode` `string`	Use this property to specify a resynchronization mode for the gateway. This property takes the following value: `UNI`: The gateway performs a resynchronize operation from Tivoli Netcool/OMNIbus to ServiceNow. The default value is `UNI`. The gateway does not currently support the values `BI` and `AUTO`.
Gate.Cache. ResyncSuppressDeletes`string`	-`cacheresyncsuppressdeletes` `string`	Use this property to suppress all resynchronization deletes. This property takes the following values: `TRUE`: Suppresses all resynchronization deletes. `FALSE`: Does not suppress all resynchronization deletes. The default value is `FALSE`.
Gate.Cache.ResyncSuppressInitialDeletes `string`	-`cacheresyncsuppressinitialdeletes` `string`	Use this property to suppress initial (gateway startup) resynchronization deletes. This property takes the following values: `TRUE`: Suppresses initial (gateway startup) resynchronization deletes. `FALSE`: Does not suppress initial (gateway startup) resynchronization deletes. The default value is `FALSE`.
Gate.ConversionsDirection `string`	-`conversionsdirection` `string`	Use this property to specify how the gateway converts field values. This property takes the following values: `BOTH`: The gateway converts in both forward and reverse directions. Conversions generally convert integer ObjectServer values to and from target specific string values, typically converting Severity ("Clear", "Indeterminate", "Warning", "Minor", "Major", "Critical") from its integer representation to a string. `FORWARD`: The gateway only converts from OMNIbus integers to target string. `REVERSE`: The gateway only converts from target strings to OMNIbus integers. The default value is `REVERSE`. Note: The gateway does not supply a conversion table. However, you can create a conversion table to make use of this property.
Gate.HistoricResync `boolean`	-`historicresync` `boolean`	Use this property to configure how the gateway handles historic journal entries for an ObjectServer alert. The property takes one of the following values: true: Instructs the gateway to transfer existing journal entries when creating a ticket in ServiceNow. false: Instructs the gateway to not transfer existing journal entries when creating a ticket in ServiceNow. The default value is `true`.
Gate.MapFile `string`	-`mapfile` `string`	Use this property to specify the map definition file for the gateway to use. The default value is $OMNIHOME/gates/servicenow/ servicenow.map.
Gate.PackageBase `string`	-`packagebase` `string`	Use this property to specify the Java gateway package. The default value is com.ibm.tivoli.netcool. integrations.gateway. Note: This is an internal property and its value should not be changed.
Gate.RdrWtr.DetailsTableName `string`	-`detailstablename` `string`	The gateway does not currently support this property.
Gate.RdrWtr.IducFlushRate `integer`	-`iducflushrate` `integer`	Use this property to specify the rate (in seconds) of the granularity of the gateway's reader. If you set this property to 0 (zero), the reader gets its updates at the same granular rate as that of the ObjectServer to which it is connected. The default value is 0. Note: If you set this property to a value greater than 0, the reader issues automatic IDUC flush requests to the ObjectServer with this period. This enables the reader to run at a faster granularity than that of the ObjectServer, thus enabling the gateway to capture more detailed event changes in systems where the ObjectServer itself has high granularity settings.
Gate.RdrWtr.JournalTable Name `string`	-`journaltablename` `string`	Use this property to specify the name of the journal table that the gateway reads. The default value is alerts.journal. Note: The value for this property must be alerts.journal and should not be changed.
Gate.RdrWtr.Password `string`	-`password` `string`	Use this property to specify the login password for the ObjectServer. The Gate.RdrWtr.Password is associated with the user specified by the Gate.RdrWtr.Username property. The default value is "". Note: The gateway uses this property only when the ObjectServer runs in secure mode.
Gate. RdrWtr.ReconnectTimeout `integer`	-`reconnecttimeout` `value` -`noreconnecttimeout`	Use this property to specify the time (in seconds) between each reconnection poll attempt that the gateway makes if the connection to the ObjectServer is lost. The default value is `30` seconds. You can use `-noreconnecttimeout` to set the value to `0` (zero) to indicate that the gateway does not try to reconnect.
Gate.RdrWtr.Server `string`	-`server` `string`	Use this property to specify the name of the ObjectServer from which the gateway reads alerts. The name can either be an interface name (for example, `NCOMS`) or the `<host>:<port>` details of the ObjectServer. The default value is localhost:4100.
Gate.RdrWtr.StatusTableName `string`	-`statustablename` `string`	Use this property to specify the name of the status table to which the gateway reads and writes. The default value is alerts.status.
Gate.RdrWtr.TblReplicate DefFile `string`	-`tblrepfile` `string`	Use this property to specify the path to the table replication definition file. The path includes the name of the table replication definition file. The default value (including the name of the table replication definition file supplied with the gateway) is $OMNIHOME/gates/servicenow/ servicenow.rdrwtr. tblrep.def.
Gate.RdrWtr.Username `string`	-`username` `string`	Use this property to specify the username used to authenticate the ObjectServer connection. The default value is root. Note: The gateway uses this property only when the ObjectServer runs in secure mode.
Gate.TargetIdField `string`	-`targetidfield` `string`	Use this property to specify the `alerts.status` column to use for target identifier tracking (that is, the identifier in ServiceNow). The default value is ServiceNowSysId. Note: The identifier is the globally unique identifier (GUID) for each ServiceNow ticket.
Gate.TraceFile `string`	-`tracefile` `string`	Use this property to specify the path of the file used to store trace information. The default value is "". Note: Typically, this property is used by IBM support to debug any issues with gateway operations.
Gate.TraceMode `string`	-`tracemode` `string` -`traceread` -`tracewrite` -`tracenone`	Use this property to specify the gateway trace mode. This property takes the following values: `READ`: Enables trace reading. `WRITE`: Enables trace writing. `NONE`: Does not enable trace reading or writing. The default value is `NONE`. Note: Typically, this property is used by IBM support to debug any issues with gateway operations. You can use the command line options `-traceread`, `-tracewrite`, or `-tracenone` to set the value to `READ`, `WRITE`, or `NONE`, respectively.
Gate.Type `string`	-`type` `string`	Use this property to specify the gateway type. The default value is servicenow. Note: The value for this property must be servicenow and should not be changed.

Table 3 lists and describes the generic Tivoli Netcool/OMNIbus properties that the gateway uses. For details on these properties, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 3. Generic OMNIbus properties
Property name	Command Line option	Description
ConfigKeyFile		See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property.
HttpServer.Password `string`		This property is not currently used.
HttpServer.Port `integer`		This property is not currently used.
HttpServer.Realm `string`		This property is not currently used.
HttpServer.Root `string`		This property is not currently used.
HttpServer.Username `string`		This property is not currently used.
MaxLogFileSize		See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default maximum size for the message log file is 0 (meaning that the file size is limitless).
MessageLevel `string`	-`messagelevel` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default message level is warn:warn.
MessageLog `string`	-`messagelog` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default message log file is $OMNIHOME/ log/G_SERVICENOW.log.
MessageLogRollKeep `integer`	-`messagelogrollkeep` `integer`	Use this property to specify the maximum number of old rolled logs to keep. To specify how older logs are processed, use the MessageLogRollProcess property. The default is 5.
MessageLogRollProcess `string`	-`messagelogrollprocess` `string`	Use this property to specify how old logs are processed. The default is ''. Note: If no value is set for this property, old logs are simply deleted. If a command is specified, the old log is passed as an argument to the command. The command might be `gzip` (to compress old files) or a custom user script to archive old log files in offline storage. This functionality helps you to prevent the unrestricted build-up of old log files.
MessageLogRolltime `string`	-`messagelogrolltime` `string`	Use this property to specify at what time a daily log file should roll. Typically, this is done at midnight, to generate daily logs. However, you can specify any time. Specify the time in `HHMM` format. Where: `HH` specifies the hour and `MM` specifies the minutes of the time you want to roll the daily log. For example, the value `'0000'` specifies that the log file rolls at midnight. The value `'0430'` specifies that the log file rolls at 04:30. The default daily log file roll time is "".
Name `string`	-`name` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default name of the current gateway instance is servicenow.
Props.AllowUnknown `boolean`	-`propsallowunknown` `boolean`	Use this property to instruct the gateway on how to handle unknown properties in the properties file. Specify one of the following values: true: Instructs the gateway to allow unknown properties in the properties file and to ignore these unknown properties. false: Instructs the gateway to generate an error if there are unknown properties in the properties file. Use this setting to catch such errors as typos in property names and to avoid the diagnostics that follow typographical related errors. The default value is `false`.
PropsFile `string`	-`propsfile` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default location and name is $OMNIHOME/etc/G_SERVICENOW.props.