Jobs tab

# Jobs parameters

Edit script: possibility to start external editor to edit user shutdown script.
The Upsagent program start before normal system shutdown, the user shutdown script. This you may use for some specific commands, which will to be executed before shutdown, for example stop web server, close some special application or shutdown database server. Name of this script is ups_shut and extension is depend on the operating system (ups_shut.bat for Windows, ups_shut.ncf for Novell Netware and ups_shut.scr for UNIX). For some operating system is possible change also script ups_mess, which is used to send messages to users about UPS status.
ATTENTION: if you specify incorrect command in user shutdown script or this command will to freeze (not correctly ended) then Upsagent not provide correct system shutdown and this is possibility lost of some data or fails filesystem on the computer. Last command in user shutdown script must to be command for shutdown of system (except Windows versions: here is shutdown executed by calling system routines directly from Upsagent).

Save files before shutdown (Only for Windows): Upsagent try save your open files before is system shutdown started. This not be supported by all programs or some international variant of standard program. Supported is only standard Windows application how MS Write, MS Office and more... Default: No.
ATTENTION: if your Upsagent system shutdown is not works correctly, this may be caused by incompatible application and conflict with possibility Save files before shutdown. For correct shutdown procedure you must disable this checkbox, if you have this problem.

Hibernate support (Only for Windows): hibernation must to be enabled by OS and supported by computer (BIOS, motherboard, free disk space, ...). Otherwise function fails and shutdown will to be not executed. Also Save files before shutdown function is bypassed, if Hibernate is used, of course. Default: No.

Event list: for detail configuration UPSMON user may also define jobs, which will to be executed when is detected some non-standard state of UPS, that are all show in the listbox below. Then Upsagent may to execute user-defined external command file or other actions.

Disable all jobs: this checkbox item may to disable start any action for all jobs.
ATTENTION: system shutdown conditions defined in UPS connection dialog is not depended on this checkbox.

Generation event delay (s): must be passed lessened delay seconds after the signalling of the event, before the generation of the correspondent software event and the start of related jobs.

Jobs:for main UPS status bits you may set any action from this list:
1 - log event
2 - execute file
3 - local message
4 - broadcast message
5 - system shutdown
6 - email
7 - SMS
8 - Call to Teleguard
9 - Fax message
10 - Voice call
For event action may to be specified delay and interval for detail settings. Both values is in seconds.

Log event: the event will to be logged into event log file.
ATTENTION: on Windows NT,2000 or XP platforms are events logged also in system Application event log. On UNIX platforms are events logged also into system log (depends on system configuration: see syslog man pages)

Execute file: Upsagent start specified command file if selected event will to be detected.
Recommendation: use full path name for file.

Local message: enables messages to users about UPS status and defines delay for first message (for filter short power fails) and repeat interval. For Window is showed dialog window on the desktop, for Novell Netware is send message to server console and for Unix is started ups_loc.scr script.

Broadcast message: send message about UPS status to remote user through network. For Windows is send broadcast message to all or some connected users (see Configurations), for other systems is started ups_mess.scr (or .ncf for Novell Netware) script.
Recommendation: use wall command to send message to all connected users on Unix systems.

Shutdown system: this option allow to shutdown system. For Windows is in first step searched ups_shut.cmd file with possible user specified command before shutdown (e.g. quit databases) and then is started standard system shutdown by calling WIN32 API functions. For other systems is started ups_shut.scr (or .cmd or .ncf) script with appropriate commands to provide correct shutdown of computer.
ATTENTION: you cannot specify Shutdown system action for AC Fail or Battery low events because this values is depend on UPS connection configuration. The system shutdown time after AC Fail may to be defined in two independed values (fixed time from AC Fail and/or specific remaining backup time). The Battery Low event cause immediately system shutdown action.

Email: direct email support is only for Windows. For other operating system you must specify own way to send email or use default prepared scripts. User may specify name and email address for email recipients in Configurations parameters dialog. If you select Email checkbox then will to be message about UPS status sent to specified users also by standard Windows MAPI or SMTP interface. Before use this option you must configure email service on your computer.
Note: for other operating system you may send email messages about UPS status by adding appropriate command into ups_eml.scr (or .cmd or .ncf) script.

SMS: possibility to send SMS to specified GSM phone number.

Call to Teleguard : the Upsmon may inform global monitoring and control system Teleguard about UPS alarm state. This function is mainly used by service companies for remote monitoring of your UPS.

Fax message: program can to send simple fax message to specified fax number.

Voice call: also is possible to send voice message (WAV file) to specified voice fax number.

Message: user may to change default message for event. It is recommended not to change basic text for possible chaotic messages or log records if will to be specified wrong message for important event.
Note: in message text is allowed to use special words which is during message generation replaced by real values:
$NAME - UPS or Group name which have detected this event.
$SYSNAME - the system name parameter is added to message. See Main parameters dialog description.
$SYSLOC - System location value is used. See Main parameters dialog.
$SHUTTIME - time to shutdown of local system in seconds.
$SHUTTIME1 - time to shutdown of local system in format: hh:mm:ss.
$STH, $STM and $STS - three values: time to shutdown of local system in hours, minutes and seconds.
$REMTIME - remaining UPS battery runtime.
$REMCAP - remaining UPS battery capacity.
$SENSORNAME - name of the sensor on which the event occurred. Valid only if events have been associated with the sensors.

Default: set event action parameters for selected event to default state.

Default all: set all event action parameters for selected event to default state.