PS_GET_HEARTBEAT

Monitors a PeopleSoft Process Scheduler Server.

Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+

Syntax

PS_GET_HEARTBEAT

RUNLOCATION=...
[,MAXPERIOD=...]

Syntax	Description/Format
RUNLOCATION=	Name of an assigned PeopleSoft Process Scheduler Batch Server, for example PSUNX or PSNT. Format: script literal
MAXPERIOD=	Maximum time period in seconds allowed between the system time of the PeopleSoft Database Server and the time of the last heartbeat from the Process Scheduler Server. Format: Number

Each Process Scheduler Server reports periodically to the PeopleSoft database. This procedure is called the heartbeat of the Process Scheduler Server.

The script element PS_GET_HEARTBEAT makes it possible to monitor the availability of the Process Scheduler Server. It evaluates system time of the PeopleSoft Database Server and the time of the last heartbeat from the specified Process Scheduler Server. Both times are output in the activation report of the AE job. The message with the message number U2004942 contains first the time of the Database Server and, second, the time of the last heartbeat. This information can be evaluated in the post script.

If the optimal parameter MAXPERIOD is used, the time difference between PeopleSoft Database Server and the last heartbeat is calculated and compared with the time period specified here. If the calculated time difference is larger than the maximum allowed time period, the AE job is canceled. If the maximum allowed time period is not reached or exceeded through the calculated time difference, the AE job ends normally.

Example

In the example, the system time of the PeopleSoft Database Server and the time of the last heartbeat by the Process Scheduler Server "PSNT" is determined and output in the activation report.

PS_GET_HEARTBEAT RUNLOCATION='PSNT'

The second example compares the time difference between the PeopleSoft Database Server and the last heartbeat from "PSNT" with the maximum allowed time period. The last heartbeat can be a maximum of 20 seconds behind the time of the PeopleSoft Database Server, otherwise the job is canceled.

PS_GET_HEARTBEAT RUNLOCATION='PSNT', MAXPERIOD=20