2.7.4 Registration of the JP1 event
Function
This service template registers a JP1 event to the agent server.
If a destination event server name is specified, this template confirms whether a JP1 event has reached the destination.
This template is used, for example, to register a problem during JP1/AO processing as a JP1 event to JP1/IM.
This service template assumes the following server as a prerequisite:
- Agent server
Server running JP1/Base
An outline of the processing is as follows:
(1) The JP1 event is registered to the agent server.
If a destination event server name is specified, it is confirmed whether a JP1 event has reached the destination.
The event level or severity of a registered JP1 event indicates the urgency of the event.
If a destination event server name is specified, it will first confirm three seconds later whether a JP1 event has reached the destination. Thereafter, it will continue to confirm whether the JP1 event has reached the destination, each time the number of seconds specified as the confirmation frequency elapses until it reaches the specified number of confirmation retries. The maximum confirmation time is expressed by "3 + (confirmation frequency) x (number of confirmation retries) seconds".
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1) Job Management Partner 1/Base 09-00 or later, or
JP1/Base 11-00 or later
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) AIX V6
(9) AIX V7
[Usage conditions for the required products for the service template execution system]
(1) The JP1/Base event service is running.
Cautions
(1) If you are executing this service for an environment where the OS running on the agent server is UNIX, do not use any multi-byte characters for properties.
(2) If specifying multi-byte characters for an environment where the OS running on the agent server is Windows, limit the length of the message property (jp1base.message) to a maximum of 1,023 bytes.
(3) If a destination event server name is specified and a KAJP1741-W message indicating that "the event has not reached the destination event server" is output to the task log, JP1 event sending continues to occur. If this happens, use JP1/IM - View on the host sending the JP1 event to confirm whether the JP1 event has reached the destination.
(4) To execute this service for a JP1/AO server, the set agent-less destination must be a JP1/AO server (having a loopback address to be resolved by "localhost").
Version
02.00.00
Tags
Configure JP1,Base
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
System environment information |
Specify JP1/Base environment information |
Y |
|
JP1 event information |
Specify JP1 event information to be registered. |
Y |
|
Information to be specified at the time of event sending |
This property is used to specify the destination of the JP1 event to be registered. Specify this property as appropriate. |
Y |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1base.jp1BaseHostName |
JP1/Base host name |
Specifies the host name or IP address of the server where JP1/Base is installed. IPv6 addresses are not supported. In the case of a cluster configuration, specify the logical host of the active server. |
Input |
Disabled |
R |
System environment information |
|
jp1base.sourceEventServerName |
Source event server name |
Specifies event server of the logical host for a cluster configuration. When not specifying the destination event server name, registers the JP1 event in this event server. When specifying the server name, uses this event server to transfer the JP1 event. |
Input |
Disabled |
O |
System environment information |
|
jp1base.eventID |
Event ID |
Specify the event ID of the JP1 event to be registered. Specify the ID in hexadecimals. If omitted, "0" is assumed. |
Input |
Disabled |
O |
JP1 event information |
|
jp1base.message |
Message |
Specify the message text for the JP1 event to be registered. |
Input |
Disabled |
O |
JP1 event information |
|
jp1base.eventLevel |
Severity |
Specify the severity of the JP1 event to be registered. |
Input |
Disabled |
R |
JP1 event information |
|
jp1base.extendedAttributeName1 |
Extended attribute name 1 |
Specify the name of the extended attribute for the JP1 event to be registered. |
Input |
Disabled |
O |
JP1 event information |
|
jp1base.extendedAttributeValue1 |
Extended attribute value 1 |
Specify the value of the extended attribute for the JP1 event to be registered. When extended attribute name 1 is specified, be sure to specify the value. |
Input |
Disabled |
O |
JP1 event information |
|
jp1base.extendedAttributeName2 |
Extended attribute name 2 |
Specify the name of the extended attribute for the JP1 event to be registered. |
Input |
Disabled |
O |
JP1 event information |
|
jp1base.extendedAttributeValue2 |
Extended attribute value 2 |
Specify the value of the extended attribute for the JP1 event to be registered. When extended attribute name 2 is specified, be sure to specify the value. |
Input |
Disabled |
O |
JP1 event information |
|
jp1base.destinationEventServerName |
Destination event server name |
To send the JP1 event to be registered to an event server, specify the destination event server. |
Input |
Disabled |
O |
Information to be specified at the time of event sending |
|
jp1base.checkInterval |
Confirmation frequency |
Specifies the checking interval (sec.) if the registered JP1 event reached the specified destination event server. This interval plus the checking frequency is the maximum checking time. Always specify when specifying the destination event server name. |
Input |
Disabled |
O |
Information to be specified at the time of event sending |
|
jp1base.checkCount |
Number of confirmation retries |
Specify the number of retries to confirm whether the registered JP1 event has reached the specified destination event server. If a destination event server name is specified, be sure to specify this parameter. |
Input |
Disabled |
O |
Information to be specified at the time of event sending |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1base.jp1BaseHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1base.sourceEventServerName |
This is a character string consisting of up to 255 alphanumeric characters, along with . and -. |
|
jp1base.eventID |
This is a hexadecimal number of up to eight digits. Specify the ID between 0 and 1FFF or between 7FFF8000 and 7FFFFFFF. |
|
jp1base.message |
This is a character string of up to 1,023 characters. < > | ; & " and ` are not allowed. |
|
jp1base.eventLevel |
Select one of the following values: Emergency,Alert,Critical,Error,Warning,Notice,Information,Debug |
|
jp1base.extendedAttributeName1 |
This is a character string consisting of up to 32 alphanumeric characters (uppercase), along with _. |
|
jp1base.extendedAttributeValue1 |
This is a character string of up to 1,024 characters. < > | ; & and " are not allowed. |
|
jp1base.extendedAttributeName2 |
This is a character string consisting of up to 32 alphanumeric characters (uppercase), along with _. |
|
jp1base.extendedAttributeValue2 |
This is a character string of up to 1,024 characters. < > | ; & and " are not allowed. |
|
jp1base.destinationEventServerName |
This is a character string consisting of up to 255 alphanumeric characters, along with . and -. |
|
jp1base.checkInterval |
This is an integer between 3 and 600. |
|
jp1base.checkCount |
This is an integer between 0 and 999. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
jp1baseSendEvent |
Registration of a JP1 event |
Registers the JP1 event. |
If a destination event server name is specified and it cannot be confirmed whether an event has reached the destination, use JP1/IM - View on the destination event server to confirm whether the JP1 event has reached it. Otherwise, remove the cause of the error, and then execute the service again. |