Although the System Manager is not a general-purpose tracing facility, a mechanism is provided to allow applications to record Custom Messages. The recordCustomMessage method can be used to create Custom Messages for the Listener, which will be sent to any connected Managers:
listener.recordCustomMessage(customMessage, [criticality]);
The customMessage is a Unicode String which provides the text of the Custom Message and may contain any printable characters excluding the newline character.
In FileNet P8 4.0.0 and later, a pre-defined constant value may be passed to the recordCustomMessage method to specify whether the content of the message is informational only, a warning, or of a more critical nature. The following values are supported:
INFO
WARNING
CRITICAL
FATAL
Each constant is defined as a public static final int
value and is passed to the method through the criticality parameter. Prior to 4.0.0, all Custom Messages were automatically considered to be at the INFO
critical level. Therefore, when no critical level is specified, the INFO
level is automatically assigned to allow for backward compatibility.
Although a critical level may be specified, the System Manager does not attempt to assign meaning to the Custom Message; it is considered to be application-specific. The application may provide support for Custom Messages by implementing custom Manager processes to watch for the messages and then perform application-specific actions based on the message and the specified critical level. In addition, the application may track Events related to Custom Messages and analyze the performance characteristics as a result. For more information about processing Custom Messages received from connected Managers, see Supporting Communication from Managers: Processing Custom Messages.