Definition file for opening monitor windows

Format

[@encode character-encoding]
DESC_VERSION=0300
{key-definition(SUBKEY parameter is used)
subkey-definition
association-definition
|key-definition(INTERFACE parameter is used)}
call-interface-definition

To Page Top

File

hitachi_xxxx_mon.conf

(definition file for opening monitor windows for a linked product)

company-name_product-name_mon.conf

(user-defined definition file for opening monitor windows)

company-name_series-name_product-name_mon.conf

(user-defined definition file for opening monitor windows)

To Page Top

Storage directory

In Windows

For a physical host:

Console-path\conf\console\monitor\

For a logical host:

shared-folder\jp1cons\conf\console\monitor\

In UNIX

For a physical host:

/etc/opt/jp1cons/conf/console/monitor/

For a logical host:

shared-directory/jp1cons/conf/console/monitor/

To Page Top

Description

This definition file is used to define settings for calling monitor windows (such as a monitor window at an event source) from the Integrated Operation Viewer window of Intelligent Integrated Management Base, or the Event Console window of Central Console. Use this file to create a key from information such as the event ID and attributes, and a command line parameter from the event attributes.

The encoding defined in the definition file for calling monitor windows must be UTF-8 for JP1/IM - Manager for Linux and Shift-JIS or EUCJIS for JP1/IM - Manager for an OS other than Linux. Because, hitachi is used for the default file name, use a name other than hitachi for company-name.

If hitachi is specified for the company name in a definition file for opening monitor windows, this definition file contains system standard definition information, and therefore a user cannot create, change, or delete the file.

JP1/IM provides the jcomonitorfcheck command for checking the contents of the definition file for opening monitor windows.For details about this command, see jcomonitorfcheck in Chapter 1. Commands.

To Page Top

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted or when the jco_spmd_reload command is executed. Note that the changes made to the definition while the user is logged in to JP1/IM - View or the Intelligent Integrated Management Base, are not applied. You need to restart JP1/IM - View or the Intelligent Integrated Management Base to apply the change.

To Page Top

Information that is specified

@encode

Specifies the character encoding that is to be used in the definition file for opening monitor windows. This item is optional.

To create an additional file for definition file for opening monitor windows, use an @encode statement to specify the character set for the definition file.

Item names will be expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for opening monitor windows will be saved in the character encoding specified in the @encode statement.

In the following circumstances, item names displayed in JP1/IM - View or the Integrated Operation Viewer window, might be garbled:

• If the item name uses characters that cannot be represented in the character encoding specified in the @encode statement

• If the character encoding specified in the @encode statement does not match the character encoding in which the file was saved

If no @encode statement exists or if there is an error in the specified character set name that follows the @encode statement, the character set is determined automatically. However, depending on the contents of the definition file, the character encoding might not be determined correctly.

The specifiable character encodings are as follows:

• C

• EUCJIS

• SJIS

• UTF-8

• GB18030

Note

If you use UTF-8 as the encoding to save a definition file, save the file without attaching a BOM (byte order mark).

An error is output in the following cases:

• A character encoding other than C, EUCJIS, SJIS UTF-8 or GB18030 is specified

• The definition file does not begin with @encode.

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

Note

If you use a definition file for extended event attributes provided by another product, make sure the character encoding specified in the @encode statement matches the character encoding used in the definition file. In addition, if you will be transferring definition files, do not convert the character encoding of the definition files.

DESC_VERSION=0300

This is the table version record.

key-definition

Defines a fixed key in the event attributes that is to be used when a monitor window is opened. The key consists of three items:

• Event ID

• Product name

• Version

The combination of these attributes defines a link to operations and subkeys.

Format

DEF_KEY PRODUCT_NAME="product-name"

EVENT_ID=event-ID

[VERSION=version|ALL]

{SUBKEY=subkey

|INTERFACE=interface-name}

Arguments

• PRODUCT_NAME="product-name"

Specifies a product name as a character string, such as /HITACHI/JP1/AJS. This value must be the same as a value that is set in a PRODUCT_NAME extended attribute.

• EVENT_ID=event-ID

Specifies only the base part of an event identifier, expressed as eight hexadecimal characters. The extended part is ignored. If you need to include the extended part set for a JP1/SES event, use a subkey.

• VERSION=version

Specifies a version. The version specified in this argument is compared with the ACTION_VERSION JP1 event extended attribute. The version can be expressed in numeric characters (from 0 to 9), alphabetic characters (A to Z), the forward slash (/), and the hyphen (-). The alphabetic characters are not case sensitive.

Specify a single version as a string of no more than 8 bytes. To specify a range of versions, separate the start version from the end version with a hyphen (-). In this case, there must be at least one space preceding and following the hyphen.

The version specified here cannot duplicate any version specified in any other key definition.

• SUBKEY=subkey

Specifies the name of a subkey. This parameter and the INTERFACE parameter are mutually exclusive.

If you specify the SUBKEY parameter, you need the subkey definition corresponding to the subkey name specified for SUBKEY, and the association definition.

• INTERFACE=interface-name

Specifies an interface name. For the key to define, specify only one interface that is to be used when the monitor window opens. This parameter and the SUBKEY parameter are mutually exclusive.

If you specify the INTERFACE parameter, you cannot use the subkey definition and association definition.

Notes:

The versions are compared in ascending order. If the start version is greater than the end version, that key definition is ignored even though no error is issued.

The value specified in PRODUCT_NAME must be the same as the value specified in a PRODUCT_NAME JP1 event extended attribute.

subkey-definition

When the monitor window is opened, the subkey definition is linked from the fixed key and registers the event attributes as the key.

Format

DEF_SUBKEY

NAME=subkey-name

KEYS=attribute-name-1 [, attribute-name-2[,attribute-name-3[,attribute-name-4]]]

Arguments

• NAME=subkey-name

Specifies a name for the subkey, expressed using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

• KEYS=attribute-name-1 [,attribute-name-2 [,attribute-name-3 [,attribute-name-4]]]

Specifies attribute names. The following table shows the specification formats of the attribute names.

Table 2‒67: Specification formats of the attribute names

Specification format	Value format	Description
B.ARRIVEDTIME	13-digit decimal character string	Arrived time (time in milliseconds since UTC 1970-01-01 at 00:00:00)
B.DESTSERVER	Character string	Target event server name
B.GROUPNAME	Character string	Source group name
B.IDBASE	8 hexadecimal characters	Base part of the event ID
B.IDEXT	8 hexadecimal characters	Extended part of the event ID
B.PROCESSID	Decimal character string	Source process ID
B.SEQNO	Decimal character string	Sequence number in the database
B.SOURCESEQNO	Decimal character string	Sequence number by source
B.SOURCESERVER	Character string	Event-issuing server name
B.TIME	13-digit decimal character string	Registered time (time in milliseconds since UTC 1970-01-01 at 00:00:00)
B.USERNAME	Character string	Source user name
B.MESSAGE	Character string	Message
E.JP1_SOURCEHOST#	Character string	Event source host name
E.xxxxxxx	Character string	Extended attribute

#

A business group name cannot be used for the event-issuing server name (B.SOURCESERVER) and the event source host name (E.JP1_SOURCEHOST). If a business group name is specified, it is treated as a host name.

association-definition

Defines the association between subkey values and the interface.

Format

DEF_IF_RELATION

SUBKEY_NAME=subkey-name

{ VALUE1="attribute-value-1"[[ VALUE2="attribute-value-2"]...]

|KEY_DEFAULT }

IF_NAME=interface-name

Arguments

• SUBKEY_NAME=subkey-name

Specifies the name of the subkey. Express the name using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

• VALUEn="attribute-value"

Specifies an attribute value and its sort order. Specify for n an integer in the range from 1 to 4 representing the sort order among the attributes specified in the KEYS parameter in the subkey definition. The key values must match exactly. A regular expression cannot be used for the value. For a list of the specifiable attributes and their specification formats, see the explanation of subkey-definition.

If any of the attributes, such as VALUE1, VALUE2, ..., does not match, the interface specified in KEY_DEFAULT is used for the corresponding JP1 event.

• KEY_DEFAULT

Specify this argument instead of VALUE1, VALUE2, ..., in order to create an association with the interface when there is not an exact match with the values specified in VALUE1, VALUE2, ....

• IF_NAME=interface-name

Specifies the name of the interface that is to be called when the subkey values match. Express the interface name using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

call-interface-definition

Defines the interface to be used when a monitor window is opened.

Format

DEF_MTR_CALL

NAME=interface-name

EXEC_ID=application-execution-definition-identifier

PATH="command-arguments"

[PARAM=attribute-name-1[,attribute-name-2...]]

Arguments

• NAME=interface-name

Specifies a name for the interface. Express the name using from 1 to 16 alphanumeric characters; no spaces or control characters can be used. This name is not case sensitive.

• EXEC_ID=application-execution-definition-identifier

Specifies the identifier for an application execution definition. You must specify an identifier defined in the definition file for executing applications on the viewer.

You can launch the default browser by specifying "default_browser" for the EXEC_ID parameter. If you specify "default_browser" for the EXEC_ID parameter, specify a URL for the PATH parameter.

Note that a character string beginning with jco_ cannot be used because it is reserved as the application execution definition identifier.

• PATH="command-arguments"

Specifies command arguments that are to be passed to the executable file specified in EXEC_ID. The command line is formed by the name of the executable file specified in EXEC_ID and the arguments specified here. For example, you would specify arg1 and arg2 in the PATH parameter to form the following command line:

"app.exe arg1 arg2"

You can also specify in the PATH parameter reserved keywords that will be replaced with values from the viewer's operating environment attributes and event attributes. The following lists and describes the specifiable substitute keywords.

Table 2‒68: Specifiable substitute keywords

Keyword	Substituted value
%JCO_JP1USER%	Central Console or the Intelligent Integrated Management Base are login user name
%JCO_INSTALL_PATH%#	Name of the viewer installation folder
%IM_EVC_PARAMETER_n%	Event attribute value specified in PARAM (n: integer of 1 or greater)
%IM_EVC_LANGUAGE%	Depending on the language environment, the language switches between Japanese and English.

#: In the Intelligent Integrated Management Base, the string is not substituted.

• PARAM=attribute-name-1 [,attribute-name-2...]

Specifies the names of event attributes whose values are to be set. Sequential numbers that begin with 1 are assigned to the attribute names. This sequence corresponds to n in the substitute keywords.

Separate multiple event attributes with the comma, as shown in the example below:

B.EXTID,E.A0

You can specify some of the basic attributes and extended attributes. For details about the specifiable attributes and their specification formats, see the explanation of subkey-definition.

To Page Top

Example definition

This example opens a monitor window from the JP1 event that traps the Windows event log:

Note:

In this example, a line number is assigned at the beginning of each line for explanatory purposes.

Line 1

Indicates the character encoding used for the definition file. In this example, the character encoding is UTF-8.

Line 2

DESC_VERSION=0300 means that the description format version of this file is 0300.

Lines 3 to 5

These are comment lines. We recommend that you include the scope of the operating version.

Line 6

This is a key definition record. It means that if the product name is /HITACHI/JP1/NTEVENT_LOGTRAP and the event ID is 00003A71, then the subkey SAMPLE is used to determine which monitor window is opened.

Line 7

This is a subkey definition record. It declares that the extended attributes PRODUCT_NAME and A5 (Windows event log ID) are used with the subkey name SAMPLE.

Line 8

This is an association definition record. It means that if the value of subkey E.A5 matches 8010, the interface NETM_DM is used to display the monitor window.

Line 9

This is a call interface definition record. It means that the interface name is NETM_DM and the argument netmdm_argument is passed to the command whose application execution definition identifier is HITACHI_NETM_DM, which is then executed.

To Page Top