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:
-
Display message change definition file version
Defines the format version of the display message change definition file.
-
Display message change definition parameter
Defines a condition for the JP1 events whose display message is to be changed and the display message after the change. The higher a display message change definition appears in the display message change definition file, the higher its priority.
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:
-
JP1/IM - Manager is restarted
-
The jco_spmd_reload command is executed
-
The OK button is clicked in the Add Display Message Change Definition Settings window opened from the Display Message Change Definition Settings menu
-
The Apply button is clicked in the View Display Message Change Definition window
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.
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 () 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‒72: 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.
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)
-
Notes about specifying variables
-
If you want to specify $ as a character, specify the escape character \ before the $.
-
If you specify a character, such as an alphanumeric character or an underscore (_), immediately after the variable name, the variable will not be converted correctly. In such a case, enclose the variable name in curly brackets ({ }), as shown in the examples below. These examples assume that 100:0 is specified as the event ID ($EVID) and ABC is specified as the extended attribute EX ($EV"EX").
Examples:
display-message-change-definition -> information-after-conversion
$EVID abc -> 100:0 abc
$EVIDabc -> $EVIDabc
${EVID}abc -> 100:0abc
$EVID_abc -> $EVID_abc
${EVID}_abc -> 100:0_abc
$EV"EX" abc -> ABC abc
$EV"EX"abc -> ABCabc
-
If a non-variable name is specified, no information will be converted at that location. For example, if you specify $AAA but there is no variable AAA, $AAA will be set in the message after the change.
-
If the value of the attribute specified in EV"extended-attribute-name" or EVENV1 to EVENV20 cannot be acquired, no information will be converted at that location. For example, if $EV"BBB" is specified but the JP1 event has no extended attribute BBB, $EV"BBB" will be set in the message after the change.
-
If the value of the attribute specified in a variable other than EV"extended-attribute-name" or EVENV1 to EVENV20 cannot be acquired, the variable will be converted to the null character at that location. For example, if $EVSEV is specified but the JP1 event has no extended attribute SEVERITY, the null character will be set in the message after the change.
-
When there is more than one event condition that uses a regular expression, and when there is more than one set of parentheses (()) in a regular expression, the data captured in parentheses is associated with variables EVENV1 to EVENV20 in a nested sequential manner, proceeding from left to right within each regular expression, and then through each event condition in series.
Conversion functions for inherited event information
-
Inherited event information can be converted into character strings of a user-specified length. This makes it possible to display lists of message IDs, dates, and so on in an easy-to-read format where the data is aligned in a fixed-length field.
If the length of the inherited event information is less than the length specified by the user, single-byte spaces are added to make it the specified length.
If the length of the inherited event information is greater than the length specified by the user, the information is truncated to make it fit the length specified by the user.
When multi-byte characters are truncated, the truncation is performed in such a way that characters are not broken. If the length after truncation is less than the length specified by the user, a single-byte space is added.
Specification format:
$variable-name$FIXLEN=number-of-bytes
Specify a numeric value from 1 to 1,023 for number-of-bytes. If the specification format is incorrect, $FIXLEN=number-of-bytes will be treated as a character string.
By enclosing variable-name in curly brackets ({}), you can explicitly specify the material to be treated as part of the parameter.
No.
Specification format
Character string in $variable-name
Character string set in message
Remarks
1
$variable-name$FIXLEN=6
ABC
ABCΔ
Because the character string is shorter than the specified length, single-byte spaces are added to compensate.
2
ABCDEFG
ABCDEF
Because the character string exceeds the specified length, it is truncated.
3
$variable-name$FIXLEN=1024
ABC
ABC$FIXLEN=1024
Because the specified value exceeds the maximum value of 1023, it is treated as a character string.
4
$variable-name$FIXLEN=10225
ABC
ABCΔ ... Δ 5, where
Δ ... Δ represents 1,019 Δ characters
Only the first four characters in the character string after $FIXLEN= are considered part of the parameter, so the fifth and subsequent characters are treated as a character string.
5
${variable-name$FIXLEN=10}235
ABC
ABCΔ235
The material in the curly brackets ({}) through 10 is treated as the parameter, and 235 is treated as a character string.
-
It is possible to align the number of digits of numerical values to be displayed in the message by padding the value with zeros. This can be used when you want to convert the numeric value representing seconds to a format such as ss, ss.sss, or ss.ssssss.
Specification format:
$variable-name$FIXNUM=00.000000
You can specify 0 to 2 digits for the integer portion and 0 to 6 digits for the decimal portion.
This conversion is also possible when the value stored in the variable is a character string representation of a numeric value.
When a character string representing a non-numeric value is set, no conversion is performed if the integer portion exceeds the specified number of digits, or the value stored in the variable is greater than or equal to 100.
When the decimal portion exceeds the specified number of digits, the excess decimal places are truncated. Truncation is also performed whenever 7 or more decimal places are set in the value stored in the variable.
No.
Specification format
Character string in $variable-name
Character string set in message
Remarks
1
$variable-name$FIXNUM=00.000
1
01.000
The integer and decimal portions are padded with zeros.
2
123.123456
123.123456
No conversion is performed because the value is greater than or equal to 100.
3
$variable-name$FIXNUM=0.00
15
15.00
The integer portion is not converted because it exceeds the specified number of digits (1).
4
$variable-name$FIXNUM=00
1
01
The integer portion is padded with zeros.
5
1.5
01
The decimal portion exceeds the specified number of digits, so the excess decimal places are truncated.
6
$variable-name$FIXNUM=00.000000
0.1234567
00.123456
The 7th and subsequent decimal places are truncated.
7
$variable-name$FIXNUM=.00
1
1.00
The decimal portion is padded with zeros.
8
$variable-name$FIXNUM=00.
1
01
The integer portion is padded with zeros.
9
$variable-name$FIXNUM=ABC
1
1$FIXNUM=ABC
The invalid $FIXNUM specification is treated as a character string.
10
$variable-name$FIXNUM=0.00
ABC
ABC
No conversion is performed because the value in $variable-name is non-numeric.
11
0.0000000A
0.0000000A
-
The number of seconds elapsed since 1970/01/01 is converted to character strings representing the year, month, day, hour, minute, and seconds.
The conversion uses the time zone of the manager host.
No conversion is performed unless the value stored in the variable is a character string representing a numeric value from 0 to 2,147,483,647.
No.
Specification format
Conversion
1
$variable-name$YEAR
Converts the number of seconds elapsed since 1970/01/01 to a year.
After conversion, the value is output in the format YYYY. The year to be output is padded with zeros as necessary to make it 4 digits.
2
$variable-name$MONTH
Converts the number of seconds elapsed since 1970/01/01 to a month
After conversion, the value is output in the format MM. The month to be output is padded with zeros as necessary to make it 2 digits.
3
$variable-name$DAY
Converts the number of seconds elapsed since 1970/01/01 to a day.
After conversion, the value is output in the format DD. The day to be output is padded with zeros as necessary to make it 2 digits.
4
$variable-name$HOUR
Converts the number of seconds elapsed since 1970/01/01 to an hour.
After conversion, the value is output in the format hh. The hour to be output is padded with zeros as necessary to make it 2 digits.
The hour value is output in 24-hour format.
5
$variable-name$MIN
Converts the number of seconds elapsed since 1970/01/01 to a minute.
After conversion, the value is output in the format mm. The minutes value to be output is padded with zeros as necessary to make it 2 digits.
6
$variable-name$SEC
Converts the number of seconds elapsed since 1970/01/01 to seconds.
After conversion, the value is output in the format ss. The seconds value to be output is padded with zeros as necessary to make it 2 digits.
-
Successive format conversion functions can be specified.
If you specify a succession of format conversion functions, the format conversions will be performed from left to right in the order specified.
Even if the previous format conversion fails, subsequent conversion processing is performed.
Figure 2‒10: Successive format conversions
- # 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