A.2 Extended attributes
Extended attributes of JP1 events are classified into common extended attributes and user-specific extended attributes.
- Organization of this subsection
(1) Common extended attributes
Attribute name |
Item |
Explanation |
---|---|---|
Event level |
This attribute indicates the severity of the event. The possible event levels are as follows: Emergency, Alert, Critical, Error, Warning, Notice, Information, and Debug. For details about event levels (severity), see Table A-3 Event levels. |
|
USER_NAME |
User name |
This attribute indicates the name of the user who is executing the job. |
PRODUCT_NAME |
Product name |
This attribute indicates the product name. The value of this attribute consists of alphanumeric strings separated by a slant (/). The value must have either of the following formats and must be unique for each company:
Note also that you cannot use HITACHI, because as a company name it is a reserved word. |
OBJECT_TYPE |
Object type |
This attribute indicates the object type. As the value of this attribute, specify the type of the event-originating object. In the initial status, the object types listed below are provided. You may want to select or search JP1 events by specifying these object types in event filters, so you should assign the same object type to the JP1 events that have the same meaning. If you want to add new object types, create the definition file for object types and specify unique object types in the file.
|
OBJECT_NAME |
Object name |
This attribute specifies the object name. As the value of this attribute, specify a name that identifies the type of the object. For example, if the object type is JOB, you may assign the job name. |
ROOT_OBJECT_TYPE |
Root object type |
This attribute specifies the root object type. As the value of this attribute, specify the parent object type. This attribute is effective when objects have a hierarchical structure. For example, if the object type is JOB, the root object type is JOBNET. If the root object type does not exist, specify the same value as the object type. In the initial status, the same value as the object type is defined. |
ROOT_OBJECT_NAME |
Root object name |
This attribute specifies the root object name. Specify a name that identifies the root object type. For example, specify a jobnet name. |
OBJECT_ID |
Object ID |
A combination of this attribute and the PRODUCT_NAME attribute specifies a character string that uniquely identifies the object instance in the integrated system. The format of an object ID depends on the other products. This information is used to open the monitor of a product from the Tool Launcher window of JP1/IM. |
OCCURRENCE |
Occurrence |
This attribute specifies an object-specific occurrence that causes the event to occur. In the initial status, the occurrences listed below are provided. You can specify an occurrence and an object type in a filter to select a specific event for a specific object.
|
START_TIME |
Start time |
This attribute indicates the execution start or restart time. As the value of this attribute, specify the number of seconds from 00:00:00 UTC on January 1, 1970. You can specify this attribute only when the OCCURRENCE attribute is START, RESTART, PAUSE, RELEASE, or END. |
END_TIME |
End time |
This attribute indicates the time to end execution. As the value of this attribute, specify the number of seconds from 00:00:00 UTC on January 1, 1970. You can specify this attribute only when the OCCURRENCE attribute is END. |
RESULT_CODE |
Result code |
This attribute indicates a termination code consisting of decimal numbers. You can specify this attribute only when the OCCURRENCE attribute is END. |
PLATFORM# |
Platform type |
This attribute indicates the platform type. Specify a character string for this attribute to specify the platform type in the definition file for extended event attributes or in the definition file for opening monitor windows. If you do not specify this attribute, base is used by default. |
ACTION_VERSION# |
Version information |
This attribute indicates the version used for opening the monitor window. This attribute is necessary when the monitor windows to open differ depending on the version. If you do not specify this attribute, do not specify a version in the definition file for opening monitor windows. |
- Event levels
-
The following table explains event levels that may be specified in the SEVERITY common extended attribute. Use the following criteria as a guideline for setting the event level of user-defined events. Note that the JP1/IM Event Console window does not display events that did not have an event level specified when they were issued.
Table A‒3: Event levels Event level
Display name
Explanation
Emergency
Emergency
An emergency status. Normally, the events specifying this event level are broadcast to all users.
Alert
Alert
A status requiring an immediate recovery, such as damage to the system or database.
Critical
Critical
A critical status such as a hardware error.
Error
Error
An error.
Warning
Warning
A warning message.
Notice
Notice
A status that does not indicate an error, but indicates a situation that requires careful handling.
Information
Information
Information to users.
Debug
Debug
A message that normally contains information used only for debugging the program. This event level is not used for JP1 events because an excessive volume of messages might occur.
(2) User-specific extended attributes
In addition to common extended attributes, you can add user-specific extended attributes for the program to JP1 events. To add user-specific extended attributes, you must define them with JP1/IM in the definition file for extended event attributes.
The following shows the rules for creating user-specific extended attributes:
-
You can use a symbolic name having no meaning as an attribute name.
-
For programs that have the same value in the PRODUCT_NAME extended attribute, there must be a one-to-one correspondence between attribute names and meanings.