4.7.17 Registration of a JP1 event
Function
This component registers JP1 events to JP1/Base on a specified server.
If a destination event server name is specified, it confirms whether a JP1 event has reached the destination.
The component assumes the following server as a prerequisite:
- Agent server (Execution target server)
Server running this component. JP1/Base has been set up and the event server is up and running.
If a destination event server name is specified, the component will first confirm three seconds later whether a JP1 event has reached the destination. Thereafter, the component 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".
Use situation
Registers a problem during JP1/AO processing as a JP1 event to JP1/IM - Manager.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
(1) JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
(1) Job Management Partner 1/Base 09-00 or later, or
JP1/Base 11-00 or later
[Prerequisite product OS running in the execution target server]
(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 required products on the execution target server]
(1) The JP1/Base event service is up and running.
Cautions
(1) If you are executing this component for an environment where the OS running on the agent server is UNIX, do not use any multi-byte characters in properties.
(2) If a destination event server name is specified and if a KAJP1743-E message indicating that "the event has not been confirmed to have reached the destination event server" is output to the standard output of the component, JP1 event sending continues. If so, use JP1/IM - View on the host sending the JP1 event to confirm whether the JP1 event has reached the destination.
(3) If a value starting with "=" is specified in an extended property (jp1base.extendedAttribute1 to jp1base.extendedAttribute20), the property will be ignored.
Version
02.00.00
Plug-in tags
Control JP1,Base,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1baseSendEvent
Return code
0: Normal
12: Abnormal (User error) - Invalid property
21: Abnormal (Environment error) - The command is not found. (The component script has detected an error.)
25: Abnormal (Environment error) - Communication error
26: Abnormal (Linkage product problem) - Internal error
41: Abnormal (Error detected inside the component) - A property is not specified. (The component script has detected an error.)
42: Abnormal (Error detected inside the component) - Internal error (The component script has detected an error.)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
JP1Base.eventID |
Event ID |
Specify the event ID of the JP1 event to be registered. |
-- |
Input |
O |
|
JP1Base.message |
Message |
Specify message text for the JP1 event to be registered. |
-- |
Input |
O |
|
JP1Base.destinationEventServerName |
Destination event server name |
To send the JP1 event to be registered to an event server, specify the destination event server. |
-- |
Input |
O |
|
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 |
O |
|
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 |
O |
|
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 |
O |
|
JP1Base.extendedAttribute1 |
Extended attribute 1 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute2 |
Extended attribute 2 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute3 |
Extended attribute 3 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute4 |
Extended attribute 4 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute5 |
Extended attribute 5 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute6 |
Extended attribute 6 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute7 |
Extended attribute 7 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute8 |
Extended attribute 8 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute9 |
Extended attribute 9 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute10 |
Extended attribute 10 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute11 |
Extended attribute 11 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute12 |
Extended attribute 12 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute13 |
Extended attribute 13 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute14 |
Extended attribute 14 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute15 |
Extended attribute 15 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute16 |
Extended attribute 16 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute17 |
Extended attribute 17 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute18 |
Extended attribute 18 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute19 |
Extended attribute 19 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
JP1Base.extendedAttribute20 |
Extended attribute 20 |
Specify an extended attribute for the JP1 event to be registered. Specify the attribute in the format "extended attribute name=extended attribute value". |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |