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

Batch Program properties

When creating or configuring a Batch Program resource, you can specify or modify the Batch Program properties as described in the following sections:
*Batch Program General properties
*Batch Program Startup properties
*Batch Program Monitoring properties
*Batch Program Shutdown properties
*Batch Program Environment variable properties
Table 111. Startup properties
Property
Description
Startup script
(Optional) The name of the Batch Program that you want to run.
This can be the Batch Program or a script that starts the Batch Program.
Startup script parameters
(Optional) The parameters that are to be passed to the Startup script.
Startup script timeout (seconds)
(Optional) The timeout value for the Batch Program to start.
The default value is 15 seconds. If the status of the Batch Program is unknown within the timeout value, OpenEdge Management considers it as a failure.
Kill if still running after timeout
Terminates the Startup script, if running, after the specified timeout.
If this option is not selected and the Startup script is not terminated after the specified timeout, OpenEdge Management tracks the PID of the script.
Supports multiple processes
(Optional) Supports running multiple process.
Startup failure behavior
*On first startup failure
*On second startup failure
*On subsequent startup failure(s)
(Optional) The behavior of OpenEdge Management when the startup of the Batch Program fails on the first, second, and subsequent startups.
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.
The default is that the OpenEdge Management does not follow any behavior.
Subsequent startup limit
(Optional) The number of times the Subsequent startup behavior must be executed.
The minimum value is 1 and there is no maximum value. The program restarts until it reaches the specified limit.
Table 112. 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 status can be running or failed. The script can call other programs such as reading log files, reading PID files, or making an HTTP request.
*PID file — The Process ID (PID) of the Batch Program. 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.
*PID registration
*Exit code
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 running. 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 tracks the PID of the script.
PID file
The absolute path to the location where PID is maintained by Startup or Shutdown scripts.
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.
Table 113. Shutdown properties
Property
Description
Shutdown method
The method to stop the Batch Program.
Select from the following options:
*Shutdown script
*Terminate
If you select Terminate, OpenEdge Management looks for the Process ID (PID) of the Batch Program and stops the Batch Program. If the PID is not available, OpenEdge Management fails to stop the Batch Program.
Shutdown script
(Optional) The path to the script to stop the Batch Program.
Shutdown script parameters
(Optional) The parameters that are to be passed to the Shutdown script.
Shutdown script timeout (seconds)
(Optional) The timeout value for the OpenEdge Management to wait for executing the Shutdown script to stop the Batch Program.
The default value is 15 seconds. If the Shutdown script is not executed within the timeout value, OpenEdge Management considers it as a failure.
Kill if still running after timeout
Terminates the Shutdown script, if running, after the specified timeout.
If this option is not selected and the Shutdown script is not terminated after the specified timeout, OpenEdge Management tracks the PID of the script.
Table 114. Environment variable properties
Property
Description
User
(Optional) The name or ID of the user account on the machine where the process is to be executed.
This field allows you to determine the permissions that the process must have when executed.
Group
(Optional) (UNIX only) The name of the group.
Password
(Optional) The user account's password for authentication.
It is stored in the configuration database.
Environment variables
(Optional) The environment variables specified by the user.
These variables are provided during the execution of the Startup, Status, and Shutdown scripts.
Debug program
Debugs the Batch Program.
* Batch Program General properties
* Batch Program Startup properties
* Batch Program Monitoring properties
* Batch Program Shutdown properties
* Batch Program Environment variable properties
* Using Batch Program default actions
* Using PID registration