Flat File Gateway properties

You use the Flat File Gateway properties to specify how the gateway interfaces with the data source. You can override the default values by using the configuration file.

The following tables describes the properties used to create a Flat File Gateway writer.

Note: For details of the data type definitions for the alerts tables forwarded to the ObjectServer, see the IBM Tivoli Netcool/OMNIbus Administration Guide, (SC23-6371).

Common Netcool/OMNIbus properties

Table 1. Common gateway properties
Property Name Command line option Description
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 name with the suffix .old and creates a new log file.

The default value is 1024
MessageLevel string -messagelevel string

Use this property to specify the reporting level of the log file messages.

The default value is 'warn'
MessageLog string -messagelog string

Use this property to specify the location of the message log file.

The default value is '$OMNIHOME/log/NCO_GATE.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 value is 'NCO_GATE'
PropsFile string -propsfile string

Use this property to specify the location of the gateway properties file.

The default value is '$OMNIHOME/etc/NCO_GATE.props'
Help string -help string

Use this property to instruct the gateway to display application help information on startup and exit.

The default value is FALSE
UniqueLog string -uniquelog string

Use this property to specify whether or not log file names are made unique by adding the Process ID (PID) of the gateway to the file name.

The default value is FALSE
Version string -version string

Use this property to instruct the gateway to display information about the application version on startup and exit.

The default value is FALSE

Common IPC properties

Table 2. Common IPC properties
Property Name Command line option Description
Ipc.ClientOverrideSybase string -clientoverridesybase string

Use this property to specify whether the client overrides the Sybase settings.

The default value is FALSE
Ipc.OpenClientDebug string -openclientdebug string

Use this property to specify that the probe logs client debug messages.

The default value is FALSE
Ipc.QueueSize integer -queuesize integer

Use this property to specify the size of the internal server queues used by the middleware.

The default value is 1024

You should only change this value if instructed by IBM Software Support.
Ipc.SingleThreaded boolean -singlethreaded boolean

Use this property to specify that the server middleware runs single threaded.

The default value is FALSE
Ipc.StackSize integer -stacksize integer

Use this property to specify the size (in bytes) of the internal server thread stacks.

The default value is 34816
Ipc.Timeout integer -timeout integer

Use this property to specify the period (in seconds) that the gateway allows for a response from the server before timing out.

The default value is 60
Ipc.TruncateVendorLogFile string -truncatevendorlogfile string

Use this property to specify whether the gateway truncates the middleware vendor log file on startup.

The default value is TRUE
Ipc.VendorLogFileSize integer -vendorlogfilesize integer

Use this property to specify the maximum size (in bytes) of the middleware vendor file.

The default value is 1024
Connections integer -connections integer

Use this property to specify the maximum number of client connections that can be made to the gateway server.

The default value is 30

Common Gateway Properties

Table 3. Common Gateway Properties
Property Name Command line option Description
Gate.CacheHashTblSize integer -cachehtblsize integer

Use this property to specify the number of elements (database rows) that the gateway allocates for the hash table cache.

The default value is 5023.
Gate.MapFile string -mapfile string

Use this property to specify the mapping file for the gateway to use.

The default value is '$OMNIHOME/gates/file/file.map'.
Gate.Mapper.Debug boolean -mapperdebug boolean

Use this property to specify whether or not the gateway includes mapper debug messages in the debug log.

The default value is TRUE
Gate.Mapper.Forward HistoricDetails string -mapperforhistdtls string

Use this property to specify whether the gateway forwards all historic details on converted update.

The default value is FALSE
Gate.Mapper.Forward HistoricJournals string -mapperforhistjrnl string

Use this property to specify whether the gateway forwards all historic journals on converted update.

The default value is FALSE
Gate.StartupCmdFile string -startupcmdfile string

Use this property to specify the location of the startup command file.

The default value is '$OMNIHOME/gates/file/file.startup.cmd'
Gate.Reader.Debug string -readerdebug string

Use this property to specify whether the gateway includes gateway reader debug messages in the debug log.

The default value is TRUE
Gate.Reader.Description string -readerdescription string

Use this property to specify the application description for the reader connection. This description is used in triggers and allows you to determine which component of the gateway attempted to perform an action.

The default value is 'Gateway Reader'
Gate.Reader.DetailsTable Name string -readerdetailstblname string

Use this property to specify the name of the details table that the gateway reads.

The default value is 'alerts.details'
Gate.Reader.FailbackEnabled string -readerfailbackenabled string

Use this property to specify whether the gateway fails back to the backup ObjectServer when disconnected from the primary ObjectServer.

The default value is TRUE
Gate.Reader.FailbackTimeout integer -readerfailbacktimeout integer

Use this property to specify the frequency (in seconds) with which the gateway attempts to fail back to the primary system following a system failover.

The default value is 30
Gate.Reader.IducFlushRate integer -readeriducflushrate integer

Use this property to specify the rate (in seconds) of the granularity of the reader. If you set this property to 0, 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 frequency. 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.Reader.JournalTable Name string -readerjournaltblname string

Use this property to specify the name of the journal table that the gateway reads.

The default value is 'alerts.journal'
Gate.Reader.LogOSSql boolean -readerlogossql boolean

Use this property to specify whether the gateway logs all SQL commands sent to the ObjectServer in debug mode.

The default value is FALSE
Gate.Reader.Password string -readerpassword string

Use this property to specify the password associated with the user specified by the Gate.Reader.Username property.

The default value is ''

Note: This password must be encrypted using the nco_g_crypt utility. For information about using nco_g_crypt, see the IBM Tivoli Netcool/OMNIbus Administration Guide.
Gate.Reader.Reconnect Timeout integer -readerreconntimeout integer

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'
Gate.Reader.Server string -readerserver string

Use this property to specify the name of the ObjectServer from which the gateway reads alerts.

The default value is 'NCOMS'
Gate.Reader.StatusTableName string -readerstatustblname string

Use this property to specify the name of the status table that the gateway reads.

The default value is 'alerts.status'
Gate.Reader.TblReplicate DefFile string -readertblrepdef string

Use this property to specify the location of the table replication definition file.

The default value is '$OMNIHOME/gates/file/file.reader.tblrep.def'
Gate.Reader.Username string -readerusername string

Use this property to specify the user name that is used to authenticate the ObjectServer connection.

The default value is 'root'
Gate.Transfer.Failover SyncRate integer -fsyncrate integer

Use this property to specify the rate (in seconds) of the failover synchronization.

The default value is '60'
Gate.NGtkDebug boolean -ngtkdebug boolean

Use this property to specify whether or not the NGTK library logs debug messages.

The default value is 'TRUE'
Gate.PAAware integer -paaware integer

This property indicates whether or not the gateway is Process Agent (PA) aware.

The default value is '0' (the gateway is not PA-aware).

Note: This property is maintained by the PA server and is included in the properties file for information only.
Gate.PAAwareName string -paname string

This property indicates the name of the PA controlling the gateway.

The default value is ''

Note: This property is maintained by the PA server and is included in the properties file for information only.

Flat File Gateway Properties

Table 4. Flat File Gateway Properties
Property Name Command line option Description
Gate.File.BatchHeader string -filebatchhdr string

Use this property to specify the format of the header that the gateway adds to indicate the start of each new table written to the file.

The default value is '########## BATCH START ##########'

Note: The gateway only uses the batch header if the Gate.File.UseBatchSeparator property is set to TRUE.
Gate.File.BatchTrailer string -filebatchtl string

Use this property to specify the format of the trailer that the gateway adds to indicate the end of each table written to the file.

The default value is '########## BATCH END ##########'

Note: The gateway only uses the batch trailer if the Gate.File.UseBatchSeparator property is set to TRUE.
Gate.File.ColSeparator string -filecolseparator string

Use this property to specify the character that the gateway inserts between each column name and its corresponding value.

The default value is ':'
Gate.File.DateFormat string -dateformat string

Use this property to specify the date format that the gateway uses for any date fields written to the socket.

The default value is '%x %X'
Gate.File.DeleteHeader string -deleteheader string

Use this property to specify the format of the header added to the start of each delete alert written to the socket.

The default value is 'DELETE: '
Gate.File.DeleteTrailer string -deletetrailer string

Use this property to specify the format of the trailer added to the end of each delete alert written to the socket.

The default value is '\n'
Gate.File.DoTimeStamp boolean -dotimestamp boolean

Use this property to specify whether the gateway prefixes each event with the date and time of its arrival.

The default value is 'FALSE'
Gate.File.EndString string -endstring string

Use this property to specify whether the gateway prefixes each event with the date and time of its arrival.

The default value is '"'
Gate.File.FileMode integer -filemode integer

Use this property to specify the file permissions to set for the file to which the gateway writes. The parameter that you specify is contingent on the umask value of the shell in which you start the gateway. The umask value determines the default permissions for any file created by a process. The Gate.File.FileMode property accepts any permission that is not specified by umask.

The default value is '644'

Note: If the value configured for this property is outside of the range of permitted values, the permission will be undetermined. The final file permission will be bound by the operating system.

In Windows, there is an OS predisposition to force 644 permission regardless of what is being configured in this property.
Gate.File.FileName string -filefname string

Use this property to specify the name of the file to which the gateway writes alert data from the ObjectServer.

The default value is 'output.log'.

Note: This property supports date and time stamping using date parameters. For example, if you specify output.#y-#m-#d-#h, the gateway appends the date and time at which the file is created to the file name. In this example, #y indicates the year (00-99), #m indicates the Month as a number (01-12), #d indicates the Day of the month (01-31), #H indicates the in 24 hour format (00-23), and #M indicates the minute (00-59).

The gateway is incapable of knowing if this output file is absent, so if this output file gets deleted while the gateway is running, it will not know and will not exit.
Gate.File.InsertHeader string -InsertHeader string

Use this property to specify the format of the header added to the start of each insert alert written to the file.

The default value is 'INSERT'
Gate.File.InsertTrailer string -inserttrailer string

Use this property to specify the format of the trailer added to the end of each insert alert written to the file.

The default value is '\n'
Gate.File.MaxFileSize integer -maxfilesize integer

Use this property to specify the maximum size (in bytes) of the flat file to which the gateway sends output. When the file reaches this size, the gateway sends its output to a new file.

The default value is 0.
Note: The maximum value that can be assigned to this property is 2,147,000,000 bytes.
Note: To specify whether the gateway maintains two concurrent files or multiple files, use the Gate.File.OutputMode property.
Gate.File.OutputFieldNames boolean -fileoutputfldnames boolean

Use this property to specify whether the gateway writes the alert data to the file as name-value pairs.

The default value is FALSE

Note: If the name fields appear as "" in the output for all fields, you must update the mapping file, adding the appropriate field name. For example, to output "Id":"Heartbeat", you must change the entry in the mapping file to: 'Id' = '@Identifier'.
Gate.File.OutputMode string -fileoutputmode string

Use this property to specify whether the gateway maintains two concurrent files or a series of successive, incrementally named files.

Possible values are:
  • HISTORICAL: The gateway writes to the file specified by the Gate.File.FileName property; when it reaches the maximum file size, it starts writing a new file named _1. It repeats this each time the maximum file size is reached, incrementing the filename by one each time; for example, the gateway creates files named FILE, FILE_1, FILE_2, and so forth
  • CURRENT: The gateway writes to the file specified by the Gate.File.FileName property; when it reaches the maximum file size, it renames this file .old and creates a new file named to continue output; for example, the gateway creates files named FILE and FILE.old.

The default value is "HISTORICAL"

Note: The maximum size for any of these files is specified by the Gate.File.MaxFileSize property.
Gate.File.ProtectAllFields boolean -fileprotectall boolean

Use this property to specify whether the gateway adds the characters defined by the Gate.File.StartString and Gate.File.EndString properties to integer fields as well as string fields.

The default value is FALSE
Gate.File.Separator string -separator string

Use this property to specify the character that the gateway inserts between the fields written to the file.

The default value is ','
Gate.File.StartString string -filestartstring string

Use this property to specify the character that the gateway adds to the start of string values written to the file.

The default value is '"'
Gate.File.Sync boolean -filesync boolean

Use this property to specify the whether synchronous write is enabled

The default value is FALSE
Gate.File.Truncate boolean -filetruncate boolean

Use this property to specify the file is truncated on startup, or whether the writer continues to append to the end of the file.

The default value is FALSE
Gate.File.UpdateHeader string -fileuphdr string

Use this property to specify the value that the gateway adds to the start of each update alert written to the file.

The default value is 'UPDATE: '
Gate.File.UpdateTrailer string -fileupdtl string

Use this property to specify the value that the gateway adds to the end of each update alert written to the file.

The default value is '\n'
Gate.File.UseBatchSeparator boolean -fileusebatchsep boolean

Use this property to specify whether the gateway writes details of changes from multiple tables to the file in batches, with a separator between each table.

The default value is FALSE

Properties taking Boolean values

For binary-typed properties (namely boolean properties taking the value TRUE or FALSE) or range-typed properties (namely those taking an integer range of values), using a value that does not conform to the possible settings will result in the use of the property's default value.

Boolean-Type File Gateway properties:

  • Gate.File.DoTimeStamp
  • Gate.File.OutputFieldNames
  • Gate.File.Truncate
  • Gate.File.DoTimeStamp
  • Gate.File.OutputFieldNames
  • Gate.File.ProtectAllFields
  • Gate.File.Sync
  • Gate.File.UseBatchSeparator

Range-Type File Gateway properties:

  • Gate.File.FileMode
  • Gate.File.MaxFileSize