The behavior of the Listener may be customized through the use of four configuration
parameters: port_number
, secondary_port
, output_count
,
and output_interval
. FileNet provides default values for each of
these parameters. However, you may override the defaults by specifying new values
in a configuration file called PchConfig.properties.
In the PchConfig.properties configuration file, you may specify values for
the configuration parameters using the syntax property=value
. The
following table describes the customizable configuration parameters and the
default values assigned by FileNet System Manager:
Property |
Default
|
Description |
---|---|---|
port_number |
32775
|
The primary TCP port number on which the first instantiated Listener (called the primary Listener) listens for connections from Managers. When a Manager connects to the primary Listener, it will be informed about which other ports are bound to other (secondary) Listeners. (Managers will normally choose to connect to both the primary and secondary Listeners). NOTE A different port number should only be specified if another service is already using this port locally. |
secondary_port |
OS defined
|
When this parameter is defined, secondary Listeners attempt to bind to
the specified port number, then that number plus 1, plus 2, etc., until
they successfully bind to a port. After a secondary Listener binds to
a port, it contacts the primary Listener and informs it of the port number
it has chosen. Multiple Listeners on the same computer will automatically
arbitrate the use of the TCP port number using the |
output_interval |
900 |
Specifies the aggregation interval in seconds; values of less than 100 milliseconds are ignored. The aggregation interval is the length of time over which each summary block of performance data is accumulated by the Listener. At the end of each aggregation interval, the Listener computes a summary block (basically, a snapshot of the current counter values), sends the summary to any Managers that have requested automatic updates, and then resets the min and max values associated with the Accumulators. The summary block is also added to a running history maintained by the Listener, which allows newly-connecting Managers to request information about recent application activity. For more information about the aggregation interval, see Getting Started: Configuring the Aggregation Interval in the FileNet System Manager Listener C++ API Developer's Guide or the FileNet System Manager Listener Java API Developer's Guide. |
output_count |
96
|
Specifies the maximum number of summary blocks that will be written to the summary log file before it is closed and a new one is opened. The default configuration provides for 24 hours worth of data to be written to a single file. Therefore, somewhere between 24 and 48 hours of performance history will be available at any given time. |
Multiple Listeners on the same computer will automatically arbitrate the use
of the TCP port
number, via the secondary_port
parameter. This ensures that there
is always one Listener listening on
the primary port to which Managers may connect.
When executing in an application server environment, you must ensure that the application has the appropriate privileges to listen for connections on these TCP port(s). On Windows systems, the WinPerfMon.dll file must be installed in the appropriate search path in order for the Listener to obtain system performance information. On Unix systems, the application must have the privilege to exchange UDP packets with rstatd.
When the Listener is instantiated, the System Manager attempts to locate the PchConfig.properties configuration file and if it is found, the contents of the file are processed. When the PchConfig.properties configuration file cannot be located, FileNet assigns the default values to the configuration parameters.
The process for locating the file on a Windows platform for use with the C++ Listener API is as follows:
filenet.pchconfig
environment variable is defined. If the variable is defined and its value
is not the empty string, then the value of the variable is considered to be
the complete path to the location of the configuration file.filenet.pchconfig
environment variable is not defined,
or its value is the empty string, then the System Manager searches for the
configuration file in the current directory.HOME
environment variable is defined, the configuration
file is searched for in that directory.HOME
environment variable, and if the PATH
environment
variable is defined, then each semicolon-separated directory is searched for
the file.The process for locating the file on a Java-enabled platform for use with the Java Listener API is as follows:
filenet.pchconfig
Java system property is defined. If the property is defined and its value
is not the empty string, then the value of the property is considered to be
the complete path to the location of the configuration file.filenet.pchconfig
property is not defined, or its value
is the empty string, then the System Manager searches for the configuration
file in the directories specified by the user.home
, user.dir
,
and java.home
Java system properties, in that order.CLASSPATHS
variable are searched.