Hitachi

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


Configuration file for incident inheritance information (incident_info.conf)

Organization of this page

Format

[@encode UTF-8]
#item-field-ID=value-to-be-set-for-the-item
JP1/Service-Support-item-element-ID=value-passed-to-item-element[end-of-line-character]

File

incident_info.conf (Configuration file for incident inheritance information)

incident_info.conf.model (Model file for the configuration file for incident inheritance information)

Storage directory

In Windows:
Physical hosts:

Console-path\conf\console\incident\

Logical hosts:

shared-folder\jp1cons\conf\console\incident\

In UNIX:
Physical hosts:

/etc/opt/jp1cons/conf/console/incident/

Logical hosts:

shared-directory/jp1cons/conf/console/incident/

Description

Attributes or character strings of a JP1 event can be inherited as an incident in JP1/Service Support. This file defines which attributes or character strings of a JP event are mapped to which item elements of the New item window in JP1/Service Support.

When the definitions are applied

The settings edited in the configuration file for incident inheritance information take effect when you log in to JP1/IM - Manager (Central Console) with JP1/IM - View after setting the incident registration mode to 3 and then executing the jco_spmd_reload command or restarting JP1/IM - Manager.

Information that is specified

[@encode UTF-8]

Specifies the character encoding of the configuration file for incident inheritance information. The @encode statement must be on the first line. When the @encode statement does not exist, the character encoding of the manager is used. The acceptable character encoding is UTF-8. When the specified character encoding is UTF-8, the character encoding of the configuration file is set to UTF-8.

The error message KAVB1115-W is issued and the character encoding of the manager is used when any of the following conditions is true:

  • The configuration file does not begin with @encode.

  • @encode is not followed by a character encoding value.

The error message KAVB1119-W is issued and the character encoding of the manager is used when the following condition is true:

  • The specified character encoding is not UTF-8.

The managers use the following character encodings:

In Windows:

One of the following character encodings is used depending on the system locale:

Japanese: MS932 (Note that available characters are limited to SJIS characters.)

English: C

Chinese: GB18030

Any encoding other than Japanese or Chinese: C

In UNIX:

The character encoding depends on the value of the LANG environment variable specified in the /etc/opt/jp1cons/conf/jp1co_env.conf file.

#comment-line

A line beginning with a hash mark (#) is treated as a comment.

JP1/Service-Support-item-element-ID=value-passed-to-item-element[end-of-line-character]

Specifies which attributes or character strings of a JP1 event that are inherited as incidents are mapped to which item elements of the New item window in JP1/Service Support.

JP1/Service-Support-item-element-specification-ID

Specifies an item element specification ID in JP1/Service Support. If there are multiple occurrences of the same ID, the first occurrence takes precedence. For details about item element specification IDs, see the manual JP1/Service Support Configuration and Administration Guide.

value-passed-to-item-element[end-of-line-character]

Specifies any character strings or variables. You can specify as many multiple variables as you need.

A character string can consist of any characters other than control characters. When you include a control character (0x00 to 0x0F, 0x14 to 0x1F, or 0x7F), the character is replaced with a space (0x20). To use a dollar sign ($) as a literal character, place an escape character \ immediately before the dollar sign ($). To break a line, specify \n on the point where you want to break the line. To use \n as literal characters, specify \\n.

The following table describes how to specify a variable.

Table 2‒49: How to specify a variable

Format

Description

$variable-name

A variable must be specified in the following format: $variable-name. For details about specific variable names of JP1 event attributes, see Table 2-51 Variables that can be specified for JP1/Service Support item elements.

${variable-name}

A variable name must be enclosed in curly brackets ({}) when the variable name is directly followed by an alphanumeric character or an underscore (_).

$variable-name$URLENC

${variable-name$URLENC}

The attribute value is URL-encoded with UTF-8 character encoding.

$variable-name$ENC

${variable-name$ENC}

The attribute value is Base64-encoded.

$variable-name$ENC$URLENC

${variable-name$ENC$URLENC}

The attribute value is Base64-encoded and then URL-encoded.

The following table lists the examples of specified variables. These examples assume that the value of the event ID ($EVID) is 100:0 and the value of the EX extended attribute ($EV"EX") is ABC.

Table 2‒50: Examples of specified variables

Specified variable

Converted value

$EVID abc

100:0 abc

$EVIDabc

In Windows

$EVIDabc

In UNIX

Converted to an empty string.

${EVID}abc

100:0abc

$EVID_abc

In Window

$EVID_abc

In UNIX

Converted to an empty string.

${EVID}_abc

100:0_abc

$EV"EX" abc

ABC abc

$EV"EX"abc

ABCabc

The table below lists variables that can be used to pass the attribute values. You can map any source attribute to any target element but you must ensure that the value of the source attribute matches the display format of the target element.

Table 2‒51: Variables that can be specified for JP1/Service Support item elements

Item

Information to be inherited

Variable name

Entire basic event information

Entire basic event information

EVBASE

Event ID (basic-code:extended-code)

Value of the event ID in the format basic-code:extended-code.

basic-code is the value of the event ID (B.ID). extended-code is the value of the event code (extended code) (B.IDEXT). Both basic-code and extended-code are an 8-digit hexadecimal number (where A-F are uppercase). Zeros preceding the ID are omitted. When the extended code is 00000000, the value of the variable is basic-code:0.

EVID

Event ID (basic-code)

8-digit hexadecimal number representing the event ID (basic code) (where A-F are uppercase). Zeros preceding the ID are omitted.

EVIDBASE

Event registration date

Character value of the registration time (B.TIME) in the following format: yyyy/mm/dd

EVDATE

Event registration time (hh:mm:ss)

Character value of the registration time (B.TIME) in the following format: hh:mm:ss

EVTIME

Event source process ID

Value of B.PROCESSID

EVPID

User ID of the event source process

Value of B.USERID

EVUSRID

Group ID of the event source process

Value of B.GROUPID

EVGRPID

Event source user name

Value of B.USERNAME

EVUSR

Event source group name

Value of B.GROUPNAME

EVGRP

Event source server name

Value of B.SOURCESERVER

Only when the event source host mapping is disenabled

EVHOST

Event source IP address

Value of B.SOURCEIPADDR

EVIPADDR

Event database serial number

Value of B.SEQNO

EVSEQNO

Event arrival date

Character value of the arrival time (B.ARRIVEDTIME) in the following format: yyyy/mm/dd

EVARVDATE

Event arrival time

Character value of the arrival time (B.ARRIVEDTIME) in the following format: hh:mm:ss

EVARVTIME

Event database serial number at the event source

Value of B.SOURCESEQNO

EVSRCNO

Message

Value of B.MESSAGE

EVMSG

Detailed information

Character value of the detailed information (B.DETAIL) in the following format: informaion-1Δinformaion-2Δinformaion-3Δ...informaion-nΔ (where Δ indicates a space)

EVDETAIL

Severity level

Value of E.SEVERITY

EVSEV

User name

Value of E.USER_NAME

EVUSNAM

Object type

Value of E.OBJECT_TYPE

EVOBTYP

Object name

Value of E.OBJECT_NAME

EVOBNAM

Root object type

Value of E.ROOT_OBJECT_TYPE

EVROBTYP

Root object name

Value of E.ROOT_OBJECT_NAME

EVROBNAM

Product name

Value of E.PRODUCT_NAME

EV"PRODUCT_NAME"

Object ID

Value of E.OBJECT_ID

EV"OBJECT_ID"

Occurrence

Value of E.OCCURRENCE

EV"OCCURRENCE"

Start time

Value of E.START_TIME

EV"START_TIME"

End time

Value of E.END_TIME

EV"END_TIME"

Return code

Value of E.RESULT_CODE

EV"RESULT_CODE"

Event source host name

Value of E.JP1_SOURCEHOST

Only when the event source host mapping is enabled

EV"JP1_SOURCEHOST"

Any extended attribute

Value of a named extended attribute

EV"extended-attribute-name"

Correlation event flag

Value of E.@JP1IM_CORRELATE

Not a correlation event: 0

Correlation approval event: 1

Correlation failure event: 2

Only when the correlation event generation function is enabled and the integrated monitoring database is enabled

EV"@JP1IM_CORRELATE"

Original severity level

Value of E.@JP1IM_ORIGINAL_SEVERITY

Only when the severity changing function is enabled

EV"@JP1IM_ORIGINAL_SEVERITY"

New severity level flag

Value of E.@JP1IM_CHANGE_SEVERITY

Severity is not changed: 0

Severity is changed: 1

Only when the severity changing function is enabled

EV"@JP1IM_CHANGE_SEVERITY"

Changed display message

Value of E.@JP1IM_DISPLAY_MESSAGE

Only when the display message change function is enabled

EV"@JP1IM_DISPLAY_MESSAGE"

New display message flag

Value of E.@JP1IM_CHANGE_MESSAGE

Message is not changed: 0

Message is changed: 1

Only when the display message change function is enabled

EV"@JP1IM_CHANGE_MESSAGE"

Memo

Value of E.@JP1IM_MEMO

An attribute that is set after memo is set

EV"@JP1IM_MEMO"

Common exclude conditions group ID

Value of E.JP1_IMCOMEXCLUDE_ID

Only when the extended mode of common exclusion is enabled and the integrated monitoring database is enabled

EV"JP1_IMCOMEXCLUDE_ID"

Common exclude conditions group name

Value of E.JP1_IMCOMEXCLUDE_NAME

Only when the extended mode of common exclusion is enabled and the integrated monitoring database is enabled

EV"JP1_IMCOMEXCLUDE_NAME"

Common exclude conditions group target-for-exclusion

Value of E.JP1_IMCOMEXCLUDE_TARGET

Only when the extended mode of common exclusion is enabled and the integrated monitoring database is enabled

EV"JP1_IMCOMEXCLUDE_TARGET"

When a variable name other than those listed above is specified, the statement including the variable is not replaced with event information. For example, when you use the variable AAA to compose the statement $AAA, the literal characters $AAA are passed to the New item window in JP1/Service Support.

When the value of an attribute that is specified in EV"extended-attribute-name" is not available, the statement including the variable is not replaced with event information. For example, when you specify the statement $EV"BBB" but the JP1 event does not have the extended attribute BBB, the literal characters $EV"BBB" are passed to the New item window in JP1/Service Support.

When the value of an attribute that is specified in a statement other than EV"extended-attribute-name" is not available, the statement including the variable is replaced with an empty string. For example, when you specify the statement $EVSEV but the JP1 event does not have the extended attribute SEVERITY, "" (an empty string) is passed to the New item window in JP1/Service Support.

Example definition

To show "Event that occurred on event-source-host name (IP-address): event-ID" in the Title element of the New item window in JP1/Service Support (only when the event source host mapping is enabled):
TITLE=Event that occurred on $EV"JP1_SOURCEHOST" ($EVIPADDR): $EVIDBASE
To show a URL link (by URL-encoding the attribute value with UTF-8 character encoding) in the Related information element of the New item window in JP1/Service Support:
LINKURL=http://host/page?msg=$EVMSG$URLENC