Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager GUI Reference


3.23 Display Message Change Definition Settings window (Add Display Message Change Definition Settings window)

In the Display Message Change Definition Settings window (Add Display Message Change Definition Settings window), you can edit and register display message change definitions associated with the display message change function. Depending on how you display the window, the Display Message Change Definition Settings or the Add Display Message Change Definition Settings window is displayed.

To display these windows:

Display Message Change Definition Settings window
  • Click the Add button in the Display Message Change Definitions window.

  • Select a display message change definition in the Display Message Change Definitions window, and then click the Edit button.

  • In the Display message change definitions list of the Display Message Change Definitions window, select an item, and then double-click the item.

Add Display Message Change Definition Settings window
  • In the event list of the Event Console window, select an event associated with a display message change definition, and then from the View menu, select Add Display Message Change Definition Settings. Alternatively, right-click the event, and then select Add Display Message Change Definition Settings from the pop-up menu.

If you do not set any conditions for an event condition set in this window, all JP1 events will match the condition.

You must have JP1_Console_Admin permission to display the Display Message Change Definition Settings (or Add Display Message Change Definition Settings) window. If the reference/operation permission function for business groups is enabled, a user might be unable to display the window depending on his or her combination of JP1 resource groups and JP1 permission levels. For details, see 4.1.4(2) Assigning a JP1 resource group and permission level to a JP1 user in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.

When you click the OK button after setting a display message change definition in this window, the definition is added to the Display Message Change Definitions window#.

#: The new settings take effect in the following cases:

The figures below show the Display Message Change Definition Settings window and the Add Display Message Change Definition Settings window.

Figure 3‒46: Display Message Change Definition Settings window

[Figure]

Figure 3‒47: Add Display Message Change Definition Settings window

[Figure]

The following describes the items displayed in these windows:

Display message change definition name

Use this text box to enter the name of the display message change definition. Specify a character string of 1 to 50 bytes when the character string is encoded by Shift-JIS if JP1/IM - Manager runs on Windows, or when the character string is encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX. You can use any characters except control characters (0x00 to 0x1F and 0x7F to 0x9F).

An initial value is already input when you open the Display Message Change Definition Settings window. The initial value depends on whether the Display Message Change Definition Settings window was opened from the Display Message Change Definitions window or whether the Add Display Message Change Definition Settings window was opened by selecting the Add Display Message Change Definition Setting menu command. If the Display Message Change Definition Settings window was opened from the Display Message Change Definitions window, the initial value is Display message change definition n. If the Add Display Message Change Definition Settings window was opened by selecting the Add Display Message Change Definition Settings menu command, the initial value is value-set-in-automatic-input-definition-file-for-a-display-message-change-definition n. You can change the initial value by using the automatic input definition file for a display message change definition. To avoid repeating the name of an existing display message change definition, the number n is the smallest unused number in the range from 1 to the maximum number of display message change definitions. You can edit this character string.

If you specify the same name as an existing display message change definition, the message KAVB0252-E is displayed in a dialog box.

Comment

Use this text box to enter a comment for the display message change definition. Specify a character string containing 1,024 or fewer bytes when the character string is encoded by Shift-JIS if JP1/IM - Manager runs on Windows, or when the character string is encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX. You can use any characters except control characters (0x00 to 0x1F and 0x7F to 0x9F). This text box is blank if you open the Display Message Change Definition Settings window from the Display Message Change Definitions window. If you open the window by selecting the Add Display Message Change Definition Settings menu command from the pop-up menu, this text box displays the name of the JP1 user who added the definition, and the date and time when the definition was added. The date and time is displayed in YYYY/MM/DD hh:mm:ss format using the time zone of the JP1/IM - View host. You can edit the contents of this text box.

Event conditions

Displays a list of event conditions for display message change definitions. Conditions that are higher in the list have higher priority.

The Attribute name column displays the names of the attributes of the event conditions. For program-specific extended attributes specified by users, the string E. is prefixed to the attribute names. For example, if TEST is specified, E.TEST is displayed.

The Attribute value column displays one or more attribute values. Multiple attribute values are separated by commas (,).

The Condition column displays the comparative operator for the event condition (First characters, Match, Does not match, Is contained, Is not contained, or Regular expression).

Read From Selected Event

When you click this button, the attribute values of the JP1 event selected in the Event Console window are automatically input to the condition list. The table below describes how the system behaves when this button is clicked. The byte counts in the table are for character strings encoded by Shift-JIS if JP1/IM - Manager runs on Windows or for character strings encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX.

Table 3‒20: How the system behaves when the Read From Selected Event button is clicked

Event attribute value

Behavior

Length

Control characters#1

4,096 or fewer bytes

Not included

  • All event attribute values are applied.

  • For attributes for which an optional condition can be specified, Match is selected.

Included

  • The characters before the first control character are used as the condition value in the condition list.

  • For attributes for which an optional condition can be specified, First characters is selected.

4,097 or more bytes

Not included

  • The first 4,096 bytes#2 are used as the condition value in the condition list.

  • For attributes for which an optional condition can be specified, First characters is selected.

Included in the first 4,096 bytes

  • The characters before the first control character are used as the condition value in the condition list.

  • For attributes for which an optional condition can be specified, First characters is selected.

Included after the 4,096th byte

  • The first 4,096 bytes#2 are used as the condition value in the condition list.

  • For attributes for which an optional condition can be specified, First characters is selected.

#1

This column indicates whether control characters are included in the event attribute value. Control characters include linefeeds and tabs.

#2

If the 4,096th byte is part of a multi-byte character, the string before the multi-byte character is used as the condition value in the condition list.

If information about the selected JP1 event is mapped in an event-information mapping definition, the attribute values and program-specific extended attribute values for the mapped display items are not input to the condition list. For details about event-information mapping definitions, see 6.9.2 Displaying extended attributes of JP1 events (mapping of event information) in the JP1/Integrated Management 2 - Manager Administration Guide.

Add

Click this button to add a new event condition. Event conditions that are not already set for the definition are added to the bottom of the event condition list. The list can contain a maximum of 256 event conditions.

Delete

Click this button to delete the selected event condition.

Up

Click this button to move the selected event condition up one line.

Use this button to change the priority of the event conditions.

Down

Click this button to move the selected event condition down one line.

Use this button to change the priority of the event conditions.

Event condition editing area

This area is used to edit the event conditions of the display message change definitions. What form this area takes depends on the selected attribute. Each type of the area is described below.

Note that if the window was opened by selecting the Add Display Message Change Definition Settings menu command, the attribute names and values for the JP1 event that was selected when the window was opened are automatically set as conditions. You can specify which attribute names and values are to be automatically set by using the automatic input definition file for a display message change definition. The behavior of the system when an attribute value is longer than 4,096 bytes (when Shift-JIS encoded) or includes control characters is the same as when the Read From Selected Event button is clicked. For details about the automatic input definition file for a display message change definition, see Automatic input definition file for a display message change definition (chmsg_auto_list.conf) in 2. Definition Files in the manual JP1/Integrated Management 2 - Manager Command, Definition File and API Reference.

Character string editing

[Figure]

This pattern applies when one of the following attributes is selected:

- Event source host name

- Source host

- Object name

- Root object name

- Occurrence

- User name

- Message

- Product name

- Destination event server name

- Source user name

- Source group name

- Object ID

- Return code

If the integrated monitoring database and IM Configuration Management database are enabled, you can specify a business group name in path format for Source host and Event source host name. In this case, either Match or Does not match can be selected as a condition. If these databases are disabled and the selected condition is not Match or Does not match, a business group name specified in path format is treated as a host name.

Note that Event source host name can be specified only if the mapping of the event source host is enabled. If the mapping of the event source host is disabled, conditions for Event source host name can be specified by specifying JP1_SOURCEHOST as the attribute name when the area for editing event conditions is in the Extended-attribute editing pattern.

Specify a character string of no more than 4 kilobytes when the character string is encoded by Shift-JIS if JP1/IM - Manager runs on Windows, or when the character string is encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX. Alphabetic characters are case sensitive.

You can specify a maximum of 100 character strings by using a comma (,) as a separator. However, only one character string can be specified if Regular expression is selected.

To specify a comma (,) or backslash (\) as an ordinary character, prefix it with a backslash (\). That is, to use a comma (,), enter \,. To use a backslash (\), enter \\.

From the drop-down list on the right, select a condition for the specified character string from First characters, Match, Does not match, Is contained, Is not contained, and Regular expression.

If Regular expression is not selected in the drop-down list on the right when ON is set for the -ignorecasehost option of the jcoimdef command, the case of alphabetic characters is ignored for the following attributes:

- Source host

- Event source host name

Event level editing

[Figure]

This pattern applies when the following attribute is selected:

- Event level

You can select Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug. The original severity level is automatically input when you click the Read From Selected Event button or the Add Display Message Change Definition Settings menu command.

Character string editing (with input candidates)

[Figure]

This pattern applies when you select the following attributes:

- Object type

- Root object type

Specify a character string of no more than 4 kilobytes when the character string is encoded by Shift-JIS if JP1/IM - Manager runs on Windows, or when the character string is encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX. Alphabetic characters are case sensitive.

You can specify a maximum of 100 character strings by using a comma (,) as a separator. However, only one character string can be specified if Regular expression is selected.

To specify a comma (,) or backslash (\) as an ordinary character, prefix it with a backslash (\). That is, to use a comma (,), enter \,. To use a backslash (\), enter \\.

From the drop-down list on the right, select a condition for the specified character string from First characters, Match, Does not match, Is contained, Is not contained, and Regular expression.

Event ID editing

[Figure]

This pattern applies when the following attribute is selected:

- Event ID

You can specify a maximum of eight hexadecimal digits as an event ID. When specifying multiple event IDs, the entire string must not exceed 4 kilobytes. You cannot specify control characters. The range of specifiable values is from 0 to 7FFFFFFF.

You can specify a maximum of 100 event IDs by using a comma (,) as a separator.

From the drop-down list on the right, select Match or Does not match as a condition for the specified event IDs.

Extended-attribute editing

[Figure]

This pattern applies when the following attribute is selected:

- Extended attribute

Specify a condition for the program-specific extended attribute.

Depending on the selected radio button, the item that can be specified differs.

  • When Attribute name is selected

    Specify a condition for the program-specific extended attribute by using an attribute name.

    In the Attribute name text box, you can enter a character string of no more than 32 bytes. The character string can contain upper-case alphabetic characters, numeric characters, and underscores (_). The first character must be an upper-case alphabetic character. If you enter a lower-case character as the first character, it is converted to an upper-case character. You cannot specify common information as an extended attribute.

  • When Item name is selected:

    Specify a condition for the program-specific extended attribute by using an item name.

    Specify a condition by selecting an item name from the Item name drop-down list. The displayed item names are program-specific extended attributes specified for the standard file and the extended file of the definition file for extended event attributes.

In the Condition text box, specify a character string of no more than 4 kilobytes when the character string is encoded by Shift-JIS if JP1/IM - Manager runs on Windows, or when the character string is encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX. Alphabetic characters are case sensitive.

You can specify a maximum of 100 character strings by using a comma (,) as a separator. However, only one character string can be specified if Regular expression is selected.

To specify a comma (,) or backslash (\) as an ordinary character, prefix it with a backslash (\). That is, to use a comma (,), enter \,. To use a backslash (\), enter \\. Note that \, and \\ each count as one byte.

From the drop-down list on the right, select a condition for the specified character string from First characters, Match, Does not match, Is contained, Is not contained, and Regular expression.

Numeric value editing

[Figure]

This pattern applies when you select the following attributes:

- Registered reason

- Source process ID

- Source user ID

- Source group ID

Specify a decimal integer of no more than 4 kilobytes, using integers from 0 to 9 and hyphens (-). You can specify values in the range from -2,147,483,648 to 2,147,483,647.

You can specify a maximum of 100 numeric values by using a comma (,) as a separator.

From the drop-down list on the right, select Match or Does not match as a condition for the specified numeric value.

Apply

Click this button to apply the settings.

Message after the change

Specify the new message format for the display message change definition.

[Figure]

Enter a character string to be set for the changed display message. You can use any characters except control characters (0x00 to 0x1F and 0x7F to 0x9F).

If you use a variable to specify the message format, you can set the attribute information of the received JP1 event for the message. For details about the variables that can be specified, see Display message change definition file (jcochmsg.conf) in 2. Definition Files in the manual JP1/Integrated Management 2 - Manager Command, Definition File and API Reference.

The maximum size of the character string is 1,023 bytes when the character string is encoded by Shift-JIS if JP1/IM - Manager runs on Windows, or when the character string is encoded by the language encoding with which JP1/IM - Manager operates if JP1/IM - Manager runs on UNIX.

If a variable (such as $EVMSG) is used and the character string that includes the information of the converted variable exceeds 1,023 bytes, only the first 1,023 bytes are set for the message.