Recording Custom Messages

Although IBM® System Dashboard for Enterprise Content Management is not a general-purpose tracing facility, a mechanism is provided to allow applications to record Custom Messages. The recordCustomMessage member function can be used to create Custom Messages for the Listener, which can then be used by the application to communicate with all connected Managers:

listener->recordCustomMessage(customMessage);

The customMessage is a string, which provides the text of the Custom Message. The recordCustomMessage constructor is overloaded to allow the string to be passed as Unicode (const wchar_t *) that contains any printable UTF-8 characters, excluding the newline character.

IBM System Dashboard for Enterprise Content Management does not attempt to assign meaning to Custom Messages; they are considered to be application-specific. The application provides support for Custom Messages by implementing custom Manager processes to watch for the messages and then run application-specific actions that are based on the message. In addition, the application can also track Events that are related to Custom Messages and analyze the performance characteristics as a result. For more information about processing Custom Messages received from connected Managers, see the section on processing custom messages in Supporting Communication from Managers.