PS_GET_HEARTBEAT

Each Process Scheduler Server reports periodically to the PeopleSoft database. This procedure is called the heartbeat of the Process Scheduler Server. The PS_GET_HEARTBEAT script element allows you to monitor the availability of the Process Scheduler Server. PS_GE_HEARTBEAT evaluates the PeopleSoft Database server's system time 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 the time of the Database Server and, second, the time of the last heartbeat. You can evaluate this information on the Post Process page.

Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+

Syntax

PS_GET_HEARTBEAT

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

Parameters

PS_GET_HEARTBEAT
Monitors a PeopleSoft Process Scheduler Server
RUNLOCATION=
Name of an assigned PeopleSoft Process Scheduler Batch Server, such as PSUNX or PSNT.
Format: script literal
MAXPERIOD=
(Optional) Maximum time in seconds allowed between the PeopleSoft Database server's system time and the time of the last heartbeat from the Process Scheduler Server. The time difference between the PeopleSoft Database Server and the last heartbeat is calculated and compared with the period specified here. The AE job is canceled if the calculated time difference is more significant than the maximum allowed period. The AE job ends normally if the maximum allowed period is not reached or exceeded through the calculated time difference.
Format: Number

Example

The following example retrieves the system time of the PeopleSoft Database Server and the time of the last heartbeat of the PSNT Process Scheduler Server and prints the result 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 of PSNT with the maximum allowed period. The last heartbeat must not be older than 20 seconds of the PeopleSoft Database Server's time, otherwise the job is canceled.

PS_GET_HEARTBEAT RUNLOCATION='PSNT', MAXPERIOD=20