Introduction

UM-Editor is a graphic interface utility designed to read an modify configuration files of the following products :

UM-Agent

UM-Client

UM-Console

The appropriate configuration windows are displayed if the corresponding softwares are installed on the system.

To view or modify parameters of a particular software, activate its General Parameters window which must be displayed if the corresponding software is properly installed. Please refer to the appropriate subject in this online Help to find a description of the available parameters.

To save modifications, choose menu File-Save choice on the General Parameters window currently active.

To quit UM-Editor, choose menu File-Exit choice. If changes are not already saved, a message is issued and you are prompt to confirm if you really want to quit without saving.

Online Help is available everywhere by pressing the F1 key. The menu choice Help-Index... is also available.


General parameters

This window allows configuration of UM-Agent general parameters.

IP address (informational)

This is the content of the upsAgentIpaddress UPS MG MIB V1.6 object which should be in accordance with the actual IP address configured for TCP/IP.

This parameter cannot be modified.

Initial value is 'Undefined' when UM-Agent has never been executed on the system.

Community name

This parameter is displayed only for systems which use it.

This is the community name used to connect UM-Agent to the native SNMP agent.

Initial default value is 'public'.

Range : 1 to 16 alphabetic characters and digits

Default setting : public

Trap ACK timeout

This is the number of seconds to wait before trying to resend trap that has not been acknowledged.

Range : 1 - 60

Default setting : 5 seconds

Trap retry count

This is the maximum number of retries to resend trap that has not been acknowledged.

Range : 1 - 10

Default setting : 4 times

Serial port

This is the name of the serial port used for communication with UPS.

The available values are in the list.

Default setting : depending on the system hardware

Baud rate (informational)

This is the baud rate used for communication with the UPS.

This parameter cannot be modified.

Activate trap trace

When checked, the automatic log of SNMP traps sent to specific manager on the network is enabled.

Acknowledgements are also stored in the log file.

Default setting : Disabled

Log size

This is the maximum number of lines (traps and trap acknowledgements) in the trap log file.

This parameter can be modified only if 'Activate trap trace' is checked.

Range : 10 - 5000

Default setting : 1000 lines

Automatic startup

When checked, the automatic start of UM-Agent at system boot is enabled.

Default setting : Enabled

Manager Table...

This button displays the Manager table edition window.

Log settings...

This button displays the Log settings edition window.


Manager table

The list of managers displayed in this window contains the following informations :

(manager) #

This is the number of the manager.

IP address

This is the IP address of the manager.

NMS type

This is the name of the SNMP network management program software installed on the NMS.

Comm. type

This is level of communication protocol between UM-Agent and the manager.

Trap level

A trap is a message over the network reporting an event occuring on the UPS side.

Traps are grouped into levels according to the gravity of the events. Trap level 7 signifies the least serious events, while trap level 1 signifies the most serious events.

The trap level indicates the maximum level of traps sent to the manager.

Community

This parameter is the community name that will be used by UM-Agent when sending traps to the manager.

Trap ack.

This parameter defines the acknowledgement process used when sending a trap to the manager.

Edit...

This button displays the Edit Manager window for the selected manager in the list.

To select a manager in the list, click on its line.

Delete...

This button deletes the selected manager in the list (after user confirmation).

The manager is deleted by setting its 'Comm. type' to 'Invalid'. The other informations are reset to default values.

OK

This button returns to the General parameters window, keeping the modifications made on the manager table.

Cancel

This button returns to the General parameters window, discarding the modifications made on the manager table.


Edit Manager

This window gives access to the information of the manager.

IP address

This is the IP address of the manager.

This address is in decimal dotted notation  : x.y.z.t (ex : 166.12.13.45)

Default setting : 0.0.0.0

NMS type

This is the name of the SNMP network management program software installed on the NMS.

The available values are in the list.

Comm. type

This is level of communication protocol between UM-Agent and the manager.

The available values are in the list.

Trap level

A trap is a message over the network reporting an event occuring on the UPS side.

Traps are grouped into levels according to the gravity of the events. Trap level 7 signifies the least serious events, while trap level 1 signifies the most serious events.

The trap level indicates the maximum level of traps sent to the manager.

The available values are in the list.

Community

This parameter is the community name that will be used by UM-Agent when sending traps to the manager.

The Community name may contain up to 16 alphabetic characters.

Range : 1 to 16 alphabetic characters and digits

Default setting : none

Trap ack.

This parameter defines the acknowledgement process used when sending a trap to the manager.

The available values are in the list.

OK

This button returns to the Manager table window, keeping the modifications made on the manager.

Cancel

This button returns to the Manager table window, discarding the modifications made on the manager.


Log settings

This window gives access to the UM-Agent electrical measures parameters.

Log period

A time interval between periodic measures can be specified by selecting its value.

Log file size

This value is the maximum number of lines stored into the measures log file.

Range : 10 - 5000

Default setting : 1000 lines

Objects list

This list contains all the objects which can be measured.

To add an object (to the Logged objects list), select it by clicking on its line and click on the 'Add >>' button or simply double click on its line.

Logged objects list

This list contains all the objects which will be measured.

To remove an object (that will return to the Objects list), select it by clicking on its line and click on the '<< Remove' button or simply double click on its line.

OK

This button returns to the General parameters window, keeping the modifications made on the Log settings.

Cancel

This button returns to the General parameters window, discarding the modifications made on the Log settings.


General parameters

This window allows configuration of UM-Client general parameters.

Agent IP Address

This is the IP address of the agent connected to the UPS which protects your system. Refer to the UPS agent configuration or to your network administrator to know this address.

Enter the IP address in dotted decimal notation x.y.z.t (for example 168.8.0.73).

Default setting : None

Community name

Community name is used to check the access right to the UPS agent. Refer to the UPS agent configuration and enter the same value.

Range : 1 to 16 alphabetic characters or digits

Default setting : public

Automatic Startup

Select this check box to allow automatic start of UM-Client after system initialization.

Default setting : Selected

Delay after boot

Enter the number of seconds to wait after system initialization before activating UM-Client.

Range : 0 - 9999

Default setting : 120 seconds

Shutdown Duration

Enter the number of seconds your system needs to run its shutdown procedure. This value is used by the agents to generate the 'Off start in progress' event with enough time left to each device to complete its shutdown procedure.

Range : 0 - 9999

Default setting : 180 seconds

Shutdown Timer

The shutdown timer specifies how long UM-Client waits after detecting a power failure, before starting the shutdown sequence. Enter the desired time in minutes. Choose a period that gives the users enough time to close their current application(s) and log out of the system without exhausting the UPS battery supply. See your UPS manual for guidelines on battery autonomy. If the UPS battery runs low before this timer ends, shutdown will begin immediately.

Range : 0 - 9999

Default setting : 5 minutes

Grace Period

Enter the number of minutes, after a power failure, before the first warning message is broadcast to users.

Range : 0 - 9999

Default setting : 1 minute

Shutdown if on Bypass

Select this check box to allow system shutdown if UPS is on bypass.

Default setting : Not selected

Shutdown if Battery Fault

Select this check box to allow system shutdown if UPS is on battery fault.

Default setting : Not selected

Broadcast

If this check box is selected, all users will be informed when UPS goes on battery backup and when power is restored.

Default setting : Selected

Interval between messages

Enter the time interval in minutes between successive broadcasts of power failure messages.

Range : 1 - 9999

Default setting : 1 minute

VA Rating

Enter the VA rating of your system. This parameter is not critical.

Range : 0 - 9999

Default setting : 200 VA

Switchable plug

Select this check box if your UPS has switchable plugs. This information is critical and must be carefully checked on your UPS configuration.

Default setting : Not selected

Receptacle Number

If your UPS is equipped with switchable plugs, enter the receptacle number to which UM-Client system is connected.

This information is critical and must be carefully checked on your UPS configuration.

Range : 1 - 9999

Default setting : 1


General parameters

This window allows configuration of UM-Console general parameters.

Polling rate

This parameter gives the polling rate of managed agents in seconds. A small value allows fresh information on the screen, but might generate a heavy SNMP traffic load on the network. The ideal value is a balance between information freshness and network traffic load, and it depends on how many managed agent you have.

Range : 2 - 9999

Default setting : 3

Get timeout

This is the number of seconds UM-Console will wait for SNMPGET requests being satisfied. A SNMPGET request in a request to read a value in a MIB. Every value comming from managed agents are requested by SNMPGET requests. Too low a value would result in UM-Console considering the SNMP agent does not answer.

If you got timeout problems, check if the community name is Ok.

Range : 2 - 9999

Default setting : 2

Set timeout

This is the number of seconds UM-Console will wait for the SNMPSET request being satisfied. A SNMPSET request in a request to set a value in a MIB. Too low a value would result in UM-Console considering the SNMP agent is unable to write values in its MIB.

If you got timeout problems, check if the community name is Ok.

Range : 2 - 9999

Default setting : 5

User actions file name

Name of the file into which users actions are logged.

Default setting : umco_log

User actions file size

Maximum number of lines in the user actions log file. When this size is reached, new lines are added to the begining of the file, overwriting the oldest lines.

Range : 10 - 5000

Default setting : 1000

Dependencies file name

Name of the file containing the description of dependencies between plugs. This file is generated by the 'List' operation in the output management screen.

Default setting : depend.tmp

User actions to log

This list indicates which user actions are logged by UM-Console into the User actions log file.

To toggle a user action state, double click on its line.

The following user actions can be logged :

Agent list modification : to log modifications in the Device agent list.

UM-Sensor modification : to log modifications of UM-Sensor configuration.

Output configuration modification : to log modifications of Output configuration.

Schedule modification : to log modifications of schedule.

Test period modification : to log modifications of test period.

Diagnostic test : to log use of diagnostic test.

Battery test : to log use of battery test.

Output management modification : to log modifications of Output modifications.

SNMP configuration modification : to log modifications of SNMP configuration.

Privilege on/off : to log toggle between privilege on and off.

Password modification : to log modifications of password.

Restart UPS Communication : to log restart of UPS communication.

Reset UPS Communication : to log reset of UPS communication.

On/off control : to log use of on/off sequences.

Default setting : no action logged.


Missing Topic
The linked-to topic is undefined.


Help on Operating Help
You operate the help system by selecting items from the  help menu.

Common operations include:

- Searching for help

- Contextual help

- Keyboard help

- Click help


Index

To search for topics, press the Search button. Or, go to the Table of Contents topic.


UM-Editor Help Index

Introduction

Introduction

Configuring UM-Agent

General parameters

Manager table

Edit Manager

Log settings

Configuring UM-Client

General parameters

Configuring UM-Console

General parameters


Glossary

No glossary defined.


About Help
Help Viewer

UM-Editor Online Help Version 0.01


Help/On Context
The "Help On Context" menu item provides context dependant help. Help is retrieved according to location of the input focus within  an application.  Typically, controls or windows are highlighted in a  special (and object specific) manner; this shows the input focus.

By pressing the help or F1 key, help is retrieved from the application help file for the currently focused object.


Help/Search
The search help menu item, and the "Search..." button in the help viewer both activate the topic search dialog.

The search dialog is an easy way to see what topics are available within a help file, and to quickly activate a topic.

You can search either by keyword, or in some cases by the help topic title.


Help/On Window
This help item displays help for the current window.


Help/Object Click
Object click help allows the selection of various application objects -- once an object is selected, help for that object is displayed in the help viewer.