OPM CON PSW JMP DSH XGB 0220 - NETI3187046.la01.neti.ee/.../DataShield/OPM_CON_PSW_JMP_DSH_XGB_0220.pdf · OPM_CON_PSW_JMP_DSH_XGB_0220.doc - March 05 Operating manual GE Digital

GE Consumer & Industrial Power Protection

Operating Manual Digital Energy™ JUMP DataShield 2.2.0 Protection software package for JAVA™ supporting platforms Manufactured by:

GE Digital Energy General Electric Company CH – 6595 Riazzino (Locarno) Switzerland T +41 (0)91 / 850 51 51 F +41 (0)91 / 850 51 44

www.gedigitalenergy.com

Modifications reserved Page 2/90 OPM_CON_PSW_JMP_DSH_XGB_0220.doc - March 05 Operating manual GE Digital Energy DataShield ver 2.2.0

Model: Digital Energy™ JUMP DataShield 2.2.0

Date of issue: 10.03.2005

File name: OPM_CON_PSW_JML_DSH_XGB_0220.doc

Revision: 2.2.0

Identification No.

Up-dating

Revision Concerns Date

2.2.0 Added new functionality - centralized event logging - - USB support

10.03.2005

COPYRIGHT © 2005 by GE

All rights reserved.

The information contained in this publication is intended solely for the purposes indicated.

The present publication and any other documentation supplied with the software is not to be reproduced, either in part or in its entirety, without the prior written consent of GE.

The illustrations and plans describing the equipment are intended as general reference only and are not necessarily complete in every detail.

The content of this publication may be subject to modification without prior notice.


Dear Customer,

We thank you for selecting our products and are pleased to count you amongst our very valued customers at GE. Please read carefully the Operating Manual, which contains all the necessary information and describes all you need to know about the use of JUMP DataShield.

Thank you for choosing GE!

Manufactured by: Distributed by: Your service contact:

g

GE Digital Energy General Electric Company

CH – 6595 Riazzino (Locarno) Switzerland


Table of contents Page

1 FUNCTIONAL EXPLANATION......................................................................................................................... 7 1.1 Protection ..............................................................................................................................................................................7 1.2 Management .......................................................................................................................................................................8 1.3 Analysis ..................................................................................................................................................................................8

2 GENERAL DESIGN ........................................................................................................................................... 9 2.1 SNMP Agent, Client and Manager..............................................................................................................................9 2.2 DataShield protection module ....................................................................................................................................9 2.3 DataShield Management Module (JUMPView) ................................................................................................. 10

3 HARDWARE CONFIGURATIONS OF DATASHIELD ...................................................................................11 3.1 Stand Alone UPS Connections using DataShield (One system per UPS).............................................. 11 3.2 Stand alone ups connected to the USB-interface of the system............................................................ 12 3.3 Networked UPS Connections using DataShield (Several systems)......................................................... 12

4 JUMP DATASHIELD ON MICROSOFT WINDOWS .....................................................................................14 4.1 Installation.......................................................................................................................................................................... 14 4.2 Software startup ............................................................................................................................................................. 18 4.3 JUMP Datashield serial (RS232) configuration.................................................................................................. 20 4.4 JUMP Datashield SNMP CONFIGURATION.......................................................................................................... 24 4.5 JUMP Datashield SNMP proxy agent configuration ...................................................................................... 28 4.6 JUMP DataShield low level configuration in textual mode (Experts only)........................................... 31 4.7 JUMP Datashield and Remote computer shutdown via script................................................................. 32

5 GENERAL SOFTWARE FUNCTIONALITY.....................................................................................................33 5.1 Password and security managment..................................................................................................................... 33 5.2 Advanced communication settings....................................................................................................................... 34 5.3 Alarm management ...................................................................................................................................................... 36 5.4 Script execution action ................................................................................................................................................ 38 5.5 Send emails ....................................................................................................................................................................... 40 5.6 Configure scheduled actions .................................................................................................................................... 42 5.7 View configuration ......................................................................................................................................................... 44 5.8 Global configuration parameters ........................................................................................................................... 45 5.9 Run a test............................................................................................................................................................................ 45 5.10 Data logging...................................................................................................................................................................... 46 5.11 Centralised event logging........................................................................................................................................... 47

5.11.1 General system overviev ............................................................................................................................ 47 5.11.2 Preconditions.................................................................................................................................................... 48 5.11.3 Security ............................................................................................................................................................... 48 5.11.4 Installing DataShield with centralised logging functionality .................................................... 48 5.11.5 System configuration................................................................................................................................... 49

6 JUMP DATASHIELD ON LINUX ....................................................................................................................51 6.1 Prerequisites...................................................................................................................................................................... 51 6.2 Installation.......................................................................................................................................................................... 51 6.3 Linux configuration screen ........................................................................................................................................ 54 6.4 Linux and RS232.............................................................................................................................................................. 55 6.5 Linux and SNMP communication............................................................................................................................ 55 6.6 Linux and SNMP proxy agent ................................................................................................................................... 55 6.7 Linux automatic startup as Daemon .................................................................................................................... 55


7 JUMP DATASHIELD ON SUN SOLARIS .......................................................................................................57 7.1 Prerequisites...................................................................................................................................................................... 57 7.2 Installation.......................................................................................................................................................................... 57 7.3 Sun Solaris configuration screen ............................................................................................................................ 59 7.4 Sun Solaris and RS232.................................................................................................................................................. 60 7.5 Sun Solaris and SNMP communication................................................................................................................ 60 7.6 Sun Solaris and SNMP proxy agent ....................................................................................................................... 60 7.7 Sun Solaris automatic startup as Daemon ........................................................................................................ 60

8 JUMP DATASHIELD ON NOVELL NETWARE..............................................................................................61 8.1 Prerequisites...................................................................................................................................................................... 61 8.2 Installation.......................................................................................................................................................................... 61

9 JUMP DATASHIELD ON MAC OS 9..............................................................................................................62 9.1 Prerequisites...................................................................................................................................................................... 62 9.2 Installation.......................................................................................................................................................................... 62 9.3 Create the application.................................................................................................................................................. 63 9.4 MAC OS 9 And SNMP communication .................................................................................................................. 63

10 JUMP DATASHIELD ON MAC OS X..............................................................................................................64 10.1 Installation.......................................................................................................................................................................... 64 10.2 Graphic installation........................................................................................................................................................ 65 10.3 MAC OS X and SNMP communication .................................................................................................................. 68

11 JUMP DATASHIELD USING USB ON MS WINDOWS ................................................................................69 11.1 Installing DataShield together with USB to serial support.......................................................................... 69 11.2 Installing USB to serial support when updating DataShield ...................................................................... 71 11.3 Updating DataShield without changings on USB to serial support ....................................................... 71 11.4 Updating USB to serial support................................................................................................................................ 72 11.5 Manual installation of USB to serial support ..................................................................................................... 75

12 JUMP DATASHIELD USING USB ON LINUX ...............................................................................................76 12.1 Installing DataShield together with USB to serial support.......................................................................... 76 12.2 Installing USB to serial support when updating DataShield ...................................................................... 77 12.3 Updating DataShield without changes on USB to serial support ........................................................... 77 12.4 Updating USB to serial support................................................................................................................................ 78 12.5 Manual installation of USB to serial support ..................................................................................................... 79

13 JUMP DATASHIELD USING USB ON MAC OS9..........................................................................................80 13.1 Manual installation of USB to serial support ..................................................................................................... 80

14 JUMP DATASHIELD USING USB ON MAC OS X.........................................................................................81 14.1 Installing DataShield together with USB to serial support.......................................................................... 81 14.2 Installing USB to serial support when updating datashield....................................................................... 82 14.3 Updating DataShield without changings on USB to serial support ....................................................... 82 14.4 Updating USB to serial support................................................................................................................................ 83 14.5 Manual installation of USB to serial support ..................................................................................................... 84

15 ALARMS MONITORED BY DATASHIELD.....................................................................................................85

16 TROUBLESHOOTING ....................................................................................................................................87

17 PRODUCT DESCRIPTION..............................................................................................................................90


1 FUNCTIONAL EXPLANATION A UPS is designed to protect your IT structure from system damage and data loss caused by power failures or instabilities. Since a UPS can supply backup power to a computer for only a limited period of battery run-time, UPS software completes and automates your protection solution. It is important to understand how DataShield works in order to make a suitable plan for your particular operating environment. What DataShield provides

• DataShield enhances the value of your power protection by providing many complementary features to your UPS. It is the safest UPS software, which provides operating system protection, file saving protection and entire network protection.

• DataShield is a high value UPS management solution supporting both WAN and LAN UPS management (SNMP).

• DataShield is a JAVA application and supports remote management via Internet or any other TCP/IP network.

• Because of its JAVA nature DataShield runs on all Operating Systems supporting JAVA.

• In addition, DataShield provides power history analysis and different functional views of the UPS and its operating environment.

1.1 Protection Since a UPS can supply backup power to a computer for only a limited period of battery run-time, protection software completes and automates your protection in three ways. Operating System Protection Almost all advanced operating systems need a user to shutdown before turning off the power. If not, the system might be damaged or data might be lost. Protection software can automate this shutdown before the UPS runs out of battery power. DataShield provides users with a very complete alarm notification feature which includes network broadcast, sound, paging and e-mail, in case power fails, the UPS fails or the power becomes dangerously unstable. In addition DataShield increases system reliability and uptime by providing File and Network protection. File Protection Before shutting down the operating system, DataShield tries to close all open files and save them when the Operating System supports this. This advanced feature can prevent your work from losing data. Network Protection In a network environment, some computers might need to be shut down in the correct order. For example, a Windows XP workstation is using data from its Windows 2003 Server. In this case, the workstation needs to perform its shut down before the Server to avoid data loss in the network. DataShield provides complete network protection. The system manager can define the safety relations so DataShield will perform orderly shutdown procedures on several computers when a critical event occurs anywhere in the corporate network.


1.2 Management Nowadays, network management plays an increasingly important role. In addition to the fundamental protection function, DataShield provides a UPS management function. Single UPS management In short, management includes view (getting information) and control (changing settings) functions. Management via your standard browser DataShield can be remotely accessed by use of any standard network browser because of its built-in Web-server. This allows you to look at the DataShield documentation, log files and real-time UPS measurement values from anywhere in the world. Also management of the UPS from your standard browser becomes possible after you have successfully passed the authorization procedure. SNMP Management In addition to managing a single UPS, DataShield allows the user to manage any UPS in the network from one point:

- DataShield itself can manage a large number of UPS in a network and configured actions can be performed in case of all possible events. All of these features can be managed via your standard browser.

- Integration into existing Network Management software is easy because DataShield is compliant to the industry Simple Network Management Protocol (SNMP). DataShield graphic interface JUMPView snaps in to standard SNMP platform such as HP OpenView and Novell ManageWise.

1.3 Analysis A system manager needs to receive valuable power history data information in order to increase the reliability of the power management. For this reason, DataShield provides two kinds of tools to help optimize mains management:

• Event analysis. This tool sums up and analyzes power events providing: date, time, location and event information (power failures, battery low conditions, etc...).

• Data analysis. This tool shows a history log of power data (input voltage, output voltage, input frequency and output frequency) on the screen to let you analyze the power quality.


2 GENERAL DESIGN Our UPS software solutions are completely based on the SNMP protocol. Therefore a small introduction of SNMP is provided in section 2.1. DataShield itself is a modular program consisting of two separate programs: An invisible protection program ‘DataShield’ (section 2.2) and a graphic interface program called ‘JUMPView’ (section 2.3). 2.1 SNMP Agent, Client and Manager There are three elements related to SNMP. This short overview briefly explains their function in a SNMP environment. Agent The agent makes the UPS information available on the network, using the SNMP

communication protocol. When power fails locally, the agent provides all the alarm details onto the network, were it will be received by the clients throughout the network.

There are two physical types of agents with identical functionality: 1. Software Agent this is a program (e.g. DataShield), which runs on a server. 2. Hardware Agent A SNMP interface box or SNMP interface card.

Client This is a non-visible element of DataShield. Clients are dependent machines, somewhere in the network. When power problems occur on the UPS connected to the Agent, it triggers the clients, which set their protective functionality into action. Clients can reside on any operating system (UNIX, Novell, Windows, OS/2, MacOS and all other JAVA supporting platforms).

Manager This is the management station to which SNMP traps should be sent in case of alarms. Traps are small information packets, sent out by the Agent, with information about an activated (or deactivated) alarm. SNMP Management software will catch the trap and visualize this on the console in the way of a flashing icon or pop-up message. Most management software has a large scale of customizable actions, which can be performed at arrival of traps. An SNMP Manager is a powerful tool for centralized management of all networked devices. Examples of these managers are HP-OpenView, IBM Tivoli and CA Unicenter TNG.

2.2 DataShield protection module DataShield is resident on the system. It monitors and handles signals sent by: a) An intelligent UPS that protects it (directly via computer RS232 port). b) Any UPS in a TCP/IP network (Via an SNMP (Proxy) Agent)

These interfacing options are described in detail in the next paragraphs. The protection program runs as an automatic background process: • As a UPS protection program (SNMP Client): It communicates with the UPS via the serial cable or via

the network to receive vital information and to control the UPS. In addition, it broadcasts event messages, logs events and data, and shuts down the operating system and the UPS when necessary.

• As an SNMP agent program: It answers requests for information or commands from any central SNMP management station or other monitoring software. When a critical power or UPS event occurs, it sends alarms to a predefined network management station. Thus the SNMP agent makes the attached UPS available on the network.

• As a WWW-server program: It answers requests for information or commands from any standard browser in the world pointing to it. Because of this flexible and easy way to access the UPS information, there is a built-in authorization procedure to ensure that only authorized persons have access to it.


2.3 DataShield Management Module (JUMPView) This is a user interface program that displays the UPS information and allows the user to control the UPS:

• As a local or remote management program: It is a bridge between the protection program and the user.

It displays the UPS information on the screen and provides an interface for you to change settings and control the UPS.

• As a central management program: It manages and displays all networked UPS from one workstation and passes commands to any UPS when the system operator wants to change settings or control the UPS.

• From anywhere in the world: The complete functionality is both local and remote available because the software runs as a JAVA applet in any standard browser from any place in the world.

Network Management

Network management means that people want to monitor and manage all network devices from a central location. This is getting more and more important as the network expands. Without network management, system administrators have to go on site a lot to check and control the devices on the network one by one.

The big advantage of DataShield is its ability to manage all UPS on one central point, but access to this central point is not limited in any way. From all over the internet/network you can access your management station and work with it the same way like you are at the management console. This gives you the possibility to act immediately when there is an emergency going on, there is no time wasted anymore to go to either the UPS itself or to the Network management station. Network management consists of two elements: a management system (manager) and a managed system (UPS agent). They use a standard protocol to communicate with each other, called SNMP. The UPS industry has defined the specific UPS parameters in the UPS-MIB (described in RFC1628).


3 HARDWARE CONFIGURATIONS OF DATASHIELD This chapter shows how the UPS and computer are connected to get the full functionality of the DataShield software. Several configurations are possible depending on the type of UPS and computer or network configuration.

3.1 Stand Alone UPS Connections using DataShield (One system per UPS) There are two ways to connect a single UPS to the serial interface (RS232) of a single system using DataShield: using an intelligent interface cable or using a contact interface cable. a) Intelligent Interface (RS232)

An Intelligent UPS can be connected directly to a stand-alone system, via a free serial RS232 (DTE) Port on that system (e.g. a free printer or modem port).

Figure 3.1.1: Intelligent UPS connected directly to computer system

b) Contact Interface

A contact closure UPS can be connected directly to the RS232 Port of a stand-alone system. Any UPS brand can thus be connected to the DataShield program, using its contact interface, thus not harming any prior network investments

Figure 3.1.2: Contact Interface UPS connected directly to computer system

Note: When using this hardware setup only the Power Failure and Battery Low alarms are monitored.


3.2 Stand alone ups connected to the USB-interface of the system In case your system does not provide a serial RS232 interface, you may connect the UPS to the USB interface of your system by using the attached USB to Serial converter.

Figure 3.2.1

USB Interface VIC23 / VIC25 cable

The needed driver is installed directly after the DataShield Software installation procedure. For more details please refer to the chapters JUMP DataShield using USB. 3.3 Networked UPS Connections using DataShield (Several systems) There are two ways to connect multiple systems with one UPS using the network as communication link: via a General Electric Digital Energy SNMP Interface Box/Card (Agent) or via a Server and General Electric Digital Energy Software (Proxy Agent). Both types of agents support intelligent, as well as contact interface UPS. a) Using a General Electric Digital Energy SNMP/Web Interface card or box

Any UPS connected to a General Electric Digital Energy SNMP/Web Interface can communicate with a number of systems or workstations (Clients) via a TCP/IP network. The SNMP/Web Interface communicates directly with the network (Ethernet or Token Ring). Protected systems can (re) act as a client to alarms from that UPS. This solution is preferred, above the one mentioned at point “d.”, because the SNMP/Web Interface has a guaranteed 100% uptime, while proxy agents are depending on the uptime of the server on which they run.

Figure 3.3: Any UPS using an SNMP Interface Box/Card and Clients

b) Using the DataShield (Proxy) Agent

Any UPS connected serially to a System running the DataShield agent can communicate with a number of other systems or workstations (Clients) via a TCP/IP network. The DataShield Proxy Agent (an AGENT) communicates directly with the network. Protected systems can (re) act as a client to alarms from that UPS. This solution is often more cost efficient than using the SNMP/Web Interface.


Figure 3.4: Any UPS using the AGENT and network.

* NOTE: GE offers SNMP/Web Interface boxes and cards for Ethernet.

Proxy Agents and Protection Clients for UNIX, Novell, OS/2, Windows and all JAVA supporting platforms.


4 JUMP DATASHIELD ON MICROSOFT WINDOWS DataShield installation procedure is exactly the same for all the Microsoft Windows operating systems family, such as NT/2000/XP/2003. Therefore this documentation shows the procedure realized on Windows XP graphic layout, however the configuration can be applied to all the others Microsoft Operating Systems. 4.1 Installation a) Extract JUMP DataShield package content into a temporary directory in your local drive and

double click on the file named ‘install.bat’.(See Figure 4.1.1)

Figure 4.1.1

b) Once the file ‘install.bat’ has been executed a graphic dialog box appears on the screen.

Click “Next” to display the welcome box. (See Figure 4.1.2)

Figure 4.1.2


c) See the information concerning the minimum software requirements and click “Next”. See figure 4.1.3.

Figure 4.1.3

d) Read carefully the license terms and accept the conditions in order to proceed with software

installation. See figure 4.1.4.

Figure 4.1.4


e) Install the software in the local ‘C:\’ drive and specify a directory where to install the software which does not contain any space it. E.G. ‘C:\DataShield’ and not ‘C:\Documents and Settings\Administrator\DataShield’ When the software is installed with space in path it may not run properly and special functions like scripts execution will be not handled correctly. Click “Next”. (See Figure 4.1.5)

Figure 4.1.5

f) Specify the directory, and click Install. (See Figure 4.1.6)

Figure 4.1.6


g) If the specified directory does not exist in local drive JUMP DataShield has to create it. A dialog box asks you to confirm if the new directory has to be created. Click “Yes”. (See Figure 4.1.7)

Figure 4.1.7 h) During the installation process the forward buttons are disabled.

Wait for the installation process and then click “Finish”. (See Figures 4.1.8 and 4.1.10)

Figure 4.1.8

During installation you have the option to install the needed drivers for USB to serial support. For more details about USB to serial support please refer to chapter 3.2. To choose this option you have to select “Yes” in the following window. (See Figure 4.1.9). The next steps are described in chapter 11 in details.

Figure 4.1.9

Figure 4.1.10 If you connect the UPS to your system using any other way described in chapter 3, then select “No”.

If no errors are displayed JUMP DataShield has been successfully installed. You are now able to start up the software and configure the UPS connection.


4.2 Software startup JUMP DataShield is built in two parts, a communication part and a graphic user interface (see chapter 2). After the installation open the service and start up DataShield service, which is the communication part of the software that runs in background. a) Find the Service list.

Start > Settings > Control Panel > Administrative Tools > Services (See Figure 4.2.1)

Figure 4.2.1

NOTE: You have to start-up the service only the first time, after the reboot DataShield will start-up

automatically, so you don’t need to repeat this operation. b) Double click on the DataShield service name.

Click on START and DataShield will start-up. (See Figure 4.2.2)

Figure 4.2.2


c) You can also start-up DataShield “manually“ from the Start Program menu. (See Figure 4.2.3)

Figure 4.2.3

Before start-up DataShield “manually” make sure that it is not already running as service, if so open the service list and stop DataShield service if it is running. d) When DataShield is started manually you have to keep open the MS-DOS window, which appears

during the start-up. ( See Figure 4.2.4)

Figure 4.2.4

NOTE: DataShield can be started as service or manually, do not start the software from both sides

simultaneously, otherwise the application will be not able to open the socket for the connection.

Once the communication part of JUMP DataShield is up and running, you are now ready to setup the first configuration through JUMP View Graphic Interface.


4.3 JUMP Datashield serial (RS232) configuration JUMP DataShield provides a graphic user interface panel suitable for UPS monitoring and configuration. Start JUMPView panel from Start > Programs Files > JUMPView. (See Figure 4.3.1)

Figure 4.3.1

When DataShield starts up the graphic interface appears on the screen. (See Figure 4.3.2)

Figure 4.3.2

Sensitive operations on DataShield initiated from JUMPView are protected by password. The default password used for manage the software configuration is ‘GE’ and it must be used to create the UPS configuration. (See Figure 4.3.3)

Figure 4.3.3


In order to setup a first UPS connection with JUMP DataShield you have to click on the Configuration Pull Down menu and select UPS Configuration. (See Figure 4.3.4)

Figure 4.3.4

Click ‘Configure’ to change the default configuration associated to the default profile “My UPS”. (See Figure 4.3.5)

Figure 4.3.5

In order to configure a serial connection, make sure that the UPS serial cable is properly connected between the computer RS232 port and the UPS RS232 channel, and configure the software parameters as described in the following tables.

Figure 4.3.6


SETTINGS DESCRIPTION (See Figure 4.3.6)

CONFIGURATION VARIABLES UPS NAME Free text box that let’s you specify a UPS name. COMMUNICATION TYPE if you use a serial (RS232) connection leave it configured as ‘Serial’. SERIAL PORT Chose where the UPS is connected if to the serial port COM1 or COM2. ENABLE SNMP AGENT See chapter 4.5 JUMP DATASHIELD SNMP PROXY AGENT.

CHOSE THE SHUTDOWN TYPE SUITABLE FOR YOUR OPERATING SYSTEM

ALARM MANAGEMENT

ENABLE ALARM MANAGEMENT Enable alarms popup and the alarms management functions (see chapter 5.3), if you wish to receive popup messages when DataShield detects a UPS alarm do not disable this option.

PRE DELAY Time passed between alarms acknowledgment and software popup.

SYSTEM SHUTDOWN Enable DataShield to drive the computer shutdown in case of power failure, if this box is not checked DataShield is not activated to shutdown your computer in case of mains failure.

AFTER A FIXED RUNTIME You can specify after how many minutes before the computer must start the shutdown procedure in case of power failure.

WHEN BATTERY RUNTIME LEFT

Start computer shutdown procedure only when the battery autonomy is equal to the minutes filled in this form. E.g. When you are sure that the server can finish the shutdown process in 2 minutes, you can configure DataShield to shutdown the system when battery runtime left 3 minutes. It means that your computer initiate the shutdown process when the UPS battery autonomy is equal 3 minutes.

AFTER BATTERY LOW SIGNAL This option let’s our operating system to execute the shutdown only when UPS batteries are Low. (Normally 3 minutes of Autonomy).

Click the “OK” button to close the configuration wizard. After you have properly configured DataShield you have to activate the new configuration to save the new settings; In order to do so, you have to exit from the Configuration Wizard and a Java popup will appear on the screen saying, "You should activate changes to use new configuration". (See Figure 4.3.7).

Figure 4.3.7

Before applying the New configuration, make sure that JUMPView Status bar displays the message “New configuration file has been successfully written”, from the pull down menu click on configure, and ‘Activate new Configuration’. (See Figure 4.3.8).

Figure 4.3.8


DataShield performs an internal reboot and after a while restarts and you can see in the MIB tree all the information and measures provided by the UPS. Now the server is under protection, you can simulate a UPS mains failure in order to test the functionality of the shutdown procedure handled on your system. (See Figure 4.3.9)

Figure 4.3.9


4.4 JUMP Datashield SNMP CONFIGURATION JUMP DataShield provides a graphic interface panel suitable for UPS monitoring and configuration. Start JUMPView panel from Start > Programs Files > JUMPView. (See Figure 4.4.1)

Figure 4.4.1


Figure 4.4.2

Sensitive operations on DataShield initiated from JUMPView are protected by password. The default password used for manage the software configuration is ‘imv’ and it must be used to create the UPS configuration. (See Figure 4.4.3)

Figure 4.4.3


In order to configure the SNMP connection with your UPS, make sure that the SNMP CARD/BOX has been properly configured. Check if the computer where you are installing DataShield is able to communicate with the remote UPS. You can issue the ‘ping’ command in order to check if the SNMP adapter installed in the UPS is configured correctly. Type ping followed by the SNMP card IP address. (See Figure 4.4.4)

Figure 4.4.4

For additional information on how to configure the SNMP adapter please check the related documentation. In order to setup a first UPS connection with JUMP DataShield click on the Configuration pull down menu and select UPS configuration. (See Figure 4.4.5)

Figure 4.4.5

Click ‘Configure’ for change the default configuration associate to the default profile My UPS. (See Figure 4.4.6)

Figure 4.4.6


Configure network parameters to setup the SNMP communication. (See Figure 4.4.7)

Figure 4.4.7

Settings description (See Figure 4.4.7) Configuration variables UPS NAME Free text box that let’s you specify a UPS name. COMMUNICATION TYPE For the SNMP communication, chose SNMP from the pull down list. IP Address The IP address of the SNMP adapter connected into the UPS. UPS TYPE Leave IMV for control General Electric UPS’s.

Chose the shutdown type suitable for your operating system

Alarm management

ENABLE ALARM MANAGEMENT Enable alarms popup and the alarms management functions (see chapter 5.3), if you wish to receive popup messages when DataShield detects a UPS alarm do not disable this option.

PRE DELAY Time passed between alarms acknowledgment and software popup.

SYSTEM SHUTDOWN Enable DataShield to drive the computer shutdown in case of power failure, if this box is not checked DataShield is not activated to shutdown your computer in case of mains failure.

AFTER A FIXED RUNTIME You can specify after how many minutes before the computer must start the shutdown procedure in case of power failure.

WHEN BATTERY RUNTIME LEFT

Start computer shutdown procedure only when the battery autonomy is equal to the minutes filled in this form. E.g. When you are sure that the server can finish the shutdown process in 2 minutes, you can configure DataShield to shutdown the system when battery runtime left 3 minutes. It means that your computer initiate the shutdown process when the UPS battery autonomy is equal 3 minutes.

AFTER BATTERY LOW SIGNAL This option let’s our operating system to execute the shutdown only when UPS batteries are Low. (Normally 3 minutes of Autonomy).

Close the configuration wizard.


After you have properly configured DataShield you have to activate the new configuration to save the new settings; In order to do so, you have to exit from the Configuration Wizard and a java popup will appear on the screen saying, "you should activate changes to use new configuration". (See Figure 4.4.8)

Figure 4.4.8

Before applying the New configuration, make sure that JUMPView Status bar displays the message “New configuration file has been successfully written”. From the pull down menu click on Configure, and ‘Activate new Configuration’. (See Figure 4.4.9)

Figure 4.4.9


Figure 4.4.10


4.5 JUMP Datashield SNMP proxy agent configuration The proxy Agent functionality adds the capacity to connect a computer with JUMP DataShield installed directly to the UPS via RS232 cable and became a SNMP agent for the network clients. For more information about Proxy Agent see chapter 2 of the manual GENERAL DESIGN. JUMP DataShield provides a graphic interface panel suitable for the UPS connection settings and for monitor the UPS. Start JUMPView panel from Start > Programs Files > JUMPView. (See Figure 4.5.1)

Figure 4.5.1


Figure 4.5.2


Sensitive operations on DataShield initiated from JUMPView are protected by password. The default password used for manage the software configuration is ‘imv’ and it must be used to create the UPS configuration. (See Figure 4.5.3)

Figure 4.5.3

Chose Configuration from the JUMPView pull down menu and select “Advanced Agent Configuration”. (See Figure 4.5.4)

Figure 4.5.4

In SNMP Agent configuration parameters you can enable the SNMP Proxy Agent. Select Agent Enabled option to configure DataShield to act as SNMP agent. (See Figure 4.5.5)

Figure 4.5.5


The “Agent SNMP PORT” is used to provide remote connection over the SNMP protocol for the network clients. The default port is 161, change that port to 1161 to avoid conflicts if port 161 already used by other applications. Agent for UPS number is a list box where you can specify (where in your software there is more than one UPS connection defined) on which UPS you want to enable the proxy agent function. Identification name and attached devices are free text boxes that you can use to provide a short description of the equipment. Trap host, community name and port are additional settings of the agent that you can eventually use if you need to send message traps to remote management systems. Click “OK” to close the configuration windows, wait till the status bar shows “New Configuration has been successfully written” and chose “Activate New Configuration” from the JUMPView pull down menu. DataShield does an internal reboot and is able to accept connections over the SNMP protocols from the other clients. To configure all the other clients that are suppose to be connected to this SNMP proxy agent make sure that the SNMP connection over the 1161 UDP port is configured properly. See the section 4.4 SNMP CONFIGURATION.


4.6 JUMP DataShield low level configuration in textual mode (Experts only) System administrators that are interested in modifying the DataShield configuration in textual mode, can find all the software configuration included into “datashield.cfg” which is located in the DataShield installation path assigned local drive during the software installation procedure e.g. ‘C:\DataShield\config’. “datashield.cfg” is a textual file that can be viewed with a standard program such as WordPad for Microsoft Windows or vi for Unix. Figure 4.6.1 and 4.6.2 shows datashield.cfg

Figure 4.6.1

Figure 4.6.2

Please if you don’t know the meaning of the parameters included do not change them otherwise your application could not start-up properly. Before you attempting any changes to the configuration file we strongly suggest to backup the configuration file in order to restore it if something goes wrong. NOTE: DataShield configuration has to be done as explained in point 4.3 or 4.4, the file

“datashield.cfg” has to be modified only by expert administrators. The powerful function of “datashield.cfg” is that if you have to install DataShield on several workstations and configure all of them in the same way, you can configure DataShield via JUMPView only on one computer and copy the same configuration file to all the workstations in your network that require the same settings, by doing so you can save time and avoid configuration mistakes.


4.7 JUMP Datashield and Remote computer shutdown via script In order to be able to shutdown remote computers via network without install JUMP DataShield on all of your systems you can use the powerful psshutdown.exe. included with JUMP DataShield the utility. It is a command-line utility similar to the shutdown utility from the Windows 2000 Resource Kit, but with the ability to do much more. In addition to supporting the same options for shutting down or rebooting the local or a remote computer, PsShutdown can logoff the console user or lock the console (locking requires Windows 2000 or higher). It is included in JUMP DataShield under scripts/win2000 directory. PsShutdown works on NT 4.0, Win2K, XP and Windows 2003 Server. How to use it with JUMP DataShield?

Enter in Datashield installation path .//datashield/scripts/win2000 and edit the script powershut. This script is the file called by Datashield when the software decides that is time to shutdown the computer. As default this script contains only one line which calls the shutdown for the local operating system where Datashield is installed. In order to shutdown a remote computer you simply have to add a new line, before the default one and tell to psshutdown to send shutdown command to the remote workstation that you need to power off when the mains failure occurs on the UPS. Example:

If you look at the first line psshutdown is called to establish a connection to the remote computer (3.18.199.55), login with the required account and execute the shutdown with the -k option. Whether you need to shutdown many remote computers, you have to add in powershut script one line for every computer that you want to protect. More details about powershut and psshutdown options are available in Readme_shutdown.txt file included in Datashield installation path.


5 GENERAL SOFTWARE FUNCTIONALITY 5.1 Password and security managment It is recommended that you change the default password so your system is protected against misuse. To access the password panel choose from the pull down menu Authentification > Set new password. (See Figure 5.1.1)

Figure 5.1.1

The new password panel appears on screen. For security reasons you have to type new password twice before you can store it to new configuration. New password has to be at least 3 characters long. Click Save in order to store the new password in DataShield configuration. (See Figure 5.1.2)

Figure 5.1.2


5.2 Advanced communication settings In the UPS Configuration screen, the button ‘Advanced Settings’ provides a more accurate configuration panel needed for setup the UPS connection. (See Figure 5.1.3)

Figure 5.2.1

Settings description

READ COMMUNITY Security access level used by SNMP protocol to read the UPS information.

WRITE COMMUNITY Security access level used by SNMP protocol to set values to UPS

TIME OUT (SEC) Is the time expressed in seconds that the system waits for a response from the agent.

NUMBER OF RETRIES Amount of retries for getting the response before raising a Lost Communication Alarm.

UPDATE INT. FOR ALARMS

Seconds passed between the polling cycles to update the alarms. DataShield continuously polls the UPS for retrieval of the UPS status. You can change this parameter to increase or reduce the polling time cycle for the alarms. Normally you can leave the default values, where it has to be changed if you need to connect several computers to an SNMP agent. By increasing this value you reduce the communication traffic over the LAN.


UPDATE INT. FOR DETAILS

Seconds passed between the polling cycles to update the details. DataShield continuously polls the UPS to retrieval of the UPS status. You can change this parameter to increase or reduce the polling time cycle for details. Normally you can leave the default values, where it has to be changed if you have to connect several computers to an SNMP agent. By increasing this value you reduce the communication traffic over the LAN.

UPS SHUTDOWN

Configure DataShield to shutdown the UPS after the computer shutdown procedure has been completed. This function sends the shutdown command to the UPS so it will completely switch OFF the UPS as soon as a power failure is detected. See also the grace period settings to be used in combination with “UPS Shutdown” in order to create the correct configuration of your system shutdown.

SCRIPT EXECUTION TIME

This is the time that the system needs to execute the internal script used for shutting down the computer. If the computer is configured to perform the shutdown after 3 minutes of the UPS running on battery and the script execution time is configured on 30 seconds, DataShield starts the "script execution time" after two and a half minutes in order to allow the operating system to execute the shutdown script in 30 seconds. If the computer is configured to perform the shutdown after 3 minutes of the UPS running on battery and the script execution time is configured on 180 seconds, as soon as the UPS will run on battery the shutdown script will be executed immediately and the computer will shutdown in few seconds. This parameter has normally to be left with the default value.

GRACE PERIOD

When configuring the UPS shutdown the grace period has to be specified. This is the time needed by your operating system to complete the shutdown. When the specified period is too short for the system shutdown the UPS will be switched off before all applications are closed. To avoid this situation you have to add some extra time to the actual system shutdown time. (E.g. when your system needs 60 seconds to shutdown, you will need a grace period of 90 seconds.) Script execution time is related to the operating system shutdown, while grace period time is related to the UPS shutdown.


5.3 Alarm management The alarm management configuration contains all the actions that DataShield should perform as soon as an alarm is detected on the UPS. To access the alarm management click on configuration pull down menu and Alarm Management. (See Figure 5.3.1)

Figure 5.3.1

The alarms configuration panel appears on the screen. There you can expand and collapse the data tree which is divided in Message Configuration and Alarm Configuration. (See figure 5.3.1) The first section is used to configure the messages behaviour of the software.

Figure 5.3.1

In the alarm configuration section you can define a UPS action to be taken when DataShield recognizes a UPS alarm. In fact you have a list of UPS alarms and for each alarm you can configure the software to execute an action, like to start a script or to send an email when the alarm is activated or deactivated. (Figure 5.3.2)

Figure 5.3.2


To configure a UPS action double click on the alarm required, e.g. upsAlarmBatteryBad, expand it and double click on the red arrows. A new panel appears on the screen and there you can specify. (See Figure 5.3.3) Here you can specify if DataShield should send an email or run an external script.

Figure 5.3.3


5.4 Script execution action To extend the software capability you can implement a script action to be executed once DataShield detects an alarm on the UPS and an action to be executed when the same alarm is removed. For example a script can be started when the alarm On Battery is ON and another script can be started when the alarm On Battery is OFF.

DataShield automatically kills the script started in few seconds, therefore you have to configure a first script that calls a second one which will contain the entry job process to be execute.

Example: You need a script, that executes several NET SEND commands to provide windows popup messages to remote workstations. In order to accomplish this task, you have to prepare two different scripts. The first script is initialized by the Alarm Management and runs a second script that contains the entry job process.

A) Open the Alarm Management panel and choose from the Alarm Configuration list the Alarm name

to be executed. Choose for example upsAalrmBatteryBad. Specify the delay time and script execution name and click “OK” to close the window.

Figure 5.4.1

NOTE: the first script initiated by the alarm management must not contain the extension name. DataShield philosophy is to place all the scripts that have to be started automatically by the alarm management into a specific subdirectory of your operating system. The scripts location is under the installation path of JUMP DataShield, there you can find a directory named scripts which contains a list of the used operating system. (See figure 5.4.2)

Figure 5.4.2


B) Put all the necessary scripts into the same directory e.g. C:\DataShield\scripts\win2000 and create your scripts as shows in figures 5.4.3 and 5.4.4

Figure 5.4.3

Figure 5.4.4

In the above example script1 is started by the alarm management and script2 which contains the entry job process is started by script1, in this way script1 is later killed by JUMP DataShield process, while script2 keep its process running until the task is completed. Once the configuration is completed remember to activate the new configuration.


5.5 Send emails Sending emails from JUMP DataShield is not so complicated, you need a few settings to take the necessary actions. It is important to understand that the application itself is not making contact with remote mail servers to deliver the email themselves. Instead it uses a SMTP server for this task. So, the first thing to do is to tell the application where to find the SMTP Mailer that will handle his email. For this purpose you need to configure the DNS name or IP-address of the SMTP mailer you want to use. In case you want to check the name or connection you can use the ping and telnet commands.

Ping will tell you whether a physical connection can be established. A telnet session to port 25 of the SMTP server will tell you whether you have access to the SMTP server application itself. The command to use is:

Telnet [SNMP server name/IP-address] 25 When a welcome message appears the connection is OK. If no welcome message appears the connection is not OK and you should contact you administrator to give you proper access rights. In order to avoid misuse of mail servers for sending all kind of unwanted email there are several levels of security possible:

• First the mail server can have the SMTP functionality switched off. For sending email from DataShield it must be enabled.

• Secondly the mail-server may have a list of computers (IP-addresses) that are allowed to use the SMTP mailer for sending mail. In case this type of security is used, the machine running your application should be in this list of authorized computers.

• Third option is that you will have to login using a user-id and password. To support this method our applications let you configure this optional user-id and password.

The JUMP DataShield email window must be configured as described. In case you need more information about the settings you should contact you system or network administrator. In Figure 5.5.1 you can find the configuration details. From the pull down menu Click Configuration > Advanced general configuration.

Settings Descriptions

Mail Server Insert the email server IP address.

Mail From Address

The address used by DataShield to send email.

Mail User

User Account defined on the server to login and send email with the mail from address.

Mail password Password defined for the Mail user.

Figure 5.5.1


To configure DataShield to send emails, open JUMPView, select alarm management from the configuration pull down menu, select alarm configuration, choose one alarm from the list, select the option “send email” and enter the email address of the account where you wish to send the message when the alarm appears. Insert a delay time and click “OK” to close the configuration window. From the pull down menu click on Configure, and ‘Activate new Configuration’. (See Figure 5.5.2)

Figure 5.5.2


Figure 5.5.3


5.6 Configure scheduled actions The scheduled wizard panel is used to program an action that has to be performed after a certain period. For example you can program the UPS shutdown on Friday evening and UPS start-up on Monday morning. Scheduled UPS shutdown and reboot. The shutdown can be set for immediate action, daily, weekly and monthly at a specific day and time. You can shutdown and start up your UPS via DataShield, whether it is a local UPS or remote UPS. In addition to shutting down the UPS immediately, you can set a work schedule for the UPS and the system attached to it. Most intelligent UPS can be tested for preventive maintenance or troubleshooting. Tests can be issued instantly or scheduled from one central location. Thus minimizing the cost of going on site. Tests available:

General System Test The manufacturer’s standard test of the UPS system. Quick Battery test Test sufficient to determinate if the battery need to be replaced. Deep Battery Calibration The system is placed on battery to a discharge level, set by the

manufacturer, sufficient to determinate battery replacement and battery runtime with a high degree of confidence.

Testing options depend on the type of UPS. Please consult your reseller. In addition to testing the UPS immediately, you can set a test schedule for the UPS. You can use this function to test and to arrange test schedule for any UPS in the network. In the following example we configure DataShield to perform a Quick Battery test once a month. Choose configuration scheduling wizard from the Configuration pull down menu in JUMPView panel and select Scheduling wizard (See Figure 5.6.1). Select the action number and type in the free text box a description of the action. Click on button ‘Configure’, select ‘Test’ and push on ‘Next’ (See Figure 5.6.2).

Figure 5.6.1

Figure 5.6.2


Choose the frequency of the event and specify the time when it is supposed to be initialized. (See Figure 5.6.3 and 5.6.4)

Figure 5.6.3

Figure 5.6.3

Select the event type that should occur on the system and choose “Next”. (See Figure 5.6.5)

Figure 5.6.5

Figure 5.6.6

Once the configuration has been completed, scheduling wizard shows the action configured in the list (See Figure 5.6.6), click “OK” and remember to activate the new configuration as described in chapter 4.3.


5.7 View configuration View configuration menu is available to personalize the graphic interface of the UPS data. Adding and removing the gauges used to display the UPS data is very easy. (See Figure 5.7.1)

Figure 5.7.1

Once you have selected a new gauge to be displayed you are able to personalize its data and set the alarm variable. (See picture 5.7.2)

Figure 5.7.2

The graphic gauges are available as external component in JUMP View from the “view” pull down menu and “View UPS status”. (See Figure 5.7.3)

Figure 5.7.3


5.8 Global configuration parameters Global configuration parameters let you change some software settings in order to personalize DataShield behaviour, for example in the language selection you have a list of languages supported that turn JUMP View in local language layout. The communication port is used by JUMP View to communicate with DataShield to transfer data, email server configuration settings are described in chapter 5.5. The maximum size of the log file can be defined, regulate the size of DataShield log file.

Figure 5.8.1

5.9 Run a test The JUMP View panel lets you initiate a test to check the UPS status. Choose test from the pull down menu and click run a test. You can select general system test, a quick battery test or a deep battery calibration. (See Figure 5.9.1)

Tests available

General System Test The manufacturer’s standard test of the UPS system

Quick Battery test Test sufficient to determinate if the battery need to be replaced.

Deep Battery Calibration

The system is placed on battery to a discharge level, set by the manufacturer, sufficient to determinate battery replacement and battery runtime with an high degree of confidence.

Figure 5.9.1


5.10 Data logging DataShield offers an integrated event logging functionality to help you keep a history of your system. DataShield maintains two log files: an event log file and a history log file. The event log file contains all UPS related events since last start-up of the program, including power failures, shut downs, power recoveries, etc. The history log file is a collection of all the UPS events since installation of DataShield. Of course there is a limitation for the size of this log-file, which is configurable. (See chapter 5.8) DataShield is able to log Incoming alarms recognized on the UPS, communication problems for serial and SNMP, scheduling of a test and relative results.

Information logged for each event:

• The date and time when this event occurred

• The exact type of event (for alarms and tests)

DataShield will always log special events during functioning. These events are Alarm, Test Initiation, Test Aborted or Test Completed. All of this logging information is available in HTML format that makes it easy to read log file in your favourite web browser from any location. Select Log from the JUMPView pull down menu’ and start the log file explorer. Recording events in the Windows Event Log Service:

DataShield can also be enabled to log event, error and web information under the application log of Microsoft Windows Event Log Service. Each event contains event type (i.e., error, information or warning), event Id and event Information. Enabling DataShield to record events in the Windows Event Log Service. Enable the Data logging in Windows Event Log Service when DataShield is used in manual start-up. Open runshield.bat Enabling the DataShield to log events into Win OS Event. Edit the runshield.bat file and change the line DataShield %1 %2 %3 %4 %5 %6 %7 %8 %9 to DataShield -MSEvent %1 %2 %3 %4 %5 %6 %7 %8 %9. Save the runshield.bat file and execute. Enable the data logging in Windows Event Log Service when DataShield is used in service mode. Open scripts\win2000\jsl.ini file, change the following fields in the jsl.ini file and save it. Increment the number of parameters passed to the service. This can be done by changing the value of params field. (For example if params = 4 change it to params = 5). Add the new parameter field for passing the argument value. (For example if the last parameter field is param03, then add a new parameter field as param04 = -MSEvent). Restart the service.


5.11 Centralised event logging This chapter describes the additional features of DataShield, which are introduced with the release 2.2.0. The main objective is, to have a centralised event logging available were all protected machines are able to send their log information to one central log server. This feature is available for all supported platforms. To achieve the centralised event logging, one has to configure DataShield by the help of some easy to use command line parameters. With these initial start up parameters, DataShield is set to provide an additional log server or log client functionality. 5.11.1 General system overviev

To setup a system consisting of several protected machines logging to one central instance, the following diagram may help to understand the interaction of the involved modules and how they can be configured: Centralised event logging

Figure 5.11.1 The system described in figure 5.11.1 is providing the most advanced flexibility and adding the following advantages:

• DataShield is able to run in Windows using any user-account, also the system-account. This is very important due to the fact that only the system account is able to interact with the desktop, when DataShield is started to run as service in the background.

• The DataShield centralised logging functionality allows logging to a remote server, also when running in the system-account. This is a big advantage when comparing with the native MS event logging, where remote logging is not allowed for all services using the system account.

• DataShield centralised remote logging is using its own system independent communication protocol, therefore it is possible to use remote logging also in heterogeneous environments, where also other operating systems like LINUX, Netware or even Windows non server operating systems like Win98 are able to log in the MicroSoft event log as well as in the built in DataShield event log. This keeps the DataShield solution really Operating system independent.

• The communication between log-client and log-server is running on tcp/ip, a remote login configuration only on DataShield-level is needed.

DataShield protection

part

Log info

All platforms: Local DataShield

log-files 1

2 Tcp-ip Network

Local machine Log-Server

3

1: -Msevent 2: -loghost

3: -Msevent

Log Fifo

Win Server platforms: Local MS-event

log-file

All platforms: Remote DataShield

log-client

Log server

All platforms: Server DataShield

log-files

Win Server platforms: Server MS-event

log-file


5.11.2 Preconditions

To setup a system consisting of several protected machines logging to one central instance, we assume the following preconditions: General: The installation of DataShield V2.2.0 was already done according to the platform specific installation descriptions. The installation is already tested and running successfully on all involved machines. Networking: The given infrastructure has to provide the following:

• All involved machines are connected, using a tcp/ip network.

• Between all involved machines, the communication to and from the defined ip-port is allowed and available. The default port is 10050.

• When DataShield is running on Windows – Server platforms like NT, 2000, 2003 XP, it also possible to use the built in MS event log as the log server. This is done with the option „– MS event“. In this case the event-message-texts are assembled like: Logserver.logclient.myups, where logserver is the name of the machine the logserver is running on, logclient is the name of the machine where DataShield is running as logclient and myups is the name of the UPS which generates the event.

5.11.3 Security

To keep the system easy to install and maintain, there are no additional network security services implemented on the level of DataShield. The system is presupposing a network which is protected and a operating system using the recommended patches. To prevent the logserver from the results of mal configuration, the following is implemented:

• One has to define an administrator password on DataShield level, default is GE.

• One has to define the name / ip-adress of the log server one the client.

• One has to define the ip-port where the log server is listening for the client, default is 10050.

• One has to define the maximum size of the log-file on the log-server to prevent the system running out of memory, default is 200kB. The log-file is handled like a FIFO, to avoid an overflow, the eldest messages will be overwritten.

• The logserver is comparing the clients password with its own to allow the access of the client, therefore client and server must have the same password.

5.11.4 Installing DataShield with centralised logging functionality

There are no different issues during installation of DataShield to provide the centralised logging functionality. All settings are made by setting few simple command-line parameters.


5.11.5 System configuration

Client configuration: To enable the logclient-functionality, sending logs on the default port 10050 to the logserver specified by name, you need the following minimum command line:

-loghost=name Where name is the name of the machine the logserver is running on. To enable the logclient-functionality, sending logs on the default port 10050 to the logserver specified by ip-address, you need the following minimum command line:

-loghost=ip-address Where ip-address is the ip-address of the machine the logserver is running on.

Optional Communication port: If the communication between logclient and logserver shall run on a different prot, for example 12345, you have to type for the logserver specified by name:

-loghost=name:12345 or

-loghost=ip-adress:12345

when the logserver is specified by ip-address. Optional user: If the log-user shall be different from the default, which is „loguser“, you have to type:

–loguser=username Please take care, that the username you had specified for the logserver must be the same that you have specified for the logclient. Server configuration To enable the logserver-functionality listening on the default port 10050. You need the following minimum command line:

-logserver Optional communication port: If the communication between logclient and logserver shall run on a different prot, for example 12345, you have to type:

-logserver:12345 Optional user: If the log-user shall be different from the default, which is „loguser“, you have to type:

–loguser=username Please take care, that the username you had specified for the logserver must be the same that you have specified for the logclient.


DataShield running as service: One has to modify the jsl.ini as follows: If you found that you will need one additional command, then you have: • Add +1 to the params Example:

before:

Params=6 after:

Params=7 • Add in the last line the wanted startparameters, for example:

Param06=-logserver:10050

to make the system run as logserver as service on port 10050. Please note, that the count of parameters is starting with 00, so the 7th parameter is the parameter no. 6. If you will need two additional command lines, because you are using the option loguser, then you have to add +2 to the number of params. Each parameter needs its own line in the jsl.ini. DataShield running as application: One has to modify the runshield.bat as follows: Adding at the end of the line, where the Java call to DataShield is made, the required start parameters: Example:

-logserver:10050 or

-logserver:10050 -loguser=username In the runshield.bat you have to set one parameter after the other in one line, only separated by a blank.


6 JUMP DATASHIELD ON LINUX 6.1 Prerequisites Before beginning with the JUMP DataShield installation process, make sure that your Linux system has been installed with Java Runtime Environment, or Java Development Kit, if not please download and install Java Layer from http://java.sun.com 6.2 Installation Make sure you are logged in your server as ROOT with the Xfree86 server running with a windows manager such as GNOME, KDE or similar. Copy JUMP DataShield software package in some temporary directory of your Operating System. Extract the content of the tar package with the command “tar xvf datashieldx.y.z.tar”. Once the package is extracted, you can find some more files in the directory used for the files extractions. (See Figure 6.2.1)

Figure 6.2.1

Type the command “java setup” and a welcome page appears in DataShield Graphic Interface. (See Figure 6.2.2).

Figure 6.2.2


Click “Next” and README information page appears on the screen. (See Figure 6.2.3)

Figure 6.2.3

Click “Next” and DataShield License is displayed, in order to be able to install the software you have to accept and license and click “Next”. (See Figure 6.2.4)

Figure 6.2.4

A message appears in the graphic interface that says “If you use DataShield on windows Operating Systems do not install the software in path name with spaces”. (See Figure 6.2.5)

Figure 6.2.5


Click “Next” and specify the directory path where you wish to install the software (See Figure 6.2.6)

Figure 6.2.6

Click Install to proceed with the software installation. A message could appear that says the specified directory does not exist, there it asks if has to create it. (See Figure 6.2.7 and Figure 6.2.8)

Figure 6.2.7

Figure 6.2.8

During installation you have the option to install the required needed drivers for USB to serial support. For more details about USB to serial support please refer to chapter 3.2. To choose this option you have to select “Yes” in the following window. (See Figure 6.2.9). The next steps are described in chapter 12 in details.

Figure 6.2.9

If you connect the UPS to your system using any other way described in chapter 3, then select “No”. Once the installation has been completed, click on “Finish” button to close the graphic installation wizard. (See Figure 6.2.9)

Figure 6.2.10


6.3 Linux configuration screen When the installation has been completed, enter in the installation path, and start the script runshieldu with command ./runshieldu, DataShield starts and attempts to communicate with the serial port COM1 which loads the default configuration. (See Figure 6.3.1) Open another terminal emulator windows (keep the ./runshieldu window running) an enter in the path where DataShield has been installed. Start the graphic interface with command ./runview (Figure 6.3.2)

Figure 6.3.1

Figure 6.3.2

Once the runview script has been started, you can see on your screen the JUMP View Graphic interface (See Figure 6.3.3)

Figure 6.3.3

DataShield has been successfully installed on your Linux Operating system. Now you have to configure the communication type used between your server and the UPS. Since the Software is developed in Java and the configuration is common for all the operating systems, refer to the following chapters to see how to complete the UPS communication settings.


6.4 Linux and RS232 Chapter 4.3 (JUMP DATASHIELD SERIAL (RS232) CONFIGURATION) explains how to configure JUMP DataShield to communicate over the serial cable with the UPS. In order to be able to configure your Linux server to use a serial communication with the UPS follow step by step the information given and make sure that instead of configure serial COM1 you have to use the Linux serial port /dev/ttyS0 (for COM1) or /dev/ttyS1 (COM2).

6.5 Linux and SNMP communication Chapter 4.4 (JUMP DATASHIELD SNMP CONFIGURATION) explains how to configure DataShield to communicate with the UPS over SNMP protocol. The configuration procedure is exactly the same also for Linux OS.

6.6 Linux and SNMP proxy agent Charter 4.5 (JUMP DATASHIELD SNMP PROXY AGENT CONFIGURATION) shows how to create a proxy agent for share the UPS data via SNMP protocol. The configuration procedure is exactly the same also for Linux OS.

6.7 Linux automatic startup as Daemon Since there is not a common way (for Unix systems) to configure DataShield for the automatic start-up at the boot time, the system administrator has to create it.

The script must be prepared in order to accept one parameter like {start¦stop}

Following is an example script that accepts the parameters, start stop. The script is named “datashield”, and placed in /etc/rc.d/int.d. You can take it only as example, if you copy it in your system it probably wont work since the installation paths are not the same. #!/bin/bash

RETVAL=0

prog="datashield"

start () { cd /DataShield # This is the path where datashield is located. ./runshieldu > /dev/null & echo -n $"Starting $prog:" echo }

stop () { echo -n $"Stopping $prog:" killproc datashield RETVAL=$? echo return $RETVAL echo }

restart() { stop start }

case "$1" in start) start ;; stop) stop ;;

*)

echo $"Usage: $0 {start|stop}" exit 1 esac exit$? exit $RETVAL


In DataShield directory the script named 'runshieldu' has to be modified by adding a switch '-service' at the end of line. Example: export CLASSPATH /usr/bin/jdk1.4/bin/java -Dinstall.root=/DataShield/ DataShield "$@" -service DataShield Make a symbolic link between your script /etc/rc.d/init.d and directories rc0.d to rc6.d (they correspond to runlevels 0 to 6). Different numbers in names of those symbolic links are specifying order of start of those relevant scripts, so DataShield script should be with reasonably high number, because it has to be started after network modules are loaded. Example: Make a symbolic link between the script /etc/init.d/DataShield and the following Scripts: /etc/rc2.d/S90datashield

/etc/rc1.d/S90datashield

/etc/rc6.d/K01datashield


7 JUMP DATASHIELD ON SUN SOLARIS 7.1 Prerequisites Before starting the JUMP DataShield installation process, make sure that your Solaris system has been installed with Java Runtime Environment, or Java Development Kit, if not please download and install Java Layer from http://java.sun.com. Sun Solaris is a SUN MICROSYSTEM product, for this reason the operating system is build in Java, and JRE layer is probably already well installed. Make sure you are logged in your server as ROOT with a windows manager such as CDE, GNOME or whatever. 7.2 Installation Copy JUMP DataShield software package in some temporary directory of your Operating system. Extract the content of the tar package with the command “tar xvf datashieldx.y.z.tar”. Once the package is extracted, you can find some more files in your path. (See Figure 7.2.1) Type the command “java setup” and the welcome page appears in DataShield Graphic Interface. (See Figure 7.2.2).

Figure 7.2.1

Figure 7.2.2

Click “Next” to see the README information page (See Figure 7.2.3). Click “Next” and DataShield License is displayed, to install the software you have to accept and license and click “Next”. (See Figure 7.2.4)

Figure 7.2.3

Figure 7.2.4


A message appears and says “If you use DataShield on windows Operating Systems do not install the software in path name with spaces”. (See Figure 7.2.5) Next screen you have to specify the directory path where you wish to install the software. (Figure 7.2.6)

Figure 7.2.5

Figure 7.2.6

Click Install to proceed with software installation, a message says that specified directory does not exist, and DataShield asks if you want to create it. Answer “Yes”. (See Figure 7.2.7 and Figure 7.2.8)

Figure 7.2.7

Figure 7.2.8

Once the installation has been terminated, click “Finish” button to close the graphic installation wizard. (See Figure 7.2.9)

Figure 7.2.9


7.3 Sun Solaris configuration screen When the installation has been completed, enter in the installation path, and start the script runshieldu with command ./runshieldu, DataShield starts and attempts to communicate with the serial port COM1 which loads the default configuration. (See Figure 7.3.1) Open another terminal emulator windows (keep the ./runshieldu window running) an enter in the path where DataShield is installed. Start the graphic interface with command ./runview. (See Figure 7.3.2).

Figure 7.3.1

Figure 7.3.2

Once runview script has been started, you can see on your screen the JUMP View Graphic interface. (See Figure 7.3.3)

Figure 7.3.3

DataShield has been successfully installed on your Sun Solaris Operating system. Now you have to configure the communication type used between your server and the UPS. Since the Software is developed in Java and the configuration is common for all the operating systems, refer to the following chapters to see how to complete the UPS communication settings.


7.4 Sun Solaris and RS232 Chapter 4.3 (JUMP DATASHIELD SERIAL (RS232) CONFIGURATION) explains how to configure JUMP DataShield to communicate over the serial cable with the UPS. In order to be able to configure Sun Solaris server to use a serial communication with the UPS follow step by step the information given and make sure that instead of configure serial COM1 you use Sun Solaris serial ports name such as /dev/ttya (for COM1) or /dev/ttyb (COM2). 7.5 Sun Solaris and SNMP communication Chapter 4.4 (JUMP DATASHIELD SNMP CONFIGURATION) explains how to configure DataShield to communicate with the UPS over SNMP protocol. The configuration procedure is exactly the same also for Sun Solaris. 7.6 Sun Solaris and SNMP proxy agent Charter 4.5 (JUMP DATASHIELD SNMP PROXY AGENT CONFIGURATION) shows how to create a proxy agent for share the UPS data via SNMP protocol. The configuration procedure is exactly the same also for Sun Solaris. 7.7 Sun Solaris automatic startup as Daemon Since there is not a common way (for Unix systems) to configure DataShield for the automatic start-up at the boot time, the system administrator has to create it. In DataShield directory the script named 'runshieldu' has to be modified by adding a switch '-service' at the end of line. Example: export CLASSPATH /usr/bin/jdk1.4/bin/java -Dinstall.root=/DataShield/ DataShield "$@" -service DataShield Once the script has been modified the administrator can prepare a start-up script to hook runshieldu and start-up the software in background.


8 JUMP DATASHIELD ON NOVELL NETWARE 8.1 Prerequisites If not already installed, you need to get Novells Java Virtual Machine JVM 1.4.1 from:

http://download.novell.com.au/support/pub/updates/ 8.2 Installation The first part of DataShield installation is performed using InstallShield Java Edition. The DataShield software package comes as one class file called setup.class. In order to start the installation on Novell platform user simply has to type

java -ns -cp sourcedir setup -o destdir where sourcedir is the path where the setup.class is located in, and destdir is the target directory of your desired installation. After Installshield extracted all files to destdir and created the necessary files for starting, you are asked, if InstallShield shall modify your autoexec.ncf in order to start the protection part of DataShield on bootup of your server. If answering “Yes”, Installshield will look for a STARTX entry and place the start entry for the protection part of DataShield before the STARTX command. In case there is no STARTX entry found, the protection part of DataShield will be placed at the end of autoexec.ncf. If answering “No”, you may do the entry manually. Although InstallShield prompting not to know so much about Sun on Novell, the DataShield component of InstallShield programm creates the needed batch files, if no further error prompted. Autoexec.ncf will be saved to autoexec.dss. To proceed a proper shutdown under Novells Netware, Datashield is using a native tool, called "doshutdown.nlm", in the sys:system directory. This tool checks if the conditions for shutdown are true, if so, it will run a shutdown-script. To initiate the shutdown process, the protection part of Datashield creates a file called shutdown.now in the sys:system directory. This file is checked by doshutdown.nlm. If the file exists and has the correct content, then the tool starts the powershut.ncf, located in:

\\Datashield\scripts\novell Feel free to add commands to \\Datashield\scripts\novell\powershut.ncf regarding the needs of shutting down your server. Note that script sys:\system\shutdown.ncf -if exists- is also responsible for the shutdown behaviour of your server. After installation you can run protection part and presentation part using generated scripts "runshield" and "runview" (with platform specific types - ncf for novell). You have to configure the system to communicate with correct SNMP box connected to your UPS or - for that it is best to run both programs and use JUMPView for configuration of protection part. You have to authenticate yourself to be able to do that - use predefined password "GE" and change it to something only you will know. Don't forget to save the changed configuration data and restart DataShield using menu selection "Activate changes" in Configuration menu. Read more about features of the software using menu item "Documentation" while running JUMPView or using your favorite Web browser pointed to the system with running DataShield using predefined port for Web communication 2161 (you type something like http://my_computer:2161/ to connect to DataShield built in Web server). You can also disable start of built in Web server. It is enough to configure port for Web communication to be -1 and Web server will not be started upon next restart of DataShield.


9 JUMP DATASHIELD ON MAC OS 9 Installation of DataShield on Macintosh platform is a little more complicated to compare with other supported platforms. Here we will outline the necessary steps you have to take in order to successfully install DataShield software on Macintosh platform. 9.1 Prerequisites You need to get Mac OS Runtime for Java (MRJ) support version 2.1.2 or higher from http://developer.apple.com/java/. You also need to download MRJ Software Development Kit (SDK) from the same location. User's need to get SDK because of non-existence of command line interface on Mac platform combined with special type of file system on Mac platform that prevents us to prepare executable script files on different platform then Mac itself. Because DataShield software is by design multiplatform, we decided to make installation on Mac as easy as possible while staying multiplatform. 9.2 Installation The first part of installation of DataShield is performed using product InstallShield Java Edition. DataShield software comes in the form of one class file called setup.class. In order to start installation on Mac platform user has to create "application" to be able to start setup.class with Java. For that user has to use JBindery, that can be found in MRJ Software Development Kit (SDK). It is kind of help application that is used to define which classes are needed for specific application and what additional libraries are to be used. In order to create installation application user has to start JBindery and specify in Command specification section as Class name simply setup (without extension). For the classpath specification there is always $CLASSPATH specified (and cannot be removed). We have to add folder, where this readme and setup.class have been copied (so that Java runtime is able to find setup.class file). After that user has to save this "application" to the folder where setup.class has been copied under the name install. After that he can quit JBindery application, double click on icon representing "install" application and first part of installation will start. This part is asking only to agree with license terms and then it is providing default folder to install DataShield to. This folder is called DataShield, but don't accept the default! It is because all other scripts that are prepared are assuming, that DataShield will be installed into the directory DataShield, but starting at the root of start-up hard drive (not as a subdirectory of the original directory where setup.class has been copied). So in this place YOU HAVE TO MODIFY folder specification BY HAND! You have to specify /(start-up hard drive)/DataShield. After that this part of installation will expand a lot of files from setup.class. It will create standard directory structure of DataShield in that specified directory called also DataShield (that starts at the root of start-up hard drive). In remaining steps of installation we will always refer only to this installation directory and its subdirectories. Please note: If you will read all the instructions for installing DataShield software you will understand, that you can of course install it to some other directory, but then you have to modify the content of the prepared scripts that we will be dealing with in next steps of installation.


After the first step of installation will finish you will mention, that it claims 0 batch files created. There are really no batch files created - on Mac platform we have to create them by hand. The good news is that they are already prepared and ready to go, it is just that Mac does not know that they are really Mac scripts. So the idea is to start AppleScript Editor of Scripts, read the files into the editor, check them and save them under slightly different names. We are talking about using Editor of Scripts to read files runshield-mac.bat and runview-mac.bat and save them back under names runshield-mac (without extension) and runview-mac respectively (save them in the same directory - which means DataShield directory, or in other words installation directory). The trick is, that they are named originally with extension .bat, because in this way Mac Editor of Scripts will recognize them as potential scripts, but treats them as normal text. So when you go to save them under name without extension, you have to be careful and CHANGE TYPE TO APPLICATION (please check also "Don't show start-up window" for them). One last complication is that these scripts have been prepared on Win platform so the contain wrong line ending. Please remove unnecessary character by hand and 'Check syntax' to be sure none of those extra characters is remaining in the file. This whole procedure is a little clumsy way of creating AppleScripts from prepared text files. After successfully creating these two scripts in installation (DataShield directory) you have to do the same procedure with macrestart.bat (going to macrestart script) and macshut.bat (going to macshut script) in scripts/mac subdirectory of installation directory. Again you read them with Editor for Scripts, remove extra characters from DOS world, save them under name without extension but changing them from text to application and checking 'Do not show starting window'. After this painful procedure we have created 2 AppleScripts in DataShield directory and 2 in scripts subdirectory of this directory. 9.3 Create the application We have scripts now, but we don't have applications to start. Please use again JBindery to create two "applications" in DataShield directory called macjump and macview. The settings for these two applications are listed in files macjump.txt and macview.txt that are located also in DataShield directory. Please use them as helpful reference for setting up required values in JBindery editor and save them under these names (macjump without extension and macview without extension) in DataShield directory. To launch the protection part of DataShield at every start of your Mac, you can create an Alias of script runshield-mac and copy it to start objects folder of your Mac's System directory. Because error can be introduced in any step, you have to test the installation by really starting DataShield (using runshield-mac) and JUMPView (using runview-mac) and trying to apply some configuration changes and restart DataShield as well as letting the whole Mac being shut down during power outage (in this case of course simulated). After installation you can run protection part and presentation part using generated scripts "runshield" and "runview". 9.4 MAC OS 9 And SNMP communication Chapter 4.4 (JUMP DATASHIELD SNMP CONFIGURATION) explains how to configure DataShield to communicate with the UPS over SNMP protocol. The configuration procedure is exactly the same also for MAC OS 9.


10 JUMP DATASHIELD ON MAC OS X 10.1 Installation Here we will outline the necessary steps you have to take in order to successfully install DataShield software on Macintosh OSX platform. Mac OS X delivers Java 2 on every system. For further Information about Java on Mac OS X see http://www.apple.com/macosx/features/java/. DataShield on Mac OS X is best tested with the JVM 1.4.1 To get the latest version of the JVM use the Software Update feature of your Mac. To proceed a proper shutdown under Mac OS X, DataShield has to run with root permissions. On standard installation, normally no such user can log in. To enable login of user root, you have to boot from CD 1 of your Mac OS X installation. In Installer menu select Reset Password. Then you have to select your start-up disk. Now you can enter the new password for the System Administrator (root). For the following operations log into your system as root or use terminal with super user permissions. First part of installation of DataShield is performed using product InstallShield Java Edition. DataShield software comes in the form of one class file called setup.class. You can use a terminal to install DataShield. Terminal is located in folder Applications\Utilities of your start-up disk. If you're not logged in as root, you can type su in running terminal. Now you are asked for the root password. Change to directory where setup.class is located in. Then type:

java -cp . setup -o destdir Where destdir is the target directory of desired installation. After InstallShield extracted all files to destdir, you will mention, that it claims 0 batch files created. Don't worry, they are created called runshieldu and runview. Furthermore an entry in /Library/Startup Items called runshieldu is generated to provide DataShield service at every system start-up.

During the installation you see the following question:

do you want to install usb to serial support? 1) Yes 2) No

Select choice [1 – 2]: Here you have the option to install the needed drivers for USB to serial support. For more details about USB to serial support please refer to chapter 3.2. To choose this option you have to select 1 followed by enter. The next steps are described in chapter 14 in details. If you connect the UPS to your system using any other way described in chapter 3, then select 2 for “No”. After installation you can run protection part and presentation part using generated scripts "runshieldu" and "runview" located in the target directory of installation. You have to configure the system to communicate with correct SNMP box connected to your UPS or - for that it is best to run both programs and use JUMPView for configuration of protection part. You have to authenticate yourself to be able to do that - use predefined password "GE" and change it to something only you will know. Don't forget to save changed configuration data and restart DataShield using menu selection "Activate changes” in Configuration menu. On next start-up of your system, DataShield will be started automatically.


10.2 Graphic installation Go to the directory where setup.class is located. Type the command “java setup” and the following welcome page appears in DataShield Graphic Interface. (See Figure 10.2.1)

Figure 10.2.1

Click “Next” and README information page appears on the screen. (See Figure 10.2.2)

Figure 10.2.2


Click “Next” and DataShield License agreement is displayed, in order to be able to install the software you have to accept the license and click “Next”. (See Figure 10.2.3)

Figure 10.2.3

Click “Next” and specify the directory path where you wish to install the software. (See Figure 10.2.4)

Figure 10.2.4

Click Install to proceed with the software installation. A message could appear prompting that the specified directory does not exists. In this case you need to advise “Yes” to create it. (See Figure 10.2.5)

Figure 10.2.5


Figure 10.2.6

During installation you have the option to install the required drivers for USB to serial support. For more details about USB to serial support please refer to chapter 3.2. To choose this option you have to select “Yes” in the following window. (See Figure 10.2.7). The next steps are described in chapter 14 in details.

Figure 10.2.7

If you connect the UPS to your system using any other way described in chapter 3, then select “No”. Once the installation has been completed, click on “Finish” button to close the graphic installation wizard. (See Figure 10.2.8)

Figure 10.2.8


10.3 MAC OS X and SNMP communication Chapter 4.4 (JUMP DATASHIELD SNMP CONFIGURATION) explains how to configure DataShield to communicate with the UPS over SNMP protocol. The configuration procedure is exactly the same also for MAC OS X.


11 JUMP DATASHIELD USING USB ON MS WINDOWS If you like to use the USB to serial adapter, the software driver has to be installed before the adapter is plugged into the system. 11.1 Installing DataShield together with USB to serial support If you are installing DataShield for the first time on your system, after finishing the DataShield part of the installation the installation process detects if USB is generally supported by your operating system. If “Yes”, you are asked if you like to install USB support now. (See Figure 11.1.1)

Figure 11.1.1

Selecting "No" will finish DataShield installation. Selecting "Yes" will check if older versions of USB to serial drivers are already installed or USB to serial adapter was ever connected to system. Assuming no USB to serial device is found on the system, following Window appears. (See Figure 11.1.2)

Figure 11.1.2

To continue press "Next" and the required files are now copied to the system.


In the following window please select "Finish" to complete the USB to serial installation part. (See Figure 11.1.3)

Figure 11.1.3

Afterwards the following message box appears: (See Figure 11.1.4)

Figure 11.1.4

Now you have to plug in your USB to serial adapter. To check if USB to serial installation was successful and to take the newly installed USB to serial adapter into the configuration of DataShield, you have to select "Yes". Note: The newly installed USB to serial adapter will be automatic integrated in your actual

configuration of DataShield if you are installing DataShield for the first time on this system.


11.2 Installing USB to serial support when updating DataShield In case of updating an existing DataShield installation, the settings of the former installation are kept available. The installation process of the USB to serial support is the same as described in the chapter before, but you have to configure the communication port of DataShield manually. This is done by using the detected device name shown in the last window of the driver installation. (See Figure 11.2.1)

Figure 11.2.1

Note: The COM number may differ and depends on your hardware configuration. To configure the serial port to be used in DataShield, please continue as described in the related chapters for RS232 configuration. 11.3 Updating DataShield without changings on USB to serial support At the end of DataShield installation, also when updating DataShield to the latest version, the following question appears. (See Figure 11.3.1)

Figure 11.2.1

Selecting "No" will finish the installation. This may be your intention if you are updating DataShield to a later version. Your configuration and USB to serial support will be kept available.


11.4 Updating USB to serial support The following procedure is similar to the installation together with the DataShield. The difference is, that in case of updating the USB to serial support the former version of the driver has to be removed. In any case the installation process is first detecting if USB is generally supported by your operating system and starts with the following screen. (See Figure 11.4.1)

Figure 11.4.1

Selecting "Yes" will check if older versions of USB to serial drivers are already installed, or the USB to serial adapter was ever connected to your system. Even if USB to serial adaptor was connected to your system only for a short time and no driver was manually installed the following Message appears. (See Figure 11.4.2)

Figure 11.4.2

Since there are several versions of the driver found in the market which won't work with this USB to serial adaptor, it is strongly recommended to select "Yes" here. This leads to the last question before removing the old driver. (See Figure 11.4.3)

Figure 11.4.3

Selecting “OK” will result in the next window, were you can decide to reboot your system now, or not. (See Figure 11.4.4)


Figure 11.4.4

Select "No" At this point it is not necessary to reboot now since it is possible you have some newer versions of the driver installed and the setup program will scan for them soon. Click exit to finish removing the old driver. (See Figure 11.4.5)

Figure 11.4.5

In case a newer driver is found, you will see a Window like this. (See Figure 11.4.6):

Figure 11.4.6


Place the radio button on "Uninstaller driver!" like shown above and click "Next". The driver will be removed and the following window appears. (See Figure 11.4.7)

Figure 11.4.7

Now a reboot is needed, so please place the radio button on "Yes...".

To install the USB to serial support now, please refer to the related chapters above.


11.5 Manual installation of USB to serial support Navigate to folder where PL-2303_X_H_HX_ Driver_Installer.exe is located and start this application. When Figure 11.5.1 is prompted, click “Next” and the required files are copied to the system.

Figure 11.5.1

Figure 11.5.2

In Figure 11.5.2 select "Finish" to complete USB to serial installation part. After connecting your USB to serial adapter to your system you can look in the hardware manager for the name of the new serial device.


12 JUMP DATASHIELD USING USB ON LINUX If you like to use the USB to serial adapter, the software driver has to be installed before the adapter is plugged into the system. 12.1 Installing DataShield together with USB to serial support If you are installing DataShield for the first time on your system, after finishing the DataShield part of the installation the installation process detects if USB is generally supported by your operating system. If “Yes”, you are asked if you like to install y support now. (See Figure 12.1.1)

Figure 12.1.1

Selecting "No" will finish DataShield installation. Selecting "Yes" will check if older versions of USB to serial drivers are already installed or USB to serial adapter was ever connected to system. Assuming no USB to serial device is found on the system, following Window appears. (See Figure 12.1.2)

Figure 12.1.2

Now you have to plug in your USB to serial adapter. To check if USB to serial installation was successful and to take the newly installed USB to serial adapter into the configuration of DataShield, you have to select "Yes". Note: The newly installed USB to serial adapter will be automatic integrated in your actual



12.2 Installing USB to serial support when updating DataShield In case of updating an existing DataShield installation, the settings of the former installation are kept available. The installation process of the USB to serial support is the same as described in the chapter before, but you have to configure the communication port of DataShield manually. This is done by using the detected device name shown in the last window of the driver installation. (See Figure 12.2.1)

Figure 12.2.1

Note: The COM number may differ and depends on your hardware configuration. To configure the serial port to be used in DataShield, please continue as described in the related chapters for RS232 configuration. 12.3 Updating DataShield without changes on USB to serial support At the end of DataShield installation, also when updating DataShield to the latest version, the following question appears. (See Figure 12.3.1)

Figure 12.3.1




Figure 12.4.1

Selecting "Yes" will check if older versions of USB to serial drivers are already installed, or the USB to serial adapter was ever connected to your system. Even if USB to serial adapter was connected to your system only for a short time and no driver was manually installed the following Message appears. (See Figure 12.4.2)

Figure 12.4.2

Since there are several versions of the driver found in the market which won't work with this USB to serial adapter, it is strongly recommended to select "Yes" here. Selecting "No" will finish the installation without changing the serial and USB configuration of your system. Selecting "Yes" will overwrite any existing usb2serial driver installation and the following Window appears. (See Figure 12.4.3)

Figure 12.4.3

Now you have to plug in your USB to serial adapter. To check if USB to serial installation was successful you have to select "Yes" when ready.


12.5 Manual installation of USB to serial support Navigate to the folder where the Linux driver files are located and follow the instructions in the readme files.


13 JUMP DATASHIELD USING USB ON MAC OS9 If you like to use the USB to serial adapter, the software driver has to be installed before the adapter is plugged into the system. 13.1 Manual installation of USB to serial support To use USB to serial adapter PL2303 with your system you have to navigate to the subfolder: usb/Mac/OS9 of the DataShield directory on CD. Simply unstuff the file pl-2303hx.hqx. Put the newly generated file ProlificUSBSerial1.3.0b2 to the system extensions directory of your Mac. In order to activate the driver you have to reboot. In the configuration part of DataShield the USB adapter will appear as serial interface PL2303_. In the file readme-mac-OS9.txt located in the OS9 directory, you may find additional information.


14 JUMP DATASHIELD USING USB ON MAC OS X If you like to use the USB to serial adapter, the software driver has to be installed before the adapter is plugged into the system. 14.1 Installing DataShield together with USB to serial support If you are installing DataShield for the first time on your system, after finishing the DataShield part of the installation the installation process detects if USB is generally supported by your operating system. If “Yes”, you are asked if you like to install USB support now. (See Figure 14.1.1)

Figure 14.1.1

Selecting "No" will finish DataShield installation. Selecting "Yes" will check if older versions of USB to serial drivers are already installed or USB to serial adapter was ever connected to system. Assuming no USB to serial device is found on the system, the following Window appears. (See Figure 14.1.2)

Figure 14.1.2

Now you have to plug in your USB to serial adapter. To check if USB to serial installation was successful and to take the newly installed USB to serial adapter into the configuration of DataShield, you have to select "OK". Note: The newly installed USB to serial adapter will be automatically integrated in your actual



14.2 Installing USB to serial support when updating datashield In case of updating an existing DataShield installation, the settings of the former installation are kept available. The installation process of the USB to serial support is the same as described in the chapter before, but you have to configure the communication port of DataShield manually. This is done by using the detected device name shown in the last window of the driver installation. (See Figure 12.2.1)

Figure 14.2.1

Note: The number of the ttyUSBserial device may differ and depends on your hardware configuration. To configure the serial port to be used in DataShield, please continue as described in the related chapters for RS232 configuration. 14.3 Updating DataShield without changings on USB to serial support At the end of DataShield installation, also when updating DataShield to the latest version, the following question appears. (See Figure 14.3.1)

Figure 14.3.1




Figure 14.4.1

Selecting "Yes" will check if older versions of USB to serial drivers are already installed, or the USB to serial adapter was ever connected to your system. Even if USB to serial adapter was connected to your system only for a short time and no driver was manually installed the following message appears. (See Figure 14.4.2)

Figure 14.4.2

Since there are several versions of the driver found in the market which won't work with this USB to serial adapter, it is strongly recommended to select "Yes" here. Selecting "No" will finish the installation without changing the serial and USB configuration of your system. Selecting "Yes" will overwrite any existing usb2serial driver installation and the following Window appears. (See Figure 14.4.3)


Figure 14.4.3

Now you have to plug in your USB to serial adapter. To check if USB to serial installation was successful you have to select "OK" when ready. 14.5 Manual installation of USB to serial support Navigate to the folder usb/Mac/OSX where the MacOSx driver files are located and follow the instructions in the readme file readme-mac-OSX.txt.


15 ALARMS MONITORED BY DATASHIELD A modern UPS provides power back-up & protection plus the capability to inform someone about his operating status. That means that the UPS offers a communication interface to the outer world, and this interface can be used by specially designed programs to read/write UPS parameters. More than that, the UPS has the ability to signal abnormal conditions by generating a set of asynchronous events on the interface. These events are commonly named alarms. The typical set of UPS generated alarms consists of three categories of alarms:

1. The first category informs about error conditions that just occurred in the normal operation of the UPS. 2. The second one informs about the UPS being in some a special mode of operation. 3. The last category of alarms is dangerous alarms as UPS On Battery, Low Battery and Shutdown Imminent. If DataShield detects such alarm condition it will shutdown your computer immediately to prevent file-system crashes, or other potential causes of data loss. It must be noted that these operations are performed by a background process. It is not required to have the graphic viewer running in order to have your computer protected. The complete list of alarms detected by DataShield

Battery Bad One or more batteries have been determined to require replacement. On Battery UPS is drawing power from the batteries. Low Battery The remaining battery run-time is dangerously low. Depleted Battery UPS is unable to sustain the present load when and if mains is lost. Temperature Bad A temperature is out of tolerance. Input Bad An input condition is out of tolerance. Output Bad An output condition (other than Output Overload) is out of tolerance. Output Overload The output load exceeds the UPS output capacity. On Bypass The Bypass is presently engaged on the UPS. Bypass Bad The Bypass is out of tolerance. Output Off As Requested

UPS has shutdown as requested, i.e., the output is off.

UPS Off As Requested The entire UPS has shutdown as commanded. Charger Failed An uncorrected problem has been detected in the UPS charger. UPS Output Off The output of the UPS is in the off state. UPS System Off The UPS system is in the off state. Fan Failure The failure of one or more fans in the UPS has been detected. Fuse Failure The failure of one or more fuses has been detected. General Fault A general fault in the UPS has been detected. Test Failed The result of the last diagnostic test indicates a failure.

Communication Lost A problem has been encountered in the communications between the UPS and Computer/SNMP box/card.

Awaiting Power The UPS output is off and the UPS is awaiting the return of input power. Shutdown Pending A shutdown countdown is underway.

Shutdown Imminent The UPS will turn off power to the load in less than 5 seconds; this may be either a timed shutdown or a low battery shutdown.

Test In Progress A test is in progress.

Lost Agent A problem has been encountered in the communications between the DataShield and SNMP/Web Interface / Proxy-AGENT.

Note: Availability of above alarms depends on the UPS type.

Please check the UPS manual for more Information.


How DataShield handles alarms DataShield handles alarms coming from a UPS to shut down affected systems or workstations. In this section, he example of a PowerFailure alarm will be illustrated. When DataShield detects an alarm signal (e.g. PowerFailure) it immediately checks to see if a predelay (i.e. an alarm filter) has been set and then logs the event to a log-file. During the period of the predelay DataShield will not take any other action. If the predelay is passed DataShield starts counting down the runtime. During the runtime, depending upon user defined settings, DataShield will broadcast the alarm messages on the system and take other user defined actions when defined. Execution of these user-defined actions is logged. If the situation that triggered the alarm returns to normal before the expiration of the runtime, DataShield logs this fact and, depending on the user defined settings, a message is broadcast on the system. When the alarm is active and the runtime period expires, DataShield will check to see if the system shutdown has been set. If the system shutdown option is set DataShield will execute the shutdown script. Depending on user defined settings, this will also shutting down the UPS, and/or take other action which the user can define within this shutdown script file. When the system is restarted (DataShield will normally be set up to start automatically) DataShield starts up monitoring for alarms again. DataShield SCRIPT Files The way DataShield was designed to execute scripts (or batch/command files) gives users a very powerful and flexible method to customize the actions of the program. As delivered, the DataShield scripts can be modified to broadcast messages and initiate a system shutdown. Should the user wish to add custom calls in the DataShield scripts, the system text editor can be used for this purpose (for instance alarms via modems or paging systems). However, it is recommended users become thoroughly familiar with how DataShield functions before customizing. It is possible to have multiple scripts started at different times after activation or deactivation of an alarm.


16 TROUBLESHOOTING 1. I cannot see Russian characters in my DOS Prompt 2. During the installation process there is an “error failed to open properties file for reading” 3. I got an error Exception in thread "main" java.lang.NoClassDefFoundError: setup 4. Will Java applications run on OpenVMS VAX? 5. Runshieldu takes 95,8% , mem 7.7% when running as background process. 6. Where can I download the Windows 2K/XP driver for my UPS? 1. I cannot see the Russian characters in my DOS Prompt

The user has to change (manually) so called font definition file to represent his specific character group (Arabic, Chinese, Russian etc). Technically it is very simple - inside Java runtime support there is directory called lib and there one can find file font.properties (ASCII file), and also couple of others: font.properties.zh, font.properties.ru etc. The only thing user should do is to make backup copy of current font.properties file and copy say font.properties.ru to font.properties file (essentially replacing 'normal' font properties file with the one designed for Russian windows). This tells Java to make proper font mapping between characters and local fonts of the operating system. 2. During the installation process there is an “error failed to open properties file for reading”

Most likely you are using a Path name containing spaces, or you started the install.bat script form a network file system. Please use path names like: [Local_Drive]:\DataShield or [Local_Drive]:\programs\DataShield

DO NOT USE: [Local_Drive]:\Downloaded Files\Installation Files\Program Files\DataShield

3. Exception in thread "main" java.lang.NoClassDefFoundError: setup, while the setup.class file is

in the directory.

You should start the installation using ‘java -cp . setup’ The reason is that Java requires to know the path of the filename you are trying to execute, hence the '-cp .' Please run the above command within a dos-box and make sure you are within the directory containing the setup.class file 4. Will Java applications run on OpenVMS VAX?

No. You can run Java applications on any operating system platform that implements the Java Virtual Machine. The Java Virtual Machine is included in both the Java Development Kit (JDK/SDK) for OpenVMS Alpha and in the Netscape Navigator for OpenVMS Alpha. However, the Java Virtual Machine won't be available on OpenVMS VAX. Why? The Java Virtual Machine requires an implementation of the IEEE math standard within the operating system. This IEEE standard is not part of the OpenVMS VAX architecture. In Compaq's attempts to emulate this IEEE standard on OpenVMS VAX, they encountered architectural restrictions that hindered their ability to deliver a conformant Java Virtual Machine implementation required by Java Soft. Further attempts to work around these architectural restrictions on OpenVMS VAX resulted in Java applications running with unacceptable performance.


5. Runshieldu takes 95,8%, mem 7.7% when running as background process. Edit with your favourite editor like “vi” the script runshieldu and insert the switch “-service” at the end of runshieldu line code before the DataShield name. EXAMPLE:

...-Dinstall.root=/DataShield/ DataShield "$@" -service DataShield

Try to start the script, if does not gives any error, then the software is working properly. This switch also deny the software to print out text in console.

6. WHERE CAN I DOWNLOAD THE WINDOWS 2K/XP DRIVER FOR MY UPS? UPS should be connected to your PC through a cable named VIC 25 in order to avoid the installation of any particular software/driver and to use the native MS Windows solution. Cable usually delivered with the UPS is named VIC 23 (Which is used for the Intelligent communication) and should not be used to handle the UPS with MS windows native UPS service. VIC 23 cable has to be used in combination with GE Digital Energy Data Protection and Management software tools, as JUMP DataShield, JUMP Manager and PowerFLAG. When a UPS is connected for the first time in Windows 2000/XP with VIC 23 cable, the operating system will prompt a request to assign a valid driver for the device. Since a driver is not necessary because you have to communicate with the UPS through the native GEDE application you have to proceed as follows:

Select the option “search for a suitable driver for my device” and choose “Next” Specify where to search the driver (CD-Rom, Floppy) do not change the settings in this window and choose “Next”. The system will search in your Floppy drive and CD-Rom device for a suitable driver, and after few seconds the driver files search results appear.


Select the option Disable the device and choose “Finish”. With this configuration you only have deactivated the Plug and Play request, which appear during the start-up process. The UPS is still enabled and ready to communicate with GEDE Data protection and Monitoring tools.


17 PRODUCT DESCRIPTION Package contents

1 CD ROM (delivered with the UPS) 1 cable (delivered with the UPS) System requirements

Platform supporting JAVA 1.2 or higher Approx. 5Mb hard disk space Min. 4Mb RAM 1 free RS232 port or network connection with TCP/IP installed Performance Note

Running as a normal background task, DataShield will consume a fraction of the available CPU-time (often below 1%, depending on your hardware and the number of servers). Compatibility

General Electric Digital Energy provides support and regular upgrading for the following platforms: All platforms that support JAVA 1.2 or higher.