Batch Program default actions
- Last Updated: March 30, 2020
- 1 minute read
- OpenEdge
- Version 12.2
- Documentation
OpenEdge Management supports log and email actions for Batch Program resource. You can create your own log and email actions, or use the sample email template for Batch_Program_Stopped action.
When a log file action is triggered, OpenEdge Management writes the start time, stop time, and status of the current Batch Program process to the configured log file.
When an email action is triggered, OpenEdge Management invokes the email action
with a set of values appropriate for the process. The following table describes the
properties used in the email message template:
Few properties mentioned in the table are not applicable when an email action is
fired for a status failure without a process involved in it. For example, the properties
PROCESSSTARTTIME, PROCESSSTOPTIME, PROCESSSTATE, PROCESSID are not applicable without a
process object.
| Property | Description |
|---|---|
| HOSTLINK | The URL to OpenEdge management. |
| PIDFILE | The PID file configured for the Batch Program process. |
| PROCESSCONTAINER | The container name of the Batch Program resource. |
| PROCESSENVVARS | The environment variables configured for the Batch Program. |
| PROCESSPID | The PID of the last known process. |
| PROCESSSTARTTIME | The start time of the process, if available. This requires a PID that OpenEdge Management can query. |
| PROCESSSTATE | The reported state of the process such as initializing, starting, running, stopping, not running. |
| PROCESSSTATUSMSG | The Status message of the current process when the email action is triggered. |
| PROCESSSTOPTIME | The stop time of the process, if OpenEdge Management is able to determine it. Otherwise, the stop time of the end of the shutdown script. |
| PROGRAMNAME | The name of the Batch Program resource. |
| SHUTDOWNSCRIPT | The Shutdown script, if configured. |
| SHUTDOWNSCRIPTARGS | The Shutdown script arguments, if configured. |
| STARTUPSCRIPT | The Startup program, if configured. |
| STARTUPSCRIPTARGS | The arguments for the Startup program. |
| STATUSSCRIPT | The Status script, if configured. |
| STATUSSCRIPTARGS | The Status script arguments, if configured. |
| STDERRFILE | The stderr file configured for the Batch Program process. |
| STDOUTFILE | The stdout file configured for the Batch Program process. |