Power Management Software User Guide
April 2007
This section describes the symbols used in this guide.
Danger
This alerts you to things that may cause serious injury to a person.
Only qualified, properly trained personnel should perform these procedures.
Caution
This alerts you to things that may cause loss of data, damage to your computer or your device
Note
A note provides you with additional information that you might want to consider.
Tip
This draws your attention to information that will help you perform a task more quickly or easily.
PowerLogic, ION, ION Enterprise, MeterM@il and Modbus are either trademarks or registered trademarks of Schneider Electric.
Documentation Conventions
This section describes the terms used to describe common methods or procedures used throughout this guide.
Clear Place the mouse cursor over the check box, then click the mouse button to remove the check mark from the box.
Click Place the mouse cursor over the button or item, then press and release the mouse button.
Double-click Place the mouse cursor over the button or item, then press and release the mouse button twice.
Drag Hold down the mouse button while moving the mouse cursor to hightlight the selection or move the selected item, then release the button.
Enter Type the information, then press ENTER on the keyboard.
Point Position the mouse pointer over an item such as a menu command.
Press Press the specified key or combination of keys (for example, CTRL+ALT+DEL) on your keyboard.
Select Place the mouse pointer over a radio button or check box, then click the mouse button to mark your selection.
Type Type the information in the space or box. DO NOT press the Enter key.
Chapter 1 Introduction ... 13
ION Enterprise Software Components . . . 14
Core Applications . . . . 14
Administration . . . . 14
Programming . . . . 15
ION Enterprise Services . . . 16
ION Enterprise Databases . . . 17
Getting Started . . . 18
Starting ION Enterprise . . . . 18
Logging in to ION Enterprise . . . . 18
Chapter 2 Management Console ... 19
The Management Console Interface . . . 20
Shortcut Menu Summary . . . . 21
Management Console Network Components . . . 25
Detailed Operation . . . 27
Adding a Network Component . . . . 27
Editing a Network Component . . . . 30
Deleting a Network Component . . . . 30
Accessing Meters with Advanced Security . . . . 30
Configuring the Network through SQL Statements . . . . 31
Configuring Connection Schedules . . . . 32
Setting Up Large Systems . . . 34
Creating Multiple Copies of an Ethernet Device . . . . 34
Creating Multiple Copies of a Serial Device . . . . 38
Creating Multiple Copies of an OPC Device . . . . 39
Selecting Multiple Devices to Configure . . . . 40
Using the Table Editing Area . . . . 42
Edit, Copy and Paste . . . . 45
Find and Replace . . . . 46
Chapter 3 Management Console Tools ... 49
Introduction . . . 50
User Manager . . . 51
Starting User Manager . . . . 51
Starting Diagnostic Viewer . . . . 54
Navigation Panel . . . . 54
Diagnostics Information Panel . . . . 55
Using the Filter Editor . . . . 57
Server Diagnostics . . . . 57
Communications Diagnostics . . . . 59
Additional Commands . . . . 60
Communication Status vs. Site Status . . . . 62
Device Upgrader . . . 63
Using Device Upgrader . . . . 63
Firmware Upgrade Error Codes . . . . 65
Remote Modem Setup . . . 66
Using Remote Modem Setup . . . . 66
Virtual Processor Setup . . . 68
Configuring the Virtual Processorʹs Modbus Service . . . . 68
Modifying the Global Parameters . . . . 73
Chapter 4 Vista ... 75
Starting Vista . . . 76
Ending Your Vista Session . . . . 76
The Vista Interface . . . 77
Vista User Diagrams . . . 78
What is a User Diagram? . . . . 78
Default User Diagrams . . . . 79
Generating, Opening and Closing a User Diagram . . . 80
Generating a Network Diagram . . . . 80
Opening a User Diagram . . . . 80
Specifying a Vista Diagram to Open for a Given User . . . . 80
Closing a User Diagram . . . . 81
Navigating a User Diagram . . . 82
Display Mode and Edit Mode . . . . 82
Grouping Windows . . . . 82
Display Features . . . . 83
Monitoring Your System in Vista . . . 84
Viewing Real‐Time Data . . . . 84
Viewing Logged Data . . . . 87
The Log View Plotter . . . 93
Viewing the Plot Display Tab . . . . 96
Viewing the Harmonics Analysis Tab . . . . 100
Viewing the Phasor Diagram Tab . . . . 102
Adding Parameters to a Log View Plotter . . . 105
Adding Data from a Data Log Viewer . . . . 105
Adding Events from an Event Log Viewer . . . . 105
Adding Data from a Spreadsheet or Text File . . . . 106
Customizing the Log View Plotter . . . 108
Customizing an Axis . . . . 108
Customizing Curve Style . . . . 110
Customizing Graph and Legend Options . . . . 112
Removing Graph Parameters . . . . 113
Overlaying Curves (CBEMA) . . . 114
Creating and Editing a User Diagram . . . 116
Opening a User Diagram . . . . 116
Creating a new user diagram . . . . 116
Saving a User Diagram . . . . 116
Placing Diagram Objects into a User Diagram . . . 118
The Enable Undo Option . . . . 118
Types of Diagram Objects . . . . 118
Adding a Diagram Object to a User Diagram . . . . 119
Moving a Diagram Object . . . . 120
Resizing a Diagram Object . . . . 121
Arranging Object Layout: Alignment, Grid, and Size . . . . 121
Cutting, Copying, and Pasting a Diagram Object . . . . 123
Copying a Group of Diagram Objects to a Framework . . . . 124
Linking a Diagram Object to a Data Source . . . 125
Linking a Numeric, Status or Control Object . . . . 125
Configuring a Data Log Viewer or Event Log Viewer . . . . 126
Adding a Global Event Log Viewer . . . 129
Querying the Database . . . 130
Using the Query Options . . . . 130
Using the Query Wizard . . . . 132
Custom User Diagrams . . . 140
Customizing a Diagram Object . . . 140
Caption Options . . . . 141
Text Options . . . . 141
Edit Text Options . . . . 142
Link Options . . . . 143
Action Options . . . . 153
Box Options . . . . 155
Annunciation Options . . . . 156
Alarming Options . . . . 157
Customizing a Diagram Window . . . 159
Default Font . . . . 159
Background Color . . . . 159
Configuring Window Properties . . . . 160
Chapter 5 WebReach ... 167
WebReach Support . . . 168
WebReach Installation After ION Enterprise is Installed . . . . 168
Preliminary Setup . . . . 169
Displaying Vista Diagrams Online . . . . 169
Viewing Historical (Trend) Data . . . . 170
Viewing Meter Events . . . . 172
Adding a Global Event Viewer . . . . 173
Stale Data or Error Indicators . . . . 174
Advanced WebReach Configuration . . . 174
Custom Network Diagram Setup . . . . 174
WebReach Registry Settings . . . . 175
Additional Information . . . . 176
Troubleshooting . . . 177
Chapter 6 Reporter ... 179
Reporter Basics . . . 180
Starting Reporter . . . 180
Creating a Report . . . 180
Wizard ‐ Step 1: Select Template . . . . 181
Wizard ‐ Step 2: Select Database and Sources . . . . 181
Wizard ‐ Step 3: Set Up the Report Options . . . . 183
Previewing the Report . . . . 185
Generating a Report . . . 185
Types of Reports . . . 185
Energy and Demand . . . . 186
Load Profile . . . . 187
Power Quality . . . . 187
EN50160 . . . . 189
IEC 61000‐4‐30 . . . . 190
Waveforms . . . . 191
Creating a Report Without a Template . . . 192
Automatic Report Generation . . . 193
Using Reporter on Secondary Server or Client . . . 194
Troubleshooting . . . 194
Chapter 7 Designer ... 195
Getting Started with Designer . . . 196
Starting Designer . . . . 196
The Designer Interface . . . . 197
Display Mode and Edit Mode . . . . 198
Designer Shortcuts . . . . 198
Quitting Designer . . . . 199
The Node Diagram . . . 200
Using a Node Diagram . . . . 200
Icons . . . . 202
Grouping Windows . . . . 206
Windows . . . . 208
Working with ION Modules . . . 210
Using ION Modules . . . . 210
Linking and Configuring ION Modules . . . . 220
Deleting Links . . . . 225
Configuring ION Modules . . . . 228
Copying and Pasting ION Modules . . . . 235
Viewing Output Registers, Setup Registers, and Inputs . . . . 244
Time of Use (TOU) Program Management . . . 246
Advanced TOU Schedule Configuration . . . . 247
Virtual Processor Service . . . 249
Using the Virtual Processor . . . . 249
Distributed Control . . . . 250
Modbus Communications . . . . 253
Common Virtual Processor Applications . . . . 255
Setting Global Parameters . . . . 257
Chapter 8 Modbus Device Importer ... 259
Introduction . . . 260
ION Object Descriptions . . . 262
Managers . . . . 262
Modules . . . . 262
Registers . . . . 262
File Menu . . . . 264
Edit Menu . . . . 264
View Menu . . . . 267
Tools Menu . . . . 268
Settings Menu . . . . 271
Help Menu . . . . 272
Configure Logging and Calculation Button . . . . 272
Editing a Register . . . 272
Register Properties Defined . . . . 273
Key Mappings . . . 278
General Key Shortcuts . . . . 278
Register Quick Edit Mode . . . . 278
Tree‐view Pane . . . . 279
Modbus Register List View Pane . . . . 280
Additional Information . . . 281
Data Formats . . . . 281
Configuring Logging and Calculation . . . 283
Screen Overview . . . . 283
Configuring Register Logging . . . . 284
Configuring Low, High and Mean Calculation and Logging . . . . 285
Configuring Stale Data Settings . . . . 285
Configuring Downstream Device Functionality . . . . 286
Saving and Exiting . . . . 287
Chapter 9 Database Management ... 289
Microsoft SQL Server Database . . . 290
The Network Configuration Database . . . . 290
The System Events Database . . . . 290
The ION Database . . . . 291
Database Manager . . . 292
Manual Tasks . . . . 295
Scheduled Tasks . . . . 303
Detaching then Re‐attaching Databases . . . . 307
Attaching a Database Using Database Manager . . . . 307
Restoring an ION Database from a Backup . . . . 308
Accessing the ION Database with 3rd‐Party Applications . . . . 309
Optimizing Database Query Time . . . . 310
Log Inserter . . . 313
Log Inserter Components . . . . 313
Configuring the Log Inserter . . . . 314
Optimizing Log Inserter . . . . 317
Alert Monitor Service . . . 320
Setting Up the Alert Monitor Service . . . . 321
Starting the Alert Monitor Service . . . . 324
Chapter 11 Downstream Device Assistant ... 325
Detecting Downstream Devices . . . 326
Downstream Device Assistant Basics . . . 327
Starting the Downstream Device Assistant . . . . 327
Basic View . . . . 327
Advanced View . . . . 328
Displaying Physical Sources . . . . 329
Sorting Data . . . . 329
Options . . . . 329
Downstream Device Assistant Functions . . . 332
Renaming the Assigned Source . . . . 332
Cancelling Changes . . . . 333
Changing the Measurement Mapping . . . . 333
Adding a New Downstream Device Mapping . . . . 334
Updating the Historical Data at a Later Time . . . . 334
Activity Log . . . . 335
Description of Columns and Commands . . . 335
Downstream Device Assistant Columns . . . . 336
Downstream Device Assistant Commands . . . . 338
PowerLogic® ION Enterprise® software is a complete power management solution for energy suppliers and consumers. It allows you to manage energy information from metering and control devices installed in your facility or other remote locations. ION Enterprise offers control capabilities and comprehensive power quality and reliability analysis to help you reduce energy‐related costs.
ION Enterprise is compatible with Microsoft® Windows® Server 2003 operating system, and supports multiple communications standards and protocols available on ION meters and similar intelligent metering devices. You can also connect to existing power monitoring systems through industry standard protocols such as Modbus, OPC, DNP and XML.
ION Enterprise uses Microsoft SQL Server 2005 for efficient and secure data management. You can install the SQL Server 2005 Express Edition that comes with ION Enterprise (4 GB maximum database size), or for larger database needs you can use an existing SQL Server 2005 instance (Standard edition or better) to host the ION Enterprise database.
In This Chapter
ION Enterprise Software Components . . . 14
Core Applications . . . . 14
Administration . . . . 14
Programming . . . . 15
ION Enterprise Services . . . 16
ION Enterprise Databases . . . 17
Getting Started . . . 18
Starting ION Enterprise . . . . 18
Logging in to ION Enterprise . . . . 18
ION Enterprise Software Components
This section outlines the ION Enterprise software components, and how they are used to build, monitor, maintain and customize your ION Enterprise system.
Core Applications
These ION Enterprise programs are most commonly used in day‐to‐day power management tasks:
Vista
“Vista” is the main user interface for displaying graphical representations of your power monitoring system on a computer monitor. Vista displays real‐time and historical information, visual objects that indicate the current status of your system, and interactive objects that you can use to perform certain actions such as acknowledging alarms.
WebReach
“WebReach” is the ION Enterprise component that displays Vista diagrams in a web browser.
Reporter
“Reporter” is the tool you use to create and generate common energy, demand or power quality reports.
Administration
These ION Enterprise programs help you set up and maintain your power management system:
Management Console
Use “Management Console” to add and configure network components such as servers, sites (communication links) and devices. Management Console also provides access to system and database applications, and utilities for managing user accounts and upgrading the software licensing. These are described in the following topics:
“Database Management” on page 289
“User Manager” on page 51
“License Manager” on page 53
“Designer” on page 195
“Diagnostic Viewer” on page 54
“Device Upgrader” on page 63
“Remote Modem Setup” on page 66
“Virtual Processor Setup” on page 68
“Modbus Device Importer” on page 259
The following commands are available from the Management Console Tools menu when these add‐on components are ordered and activated:
Update OPC Server
This command checks the network for new sources of common or typical measurements to be exposed to the OPC Server; this is only available with the optional OPC Server license.
PQDIF Exporter
This command lets you export data to Power Quality Data Interchange Format (PQDIF) and set regular scheduled exports with notification; this is only available with the optional PQDIF Exporter license.
Programming
These ION Enterprise programs help you customize elements in your system and configure third‐party devices so the system can recognize and utilize them:
Designer
Use “Designer” to perform a wide range of functions, from configuring setup registers of devices on your network, to creation of complex frameworks using a combination of ION modules from hardware or software nodes.
Modbus Device Importer
Use “Modbus Device Importer” to integrate third‐party Modbus devices into the ION Enterprise network.
Large System Setup Using Management Console
Refer to “Setting Up Large Systems” on page 34 to set up large systems efficiently, using the “Duplicate and Configure” shortcut command for devices in
Management Console.
ION Enterprise Services
Many of ION Enterprise’s core components run as Windows Services. This allows your servers to continue monitoring your power management system even when no users are logged on. In the event of a power outage, your system automatically resumes power monitoring when the power is restored. The ION Enterprise services are started and set for automatic startup by default, unless noted below:
ION Alert Monitor Service continuously checks the ION Enterprise computer’s communications ports for high priority events occurring at remote modem sites.
When this happens, Alert Monitor initiates a communications connection to the remote modem site. Alert Monitor is registered as a manual service, and is not started by default.
ION Component Identifier Service manages communications between local and remote ION Enterprise components.
ION Connection Management Service is responsible for determining the connection status of the ION Enterprise systemʹs sites and devices, as well as handling resource allocation such as modems.
This service manages the state of connectivity for the ION Enterprise software system. In order to establish the most appropriate state for the system, each connection and disconnection request is evaluated against the overall state of the system and availability of communications channels. The system status is stored in the Network Configuration Database.
ION DDE Server is responsible for providing Dynamic Data Exchange (DDE) connectivity between ION devices and DDE compatible applications, such as Excel. ION DDE Server is registered as a manual service, and is not started by default.
ION Log Inserter Service provides historical data storage for your power‐
monitoring system. Refer to “Log Inserter” on page 313.
ION Network Router Service is responsible for routing all information between ION software components, such as client workstations and the Log Inserter. The service dynamically detects changes to the network configuration, including the addition of new servers; it is also capable of recognizing new software nodes, such as Vista, that are added to an existing server. This mechanism is used for automatic software node registration.
NOTE
ION Network Router Service has many dependent ION software services: the Virtual Processor, ION Log Inserter Service, ION Site Service, and DDE services cannot start and operate without it running.
ION OPC Data Access Server manages and is responsible for supplying OPC data to client applications. ION OPC Data Access Server is registered as a manual service, and is not started by default.
ION PQDIF Exporter Service translates ION data to PQDIF file format and manages scheduled PQDIF exports. ION PQDIF Exporter Service is registered as a manual service, and is not started by default.
ION Query Service provides historical data retrieval for your power‐
monitoring system. Refer to “Configuring a Data Log Viewer or Event Log Viewer” on page 126 for more information regarding this service.
ION Real Time Data Service manages and provides access to real time data from the power management system.
ION Site Service manages communication links to and from ION Enterprise.
ION Site Service is responsible for handling packet communications to system devices and controlling direct device communications. The service reacts to changes in network configuration: for example, often changes to certain
channels, gates, ports, or device parameters can interrupt a connection). You can add, delete, or change channels, gates, ports, and devices without having to restart the ION Site Service, ION Network Router Service, and ION Connection Management Service.
ION Virtual Processor Service provides coordinated data collection, data processing, and control functions for groups of meters. For more information on the Virtual Processor and its functionality, refer to “Virtual Processor Setup” on page 68.
ION XML Subscription Service manages subscriptions to XML data for Vista diagrams. This service is used only by WebReach. When you open a Vista diagram in a web browser, the ION XML Subscription Service creates a
subscription and delivers the real‐time data in XML format. Subscriptions expire automatically if they are not renewed. A browser renews a subscription by repeatedly requesting XML data.
ION XML Subscription Store Service keeps track of data subscriptions to the power monitoring devices on the network. This service is used only by WebReach.
ION Enterprise Databases
The ION Enterprise databases are typically installed on the Primary Server and run in the background of your ION Enterprise network system. ION Enterprise uses the SQL Server 2005 instance you set up to connect to these databases:
ION Database (ION_Data): This contains logged data from all devices on the power management network.
Network Configuration Database (ION_Network): This contains information about your network topology — the network connections, computers and every connected device, including dialout modems.
System Event Database (ION_SystemLog): This contains records of all system events.
Getting Started
Most ION Enterprise programs require you to log in before you can use them.
Starting ION Enterprise
Use one of the following methods to start ION Enterprise:
Open the “ION Enterprise Tools” folder on your desktop and double‐click the icon of the program you want to start
Double‐click the ION Enterprise icon to open the ION Enterprise Taskpad, then click on one of the links
Click Start > Programs > Schneider Electric > ION Enterprise Tools.
Logging in to ION Enterprise
Some ION Enterprise programs require you to log in before you can access them.
Type your user name and password in the appropriate box, then click OK. Some actions are restricted to certain users or groups, depending on how their login permissions were set up. See “User Manager” on page 51 for details.
For read-only access without using a password, click View only.
Use Management Console to add, remove or configure components such as metering devices in your ION Enterprise power management system. You can set up different types of sites (communication links such as Ethernet or serial), and set up connection schedules for these sites.
In addition, the Management Console “Tools” menu provides access to device and system configuration, maintenance and programming tools. These include programs for managing the databases, user accounts and software license upgrades. See “Management Console Tools” on page 49 for details.
CAUTION
Unauthorized changes to the network configuration can result in an unstable or unusable network, therefore only users with Operator or Supervisor privileges can make changes in Management Console.
In This Chapter
The Management Console Interface . . . 20
Shortcut Menu Summary . . . . 21
Management Console Network Components . . . 25
Detailed Operation . . . 27
Adding a Network Component . . . . 27
Editing a Network Component . . . . 30
Deleting a Network Component . . . . 30
Accessing Meters with Advanced Security . . . . 30
Configuring the Network through SQL Statements . . . . 31
Configuring Connection Schedules . . . . 32
Setting Up Large Systems . . . 34
Creating Multiple Copies of an Ethernet Device . . . . 34
Creating Multiple Copies of a Serial Device . . . . 38
Creating Multiple Copies of an OPC Device . . . . 39
Selecting Multiple Devices to Configure . . . . 40
Using the Table Editing Area . . . . 42
Edit, Copy and Paste . . . . 45
Find and Replace . . . . 46
The Management Console Interface
To start Management Console:
1. Click Start > Programs > Schneider Electric > ION Enterprise Tools >
Management Console (or double‐click the ION Enterprise icon on your desktop to open the ION Enterprise Taskpad, then click on the Management Console link).
2. Type your user name and password in the Logon dialog. The default user name is “guest” with a password of “0” (zero).
Window title
The window title displays the type of System Setup item currently selected, the current user’s name and user security access level, and the name of the software program:
System Setup pane
The icons in the System Setup pane represent categories of items you can add, remove, and set up. You can change the icon size by right‐clicking inside the System Setup pane and selecting one of the options.
Display window
The Display window consists of two tabs, “Properties” and “Events”. When you first select a System Setup icon, the Display window shows the “Properties” tab by default.
Window title
Display window.
This area displays the contents of the selected system setup icon.
System Setup pane and icons
Properties tab &
Events tab
Mouse hover text Table title
Selected System
Setup item User name Access level Program name
Sorting items in the Display window
Click a column heading to sort the items in that column in ascending order; click it again to sort the items in descending order.
Properties tab
All configuration is performed through the Properties tab. The Properties tab lists configuration properties of each system item in a row. The selected System Setup item determines what column headings (Properties) are displayed.
Events tab
The Events tab lists system events for the items contained in the Properties tab. For events with long descriptions, you can resize the column width. You can also double‐click that row to display the details of that event inside a dialog box, for easier reading. You can also copy the description by selecting it in the dialog box, then pressing CTRL+C.
Priority
Priority is a number or numeric range that classifies what type of event has occurred. The system log database lists these event priorities as numbers in the event table. The value corresponds to the severity of the event: the higher the number, the more severe the event is. When events are viewed in Management Console, the priority number is evaluated and displayed as a priority string.
Priority is mapped according to the following numeric ranges:
By default, the Cutoff setup register of Log Inserter’s System Log Controller module is set to 192. This means that system events with a priority less than 192 are not transferred to the ION database and therefore cannot be viewed in Vista using the Global Event Viewer. Use the above priority mapping as a guide to set the Cutoff setup register to a lower value if you want to view lower priority events in Vista.
NOTE
The Global Event Viewer includes records retrieved from meter and Virtual Processor event logs, as well as records transferred from the system log database.
Shortcut Menu Summary
Shortcut menus are accessed by right‐clicking certain areas in the Management Console. Different areas open different shortcut menus. The following areas of the Management Console provide access to shortcut menus:
Diagnostic 0-5 Warning 21-63 Critical 192-255
Information 6-20 Error 64-191
System Setup pane
Right‐click the System Setup pane to access shortcut menus for adjusting the size of the icons in this pane.
Table title
To use the table title shortcut menus, right‐click the table title to access these shortcut menus:
Refresh manually updates the Management Console (i.e. reloads its contents).
View Field allows you to select an item and display the value of a particular field in a dialog box. This is useful for viewing text that is too long to fit within the column’s width. The View Field options change, depending on which tab you have selected — Properties tab or Events tab.
Properties opens the property sheet (Options dialog box) for the Display Window, where you can change the settings of the Column Properties or Row Properties.
Column Properties tab: You can control which columns (fields) are shown in the display window. Select the check box beside the field to display that column, or clear it to hide that column. You can also control which items (rows) are displayed by using text filtering on a particular column. Click the name of the column (field) to select it, then click the Set Filter button. In the Filter Setup dialog box, type the text you want to search for in the Filter Text box, then select whether you want the search to match the text Exactly, or Combined with other text. Click OK to apply the filter. Text filtering is useful in situations where there are too many rows shown in the display window. Click Clear Filter to turn off the filtering.
Row Properties tab: This lets you control the appearance of the rows in the Event tab. You can enable or disable row highlighting, and specify which highlight color to use. Row highlighting applies the color you specify to every other row, to distinguish them better. You can also set how many recent event records to retrieve, and specify whether or not to convert the timestamps to local date and time.
Display Window
To access shortcut menus in the Display Window, first select the System Setup item by clicking its icon. Then, right‐click in the display window area to display the shortcut menu.
New displays the options available for adding new network items. Connect and Disconnect lets you manually connect or disconnect the selected site. Similarly, Connect Ethernet and Disconnect Ethernet manually connects or disconnects the selected Ethernet device. Note that you cannot connect or disconnect an
individual serial device in a site; you can only connect or disconnect the site for that serial device.
Security... accesses the Advanced Meter Security Settings dialog box. This is used by the software to gain access to security‐enabled devices (e.g. ION8600 or ION7650); it is only available from the shortcut menu for the Devices Display Window. Selecting Properties... opens the property sheet (options) for the selected server, site, or device. Mandatory properties are highlighted in red — you must select or enter the appropriate value for these.
Devices Servers
Sites
Duplicate creates one or more copies of a selected item.
NOTE
For the Duplicate command, each one of the duplicates needs to be opened individually in order to configure them. Duplicate and Configure cuts setup time by creating and setting up multiple devices at the same time.
Delete removes the selected items.
Duplicate and Configure... lets you perform batch cloning of devices — a real time‐saver when commissioning large systems. When multiple devices are selected, this right‐click shortcut becomes “Configure Selected Devices...” which lets you perform useful setup functions such as batch renaming of devices.
Component Property Sheet Shortcut Menus
This shortcut menu is accessed from a property sheet (Options dialog box) for a server, site, device, or dialout modem. Selecting Property Details... opens a window containing information on the selected property, including minimum and maximum allowable values, if applicable. Advanced Properties exposes all the remaining property fields that were hidden in the default (basic) view. Reset All To Default resets all properties to their original values.
Select a property to display its description in the “Property Description” field, as shown here.
Management Console Network Components
This section describes the different network items in Management Console.
Servers
A server is a computer in an ION Enterprise system running administrative software that controls access to the network and its resources, such as ION devices.
A server provides resources to other computers (workstations) on the network.
The server runs service components for tasks such as creating communication and software links between ION system components, and creating links into ION databases.
Sites
A site is a group of devices in the ION Enterprise system that share a common communications link. A site can be a direct site, a modem site, Ethernet gateway site, or OPC site.
Direct Site
In a direct site, serial communications occur between a computer and one or more meters. To set up a direct site, you must specify a serial communications port on the computer. The standards most commonly used on computers are RS‐232 (for connecting one device) and RS‐485 (for connecting a loop of up to 32 devices).
When connecting to more than one serial device, use an RS‐232 to RS‐485 converter.
Modem Site
In a modem site, communications occur between a remote modem (at the Modem Site) and a local modem (on the Primary Server).
NOTE
Remote sites that use radio modems or leased-line modems are configured as Direct (Serial) Sites, not as Modem Sites.
Modem sites can include traditional hardware modems (those that are configured and controlled by ION Enterprise), or WinModems (Windows modems). If multiple modems are set up in the modem site, ION Enterprise chooses the first available modem to establish communications (this is referred to as “modem pooling”).
Ethernet Gateway Site
Ethernet gateway sites consist of an RS‐485 chain of devices that communicates with an Ethernet network via an Ethernet Device that converts RS‐232/RS‐485 communications to and from Ethernet. The Ethernet Device then has a direct connection to the network of serial devices through one of its serial
communications ports. The Ethernet device acts as a gateway that transfers data between an Ethernet network and an RS‐485 chain of connected devices. For Ethernet gateway sites, the TCP/IP Address field and TCP/IP Port field must be filled in. The TCP/IP Port can identify which communications port is used for
connecting to the serial devices (depending on the type of Ethernet gateway device that is used).
OPC Site
An OPC Site consists of an OPC Server that communicates with OPC‐compliant devices in the network.
Devices
A Device is an ION meter, or other component that communicates and gathers data, that is installed on a network.
Serial Devices belong to Direct Sites, Modem Sites, or EtherGate Sites — they communicate through a modem, RS‐232, RS‐485, or Ethernet‐to‐Serial gateway connection. You must have the appropriate sites configured first before you can add serial devices.
Ethernet Devices are those that are directly connected to the Ethernet network.
You can manually connect or disconnect your Ethernet device through the Management Console.
Dial-Out Modems
A dial‐out modem is one that a server computer uses to communicate with a remote modem at a Modem Site. The modem implemented could be a traditional hardware‐based modem or the newer (and usually cheaper) software‐based modem that uses the computer’s processor to emulate the traditional hardware‐
based modem.
NOTE
A WinModem is a modem that is directly controlled by the computer’s operating system.
When a modem site needs to establish communications, it selects a modem from the list of modems configured in the modem site. You can add hardware modems or WinModems to the modem list.
Connection Schedules
Connection schedules are programmed routines for a server to regularly connect to and disconnect from Modem Sites and their associated ION device. You can also create connection schedules for Direct Sites and Ethernet Devices or Ethernet Gateway Sites.
Detailed Operation
The Primary Server contains all the ION Enterprise programs and controls the overall operation of your energy management system. The primary server is displayed when you first start Management Console.
To start building your system, add and set up your sites and devices.
Adding a Network Component
Follow the procedure below to add a new network component:
1. Select the System Setup item that you want to add by clicking its icon (i.e., Server, Site, Device, Dial Out Modem, or Connection Schedule).
2. Right‐click in the display window, select New, and then select the specific type of network component from the shortcut menu. The options differ depending on which system setup item you have selected.
3. Configure the properties using the drop‐down menus; mandatory items are highlighted in red — they must be filled in.
If you want to configure advanced properties, right‐click in the dialog box and select Advanced Properties.
4. Click OK when you are done.
Adding a Server
Click the Servers icon, right‐click in the display window and select New > Computer, then fill in all the mandatory fields.
Right-click a field and select “Property Details”
for more information on a particular property.
Right-click and select
“Advanced Properties”
to display all properties.
This area displays the description of the selected property.
Setting Up Devices for Direct Serial Communications
To set up devices for RS‐232 or RS‐485 communications on a direct serial loop, first you need to set up a direct site. Serial devices you can add to a direct site include those that communicate using ION or Modbus RTU protocol.
Adding a Direct Site
Click the Sites icon. Right‐click in the display window and select New > Direct Site. Fill in the Name and Serial Port fields, and configure the other fields as required.
Adding a Device to the Direct Site
Click the Devices icon. Right‐click in the display window and select New > Serial Device on Direct Site. Fill in these fields:
Group (select one or set up a new one by selecting “[Add New Group]”) Name
Device Type (for serial Modbus devices, select the one with “ModRTU” in brackets)
Unit ID (range is 1‐9999 for ION devices, or 1‐247 for Modbus RTU devices) Site (select the Direct Site you previously set up)
Configure the other fields as required.
Setting Up Devices for Ethernet Gateway Communications
To set up devices for Ethernet gateway communications, first you need to set up an Ethernet gateway site. Ethernet gateways that can be used include those that are simple Ethernet‐to‐Serial converters, or any gateway or data concentrator that provides ModbusTCP communications.
Adding an Ethernet Gateway Site
Click the Sites icon. Right‐click in the display window and select New > Ethernet Gateway Site. Fill in the Name, TCP/IP Address and TCP/IP Port fields, and configure the other fields as required.
Adding a Device to the Ethernet Gateway Site
Click the Devices icon. Right‐click in the display window and select New > Serial Device on Ethernet Gateway Site. Fill in these fields:
Group (select one or set up a new one by selecting “[Add New Group]”) Name
Device Type (for ModbusTCP gateways, select a device type with ʺModTCPʺ in brackets)
Unit ID (range is 1‐9999 for ION devices, or 1‐247 for Modbus TCP devices) Site (select the Ethernet Gateway site you previously set up)
Configure the other fields as required.
Adding an Ethernet Device
Click the Devices icon. Right‐click in the display window and select New > Ethernet Device. Fill in the Group, Name, Device Type and TCP/IP Address fields, and configure the other fields as required.
NOTE
When configuring Ethernet or Ethernet Gateway devices, you can specify either a hostname or an IP address in the TCP/IP Address field.
Setting Up Devices for OPC Communications
NOTE
At least one OPC Device Type needs to be preconfigured before an OPC Device can be created in Management Console. Contact Technical Support for assistance.
To set up devices for OPC communications, first you need to set up an OPC site.
Adding an OPC Site
Click the Sites icon. Right‐click in the display window and select New > OPC Site.
Fill in the Name and Address fields, and configure the other fields as required.
Make sure you follow the correct syntax when filling in the address for the OPC site. Select the Address field to see an example adress in the Property Description area (near the bottom of the OPC Site Options dialog).
Adding a Device to the OPC Site
Click the Devices icon. Right‐click in the display window and select New > OPC Device. Fill in the Group, Name, Device Type and Site (select the OPC site you previously set up), and configure the other fields as required.
Adding a Modem
1. Click the Dial Out Modems icon, right‐click in the display window and select New, then select either Serial Modem... (hardware modem), or WinModem...
(Windows modem).
2. Fill in the values for all required fields in the properties dialog box:
For serial modem, select the Modem Type from the list. If your modem is not in this list, select “Generic ION Modem ‐ Other”. Select the Serial Port where your modem is connected.
For WinModems, select the Modem Name from the list.
3. Click OK.
WinModem Installation Notes
Before you can use a WinModem, you must first install it on your computer (follow the instructions that came with the WinModem product). After rebooting the computer, set up the WinModem:
1. Click Start > Settings > Control Panel, then double‐click Phone and Modem Options.
2. Click the Modems tab, select your WinModem, then click Properties.
3. Click the Advanced tab, then click Change Default Preference.
4. Set Port speed to match the baud rate that is used between the meter and the modem on the remote end of the connection (i.e. both modems must be set to the same baud rate).
5. Set Flow Control to “None”.
6. Click OK to apply the changes.
NOTE
You may need to reboot your machine for the settings to take effect.
Editing a Network Component
1. Click the appropriate System Setup icon.
2. In the display window, right‐click the network component you want to edit and select Properties.
3. Make the required changes. To display all configurable fields, right‐click in the properties dialog box and select Advanced Properties.
Deleting a Network Component
1. Click the appropriate System Setup icon.
2. In the display window, right‐click the network component you want to delete and select Delete (or select the item and press the Delete key).
3. Click Yes to confirm the deletion.
CAUTION
When deleting a Site or a Server, all devices associated with it are also deleted.
Accessing Meters with Advanced Security
If you have a meter in your network with Advanced Security, use Management Console to configure the security settings so that ION Real Time Data Service can access the meter:
1. Right‐click the device that has Advanced Security enabled and select Security....
1. Set up the appropriate access level.
2. Click OK.
Configuring the Network through SQL Statements
You can use Management Console to manually configure the network components by executing SQL statements.
CAUTION
Altering the network configuration using SQL satements is for advanced users only.
1. While holding down the CTRL key, right‐click the table title (shaded area above the display window) and select Custom SQL. A warning displays (this warning appears only once per session):
2. Click OK to continue.
3. Type your SQL statement in the Custom SQL box.
4. Click Execute.
The results of the SQL statement execution appear in the display window.
Configuring Connection Schedules
You can schedule the times when the server connects to a Site.
1. Click the Connection Schedules icon, right‐click in the display window, then select New.
2. Enter the name of your connection schedule (for example “Daily Reading).
3. Select the Sites tab, then click Change Selection...
4. In the Available Sites area, click the sites or individual devices you want to include in the schedule, then click the right‐arrow button near the Include Sites area to move the selected site there. You can also set sites or devices you want to exclude by moving them to the Exclude Sites area. Click OK.
5. Make your changes in the Site Connection Settings section, then click the Schedule tab.
6. Set your schedule for the site connection, then click OK. If you configure a full‐
day (i.e. 24‐hour) daily schedule, make sure you allow enough time between the end time and the start of the next connection to avoid connection problems. For example, to add a 2‐minute gap to a 24‐hour schedule, set the Start Time to 0:00:00 and the EndTime to 23:58:00.
Setting Up Large Systems
A power monitoring network that contains many devices of the same type (such as a particular brand and model number of a branch circuit monitor) typically uses a logical naming scheme for the devices. For example, you can use a scheme like
“FL1_PNL1A.CCT01” to name a device that is installed on the “1st Floor” of the building, “electrical panel 1A”, and “Circuit breaker #1”.
To perform batch network setup of devices, create the first device in Management Console (refer to the previous section, “Adding a Network Component” on page 27). After creating this first device, you can then use it to create multiple duplicates and configure their properities.
NOTE
Only users with Supervisor or Operator privileges can create and configure devices.
Creating Multiple Copies of an Ethernet Device
1. Select the Devices icon on the System Setup pane in Management Console.
2. Right‐click in the display window and select New > Ethernet Device, then configure the first Ethernet device using your logical naming scheme. For example, click the “Group” dropdown box and select [Add New Group], then enter the group name (e.g. “FL1_PNL1A”) in the Add Group box. Type the device Name (e.g. “CCT01”), select the Device Type, type the IP address, then click OK.
3. Right‐click the Ethernet device you want to duplicate and select Duplicate and Configure.
Scroll left Scroll right
Table Editing area
Duplicate and Configure area
Hide/Show Columns area Start & End spin box
The Duplicate and Configure area contains these sections:
Configure Names: Use this section to create the duplicates.
Configure TCP/IP Addresses: Use this section to create a sequence of IP addresses to assign to the duplicates after they have been created.
Configure TCP/IP Port: The port number used in the original device is automatically assigned to all the duplicates. If required, you can use this section to select a different port number for all the displayed devices in the Table Editing area (note that changes made here are applied to all devices, including the original).
Configure Unit ID: This section is disabled by default, since unit IDs do not apply to typical Ethernet devices. (To enable this section, you must first set up the Table Editing area so that the “Unit ID” column is showing).
4. In the Configure Names area, the device name is displayed such that each letter and number is selectable. A group of numbers is treated as a single entity. For example, the name “MY8600” is displayed so the entities you can select are “M”,
“Y” and “8600”. Leading zeroes are also supported, so you can set sequences such as “01, 02, 03” or “001, 002, 003”.
5. Select a letter or number in the device name. This action fills in the Start box with that value, so you can start setting a sequential range.
For example, if you select the first “1” from the example naming scheme and set the End spin box to “2”, two names will be generated (the original, plus one duplicate). If you select a letter and set its Start value to “A” and the End value to “C”, three names will be generated (the original, plus two duplicates).
The total number of generated names is the product of the first range multiplied by the next, and so on until the last range, as indicated in the graphic below.
The Start box displays the selected number/letter, which is the start value. Use the up or down arrow in the spin box to change the start value, or simply type it in the box.
6. Click the up arrow on the End box to increase the range, or type the end value in the box. To clear the range and start over, click Remove Parameters.
7. To set exceptions for individual values or a range of values, refer to the section,
“Setting Exceptions to Generated Sequences” on page 37. Exceptions reduce the number of names created (i.e. total generated names minus the exceptions).
8. When you are finished setting the exceptions, click OK to apply your changes and close the dialog box.
The total generated names is the product:
[2 x 3 x 10] = 60
9. Click Duplicate. The duplicated devices appear in the Table Editing area.
10. Scroll to the right in the Duplicate and Configure area and repeat the procedure to set the IP addresses for the duplicated devices.
11. Click Configure to set the values for the devices.
Asterisks indicate pending changes that have not yet been saved.
Original device
Text color is red if the number of items does not match the number of items in the Table Editing area. If the numbers match, the text color is black.
Duplicated devices are always disabled when they are added to Management Console
NOTE
To discard your changes up until the last saved state, click Revert. You can also press CTRL+Z to undo the last action. To redo, the last action, press SHIFT+CTRL+Z. You can only undo your last action (one undo).
12. Click Apply to save your changes and leave the window open to continue working, or click OK save your changes and return to Management Console, or click Cancel to discard your changes. A dialog prompts you if there are pending (unsaved) changes when you click Cancel. Click Yes to discard the changes and return to Management Console, or No to return to the configuration window and continue editing.
NOTE
If inappropriate values (such as a device that is renamed with the same name as another existing device) are encountered, a message displays with error details. You cannot save the configuration changes until you have corrected the errors.
Setting Exceptions to Generated Sequences
The Exceptions option applies to the Configure Names and Configure IP addresses sections only.
1. To set exceptions to the range of generated values, click Edit.
Click this to edit exceptions
2. Use the Add number (or Add character) spin box to set a value to exclude from the range you have specified, then click Add. Repeat to set additional values to exclude. To set a range of values to exclude, select Add number range (or Add character range), then use the Start and End spin boxes to set the range to exclude. Click Add. Repeat to set additional ranges of values to exclude.
NOTE
You cannot add the same number or letter to the list of exceptions more than once. If the Add button is disabled, check that the numbers or letters are not already included in the exceptions list near the top of the window.
3. Use the Remove number (or Remove character) spin box to remove the exception that was set for a given value (i.e. put it back in as an acceptable value).
Use the Remove number range (or Remove character range) spin boxes to remove the exception that was set for a range of values.
Creating Multiple Copies of a Serial Device
1. Create and configure a Direct Site or Ethernet Gateway Site in Management Console.
2. Select the Devices icon on the System Setup pane in Management Console.
3. Right‐click in the display window and select New > Serial Device on Direct Site or New > Serial Device on Ethernet Gateway Site (as appropriate), then configure the first serial device using your logical naming scheme. For example, click the “Group” dropdown box and select [Add New Group], then enter the group name (e.g. “DS1_FL1”) in the Add Group box. Type the device Name (e.g. “P6200_01”), select the Device Type, type the Unit ID, select the Site, then click OK.
4. Right‐click the new serial device and select Duplicate and Configure.
The Duplicate and Configure area contains these sections:
Configure Names: Use this section to create the duplicates.
Configure Unit IDs: Use this section to create a sequence of unit IDs to assign to the duplicates after they have been created.
Configure Serial Sites: The serial site used in the original device is automatically assigned to all the duplicates. If required, you can use this section to select a different serial site for all the displayed devices in the Table Editing area (note that changes made here are applied to all devices, including the original).
5. Use the Configure Names section to duplicate the serial device. Follow the procedure as described in the previous section, “Creating Multiple Copies of an Ethernet Device” on page 34.
6. On the Configure Unit IDs section, set the Unit IDs of the serial devices using the previous procedure.
7. Click Apply or OK.
Creating Multiple Copies of an OPC Device
1. Create and configure an OPC Site in Management Console.
2. Select the Devices icon on the System Setup pane in Management Console.
3. Right‐click in the display window and select New > OPC Device, then configure the first OPC device using your logical naming scheme. Mandatory fields are:
Group, Name, Device Type, and Site.
4. Right‐click the new OPC device and select Duplicate and Configure.
The Duplicate and Configure area contains these sections:
Configure Names: Use this section to create the duplicates.
Configure Address: Use this section to create a sequence of addresses to assign to the duplicates after they have been created.
Configure OPC Sites: The OPC site used in the original device is
automatically assigned to all the duplicates. If required, you can use this section to select a different OPC site for all the displayed devices in the Table Editing area (note that changes made here are applied to all devices, including the original).
5. Use the Configure Names section to duplicate the OPC device. Follow the procedure as described in the previous section, “Creating Multiple Copies of an Ethernet Device” on page 34.
6. On the Configure Address section, set the addresses of the OPC devices using the previous procedure.
7. Click Apply or OK.
Selecting Multiple Devices to Configure
After you have duplicated the devices, you can select and configure any or all of them.
1. Select the Devices icon on the System Setup pane in Management Console.
2. Select the devices you want to configure. To select a contiguous range, click the first device, hold down the SHIFT key, then click the last device. To select a non‐
contiguous range, hold down the CTRL key while clicking each device.
3. Right‐click and select Configure Selected Devices. This option is only available if multiple devices are selected.
4. Use the different sections in the window to make your configuration changes.
For example: With serial devices, you can use the Start and End spin boxes in the Configure Unit IDs section to configure the range of unit IDs. Click Configure to apply the changes to the displayed devices in the Table Editing area (changes are applied from top to bottom).
TIP
Configuration changes only affect the devices that are currently displayed in the Table Editing area. Use the column sorting and filtering features, described in the next section, to control which devices are displayed in the table.
5. Repeat the previous configuration step for the other properties you want to change. For instance, if you want to assign a different site for the devices, select the site in the Configure Serial Site section. Click Configure to apply the changes to all displayed devices in the Table Editing area.
NOTE
Devices affected by a configuration change (that has not been saved) are identified by an asterisk in the first column of the Table Editing area.
6. Click Apply to save your changes. If you changed the name of one or more devices, a warning displays with a list of devices that will be renamed. If data for those devices already exist in the ION database and you still proceed with the renaming, then the existing data associated with the old device name will be lost (“orphaned”). Click Continue to proceed, or Cancel to go back and edit the device configuration.
7. When you have finished making your changes, click OK to save them and return to Management Console.
Using the Table Editing Area
You can customize the way data is displayed in the Table Editing area. When making configuration changes, these changes are applied only to the rows that are visible in the Table Editing area.
Column Sorting and Filtering
Click a column to sort the information in the table in ascending or descending order (indicated by an up or down arrow, respectively). To cancel sorting and return the column to its default state, right‐click the column and select Clear Sorting.
When the mouse is positioned over a column, the Filter icon appears on the top
Sort Filter