This section provides information on how to create various types of user information within your PATROL KM, such as messages, context-sensitive help panels, product expert advice, product help systems, and end-user guides. The following topics are discussed:
User information that is built within a PATROL KM falls into three main categories:
User information typically thought as "product documentation" includes:
Each of these types of information provide a mechanism to communicate knowledge back to the PATROL KM product end-user. Therefore, keep in mind your end-user's needs when generating this information. Here are some recommendations when generating user information.
If you have defined your own event class and have defined a Expert Advice button, complete the Expert Advice screen by using the Expert Advice tab. For more information, refer to Adding an event class to an application.
All error messages for the PATROL KM should be logged to the PATROL Console output window.
Note
All error messages should be documented in an appendix of the PATROL KM product's user reference manual.
Parameter, menu command, and discovery messages should have the following output formats: ERROR:
date/time application instance parameter message ERROR:
date/time application instance menu_command message ERROR:
date/time application instance discovery message
Field | Definition |
---|---|
date/time | Character string indicating the date and time the message was produced. The date/time has the following format: Wed Apr 12 09:47:44 1995. The date/time value can be obtained by executing the following PSL statement: |
application | Name of the PATROL KM application that generated the error message. |
instance | Name of the PATROL KM application instance that produced the error message. |
parameter | Name of the PATROL KM application instance parameter that produced the error message. |
menu_command | Name of the PATROL KM application instance menu command that produced the error message. |
discovery | Name of the PATROL KM application instance discovery procedure that produced the error message. |
message | Character string that explains the error that occurred. |
For more details about how to generate the various categories of PATROL KM user information see the following:
Topic | Source |
---|---|
Messages | Refer to the PATROL Script Language Reference Manual printf() function. |
Expert Advice panel for an Event Class | Refer to Adding an event class to an application. |