Job Management Partner 1/Base User's Guide

[Contents][Glossary][Index][Back][Next]


15.1.1 Basic attributes

The following table lists and describes the basic attributes of JP1 events.

Table 15-1 Basic attributes of JP1 events

Attribute Format#1 Contents JP1/SES support
Serial number Numeric value (32 bits) Order in which events (including local events) arrive at this event server, regardless of the source. This attribute is not preserved for JP1 event transfers between event servers. This attribute is mainly used to prevent delays or duplication when events are forwarded to a pseudo-operator or to another event server. No
Event ID Two numeric values (32 bits)#2 An 8-byte value indicating the application program that issued the event and the event contents. Yes
Registered reason Numeric value (32 bits) Reason for registration of the JP1 event on this event server. This attribute is not preserved for JP1 event transfers between event servers. One of the following codes is set:

1: Event issued by the local event server to the local event server

2: Event issued by the local event server to the remote event server (this value cannot be obtained from an application)

3: Event issued by the remote event server to the local event server

4: Event forwarded from the remote event server to the local event server because of the environment settings
No
Source process ID Numeric value (32 bits) Process ID of the application program that issued the event. Yes
Registered time Numeric value (32 bits) Time of event registration on the source event server (number of seconds since UTC 1970-01-01 00:00:00, based on the source host clock). Yes
Arrived time Numeric value (32 bits) Time of event registration on the local event server (number of seconds since UTC 1970-01-01 00:00:00). This attribute is not preserved for JP1 event transfers between event servers. No
Source user ID Numeric value (32 bits) User ID (number) of the source process. In Windows and Java, set to a fixed value according to the environment settings (-1 to 65,535). Yes
Source group ID Numeric value (32 bits) Group ID (number) of the source process. In Windows and Java, set to a fixed value according to the environment settings (-1 to 65,535). Yes
Source user name Character string (0 to 20 bytes) User name of the source process. Yes
Source group name Character string (0 to 20 bytes) Group name of the source process. Null string in Windows and Java. Yes
Source event server name#3 Character string (0 to 255 bytes) Name of the source event server.
Set to the event server name of the first agent host, even if the JP1 event is forwarded from that agent host to a submanager host, and then to a manager host.
Yes
Destination event server name#3 Character string (0 to 255 bytes) Name of the remote event server, if the application program explicitly specifies forwarding to a remote event server. Yes
Source IP address Byte string (0 to 16 bytes) IP address corresponding to the source event server. (Not an accurate value if the JP1 event is sent through network address translation (NAT) or a proxy server, or is forwarded according to the environment settings.) Yes
Destination IP address Byte string (0 to 16 bytes) IP address corresponding to the destination event server. (Not an accurate value if the JP1 event is sent through network address translation (NAT) or a proxy server, or is forwarded according to the environment settings.) Yes
Source serial number Numeric value (32 bits) Serial number in the event database on the source host (unchanged at event transfer).#4 No
Code set Character string (0 to 255 bytes) Name of the character code-set in which the message, detailed information, and extended attributes are written.#5 No
Message Character string (0 to 1,023 bytes) #6 Message text indicating the JP1 event contents. Yes
Detailed information Character string or byte string (0 to 1,024 bytes) #6 Any data. Yes

Legend:
Yes: Attribute supported in JP1/SES
No: Attribute not supported in JP1/SES

#1: A character string is any non-zero byte string. Zeros can be included within the string.

#2: Represented as a hexadecimal with a colon separating the upper four bytes (basic code) and lower four bytes (extended code). For example, an event ID can be expressed as 00000111:00000000 or as 111:0. For the range of values, see the manual for the specific JP1 program. The range of event IDs that can be specified by the user is 0:0 to 1FFF:0, and 7FFF8000:0 to 7FFFFFFF:0. The extended code is always 0.

#3: The event server name is normally the host name.

#4: JP1/SES protocol events are assigned a number based on the time in milliseconds at which the event server receives them.

#5: The values include:

#6: The total maximum length of the message plus detailed information is 1,024 bytes. The relationships between these two items are shown below.


Detailed information format Without message With message (character string)
None -- 1,023 bytes
Character string 1,023 bytes 1,022 bytes total
Byte string 1,024 bytes 1,023 bytes total

[Contents][Back][Next]


[Trademarks]

All Rights Reserved. Copyright (C) 2009, Hitachi, Ltd.