IBM System Dashboard for Enterprise Content Management Listener configuration

You can use Java™ virtual machine (JVM) properties to control listener behavior and manage the user history queue.

JVM properties
Set the maximum number of User History Queue records to store in the Listener buffers:
  • filenet.pch.ILMT.MAX_HISTORY=40000 (default)
  • filenet.pch.ILMT.MAX_HISTORY=10000
  • filenet.pch.ILMT.MAX_HISTORY=2500000

The User History Queue records store the history of user activity on the system. Those records can be periodically downloaded by the IBM License Metric Tool Collector for usage trend analysis and user license compliance determination. For customers who may need to collect more data, set filenet.pch.ILMT.MAX_HISTORY to a value greater than zero based on the following formula:

MAX_HISTORY value >= (number of system users) * (4 records per hour) * (number of hours between ILMT Collector runs)
  • Example 1: Setting MAX_HISTORY=10000 allows enough buffer space for the following environment: 9,600 User History Queue records = (100 users) *(4 records per hour) * (24 hours between IBM License Metric Tool Collector runs)
  • Example 2: Setting MAX_HISTORY=2500000 allows enough buffer space for the following environment: 2,400,000 User History Queue records = (25,000 users) *(4 records per hour) * (24 hours between IBM License Metric Tool Collector runs)
  • Example 3: Setting MAX_HISTORY=2500000 allows enough buffer space for the following environment: 2,400,000 User History Queue records = (50,000 users) *(4 records per hour) * (12 hours between IBM License Metric Tool Collector runs)
Important: Setting MAX_HISTORY to too low a value causes User History Queue records to be lost and unrecoverable. Setting MAX_HISTORY to a large value can use more JVM memory if the IBM License Metric Tool Collector is running infrequently. Memory consumption is approximately 128 bytes per User History Queue record that is in use; however, the User History Queue is cleared at each IBM License Metric Tool Collector run. For example, a full User History Queue with MAX_HISTORY=2500000 uses 320 MB of JVM memory, however, each collection frees this memory. Also, an empty User History Queue, regardless of the MAX_HISTORY value, uses no memory. Memory use can be reduced by running the IBM License Metric Tool Collector more often.
Allow the IBM License Metric Tool metric collection to be disabled:
  • filenet.pch.ILMT=enabled (default)
  • filenet.pch.ILMT=disabled
Allow the entire Listener data collection and network services to be disabled:
  • filenet.pch=enabled (default - any value means enabled)
  • filenet.pch=disabled
(V5.5.9 and later) Allow the Listener to use non-hashed usernames and store the usernames in clear text:
  • filenet.pch.USERNAMEHASH=enabled (default)
  • filenet.pch.USERNAMEHASH=disabled
Note: The data that is previously extracted and stored by the IBM License Metric Tool Collector tool into a local Derby database in hashed form is not updated to non-hashed form. Only new data that is extracted from a Content Platform Engine instance by using the JVM option stores the username in clear text.
PchConfig.properties file properties
You can customize the behavior of the Listener by using four configuration parameters:
  • port_number
  • secondary_port
  • output_count
  • output_interval

Default values are provided for each of these parameters; however, you can override the defaults by specifying new values in the PchConfig.properties file.