2.1 Defining the Adapter Properties

To define F/X Adapter properties:

  1. In the Explorer pane, expand the Administration root element.

  2. Right-click Adapters, then select Create Adapter to open the Create Adapter dialog box.

  3. Click the Type drop-down list, then select NOC - F/X Adapter.

    A default name of the Event Manager adapter (Adapter: Operations Center Event Manager™) displays in the Name field. Default adapter properties specific to the Event Manager display in the Properties table.

  4. In the Name field, replace the default name with one that defines your system.

  5. Create the adapter.

  6. After creating the adapter, define the following adapter properties:

    Adapter Listen Port: The TCP/IP port on which the adapter listens for incoming connection requests. This port must match the target port setting in the F/X Monitor configuration. The default is 50001.

    Alarm Columns: A comma-separated list that determines which alarm columns display and the order in which the alarm items display (date/time, rule, and so on) in the Alarms view. The default list is:

    FilePath,CollectorType,Parser Name=ParserName,alarmMessage

    Hierarchy File: 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/FXAdapterHierarchy.xml

    Maximum Alarms: The maximum number of alarms that the adapter should maintain. Enter ‑1 to allow an unlimited number of alarms.

    Monitor Handshake Max Wait: The maximum amount of time that the adapter waits for a valid handshake to be completed with a remote F/X Monitor. If a valid handshake is not established within the specified time interval, the adapter drops the remote connection. The default is 10 seconds.

    Persist Alarms: If set to yes, the adapter automatically stores and recovers alarms when the adapter shuts down and restarts. The adapter also performs background writes of alarm persistence data to ensure an alarm persistence source is available even when an unclean shutdown of the Operations Center session occurs.

    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.info(msg).

    Script.onInitialized: A script that executes when the adapter initializes. All of the Script. properties are optional.

    Script.onStarted: A script that executes when the adapter starts, either manually or automatically, when the Operations Center server 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.

    UseAlarmTimesFor CondChanges: The date/time stamp to use for all alarm data stored by the Data Warehouse. If True, the date/time stamp information originates directly from the alarm information. If False, the date/time stamp is when the Operations Center server received the alarm. The default is True.

  7. Continue to Section 2.2, Starting the Adapter.