The # used in the following user exit parameters represents a separate number for each user exit that can be included in the Control‑M Watchdog process . A user exit can be either a user supplied script/executable file or a Control‑M utility.
Parameter |
Description |
---|---|
WD_USEREXIT_#_CMD_LINE |
Contains parameters to be passed to the exit script. Arguments must start with a ‘-’ sign. Values separated by either a space or a ‘-’ sign must be enclosed in double quotation. Mandatory. Valid values: 1024 characters Default: "" Refresh Type: Recycle |
WD_USEREXIT_#_ERROR_MSG |
Error message string to be passed to the error handler(s) if the check returns a "failed" status. Optional. Valid values: 1024 characters Default: "" Refresh Type: Recycle |
WD_USEREXIT_#_INTERVAL |
Number of basic time interval units that should pass before reinvoking the exit script. The basic time interval unit is defined in parameter WD_INTERVAL. For example, if the value of this parameter is 2, and the basic time interval unit (as defined in parameter WD_INTERVAL) is 5 minutes, the exit script will be invoked every 10 minutes (2 x 5 minutes). Valid values: 1–2^31 Default: 5 Refresh Type: Recycle |
WD_USEREXIT_#_RUN_STATE |
Specify whether (Y) or not (N) to run the utility when Control-M/Server is running. A Y must be specified for either this parameter or for parameter WD_USEREXIT_#_SUSPEND _STATE for the utility to be run. Valid values: Y, N Default: N Refresh Type: Recycle |
WD_USEREXIT_#_SCRIPT_FILE |
Relative path of the script or binary from the ~controlm\ctm_server\exe_<computer> directory. Valid values: 1024 characters Default: "" Refresh Type: Recycle |
WD_USEREXIT_#_SUSPEND_STATE |
Specify whether (Y) or not (N) to run the script in Suspend mode (that is, during New Day procedure or download, when the database inaccessible). This parameter or WD_CTMEXIT_#_RUN _STATE must be set to Y for the script to be run. Valid values: Y, N Default: N Refresh Type: Recycle |
WD_USEREXIT_#_TIMEOUT |
Time (milliseconds) allowed before the exit script is terminated. Valid values: 1–2^31 (ms) Default: 5 ms Refresh Type: Recycle |
Parent Topic |