Try OpenEdge Now
skip to main content
Configuration
Configuring Batch Programs : Batch Program properties : Batch Program Monitoring properties
 

Batch Program Monitoring properties

Table 117. Monitoring properties
Property
Description
Monitoring method
The method to track the status of the program.
Select from the following options:
*Status script — Tracks the status of the Batch Program. The script can perform any action to determine the Batch Program’s return state including reading log files, reading PID files, or making an HTTP request.
This script can be Windows batch programs or executables, or UNIX shell scripts or executables.
*PID file — The file that contains a Process ID (PID) of the Batch Program. If available, OpenEdge Management uses this file to determine the state of the process. When you define the path for the PID file, OpenEdge Management looks for the PID file and considers that the Batch Program is running only if the file is valid and the process associated with PID is executing.
In a case where the PID file is not available, cannot be read, or does not contain a single line with an integer value, the status is considered as failed.
*PID registration — Exposes a REST API with which a stand-alone process can register a PID with OpenEdge Management.
OpenEdge Management monitors the PID periodically to ensure that it is running. For the process to be monitored, it must be running on the same machine where the AdminServer is configured for the Batch Program.
*Exit code — Indicates the status of the process when it exited.
Status script
(Optional) The path to the Status script. OpenEdge Management utilizes this script to determine the status of the Batch Program.
Status script parameters
(Optional) The parameters that are to be passed to the Status script.
Status script timeout (seconds)
(Optional) The timeout value for the OpenEdge Management to wait for tracking the Batch Program’s status.
The default value is 15 seconds. The Status script must execute and terminate within the timeout value. If the Status script terminates with an exit code 0, OpenEdge Management considers that the status of the Batch Program as passed. If the script terminates with an exit code other than 0, OpenEdge Management considers that the status as failed. If the script is missing or cannot be executed, OpenEdge Management considers that the Program is not running and failed.
Kill if still running after timeout
Terminates the Status script, if running, after the specified timeout.
If this option is not selected and the Status script is not terminated after the specified timeout, OpenEdge Management writes a message to the Batch Program log files.
PID file
The absolute path to the location where PID is maintained by Startup or Shutdown scripts. However, the path can also be a relative path or to OpenEdge work directory (%DLC%\WRK).
Status failure behavior
The behavior of OpenEdge Management when the status of the Batch Program is unknown.
Select one or more behaviors from the following options:
*Fire alert — Fires an alert.
*Perform action — Executes an action.
*Restart the program — Restarts the Batch Program.
Action
The action that you want to associate with the failure of the Batch Program. For more information, see Using Batch Program default actions.
Once you specify the exit code and select its associated action, click ADD/UPDATE to add them. You can choose to add multiple exit codes and their associated actions. Click DELETE to delete your selection.