Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Command and Definition File Reference


Display message change definition file (jcochmsg.conf)

Organization of this page

Format

DESC_VERSION=1
# Display-message-change-definition-comment
def definition-name-1
    [cmt comment]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        event-condition
    end-cnd
    msg message
end-def
 
def definition-name-2
    [cmt comment]
    [define {enable | disable}]
    [addflag {true | false}]
    cnd
        event-condition
    end-cnd
    msg message
end-def

File

jcochmsg.conf (display message change definition file)

jcochmsg.conf.model (model file for the display message change definition file)

Storage directory

In Windows
For a physical host:

Console-path\conf\chattr\jcochmsg.conf

For a logical host:

shared-folder\jp1cons\conf\chattr\jcochmsg.conf

In UNIX
For a physical host:

/etc/opt/jp1cons/conf/chattr/jcochmsg.conf

For a logical host:

shared-directory/jp1cons/conf/chattr/jcochmsg.conf

Description

This file defines the JP1 event conditions that change the display of a message using the display message change function and defines the message after the change. JP1 event attributes that match event conditions are changed in accordance with the definitions in this file. Specify this file using the language encoding that is used by JP1/IM - Manager.

The maximum size of this file is 22 megabytes (23,068,672 bytes).

There are two types of parameters in the display message change definition file:

When the definitions are applied

The definition takes effect when the event display message change function is enabled, and one of the following operations is performed:

Information that is specified (display message change definition file version)

DESC_VERSION

Specifies the file version that determines the format of this display message change definition file. Specify a value of 1. If DESC_VERSION is omitted, 1 is assumed as the file version.

Specify DESC_VERSION on the first line of the definition file (the first line in the file excluding any null lines and comment lines). If there is no file version in the first line, 1 is assumed.

Information that is specified (display message change definition parameter)

As shown in the following figure, the definition parameter for changing the display message consists of a definition block and an event condition block.

Figure 2‒9: Definition parameter for changing the display message

[Figure]

Multiple definition blocks can be specified. The number of definition blocks that can be specified is from 0 to 3,000. If the number of definition blocks exceeds the maximum, message KAVB4640-W is output, and processing continues, ignoring the definition blocks after number 3,000.

def to end-def (definition block)

These are the start and end parameters for a display message change definition. The block from def to end-def can be omitted, in which case the system assumes that messages are not to be changed for any JP1 events.

After def, specify the names of display message change definitions. If you specify defΔdefinition-1Δdefinition-2Δ, then Δdefinition-1Δdefinition-2Δ are treated as the definition names (Δ indicates a single-byte space).

For a definition name, specify a character string of from 1 to 50 bytes. Each definition name must be unique within the display message change definition file. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

cmt comment

Describes the comment for the display message change definition. The comment specified for cmt is displayed in the comment section of the Display Message Change Definition Settings window. Only one cmt parameter can be specified in the definition block. This parameter can be omitted. Specify the comment using up to 1,024 bytes. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

define {enable | disable}

Specifies whether to enable the display message change definition. Only one define parameter can be specified in the definition block. To enable the display message change definition, specify enable, to disable it, specify disable. The define parameter can be omitted. By default, enable is set. The values are not case sensitive.

addflag {true | false}

Indicates an additional display message change definition has been added from a window, and specifies whether the display message change definition is an additional display message change definition. Therefore, to edit the additional display message change definition file, you do not need to specify the addflag parameter. Only one addflag parameter can be specified in the definition block. Specify true for the additional display message change definition, and false for the display message change definition. When true is specified, the icon ([Figure]) is displayed in Type of the View Display Message Change Definition window. The addflag parameter can be omitted. By default, false is set. The values are not case sensitive.

cnd to end-cnd (event condition block)

These are the start and end parameters for the block that specifies a condition for the JP1 events whose display message is to be changed. You must specify at least one event condition block in a definition block. The event condition block cannot be omitted. If a received JP1 event satisfies multiple event conditions, the definition block closest to the beginning of the display message change definition file is used. Tabs and spaces before and after the cnd and end-cnd parameters are ignored.

event-condition

Specifies a condition for the JP1 events whose display message is to be changed. You can specify from 1 to 256 event conditions per event condition block. When multiple event conditions are specified, it is assumed that they are connected with the AND condition. Specify an event condition in the following format (Δ indicates a single-byte space):

attribute-nameΔcomparison-keywordΔoperand[Δoperand]...

Note that a line consisting of only spaces or tabs is ignored during processing.

attribute-name

Specifies the name of the attribute that you want to compare. To specify a basic attribute, place B. immediately before the name. To specify an extended attribute (common information or user-specific information), place E. immediately before the name. Uppercase and lowercase are distinguished.

The following table lists and describes the combinations of attribute names and comparison keywords and the operands that can be specified.

Table 2‒71: Combinations of attribute names and comparison keywords and the operands that can be specified

No.

Item

Attribute name

Comparison keyword

Operand

1

Event ID

B.ID

  • Match

  • Does not match

A maximum of 100 of these items can be specified.

Specify the event ID in hexadecimal notation. Letter case is ignored.

The permitted range is from 0 to 7FFFFFFF.

2

Reason for registration

B.REASON

  • Match

  • Does not match

A maximum of 100 of these items can be specified.

3

Source process ID

B.PROCESSID

  • Match

  • Does not match

A maximum of 100 of these items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

4

Source user ID

B.USERID

  • Match

  • Does not match

A maximum of 100 of these items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

5

Source group ID

B.GROUPID

  • Match

  • Does not match

A maximum of 100 of these items can be specified.

The permitted range is from -2,147,483,648 to 2,147,483,647.

6

Source user name

B.USERNAME

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

7

Source group name

B.GROUPNAME

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

8

Event-issuing server name (source host)#1

B.SOURCESERVER

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

9

Destination event server name#1

B.DESTSERVER

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

10

Message

B.MESSAGE

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

11

Severity

E.SEVERITY

Match

Multiple items can be specified, unless a regular expression is used, in which case only one item is allowed. Only the following values can be specified: Emergency, Alert, Critical, Error, Warning, Notice, Information, or Debug.

12

User name

E.USER_NAME

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

13

Product name

E.PRODUCT_NAME

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

14

Object type

E.OBJECT_TYPE

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

15

Object name

E.OBJECT_NAME

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

16

Root object type

E.ROOT_OBJECT_TYPE

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

17

Root object name

E.ROOT_OBJECT_NAME

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

18

Object ID

E.OBJECT_ID

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

19

Occurrence

E.OCCURRENCE

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

20

Result code

E.RESULT_CODE

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

21

Event source host name#1

E.JP1_SOURCEHOST

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

22

Program-specific extended attribute#2

E.xxxxxxx

  • First characters

  • Match

  • Does not match

  • Is contained

  • Is not contained

  • Regular expression

For the attribute name, you can specify a name with a maximum length of 32 bytes that begins with an uppercase letter and consists of uppercase letters, numeric characters, and the underscore (_).

A maximum of 100 of these items can be specified, unless a regular expression is used, in which case only one item is allowed.

#1

If the integrated monitoring database and the IM Configuration Management database are enabled, and the comparison keyword is Match or Do not match, the business group name can be specified in a path format.

If the integrated monitoring database and the IM Configuration Management database are disabled, and a comparison keyword other than Match and Do not match is selected, a business group name specified in a path format is treated as a host name.

If the -ignorecasehost option of the jcoimdef command is set to ON, and a comparison keyword other than Regular expression is selected, the character string is no longer case sensitive.

#2

You can also specify a JP1 product-specific extended attribute. For example, the program-specific extended attribute for the JP1/AJS job execution host is E.C0. For details about the product-specific extended attributes, consult the documentation for the products that issue JP1 events.

comparison-keyword

Specifies one of BEGIN (begins with), IN (matches), NOTIN (does not match), SUBSTR (includes), NOTSUBSTR (does not include), or REGEX (regular expression) as the comparison keyword. The comparison keyword is case sensitive.

operand

Specifies a character string as the value that is to be compared with the attribute value as specified by the comparison keyword. Operands are case sensitive.

Separate multiple operands with one or more consecutive spaces or a tab. The OR condition is applied to the specified operands. Note that if a regular expression is specified, only one operand can be specified.

To specify a single-byte space, a tab, end-of-line code (CR or LF), or % as part of an operand, specify as follows:

No.

Value to be set

How to specify

1

Tab (0x09)

%09

2

Space (0x20)

%20

3

% (0x25)

%25

4

Linefeed code LF (0x0a)

%0a

5

Carriage return code CR (0x0d)

%0d

During maximum value checking for the definition format, %20 and %25 are each treated as a single character. The character code specified after the % is not case sensitive. The following shows an example of defining ID matches 100 and 200, which selects multiple operands:

B.IDΔINΔ100Δ200

Legend: Δ indicates a single-byte space (0x20)

You can specify a maximum of 4,096 bytes of operands per event condition and per event condition block (total length of operands in bytes that are specified in the event condition block).

msg

This parameter describes the message to be displayed.

You must specify one msg parameter in a definition block. The parameter cannot be omitted.

The msg parameter cannot exceed 1,023 bytes. The permitted characters are all characters other than the control characters (from 0x00 to 0x1F and 0x7F to 0x9F).

If a msg parameter is specified outside of the definition block, message KAVB4629-W is output, the msg parameter specification is ignored, and processing continues.

In the circumstances listed below, message KAVB4631-W is output, and processing continues, ignoring the definition block that produced the error.

  • The msg parameter is omitted

  • The msg parameter is specified more than once

  • The message specified in the msg parameter exceeds 1,023 bytes

  • The message specified in the msg parameter includes control characters

To specify a variable in the message after the change, use a format such as $EVSEV. The variable will be replaced with the actual value of the attribute value in the event.

The following table describes the available variables.

Type of information

Variable name

Description

Information contained in the basic attributes of JP1 events

EVBASE

Entire basic event information#1

EVID

Event ID (basic-code:extended-code)

EVIDBASE

Event ID (basic code)

EVDATE

Event registration date (YYYY/MM/DD)#2

EVTIME

Event registration time (hh:mm:ss)#2

EVPID

Event source process ID

EVUSRID

User ID of the event source process

EVGRPID

Group ID of the event source process

EVUSR

Event source user name

EVGRP

Event source group name

EVHOST

Event source host name

EVIPADDR

Event source IP address

EVSEQNO

Serial number

EVARVDATE

Event arrival date (YYYY/MM/DD)#2

EVARVTIME

Event arrival time (hh:mm:ss)#2

EVSRCNO

Serial number at the event source

EVMSG

Entire message text#3

EVDETAIL

Entire detailed event information#3, #4

Information contained in the extended attributes of JP1 events

EVSEV

Severity levels in extended event information (Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug)#3

EVUSNAM

User name#3

EVOBTYP

Object type#3

EVOBNAM

Object name#3

EVROBTYP

Registration type#3

EVROBNAM

Root object name#3

EV"PRODUCT_NAME"

Product name#5

EV"OBJECT_ID"

Object ID#5

EV"OCCURRENCE"

Occurrence#5

EV"START_TIME"

Start time#5

EV"END_TIME"

End time#5

EV"RESULT_CODE"

Return code#5

EV"JP1_SOURCEHOST"

Issuing host name#5

EV"extended-attribute-name"

Any extended attribute#5

Other

EV"@JP1IM_CORRELATE"

Correlation event flag

  • Not a correlation event: 0

  • Correlation approval event: 1

  • Correlation failure event: 2

EV"@JP1IM_ORIGINAL_SEVERITY"

Severity levels in extended event information (before change)

(Emergency, Alert, Critical, Error, Warning, Notice, Information, Debug)#3

EV"@JP1IM_CHANGE_SEVERITY"

New severity level flag

  • Severity is not changed: 0

  • Severity is changed: 1

ACTHOST

Value of the manager host name#3

EVENV1 to EVENV20

Data obtained by specifying parantheses (()) in a regular expression in the specification of an event condition#5

(applicable only when an extended regular expression is used at the manager host)

#1

The basic information of a JP1 event is converted to the following format and passed to the message after the change (Δ indicates a single-byte space):

event-ID Δ event-source-user-name Δ event-source-user-ID Δ event-source-group-name Δ event-source-group-ID Δ event-source-event-server-name Δ event-source-process-ID Δ event-registration-date Δ event-registration-time Δ event-source-host-IP-address

An item that is not set is replaced with the null character.

#2

This attribute value is converted using the time zone set for JP1/IM - Manager and is passed to the message after the change.

#3

When the message is changed, if the applicable attribute does not exist, the variable is converted to a null character and passed to the message after the change.

#4

When detailed attribute information for a JP1 event is in binary format, the variable is converted to a null character and passed to the message after the change.

#5

If the applicable attribute does not exist, the character string of the variable is passed as-is to the message after the change.

Notes about specifying variables

Conversion functions for inherited event information

# comment-line

A line beginning with a hash mark (#) is treated as a comment. Note that the comment will be deleted if the display message change definition is set from JP1/IM - View.

Example definition

If the event ID matches 100 or 200, the severity is Warning, and the source host matches hostA, hostB, or hostC, change the message to A failure occurred in the database server, with the date and time prepended to the beginning of the message.

DESC_VERSION=1
def display-message-change-1
    cmt comment1
    define enable
    addflag false
    cnd
        B.ID IN 100 200
        E.SEVERITY IN Warning
        B.SOURCESERVER IN hostA hostB hostC
    end-cnd
    msg $EVDATE $EVTIME A failure occurred in the database server
end-def

The following example extracts the message ID and message text portions from the Hntr log.

DESC_VERSION=1
def display-message-change-1
    cmt comment1
    define enable
    addflag false
    cnd
        E.OBJECT_TYPE IN LOGFILE
        E.OBJECT_NAME SUBSTR HNTRLib2
        E.ROOT_OBJECT_TYPE IN LOGFILE
        E.PRODUCT_NAME IN /HITACHI/JP1/NT_LOGTRAP
        B.MESSAGE REGEX [0-9]{4}%20[0-9]{4}/[0-9]{2}/[0-9]{2}%20[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}[%20]+.*[%20]+[0-9A-Z]+%20[0-9A-Z]+[%20]+([^%20]+)[%20]+(.*)
    end-cnd
    msg $EVENV1 $EVENV2
end-def

The following example prepends a character string to the beginning of all messages for a particular product.

DESC_VERSION=1
    def display-message-change-1
    cmt comment1
    define enable
    addflag false
    cnd
        E.PRODUCT_NAME IN PRODUCT_A
    end-cnd
    msg [Product A]$EVMSG
end-def