A.15 IBM Micromuse Netcool

Table A-15 IBM Micromuse Netcool Adapter Properties

Property	Specify…
AccountMap	The file used to construct a map between Operations Center and Netcool users. The comments at the top of this file provide details on how to assemble the AccountMap file. The default is examples/NetcoolAccountMap.properties.
AckAffectsCondition	If True, an acknowledged alarm contributes to element condition and alarm counts. The default is True. For example, assume there is an element with one critical event: counts= 1‑CRITICAL element=RED Acknowledge the alarm and set AckAffectsCondition to True. This results in reducing the alarm count by one and changing the element condition to green: counts= 0‑CRITICAL element=GREEN Acknowledge the alarm and set AckAffectsCondition to False. The result is the alarm still exists and the condition remains unchanged after acknowledging it: counts =1‑CRITICAL element=RED
AlarmColumnDefinition	By default, the alarm property pages display all original Netcool fields in the same order used on the Netcool Objectserver. To change the properties or order in which they display, edit the blank, default file named /OperationsCenter_install_path/database/examples/NetcoolAlarmColumns.properties. Then specify the path and file name in this property. Edit the file to specify the order in which properties display or to exclude properties from display: To set the order of properties displayed in the alarm property pages, enter the property names one per line in the preferred order. To exclude a field, enter the field name followed by an equal sign and the word exclude. In the following example, the Serial field displays at the top of the Properties page and NodeAlias does not display in the property page: Serial NodeAlias=exclude If no file or an empty file is specified, all alarm columns display in the same order used on the Netcool Objectserver.
AlarmColumns	A comma-separated list that determines which alarm columns display and the order in which they display in the Alarms view. To conserve memory and alarm history storage space, specify only the relevant alarm columns and exclude mining of all other alarm data. There are several ways to specify alarm columns: Use the format colum_nname=included to include an alarm column; for example: Customer=included. Shortcut: Identify only “included” fields and all other fields are excluded. Use the format column_name=excluded to exclude an alarm column; for example: Customer=excluded. Shortcut: Identify only “excluded” fields and all other fields are included. If an alarm column is identified as both included and excluded, then it is excluded. If only alarm column names are listed without any “included” or “excluded” tags, then the listed columns display in the Alarms view, but all other alarm data is mined. The fields that are always included: Serial, Severity, LastOccurrence, Acknowledged, OwnerUID, OwnerGID, and Summary.
AlarmSeverityMapping	A comma delimited list of severity mappings for alarms. Use the format NetcoolSeverity=OperationsCenterSeverity For example: CLEAR=OK,INDETERMINATE=INFORMATIONAL,WARNING=MINOR,MINOR=MINOR,MAJOR=MAJOR,CRITICAL=CRITICAL
DatabaseDriver	Version of Sybase JDBC drivers being used by Operations Center. The default is Sybase. For example, to use Sybase version 3 drivers, save the drivers to the /OperationsCenter_install_path/classes/ext directory, then update the DatabaseDriver adapter property to com.sybase.jdbc3.jdbc.SybDriver.
ElementsTimeout	If there are no open alarms and the element’s condition has not changed in the last n seconds, and the element has no children, then the element disappears from the display. If another alarm is generated for this element, then it reappears. The default is 300. ElementsTimeout < 0: Never time out. ElementsTimeout = 0: Time out immediately. ElementsTimeout > 0: Time out after specified time expires.
HierarchyFile	A file in the /OperationsCenter_install_path/database directory that contains an XML description of the element hierarchy to build below the adapter element. The default is examples/NetcoolHierarchy.xml.
HostTokens	A list of Netcool token values that determine console connectivity. If Operations Center finds one of these tokens in an alarm, it uses the token to assign connectivity. The default is Node.
IDUC Timer	The time interval used to check for updates for a specific Netcool/Operations CenterOperations Center integration. Overrides the Netcool global IDUC timer setting. The default is 60 seconds. Valid values are greater than 5 seconds.
MaxAlarms	The maximum number of alarms that the adapter queries and retains. The default is 0, which allows an unlimited number of alarms.
ObjectServerAccount	The user name for connecting to the object server. The default is root.
ObjectServerHost	The host location of the object server.
ObjectServerName	The name of the object server. The default is NCOMS.
ObjectServerPassword	The password for the user name supplied as the ObjectServerAccount.
ObjectServerPort	The port on which the object server host listens. The default is 4100.
ObjectServerVersion	The version of Object Server software that is installed. The default is 7.4.0.
OperationsMenu	The Netcool object server menu table used to populate the right-click operations for Netcool alarms. If blank, the default AlertsMenu Netcool menu displays. If the adapter attempts but fails to use the specified menu table, no operations display and the formula.trc file logs a warning.
RelayServer	The name of the server on which the relay connection exists. For details on setting up a relay connection, see Integration Using a Secure Relay Connection.
RelayServerPort	The port number configured for use by the Netcool adapter for relay communications.
RelaySecurity	The security level for the relay server: SSL or unsecured (meaning use cleartext, which is not case-sensitive).
Script.onConnected	A script that executes when the adapter successfully connects to the object server. The default is: @adapters/Netcool/setServerSkewTime.fs This script calculates the time differential (skew) between the Operations Center and object servers. This skew affects calculations of the date/time stamps used for user presentation and information logging/stamping. If the Operations Center server runs on the same machine as the Netcool server, then there is no skew to calculate. In this case, the time skew script is unnecessary. If a site synchronizes the time for its servers using the standard UNIX timeserver service (usually port 37), then the difference in time between the Operations Center server and the machine running the Netcool server might be negligible. In this case, ignore this parameter. The supplied script calculates the difference in time between the Operations Center server and the target Netcool server by running the REXEC protocol to invoke the date command on the UNIX host. If the Netcool server runs another operating system, or if a site has restricted the access to the REXEC protocol, use a different mechanism to calculate the difference in time between the machine running Operations Center and the Netcool server. If using a different mechanism, study the supplied script as a model for how to make the adjustments to the Operations Center Netcool adapter. The script invokes the setServerTimeSkew() adapter method using the number of milliseconds (seconds times 1000) of difference between the Operations Center server and Netcool server.
Script.onDisconnected	A script that executes when the adapter disconnects from the object server. All of the Script.* properties are optional. A script that executes if the adapter fails for any reason. For example, the script can print the reason for the failure as msg using log.info(msg).
Script.onError	A script that executes if the adapter fails for any reason. For example, the script can print the reason for the failure as msg using log.ino(msg).
Script.onInitialized	A script that executes when the adapter initializes.
Script.onStarted	A script that executes when the adapter starts.
Script.onStopped	A script that executes after manually stopping the adapter.
StylesheetFile	The stylesheet file in the /OperationsCenter_install_path/database directory that applies to the HierarchyFile as a style markup to produce the final output.
UnacknowledgedText	The text string to match that indicates that the alarm is unacknowledged. Defaults to no.
UseAlarmTimesForCond Changes	The date/time stamp to use for all alarm data stored by the Operations Center Data Warehouse. If true, the alarm’s date/time stamp is used. If false, the date/time stamp of when the Operations Center server received the alarm is used. The default is true.