Job Management Partner 1/Integrated Management - Manager Command and Definition File Reference

Definition file for opening monitor windows

Format

@encode character-encoding
DESC_VERSION=0300
key-definition
subkey-definition
association-definition
call-interface-definition

File

company-name_product-name_mon_en.conf

company-name_series-name_product-name_mon_en.conf

Storage directory

In Windows

Console-path\conf\console\monitor\
shared-folder\jp1cons\conf\console\monitor\ (logical host)

In UNIX

/etc/opt/jp1cons/conf/console/monitor/
shared-directory/jp1cons/conf/console/monitor/ (logical host)

Description

This definition file is used to define settings for calling monitor windows (such as a monitor window at an event source) from the Event Console window. 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.

In this definition file, hitachi cannot be specified in company-name.

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

When the definitions are applied

The definition takes effect after JP1/IM - Manager is restarted.

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.

The specifiable character encoding depends on the OS, as shown below.

Table 2-41 Specifiable character encoding

Character encoding OS

Windows Server 2003, Windows Server 2008 Solaris, AIX

C Y Y

Legend:

Y: Can be specified

N: Cannot be specified

An error is output in the following cases:

A character encoding other then C is specified.

The definition file does not begin with @encode.

@encode is not followed by a character encoding specification.

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.

INTERFACE=interface-name
Specifies an interface name. For the defined key, specify only one interface that is to be used when the monitor window is opened. This parameter and the SUBKEY parameter are mutually exclusive.

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-42 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.extended-attribute-name Character string Extended attribute
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.
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-43 Specifiable substitute keywords

Keyword Substituted value

%JCO_JP1USER% Central Console's login user name

%JCO_INSTALLPATH% 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% Language environment English

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.

Character encoding	OS
Windows Server 2003, Windows Server 2008	Solaris, AIX
C	Y	Y

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.extended-attribute-name	Character string	Extended attribute

Keyword	Substituted value
%JCO_JP1USER%	Central Console's login user name
%JCO_INSTALLPATH%	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%	Language environment English

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

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

Lines 2 to 4

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

Line 5

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 6

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 7

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 8

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.

[Contents][Back][Next]

[Trademarks]