What is this ?

This document describes Personal Solution-Pac for MacOS9, a software configuration and monitoring tool to allow owners of MGE UPS Systems' hardware to know the state of the UPS connected, as well as configure shutdown-related actions in case of a power failure.

Requirements

MGE UPS requires MacOS version 9.0.4 or newer, running on Apple iMac, Blue G3 or G4.

Note for Mac OS 9.2.x

For MAC OS 9.2.x users, we recommend to disconnect the USB link from your UPS before performing the software installation. If your have a previous version of Personal Solution Pac, uninstall it before loading the new one.

Installing and using the software

We propose bin and hqx packages for Personal Solution Pac.

Using Personal Solution-Pac is very easy. It consists of two components:

• "MGE UPS" (a Control Panel).
• "MGE UPS Extension"

Here is what these two files look like in the Finder:

The installer will take care of placing these two files where they belong on your hard disk.

"MGE UPS" goes into the System's "Control Panel" folder and "MGE UPS Extension" goes into the System's "Extensions" folder.

"MGE UPS Extension" is loaded automatically on start-up and remains active until the computer is shutdown. Its purpose is to keep an eye on the MGE UPS device and take appropriate action when power-related events occur.

On start-up, if no MGE UPS is connected to the USB port, it warns the user with the following message:

If a UPS is connected, it periodically checks for its current status and keeps a log of what happens. In case of a AC power loss, "MGE UPS Extension" notifies the user by flashing a battery icon in the Apple menu.

and displays the following message:

"MGE UPS Extension" is also responsible for:

• starting the execution of any AppleScript specified in the "MGE UPS" Control Panel in case of a power failure.
• initiating an orderly shutdown of the machine when the battery capacity reaches the level specified.
• sending a 'shutdown' message to Macintoshes on the network also relying the UPS.

The "MGE UPS" Control Panel provides an interface to "MGE UPS Extension" and allows the user to view the current state of the UPS, as well as set various options. The Control Panel's window consists of 5 sub-panels (UPS, Log, Options, Advanced and Network):

The UPS panel

This is the main panel, showing the exact type of UPS connected, the current power source (AC Power or UPS), the battery status (charging/discharging), battery level and estimated remaining time.

This panel allows you to set the shutdown level. When running off battery, the computer will be shutdown when the remaining capacity reaches that level. The default value is 30%. You might want to set a higher value in order to prevent the UPS from discharging completely in case of a prolonged power cut. Don't forget to click on the "Apply" button to validate the new setting.

The Log panel

Go to this panel to view the log, as recorded by the "MGE UPS Extension". Click on the "Clear" button to reset it.

The Options panel

Use this panel if you would like to specify an AppleScript to be automatically executed in case of a power failure. If you would like an AppleScript (or any other application) to be executed at the time of the shutdown, place it in the System Folder's "Shutdown Items" folder.

The "Restart automatically after power failure" option is useful if the machine is being used as a (unattended) server. Here is what it does:

When initiating the machine shutdown, it enables the MacOS "Restart automatically after power failure" feature (that you can also set in the "Energy Saver" control panel) and instructs the UPS to switch itself off after a default delay of 2 minutes. By this time the computer will be turned off. If it takes longer for the computer to complete its shutdown, make sure that you increase this value.

If "Restart automatically after power failure" is not selected, the shutdown procedure only consists of a 'shutdown' AppleEvent sent to the Finder. The UPS remains switched on.

For you convenience and at no extra charge a button to quickly open the "Energy Saver" control panel is also provided.

The Advanced panel

This panel allows the user to change the default voltage range for Ellipse and Ellipse Premium UPSs.

For Ellipse the default input voltage is 184V - 264V (96V - 138V in the US). It is possible to expand this range to 161V-264V (84V - 138V in the US).

For Premium the default input voltage is 161V - 264V (84V - 138V in the US). It is possible to expand this range to 150V-264V (78V - 138V in the US).

To switch between the standard and expanded configuration, simply double-click on the list item, or click on the "Change Setting..." button.

If your UPS supports switchable outlet group, they will also be listed in this panel so that it is possible to change their characteristics.

Here is what things look like in the case of a Pulsar EXtreme C UPS, which features two outlet groups:

You can manually switch on or off each outlet by double clicking on the "State" list item. The other settings are:

• Startup Timer, which is the period of time the UPS waits after AC power is restored before switching on the outlet.
• Shutdown Timer, which is the period of time the UPS waits after a power failure before switching off the outlet.
• Battery Capacity Limit, same as Shutdown Timer except that the outlet will be switched off when the battery capacity reaches the specified level (in percent).

Double-click on the setting you would like to change, and specify the new value in the dialog box that appears.

For example, you might have connected a printer to the first outlet group, and you would like it to be switched off as soon as a power failure occurs, in order to increase the life of the battery for other more important devices connected to the second outlet group. In this case you would set "Battery Capacity Limit" of the first outlet to say 95%, and 0% for the second outlet.

The Network panel

Last but not least, the "MGE UPS" control panel lets you specify other Macintoshes on the network also relying on the UPS. These machines (remote machines) will be shut down as well.

Follow these 5 steps in order to configure all the machines:

Step 1 (remote machine)

No special software needs to be installed, but a minimum configuration is required on a remote machine so that the "MGE UPS Extension" can instruct it to shut down. The remote machine must allow guest access to program linking. This is done by following these steps:

1. Open the "File Sharing" control panel.
2. Go to the "Start/Stop" tab.
3. Activate Program Linking.
4. Go to the "Users & Groups" tab.
5. Double click on the "Guest" user.
6. In the "Sharing" panel, select "Allow guests to link to programs on this computer".
7. Close the "File Sharing" control panel.

(Note that Program Linking does not require file sharing to be enabled, and it can remain disabled if this was the case.)

The remote machine is now ready.

Step 2 (main machine)

To add it to the list of computer to shutdown, click on the "Add..." button. The standard program linking dialog box to locate an application on the network is displayed, and allows you to select the remote Finder application:



Click on OK and the computer is added to the list:



(A maximum of 128 machines can be selected.)

IMPORTANT!

Step 3 - AutoGuest (main machine)

Because of a limitation in the Macintosh Operating System, the "AutoGuest" software must be installed to allow the "MGE UPS Extension" to successfully send the 'shutdown' AppleEvent to remote machines.

AutoGuest is a small Extension that enables a connection to a remote machine (as a guest) without displaying the standard program linking log on dialog box. AutoGuest also allows background processes (like "MGE UPS Extension") to send remote AppleEvents (MacOS normally requires the application to be in the foreground).

AutoGuest must only be installed on the main machine and is not required on the remote machines.

AutoGuest is an Apple product and can be found at:

ftp://ftp.apple.com/developer/Tool_Chest/OS_Utilities/AutoGuest_3.0.sit.hqx

The latest version is version 3.0.1. Please refer to the documention included in the package when installing AutoGuest.

Step 4 - NoSoftPowerOff (remote machine)

NoSoftPowerOff (located in the "MGE UPS 1.2:Utilities:" folder) is a small application program you might want to install on remote computers. Because the remote computers are switched off by sending a 'shutdown' AppleEvent (the equivalent of the user manually selecting 'shut down' in the Finder's Special menu), the machines will not automatically restart when AC power is restored. In case of the machines being used as servers, this is not on. In order to solve this problem, place a copy of the "NoSoftPowerOff" application in the remote machine's "Shutdown Items" folder.

When launched, NoSoftPowerOff configures the System so that it does *not* actually switch the machine off when the shutdown procedure is completed, thus emulating the behaviour of older Macintoshes that do not support soft powering off (and display the standard "It is now safe to turn off your Macintosh" message). Installing NoSoftPowerOff is not required on these older machines.

Also, don't forget to go to the "Energy Saver" control panel and enable the "Restart automatically after power failure" option.

NoSoftPowerOff's functionnality is built into the "MGE UPS Extension" and is not required on the machine that communicates with the UPS.

Step 5 - Notifying Remote Machines (remote machine)

By default, the MGE UPS software does not notify a remote machine when a power failure occurs. It will only shut it down when the battery level reaches the shutdown level. However, it is possible to use the following AppleScript in order to accomplish this:

using terms from application "Finder"
	tell application "Finder" of machine "Ordinateur de Software Support"
		say "There is a power failure and this computer will be shut down soon"
	end tell
end using terms from

Compile and set this script as the warning script in the "Options" panel and there you go. (of course the Speech Manager must be available on the remote machine for this to work.)

Uninstalling the MGE UPS Software

Also provided in this package is a utility program called "MGE UPS Uninstaller" (located in the "MGE UPS 1.2:Utilities:" folder). This application scans your active System folder and removes any MGE UPS-related files ("MGE UPS", "MGE UPS Extension", preferences and log files). It will also ask you if you would like MacOS's default UPS support to be re-enabled. Answer "No" to that question if you are planning to re-install the MGE UPS software afterwards.

Document Reference: 51 029 474 XU/AF