Definition file for extended event attributes
- Organization of this page
Format
@encode character-encoding @file type="definition-file-type", version="definition-format-version"; @product name="product-name"; @define-block type="event-attr-def"; block lang = "language-type", platform="platform-type" attr name="attribute-name", title="display-item-name"[, type="attribute-display-type"]; ... @define-block-end; @define-block type="event-attr-group-def"; block platform="platform-type" group name="group-name", attrs="list-of-attribute-names"; ... @define-block-end; @define-block type="event-attr-order-def"; block platform="platform-type" order id="event-ID-definition-character-string", attrs="list-of-attribute-names"; ... @define-block-end;
File
The extension of a definition file for extended event attributes must be .conf (in lowercase).
default.conf (default definition file for extended event attributes)
hitachi_xxxx.conf (definition file for extended event attributes for a linked product)
company-name_product-name_attr.conf (user-defined definition file for extended event attributes)
company-name can be changed to series-name_product-name. We recommend that you use the value specified for PRODUCT_NAME at the time of JP1 event issuance as the file name, with the forward slash (/) replaced by the underscore (_). Because, hitachi is used for the default file name, use a name other than hitachi for company-name.
Storage directory
- In Windows
-
- For a physical host:
-
Console-path\conf\console\attribute\
- For a logical host:
-
shared-folder\JP1Cons\conf\console\attribute\
- In UNIX
-
- For a physical host:
-
/etc/opt/jp1cons/conf/console/attribute/
- For a logical host:
-
shared-directory/jp1cons/conf/console/attribute/
Description
A definition file for extended event attributes defines the order for sorting the event attributes and the attribute names that are to be displayed in the Event Details window.
The following table describes the four types of definition files for extended event attributes.
No. |
Type |
Description |
---|---|---|
1 |
Default file |
Definition of detailed event information about the basic attributes common to all events and the common information of extended attributes |
2 |
Extended file |
Definition of program-specific extended attributes |
3 |
File provided by a linked product |
Definition of program-specific information about the extended attributes of a linked product that issues JP1 events |
4 |
User-defined file |
User-specific information about user-defined extended attributes |
The two file types listed under No. 1 and No. 3 above are stored in the definition file storage directory of JP1/IM. These two types of files are system standard definition files created when JP1/IM - Manager is installed, and they cannot be added to, changed, or deleted by the user.
To add new user- or program-specific information about extended attributes of JP1 events, you can create a definition file of type No. 2 or No. 4 above and store it in the storage directory.
For details about file type No. 2, see Definition file for extended event attributes (extended file) in Chapter 2. Definition Files.
Creation timing
The following shows when the different types of definition files for extended event attributes are created.
No. |
File type |
When created |
---|---|---|
1 |
default.conf |
When JP1/IM - Manager is installed |
2 |
hitachi_xxxx.conf |
When JP1/IM - Manager is installed |
3 |
company-name_product-name_attr.conf |
When the user adds the file |
When the definitions are applied
The definitions in the definition file for extended event attributes take effect after either of the following occurs:
-
JP1/IM - Manager is restarted.
-
The command jco_spmd_reload is executed.
Information that is specified
A definition file for extended event attributes defines the order for sorting event attributes and the attribute names that are to be displayed in the Event Details window.
There are three types of definition files for extended event attributes:
-
File for definition of detailed event information about the basic attributes common to all events and the common information for extended attributes (file included with the product: default.conf)
-
File for definition of program-specific information about the extended attributes of a linked product that issues JP1 events (file included with the product: hitachi_xxxx.conf)
-
File for definition of user-specific information about user-defined extended attributes (created by the user)
The definition files for extended event attributes that are created when JP1/IM - Manager is installed are system standard definition files, and they cannot be added to, changed, or deleted by the user.
To add new user-specific information about extended attributes of JP1 events, you can create a definition file according to the naming rules described in Table 2-2 Naming rules for definition files and then store the file in the same definition file storage directory.
You should note the following about creating such a definition file:
-
In JP1/IM - Manager for Linux, use UTF-8 encoding. In JP1/IM - Manager for OSs other than Linux, use Shift-JIS or EUC encoding.
-
If you mistakenly define the basic attributes or common information for the extended attributes in the definition file, the following is displayed if attributes (attribute name, item name, and attribute display type) are duplicated.
-
If only the attribute name or item name is duplicated: The attribute names and item names defined in each definition file are displayed.
-
If all attributes are duplicated: Specifications of the default file (default.conf) for the definition files for extended event attributes are ignored.
-
JP1/IM provides the jcoattrfcheck command for checking the contents of a definition file for extended event attributes. For details about this command, see jcoattrfcheck in Chapter 1. Commands.
You can specify the statements and blocks described in the table below in a definition file for extended event attributes.
Statement or block |
Description |
---|---|
@encode statement |
Specifies the character encoding used in the definition file |
@file statement |
Declares the definition file type and version |
@product statement |
Declares product information in the definition |
Definition block for extended event attributes |
Defines the display of event attributes |
Definition block for attribute groups |
Defines event attribute groups |
Definition block for the attribute display order |
Defines ID the order in which attributes are displayed in the Event Details window |
Information that is specified (specification of character encoding)
- @encode
-
Specifies the character encoding that is to be used in the definition file for extended event attributes. The @encode statement can be omitted.
To create an additional file for definition file for extended event attributes, use an @encode statement to specify the character set for the definition file.
Item names are expressed in characters that can be represented in the character encoding specified in the @encode statement. In addition, the definition file for extended event attributes is stored in the character encoding specified in the @encode statement.
In the following circumstances, item names displayed in JP1/IM - View 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 content of the definition file, the character encoding might not be determined correctly.
The following character encodings can be specified:
-
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 value.
- Note
-
If you use a definition file for extended event attributes provided by another product, make sure that the character encoding specified in the @encode statement matches the character encoding used in the definition file. In addition, if you plan to transfer definition files, do not convert their character encoding.
-
Information that is specified (rules for generating in-file statements)
- @filestatement
-
Declares that this is a definition file for extended event attributes and that the version of the definition specification format is 0300. This statement is mandatory.
This statement must be on the first line of the file, or on the line following the @encode statement. If the statement is not specified on the first line, the integrity of operations cannot be guaranteed.
- Syntax
-
@file type="extended-attributes-definition", version="0300";
- @productstatement
-
Defines product information for the statements defined in the file.
When you specify this statement, note the following:
-
The specified value must match the PRODUCT_NAME JP1 event extended attribute. If this specification is omitted, the integrity of operations cannot be guaranteed.
-
Prohibited characters and formatting irregularities are not checked during parsing; instead, the specified character string is used as is.
- Syntax
-
@product name="product-name";
-
- name="product-name"
-
The product name is a string of alphanumeric characters separated by a forward slash. It must be specified in one of the following formats:
-
/company-name/series-name/product-name
-
/company-name/product-name
- Example definition
-
The following shows an example of definition information header statements:
@file type="extended-attributes-definition", version="0300"; @product name="/HITACHI/JP1/CentralConsole"; @define-block type="event-attr-def"; block lang="English", platform="NT"; attr name="E.SAMPLE_TIME", title="Sample time"; attr name="E.SAMPLE_HOST", title="Sample host"; attr name="E.SAMPLE_USER", title="Sample user"; @define-block-end;
-
Information that is specified (rules for generating blocks in the definition file for extended event attributes)
This subsection describes the blocks that can be specified in a definition file for extended event attributes. If an invalid statement is specified in a block, an error is output but only the statement with the error is ignored.
- Definition block for extended event attributes
-
In the Event Details window, associate the event attribute name with its display item name (for all Japanese, English, and Chinese names). You can specify this block more than once in the definition file unless the blocks have the same key attribute (the value specified in the block statement discussed below).
When specifying multiple languages, if you specify an attribute name in an attr statement (described below) for any one language, you must specify that attribute name in an attr statement for every specified language.
- Types of statements that can be specified
-
You can specify the following statements in this block:
• block statement
• attr statement
- Definition block for attribute groups
-
This block groups event attributes that are defined in the definition blocks for extended event attributes. If you group multiple event attributes, you can avoid defining order statements repeatedly in the definition blocks for the attribute display order.
This block is optional.
- Types of statements that can be specified
-
You can specify the following statements in this block:
• block statement
• group statement
- Definition block for the attribute display order
-
Defines the order in which event attributes and attribute names are to be displayed when the details of each event are displayed.
- Types of statements that can be specified
-
You can specify the following statements in this block:
• block statement
• order statement
Information that is specified (rules for generating statements in a definition block for extended event attributes)
- block statement
-
Defines block attributes. You can specify this statement only once at the beginning of a block.
- Syntax
-
block lang=language-type, platform=platform-type;
- lang=language-type
-
Declares the language used for the definition block for extended event attributes. You can specify one of the following languages:
• Japanese
Indicates that this is a definition for a Japanese language environment.
• English
Indicates that this is a definition for an English language environment.
• Chinese
Indicates that this is a definition for a Chinese language environment.
- platform=platform-type
-
Specifies the platform to which the definition in the block is to be applied. You can specify the following values:
• base
The definition is applicable to all platforms.
If base is specified for the platform parameter, you must specify a comma (,) followed by extended="false".
• user-defined
The definition is applicable to a user-defined platform. You must specify for user-defined a character string of alphanumeric characters. Note that this character string is not checked for errors.
The platform name specified in the platform parameter is compared with the PLATFORM JP1 event extended attribute; if they match, the specified information is subject to detailed information processing. If the platform name specified here is not found in the PLATFORM JP1 event extended attribute, the specified information is not processed. Note that if the PLATFORM extended attribute is not set at the time of JP1 event issuance, the system assumes that base is specified and executes file parsing.
- Example definition
-
See the example definition for the attr statement below.
- attr statement
-
Specifies an item name that is to be displayed in the attribute name column in the Event Details window and the type of the attribute value. You can specify this statement more than once in a block.
Note that this statement can be used to define only user-specific extended attribute information; the basic attributes and the common information of extended attributes are excluded. If the specified information is not user-specific extended attribute information, processing continues without outputting an error, but the specified information is displayed together with the provided standard definition information. For details about the standard definitions included with the product, see Example definition below.
- Syntax
-
attr name=attribute-name, title=display-item-name[,type="elapsed_time/
date_format:CLIENT"];
- name=attribute-name
-
Specifies the name of an attribute.
The following table lists the attributes that can be displayed.
No.
Specification format
Meaning of attribute
1
"B.SEQNO"
Serial number
2
"B.IDBASE"
Event ID
3
"B.PROCESSID"
Source process ID
4
"B.TIME"
Registered time
5
"B.ARRIVEDTIME"
Arrived time
6
"B.USERID"
Source user ID
7
"B.GROUPID"
Source group ID
8
"B.USERNAME"
Source user name
9
"B.GROUPNAME"
Source group name
10
"B.SOURCESERVER"
Source host
11
"B.DESTSERVER"
Target event server name
12
"B.SOURCESEQNO"
Source serial number
13
"B.MESSAGE"
Message
14
"B.SOURCEIPADDR"
Source IP address
15
"E.extended-attribute-name"
Extended attribute
- title=display-item-name
-
Specifies the character string that is to be displayed in the attribute name column in the Event Details window; the language specified in the block statement will be used.
- type="elapsed_time/date_format:CLIENT"
-
Specifies the type and display format of the attribute value. The attribute value elapsed_time is a decimal character string indicating the elapsed time in seconds since UTC 1970-01-01 00:00:00. The display format date_format:CLIENT means that the value is to be displayed in the time format by using the time specified in the local time zone of the target viewer.
- Example definition
-
This subsection presents an example of user-specific extended attribute information for JP1 events. This is an example of a definition block for extended event attributes that displays four extended attributes (user-specific information) listed in the following table for the platform W2K.
Table 2‒25: Example definition of a definition block for extended event attributes Name displayed in the window
Extended attribute name (user-specific information)
SAMPLE common attribute 1
COMMON_ATTR1
SAMPLE common attribute 2
COMMON_ATTR2
SAMPLE start attribute 1
START_ATTR1
SAMPLE start attribute 2
START_ATTR2
@define-block type="event-attr-def"; block lang="English", platform="w2k"; attr name="E.COMMON_ATTR1", title="SAMPLE common attribute 1"; attr name="E.COMMON_ATTR2", title="SAMPLE common attribute 2"; attr name="E.START_ATTR1", title="SAMPLE start attribute 1"; attr name="E.START_ATTR2", title="SAMPLE start attribute 2"; @define-block-end;
Information that is specified (rules for generating statements in a definition block for attribute groups)
- block statement
-
Defines block attributes. You can specify this statement only once at the beginning of a block.
When you define this statement, note the following:
-
This block cannot contain the lang parameter.
- Syntax
-
block platform=platform-type;
- platform=platform-type
-
Specifies the platform to which the definition in the block is to be applied. You can specify the following values:
Specifiable value
Description
"base"
Use the value to enable the definition for all platforms.
If base is specified for the platform parameter, you must specify a comma (,) followed by extended="false".
"user-defined"
The definition is enabled for a user-defined platform. You must specify for user-defined a one-byte alphanumeric character string. Note that this character string is not checked for errors.
The platform name specified in the platform parameter is compared with the PLATFORM JP1 event extended attribute; if they match, the specified information is subject to detailed information processing. If the platform name specified here is not found in the PLATFORM JP1 event extended attribute, the specified information is not processed. Note that if the PLATFORM extended attribute is not set at the time of JP1 event issuance, the system assumes that base is specified and executes file parsing.
- Example definition
-
See the example definition for the group statement below.
-
- group statement
-
Groups attributes by assigning a name to a list of attributes that are to be displayed in the Event Details window. You can specify this statement more than once in a block.
- Syntax
-
group name=group-name, attrs=list-of-attribute-names;
- name=group-name
-
Specifies a name for the list of attribute names. Express the name using from 1 to 32 alphanumeric characters. This name is not case sensitive. You can use this name in the order block in the definition file.
- attrs=list-of-attribute-names
-
Specifies a list of one or more attributes that are to be grouped. When multiple attributes are listed in this parameter, they are displayed in the Event Details window in the order specified here. The specification format is as follows:
• To specify only one attribute: attrs="E.A0"
• To specify multiple attributes: attrs="E.A0|E.A1"
Note that you can specify only user-specific extended attribute information. If you have specified a basic attribute or a common information item for an extended attribute, the specified attribute value is displayed more than once in the Event Details window.
- Example definition
-
This example shows the definitions of basic attributes and user-specific information for JP1 event extended attributes. These definitions are provided as standard in the definition file for extended event attributes.
@define-block type="event-attr-group-def"; block platform="base", extended="false"; group name="BASE", attrs="B.GROUPID|B.GROUPNAME|B.IDBASE|B.PROCESSID|B.SEQNO|B.SOURCEIPADDR| B.SOURCESEQNO|B.SOURCESERVER|B.TIME|B.USERID|B.USERNAME|B.ARRIVEDTIME"; group name="COMMON", attrs="E.SEVERITY|E.USER_NAME|E.PRODUCT_NAME|E.OBJECT_TYPE|E.OBJECT_NAME| E.ROOT_OBJECT_TYPE|E.ROOT_OBJECT_NAME|E.OBJECT_ID|E.OCCURRENCE| E.START_TIME|E.END_TIME|E.RESULT_CODE"; @define-block-end;
Information that is specified (rules for generating statements in a definition block for the attributes display order)
- block statement
-
Defines the block attribute that depends on the definition block for the attribute display order. You can specify this statement only once at the beginning of a block.
When you define this statement, note the following:
-
This block cannot contain the lang parameter.
- Syntax
-
block platform=platform-type;
- platform=platform-type
-
Specifies the platform to which the definition in the block is to be applied. You can specify the following values:
Table 2‒26: Specifiable platforms Specifiable value
Description
"base"
Use the value to enable the definition for all platforms.
If base is specified for the platform parameter, you must specify a comma (,) followed by extended="false".
"user-defined"
The definition is enabled for a user-defined platform. You must specify for user-defined a one-byte alphanumeric character string. Note that this character string is not checked for errors.
The platform name specified in the platform parameter is compared with the PLATFORM JP1 event extended attribute; if they match, the specified information is subject to detailed information processing. If the platform name specified here is not found in the PLATFORM JP1 event extended attribute, the specified information is not processed. Note that if the PLATFORM extended attribute is not set at the time of JP1 event issuance, the system assumes that base is specified and executes file parsing.
- Example definition
-
See the example definition for the order statement below.
-
- order statement
-
Defines by ID the attributes to be displayed in the Event Details window and their sort order. You can specify this statement more than once in a block.
- Syntax
-
order id=event-ID-definition-character-string, attrs=list-of-attribute-names;
- id=event-ID-definition-character-string
-
Specifies one event ID for which attributes are to be displayed in the order specified in the attrs parameter.
The specification format is as follows:
id="200"
Express an event ID using from 1 to 8 hexadecimal characters. If a specified event ID consists of fewer than 8 characters, there is no need to add leading zeros to pad it out to 8 characters. The alphabetic characters in the hexadecimal character string (a to f) are not case sensitive.
A range of IDs cannot be specified.
- attrs=list-of-attribute-names
-
Specifies a list of the attributes, the groups, or both that are to be displayed. When multiple items are specified in this parameter, they are displayed in the Event Details window in the order specified here.
The specification format is as follows:
• To specify only one item: attrs="E.A0"
• To specify multiple items: attrs="E.A0|E.A1|GROUP1"
As is the case with the group statement, you can specify only user-specific extended attributes. If you have specified a basic attribute or common extended attribute, the specified attribute value will be displayed more than once in the Event Details window.
- Example definition
-
This example definition displays the BASE and COMMON groups for event ID 00001000:
@define-block type="event-attr-order-def"; block platform="base", extended="false"; order id="00001000", attrs="BASE|COMMON" @define-block-end;
Example definition of a definition file for extended event attributes
@encode UTF-8 @file type="extended-attributes-definition", version="0300"; @product name="/HITACHI/JP1/SAMPLE"; @define-block type="event-attr-def"; block platform="base", lang="English", extended="false"; attr name="E.SAMPLE_CLUSTER_NAME", title="Cluster name"; attr name="E.SAMPLE_PRINT_SERVER_NAME", title="Print server name"; attr name="E.SAMPLE_PRINTER_NAME", title="Printer name"; attr name="E.SAMPLE_PORT_NAME", title="Port name"; @define-block-end; @define-block type="event-attr-group-def"; block platform="base", extended="false"; group name="_PRINTER_INFO", attrs="E.SAMPLE_PRINT_SERVER_NAME|E.SAMPLE_PRINTER_NAME"; group name="_CLUSTER_INFO", attrs="E.SAMPLE_CLUSTER_NAME|E.SAMPLE_PORT_NAME"; @define-block-end; @define-block type="event-attr-order-def"; block platform="base", extended="false"; order id="00003100",attrs="_PRINTER_INFO"; order id="00003101",attrs="_CLUSTER_INFO"; order id="00003102", attrs="_PRINTER_INFO|_CLUSTER_INFO"; @define-block-end;
Definition file for extended event attributes that is included with the product
Shown below are the definitions of the basic attributes and the common information for extended attributes for JP1 events. These definitions are included with the product as the definition file for extended event attributes.
@define-block type="event-attr-def"; block lang="English", platform="base", extended="false"; attr name="B.SEQNO", title="Serial number"; attr name="B.IDBASE", title="Event ID"; attr name="B.PROCESSID", title="Source process ID"; attr name="B.TIME", title="Registered time", type="elapsed_time_in_milli/date_format:CLIENT"; attr name="B.ARRIVEDTIME", title="Arrival time", type="elapsed_time/date_format:CLIENT"; attr name="B.USERID", title="Source user ID"; attr name="B.GROUPID", title="Source group ID"; attr name="B.USERNAME", title="Source user name"; attr name="B.GROUPNAME", title="Source group name"; attr name="E.JP1_SOURCEHOST", title="Event source host name"; attr name="B.SOURCESERVER", title="Event-issuing server name"; attr name="B.SOURCEIPADDR", title="Source IP address"; attr name="B.SOURCESEQNO", title="Source serial number"; attr name="E.SEVERITY", title="Event level"; attr name="E.USER_NAME", title="User name"; attr name="E.PRODUCT_NAME", title="Product name"; attr name="E.OBJECT_TYPE", title="Object type"; attr name="E.OBJECT_NAME", title="Object name"; attr name="E.ROOT_OBJECT_TYPE", title="Root object type"; attr name="E.ROOT_OBJECT_NAME", title="Root object name"; attr name="E.OBJECT_ID", title="Object ID"; attr name="E.OCCURRENCE", title="Occurrence"; attr name="E.START_TIME", title="Start time", type="elapsed_time/date_format:CLIENT"; attr name="E.END_TIME", title="End time",type="elapsed_time/date_format:CLIENT"; attr name="E.RESULT_CODE", title="Result code"; attr name="E.JP1_GENERATE_SOURCE_SEQNO", title="Relation Event serial number"; attr name="E.JP1_GENERATE_NAME", title="Correlation event generation condition name"; attr name="E.@JP1IM_ORIGINAL_SEVERITY", title="Original severity level"; attr name="E.JP1_IMSUPPRESS_ID", title="Suppressed event ID"; attr name="E.JP1_IMSUPPRESS_NAME", title="Repeated event condition name"; attr name="E.JP1_TRAP_ID", title="Monitoring ID"; attr name="E.JP1_TRAP_NAME", title="Log file trap name"; attr name="E.@JP1IM_CHANGE_MESSAGE_NAME", title="Display message change definition"; attr name="E.JP1_IMCOMEXCLUDE_ID", title="Common exclude conditions group ID"; attr name="E.JP1_IMCOMEXCLUDE_NAME", title="Common exclude conditions group name"; attr name="E.JP1_IMCOMEXCLUDE_TARGET", title="Common exclude conditions group target-for-exclusion"; @define-block-end;