Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Overview and System Design Guide


5.8.1 Settings for guide information

The contents displayed as guide information are set in a guide information file managed by JP1/IM - Manager.

For the format of a guide information file, see below.

About the guide information file
  • Format of a guide information file

    See Guide information file (jcs_guide.txt) in Chapter 2. Definition Files in the manual JP1/Integrated Management 2 - Manager Command, Definition File and API Reference.

In a guide information file, you can specify the contents to be displayed as guide information and the conditions about when to display the information.

The information to be displayed can be stored and managed in individual files. In JP1/IM, these separate files are known as guide-message files.

To use guide-message files, the guide information file must be version 2 (DESC_VERSION=2). In the guide information file, instead of writing out the information itself, you simply write links to the guide-message files.

Figure 5‒23: Using guide-message files

[Figure]

Organization of this subsection

(1) Conditions for displaying guide information

Using a condition EV_COMP_n (where n represents a number), you can specify when to display a particular item of guide information. You can specify multiple conditions in the form EV_COMP_1, EV_COMP_2, and so on. The specified conditions are related by an AND condition.

As the condition, you can specify the type of JP1 event received by the monitoring node, or information about the node itself, as follows:

When guide information is displayed in JP1/IM - View, the contents of the guide information file are referenced from the top. When an item matching the conditions is found, referencing stops and the applicable information appears in the Guide window.

Important

Because the Guide window displays only the first of possibly multiple items in the guide information file that match the conditions, bear the following in mind when setting display conditions:

  • Set multiple display conditions for an item of guide information so that the condition does not duplicate a display condition set for a different guide item.

    For example, by setting multiple JP1 event attributes in a display condition, such as the event ID, event level, or message, you can differentiate the display condition from that set for another guide item.

    A regular expression can be written as the contents of an attribute, but it must require a complete match.

  • Write the contents of the guide information file starting from the highest event level.

    For example, if status change conditions have been defined to change the status of a monitoring node to Warning and Error, respectively, write the information displayed when the node status changes to Error before the information displayed when the node status changes to Warning.

    To display a description of the monitoring node as guide information, simply specify the node ID as the display condition. Write low-priority information of this nature at the very end of the guide information file.

(2) Contents displayed as guide information

To write messages to be displayed as guide information, specify EV_GUIDE in the guide information file. To use guide-message files, specify EV_FILE instead of EV_GUIDE.

Messages can be written in text format or HTML format. The attribute values of JP1 events can also be used as variables in messages (by prefixing the attribute value with $). For example, if you write $B.MESSAGE, JP1 event messages (B.MESSAGE) will be handled as variables, and the attribute value of the JP1 event will be displayed in the guide message.

Reference note: