Contents

The following Help topics are available :

General Information

Notion of classe

Monitoring :

Main Window

Communication status viewer

Device power consumption viewer

Battery information viewer

Utility power status viewer

UPS receptacle status viewer

Device power status viewer

Environmental monitoring

UM-Switch receptacle status viewer

View Events Window

Log Files Window

Current Device Selection :

Select Device Window

Define Local Device Window

Define Distant Device Window

Actions and Events Definition :

Define Action Window

Define Events Window

Action Options Window

New Driver Window

What to do after installing Jericho

UPS Configuration :

Device Configuration Window

Schedule Window

UPS Control and Test :

Device Control Window

Diagnostics Window

Advanced Usage :

Modify Password Window

Restart UPS Communication Window

Reset UPS Communication Window


General Information

All brand and product names are registered trademarks of their respective holders.

Some functionality such as Setup or Extended Parameters configuration are not described in this Online Help but Help is available when using them.


Notion of classe

This notion exists in the presentation screens of log files.

A class groups by type the actions done with the tools of communication, protection

or supervision.

However, software Agent, Client and PSP don't take any information about classes.

So, classe notion is not used by tools.


Main Window

Click on the green objects on the picture
to get each colour signification.

The main screen directly show essential information about your UPS. Each object status is displayed with a specific colour.

	Green	: No trouble.
	Yellow	: No critical problem.
	Red	: Critical problem.
	Grey	: Unknown status.
 To obtain more information on object status, click on it.

Main screen buttons

	Select device to over view.
	View or configure action/event.
	Basic configuration.
	Scheduling screen.
	Event Log screen.
	On/Off control screen.
	Environmental screen. The value indicates how many UM-Sensors are connected.
	Switchable plugs. The value indicates how many UM-Switchs are connected.


Communication status

Object colour indicates the status of communication between the graphic interface and the UPS.

	Green	: Communication is correct.
	Red	: Communication with UPS has a problem or is initialising.
	Grey	: Configuration trouble forbid communication.


Device power status
Powered device status

Object colour indicates the status of the powered device.

	Green	: Device normally powered.
	Yellow	: Powered device is not safe or is overloaded.
	Red	: Device not powered.
	Grey	: Power status unknown.

Click on this object to access to the Powered device status viewer.


Utility power status

Object colour indicates the status of the utility power.

	Green	: Utility power is correct.
	Yellow	: Utility power is out of normal range. UPS must adjust it.
	Red	: No utility power.
	Grey	: Utility status unknown.

Click on this object to access to the Utility power status viewer.


Battery status

Object colour indicates the status of the battery.

	Green	: Battery is OK.
	Yellow	: Battery is low.
	Red	: Battery must be changed or has a default.
	Grey	: Battery status unknown.

Click on this object to access to the Battery information viewer.


Utility power status viewer

This screen shows values for :

•	The utility status.

•	The utility voltage.

•	The utility frequency.

	Green	: No problems.
	Yellow	: No critical problem.
	Red	: Critical problem.

For some UPS, these later information are not available and only the status is displayed.


Device power status viewer
Powered device status viewer

This screen show values for :

•	Powered device status.

•	Powered device voltage.

•	Powered device frequency.

	Green	: No problems.
	Yellow	: No critical problem.
	Red	: Critical problem.

For some UPS, these later information are not available and only the status is displayed.


Battery information viewer

This screen show :

•	The battery status

•	The battery level.

	Green	: Level greater than 40%.
	Yellow	: Level lower than 40%.
	Red	: Level lower than 20%.
•	The remaining battery autonomy time.

For some UPS, these later information are not available and only the status is displayed.


Device power consumption viewer
Powered device consumption viewer

This screen shows :

•	The powered device status.

•	The UPS load level in percent. When this value is greater than 100%, the UPS is overloaded.

	Green	: No problems.
	Yellow	: UPS is overloaded.
	Red	: UPS output load level is greater than 80%.

For some UPS, these later information are not available and only the status is displayed.


Communication status viewer

This screen shows the UPS communication status.


UPS receptacle status viewer

This screen shows each UPS receptacle status.

•	The main receptacle show status of the main output of the UPS (one or more plugs).

•	Switchable receptacle(s) show the status of switchable receptacle on your UPS.

	: Receptacle is powered.
	: Receptacle is not powered.
	: Receptacle status unknown.

For some UPS, these later information are not all available.


Environmental monitoring

This screen shows 8 alarm contacts status as well as temperature and hygrometry sensors given by each UM-Sensor connected to your UPS.

Alarm contact status :

	Inactive alarm (opened contact)
	Active alarm (closed contact)

Sensors states :

	Green	: No problems.
	Yellow	: No critical problem.
	Red	: Critical problem.
	Grey	: Status unknown.

For some UPS, these later information are not all available.


UM-Switch receptacle status viewer

This screen shows programmable receptacle status of UM-Switch connected to your UPS.

	: Receptacle is powered.
	: Receptacle is not powered.
	: Receptacle status unknown.

For some UPS, these later information are not all available.


Define Local Device Window

The manager can display informations about devices powered by MGE UPS SYSTEMS UPS.

To manage these systems, they must be defined into this software. A managed device can be either local (defined this window) or distant (defined by Define Distant Device Window ). Once devices are defined, it is possible to switch between managed devices (Select Device Window ).

Using this window, you can define or modify the monitored device, when it is the local computer.

The following informations may be typed or modified :

•	Name, defined by the user

•	Type, choosen among the list

•	Community Name for SNMP communication.

The IP Address of the computer is automatically determined.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Define Distant Device Window

The manager can display informations about devices powered by MGE UPS SYSTEMS UPS.

To manage these systems, they must be defined into this software. A managed device can be either local (defined by Define Local Device Window ) or distant (defined by this window). Once devices are defined, it is possible to switch between managed devices (Select Device Window ).

This window displays all the defined distant devices

You may perform the following actions :

•	Click on Add to add a new device. Edit Device Window will be displayed.

•	Click on Modify to modify an existing device. Edit Device Window will be displayded.

•	Click on Delete to delete a device. You will be asked to confirm before deletion.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Edit Device Window

Using this window, you can define or modify the monitored device, when it is a distant computer.

The following informations may be typed or modified :

•	Name,

•	Type,

•	IP Address of the device,

•	Community Name for SNMP communication,

•	Network drive of the monitored device (optional).

IP Address and Community Name can be left blank. In that case, the Drive must be defined. No information about the UPS will be displayed for this device. The Network drive will give access to the configuration files of the application, so you will be able to configure the device in that case.

Network drive may be blank, in that case, functions that need to access this drive will be disabled.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Select Device Window

The manager can display informations about devices powered by MGE UPS SYSTEMS UPS.

To manage these systems, they must be defined into this software. A managed device can be either local (defined by Define Local Device Window ) or distant (defined by Define Distant Device Window ). Once devices are defined, it is possible to switch between managed devices (Select Device Window ).

A device powered by an UPS can communicate with it. In that case, informations about the UPS and installed software (configuration, log files, ...) will be available.

If the device does not communicate with the UPS, only the informations about the installed software will be available. UPS information will remain disabled into the windows.

Some manager functionality will be available or not depending on definition of IP Address and/or Network drive.

Viewer windows are always relative to the current device.

This window displays all the defined distant devices that can be monitored

Select the one you want to monitor and click on OK.

Click on Cancel to quit this window without changing current device.


Log Files Window

This function allows user to see log files. Three different kind of information are logged in separate files :

•	SNMP traps,

•	measurements,

•	user actions.

This function is available only in Extended mode.

You can choose the file you want to display by selecting the appropriate tab :

	Events	every SNMP trap received by UM-Client is logged in this file.
	Measurements	different kind of information measured on the UPS, like battery level, output load voltage, output frequency,... To make these measurements, you must configure UM-Agent bye using Advanced Parameters Configuration : Click on Log settings button in UM-Agent General Parameters window of UM-Editor.
	User interventions	user's actions (modification of UPS configuration, manual tests or controls) are logged in this file.

You can extract logged events for a given period and/or class by typing a class interval, a starting and a finishing date and time.

To do it, type in the beginning class, date and time in the from fields, and the finishing class, date in the To fields, and click on Select.
Date format is DD/MM and Time format is HH:MM

If the from fields and To fields are left empty, the whole log file will be displayed.

To clear the selected log file, click on the Clear button. You will be asked for a confirmation before file is actually cleared.

You can change the log files names by editing them. If you want to see the new file, click again on the Select button to refresh the displayed list.

You can export extracts in a file. To do it, click on Save button, the Save Log File Window will be displayed.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Save Log File Window

The function of this window is to save selected lines of the current log file into another file.

You can type the name of the file. If you select Append, informations will be added to the end of the export file. If not, file will be overwritten.

To leave this window, you may :
Click on OK. Lines will be saved.
Click on Cancel. Lines will not be saved.


Define Events Window

By this window, you can define and modify actions done by the UM-Client software of the monitored device when it detects an event on the UPS. This function is available only in Extended mode.

The first list displays all the events known by UM-Client. Select an event, the list Actions associated to selected event will the display the actions done by UM-Client for this event. You can add an action for this event by selecting it in the Actions list and clicking on << Add. You can remove an action with the Remove >> button

Remark : Start system shutdown action is always associated to Utility failure event, even if it is not listed in the list Actions associated to selected event. When an utility failure occurs, system shutdown is started after a delay depending on parameters such as battery remaining time, system shutdown duration, etc.
If you add Start system shutdown action to the list, system shutdown will start immediately after the event is detected.

For an associated action, you can modify the option(s) by clicking on Options. The Action Options Window is displayed.

If Jericho is installed and running, you can add, modify or remove media actions. Media actions are action that will send message by using Jericho (pagers, fax, e-mail, etc.).

For these actions, you can :

•	Click on New to add a new action by Define Action Window .

•	Click on Edit to modify an existing by Define Action Window.

•	Click on Delete to delete an action. You will be asked to confirm before deletion.

•	Click on Options to modify the option(s) of the action for the selected event in theAction Options Window .

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


View Events Window

By this window, you can view actions done by the UM-Client software of the monitored device when it detects an event on the UPS. This function is available only in Standard mode.

The first list displays all the events known by UM-Client. Select an event, the list Actions associated to selected event will the display the actions done by UM-Client for this event.

For an associated action, you can modify the option(s) by clicking on Options. The Action Options Window is displayed.

Remark : if the selected action is a media action, you may modify its option(s) only if Jericho is installed and running.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.

See also : Define Events Window


Action Options Window

dir

By this window, you can define and modify the option(s) associated to an action when it takes place for an event.

Depending on the action, the following options can be defined :

•	For messaging action.
You can modify or replace the text of the message according to your needs.

•	For script execution action.
You can type the name of the script. The script file must be located into directory UPSMAN\UMCLIENT in order to be executed.
Remark : if you need to execute a system command and not a script file, type a $ before the name of the command.

•	For some media actions that accept a message and a file name.
You can modify or replace the text of the message according to your needs. The file must be located into directory UPSMAN\UMCLIENT.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Define Action Window

This window allows you to define or modify a media action.

You must define :

•	the name of the action,

•	the media, by selecting it in the list,

•	the address corresponding to the selected media.

You can also activate configuration of Pagers and Mails (Jericho) by clicking on Configure. You will then be able to :

•	configure communication link,

•	configure your modem,

•	configure your communication drivers.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Device Control Window

By this window, you can control (switch off or switch on) each plug of the UPS and of the UM-Switch. This function is available only in Extended mode.

For security reasons, even if immediate switch off is selected, actual switch off will occur after security delay. This delay is used by UM-Client to perform a graceful shutdown of the System. You can view this delay into Device Configuration Windowk, parameter : Shutdown duration.

The "General" tab deals only with the main plug of the UPS. Switching it off will turn the entire UPS off.

The "Devices" tab is related to switchable plugs (of the UPS and eventually of the UM-Switch)

Each plug is displayed as a symbol which color indicates its status :

	: The plug is On.
	: The plug is Off.

To control a plug :

•	select the appropriate tab,

•	select the desired plug;

If the plug is On, you can :

•	Switch it off immediately : select "Immediate Switch Off" then click on Execute,

•	Switch it off after a delay : select "Switch Off after", define the delay before actual switch off, then click Execute. In that case, you can restart the plug after a selectable delay.

If the plug is Off, you can :

•	Switch it on immediately : select "Immediate Switch On" then click on Execute,

•	Switch it on after a delay : select "Switch On after", define the delay before actual switch off, then click Execute.

The current state of control sequence is displayed in the Status field for the selected plug. When the control sequence is ended, the color of the plug corresponds to the new state of the plug and the Status is None.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Schedule Window

This window displays the turning on and turning off times of the UPS. By using it, the UPS can be automatically turned on or off any day of the week. This function is available only in Extended mode.

For every day of the week, you can set a power on time and a power off time by selecting a time in the corresponding pull down list. If you do not want a power on time or a power off time, select No.

The bargraphs on the rights shows power on and power off periods. Each bargraph represents a day. Power on periods are in green, and power off periods are red.

The default state at the beginning of a day is the state at the end of the previous day.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Diagnostics Window

This function allows user to send immediate test commands to the UPS and to define the period of the automatic diagnostic. This function is available only in Extended mode.

•	By clicking on Start test in the Diagnostic test zone, you start an UPS test. This test checks the states of the main functions of the UPS.
The test result is displayed after a few seconds.

•	By clicking on Start test in the Battery test zone, the user starts an immediate battery diagnostic. The test result is displayed after the diagnostic is completed, which can last a few minutes.

The user can chose a period for the automatic battery test in the Periodic test zone (not available on all UPSs).

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Device Configuration Window

General UPS configuration

By this window you can view and configure general shutdown and restart parameters of the UPS.

These parameters are :

•	Bootup duration : Maximum reinitialization time for the system powered by this plug.
This parameter is given in seconds. At the end of this time, a trap will be sent over the network.
To change this parameter, the UM-Agent set up must be downloaded.

•	Minimum delay : Minimum time (starting from the beginning of the UPS shutdown procedure) during which any attempt to restart the UPS is forbidden.
This parameter is read-only  and indicated in minutes.

•	Shutdown duration : This is the maximum shutdown duration for systems powered by this plug.
This parameter is read-only and given in minutes. There are several ways of changing it:
download the UM-Agent configuration or edit the Shutdown duration parameter in the umc_par file (UM-Client directory).

•	Shutdown timer : This parameter corresponds to the time between the mains failure and the moment at which the system shutdown request trap is sent.
At the end of this period, the UPS shutdown is scheduled for the end of the Shutdown duration.
In order to ensure that plugs shut down properly (shutdown of switchable plugs before plug 1 and UPS shutdown) the general Shutdown duration must be longer than the maximum Shutdown duration for the switchable plugs.

Device configuration

By this window you can view and configure naming, shutdown and restart parameters of the switchable plugs.

These parameters are :

•	Name : Name of the plug, defined by the user.

•	Type : Type of the plug, choosen in the list.

•	Restart delay : delay between utility is restored and the plug is switched on
This parameter is indicated in minutes.

•	Shutdown timer : This parameter corresponds to the time between the mains failure and the moment at which the plug is switched off.
This parameter is indicated in minutes.

To leave this window, you may :
Click on OK. Modifications will be saved.
Click on Cancel. Modifications will be discarded.


Restart UPS Communication Window

The restart function is a versatile function for troubleshooting. It enables you to restart the UPS agent remotely. This function is only available in Extended mode.

To restart the UPS agent, proceed as follows:

•	In the Actions menu, select Restart UPS Communication.

•	Click OK to restart the agent, or click Cancel to abandon the operation.


Reset UPS Communication Window

To retrieve the original setup of the UPS agent (and start on a firm basis) you may reset the system. This function is only available in Manager mode. All the settings of the current UPS agent will be replaced with the default factory settings. All the current UM-Agent (or UM-Link) settings will be set to their default value.

WARNING: this is a risky operation which should only be performed if it is strictly necessary.

After resetting UPS communication, check that UM-Agent has correctly restarted its communication with the UPS. It may be necessary to restart it with the -n option (see UM-Agent documentation).

To reset the current agent, proceed as follows:

•	In the Actions menu, select Reset UPS Communication.

•	Click OK to reset the agent, or click Cancel to abandon the operation.

•	shut down UM-Agent and restart it with the -n option as the device configuration has been changed by this function.


Type Password Window

In this window you can type the password defined to access to Extended mode. Characters types don't display when typing.

If the password you typed is correct, you access to Extended mode when clicking on OK.


Modify Password Window

This window allows you to define a password to access to Extended mode. You can also modify an already defined password. This function is only available in Extended mode.

The new password must be type twice identically and is not displayed while typing.

To leave this window, you may :
Click on OK. Defined password will be saved.
Click on Cancel. Modifications will be discarded.


New Driver Window

This window is displayed to prepare installation of Jericho (pager system and mail). You must choose the letter of the CD-ROM drive in which Solution-Pac CD is installed (automatically displayed if a CD-ROM drive is connected to your computer).

Then you can :
Click on OK. Installation of new driver will begin.
Click on Cancel. Installation will be aborted.


What to do after installing Jericho

1) Actions for Microsoft Windows systems

If you installed new drivers for local device, Solution-Pac Wan software which protects your computer will be able to send pager or e-mail messages. To ensure that this function will operate successfully, you must check the following conditions :

•	Jericho software must be running. After installation, Jericho starts automatically after system startup. To start it manually, click on its icon in MGE UPS SYSTEMS program group.

•	Solution-Pac Wan software must be running. After installation, Solution-Pac Wan starts automatically after system startup. To start it manually, click on " SP -  WAN Start Monitoring" icon in MGE UPS SYSTEMS program group.

•	Pager or E-mail actions for desired events must have been configured in Define Events Window

2) Actions for NetWare systems

If you installed new drivers for a NetWare Server, Solution-Pac Wan software which protects your computer will be able to send pager or e-mail messages. To ensure that this function will operate successfully, you must check the following conditions :

•	Determine local computer's IPX address. Type the following command : JER4NW.EXE  /A will display the IPX address of your computer.
For example, if C: is the name of your drive, type :

C:\UPSMAN\MMI\JERICHO\JER4NW.EXE  /A

Sample result : 0000000200608C61D2EC

•	Configure Solution-Pac Wan software with the IPX address of your computer. With a text editor, copy the address (without space) into the file UMC_PAR of the Solution-Pac Wan of the server ([Communication] section, parameter NetwareDeport).

Example :

[Communication]

NetwareDeport=0000000200608C61D2EC

•	Start JERICHO software on your local workstation. After installation, Jericho starts automatically after system startup. To start it manually, click on its icon in MGE UPS SYSTEMS program group.

•	Start NetWare distant module for Jericho. After installation, this module starts automatically when Jericho module is starting.

To start it manually, use the command JER4NW.EXE (without parameter).

For example, if C: is the name of your drive, type :

C:\UPSMAN\MMI\JERICHO\JER4NW.EXE

•	Update configuration. Stop and then restart Solution-Pac Wan to update its configuration with the IPX address.


About Window

This window displays information about this software.

You can leave it by clicking on OK.