PowerLogic ION Enterprise 5.

6
Power Management Software
User Guide
April 2007

Notices
Thissectiondescribesthesymbolsusedinthisguide.
Danger
Thisalertsyoutothingsthatmaycauseseriousinjurytoaperson.
Onlyqualified,properlytrainedpersonnelshouldperformthese
procedures.
Caution
Thisalertsyoutothingsthatmaycauselossofdata,damagetoyour
computeroryourdevice
Note
Anoteprovidesyouwithadditionalinformationthatyoumightwant
toconsider.
Tip
Thisdrawsyourattentiontoinformationthatwillhelpyouperform
ataskmorequicklyoreasily.

PowerLogic,ION,IONEnterprise,MeterM@ilandModbusareeithertrademarks
orregisteredtrademarksofSchneiderElectric.

Documentation Conventions
Thissectiondescribesthetermsusedtodescribecommonmethodsorprocedures
usedthroughoutthisguide.
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.

Contents
Chapter 1

Introduction ................................................................ 13
ION Enterprise Software Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
CoreApplications .................................................... 14
Administration ....................................................... 14
Programming........................................................ 15
ION Enterprise Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
ION Enterprise Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
StartingIONEnterprise ............................................... 18
LoggingintoIONEnterprise........................................... 18

Chapter 2

Management Console ................................................. 19

The Management Console Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
ShortcutMenuSummary.............................................. 21
Management Console Network Components . . . . . . . . . . . . . . . . . . . . . . . 25
Detailed Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
AddingaNetworkComponent......................................... 27
EditingaNetworkComponent......................................... 30
DeletingaNetworkComponent ........................................ 30
AccessingMeterswithAdvancedSecurity............................... 30
ConfiguringtheNetworkthroughSQLStatements........................ 31
ConfiguringConnectionSchedules...................................... 32
Setting Up Large Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
CreatingMultipleCopiesofanEthernetDevice........................... 34
CreatingMultipleCopiesofaSerialDevice .............................. 38
CreatingMultipleCopiesofanOPCDevice .............................. 39
SelectingMultipleDevicestoConfigure ................................. 40
UsingtheTableEditingArea ........................................... 42
Edit,CopyandPaste .................................................. 45
FindandReplace..................................................... 46

Chapter 3

Management Console Tools ......................................... 49

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
User Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
StartingUserManager ................................................ 51

License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Diagnostic Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
StartingDiagnosticViewer............................................. 54
NavigationPanel..................................................... 54
DiagnosticsInformationPanel.......................................... 55
UsingtheFilterEditor ................................................. 57
ServerDiagnostics .................................................... 57
CommunicationsDiagnostics .......................................... 59
AdditionalCommands................................................ 60
CommunicationStatusvs.SiteStatus.................................... 62
Device Upgrader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
UsingDeviceUpgrader................................................ 63
FirmwareUpgradeErrorCodes ........................................ 65
Remote Modem Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
UsingRemoteModemSetup ........................................... 66
Virtual Processor Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
ConfiguringtheVirtualProcessorsModbusService....................... 68
ModifyingtheGlobalParameters ....................................... 73

Chapter 4

Vista .......................................................................... 75
Starting Vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
EndingYourVistaSession............................................. 76
The Vista Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Vista User Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
WhatisaUserDiagram? .............................................. 78
DefaultUserDiagrams................................................ 79
Generating, Opening and Closing a User Diagram . . . . . . . . . . . . . . . . . . 80
GeneratingaNetworkDiagram ........................................ 80
OpeningaUserDiagram .............................................. 80
SpecifyingaVistaDiagramtoOpenforaGivenUser...................... 80
ClosingaUserDiagram ............................................... 81
Navigating a User Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
DisplayModeandEditMode .......................................... 82
GroupingWindows ................................................... 82
DisplayFeatures...................................................... 83
Monitoring Your System in Vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ViewingRealTimeData............................................... 84
ViewingLoggedData................................................. 87

Controlling System Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Plotting Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
The Log View Plotter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
ViewingthePlotDisplayTab .......................................... 96
ViewingtheHarmonicsAnalysisTab .................................. 100
ViewingthePhasorDiagramTab ...................................... 102
Adding Parameters to a Log View Plotter . . . . . . . . . . . . . . . . . . . . . . . . . 105
AddingDatafromaDataLogViewer.................................. 105
AddingEventsfromanEventLogViewer .............................. 105
AddingDatafromaSpreadsheetorTextFile ............................ 106
Customizing the Log View Plotter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
CustomizinganAxis ................................................. 108
CustomizingCurveStyle ............................................. 110
CustomizingGraphandLegendOptions ............................... 112
RemovingGraphParameters.......................................... 113
Overlaying Curves (CBEMA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Creating and Editing a User Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
OpeningaUserDiagram ............................................. 116
Creatinganewuserdiagram .......................................... 116
SavingaUserDiagram ............................................... 116
Placing Diagram Objects into a User Diagram . . . . . . . . . . . . . . . . . . . . . 118
TheEnableUndoOption ............................................. 118
TypesofDiagramObjects............................................. 118
AddingaDiagramObjecttoaUserDiagram ............................ 119
MovingaDiagramObject............................................. 120
ResizingaDiagramObject ............................................ 121
ArrangingObjectLayout:Alignment,Grid,andSize..................... 121
Cutting,Copying,andPastingaDiagramObject......................... 123
CopyingaGroupofDiagramObjectstoaFramework .................... 124
Linking a Diagram Object to a Data Source . . . . . . . . . . . . . . . . . . . . . . . 125
LinkingaNumeric,StatusorControlObject ............................ 125
ConfiguringaDataLogViewerorEventLogViewer ..................... 126
Adding a Global Event Log Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Querying the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
UsingtheQueryOptions............................................. 130
UsingtheQueryWizard .............................................. 132
Custom User Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Customizing a Diagram Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
CaptionOptions ..................................................... 141
TextOptions........................................................ 141
EditTextOptions .................................................... 142
LinkOptions ........................................................ 143

QueryServerOptions................................................ 144
DisplayOptions ..................................................... 145
ActionOptions ...................................................... 153
BoxOptions......................................................... 155
AnnunciationOptions................................................ 156
AlarmingOptions ................................................... 157

Customizing a Diagram Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

DefaultFont ........................................................ 159
BackgroundColor................................................... 159
ConfiguringWindowProperties ....................................... 160

Chapter 5

WebReach ................................................................ 167

WebReach Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
WebReachInstallationAfterIONEnterpriseisInstalled .................. 168
PreliminarySetup ................................................... 169
DisplayingVistaDiagramsOnline..................................... 169
ViewingHistorical(Trend)Data ....................................... 170
ViewingMeterEvents ................................................ 172
AddingaGlobalEventViewer ........................................ 173
StaleDataorErrorIndicators.......................................... 174
Advanced WebReach Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
CustomNetworkDiagramSetup...................................... 174
WebReachRegistrySettings........................................... 175
AdditionalInformation............................................... 176
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Chapter 6

Reporter ................................................................... 179

Reporter Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Starting Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Creating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
WizardStep1:SelectTemplate ....................................... 181
WizardStep2:SelectDatabaseandSources ............................ 181
WizardStep3:SetUptheReportOptions.............................. 183
PreviewingtheReport................................................ 185
Generating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Types of Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
EnergyandDemand................................................. 186
LoadProfile......................................................... 187
PowerQuality....................................................... 187
EN50160............................................................ 189
IEC61000430 ...................................................... 190
Waveforms ......................................................... 191
ModifyingtheFinishedReport........................................ 192

UpgradeConsiderations .............................................. 192

CustomTemplates ................................................... 192

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
StartingDesigner.................................................... 196
TheDesignerInterface ............................................... 197
DisplayModeandEditMode ......................................... 198
DesignerShortcuts................................................... 198
QuittingDesigner.................................................... 199
The Node Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
UsingaNodeDiagram ............................................... 200
Icons ............................................................... 202
GroupingWindows .................................................. 206
Windows ........................................................... 208
Working with ION Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
UsingIONModules.................................................. 210
LinkingandConfiguringIONModules................................. 220
DeletingLinks ...................................................... 225
ConfiguringIONModules ............................................ 228
CopyingandPastingIONModules.................................... 235
ViewingOutputRegisters,SetupRegisters,andInputs................... 244
Time of Use (TOU) Program Management . . . . . . . . . . . . . . . . . . . . . . . . 246
AdvancedTOUScheduleConfiguration ................................ 247
Virtual Processor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
UsingtheVirtualProcessor........................................... 249
DistributedControl.................................................. 250
ModbusCommunications ............................................ 253
CommonVirtualProcessorApplications................................ 255
SettingGlobalParameters ............................................ 257

Chapter 8

Modbus Device Importer ........................................... 259

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
ION Object Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Managers ........................................................... 262
Modules............................................................ 262
Registers ........................................................... 262

Main Console Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Main Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
FileMenu........................................................... 264
EditMenu.......................................................... 264
ViewMenu......................................................... 267
ToolsMenu ......................................................... 268
SettingsMenu ....................................................... 271
HelpMenu ......................................................... 272
ConfigureLoggingandCalculationButton.............................. 272
Editing a Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
RegisterPropertiesDefined........................................... 273
Key Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
GeneralKeyShortcuts................................................ 278
RegisterQuickEditMode............................................. 278
TreeviewPane ...................................................... 279
ModbusRegisterListViewPane....................................... 280
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
DataFormats........................................................ 281
Configuring Logging and Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
ScreenOverview .................................................... 283
ConfiguringRegisterLogging ......................................... 284
ConfiguringLow,HighandMeanCalculationandLogging ............... 285
ConfiguringStaleDataSettings........................................ 285
ConfiguringDownstreamDeviceFunctionality .......................... 286
SavingandExiting ................................................... 287

Chapter 9

Database Management ............................................. 289

Microsoft SQL Server Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
TheNetworkConfigurationDatabase.................................. 290
TheSystemEventsDatabase.......................................... 290
TheIONDatabase................................................... 291
Database Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
ManualTasks....................................................... 295
ScheduledTasks ..................................................... 303
DetachingthenReattachingDatabases ................................. 307
AttachingaDatabaseUsingDatabaseManager .......................... 307
RestoringanIONDatabasefromaBackup .............................. 308
AccessingtheIONDatabasewith3rdPartyApplications ................. 309
OptimizingDatabaseQueryTime ..................................... 310
Log Inserter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
LogInserterComponents ............................................. 313
ConfiguringtheLogInserter.......................................... 314
OptimizingLogInserter.............................................. 317

Chapter 10

Alert Monitor Service ................................................ 319

Alert Monitor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
SettingUptheAlertMonitorService................................... 321
StartingtheAlertMonitorService...................................... 324

Chapter 11

Downstream Device Assistant .................................... 325

Detecting Downstream Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Downstream Device Assistant Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
StartingtheDownstreamDeviceAssistant.............................. 327
BasicView .......................................................... 327
AdvancedView..................................................... 328
DisplayingPhysicalSources........................................... 329
SortingData ........................................................ 329
Options ............................................................ 329
Downstream Device Assistant Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 332
RenamingtheAssignedSource ........................................ 332
CancellingChanges .................................................. 333
ChangingtheMeasurementMapping.................................. 333
AddingaNewDownstreamDeviceMapping........................... 334
UpdatingtheHistoricalDataataLaterTime............................ 334
ActivityLog ........................................................ 335
Description of Columns and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 335
DownstreamDeviceAssistantColumns ................................ 336
DownstreamDeviceAssistantCommands.............................. 338

Introduction
PowerLogicIONEnterprisesoftwareisacompletepowermanagement
solutionforenergysuppliersandconsumers.Itallowsyoutomanageenergy
informationfrommeteringandcontroldevicesinstalledinyourfacilityorother
remotelocations.IONEnterpriseofferscontrolcapabilitiesandcomprehensive
powerqualityandreliabilityanalysistohelpyoureduceenergyrelatedcosts.
IONEnterpriseiscompatiblewithMicrosoftWindowsServer2003operating
system,andsupportsmultiplecommunicationsstandardsandprotocolsavailable
onIONmetersandsimilarintelligentmeteringdevices.Youcanalsoconnectto
existingpowermonitoringsystemsthroughindustrystandardprotocolssuchas
Modbus,OPC,DNPandXML.
IONEnterpriseusesMicrosoftSQLServer2005forefficientandsecuredata
management.YoucaninstalltheSQLServer2005ExpressEditionthatcomeswith
IONEnterprise(4GBmaximumdatabasesize),orforlargerdatabaseneedsyou
canuseanexistingSQLServer2005instance(Standardeditionorbetter)tohost
theIONEnterprisedatabase.

In This Chapter
ION Enterprise Software Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
CoreApplications .................................................... 14
Administration ....................................................... 14
Programming........................................................ 15
ION Enterprise Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
ION Enterprise Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
StartingIONEnterprise ............................................... 18
LoggingintoIONEnterprise........................................... 18

2007 Schneider Electric. All rights reserved.

Page 13

Chapter 1 - Introduction

ION Enterprise 5.6 User Guide

ION Enterprise Software Components

ThissectionoutlinestheIONEnterprisesoftwarecomponents,andhowtheyare
usedtobuild,monitor,maintainandcustomizeyourIONEnterprisesystem.

Core Applications
TheseIONEnterpriseprogramsaremostcommonlyusedindaytodaypower
managementtasks:

Vista
Vistaisthemainuserinterfacefordisplayinggraphicalrepresentationsofyour
powermonitoringsystemonacomputermonitor.Vistadisplaysrealtimeand
historicalinformation,visualobjectsthatindicatethecurrentstatusofyour
system,andinteractiveobjectsthatyoucanusetoperformcertainactionssuchas
acknowledgingalarms.

WebReach
WebReachistheIONEnterprisecomponentthatdisplaysVistadiagramsina
webbrowser.

Reporter
Reporteristhetoolyouusetocreateandgeneratecommonenergy,demandor
powerqualityreports.

Administration
TheseIONEnterpriseprogramshelpyousetupandmaintainyourpower
managementsystem:

Management Console
UseManagementConsoletoaddandconfigurenetworkcomponentssuchas
servers,sites(communicationlinks)anddevices.ManagementConsolealso
providesaccesstosystemanddatabaseapplications,andutilitiesformanaging
useraccountsandupgradingthesoftwarelicensing.Thesearedescribedinthe
followingtopics:
DatabaseManagementonpage 289
UserManageronpage 51
LicenseManageronpage 53
Designeronpage 195
DiagnosticVieweronpage 54

Page 14

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 1 - Introduction

DeviceUpgraderonpage 63
RemoteModemSetuponpage 66
VirtualProcessorSetuponpage 68
ModbusDeviceImporteronpage 259
ThefollowingcommandsareavailablefromtheManagementConsoleTools
menuwhentheseaddoncomponentsareorderedandactivated:
Update OPC Server
Thiscommandchecksthenetworkfornewsourcesofcommonortypical
measurementstobeexposedtotheOPCServer;thisisonlyavailablewiththe
optionalOPCServerlicense.
PQDIF Exporter
ThiscommandletsyouexportdatatoPowerQualityDataInterchangeFormat
(PQDIF)andsetregularscheduledexportswithnotification;thisisonlyavailable
withtheoptionalPQDIFExporterlicense.

Programming
TheseIONEnterpriseprogramshelpyoucustomizeelementsinyoursystemand
configurethirdpartydevicessothesystemcanrecognizeandutilizethem:

Designer
UseDesignertoperformawiderangeoffunctions,fromconfiguringsetup
registersofdevicesonyournetwork,tocreationofcomplexframeworksusinga
combinationofIONmodulesfromhardwareorsoftwarenodes.

Modbus Device Importer

UseModbusDeviceImportertointegratethirdpartyModbusdevicesintothe
IONEnterprisenetwork.

Large System Setup Using Management Console

RefertoSettingUpLargeSystemsonpage 34tosetuplargesystemsefficiently,
usingtheDuplicateandConfigureshortcutcommandfordevicesin
ManagementConsole.

2007 Schneider Electric. All rights reserved.

Page 15

Chapter 1 - Introduction

ION Enterprise 5.6 User Guide

ION Enterprise Services

ManyofIONEnterprisescorecomponentsrunasWindowsServices.Thisallows
yourserverstocontinuemonitoringyourpowermanagementsystemevenwhen
nousersareloggedon.Intheeventofapoweroutage,yoursystemautomatically
resumespowermonitoringwhenthepowerisrestored.TheIONEnterprise
servicesarestartedandsetforautomaticstartupbydefault,unlessnotedbelow:
IONAlertMonitorServicecontinuouslycheckstheIONEnterprisecomputers
communicationsportsforhighpriorityeventsoccurringatremotemodemsites.
Whenthishappens,AlertMonitorinitiatesacommunicationsconnectiontothe
remotemodemsite.AlertMonitorisregisteredasamanualservice,andisnot
startedbydefault.
IONComponentIdentifierServicemanagescommunicationsbetweenlocal
andremoteIONEnterprisecomponents.
IONConnectionManagementServiceisresponsiblefordeterminingthe
connectionstatusoftheIONEnterprisesystemssitesanddevices,aswellas
handlingresourceallocationsuchasmodems.
ThisservicemanagesthestateofconnectivityfortheIONEnterprisesoftware
system.Inordertoestablishthemostappropriatestateforthesystem,each
connectionanddisconnectionrequestisevaluatedagainsttheoverallstateof
thesystemandavailabilityofcommunicationschannels.Thesystemstatusis
storedintheNetworkConfigurationDatabase.
IONDDEServerisresponsibleforprovidingDynamicDataExchange(DDE)
connectivitybetweenIONdevicesandDDEcompatibleapplications,suchas
Excel.IONDDEServerisregisteredasamanualservice,andisnotstartedby
default.
IONLogInserterServiceprovideshistoricaldatastorageforyourpower
monitoringsystem.RefertoLogInserteronpage 313.
IONNetworkRouterServiceisresponsibleforroutingallinformationbetween
IONsoftwarecomponents,suchasclientworkstationsandtheLogInserter.The
servicedynamicallydetectschangestothenetworkconfiguration,includingthe
additionofnewservers;itisalsocapableofrecognizingnewsoftwarenodes,
suchasVista,thatareaddedtoanexistingserver.Thismechanismisusedfor
automaticsoftwarenoderegistration.

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.

IONOPCDataAccessServermanagesandisresponsibleforsupplyingOPC
datatoclientapplications.IONOPCDataAccessServerisregisteredasa
manualservice,andisnotstartedbydefault.
IONPQDIFExporterServicetranslatesIONdatatoPQDIFfileformatand
managesscheduledPQDIFexports.IONPQDIFExporterServiceisregistered
asamanualservice,andisnotstartedbydefault.

Page 16

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 1 - Introduction

IONQueryServiceprovideshistoricaldataretrievalforyourpower
monitoringsystem.RefertoConfiguringaDataLogViewerorEventLog
Vieweronpage 126formoreinformationregardingthisservice.
IONRealTimeDataServicemanagesandprovidesaccesstorealtimedata
fromthepowermanagementsystem.
IONSiteServicemanagescommunicationlinkstoandfromIONEnterprise.
IONSiteServiceisresponsibleforhandlingpacketcommunicationstosystem
devicesandcontrollingdirectdevicecommunications.Theservicereactsto
changesinnetworkconfiguration:forexample,oftenchangestocertain
channels,gates,ports,ordeviceparameterscaninterruptaconnection).Youcan
add,delete,orchangechannels,gates,ports,anddeviceswithouthavingto
restarttheIONSiteService,IONNetworkRouterService,andIONConnection
ManagementService.
IONVirtualProcessorServiceprovidescoordinateddatacollection,data
processing,andcontrolfunctionsforgroupsofmeters.Formoreinformationon
theVirtualProcessoranditsfunctionality,refertoVirtualProcessorSetupon
page 68.
IONXMLSubscriptionServicemanagessubscriptionstoXMLdataforVista
diagrams.ThisserviceisusedonlybyWebReach.WhenyouopenaVista
diagraminawebbrowser,theIONXMLSubscriptionServicecreatesa
subscriptionanddeliverstherealtimedatainXMLformat.Subscriptionsexpire
automaticallyiftheyarenotrenewed.Abrowserrenewsasubscriptionby
repeatedlyrequestingXMLdata.
IONXMLSubscriptionStoreServicekeepstrackofdatasubscriptionstothe
powermonitoringdevicesonthenetwork.Thisserviceisusedonlyby
WebReach.

ION Enterprise Databases

TheIONEnterprisedatabasesaretypicallyinstalledonthePrimaryServerand
runinthebackgroundofyourIONEnterprisenetworksystem.IONEnterprise
usestheSQLServer2005instanceyousetuptoconnecttothesedatabases:
IONDatabase(ION_Data):Thiscontainsloggeddatafromalldevicesonthe
powermanagementnetwork.
NetworkConfigurationDatabase(ION_Network):Thiscontainsinformation
aboutyournetworktopologythenetworkconnections,computersandevery
connecteddevice,includingdialoutmodems.
SystemEventDatabase(ION_SystemLog):Thiscontainsrecordsofallsystem
events.

2007 Schneider Electric. All rights reserved.

Page 17

Chapter 1 - Introduction

ION Enterprise 5.6 User Guide

Getting Started
MostIONEnterpriseprogramsrequireyoutologinbeforeyoucanusethem.

Starting ION Enterprise

UseoneofthefollowingmethodstostartIONEnterprise:
OpentheIONEnterpriseToolsfolderonyourdesktopanddoubleclickthe
iconoftheprogramyouwanttostart
DoubleclicktheIONEnterpriseicontoopentheIONEnterpriseTaskpad,then
clickononeofthelinks
ClickStart>Programs>SchneiderElectric>IONEnterpriseTools.

Logging in to ION Enterprise

SomeIONEnterpriseprogramsrequireyoutologinbeforeyoucanaccessthem.

For read-only access without

using a password, click View only.

Typeyourusernameandpasswordintheappropriatebox,thenclickOK.Some
actionsarerestrictedtocertainusersorgroups,dependingonhowtheirlogin
permissionsweresetup.SeeUserManageronpage 51fordetails.

Page 18

2007 Schneider Electric. All rights reserved.

Management Console
UseManagementConsoletoadd,removeorconfigurecomponentssuchas
meteringdevicesinyourIONEnterprisepowermanagementsystem.Youcanset
updifferenttypesofsites(communicationlinkssuchasEthernetorserial),andset
upconnectionschedulesforthesesites.
Inaddition,theManagementConsoleToolsmenuprovidesaccesstodeviceand
systemconfiguration,maintenanceandprogrammingtools.Theseinclude
programsformanagingthedatabases,useraccountsandsoftwarelicense
upgrades.SeeManagementConsoleToolsonpage 49fordetails.

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
ShortcutMenuSummary.............................................. 21
Management Console Network Components . . . . . . . . . . . . . . . . . . . . . . . 25
Detailed Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
AddingaNetworkComponent......................................... 27
EditingaNetworkComponent......................................... 30
DeletingaNetworkComponent ........................................ 30
AccessingMeterswithAdvancedSecurity............................... 30
ConfiguringtheNetworkthroughSQLStatements........................ 31
ConfiguringConnectionSchedules...................................... 32
Setting Up Large Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
CreatingMultipleCopiesofanEthernetDevice........................... 34
CreatingMultipleCopiesofaSerialDevice .............................. 38
CreatingMultipleCopiesofanOPCDevice .............................. 39
SelectingMultipleDevicestoConfigure ................................. 40
UsingtheTableEditingArea ........................................... 42
Edit,CopyandPaste .................................................. 45
FindandReplace..................................................... 46

2007 Schneider Electric. All rights reserved.

Page 19

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

The Management Console Interface

TostartManagementConsole:
1.

ClickStart>Programs>SchneiderElectric>IONEnterpriseTools>
ManagementConsole(ordoubleclicktheIONEnterpriseicononyour
desktoptoopentheIONEnterpriseTaskpad,thenclickontheManagement
Consolelink).

2.

TypeyourusernameandpasswordintheLogondialog.Thedefaultusername
isguestwithapasswordof0(zero).
Window title
Table title

System Setup pane

and icons

Display window.
This area displays the contents of
the selected system setup icon.

Mouse hover text

Properties tab &
Events tab

Window title
ThewindowtitledisplaysthetypeofSystemSetupitemcurrentlyselected,the
currentusersnameandusersecurityaccesslevel,andthenameofthesoftware
program:

Selected System
Setup item

User name

Access level

Program name

System Setup pane

TheiconsintheSystemSetuppanerepresentcategoriesofitemsyoucanadd,
remove,andsetup.Youcanchangetheiconsizebyrightclickinginsidethe
SystemSetuppaneandselectingoneoftheoptions.

Display window
TheDisplaywindowconsistsoftwotabs,PropertiesandEvents.Whenyou
firstselectaSystemSetupicon,theDisplaywindowshowsthePropertiestabby
default.

Page 20

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

Sorting items in the Display window

Clickacolumnheadingtosorttheitemsinthatcolumninascendingorder;click
itagaintosorttheitemsindescendingorder.

Properties tab
AllconfigurationisperformedthroughthePropertiestab.ThePropertiestablists
configurationpropertiesofeachsystemiteminarow.TheselectedSystemSetup
itemdetermineswhatcolumnheadings(Properties)aredisplayed.

Events tab
TheEventstablistssystemeventsfortheitemscontainedinthePropertiestab.For
eventswithlongdescriptions,youcanresizethecolumnwidth.Youcanalso
doubleclickthatrowtodisplaythedetailsofthateventinsideadialogbox,for
easierreading.Youcanalsocopythedescriptionbyselectingitinthedialogbox,
thenpressingCTRL+C.
Priority
Priorityisanumberornumericrangethatclassifieswhattypeofeventhas
occurred.Thesystemlogdatabaseliststheseeventprioritiesasnumbersinthe
eventtable.Thevaluecorrespondstotheseverityoftheevent:thehigherthe
number,themoreseveretheeventis.WheneventsareviewedinManagement
Console,theprioritynumberisevaluatedanddisplayedasaprioritystring.
Priorityismappedaccordingtothefollowingnumericranges:
Diagnostic 0-5

Warning 21-63

Information 6-20

Error 64-191

Critical 192-255

Bydefault,theCutoffsetupregisterofLogInsertersSystemLogController
moduleissetto192.Thismeansthatsystemeventswithaprioritylessthan192
arenottransferredtotheIONdatabaseandthereforecannotbeviewedinVista
usingtheGlobalEventViewer.Usetheaboveprioritymappingasaguidetoset
theCutoffsetupregistertoalowervalueifyouwanttoviewlowerpriorityevents
inVista.

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

ShortcutmenusareaccessedbyrightclickingcertainareasintheManagement
Console.Differentareasopendifferentshortcutmenus.Thefollowingareasofthe
ManagementConsoleprovideaccesstoshortcutmenus:

2007 Schneider Electric. All rights reserved.

Page 21

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

System Setup pane

RightclicktheSystemSetuppanetoaccessshortcutmenusforadjustingthesize
oftheiconsinthispane.
Table title
Tousethetabletitleshortcutmenus,rightclickthetabletitletoaccessthese
shortcutmenus:
RefreshmanuallyupdatestheManagementConsole(i.e.reloadsitscontents).
ViewFieldallowsyoutoselectanitemanddisplaythevalueofaparticular
fieldinadialogbox.Thisisusefulforviewingtextthatistoolongtofitwithin
thecolumnswidth.TheViewFieldoptionschange,dependingonwhichtab
youhaveselectedPropertiestaborEventstab.
Propertiesopensthepropertysheet(Optionsdialogbox)fortheDisplay
Window,whereyoucanchangethesettingsoftheColumnPropertiesorRow
Properties.
ColumnPropertiestab:Youcancontrolwhichcolumns(fields)areshown
inthedisplaywindow.Selectthecheckboxbesidethefieldtodisplaythat
column,orclearittohidethatcolumn.Youcanalsocontrolwhichitems
(rows)aredisplayedbyusingtextfilteringonaparticularcolumn.Clickthe
nameofthecolumn(field)toselectit,thenclicktheSetFilterbutton.Inthe
FilterSetupdialogbox,typethetextyouwanttosearchforintheFilterText
box,thenselectwhetheryouwantthesearchtomatchthetextExactly,or
Combinedwithothertext.ClickOKtoapplythefilter.Textfilteringis
usefulinsituationswheretherearetoomanyrowsshowninthedisplay
window.ClickClearFiltertoturnoffthefiltering.

RowPropertiestab:Thisletsyoucontroltheappearanceoftherowsinthe
Eventtab.Youcanenableordisablerowhighlighting,andspecifywhich
highlightcolortouse.Rowhighlightingappliesthecoloryouspecifyto
everyotherrow,todistinguishthembetter.Youcanalsosethowmany
recenteventrecordstoretrieve,andspecifywhetherornottoconvertthe
timestampstolocaldateandtime.

Page 22

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

Display Window
ToaccessshortcutmenusintheDisplayWindow,firstselecttheSystemSetup
itembyclickingitsicon.Then,rightclickinthedisplaywindowareatodisplay
theshortcutmenu.
Servers

Sites

Devices

Newdisplaystheoptionsavailableforaddingnewnetworkitems.Connectand
Disconnectletsyoumanuallyconnectordisconnecttheselectedsite.Similarly,
ConnectEthernetandDisconnectEthernetmanuallyconnectsordisconnectsthe
selectedEthernetdevice.Notethatyoucannotconnectordisconnectan
individualserialdeviceinasite;youcanonlyconnectordisconnectthesitefor
thatserialdevice.
Security...accessestheAdvancedMeterSecuritySettingsdialogbox.Thisisused
bythesoftwaretogainaccesstosecurityenableddevices(e.g.ION8600or
ION7650);itisonlyavailablefromtheshortcutmenufortheDevicesDisplay
Window.SelectingProperties...opensthepropertysheet(options)fortheselected
server,site,ordevice.Mandatorypropertiesarehighlightedinredyoumust
selectorentertheappropriatevalueforthese.

2007 Schneider Electric. All rights reserved.

Page 23

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

Duplicatecreatesoneormorecopiesofaselecteditem.

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.

Deleteremovestheselecteditems.
DuplicateandConfigure...letsyouperformbatchcloningofdevicesareal
timesaverwhencommissioninglargesystems.Whenmultipledevicesare
selected,thisrightclickshortcutbecomesConfigureSelectedDevices...which
letsyouperformusefulsetupfunctionssuchasbatchrenamingofdevices.

Component Property Sheet Shortcut Menus

Thisshortcutmenuisaccessedfromapropertysheet(Optionsdialogbox)fora
server,site,device,ordialoutmodem.SelectingPropertyDetails...opensa
windowcontaininginformationontheselectedproperty,includingminimumand
maximumallowablevalues,ifapplicable.AdvancedPropertiesexposesallthe
remainingpropertyfieldsthatwerehiddeninthedefault(basic)view.ResetAll
ToDefaultresetsallpropertiestotheiroriginalvalues.

Select a property to display its

description in the Property
Description field, as shown
here.

Page 24

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

Management Console Network Components

ThissectiondescribesthedifferentnetworkitemsinManagementConsole.

Servers
AserverisacomputerinanIONEnterprisesystemrunningadministrative
softwarethatcontrolsaccesstothenetworkanditsresources,suchasIONdevices.
Aserverprovidesresourcestoothercomputers(workstations)onthenetwork.
Theserverrunsservicecomponentsfortaskssuchascreatingcommunicationand
softwarelinksbetweenIONsystemcomponents,andcreatinglinksintoION
databases.

Sites
AsiteisagroupofdevicesintheIONEnterprisesystemthatshareacommon
communicationslink.Asitecanbeadirectsite,amodemsite,Ethernetgateway
site,orOPCsite.
Direct Site
Inadirectsite,serialcommunicationsoccurbetweenacomputerandoneormore
meters.Tosetupadirectsite,youmustspecifyaserialcommunicationsporton
thecomputer.ThestandardsmostcommonlyusedoncomputersareRS232(for
connectingonedevice)andRS485(forconnectingaloopofupto32devices).
Whenconnectingtomorethanoneserialdevice,useanRS232toRS485
converter.
Modem Site
Inamodemsite,communicationsoccurbetweenaremotemodem(attheModem
Site)andalocalmodem(onthePrimaryServer).

NOTE
Remote sites that use radio modems or leased-line modems are configured as Direct (Serial) Sites, not as
Modem Sites.

Modemsitescanincludetraditionalhardwaremodems(thosethatareconfigured
andcontrolledbyIONEnterprise),orWinModems(Windowsmodems).If
multiplemodemsaresetupinthemodemsite,IONEnterprisechoosesthefirst
availablemodemtoestablishcommunications(thisisreferredtoasmodem
pooling).
Ethernet Gateway Site
EthernetgatewaysitesconsistofanRS485chainofdevicesthatcommunicates
withanEthernetnetworkviaanEthernetDevicethatconvertsRS232/RS485
communicationstoandfromEthernet.TheEthernetDevicethenhasadirect
connectiontothenetworkofserialdevicesthroughoneofitsserial
communicationsports.TheEthernetdeviceactsasagatewaythattransfersdata
betweenanEthernetnetworkandanRS485chainofconnecteddevices.For
Ethernetgatewaysites,theTCP/IPAddressfieldandTCP/IPPortfieldmustbe
filledin.TheTCP/IPPortcanidentifywhichcommunicationsportisusedfor

2007 Schneider Electric. All rights reserved.

Page 25

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

connectingtotheserialdevices(dependingonthetypeofEthernetgatewaydevice
thatisused).
OPC Site
AnOPCSiteconsistsofanOPCServerthatcommunicateswithOPCcompliant
devicesinthenetwork.

Devices
ADeviceisanIONmeter,orothercomponentthatcommunicatesandgathers
data,thatisinstalledonanetwork.
SerialDevicesbelongtoDirectSites,ModemSites,orEtherGateSitesthey
communicatethroughamodem,RS232,RS485,orEthernettoSerialgateway
connection.Youmusthavetheappropriatesitesconfiguredfirstbeforeyoucan
addserialdevices.
EthernetDevicesarethosethataredirectlyconnectedtotheEthernetnetwork.
YoucanmanuallyconnectordisconnectyourEthernetdevicethroughthe
ManagementConsole.

Dial-Out Modems
Adialoutmodemisonethataservercomputerusestocommunicatewitha
remotemodemataModemSite.Themodemimplementedcouldbeatraditional
hardwarebasedmodemorthenewer(andusuallycheaper)softwarebased
modemthatusesthecomputersprocessortoemulatethetraditionalhardware
basedmodem.

NOTE
A WinModem is a modem that is directly controlled by the computers operating system.

Whenamodemsiteneedstoestablishcommunications,itselectsamodemfrom
thelistofmodemsconfiguredinthemodemsite.Youcanaddhardwaremodems
orWinModemstothemodemlist.

Connection Schedules
Connectionschedulesareprogrammedroutinesforaservertoregularlyconnect
toanddisconnectfromModemSitesandtheirassociatedIONdevice.Youcanalso
createconnectionschedulesforDirectSitesandEthernetDevicesorEthernet
GatewaySites.

Page 26

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

Detailed Operation
ThePrimaryServercontainsalltheIONEnterpriseprogramsandcontrolsthe
overalloperationofyourenergymanagementsystem.Theprimaryserveris
displayedwhenyoufirststartManagementConsole.
Tostartbuildingyoursystem,addandsetupyoursitesanddevices.

Adding a Network Component

Followtheprocedurebelowtoaddanewnetworkcomponent:
1.

SelecttheSystemSetupitemthatyouwanttoaddbyclickingitsicon(i.e.,
Server,Site,Device,DialOutModem,orConnectionSchedule).

2.

Rightclickinthedisplaywindow,selectNew,andthenselectthespecifictype
ofnetworkcomponentfromtheshortcutmenu.Theoptionsdifferdepending
onwhichsystemsetupitemyouhaveselected.

3.

Configurethepropertiesusingthedropdownmenus;mandatoryitemsare
highlightedinredtheymustbefilledin.
Ifyouwanttoconfigureadvancedproperties,rightclickinthedialogboxand
selectAdvancedProperties.

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.

4.

ClickOKwhenyouaredone.

Adding a Server
ClicktheServersicon,rightclickinthedisplaywindowandselect
New > Computer,thenfillinallthemandatoryfields.

2007 Schneider Electric. All rights reserved.

Page 27

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

Setting Up Devices for Direct Serial Communications

TosetupdevicesforRS232orRS485communicationsonadirectserialloop,first
youneedtosetupadirectsite.Serialdevicesyoucanaddtoadirectsiteinclude
thosethatcommunicateusingIONorModbusRTUprotocol.
Adding a Direct Site
ClicktheSitesicon.RightclickinthedisplaywindowandselectNew > Direct
Site.FillintheNameandSerialPortfields,andconfiguretheotherfieldsas
required.
Adding a Device to the Direct Site
ClicktheDevicesicon.RightclickinthedisplaywindowandselectNew > Serial
DeviceonDirectSite.Fillinthesefields:
Group(selectoneorsetupanewonebyselecting[AddNewGroup])
Name
DeviceType(forserialModbusdevices,selecttheonewithModRTUin
brackets)
UnitID(rangeis19999forIONdevices,or1247forModbusRTUdevices)
Site(selecttheDirectSiteyoupreviouslysetup)
Configuretheotherfieldsasrequired.

Setting Up Devices for Ethernet Gateway Communications

TosetupdevicesforEthernetgatewaycommunications,firstyouneedtosetup
anEthernetgatewaysite.Ethernetgatewaysthatcanbeusedincludethosethat
aresimpleEthernettoSerialconverters,oranygatewayordataconcentratorthat
providesModbusTCPcommunications.
Adding an Ethernet Gateway Site
ClicktheSitesicon.RightclickinthedisplaywindowandselectNew > Ethernet
GatewaySite.FillintheName,TCP/IPAddressandTCP/IPPortfields,and
configuretheotherfieldsasrequired.
Adding a Device to the Ethernet Gateway Site
ClicktheDevicesicon.RightclickinthedisplaywindowandselectNew > Serial
DeviceonEthernetGatewaySite.Fillinthesefields:
Group(selectoneorsetupanewonebyselecting[AddNewGroup])
Name
DeviceType(forModbusTCPgateways,selectadevicetypewithModTCPin
brackets)
UnitID(rangeis19999forIONdevices,or1247forModbusTCPdevices)
Site(selecttheEthernetGatewaysiteyoupreviouslysetup)
Configuretheotherfieldsasrequired.

Page 28

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

Adding an Ethernet Device

ClicktheDevicesicon.Rightclickinthedisplaywindowandselect
New > EthernetDevice.FillintheGroup,Name,DeviceTypeandTCP/IP
Addressfields,andconfiguretheotherfieldsasrequired.

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.

TosetupdevicesforOPCcommunications,firstyouneedtosetupanOPCsite.
Adding an OPC Site
ClicktheSitesicon.RightclickinthedisplaywindowandselectNew > OPCSite.
FillintheNameandAddressfields,andconfiguretheotherfieldsasrequired.
MakesureyoufollowthecorrectsyntaxwhenfillingintheaddressfortheOPC
site.SelecttheAddressfieldtoseeanexampleadressinthePropertyDescription
area(nearthebottomoftheOPCSiteOptionsdialog).
Adding a Device to the OPC Site
ClicktheDevicesicon.RightclickinthedisplaywindowandselectNew > OPC
Device.FillintheGroup,Name,DeviceTypeandSite(selecttheOPCsiteyou
previouslysetup),andconfiguretheotherfieldsasrequired.

Adding a Modem
1.

ClicktheDialOutModemsicon,rightclickinthedisplaywindowandselect
New,thenselecteitherSerialModem...(hardwaremodem),orWinModem...
(Windowsmodem).

2.

Fillinthevaluesforallrequiredfieldsinthepropertiesdialogbox:
Forserialmodem,selecttheModemTypefromthelist.Ifyourmodemis
notinthislist,selectGenericIONModemOther.SelecttheSerialPort
whereyourmodemisconnected.
ForWinModems,selecttheModemNamefromthelist.

3.

ClickOK.

WinModem Installation Notes

BeforeyoucanuseaWinModem,youmustfirstinstallitonyourcomputer(follow
theinstructionsthatcamewiththeWinModemproduct).Afterrebootingthe
computer,setuptheWinModem:

2007 Schneider Electric. All rights reserved.

Page 29

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

1.

ClickStart>Settings>ControlPanel,thendoubleclickPhoneandModem
Options.

2.

ClicktheModemstab,selectyourWinModem,thenclickProperties.

3.

ClicktheAdvancedtab,thenclickChangeDefaultPreference.

4.

SetPortspeedtomatchthebaudratethatisusedbetweenthemeterandthe
modemontheremoteendoftheconnection(i.e.bothmodemsmustbesettothe
samebaudrate).

5.

SetFlowControltoNone.

6.

ClickOKtoapplythechanges.

NOTE
You may need to reboot your machine for the settings to take effect.

Editing a Network Component

1.

ClicktheappropriateSystemSetupicon.

2.

Inthedisplaywindow,rightclickthenetworkcomponentyouwanttoeditand
selectProperties.

3.

Maketherequiredchanges.Todisplayallconfigurablefields,rightclickinthe
propertiesdialogboxandselectAdvancedProperties.

Deleting a Network Component

1.

ClicktheappropriateSystemSetupicon.

2.

Inthedisplaywindow,rightclickthenetworkcomponentyouwanttodelete
andselectDelete(orselecttheitemandpresstheDeletekey).

3.

ClickYestoconfirmthedeletion.

CAUTION
When deleting a Site or a Server, all devices associated with it are also deleted.

Accessing Meters with Advanced Security

IfyouhaveameterinyournetworkwithAdvancedSecurity,useManagement
ConsoletoconfigurethesecuritysettingssothatIONRealTimeDataServicecan
accessthemeter:
1.

Page 30

RightclickthedevicethathasAdvancedSecurityenabledandselect
Security....

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

1.

Setuptheappropriateaccesslevel.

2.

ClickOK.

Configuring the Network through SQL Statements

YoucanuseManagementConsoletomanuallyconfigurethenetworkcomponents
byexecutingSQLstatements.

CAUTION
Altering the network configuration using SQL satements is for advanced users only.

1.

WhileholdingdowntheCTRLkey,rightclickthetabletitle(shadedarea
abovethedisplaywindow)andselectCustomSQL.Awarningdisplays(this
warningappearsonlyoncepersession):

2.

ClickOKtocontinue.

3.

TypeyourSQLstatementintheCustomSQLbox.

4.

ClickExecute.

TheresultsoftheSQLstatementexecutionappearinthedisplaywindow.

2007 Schneider Electric. All rights reserved.

Page 31

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

Configuring Connection Schedules

YoucanschedulethetimeswhentheserverconnectstoaSite.

Page 32

1.

ClicktheConnectionSchedulesicon,rightclickinthedisplaywindow,then
selectNew.

2.

Enterthenameofyourconnectionschedule(forexampleDailyReading).

3.

SelecttheSitestab,thenclickChangeSelection...

4.

IntheAvailableSitesarea,clickthesitesorindividualdevicesyouwantto
includeintheschedule,thenclicktherightarrowbuttonneartheIncludeSites
areatomovetheselectedsitethere.Youcanalsosetsitesordevicesyouwant
toexcludebymovingthemtotheExcludeSitesarea.ClickOK.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

5.

MakeyourchangesintheSiteConnectionSettingssection,thenclickthe
Scheduletab.

6.

Setyourscheduleforthesiteconnection,thenclickOK.Ifyouconfigureafull
day(i.e.24hour)dailyschedule,makesureyouallowenoughtimebetweenthe
endtimeandthestartofthenextconnectiontoavoidconnectionproblems.For
example,toadda2minutegaptoa24hourschedule,settheStartTimeto
0:00:00andtheEndTimeto23:58:00.

2007 Schneider Electric. All rights reserved.

Page 33

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

Setting Up Large Systems

Apowermonitoringnetworkthatcontainsmanydevicesofthesametype(such
asaparticularbrandandmodelnumberofabranchcircuitmonitor)typicallyuses
alogicalnamingschemeforthedevices.Forexample,youcanuseaschemelike
FL1_PNL1A.CCT01tonameadevicethatisinstalledonthe1stFloorofthe
building,electricalpanel1A,andCircuitbreaker#1.
Toperformbatchnetworksetupofdevices,createthefirstdeviceinManagement
Console(refertotheprevioussection,AddingaNetworkComponenton
page 27).Aftercreatingthisfirstdevice,youcanthenuseittocreatemultiple
duplicatesandconfiguretheirproperities.

NOTE
Only users with Supervisor or Operator privileges can create and configure devices.

Creating Multiple Copies of an Ethernet Device

Scroll left

1.

SelecttheDevicesiconontheSystemSetuppaneinManagementConsole.

2.

RightclickinthedisplaywindowandselectNew>EthernetDevice,then
configurethefirstEthernetdeviceusingyourlogicalnamingscheme.For
example,clicktheGroupdropdownboxandselect[AddNewGroup],then
enterthegroupname(e.g.FL1_PNL1A)intheAddGroupbox.Typethe
deviceName(e.g.CCT01),selecttheDeviceType,typetheIPaddress,then
clickOK.

3.

RightclicktheEthernetdeviceyouwanttoduplicateandselectDuplicateand
Configure.

Start & End spin box

Scroll right

Duplicate and
Configure area

Hide/Show
Columns area
Table Editing
area

Page 34

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

TheDuplicateandConfigureareacontainsthesesections:
ConfigureNames:Usethissectiontocreatetheduplicates.
ConfigureTCP/IPAddresses:UsethissectiontocreateasequenceofIP
addressestoassigntotheduplicatesaftertheyhavebeencreated.
ConfigureTCP/IPPort:Theportnumberusedintheoriginaldeviceis
automaticallyassignedtoalltheduplicates.Ifrequired,youcanusethis
sectiontoselectadifferentportnumberforallthedisplayeddevicesinthe
TableEditingarea(notethatchangesmadehereareappliedtoalldevices,
includingtheoriginal).
ConfigureUnitID:Thissectionisdisabledbydefault,sinceunitIDsdonot
applytotypicalEthernetdevices.(Toenablethissection,youmustfirstset
uptheTableEditingareasothattheUnitIDcolumnisshowing).
4.

IntheConfigureNamesarea,thedevicenameisdisplayedsuchthateachletter
andnumberisselectable.Agroupofnumbersistreatedasasingleentity.For
example,thenameMY8600isdisplayedsotheentitiesyoucanselectareM,
Yand8600.Leadingzeroesarealsosupported,soyoucansetsequences
suchas01,02,03or001,002,003.

5.

Selectaletterornumberinthedevicename.ThisactionfillsintheStartboxwith
thatvalue,soyoucanstartsettingasequentialrange.
Forexample,ifyouselectthefirst1fromtheexamplenamingschemeandset
theEndspinboxto2,twonameswillbegenerated(theoriginal,plusone
duplicate).IfyouselectaletterandsetitsStartvaluetoAandtheEndvalue
toC,threenameswillbegenerated(theoriginal,plustwoduplicates).
Thetotalnumberofgeneratednamesistheproductofthefirstrangemultiplied
bythenext,andsoonuntilthelastrange,asindicatedinthegraphicbelow.

The total generated names is the product:

[2 x 3 x 10] = 60

TheStartboxdisplaystheselectednumber/letter,whichisthestartvalue.Use
theupordownarrowinthespinboxtochangethestartvalue,orsimplytypeit
inthebox.

2007 Schneider Electric. All rights reserved.

6.

ClicktheuparrowontheEndboxtoincreasetherange,ortypetheendvalue
inthebox.Tocleartherangeandstartover,clickRemoveParameters.

7.

Tosetexceptionsforindividualvaluesorarangeofvalues,refertothesection,
SettingExceptionstoGeneratedSequencesonpage 37.Exceptionsreducethe
numberofnamescreated(i.e.totalgeneratednamesminustheexceptions).

8.

Whenyouarefinishedsettingtheexceptions,clickOKtoapplyyourchanges
andclosethedialogbox.

Page 35

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

9.

ClickDuplicate.TheduplicateddevicesappearintheTableEditingarea.

Original device

Asterisks indicate pending changes

that have not yet been saved.

10. ScrolltotherightintheDuplicateandConfigureareaandrepeattheprocedure
tosettheIPaddressesfortheduplicateddevices.

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.

11. ClickConfiguretosetthevaluesforthedevices.

Duplicated devices are always

disabled when they are added to
Management Console

Page 36

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - 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. ClickApplytosaveyourchangesandleavethewindowopentocontinue
working,orclickOKsaveyourchangesandreturntoManagementConsole,or
clickCanceltodiscardyourchanges.Adialogpromptsyouiftherearepending
(unsaved)changeswhenyouclickCancel.ClickYestodiscardthechangesand
returntoManagementConsole,orNotoreturntotheconfigurationwindow
andcontinueediting.

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

TheExceptionsoptionappliestotheConfigureNamesandConfigureIP
addressessectionsonly.

Click this to edit

exceptions

1.

2007 Schneider Electric. All rights reserved.

Tosetexceptionstotherangeofgeneratedvalues,clickEdit.

Page 37

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

2.

UsetheAddnumber(orAddcharacter)spinboxtosetavaluetoexcludefrom
therangeyouhavespecified,thenclickAdd.Repeattosetadditionalvaluesto
exclude.Tosetarangeofvaluestoexclude,selectAddnumberrange(orAdd
characterrange),thenusetheStartandEndspinboxestosettherangeto
exclude.ClickAdd.Repeattosetadditionalrangesofvaluestoexclude.

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.

UsetheRemovenumber(orRemovecharacter)spinboxtoremovethe
exceptionthatwassetforagivenvalue(i.e.putitbackinasanacceptablevalue).
UsetheRemovenumberrange(orRemovecharacterrange)spinboxesto
removetheexceptionthatwassetforarangeofvalues.

Creating Multiple Copies of a Serial Device

1.

CreateandconfigureaDirectSiteorEthernetGatewaySiteinManagement
Console.

2.

SelecttheDevicesiconontheSystemSetuppaneinManagementConsole.

3.

RightclickinthedisplaywindowandselectNew>SerialDeviceonDirectSite
orNew > SerialDeviceonEthernetGatewaySite(asappropriate),then
configurethefirstserialdeviceusingyourlogicalnamingscheme.Forexample,
clicktheGroupdropdownboxandselect[AddNewGroup],thenenterthe
groupname(e.g.DS1_FL1)intheAddGroupbox.TypethedeviceName
(e.g.P6200_01),selecttheDeviceType,typetheUnitID,selecttheSite,then
clickOK.

4.

RightclickthenewserialdeviceandselectDuplicateandConfigure.
TheDuplicateandConfigureareacontainsthesesections:
ConfigureNames:Usethissectiontocreatetheduplicates.
ConfigureUnitIDs:UsethissectiontocreateasequenceofunitIDsto
assigntotheduplicatesaftertheyhavebeencreated.
ConfigureSerialSites:Theserialsiteusedintheoriginaldeviceis
automaticallyassignedtoalltheduplicates.Ifrequired,youcanusethis
sectiontoselectadifferentserialsiteforallthedisplayeddevicesinthe
TableEditingarea(notethatchangesmadehereareappliedtoalldevices,
includingtheoriginal).

5.

Page 38

UsetheConfigureNamessectiontoduplicatetheserialdevice.Followthe
procedureasdescribedintheprevioussection,CreatingMultipleCopiesofan
EthernetDeviceonpage 34.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

6.

OntheConfigureUnitIDssection,settheUnitIDsoftheserialdevicesusing
thepreviousprocedure.

7.

ClickApplyorOK.

Creating Multiple Copies of an OPC Device

1.

CreateandconfigureanOPCSiteinManagementConsole.

2.

SelecttheDevicesiconontheSystemSetuppaneinManagementConsole.

3.

RightclickinthedisplaywindowandselectNew>OPCDevice,thenconfigure
thefirstOPCdeviceusingyourlogicalnamingscheme.Mandatoryfieldsare:
Group,Name,DeviceType,andSite.

4.

RightclickthenewOPCdeviceandselectDuplicateandConfigure.
TheDuplicateandConfigureareacontainsthesesections:
ConfigureNames:Usethissectiontocreatetheduplicates.
ConfigureAddress:Usethissectiontocreateasequenceofaddressesto
assigntotheduplicatesaftertheyhavebeencreated.
ConfigureOPCSites:TheOPCsiteusedintheoriginaldeviceis
automaticallyassignedtoalltheduplicates.Ifrequired,youcanusethis
sectiontoselectadifferentOPCsiteforallthedisplayeddevicesintheTable
Editingarea(notethatchangesmadehereareappliedtoalldevices,
includingtheoriginal).

5.

2007 Schneider Electric. All rights reserved.

UsetheConfigureNamessectiontoduplicatetheOPCdevice.Followthe
procedureasdescribedintheprevioussection,CreatingMultipleCopiesofan
EthernetDeviceonpage 34.

Page 39

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

6.

OntheConfigureAddresssection,settheaddressesoftheOPCdevicesusing
thepreviousprocedure.

7.

ClickApplyorOK.

Selecting Multiple Devices to Configure

Afteryouhaveduplicatedthedevices,youcanselectandconfigureanyorallof
them.
1.

SelecttheDevicesiconontheSystemSetuppaneinManagementConsole.

2.

Selectthedevicesyouwanttoconfigure.Toselectacontiguousrange,clickthe
firstdevice,holddowntheSHIFTkey,thenclickthelastdevice.Toselectanon
contiguousrange,holddowntheCTRLkeywhileclickingeachdevice.

3.

RightclickandselectConfigureSelectedDevices.Thisoptionisonlyavailable
ifmultipledevicesareselected.

4.

Usethedifferentsectionsinthewindowtomakeyourconfigurationchanges.
Forexample:Withserialdevices,youcanusetheStartandEndspinboxesin
theConfigureUnitIDssectiontoconfiguretherangeofunitIDs.Click
ConfiguretoapplythechangestothedisplayeddevicesintheTableEditing
area(changesareappliedfromtoptobottom).

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.

Page 40

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

5.

2007 Schneider Electric. All rights reserved.

Repeatthepreviousconfigurationstepfortheotherpropertiesyouwantto
change.Forinstance,ifyouwanttoassignadifferentsiteforthedevices,select
thesiteintheConfigureSerialSitesection.ClickConfiguretoapplythe
changestoalldisplayeddevicesintheTableEditingarea.

Page 41

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

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.

ClickApplytosaveyourchanges.Ifyouchangedthenameofoneormore
devices,awarningdisplayswithalistofdevicesthatwillberenamed.Ifdata
forthosedevicesalreadyexistintheIONdatabaseandyoustillproceedwith
therenaming,thentheexistingdataassociatedwiththeolddevicenamewillbe
lost(orphaned).ClickContinuetoproceed,orCanceltogobackandeditthe
deviceconfiguration.

7.

Whenyouhavefinishedmakingyourchanges,clickOKtosavethemandreturn
toManagementConsole.

Using the Table Editing Area

YoucancustomizethewaydataisdisplayedintheTableEditingarea.When
makingconfigurationchanges,thesechangesareappliedonlytotherowsthatare
visibleintheTableEditingarea.

Column Sorting and Filtering

Clickacolumntosorttheinformationinthetableinascendingordescending
order(indicatedbyanupordownarrow,respectively).Tocancelsortingand
returnthecolumntoitsdefaultstate,rightclickthecolumnandselectClear
Sorting.

Sort

Filter

Whenthemouseispositionedoveracolumn,theFiltericonappearsonthetop
rightcornerofthecolumnheader.Clickittoselectandapplyafilterconditionto

Page 42

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

thedatainthatcolumn.Select(Custom)toapplyoneortwologicconditionsto
filterthedata.Tocancelfilteringandreturnthecolumntoitsdefaultstate,right
clickthecolumnandselectClearFilter.

NOTE
When column filtering is on, changes done using the configuration editors on the top pane of the window
affect only the devices that are visible in the Table Editing area. If you want to apply the changes to all
devices, clear the filter first before making the changes.

Adjust Column Width

Tochangethewidthofacolumn,pointthemousetotherightedgeofthecolumn
header.Whentheresizehandle(doublearrowpointer)appears,clickanddragto
adjustthewidth.Releasethemousetosetit.Toadjustthewidthforbestfit,point
totherightedgeofthecolumnheader,thendoubleclickwhentheresizehandle
appears.

Arrange Columns
Tochangetheorderofthecolumns,dragacolumnheadertotheleftorrightofits
originalposition,thenreleasethemousetosetitinplace.

Group by Column
Togroupdataaccordingtothecontentsofaparticularcolumn,dragthecolumn
headertotheareaaboveit(markedDragacolumnheaderheretogroupbythat
column).Expandorcollapsethegroupsbyclickingthe+orbutton.To
expandorcollapseallgroups,rightclickthecolumnheaderandselectFull
ExpandorFullCollapse,respectively.
Toungroup,dragthecolumnheaderbacktoitsoriginalposition(orrightclickthe
columnandselectUngroup).

Using the Filter Editor

TheFilterEditorisanadvanceddatafilteringtool.Touseit:

2007 Schneider Electric. All rights reserved.

1.

RightclickacolumnheaderandselectFilterEditor.

2.

SpecifythefilterconditionsintheFilterBuilderwindow.Clickanelementto
displaytheoptionsavailable,thenselecttheoptionyouwanttouse.

Page 43

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

Logic

Theelementsofthefilterbuilderare:
<ColumnHeader><Condition><Value>
3.

Selectthe<ColumnHeader>andthe<Condition>youwanttoapply.Typethe
<Value>totestfor.

4.

Toaddanotherfilter,clickthe+buttononthetop.

5.

Selectalogictoapplytothisnewfilter(inrelationshiptothecurrentlyselected
filter).

6.

Toremoveafilter,clickthedelete(x)buttonbesideit.

Inthenextexample,thefilterwillfindalldeviceswhosenamescontainFL1,and
whosetypesbeginwithION.

Therowsreturnedareasfollows:

Select the box to turn the filter on; clear it to turn the filter off.
Click the x to cancel and exit the filter mode

Page 44

Click Edit Filter to configure

the filter conditions

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 2 - Management Console

Edit, Copy and Paste

Sometimesdevicenamesdonotfollowanyparticularnamingpattern.Inthiscase,
youcanusethecopy/pastefunctiontoapplyconfigurationchangesdirectlytothe
TableEditingarea.
FirstthingyouneedtodoisaddanewdeviceinManagementConsole,thencreate
asmanyduplicatesofthedeviceasthequantityofitemsyouarepasting.
IfyouhaveaMicrosoftExcelspreadsheetthatcontainsalistofthesedevicesto
addtoManagementConsole,youcanusetheConfigureNamesareatocreate
duplicatesofthatdevicetype,thenusetheTableEditingareatocopyandpaste
thedevicepropertiesfromtheExcelspreadsheet.Anexampleisshownbelow.
Copy and Paste 20 Ethernet Devices from Excel

2007 Schneider Electric. All rights reserved.

1.

MakesurethenamesintheExcelspreadsheetconformtothenaming
convention,[Group].[DeviceName].

2.

AddthefirstdeviceandsetupitspropertiesinManagementConsole.Youcan
assignitasimpledevicenamesuchasA.B1sinceitwillbeoverwrittenwhen
thevaluesarecopiedandpastedfromExcel.SettheEnabledpropertytoNo
(thismakessurethatManagementConsoledoesnotattempttoconnectthe
device).

3.

ClickOKtoaddthedevice.

4.

RightclickthedeviceandselectDuplicateandConfigure.

5.

Selectthe1intheConfigureNamesbox,thenusetheEndspinboxtosetthe
valueto20.

6.

OntheHide/ShowColumnsarea,clearallthenoneditablecolumns,i.e.hide
thosethatcontaingrayedoutvalues.Alsohidethecolumnsyoudonotwantto
pasteover.

7.

OntheExcelspreadsheet,arrangethecolumnssotheymatchtheorderofthe
columnsontheTableEditingarea.HideallcolumnsontheExcelspreadsheet
exceptthosecorrespondingcolumnsontheTableEditingarea.

Page 45

Chapter 2 - Management Console

ION Enterprise 5.6 User Guide

8.

SelectthecellsinExcelandcopythem(CTRL+C).

9.

OntheTableEditingarea,clickonthefirstcellundertheNamecolumntoselect
it,thenpastethecontentsoftheclipboard(CTRL+V).

10. ClickApplytosaveyourchanges,orclickOKsaveyourchangesandreturnto
ManagementConsole.

Find and Replace

UsetheFindandReplacefeaturetomodifymatchingcharactersinthedevice
namesorinanyothereditablecolumnsonthedevicetable.TheFindandReplace
featuredoesnotworkonreadonlycolumns.

Page 46

1.

RightclickthedevicetableandselectFindandReplace.

2.

TypethecharactersyouwanttosearchforintheFindbox.Donotusewildcard
characters(*).Notethatthesearchiscasesensitive.

3.

Incolumnlistsallavailablecolumns.Selectthecolumnyouwanttosearchin.

4.

IntheReplacewithbox,typethecharactersyouwanttousetoreplacethe
charactersintheFindbox.Ifyouwanttodeletecharactersfromacolumnvalue,
leavetheReplacewithboxblank.

5.

ClickPreviewtolistthesearchresultsinthetable.TheReplacewithcolumn
displaysthenewnameorvalueresultingfromtheFindandReplaceoperation.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

2007 Schneider Electric. All rights reserved.

Chapter 2 - Management Console

6.

UsethecheckboxintheSelectcolumntoselecttherowsyouwanttochange
valuesfor.YoucanclickSelectAlltoselectalltheitems,orClearSelectedto
clearall.

7.

ClickApplytosaveyourchangesorCanceltodiscardyourchanges

8.

ClickOKtosaveyourchangesandclosetheFindandReplacedialog.

Page 47

Chapter 2 - Management Console

Page 48

ION Enterprise 5.6 User Guide

2007 Schneider Electric. All rights reserved.

Management Console Tools

ManagementConsoletoolsareadditionalprogramsthathelpyoumanageand
monitoryourIONEnterprisenetwork.

In This Chapter
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
User Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
StartingUserManager ................................................ 51
License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Diagnostic Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
StartingDiagnosticViewer............................................. 54
NavigationPanel..................................................... 54
DiagnosticsInformationPanel.......................................... 55
UsingtheFilterEditor ................................................. 57
ServerDiagnostics .................................................... 57
CommunicationsDiagnostics .......................................... 59
AdditionalCommands................................................ 60
CommunicationStatusvs.SiteStatus.................................... 62
Device Upgrader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
UsingDeviceUpgrader................................................ 63
FirmwareUpgradeErrorCodes ........................................ 65
Remote Modem Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
UsingRemoteModemSetup ........................................... 66
Virtual Processor Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
ConfiguringtheVirtualProcessorsModbusService....................... 68
ModifyingtheGlobalParameters ....................................... 73

2007 Schneider Electric. All rights reserved.

Page 49

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Introduction
ThefollowingprogramsareavailableinIONEnterprise,andcanbestarted
throughtheManagementConsolesToolsmenu:
DatabaseManagerhelpsyoumanageandmaintainyourdatabase;see
DatabaseManagementonpage 289
UserManagerallowsyoutoconfigureIONEnterpriseuserloginnames,access
levelsandpasswords
LicenseManagerallowsyoutoupgradeyoursoftwarelicensetoprovide
additionaldevice,clientandsoftwaresupport
Designerconfiguresdevicesandaddscustomfunctionalitytothem;see
Designeronpage 195
DiagnosticViewerprovidesdetailedrecordsofallsystemandnetworkevents
aswellascommunicationstatesandproblems
DeviceUpgraderuploadsnewfirmwaretonetworkmetersordevices
RemoteModemSetupconfiguresdialupmodemsthatwillbeusedatremote
powermanagementnetworks
IONVirtualProcessorSetupconfigurestheIONVirtualProcessorServicefor
userprogrammedfunctionality
ModbusDeviceImporterenablesModbusdevicestobeaddedtotheION
Enterprisenetwork;seeModbusDeviceImporteronpage 259
Optional:UpdateOPCServerandPQDIFExporterarecommandsthatappear
intheManagementConsole>Toolsmenuifthoseoptionsarepurchasedwith
IONEnterprise(oractivatedlaterusingtheappropriateupgradesoftware
license).

Page 50

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

User Manager
UserswithsupervisorlevelaccesstoIONEnterprise(suchastheION
administrator)canaddorremoveuserloginnamesandaddorchangepasswords
ofdifferentaccesslevelsinUserManager.

Starting User Manager

1.

StartManagementConsole.Loginusingausernamewithsupervisorlevel
access.

2.

ClickTools>UserManager.

Adding Users
1.

ClickAdd.

2.

TypethenewusernameandpasswordintheUsernameandPasswordboxes.
Donotusespacesintheseboxes.TypethepasswordagainintheRetype
Passwordbox.

3.

AssigntheappropriateAccessLevelaslistedinthetablebelow:

View Only

User

Controller

Operator

Supervisor

Access Level

YES

YES

YES

YES

YES

Acknowledge alarms

YES

YES

YES

YES

Trigger events2

YES

YES

YES

YES

YES

YES

YES

YES

YES

Type of Operation Allowed for User1

View Vista or Designer diagrams

Connect/disconnect sites or devices

Modify network configuration (using Management Console)
Edit Vista or Designer diagrams

YES

Administer software security

YES

1. You can use Vista to set different access levels for the different control operations.
2. Supervisors can trigger any event (waveform recording, etc), while Operators, Controllers and Users can only
trigger some events (such as resets).

2007 Schneider Electric. All rights reserved.

Page 51

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

4.

ClickAddUser.

5.

TypetheSupervisorpasswordwhenprompted.ClickOK.

6.

ClickOKattheprompttoaddtheuser.

NOTE
Keep a list of your ION Enterprise user accounts and their associated passwords in a safe place. Update
the list as you add users, remove accounts, and change passwords, because you cannot recover a lost
password (i.e. you will need to remove and re-add the user if this happens).

DuringtheIONEnterprisesoftwareinstallation,twodefaultusernames(guest
andsupervisor)werecreated,bothwithadefaultpasswordof0(zero).Both
theseusernameshavesupervisorlevelaccess,sothedefaultpasswordshouldbe
changedforsecurityreasons.

Changing the Password

1.

Selecttheusernameassociatedwiththepasswordyouwanttochange,then
clickChangePassword.

2.

TypetheoldandnewpasswordintheOldPasswordandNewPasswordboxes
respectively,thentypethenewpasswordagainintheConfirmnewpassword
box.ClickOK.

3.

ClickOKattheprompttoconfirmthepasswordchange.

NOTE
A users access level can only be set when it is added. To change the access level for the guest account,
you must first remove it.

Removing a User
Theexamplebelowshowshowtousethedefaultsupervisoraccounttodelete
thedefaultguestaccount:
1.

Selectguest,thenclickRemove.

2.

TypetheSupervisorpasswordwhenprompted.ClickOK.

3.

Whenpromptedtoconfirmremovaloftheuser,clickYes.

4.

ClickOKattheprompttoremovetheuser.

NOTE
You cannot remove the user account that you are currently using.

Page 52

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

License Manager
Foradditionaldeviceorclientusersupport(e.g.VistaorReporterclients)foryour
IONEnterprisesystem,ortoaddOPCand/orPQDIFoptions,orderthe
appropriatelicensefromSchneiderElectric.
Whenyoureceiveyournewlicense,useLicenseManagertoupgradethenumber
ofsupporteddevicesandclientusersinyoursystem:
1.

StartManagementConsole.Loginusingausernamewithsupervisorlevel
access.

2.

ClickTools>LicenseManager.
The current product key number,
number of devices in the system,
and maximum number of devices
supported are listed here.

3.

TypethenewproductkeyintheProductKeybox.ClickOK.

WhenyourestartLicenseManager,theSystemInfosectionliststheupdated
supportinformationfromthenewlyactivatedproductkey.Ifthenewkey
supportsadditionalfeaturesoroptions,thesearemadeavailableimmediately,
withouthavingtorestartManagementConsole.

2007 Schneider Electric. All rights reserved.

Page 53

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Diagnostic Viewer
DiagnosticVieweristheIONEnterprisetoolfortroubleshootingnetwork
communicationsproblemsandrelatednetworkerrors.

Starting Diagnostic Viewer

1.

StartManagementConsole.Loginwithyourusernameandpassword.

2.

ClickTools>System>DiagnosticViewer.

Diagnostics tabs

Pin/Unpin button

Expand/collapse
tree

Navigation panel

Diagnostics information panel

Navigation Panel
ThenavigationpaneldisplaysIONEnterprisediagnosticsinatreeviewformat.
Clickthethe+toexpandthetree,ortocollapseit.
Diagnosticsinformationisgroupedasfollows:
ServerDiagnostics:ContainsdiagnosticsinformationfortheCommunications
ServerandLogInserterservice.
CommunicationsDiagnostics:ContainsdiagnosticsinformationfortheION
Enterprisesites,hardwaredevicesandsoftwarenodes.
Selectaniteminthenavigationpaneltodisplayitsdiagnosticsinformation.

Dock or Hide Panel

ClickthePin/Unpinbuttononthethenavigationpaneltodock(show)orhideit.
Whenthenavigationpanelishidden,itisminimizedtoabuttonnamed
Diagnosticsontheleftsideofthewindow.Youcantemporarilydisplaythe
navigationpanelbymovingthemouseovertheDiagnosticsbutton.

Page 54

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Movethemouseawaytohidethepanelagain,orclickthePin/Unpinbuttonwhile
thepanelisdisplayedtodockit.

Diagnostics Information Panel

Thediagnosticsinformationpaneldisplaysdetaileddataaboutthestateofyour
powermonitoringsystemanddevices.Thefollowingsectionexplainshowyou
canchangethewayinformationispresentedinthediagnosticsinformationpanel.

Column Sorting and Filtering

Clickacolumntosorttheinformationinthetableinascendingordescending
order(indicatedbyanupordownarrow,respectively).Tocancelsortingand
returntoitsdefaultstate,rightclickthecolumnandselectClearSorting.
Filter
Sort

Whenthemouseispositionedoveracolumn,theFiltericonappearsonthetop
rightcornerofthecolumnheader.Clickittoselectandapplyafilterconditionto
thedatainthatcolumn.Select(Custom)toapplyoneortwologicconditionsto
filterthedata.Tocancelfilteringandreturnthecolumntoitsdefaultstate,right
clickthecolumnandselectClearFilter.

Adjust Column Width

Tochangethewidthofacolumn,pointthemousetotherightedgeofthecolumn
header.Whentheresizehandle(doublearrowpointer)appears,clickanddragto
adjustthewidth.Releasethemousetosetit.Toadjustthewidthforbestfit,point
totherightedgeofthecolumnheader,thendoubleclickwhentheresizehandle
appears.

Arrange Columns
Tochangetheorderofthecolumns,dragacolumnheadertotheleftorrightofits
originalposition,thenreleasethemousetosetitinplace.

Group by Column
Togroupdataaccordingtothecontentsofaparticularcolumn,dragthecolumn
headertotheareaaboveit(markedDragacolumnheaderheretogroupbythat
column).Expandorcollapsethegroupsbyclickingthe+orbutton.To
expandorcollapseallgroups,rightclickthecolumnheaderandselectFull
ExpandorFullCollapse,respectively.

2007 Schneider Electric. All rights reserved.

Page 55

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Toungroup,dragthecolumnheaderbacktoitsoriginalposition(orrightclickthe
columnandselectUngroup).

Column Shortcut Menu

Rightclickthecolumntodisplaytheshortcutmenu.Itcontainsthefunctions
describedearlier,plustheseadditionalfunctions:
Group By Box
Dragacolumnheaderontothisareaabovethecolumnheaders,togroupdata
accordingtodataappearinginthatcolumn.
Column Chooser
Thisallowsyoutosetwhichcolumnsareshowninthediagnosticsinfomation
panel.Touseit:
1.

RightclickthecolumnandselectColumnChooser.TheCustomization
windowdisplays.

2.

DragacolumnheaderyouwanttohideanddropitintheCustomization
window.Repeatforothercolumnsyouwanttohide.

3.

Toshowthecolumnagain,simplydragthecolumnheaderanddropitbackin
itsoriginalplace.

Best Fit (all columns)

Selectthistoadjustallcolumnwidthstothebestfit(i.e.withtheleastamountof
whitespace).

Page 56

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Using the Filter Editor

TheFilterEditorisanadvanceddatafilteringtool.Touseit:
1.

RightclickacolumnheaderandselectFilterEditor.

2.

SpecifythefilterconditionsintheFilterBuilderwindow.Clickanelementto
displaytheoptionsavailable,thenselecttheoptionyouwanttouse.

Logic

Theelementsofthefilterbuilderare:
<ColumnHeader><Condition><Value>
3.

Selectthe<ColumnHeader>andthe<Condition>youwanttoapply.Typethe
<Value>totestfor.

4.

Toaddanotherfilter,clickthe+buttononthetop.

5.

Selectalogictoapplytothisnewfilter(inrelationshiptothecurrentlyselected
filter).

6.

Repeatstep3.

7.

Toremoveafilter,clickthedelete(x)buttonbesideit.

Server Diagnostics
Serverdiagnosticsrecordscommunicationproblemsandsimilareventsoccurring
fromIONEnterprisesoftwarecomponents.

Communications Server Diagnostics

Informationaboutthecommunicationsserverisarrangedinthesetabs:
ConsoleMessageslistsallNetworkRouterconsolemessagesforthecurrent
session.
ConnectionStatusdisplaysthecurrentstatusofIONEnterprisesoftware
componentsconnectedtoNetworkRouter.
TreeStatesdisplaysthestatusofallnodes(hardwaredevicesandsoftware
nodes).

2007 Schneider Electric. All rights reserved.

Page 57

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

TIP
The blank area below the Description column header is a dynamic text search field. Type the wildcard
character (*) in front of the text you want to search (for example, *warning). The information panel
automatically displays only those records that match the text you typed in the box.

Dynamic text search field

Log Inserter Diagnostics

TheLogInserterdiagnosticsinformationpanelissplitintotwosections.Thetop
panel(SelectNodes)containstheavailablenodes,whilethebottompanel
containsthenodedetails.
Resizing the Top and Bottom Panels
Toresizethetopandbottompanels,pointthemouseattheborderwherethetwo
sectionsmeet.Whentheresizehandleappears,clickanddragthemouseupor
downtomovethehorizontalborder.Releasethemousetosettheborder.

Hidden navigation panel

Pin/Unpin button

Check boxes
Resize handle

Docking or Hiding the Select Nodes Panel

Similartothenavigationpanel,youcanhidetheSelectNodespanelbyclicking
itsPin/Unpinbutton.Whenthispanelishidden,itisminimizedtoabuttonnear
thetopleftcorner,namedSelectNodes.Pointthemousetothisbuttonto
temporarilyshowtheSelectNodespanel.Movethemouseawaytohidethepanel
again(orclickthePin/Unpinbuttonwhilethepanelisdisplayed,todockit).
Select Nodes to Display
IntheSelectNodespanel,selectthecheckboxbesideanodetodisplayits
diagnosticsinformation.Clearthecheckboxtohidethatnodesdiagnostics
information.
Iftherearemanynodes,andyouwanttodisplayonlyafewofthem,rightclick
thecheckboxarea,thenselectClearAll.Selectthenodesyouwanttodisplay.

Page 58

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Todisplayallthenodesagain,rightclickthecheckboxareaandselectSelectAll.
Node Details
Thenodedetailsareorganizedinthesetabs:
NodeInformationdisplaysLogInserterstatisticsfortheselectednodes.
NodePerformancedisplaysaggregatelogperformancestatisticsfortheselected
nodes.
LogPerformancedisplayslogperformancestatisticsforeachlogintheselected
nodes.
Maximizethewindowtoseemoreofthediagnosticstables.Scrollbars
automaticallyappearwhenthereismoreinformationthancanfitinthewindow.

Communications Diagnostics
CommunicationsDiagnosticsliststhesitesconnectedtotheworkstation.Site
Overviewsummarizesthediagnosticsinformationfromallsites.

Site Overview
Diagnosticsinformationforthesitesarecontainedinthesetabs:
SiteSummarydisplayscommunicationsstatisticsforeachsite.
NetUserStatusdisplaysthenumberofIONprogramscurrentlyinthequeue
(awaitingprocessing),andthetotalnumberofIONprogramsalready
processed.

NOTE
Requests and responses transmitted between the ION Enterprise components are referred to as ION
programs.

Site/Device Diagnostics
Diagnosticsinformationforsitesandindividualdevicesaresummarizedinthese
tabs:
CommunicationStatusdisplayserrorratesandconnectionstatisticsforthe
selecteddevice.Thefollowinginformationisavailablefromthe
CommunicationsStatustab:

Column

Description

Node

The device (or software node) name.

Requests

The number of communications requests transmitted to the meter.

Responses

The number of successful responses received.

Total Errors

The total number of errors.

2007 Schneider Electric. All rights reserved.

Page 59

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Column

Description

Total Error Rate

The ratio of Total Errors to Requests.

Sliding Error Rate

The error rate in the last 64 requests. This could indicate a trend in communications performance.

Average Response

Average time in seconds for the meter to respond.

Last Response

The last response time, in seconds.

Timeouts

The number of timeout errors. A timeout occurs when no data is received in response to a request.

Bad Checksums

The number of bad packets received, i.e. those that failed the error-detection checksum.

Incomplete Frames

The number of incomplete packets received, i.e. those that did not have all the expected bytes.

Bad Frames

The number of received packets that had an internal error.

Broken Connections

Number of times the connection was lost to the meters on a site.

Hardware Errors

Number of errors reported by the computers communication hardware.

Misc Errors

Number of other errors that do not fit any of the above descriptions.

SiteStatusdisplayssitestatisticssuchasconnectionstatusandtotals.
PollingStatusdisplaysthenumberofprogramscurrentlyinthequeue
(awaitingprocessing)andthetotalnumberofprogramsalreadyprocessed.

Additional Commands

Double-click to display
more details.

Diagnostic Details
Onthediagnosticsinformationpanel,doubleclickarowtodisplayitsDiagnostic
Detailsscreen.

Page 60

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

UsethePreviousandNextbuttonstoviewthedetailsoftheotherdevicesonthat
site.
Tocopyinformationtotheclipboard,clicktoselectit,thenpressCTRL+C.

Update/Reset/Copy All/Options
RightclickthediagnosticsinformationpaneltodisplaytheUpdate,Reset,Copy
All,andOptionscontextmenu.
Thecommandsperformthefollowingfunctions:
Right-click Option

Description

Update

Refreshes the information in the diagnostic table.

Reset

Resets the information in the diagnostic table.

Copy All

Copies all selected information to the clipboard.

Auto Scroll

Enabled by default, this Communications Server Diagnostics option

automatically scrolls and selects the latest console message. Clear this
option to disable scrolling (i.e. select and view an older console message
without jumping to the latest one when Diagnostic Viewer refreshes).

Options

Displays the option to change the diagnostics refresh rate. Note that
changing this value affects ION Enterprise performance.

Refresh Tree View

IfyouaddanewdeviceinManagementConsolewhileDiagnosticViewerisopen,
youcanrefreshthetreeview(todisplaythenewdevice)bycollapsingthen
expandingtherootnodeofthetree(i.e.IONEnterpriseDiagnostics).

2007 Schneider Electric. All rights reserved.

Page 61

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Communication Status vs. Site Status

Thissectionexplainsthedifferencebetweenthestatisticsprovidedonthe
CommunicationStatustabandthoseontheSiteStatustab.
TotalErrorsintheCommunicationStatustabisanIONSiteServicederived
statistic,whileBadResponsesintheSiteStatustabisaclientderivedstatistic.
Toexplainthisdifference,considerasituationwhereadirectsiteisexperiencing
timeouts.Communicationswiththedevicewillbeattemptedaccordingtotwo
parameters:ConnectAttempts(anadvancedsitepropertyintheManagement
Console)andMaximumAttemptsMultiple(anadvanceddevicepropertyinthe
ManagementConsole).Multiplyingthevaluesofthesetwopropertieswill
determinethenumberofattemptsmadetoreestablishcommunicationswiththe
device.
Forinstance,ifConnectAttemptsissetto1andMaximumAttemptsMultiple
issetto3,thedevicewillgoofflineafter3attempts(i.e.1x3).
TheTotalErrorsstatisticincreasesbyoneeverytimeIONSiteServicedetectsa
timeout.However,theBadResponsesstatisticonlyreportsaproblemifthe
devicegoesoffline(i.e.whenConnectAttemptsandMaximumAttempts
Multipleareexceeded).
Usingtheaboveexample,considerthecasewherefourtimeoutsoccurredandthe
devicewentoffline.Inthiscase,TotalErrorswouldincreasebyfour,whileBad
Responseswouldonlyincreasebyone.Ifonlytwotimeoutsoccurred,Total
Errorswouldincreasebytwo,whileBadResponseswouldnotchange.

Page 62

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Device Upgrader
UseDeviceUpgradertoupgradethefirmwareonasinglemeter,oronmultiple
metersofthesametype,inasinglesession.Supervisorlevelaccessisrequiredto
upgradedevices.

NOTE
To reduce the risk of upgrade errors, make sure the computer power option is set to always stay on and
screensavers are disabled. If using a laptop, plug it into a wall outlet and set the power option to do
nothing if the lid is closed.

Ifyouhavedatainthemeteryouwanttokeep,makesureyousaveitbefore
upgrading.Storeddatainthemetersmemoryiscompletelyerasedduringa
firmwareupgrade.Thisdataincludeswaveforms,datarecorders,minandmax
values,andintegratorvalues(e.g.kWh).

Using Device Upgrader

2007 Schneider Electric. All rights reserved.

1.

Obtaintheapplicableupgrade(.upg)filesforyourdevicefromyourTechnical
SupportcontactatSchneiderElectric.

2.

Savethefilesinaneasilyaccessedfolderonthecomputer.

3.

StartManagementConsole.

4.

ClickTools>System>DeviceUpgrader.Afterreadingthetipsandwarnings
abouttheupgradeoperation,clickOK.

Page 63

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

5.

TheDeviceUpgraderwindowdisplays.

6.

SelectyourdevicefromtheListDevicesofTypebox.

7.

IntheSelectRevisionsection,clickSelectFile.Locateandselecttheupgrade
(.upg)filethatyousavedinstep2,thenclickOpen.

8.

SelectthedevicenameyouwanttoupgradeintheSelectDevicestoUpgrade
box.Toselectmultipledevices,holddownCTRLwhileclickingeachdevice.

9.

TheSave/RestoreFrameworkcheckboxisselectedbydefault.Thiskeepsa
copyofyourcurrentframeworktemplateduringtheupgrade.Afterthe
firmwareupgradeiscomplete,DeviceUpgraderrestoresyourframework
template.

NOTE
The Device Upgrader loads new meter firmware that does not contain any framework templates. If you
want to preserve customizations you have made to your device framework, make sure Save/Restore
framework is selected. However, if you intend to replace the existing meter framework with a new one
(e.g. a new default meter template you downloaded), clear Save/Restore framework.

10. Ifyouareupgradingmultipledevices,specifyintheFailureHandlingareahow
theDeviceUpgraderrespondstoanunsuccessfulupgrade:
SelectHaltAfter,thenenteranumberintheboxtospecifyhowmany
attemptsDeviceUpgradershouldmakebeforestoppingduringafailed
upgrade.Bydefault,theutilityissettostopafterthefirstfailedupgrade.
SelectIgnoreAlltoattempttoupgradealloftheselecteddevicesregardless
ofthenumberofdevicesthatfailtoupgrade.
11. ClickUpgradetoupgradetheselecteddevices.
TheUpgradeStatusboxshowsthestagesoftheupgradeprocess.The
completedprogressbarindicateswhatpercentageoftheupgradeiscomplete.
EachcompletedupgradeislistedintheUpgradeStatusbox.

Page 64

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Firmware Upgrade Error Codes

Thistabledescribesthevariouserrorcodesthatmayoccurwhenyouupgrade
yourdevicesfirmware.

Error Code

Description

0, 1, 2, 3, 4, 5, 6, 7, 8, or 9

Indicates a negative acknowledgment to a request. Contact Technical Services for assistance.

100

Device timed out while downloading firmware. Probable causes include: poor communication or the
device stopped functioning.

101, 102, 103, 104, 105

Indicates a bad response to a request. Contact Technical Services for assistance.

106

Device Upgrader was unable to prepare the device to accept new firmware. Try to upgrade the device
again. Contact Technical Services for assistance if the problem persists.

107

Device Upgrader was unable to verify the device's new firmware. Try to upgrade the device again.
Contact Technical Services for assistance if the error persists.

108

Device Upgrader was unable to download a firmware packet. Try to upgrade the device again.
Contact Technical Services for assistance if the error persists.

109

Device Upgrader was unable to retrieve the device framework. Probable causes: a) time out or b)
device not functioning.

110

Device Upgrader was unable to retrieve the device's firmware revision. Probable causes: a) time out,
b) device not functioning, or c) cannot access the device's firmware revision register.

150

Device Upgrader cannot save the device framework to the file <device_name>.conf. Make sure the
ION Enterprise\config\upgrade directory exists and that you have write permissions.

151, 155

The Device Upgrader failed to successfully upgrade a device and left a <device_name>.conf file.
Probable cause: you are attempting to upgrade a different device than the one that the Device
Upgrader previously failed.

152

The information in the file <device_name>.conf is corrupted or unrecognizable by the Device

Upgrader. Contact Technical Services for assistance.

153

The Device Upgrader was unable to upgrade the device framework from ION 1.0 to ION 2.0.
Contact Technical Services for assistance.

154

Device Upgrader was unable to restore the device setup. Probable causes: a) time out or b) device
not functioning.

156

Device Upgrader was unable to restore the device framework completely to the file
<device_name>.conf. This error is most likely caused by a full hard drive.

2007 Schneider Electric. All rights reserved.

Page 65

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Remote Modem Setup

UseRemoteModemSetuptopreconfiguredialupmodemsthatwillbeconnected
tometersatremotelocations.Hardwarebasedandsoftwarebased(WinModems)
modemsaresupported.
RemoteModemSetupprovidesaccesstoadatabasethatcontainsconfiguration
dataforavarietyofmodemsyoucanpickfrom.RemoteModemSetupalso
providesdirectaccesstoyourmodemsoyoucancustomizesettingsand
troubleshootitsoperation.
Preliminary Setup
Useyourmodemusermanualtosetupandconnectthemodemtooneofyour
computersserialports.ChooseaportthattheIONEnterpriseCommunications
Serverisnotusing.

Using Remote Modem Setup

1.

StartManagementConsole.

2.

ClickTools>System>RemoteModemSetup.

3.

SelecttheserialcommunicationsPortthatthecomputerwilluseto
communicatewith,andsetup,themodem.SettheBaudRatetomatchthe
modemsbaudrate.

NOTE
To reduce possible communication problems, set the computer, modems and meters to the same baud
rate.

4.

Setthefollowingpropertiesfortheremotemodem:
SelectfromthelistofmodemsintheTypebox.SettheSiteBaudRate.
Tosetthemodemtoanswerafteraspecifiednumberofrings,selectAuto
Answer,thentypetheappropriatenumberintheNumberofRingsbox.

Page 66

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

SelectStoreProfiletosavethemodemconfigurationdatainthemodems
onboardmemory.Thisfeatureallowsthemodemtoreverttothesaved
settingsafterapowerfailure.ClearStoreProfiletodisablethisfeature.
Toturnonthemodemsinternalspeaker,selectSpeakerOn,thenselectasetting
intheVolumebox.ClearSpeakerOntodisablethisfeature.
5.

ClickSendtosavethesettingstothemodem.
IfthereareDIPswitchsettingsrequiredforthemodemthatisbeingconfigured,
amessagedisplayswithinstructionsonwhichswitchestoturnonoroff.Setthe
DIPswitchesonthemodemasinstructed.

Themodemisnowreadytobeusedattheremotepowermonitoringsite.

2007 Schneider Electric. All rights reserved.

Page 67

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Virtual Processor Setup

TheVirtualProcessoristheIONEnterpriseservice(IONVirtualProcessor
Service)thatprovidescoordinateddatacollectionandaggregation,control,and
mathematicalanalysisofpowermonitoringsystemdatafromgroupsofmetering
orsimilarintelligentdevices.UseVirtualProcessorSetuptoconfigureaVirtual
ProcessorModbusServicefordefiningsitesanddevicesinaModbusnetwork,and
tosetupthecommunicationsportforit.VirtualProcessorSetupcanalsobeused
toimprovetheperformanceoftheIONVirtualProcessorServicebymodifyingits
globaloperatingparameters.
SeethetopicVirtualProcessorServiceonpage 249forapplicationexamples
usingtheVirtualProcessor.

Configuring the Virtual Processor's Modbus Service

NOTE
This information is provided for the benefit of customers who have legacy implementations of Modbus
communications using the Virtual Processor. Users that are setting up new Modbus communications
should refer to Modbus Device Importer on page 259. Modbus support in the Virtual Processor will be
removed in a future version of ION Enterprise.

WhensettingupyourModbusnetwork,makesurethatyourModbusportis
separatefromtheportthatconnectstoyourIONdevices.TheVirtualProcessor
requiresitsowncommunicationsportforModbus,separatefromany
communicationsportdefinedasasiteintheManagementConsole.

Setting up a Virtual Processors Modbus network

1.

StartManagementConsole.

2.

ClickTools>System>IONVirtualProcessorSetup.

3.

TheVirtualProcessor(VIP.ComputerNamewhereComputerNameisthe
nameoftheworkstation)isdisplayedasaniteminthetreeview.

NOTE
A + beside an item indicates collapsed view, while a - indicates expanded view. Double-click an item
to toggle between these views.

4.

Page 68

ExpandModbusNetworktoshowModbusSitesandSlavePorts.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Adding a Modbus Master Ethernet Site

1.

SelectMasterSites,thenclickAddSite.

2.

SelectEthernet(RTU),thentypetheTCP/IPaddressandportnumberinthe
appropriatebox:

This is the IP address of the

Master site or gateway.
The TCP/IP port number is used to
connect the COM port used by the
Modbus network. For example,
TCP/IP port 7802 connects to an
EtherGate devices COM2 port.

CAUTION
Never use 502 for the TCP/IP port. Modbus/TCP packets use the TCP/IP protocol and are sent to this
registered port number. At this time, the Virtual Processor does not support Modbus/TCP (MBAP).

Adding a Modbus Master Serial Site

1.

SelectMasterSites,thenclickAddSite.

2.

SelectSerialSite,thenusetheCOMportboxtospecifywhichofyour
computersserialportsyouwantassignasyourModbusMaster.TheVirtual
ProcessorsModbusImportandModbusExportmodulesthenusethisCOM
porttocommunicatetotheModbusslavedevices.

NOTE
The COM port used to define a Master Site must be different from the COM port used for connecting to
the ION devices.

Configuring the Modbus Master Site Parameters

SelectthesiteandexpandthetreetodisplaytheparametersunderSettings.Select
theparameteryouwanttochange,andthenclickModify.

2007 Schneider Electric. All rights reserved.

Page 69

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

TransmitDelay:TheamountoftimetheVirtualProcessorwaitsbetween
sendingoutrequests.Thesupportedrangeisfrom10to60000milliseconds.The
defaultvalueis150milliseconds.
ReceiveTimeout:ThetimeperiodtheVirtualProcessorallowsforestablishing
communications.Thesupportedrangeisfrom100to60000milliseconds.The
defaultvalueis1800millisecondsforserialsitesand10000millisecondsfor
Ethernetsites.ForEthernetsites,theprotocolusedisModbusRTU.Sincethis
protocoldoesnotidentifypackets,packetmixupispossible.Therefore,specify
avaluethatavoidstimeouts.

CAUTION
For Ethernet sites, specifying too small a value for Transmit Delay may overload the network. Similarly,
specifying too small a value for Receive Timeout may cause timeout errors on Ethernet sites, which could
result in packet mix-up.

BaudRate:Appliestoserialsitesonly,thisspecifiestheBaudrateusedfor
Modbuscommunicationstoserialsites.Supportedvaluesare300,1200,2400,
4800,9600,19200,38400,57600,115200.Defaultvalueis9600baud.
Parity:Appliestoserialsitesonly,thisspecifieswhetherornotparityisactive
(andifitisactive,thetypeofparity,i.e.Odd,Even,Mark,orSpace).Parityrefers
toatechniqueofcheckingwhetherdatahasbeenlostoroverwrittenwhenitis
movedfromoneplaceinstoragetoanother,orwhentransmittedbetween
devicesand/orcomputers.DefaultvalueisNONE.
StopBits:Appliestoserialsitesonly,thisspecifiesthenumberofstopbits
supportedbythesite.Supportedvaluesareaminimumof1,1.5and2.Stopbits
signaltheendofaunitoftransmissiononaserialline.Defaultvalueis1.
DataBits:Appliestoserialsitesonly,thisspecifiesthenumberofdatabits(i.e.
bitsthatcontaininformationordata)supportedbythesite.Supportedvalues
rangefromaminimumof4andamaximumof8.Defaultvalueis8.
Adding Modbus Devices
1.

SelecttheModbusMastersiteyouwanttoaddaModbusdeviceto.Expand
thetreetodisplaySettingsandDevices.SelectDevices,thenclickAddDevice.

For Ethernet devices,

enter a value of 100
in the Unit ID box.

Page 70

2.

EntertheNameandUnitIDoftheModbusdeviceintheappropriateboxes.For
Ethernetdevices,setUnitIDto100.TheNamemustbeuniqueamongallthe
sitesservicedbytheVirtualProcessor.TheUnitIDmustbeuniqueinsidea
givensite.ClickAdd.

3.

RepeatthepreviousstepifyouareaddingmoreModbusdevicestothesame
site.WhenyouhavefinishedconnectingalltheModbusdevicestothatsite,
clickOK.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

NOTE
A Modbus device name must start with a letter, followed by letters, numbers and/or underscores. The
Modbus device name must not contain spaces. The supported range for a Modbus device Unit ID is from
1 to 247. Do not use 0 as it is reserved for broadcast messages.

Renaming a Modbus Device

1.

SelecttheModbusdeviceyouwanttorename.ClickRenameDevice.

2.

Typethenewname,thenclickOK.

CAUTION
If you rename or delete Modbus devices, all Modbus Export or Modbus Import modules that previously
referred to that renamed or deleted Modbus device will be mapped to not_a_valid_device when you
restart the Virtual Processor. Designer displays these modules as offline (outlined in red).

Deleting a Modbus Device

1.

SelecttheModbusdeviceyouwanttodelete.

2.

ClickDeleteDevice.ClickOK.

Adding a Communications Port for the Modbus Slave

TIP
If you want to use ION data in your Modbus network, you will need to convert the data to Modbus. Use
Designer to open the Virtual Processor node and create Modbus Slave modules, then set them up to map
the registers and apply the proper conversion from ION data to Modbus.

1.

ExpandModbusNetworktodisplayMasterSitesandSlavePorts.Select
SlavePorts,thenclickAddCOMPort.

2.

UsetheCOMPortboxtoselectwhichportyouwanttoasaModbusSlaveport
(thisistheportthattheModbusMasterusestoreadModbusdatafromthe
VirtualProcessorsModbusSlavemodules).ClickOK.

NOTE
The Modbus Slave port must not be set to the same port as any ION or Modbus Master ports.

2007 Schneider Electric. All rights reserved.

Page 71

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

3.

DoubleclicktheCOMportyouhavejustadded.

4.

DoubleclickSettingstoexpandandshowtheitemsbelowit.

5.

SelectUnitID,thenclickModifyUnitID.

6.

EntertheModbusSlavedeviceUnitIDinthebox.ClickOK.

7.

IfyouwanttomodifytheBaudRate,clicktoselectBaudRate,andthenclickthe
ModifyBaudRatebutton.Selectthenewbaudratefromthedropdownlist,
thenclickOK.

8.

Ifnecessary,configuretheParity,StopBitsandDataBits.

Changing Port Assignment for a Modbus Master or Slave

Page 72

1.

Clicktheportyouwanttoreassign,andthenclickRenamePort.

2.

SelecttheportyouwanttoreassignfortheModbusmasterorslave,asexplained
inAddingaModbusMasterEthernetSiteonpage 69orAddinga
CommunicationsPortfortheModbusSlaveonpage 71.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 3 - Management Console Tools

Deleting a Modbus Master Site or Slave Port

CAUTION
Deleting a Modbus Master Site also deletes all devices connected to it.

1.

Clickonthesiteorportyouwanttodelete,andthenclickDeletePort.

2.

ClickOKtodeletetheport.

Final Steps After Saving and Exiting

WhenyouhavefinishedusingVirtualProcessorSetup,clickSavetosaveyour
changes,thenclickExittoclosethewindow.
Inordertomakethechangestakeeffect,stopthenrestarttheVirtualProcessor
service.

Modifying the Global Parameters

WhiletypicallyyoushouldnotneedtochangethedefaultVirtualProcessors
GlobalParameterssettings,thefollowingsettingsmaybetweakedtotryand
optimizesystemperformance.

Global Parameter

Default Setting

Value Range

Description

Module Update Period

100 ms

50 to 1000 ms

Period at which ION modules inside the Virtual

Processor are updated.

Configuration Saver Period

60 sec

10 to 600 seconds

Period at which the Virtual Processor writes its

configuration data to the computer's hard disk.

Client Polling Period

2000 ms

500 to 300000 ms

Interval at which the Virtual Processor client subsystem

polls the ION software server node (ION meter, for
example)

Server Polling Period

1000 ms

200 to 1440000 ms

Period, in milliseconds, at which the Virtual Processor

server sends its information to client nodes (for
example, Vista)

2007 Schneider Electric. All rights reserved.

Page 73

Chapter 3 - Management Console Tools

ION Enterprise 5.6 User Guide

Module Update Period

Default=100ms.Frequentmoduleupdatescontributetotheworkstations
processorload.ByincreasingtheModuleUpdatePeriod,youreducethenumber
oftimesamoduleexecutesinagiventimeperiod.
Configuration Saver Period
Default=60seconds.TheVirtualProcessorsconfigurationfileissavedtothe
workstationsharddiskattheratedefinedbytheConfigurationSaverPeriod.
IncreasingtheConfigurationSaverPeriodsignificantlyreducestheprocessorload
ifyouhavealargeVirtualProcessorconfigurationfile.
Client Polling Period
Default=2000ms.ThissetsthetimeintervalatwhichtheVirtualProcessorgets
informationfromothernodesinthenetwork(forexample,anotherVirtual
Processor,oradevice).Supportedrangeisfrom500to300000ms.Youcan
increasetheperiodforlesscriticalVirtualProcessorapplications,andreducethe
periodformorecriticalapplications.
Server Polling Period
Default=1000ms.ThisdefineshowoftentheVirtualProcessorrespondsto
requestsforinformationfromclientnodessuchasVistaortheLogInserter.
Reducingthisvalueincreasestherateatwhichtheseresponsesaresent;however,
thisalsotendstoincreasenetworktraffic.

Page 74

2007 Schneider Electric. All rights reserved.

Vista
VistaistheIONEnterprisecomponentthatdisplaysandcontrolsyourpower
monitoring/managementsystem.

In This Chapter
Starting Vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
The Vista Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Vista User Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Generating, Opening and Closing a User Diagram . . . . . . . . . . . . . . . . . . 80
Navigating a User Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Monitoring Your System in Vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Controlling System Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Plotting Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
The Log View Plotter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Adding Parameters to a Log View Plotter . . . . . . . . . . . . . . . . . . . . . . . . . 105
Customizing the Log View Plotter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Overlaying Curves (CBEMA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Creating and Editing a User Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Placing Diagram Objects into a User Diagram . . . . . . . . . . . . . . . . . . . . . 118
Linking a Diagram Object to a Data Source . . . . . . . . . . . . . . . . . . . . . . . 125
Adding a Global Event Log Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Querying the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Custom User Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Customizing a Diagram Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Customizing a Diagram Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

2007 Schneider Electric. All rights reserved.

Page 75

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Starting Vista
TostartVista,useoneofthefollowingmethods:
ClickStart>Programs>SchneiderElectric>IONEnterpriseTools>Vista.
OpentheIONEnterpriseToolsfolderonyourdesktopanddoubleclickthe
Vistaicon.
DoubleclicktheIONEnterpriseicononyourdesktop,thenclickVistaonthe
IONEnterpriseTaskpadscreen.
Atthelogonprompt,typeyourusernameandpassword.SeeLoggingintoION
Enterpriseonpage 18formoreinformation.
Ifyouhaveausernameandpassword,logonatyouraccesslevel(asdetermined
byyoursystemadministrator).Ifyoudonothaveausernameandpassword,log
oninViewOnlymodeforlimitedaccess.SeeUserManageronpage 51formore
informationonaccesslevels.
Thedefaultusernameisguest.Thedefaultpasswordis0(zero).Bothfieldsinthe
logonboxarecasesensitive.
ThemainscreenappearsafteryouhaveloggedontoVista(seeTheVista
Interfaceonpage 77).

Ending Your Vista Session

TherearetwowaystoendyourVistasession:logoffifyouwanttoendthecurrent
usersessionbutkeepVistarunning;exitifyouwanttocloseVistacompletely.
Logging off from Vista
1.

SelectFile>Logoff.
Amessageappears,promptingyoutoconfirmyourintentiontologoff.

2.

ClickYestologofforNotoreturntoVista.
Ifyouattempttologoffwithoutsavingyourwork,Vistapromptsyoutosave
yourchanges.ChooseYestosaveyourchanges,Notodiscardthem,orCancel
toreturntoVista.
Onceyoulogoff,thestandardIONEnterpriseLogonscreenappears.

Exiting from Vista

1.

SelectFile>Exit.
Amessageappears,promptingyoutoconfirmyourintentiontoexitthe
application.

2.

ClickYestoexitorNotoreturntoVista.
Ifyouattempttoexitwithoutsavingyourwork,Vistapromptsyoutosaveyour
changes.ChooseYestosaveyourchanges,Notodiscardthem,orCancelto
returntoVista.

Page 76

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

The Vista Interface

TheVistainterfaceconsistsofamainscreenwithatitlebar,amenubar,atoolbar,
aworkspace,andastatusbar.

Menu Bar
Toolbar

Workspace
Toolbox

Receive/Transmit
Status Indicators

Status Line

Toolbar
Thetoolbaroffersquickaccesstothecommandsthatareusedmostfrequently.
Eachcommandofferedonthetoolbarisalsoavailablefromthemenubar.
Open

Fit to
Window

Restore
to 100%

Save

Zoom

Plot
Selected
Data

Copy

Layout

Help

Cut

Paste

Up One
Level

Workspace
ThemainareainthecenteroftheVistascreenistheworkspace.Theworkspaceis
usedtodisplayinformationsuchasuserdiagramsanddataandeventviewers.
Status bar
ThestatusbardisplaysinformationonspecificVistafunctions.
Thestatuslinedescribesanyactiveprocessesandprovidesabriefdescriptionof
thecurrentlyselectedcommandortoolbarbutton.Besidethestatuslinearea
displayofthecurrenttimeontheworkstation,aprogressindicatorbar,andtwo
communicationstatuslights.
Toolbox
InEditmode,thetoolboxalsoappearsonthescreen.Youcanaddobjectstothe
userdiagramusingthetoolbox.SeeCreatingandEditingaUserDiagramon
page 116formoreinformationonthetoolboxandEditmode.

2007 Schneider Electric. All rights reserved.

Page 77

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Vista User Diagrams

ThissectionexplainshowtouseVistauserdiagramstoviewrealtimeandlogged
datafromyourpowermonitoringsystem.Theinformationthatyouobtainfrom
yourIONEnterprisenetworkisrepresentedgraphicallyinauserdiagram.Thisis
oneofthefundamentalinterfacemechanismsforVista.

What is a User Diagram?

Auserdiagramisaconfigurabledisplaythatconsistsoftwomainelements:
diagramobjectsandgroupingwindows.
Diagramobjectsareconfigurablegraphiciconsthatdisplayyoursystem
information.Eachdiagramobjectdisplaysasinglepieceofinformationfrom
somewhereinyourpowermonitoringnetwork.Insomecases,diagramobjectsare
storedwithingroupingwindows.
Agroupingwindowisatypeoffolderorsubwindowthatcontainsgroupsof
diagramobjects.Vistausesgroupingwindowstologicallyorganizediagram
objectswithinauserdiagram.Whenclosed,agroupingwindowisusually
representedbyasmalliconorgroupingobject.

Diagram object

Grouping window
(contains additional
diagram objects)

Grouping object (click here to

open grouping window)
User diagram (contains diagram objects)

TIP
It is better to use grouping objects to open other user diagrams rather than grouping windows. Large
numbers of grouping windows in a user diagram can slow the performance of Vista.

Youcancreateasmanyuserdiagramsasyouwantandediteachonetorepresent
asingleaspectorphysicalareaofyourinstallation.Youcanshareuserdiagrams
withmultipleusersoveryournetwork,andusethemsimultaneously,allsharing
thesameinformation.(OnlyauserwithSupervisorlevelaccesscancreateanew
userdiagram.)

Page 78

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Default User Diagrams

Vistaprovidesasetofpreconfigureduserdiagramsthatyoucanusetodisplay
data.Thesedefaultdiagramsprovideastandardsetofoptionsthatyoucanuseto
accessyourIONmetersmostcommonlyrequiredfunctions.
Eachtypeofpowermeterusesauniquesetofdiagrams.Anexampleofthedefault
diagramforonetypeofpowermeterisshownbelow:

Real-time data is
displayed against a
representation of
your power system.
Click a tab to
display its data

Click this button to

return to the Network
Diagram view.

Click this grouping object to

open another window
containing more data.

Thedefaultdiagramdisplaysrealtimedata.Itincludesasimplepowersystem
illustrationthatdisplaysthevariousrealtimeparametersmeasuredbythedevice.

2007 Schneider Electric. All rights reserved.

Page 79

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Generating, Opening and Closing a User Diagram

Auserdiagramisidentifiedbyits.dgmextention.Youcangenerate,open,and
closeuserdiagramsasneeded.

Generating a Network Diagram

Thenetworkdiagramuseslinkstoindividualdefaultuserdiagramstodisplay
datafromeachdeviceinyoursystem.Inthisway,thenetworkdiagramdepicts
yourentirepowermonitoringsystem.Whenyougenerateanetworkdiagram,
Vistaautomaticallylocatesalldevicesinyoursystemanddisplaysthem.This
diagramissavedwiththedefaultnamenetwork.dgm.
Generating a network diagram
1.

SelectFile>GenerateNetworkDiagram.
Thenetworkdiagramappearsintheworkspaceasawindowcontainingicons
thatrepresentagroupofdevicesonyoursystem.

2.

Clickononeofthegroupingobjectstoopenawindowanddisplaythenode
iconscontainedwithin.

3.

Clickanodeicontodisplaytheuserdiagramfortheassociateddevice.

4.

Savethenetworkdiagram.

NOTE
Regenerating a network diagram and saving it overwrites the previously saved (network.dgm) file.

Opening a User Diagram

Youcanopenauserdiagramtomodifyit:
1.

SelectFile>OpenDiagram.

2.

NavigatetotheuserdiagramyouwanttoopenandselectitfromtheOpen
Diagramdialogbox.

3.

ClickOpentoopentheselecteduserdiagram.

Specifying a Vista Diagram to Open for a Given User

TosetupaspecificVistaworkspaceforaparticularuser(sothateverytimethat
userlogsontoVista,thesamesetofdiagramsisopened):

Page 80

1.

LogontoVistausingtheparticularuserslogoncredentials.

2.

OrganizeVistatoappearasyouwantittoappearonstartup.

3.

Save,thencloseVista.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

4.

UseWindowsExplorertonavigatetothe...\IONEnterprise\config\cfg\ud
folder.

5.

Locatethe.wsufilefortheuseryouaresettingup(i.e.<username>.wsu).Right
clickandselectProperties.

6.

SelecttheReadonlyattribute,thenclickOK.

NOTE
Applying the Read-only attribute prevents the workspace information from being modified, so Vista opens
the same way for a given user every time. The user will still be able to modify and save user diagrams
(if allowed by their access level)

Closing a User Diagram

SelectClosefromtheFilemenutoclosethecurrentdiagram.
SelectCloseAllfromtheFilemenutoclosealluserdiagrams.

2007 Schneider Electric. All rights reserved.

Page 81

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Navigating a User Diagram

Onceyouhaveopenedauserdiagram,youcanuseittointeractwithyourpower
monitoringsystem.Eachuserdiagramdisplayssysteminformationthrough
diagramobjects,whichyoucanusetomonitorandcontrolvariousaspectsofyour
system.
Vistaoffersseveraltoolstoassistyouwhenviewingauserdiagram.Theseinclude
groupingwindows,scrollbars,andavarietyofdisplayfeaturesformanaging
windows.

Display Mode and Edit Mode

TherearetwomodesinVista,whichaffecthowyounavigateauserdiagram.
Whetherornotthetoolboxisshowndeterminesthemodeyouarein.Ifthe
toolboxisopen,youareineditmode;ifitisclosed,youareindisplaymode:
Displaymodeallowsyoutomonitoryoursystem,viewsystemdata,andcontrol
someaspectsofyoursystem.InDisplaymode,singleclickobjectstoviewthe
informationtheycontainorperformtheiraction.
Editmodeallowsyoutoconfiguretheappearanceandfunctionofdiagramsand
diagramobjects.InEditmode,doubleclickonobjectstoviewtheinformation
theycontainorperformtheirprogrammedaction.Rightclickonobjectstoview
configurationoptions.SeeCreatingandEditingaUserDiagramonpage 116
andCustomUserDiagramsonpage 140formoreinformation.
Wheninstructedtoclickonadiagramobject,eithersingleclickordoubleclick,
dependingonthemodeyouarein.

Grouping Windows
Dependingonitscomplexity,auserdiagramcouldbequitelarge.Youmayneed
toresizethescreenorscrolltoviewthecompleteuserdiagram.Additional
informationmayalsobelocatedwithingroupingwindows.Typically,agrouping
objectisusedtoopenagroupingwindow.
GroupingObject:Insomecases,auserdiagramstoresrelatedinformationwithin
agroupingobject.Clickonagroupingobjecttoopenagroupingwindowand
displayitscontents.

NOTE
To configure a grouping object to open a grouping window, see Specifying Action for Numeric, Status,
or Grouping Objects on page 153.

Page 82

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Click a grouping
object to open its
grouping window.

Display Features
Vistaoffersseveraldisplayfeaturestoassistyouwhenviewingauserdiagram.
Zoom
SelectZoomInfromtheViewmenuorclicktheZoombuttononthetoolbarand
themousepointerchangestoacrosshair.Usethispointertodraganoutlineofthe
areathatyouwanttoenlarge.
Restore to 100%
SelectRestoreto100%fromtheViewmenuorclicktheRestoreto100%buttonon
thetoolbartoreturntothenormalview.
Fit to Window
SelectFittoWindowfromtheViewmenuorclicktheFittoWindowbuttononthe
toolbartoforcetheuserdiagramtofitinthecurrentwindow.
Up One Level
Toreturntothepreviouslydisplayedwindow,clicktheUpOneLevelbutton(or
selectFile>UpOneLevel).Notethatthisalsoclosesthecurrentwindow.Ifyou
wanttobepromptedwhenyoureachthetoplevelofadiagram,makesurethe
BrowseClosesActiveWindowoptionisselected.
Browse Closes Active Window
Wheneveryouopenawindow,anypreviouslyopenedwindowsremainopenso
youcanswitchbetweenthem.Ifyoudonotwanttoopenmorethanonewindow
atatime,selectBrowseClosesActiveWindowfromtheOptionsmenu.Withthis
optionselected,eachwindowyouopenreplacesthepreviousone.Thisoptionis
selectedbydefault.
Arrange All
Totileallopenwindowsintheworkspace,chooseArrangeAllfromtheWindow
menu.

2007 Schneider Electric. All rights reserved.

Page 83

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Monitoring Your System in Vista

UseVistauserdiagramstodisplayrealtimeandloggeddata,monitoreventsand
alarms,andcontrolavarietyofsystemfunctions.

How Data is Displayed

Allinformationinyouruserdiagramisdisplayedusingdiagramobjects.Each
diagramobjectcommunicatesasinglepieceofinformationfromsomewherein
yourpowermonitoringnetwork;forexample,asinglenumericobjectdisplays
numericdatafromasinglesource.
Thereareseventypesofdiagramobjects,eachofwhichperformsaspecifictypeof
function.Inmostcases,youcanidentifyanobjectsfunctionbyacaption,alabel,
orboth.Thetextobjectdoesnotuseacaptionoralabel.

Bydefault,thecaptionisusuallylocatedbelowthediagramobjectandidentifies
thenodetowhichthediagramobjectisconnected.Thecaptioncanbemodifiedto
displayacustomdescription.SeeCaptionOptionsonpage 141formore
information.
Whenalabelisused,itisusuallydisplayedtoonesideofthediagramobject.By
default,thelabelidentifiestheregister(onthenode)towhichthediagramobject
isconnected.Thelabelcanbemodifiedtodisplayacustomlabelname.SeeText
Optionsonpage 141formoreinformation.

NOTE
You can view either default labels or custom labels by selecting or clearing Show Default Labels on the
Options menu. You can identify the type of diagram object by pointing to it with the mouse. The object
type appears on the status line below the workspace and on a Tool Tip beside the object.

Viewing Real-Time Data

Vistausesnumericobjectsandstatusobjectstodisplayrealtimedata.Numeric
objectsdisplayrealtimenumericvaluesandstatusobjectsdisplayrealtime
Boolean(ON/OFF)information.

Viewing Numeric Objects

Vistausesnumericobjectstodisplayrealtimenumericdatafromyourpower
monitoringsystem.Numericobjectscandisplaymanytypesofdata,suchasline
voltageorcurrent,powerorenergylevels,harmonics,ordemandparameters.

Page 84

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Dependingonhowtheyareconfigured,numericobjectscandisplaydatain
differentways.Anumericobjectmayappearasanalphanumericdisplay,adial,a
horizontalorverticalbar,orascrollinggraph.
Display Styles for Numeric Objects

Alphanumeric

Partial Dial

Full Dial

Vertical Bar

Horizontal Bar

Timestamped
PC Timestamped
Scrolling Graph

Arc Meter

Timestamp Only

SeeCustomizingtheDisplayofaNumericObjectonpage 145formore
information.
Using flags on a numeric object
Insomecases,anumericobjectmayuseflagstoindicatethelowandhighlimits
ofthedisplayedparameter.

Whenusedonadialdisplay,flagsappearascoloredareasateitherend.When
usedonothertypesofnumericobjects,flagschangetheobjectsbackgroundcolor
toindicatethataloworhighlimitiscurrentlyexceeded.Bydefault,thelowflag
colorisblueandthehighflagcolorisred.
Flagsarestoredintheworkspacefileonaperuserbasis.Theyareconfigurable
andcanbecustomizedbyanyonewhohasthenecessaryaccesslevel.Configurable
settingsincludeflagcolor,lowlimitandhighlimit.SeeDisplayOptionson
page 145formoreinformationonconfiguringflags.

Identifying Stale Data

Realtimedatathathasnotbeenrefreshedisreferredtoasstaledata.Vistadetects
staledataasitoccursandidentifiesitwithacoloredborder.Bydefault,Vista
identifiesdataasstaleafter30seconds(forIONmeterdiagrams,thedefaultvalue
is60seconds).Inthefollowingexample,anumericobjectisframedwithacolored
border(yellow,bydefault)whendisplayingstaledata.Positionthepointerover
anobjecttodisplayaToolTipthatexplainswhythedatahasbecomestale.

2007 Schneider Electric. All rights reserved.

Page 85

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Thestaledatasettingsareuserconfigurableonaperdiagrambasis,andcanbe
customizedbyanyonewiththenecessaryaccesslevel.
Changing the Stale Data settings
Tochangetheamountoftime(insecondes)thatVistausestoidentifystaledata:
1.

RightclickthebackgroundandclickProperties.

2.

ClicktheUpdatestabandchangethesettingsintheStaleDatasection.

Changing the Flag settings

Tochangetheflagcolor:
1.

ClickOptions>FlagColors.

2.

ClicktheEditbuttonfortheflagcoloryouwanttochange,thenselectthenew
colorandclickOK.

Identifying Errors in Communication

Vistadetectserrors(suchasdisableddevices,securityaccessrestrictions,or
configurationerrors)andidentifiesthesewithacoloredborderaroundanobject
(orange,bydefault).Thebordercolorcanbecustomized(seeprevioussection,
ChangingtheFlagsettings).PositionthepointeroveranobjecttodisplayaTool
Tipthatexplainstheerror.

Viewing Status Objects

VistausesstatusobjectstodisplayBoolean(ON/OFF)conditionsinyoursystem.
Astatusobjectmaydisplaythestatusofadigitaloutput(suchasarelay),adigital
input(statusinput),orasetpointinyoursystem.
Thedefaultstatusobjectappearsasanindicatorlightthatchangescolortoindicate
variousconditions.Bydefault,greenindicatesanOFFconditionandredindicates
anONcondition.Agraylightindicatesthestatusobjectisnotlinkedorreceiving
data.

Likemostdiagramobjects,statusobjectscanbemodifiedbyanyuserwithchange
access.Dependingonhowastatusobjecthasbeenconfigured,itsappearanceand
functionmaydiffersignificantlyfromthedefaultsettings.

Page 86

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Astatusobjectthathasbeencustomizedmayappearasanalphanumericdisplay
(forexample,ONorOFF)oracustomimage(threeimagesrepresentingON,
OFF,andUNCONNECTED).SeeCustomizingtheDisplayofaStatusObjecton
page 149formoreinformation.
Insomecases,theactivestateofastatusobjectmayhavebeenchanged(inverted)
sothatanactivestateappearsasinactiveandviceversa.SeeAnnunciation
Optionsonpage 156formoreinformation.

Viewing Logged Data

Dataandeventsrecordedbythedevicesinyoursystemareregularlytransferred
bytheLogInserterfromeachdevicetothedatabase.VistausestheIONQuery
Servicetotransferthisinformationfromthedatabasetoyourworkstation.Vista
providestwowaystoviewloggeddataandevents:theDataLogViewerandthe
Event(andGlobalEvent)LogViewer.
TheDataLogViewerdisplaysdatalogsfromalldevicesrepresentedintheactive
userdiagram.YoucanusetheDataLogViewertodisplaywaveformandtrend
dataintabularformat.Youcanalsoselectarangeoflogsfromtheviewerand
displaythedatagraphicallyinthelogviewplotter.
TheEventLogViewertypicallydisplayseventsandalarmsfromeachdevice
representedintheactiveuserdiagram.TheEventLogViewerisusedprimarilyto
monitorlowpriorityeventsandalarmsassociatedwiththeactiveuserdiagram.
EachEventLogViewerisassociatedwithasingleuserdiagram.
TheGlobalEventLogViewerisaspecialversionoftheEventLogViewerused
primarilytodisplayhighpriorityeventsandalarmsforyourentiresystem.The
GlobalEventLogViewerisnotassociatedwithanysingleuserdiagram;theevent
informationitdisplaysiscommon,orglobal,totheentiresystem.

Using the Data Log Viewer

UsetheDataLogViewertoviewsystemdatastoredinthedatabase.TheDataLog
Viewerdisplayshistoricaltrenddata(fromdatarecorders)andwaveformdata
(fromwaveformrecorders).
YoucanselectanydatadisplayedinaDataLogViewerandplotitasagraphor
copyittoanotherapplication(forexample,MicrosoftExcel)whereyoucan
performadvancedcalculationsorincludeitinareport.

NOTE
See Querying the Database on page 130 for information on log viewer configuration.

Displaying a Data Log Viewer window

ClickonanyDataLogViewerobjectinyouruserdiagram.TheDataLogViewer
isdisplayed.

2007 Schneider Electric. All rights reserved.

Page 87

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

EachDataLogViewerdisplaysdataasatableofcolumnsandrows.Eachlabeled
columncontainsasingletypeofdataandeachnumberedrowrepresentsasingle
datarecord.
YoucanselectdatadisplayedinaDataLogViewerandplotitasagraph.
Plotting a range of data from the Data Log Viewer
1.

Highlightthecellscontainingthedatathatyouwanttoplot.Therangeofdata
canbeselectedinoneofthreeways:
Tographtrendsforallparametersoveraparticulartimespan,selecta
groupofrows.
Tographthetrendforaspecificparameterusingallavailablerecords,select
theentirecolumn.
Tographmultipleparametersoveraspecifictimespan,clickonthefirstcell
inthedesiredrangethendragtohighlightthelastcelloftherange.

2.

SelectEdit>PlotSelectedDataorclick

TheLogViewPlotterwindowisdisplayed.Thiswindowdisplaysagraphical
representationoftheselecteddata.

NOTE
You can quickly plot a single waveform by double-clicking on its waveform symbol in the Data Log
Viewer.

Copying a selection to another application

1.

Highlightthecellscontainingthedatathatyouwanttocopy.

2.

SelectEdit>Copyorclick

TheselectioniscopiedtotheWindowsClipboard.Switchtoanotherapplication
andpastetheselection.

Using the Event and Global Event Log Viewers

Eventsandalarmsoccurringinyoursystemarerecordedbythemeterand
transferredviaLogInsertertothedatabase.Vistaprovidestwowaystoviewevent

Page 88

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

recordsstoredinthedatabase:theEventLogViewerandtheGlobalEventLog
Viewer.

NOTE
See Using the Query Options on page 130 for information on log viewer configuration.

TheEventLogViewerdisplayseventsandalarmsfromthedevice(s)represented
intheactiveuserdiagram;useittomonitorlowpriorityeventsandalarms
associatedwiththeactiveuserdiagram.TheGlobalEventLogViewerdisplays
eventsandalarmsforyourentiresystem;useittomonitorhighpriorityevents
andalarmsfortheentiresystem.TheGlobalEventLogVieweroperates
independentlyofanyuserdiagram.

NOTE
You can quickly display the user diagram for any device represented in an Event or Global Event Log
Viewer. In the node column, double-click on the node name of an device to display its user diagram.

Displaying an Event Log Viewer window

ClicktheEventLogViewerobjectinyouruserdiagram.TheEventLogVieweris
displayed.

TheEventLogViewerdisplaysloggedeventsinatableofcolumnsandrows.Each
labeledcolumncontainsasinglecategoryoreventdescriptionandeachnumbered
rowrepresentsasingleeventrecord.
Typically,EventLogViewersdisplaythefollowinginformation:
Timestamp:Thisindicatestheeventsdateandtime.
Priority:Thisdeterminestherelativesignificanceoftheevent.Eachtypeof
eventhasanumericvalueassignedtoitthatrepresentsitsrelativeprioritylevel.
SeeAlarmingOptionsonpage 157formoreinformation.

2007 Schneider Electric. All rights reserved.

Page 89

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Cause:Thisisthelabelandvaluedescribingthecauseoftheevent.Forexample,
ifthelabelisSetpoint#1andthevalueisActive,thentheeventwascaused
bysetpoint#1changingtoanactivestate.
Effect:Thisisthelabelandvaluedescribingtheeffectoftheevent.Forexample,
iflabelisRelay#1andthevalueisForcedOn,thentheeffectoftheevent
wastoforcerelay#1on.
Ack_time:Thisisthedateandtimethatanalarmwasacknowledged.Anyevent
withaprioritylevelthatexceedsthealarmthresholdappearshighlightedinred
untilthealarmisacknowledged.
Whenanalarmoccurs,Vistacannotifyyouinseveralways:abeepingsound,a
flashingtitlebar,amessagebox,oracustomsound.Ifyouhavesufficientsecurity
clearance,youcanacknowledgealarms.

NOTE
Because Event Log Viewers are associated with a single user diagram, they only update and alarm when
the user diagram is open. All Event Log Viewers need to be re-opened if a diagram is closed or the
software is shut down.

Displaying the Global Event Log Viewer

SeeAddingaGlobalEventLogVieweronpage 129formoreinformationonthe
GlobalEventLogViewerorhowtoaddittoyoursystem.
SelectGlobalEventViewerfromtheWindowmenu.TheGlobalEventLogViewer
isdisplayed.

YoucanusetheGlobalEventLogViewerinthesamewayyouusetheindividual
EventLogViewers,althoughoneimportantdistinctionbetweentheGlobalEvent
LogViewerandtheindividualEventLogViewersisallusersshareasingleGlobal
EventLogViewer.Ifoneuserdeletesit,theGlobalEventLogVieweris
automaticallydeletedfromallworkstations.OnlyauserwithSupervisorlevel
accesscandeleteaGlobalEventLogViewer.

CAUTION
We recommend that you do not delete the Global Event Log Viewer. If the (configured) Global Event Log
Viewer is deleted, a new one must be created and configured.

Page 90

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

NOTE
You can temporarily hide the Global Event Log Viewer by deselecting Show Global Event Viewer on the
View menu. You are not notified of any alarms while the Global Event Log Viewer is hidden.

Acknowledging Alarms
EverytypeofeventthatoccursintheIONsoftwarehasaprioritizedvaluethat
identifiesitsrelativesignificanceonascaleofzeroto255.Vistaidentifiesanyevent
withapriorityof128(default)orgreaterasanalarm.
Bydefault,Vistaplaysabeeptoannunciateaneventwithaprioritybetween128
191,andabeepcombinedwithaflashingdisplaytoannunciateaneventwitha
prioritybetween192255.(Youcanconfigureamessageboxtodisplay.)Theevent
recordishighlightedinred,andidentifiedundertheack_timecolumnas
ALARM.Thecause_valuecolumnliststhesourceofthealarm,andthe
effect_valuecolumndescribestheevent.

Whenyouacknowledgeanalarm,Vistarecordsthetimethealarmwas
acknowledged(intheack_timecolumn)andyouruserID(intheuser_name
column).

NOTE
In some cases, your login access may not be sufficient to acknowledge an alarm; for example, a critical
alarm may require Supervisor access. This is a user-configurable option. See Alarming Options on
page 157 for more information.

Acknowledging an alarm
1.

SelectEdit>AddGlobalEventLogViewer.Thisdisplaysallalarmevents.
YoucanalsodragoutanEventLogViewerobjecttoqueryforcertainevents.

2.

IntheEventLogViewerorGlobalEventLogViewer,dooneofthefollowing:
Toacknowledgeasinglealarm,clickonthewordALARMinthe
ack_timecolumnorhighlighttherowcontainingthealarm.
Toacknowledgeallalarmstodate,clickontheack_timecolumnheading.
Aconfirmationboxappears,askingifyouwanttoacknowledgetheselected
alarm(s).

3.

SelectYestoacknowledgethealarm(s)orNotocancel.

Ifyouacknowledgethealarmbutdonothavesufficientsecurityclearance,the
alarmremainsunacknowledgedandthemessageInsufficientAuthorization
appearsinthestatusline.

2007 Schneider Electric. All rights reserved.

Page 91

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Ifyouarenotreadyorabletoacknowledgeanalarm,youcansilenceituntilitcan
beacknowledged.SelectOptions>SilenceOutstandingAlarmstosilencealarms.

NOTE
Acknowledging an alarm does not change the operating conditions that caused the alarm. You must
ensure that the cause is corrected to remove the alarm condition.

Controlling System Functions

Althoughmostdiagramobjectsdisplaydatacommunicatedfromanode,youcan
usecontrolobjectstosendcommandsfromVistatoanode.

Using control objects

Eachcontrolobjectinyouruserdiagramisconfiguredtoperformasingle
function.Whenyouclickacontrolobject,itperformsthespecifiedfunction.For
example,youcouldclickacontrolobjecttoclearanenergyaccumulator,togglea
relay,resetacounter,oradjustthevalueofananalogoutputdevice.
Thedefaultappearanceofacontrolobjectdependsonthefunctionithasbeen
configuredtoperformBoolean,pulseornumeric.

Boolean

Pulse

Numeric

Regardlessoftheirappearance,allcontrolobjectsareusedthesamewaytouse
acontrolobject,clickit.

NOTE
You can configure the message, appearance and access level of control objects. See Customizing the
Action for a Control Object on page 154 and Customizing the Display of a Control Object on
page 152 for more information.

Whenyouclickonthecontrolobject,oneofthefollowinghappens:
Vistaperformsthespecifiedactionimmediately
Vistadisplaysaconfirmationmessage.ClickYestoproceedorNotocancelthe
operation.
Vistarequestsapassword.TypeyourlogonpasswordthenclickOKtoproceed.
Dependingonthefunction,adialogboxrequestingthemeterpasswordmayalso
appear.Ifso,typethemeterpasswordthenclickOKtoproceed.

Page 92

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Plotting Logged Data

ThissectiondescribeshowtouseandcustomizetheLogViewPlotter.Whenyou
plotaselectionofloggeddata,youcanviewitasagraphicalrepresentationin
VistasLogViewPlotterwindow.UsingtheLogViewPlotter,youcangraphically
showtrendsinnumericdata,displayloggedwaveforms,displayphasor
diagrams,andperformharmonicsanalysisonwaveformdata.Youcanalsoplot
voltagedisturbancesrecordedbytheIONSag/Swellmoduleandcomparethemto
industrystandardvoltagetolerancecurves(suchastheCBEMA/ITIcurve).

NOTE
You can copy information displayed by Vista Log Viewers to the Windows Clipboard and paste it into
other Windows applications.

The Log View Plotter

TheLogViewPlotterisaVistawindowthatdisplaysplotteddata.

Plotting logged data

1.

Selectdatafromadatalogviewer:
Tographtrendsforallparametersoveraparticulartimespan,selecta
groupofrows.
Tographatrendforaspecificparameterusingallavailablerecords,select
anentirecolumn.

2007 Schneider Electric. All rights reserved.

Page 93

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Tographmultipleparametersoveraspecifictimespan,selectthefirstcellin
thedesiredrangeanddragtohighlighttothelastcelloftherange.
2.

SelectEdit>PlotSelectedDataorclick

VistaplotsthedataanddisplaysitintheLogViewPlotterwindow.
TheLogViewPlotterwindowgraphicallydisplaystheselecteddataonthePlot
Displaytab.Dependingonthetypeofdataselected,theLogViewPlottermayalso
offeraHarmonicsAnalysistabandaPhasorDiagramtab.
Inallcases,theLogViewPlotteroffersadditionalinformationintwofloating
boxes:thelegendboxandtheCalculationswindow.

The Legend Box

Eachlineorbarinthegraphisrepresentedbyapatternofthesamecolorinthe
legendbox.Ifthelegendisnotdisplayed,youcanselectitontheGraphOptions
dialog.
Click on the curve sample in the legend
to select its equivalent in the graph

Displaying the legend box

1.

RightclickonthebackgroundoftheLogViewPlotterwindow.

2.

SelectGraphOptionsinthepopupmenu.

3.

SelectShowlegendthenclickOK.

The Calculations Window

TheLogViewPlottercalculatesseveralvaluesforeverylineorbarinthegraph.
YoucanviewtheresultsofthesecalculationsinthefloatingCalculationswindow.
TheCalculationswindowupdatesautomatically,displayingarangeofcalculated
valuesbasedonthecurrentlyselectedparameter.Bydefault,allvaluesdisplayed
intheCalculationswindowarecalculatedfromthefirstparameter.Toviewthe
calculationsforadifferentparameter,selectthelineorbaryouwant.
Forexample,toviewthecalculationsforacurveonthePlotDisplaytab,clickon
thecurvelineinthegraphoronitslinepatterninthelegend.Whenyouclicka
differenttab,theCalculationswindowdisplaysthevaluesforthattab.

Page 94

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Plot Display tab

Harmonics Analysis tab

Phasor Diagram tab

Displaying the calculations window

1.

RightclickonthebackgroundoftheLogViewPlotterwindow.

2.

SelectGraphOptionsfromthepopupmenu.

3.

SelectShowcalculationsthenclickOK.

Calculations Window Parameters

TheCalculationswindowupdatesautomatically,displayingthefollowingvalues
forthecurrentlyselectedcurve:
Value Label
Cursor 1

The timestamp and the y-value of the selected curve at Cursor 1.

Cursor 2

The timestamp and the y-value of the selected curve at Cursor 2.

Delta C

The time difference between Cursor 1 and Cursor 2, and the difference between the
y-values at Cursor 1 and at Cursor 2.

Min

The minimum value of the selected curve between the two cursors.

Max

The maximum value of the selected curve between the two cursors.

dpeak

The maximum peak-to-peak value of the selected curve between the two cursors
(Max-Min).

Avg

Description

The average value of the selected curve between the two cursors.

RMS 1

The root mean squared value of the selected curve between the two cursors.

Int(H) 1

The integration of the selected curve between the two cursors with respect to time in
hours (for example, if the curve is in kW, the information will be displayed in kWh.)

The last three values (Avg, RMS, Int(H)) on the Calculation window are only available on plots where
the x-axis represents time. They are not offered on other types of plots (for example, CBEMA plots).

Bothnumericdataandwaveformdatacanbeplottedinthesamegraph.On
waveformplots,thetriggertimeisrepresentedbyaredverticalline.

2007 Schneider Electric. All rights reserved.

Page 95

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Viewing the Plot Display Tab

ThePlotDisplaytabistheLogViewPlottersprimarydisplay.ThePlotDisplay
tabdepictsthespecifiedparametersascurvesagainstagraph.

Eachparameterisplottedinadifferentcolor.Thelegendidentifiesthecolorof
eachcurveintheselection.Clickonacurvetoselectitorrightclickonittodisplay
additionaloptions.Thetimestampatthetopofthetabidentifiesthefirstpointin
theselectedcurve.
Theverticalaxis(yaxis)representsthespecifiedrange;thehorizontalaxis(xaxis)
representstime.Vistaautomaticallyadjuststhescaleoftheyaxisandthexaxisto
accommodatethelargestparameter(s)intheselection.Rightclickoneitheraxisto
changethescaleofitsproperties;rightclickontheaxisnumberstochangetheir
format.
Thetimeunitindicatorinthelowerrightcorneridentifiesthetimescaleofthe
xaxis(forexample,hindicatesanhourlyscale).Possibletimescaleunitsinclude
months,days,hours,minutes,andseconds.

Using the Cursor Lines

ThereareverticalcursorlinesateitherendofthecurvesintheLogViewPlotter.
Bydefault,Cursor1islocatedontheleftmostpointoftheselectedcurveand
Cursor2ontherightmostpoint.Dragthesecursorlinestodefinethestartandend
pointsusedbytheCalculationswindow.

Page 96

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Todefineanewstartpoint,clickonCursor1anddragitalongthecurvetothenew
startpoint.YoucanrepeatthisprocedurewithCursor2todefineanewendpoint.
Youcanalsousethearrowkeystomovetheactivecursorleftorright.Theactive
cursorisidentifiedbyasmallboxthatappearswherethecursorlinemeetsthe
curve.UsetheTabkeytoswitchtheactivecursorbetweenCursor1andCursor2.
Asthecursorlinemovesfrompointtopointalongthecurve,theinformationin
theCalculationswindowisupdated.YoucannotdragCursor1pastCursor2or
viceversa.

Changing Graph Options

WhenusingtheLogViewPlotter,youcanadjustthegraphoptionstochangethe
titleofagraphorthewaydataisdisplayed.
Changing the graph options
1.

RightclickanywhereinthegraphbackgroundthenselectGraphOptions.
TheGraphOptionsboxisdisplayed.

TypethenameyouwantintheTitlebox;thisnameappearsinthetitlebar
oftheLogViewPlotterwindow.ThegraphistitledLogViewPlotterby
default.
SelectorcleartheShowlegendandShowcalculationscheckboxestoshow
orhidethelegendboxandCalculationswindow.
SelectAlignTriggerstoalignthetriggertimesofallwaveformsinthe
graph.(Whenmultiplewaveformsareplotted,theirtriggertimesarenot
alwayscorrelated.)
SelectSeparatecurvesverticallytodisplayeachcurveseparately.
2.

ClickOKtosaveyourchanges.

NOTE
The graph options System Frequency and # of cycles for harmonics are covered in Calculating
harmonics using more than one cycle on page 101.

2007 Schneider Electric. All rights reserved.

Page 97

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

De-indexing Parameters and Specifying Y-offsets

Ifyouareplottingmultipleparameterswithdifferentmagnitudes,thelower
magnitudevaluesmaybedifficulttoseeinthedefaultgraph.Vistaallowsyouto
indexanyparametertoadifferentaxisthatcanbescaledandoffsetindependently
fromtheotheraxes.

Thenewaxisautomaticallyassumesascaleappropriatefortheselected
parameter.Inthisway,youcanplotparametersofdifferentmagnitudesonthe
samegraph(suchasvoltageandcurrent).
De-indexing a parameter, or offsetting a parameter on the y-axis
1.

Rightclickonthegraphbackgroundtodisplaythepopupmenuand
highlightthecurveyouwanttochangeonthelistatthebottomofthismenu.
Thisrevealsthecurvessubmenu.(Youcanalsoaccessthesubmenudirectly
byrightclickingontheparametercurveoronitscurvesampleinthelegend.)

2.

SelectOptionsfromthesubmenu.TheCurveOptionsdialogboxisdisplayed.

3.

Chooseoneofthefouraxisoptionsfortheselectedparameter.Theaxisis
indicatedbythelocationofthetickmarks.
SpecifyaYoffsetifrequired.Thisshiftstheselectedparameteruptheyaxis(or
downforanegativenumber)bytheamountyouspecify.

4.

Page 98

ClickOK.Anewaxisappearswithadefaulttitleandascaleappropriateforthe
selectedparameter.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Thescaleofthedefaultaxismayalsobeadjustedtoaccommodatetheremaining
curves.Aparameterhasanasteriskafteritinthelegendifithasbeenoffset.
Repeatthesestepsforeachparameterthatyouwanttodeindexfromthedefault
axis.Youcanassignmorethanoneparametertoanaxisandthescaleadjusts
accordinglytoincorporateeachnewparameter.Forexample,ifyouhaveplotted
threevoltageparametersandthreecurrentparameters,youcanselectthecurrent
curvesandassigneachofthemtoanothercommonaxis,leavingthethreevoltage
curvestosharethedefaultaxis.

Displaying Power Factor Data

Ifyouhaveplottedpowerfactordata(fromHistoricallogs)intheLogView
Plotter,youcanimprovethedisplaytoavoiddiscontinuitybysettingthevertical
axistoPowerFactorDisplay(100,+100).
Setting any vertical axis for power factor display
1.

Rightclickontheverticalaxisorrightclickonthegraphbackgroundand
selecttheaxisafteryouhaveplottedthepowerfactordata.

2.

SelectPowerFactorDisplayfromthepopupmenu.Acheckmarkappears
besidetheoptiontoindicatethatitisselected.

Youcanplotothernonpowerfactordataonthesamegraph;however,youshould
notplotthenewdataonthesameaxisasthepowerfactordata.Deindexthenew
dataonaseparateaxisasdescribedinDeindexingaparameter,oroffsettinga
parameterontheyaxisonpage 98.

Displaying a Curves Data Points in a Table

AfteryouplotdataintheLogViewPlotter,youcanselectacurveanddisplayits
datapointsinatable.
Displaying the data points of a curve in a table
1.

2007 Schneider Electric. All rights reserved.

RightclickonthecurvelineandselectDatafromthepopupmenu.Thedata
pointsaredisplayed.

Page 99

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

TheXcolumnliststhexaxiscoordinatesandtheYcolumnliststheyaxis
coordinates.Thefirstcolumn(#)assignsanumbertoeachsetofpoints.
2.

SelectFormattochangethenumberofsignificantdigitsdisplayedintheXand
Ycolumnsortochangethewidthofthesecolumns.
Widthdefinesthenumberofcharactersthecolumncandisplay.Precision
definesthenumberofsignificantdigitsdisplayed.

3.

ClickCopyonthemenubartocopytheXandYcolumnstotheclipboard.This
letsyoupasteacopyofthetableintoanotherapplication,suchasaspreadsheet
programoratextfile.

NOTE
The Log View Plotter can only display one data table at a time. If you want to display tabular data for
another curve (from the same graph or a different one), you must first close any open data window.

Viewing the Harmonics Analysis Tab

Ifanyoftheparametersyouhaveplottedisawaveform,youcandisplaya
histogramofthesignalsharmoniccontentbyselectingtheHarmonicstabonthe
LogViewPlotterwindow.Theresultinghistogramshowstheharmonicsforall
waveformsintheplot.

Page 100

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

NOTE
The cycle used is the first full cycle to the right of Cursor 1on the Plot Display tab.

Thetotalharmonicdistortion(THD),KfactorandCrestfactorvaluesforthis
waveformaredisplayedintheCalculationswindow.
Toviewthecalculationsforanotherparameter,clickonitinthegraphoronits
curvesampleinthelegend.TheCalculationswindowupdatesautomatically.The
currentlyselectedparameterisindicatedabovethecalculations.
Bydefault,theharmonicsarecalculatedusingonecycle.Youcanincreasethe
numberofcyclesbyanypoweroftwocycles(i.e.2,4,8,16,32or64)uptothe
maximumnumberofcyclesavailableforthewaveform.
Calculating harmonics using more than one cycle
1.

RightclickonthebackgroundofthegraphingareathenselectGraphOptions.
TheGraphOptionsboxisdisplayed.

2.

Selectthenumberofcyclesoverwhichharmonicscalculationsaretobe
performedfromthe#ofcyclesforharmonicslist.

3.

SelecttheappropriatefrequencyintheSystemFrequencybox,ifthewaveform
youareanalyzingcamefromasystemwithafrequencyotherthan50Hzor
60Hz.(Forexample,ifthewaveformwascapturedfroma400Hzsystemusing
a3710ACM,youwouldspecify400Hzinthisbox.)

NOTE
The Harmonics Analysis tab is only available for waveform records. Vista does not perform a harmonics
analysis for trend data or for waveforms with less than eight samples per cycle. You cannot display the
harmonics of more than 16 parameters at a time.

Harmonic Data in a Table

Youcandisplaytheharmonicdatainatable.

2007 Schneider Electric. All rights reserved.

Page 101

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Displaying harmonic data in a table

1.

SelectandplottheloggeddatayouwanttoviewthenselecttheHarmonic
Analysistab.

2.

Rightclickonabar(oronitscurvesampleinthelegend)andselectData.
Awindowappearslistingeachharmonicnumberandthemagnitudeofeach
harmonicforeachparameter.

Thefirstcolumnnumberstherows.TheXcolumnliststheharmonicsnumber
andtheY1,Y2,Y3...columnslisttheharmonicvaluesforeachbarinthe
harmonicshistogram.RowswheretheXvalueisnotaninteger(i.e..5,1.5,2.25)
containsubharmonicvalues.
3.

ClickFormatonthemenubartochangethenumberofsignificantdigits
displayedintheXandYcolumnsorthewidthofthesecolumns.Widthdefines
thenumberofcharactersthecolumncandisplay.Precisiondefinesthenumber
ofsignificantdigitsdisplayed.

4.

ClickCopyonthemenubartocopythecolumnstotheclipboard.Thisallows
youtopastethedataintoanotherapplicationsuchasatextfileoraspreadsheet.

Viewing the Phasor Diagram Tab

Ifyouhaveplottedwaveformsforallthreevoltagesand/orcurrentsofyour
system,youcanviewthisinformationasaphasordiagram.Thephasordiagram
graphicallydisplaysthethreephases(voltagesand/orcurrents),showingtheir
relativemagnitudesandangles.
Youcanuseaphasordiagramtoevaluateimportantaspectsofyourpowersystem
suchasvoltagebalance,perphaseloading,andtypeofload(orgenerator
operatingmode).AphasordiagramalsoprovidesaneasywaytoidentifyPTor
CTwiringproblems.

NOTE
The timestamp at the top of the Phasor Diagram tab is based on the time of Cursor 1 on the Plot Display
tab.

Todisplayaphasordiagram,selectthePhasorDiagramtabfromtheLogView
Plotterwindow.

Page 102

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

ThePhasorDiagramandcalculationsarederivedfromaonecyclewindow
startingatCursor1onthePlotDisplaytab.Themagnitudeandangleofthe
selectedphaseisdisplayedintheCalculationswindow.

NOTE
The Log View Plotter conforms to the convention where all phasors are plotted with respect to V1 (always
at 0) and rotate in a positive counter-clockwise direction. On a balanced power system, all three phases
should appear 120 degrees apart.

TheLogViewPlottercalculatesthesymmetricalcomponentsofyourpower
systemthepositive,negative,andzerosequencesrelativetothefirstphase
forthecycleselected.Ifyouhaveplottedwaveformsforthreevoltagesand/or
currents,youcanaccesstheirsymmetricalcomponentcalculations.Toproduce
correctsymmetricalcomponents,thewaveformsmusthavebeenplottedinthe
correctorder(forexample,V1,V2,V3notV1,V3,V2).
Toeditaphasordisplayedonaphasordiagram,rightclickonaparameterinthe
legendtodisplayapopupmenuwhereyoucanchangethephasorscoloror
deletethephasorfromthediagram.

Symmetrical Components
Theanalysisofanunbalancedsystem,suchasdeterminingtheeffectsofasystem
fault,ismadesimplerbyusingsymmetricalcomponents.Symmetrical
componentsareamathematicaltoolthatallowsanysystemofthreeunbalanced
phasorstoberepresentedbythreebalancedphasorsystems.Thetotalcurrentor
voltageinanyphasewireisexpressedasthesumofthreebalanced,threephase
components.
PositiveSequenceComponents(1)theseconsistofthreephasorsthatareequalin
magnitudeanddisplacedfromeachotherby120andhavethesamephase
sequenceastheoriginalphasors.

2007 Schneider Electric. All rights reserved.

Page 103

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

NegativeSequenceComponents(2)theseconsistofthreephasorsthatareequal
inmagnitudeanddisplacedfromeachotherby120andhavethephasesequence
oppositetothatoftheoriginalphasors.
ZeroSequenceComponents(0)theseconsistofthreephasorsthatareequalin
magnitudeandwithzerophasedisplacementfromeachother.
IftheoriginalphasorsofvoltagesareVa,Vb,andVc,thenthesymmetrical
componentswouldbeasfollows:
Va=Va1+Va2+Va0
Vb=Vb1+Vb2+Vb0
Vc=Vc1+Vc2+Vc0
Thesymmetricalcomponentsfunction,asimplementedinsidesomeIONmeters,
isusefulforsteadystateanalysis(unbalance),sincetheparametersareupdated
everysecond.However,whendeterminingthesymmetricalcomponentsduringa
fault,percycleanalysisisrequired.Forthisapplication,youdonotneedrealtime
updatesfromthemeter,becauseyouareonlyinterestedintherelativelyshorttime
before,during,andafterasystemfault.Thisinformationiscontainedinthe
waveformsrecordedwhentriggeredbyadisturbance.
Viewing symmetrical components

Page 104

1.

FromawaveformDataLogViewer(suchasWaveforms/SequenceofEvents),
selectallthreephasesofafault(voltageorcurrent).

2.

SelectEdit>PlotSelectedData.

3.

DragtheCursorandmoveittothelocationofthefault.

4.

ClickonthePhasorDiagramtabtoviewtheSymmetricalComponentsinthe
Calculationwindow.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Adding Parameters to a Log View Plotter

OnceyouhavecreatedagraphandtheLogViewPlotterwindowisvisible,you
canaddadditionalparameterstothegraphbycopyingandpastingthemintothe
graph.Theseparameterscanbecopiedfromthesamedatalogviewer,adifferent
datalogviewer,orfromadifferentWindowsapplicationsuchasMicrosoftExcel.
Thexandyaxesareautomaticallyrescaledtoaccommodatethenewparameters.
Whenaddingwaveformstothelogviewplotter,usetheAlignfeaturetocorrelate
alloftheirtriggertimes.SeeCustomizingGraphandLegendOptionson
page 112formoreinformation.

Adding Data from a Data Log Viewer

Youcanaddadditionalparametersfromanydatalogviewerconfiguredto
providecompatibletimebaseddata.Anyaddedparameterisplottedusingthe
samexaxisusedbytheexistingcurves.Toavoidconfusionensurethatthecolumn
youselectedforyourxaxisinthedatalogviewer(fromwhichyouareadding
data)containsthesameparameter(typicallyatimestamp)astheoriginaldatalog
viewer.
Adding additional parameters from a data log viewer
1.

Selecttherangeofcellsyouwanttoplot.Ensurethatitcontainsthesametype
ofinformation(timestamps)asthedataalreadybeingplotted.

2.

SelectEdit>Copy.

3.

ClickonthetitlebaroftheexistingLogViewPlotterwindowthenselectEdit>
Paste.
Theparametersyouselectedareaddedtothegraph.

Ifyouwanttoplotwaveformsonthesamegraphashistoricaldata,thehistorical
datashouldoriginatefromhighspeeddatarecordersandspanashorttimerange,
typicallyafewwaveformcycles(<1second).

Adding Events from an Event Log Viewer

Youcanaddeventstoawaveformortrendplot.Thisisusefulforcomparing
abnormalitiesofthewaveformortrendshapewithanycorrespondingeventsthat
happenedinthesametimeperiod.
Adding events from an Event Log Viewer to a waveform
1.

Selecttherow(s)youwanttoaddintheEventLogViewer.

2.

SelectEdit>Copy.

3.

ClickonthetitlebaroftheexistingLogViewPlotterwindowthenselectEdit>
Paste.
Thecopiedeventrecordsareaddedtothegraph.

2007 Schneider Electric. All rights reserved.

Page 105

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

EacheventisrepresentedintheLogViewPlotterasadiamondsymbol.A
diamondsymbolisaddedtothelegendanddiamondsymbolsappearatthe
appropriateareasalongthetopofthediagram.
Diamond symbols representing
events appear in the legend

Diamond symbols representing events

appear at appropriate points along
the top of the diagram

Pointtoadiamondsymboltodisplayadescriptionoftheeventinthestatusbarat
thebottomofthescreen.

Adding Data from a Spreadsheet or Text File

Youcanselectdatafromaspreadsheetortextfileandpasteitintoanexisting
graph.Thisisusefulifyouwanttocomparetrendsfromdifferenttimes,
waveformsshowingdifferentsystemevents,andotheranalysisapplications.
Ensurethatthefirstcolumnofdatainthespreadsheetortextfileisthesametype
asthefirstcolumninthedatalogviewerfromwhichthelogplotoriginated.In
particular,fortimestamps,makesurethecompletetimestampiscontainedina
singlecolumnandthatitusesthesamedateandtimeformatasdefinedinthe
WindowsControlPanel.Ifthedateportionofthetimestampisinonecolumnand
thetimeisinanother,oriftheformatisdifferentinanyway,thedatacannotbe
pastedintotheLogViewPlotter.
Whenyoupastedataintoagraph,frombothspreadsheetsandtextfiles,theLog
ViewPlotterinterpretsthefirstrowofdataintheselectionasaheading.Thefirst
rowinyourselectionisusedtolabeltheparameterinthelegend.So,ifthefirstrow
isnotalreadyusedforcolumnheadings,insertarowandtypeinthelabelyou
wanttoappearintheLogViewPlotter.

First row is a heading

Page 106

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Tocopydatafromatextfile,thetextfilemustbeformattedcorrectly.Eachcolumn
inthetextfilemustbeseparatedbyatabandtheremustbeahardreturnatthe
endofeachrow.

The first row is

a heading

The date and time are separated by the @

symbol or a space

Columns are separated

by a tab

A hard return
begins a new row

Adding data to a graph from a spreadsheet or text file

1.

Openthespreadsheetortextfile.

2.

Selecttherangeofvaluesyouwanttoplot,includingthefirstcolumnandthe
firstrow.Youcanalsoincludeothercolumnsinyourselection.

3.

SelectEdit>Copy.

4.

ClickonthetitlebaroftheLogViewPlotterwindowthenselectEdit>Paste.
Theparametersyoucopiedandpastedareaddedtothegraph.Theaxisscales
areadjustedautomaticallytoincludethenewdata.

Youcandefineatriggerforwaveformrecordscontainingtimestampswherethe
recordsarecopiedfromotherapplications.Simplyaddanexclamationmarktothe
endofthetimestamptoindicatethatitisthetriggertime.Forexample,the
exclamationmarkattheendof22/05/1998@02:00:41.035PM!indicatesthatthe
triggeroccurredatthistime.

NOTE
Remember that the first row in your selection is used as a label rather than plotted as data.

2007 Schneider Electric. All rights reserved.

Page 107

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Customizing the Log View Plotter

Manydisplayattributesforeachcurvecanbeadjusted.Inmostcases,ifyouright
clickonanareaofthegraph,eitherapopupmenuoradialogboxappearswith
configurationoptions.Unlessotherwisenoted,theoptionsyouspecifyfortheLog
ViewPlotterwindowaresavedandrestoredeverytimeyouplotdatafromthe
originaldatalogviewer.Ifyouplotdatafromadifferentdatalogviewer,itsgraph
willhaveitsownoptionalsettings.

Customizing an Axis
AlthoughtheLogViewPlotterautomaticallyscalesanaxistoaccommodateits
associatedparameters,youcanchangethescale.Youcanalsoaddatitle,change
thecolor,orreconfigurethetickmarksofanyxaxisoryaxis.Insomecases,you
cancustomizethegridaswell.
OnceyouhaveplotteddataintheLogViewPlotter,usetheinstructionsthat
followtocustomizetheaxisorgridlines,changeanaxislabelsformatoraddan
axistitle,orchangethefontusedonallaxes.
Configuring an axis
1.

Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight
theaxisfromthemenutorevealthesubmenu.Youcanalsoaccessthesub
menudirectlybyrightclickingontheaxisline.

2.

SelectAxisPropertiesfromthesubmenu.Adialogboxisdisplayed.

MakingchangesintheFromandToboxesadjuststheaxisrange.
ModifyingthevaluesfortheMajoreveryandSubdividedbyboxes
adjuststhefrequencyofmajorandminorticksrespectively.
SelectingorclearingtheMajorandMinorcheckboxesturnsgraph
gridlinesonoroffaccordingly.
ClickingtheStyle...buttonsallowschangestothelinestyleorwidthof
majorandminorgridlines.
SelectingthecheckboxforLogarithmicscaleenablesthelogarithmicscale
option.

Page 108

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

ClickingLine...allowsyoutochangethelinestyleorthewidthoftheaxis.

3.

ClickOKtosaveyourchanges.

NOTE
The axis range and the frequency of the major ticks are not stored in the diagram but are recalculated
for every new plot.

Changing the color of an axis or the gridlines

1.

Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight
theaxisfromthemenutorevealthesubmenu.Youcanalsoaccessthesub
menudirectlybyrightclickingontheaxis.

2.

SelectAxisColor,MajorGridColor,orMinorGridColorfromthesubmenu.
Adialogboxappearsdisplayingapaletteofcolors.

3.

Selectthecoloryouwant.Todefineacustomcolor,clickDefineCustomColors
formoreoptions.

4.

ClickOKtosaveyourchanges.
Theaxisorthemajororminorgridlineschangetothecoloryouselected.

Changing the format of the axis labels or adding an axis title

1.

Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight
theaxisfromthemenutorevealthesubmenu.YoucanalsoaccesstheAxis
Labelsdialogboxdirectlybyrightclickingontheaxislabels.

2.

SelectAxisLabelsfromthesubmenu.
TheAxisLabelsdialogboxisdisplayed.

3.

Selecttheformatinwhichyouwanttheaxislabelstoappear.
Decimalisusedbydefault(forexample,.01,.02,.03)butifthelabelsaretoolarge
(ortoosmall),youcanselectScientific(1.0x102,2.0x102,3.0x102...)or
Engineering(1m,2m,3m...).

4.

2007 Schneider Electric. All rights reserved.

Selectorchangetheaxistitle.

Page 109

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Fortimebasedplots,thedefaultxaxistitleissifthetimestampsofthe
displayeddataspansanumberofseconds,mnforminutes,hforhours,d
fordays,mformonths.(ThisappliestothePlotDisplaytabonly.)
Fornontimebasedplots(CBEMAorharmonics),youcanchangethetitle.Select
theTextoptionandtypethetitleintheeditbox.Thetitlemustbeninecharacters
orless.
5.

ClickOKtosaveyourchanges.

NOTE
If the first column of the source data includes a space or @ sign, then the Log View Plotter assumes time
on the horizontal axis and automatically determines the units based on timestamp information. The axis
title is updated whenever the window is updated.

Changing the font used on all axes

1.

RightclickanywhereinthegraphbackgroundandselectGraphFont.

2.

Specifyanyfont,style,size,effectsorcoloroptionsthatyouwanttouseforthe
axeslabelsintheFontdialogbox.

3.

ClickOKtosaveyourchanges.

Customizing Curve Style

Whendisplayingmultipleparameters,Vistadistinguisheseachparameterusing
color.Eachparameterislistedinthegraphlegendaccompaniedbyasampleofits
associatedcurve.Thecolorofacurvecanbechangedonceyouhaveplotteddata
intheLogViewPlotter.
Ifcolorisnotenoughtodistinguishonecurvefromanotherforexample,ifyou
plantoprintthegraphonablackandwhiteprinteryoucanchangethecurve
styleonceyouhaveplotteddataintheLogViewPlotter.
Bydefault,eachcurveisshownbyathinlinethatconnectseachpointofdata.
Youcancustomizethestyleofeachcurveindependentlyandshoworhidethe
coordinatesofeachdatapoint.
Bydefault,harmonicsaredisplayedasseriesofbarsinahistogram(orbar
graph).Youcandistinguishbetweenparametersbycustomizingthedisplay
styleofeachparameter.Displayoptionsincludebartype,hatching,andwidth
andcolor.
Usethefollowinginstructionstocustomizecurvestyles,barstyles,andcurve
colors.
Changing the style of a curve for the plot display tab
1.

Page 110

Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight
thecurvefromthemenutorevealthesubmenu.Youcanalsoaccessthesub
menudirectlybyrightclickingontheparametercurve,oronitsentryinthe
legend.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

2.

SelectCurvePropertiesfromthesubmenu.TheCurveStyledialogboxis
displayed.

SelectthetypeofcurveyouwantfromtheTypelist.Vistaofferssevencurve
types:asimpleline,alinewithsymbols,ascatterplotofmarkers,horizontalor
verticalbars,or3Dhorizontalorverticalbars.
TheSplineandFillAreacheckboxesareselectedbasedonthetypeofcurve
selected.
SelectSpline(forLineorLine+Symboltypes)ifyouwantthelinethat
connectseachpointtobeasmoothcurve.Ifyouleaveitunchecked,each
pairofpointsisconnectedbyastraightline.
SelectFillArea(forLinetype)tofilltheareaunderthecurvewiththeline
color.Clearthecheckboxtoleavetheareaunderthecurvetransparent.
TheMarkersectionappearsforLine+SymbolandScatteredtypesoflines.
Youcanspecifytheshape,size,andstyleofthemarkerusedforthepoints.
TheStyle...optionsapplyonlytogeometricshapes(e.g.circles,boxes,
diamonds,etc.).
Foranylinetype,clickLine...tochangethewidthandthestyle(e.g.solid,
dotted,dashed,etc.)oftheline.
Forbargraphtypesadialogopenswhereyoucanspecifythehatching
patternandthewidthofthebars.
3.

ClickOKtosaveyourchanges.

Changing the bar style for the harmonics analysis tab

2007 Schneider Electric. All rights reserved.

1.

Rightclickonthebar(oronitscurvesampleinthelegend)andselectCurve
Properties.TheBarGraphConfigurationdialogboxappears.

2.

Specifythetypeofbartouse.Thisselectionisappliedtoallbarsinthegraph.
TheTypeboxoffersthreebarstyles:Groupbars,DeepbarsandStackedbars.

Page 111

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Group Bars

Deep Bars

Stacked Bars

3.

SelectahatchingstylefortheselectedbarintheHatchingbox.Thisselectionis
appliedtothecurrentlyselectedbaronly.

4.

SpecifyhowwideyouwanteachbartobeintheWidthbox.Thespecifiedwidth
isappliedtoallbarsinthegraph.Thedefaultdependsuponthenumberof
parameters.

5.

ClickOKtosaveyourchanges.

Changing the color of a curve

1.

Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight
thecurvefromthemenutorevealthesubmenu.Youcanalsoaccessthesub
menudirectlybyrightclickingonthecurve,oronitscurvesampleinthe
legend.

2.

SelectCurveColorfromthesubmenu.Adialogboxappearsdisplayinga
paletteofcolors.

3.

Selectthecoloryouwant.Ifyouwanttodefineacustomcolor,clickDefine
CustomColorsformoreoptions.

4.

ClickOK.Thecurvechangestothecoloryouselected.

Customizing Graph and Legend Options

OnceyouhaveplotteddataintheLogViewPlotter,youcanchangethecolorof
thegraphingarea(andthelegend)anddefineafontforthelegend.
Changing the color of the graphing area
1.

RightclickanywhereinthegraphbackgroundandselectBackgroundColor.

2.

IntheColordialogbox,selectthecoloryouwantorclickDefineCustomColors
formoreoptions.

3.

ClickOK.Thegraphingareachangestothespecifiedcolor.

Changing the font used in the legend

1.

Page 112

Rightclickonthebackgroundofthelegend.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

2.

IntheFontdialogbox,specifyanyfont,style,size,effects,orcoloroptionsthat
youwanttouseforthelegendtext.

3.

ClickOKtosaveyourchanges.

Removing Graph Parameters

OnceyouhaveplotteddataintheLogViewPlotter,youcanremoveaparameter
fromthegraph.
Removing a parameter from the graph

2007 Schneider Electric. All rights reserved.

1.

Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight
thecurveyouwanttoremovefromthemenutorevealthesubmenu.Youcan
alsoaccessthesubmenudirectlybyrightclickingonthecurve,oronitscurve
sampleinthelegend.

2.

SelectDeleteCurvefromthesubmenu.Thecurveisdeletedwithoutfurther
prompting.

Page 113

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Overlaying Curves (CBEMA)

OnceyouhaveplotteddataintheLogViewPlotter,youcanoverlayacustom
curveontoyourexistinggraph.ThisisusefulwhenanalyzingdatafromanION
Sag/Swellmodule.TheSag/Swellmodule(availableonsomeIONmeters)
measuresdisturbancesinvoltageandstoresthemagnitudeanddurationofthese
disturbances.WhenthesevaluesarelinkedtoaDataRecordermodule,loggedand
subsequentlyinsertedintotheIONdatabase,theyprovideaseriesofcoordinates
thatcanbeplottedonavoltagetolerancecurve.Avoltagetolerancecurveisoften
usedtocategorizetheseverityofavoltagedisturbance.

NOTE
Most Vista queries are plotted against timestamps (using timestamp as the x-axis); however, any query
that uses the ION Sag/Swell module must be plotted against duration. When plotting sag/swell data,
select Duration as the X-parameter of the Log View Plotter.

Vistaprovidestwocommoncurvesorvoltagetoleranceenvelopesthatcanbe
usedasoverlaysintheLogViewPlotter.Thesecurves(describedbytheIEEE446
standardCBEMA,ITI)defineanupperandalowerboundonthetypesof
disturbanceselectricalequipmentislikelytotolerate.Itplotsdisturbance
magnitudeagainstdisturbancedurationandindicatesatwhatpointsavoltage
disturbanceislikelytodisruptordamageequipment.

TooverlaytheCBEMA/ITIcurve,youshouldfirsthaveadatalogviewerthat
containsthemagnitudeanddurationvaluesfromtheSag/Swellmodule.The
DurationcolumnmustbesetastheXparameterfortheLogViewPlotterit
appearsinblue.TheMagnitudevaluescanbeinanyoneoftheothercolumns.
SeeXParameterforLogViewPlotteronpage 131formoreinformationon
changingtheXparameterforDataLogViewers.

Page 114

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Plotting the magnitude values against the duration values

First,ensurethattheDurationcolumnisspecifiedasyourXparameter.(Itshould
appearblue.)
1.

Selectarangeofcellstobeplottedinthedatalogviewer.

2.

SelectEdit>PlotSelectedData.TheLogViewPlotterwindowappearswith
DurationasthexaxisandMagnitudeastheyaxis.

3.

RightclickonthegraphandselectOverlayCurvefromthepopupmenu.The
OverlayCurvedialogboxappears.

4.

SelectthetextfilecontainingtheCBEMA/ITIcurvedatathatyouwanttooverlay
(fromthe...\config\lvpdirectory).

5.

ClickOpen.Theselectedcurveappearsinthegraph.

Thisprocessautomaticallychangesyourxaxisscaletologarithmic.
YoucanrevieweachpointinyourdataandseewhereitfallsontheCBEMA(or
custom)curve.Pointsnearoroutsidethevoltagetoleranceenvelopeindicate
eventsthatcouldinterruptordamageelectricalequipment.

2007 Schneider Electric. All rights reserved.

Page 115

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Creating and Editing a User Diagram

Thissectionexplainshowtoeditanexistinguserdiagramandhowtocreateanew
userdiagram.Thesectionalsodescribesthediagramobjectsandexplainshowto
addafunctiontoyouruserdiagrambyplacingadiagramobjectintothatdiagram
andlinkingittoadatasource.

NOTE
You must have the appropriate security clearance to edit or create a user diagram. To determine if you
can edit a diagram, select Options > Show Toolbox. If you can select this option, then you can edit a
diagram. Consult your network administrator if you need to change your access privileges.

Opening a User Diagram

Youcanopenanexistinguserdiagram(File > Open)orcreateanewone
(File > New).Ifyouwanttocreatearepresentationofyourentiresystem,youcan
generateanetworkdiagram.
Whenyourightclickcertaintypesofdiagramobjects(suchasagroupingobject)
inEditModeandselectProperties,theOpenDiagramforMeterTemplateoption
appearsundertheActiontab.Thisoptionisusedbydefaulteachtimeanetwork
diagramisgenerated,soeachmetericoninthenetworkdiagramissettoopenthe
defaultdiagramsthatmatchthatmetersconfiguration.

NOTE
Any changes you make to a default diagram affect all other devices using the same diagram.

Creating a new user diagram

IfyouhaveSupervisorlevelaccess,youcancreateanewuserdiagram.Select
File > New.Anew(blank)userdiagramappears.
Toautomaticallygenerateanetworkdiagrambasedondevicesaddedusing
ManagementConsole,seeGeneratingaNetworkDiagramonpage 80.

Saving a User Diagram

Aftereditingauserdiagram,youcansaveyourchanges.Bydefault,Vistapoints
totherootofthe\uddirectorywhenyouattempttosaveanewdiagram.Youcan
createanewfolderwithinthatdirectorytostoreyourcustomizeddiagrams,rather
thanhavingthemstoredinthe\udfolder.

Page 116

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

NOTE
This \ud directory should be located on a networked drive where it can provide multiple users with access
to saved user diagrams.

Dooneofthefollowingtosaveauserdiagram:
SelectFile>Savetosaveaneworexistinguserdiagram.
SelectFile>SaveAs...tosaveanexistinguserdiagramunderanewname.
WhentheSaveNewDiagramboxappears,typeanameforthediagramintothe
FileNameboxthenclickSave.

2007 Schneider Electric. All rights reserved.

Page 117

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Placing Diagram Objects into a User Diagram

DiagramobjectsprovidetheinterfacetoIONregistersinyournetwork.Each
diagramobjectdisplaysasinglepieceofinformationfromsomewhereinyour
powermonitoringnetwork;forexample,asinglenumericobjectdisplaysnumeric
datafromasinglesource.
Ifyouraccounthaspermissiontoedituserdiagrams,youcanseethediagram
objectsrepresentedbyiconsinthefloatingDiagramObjectstoolbox.Ifthetoolbox
isnotopen,selectShowToolboxfromtheOptionsmenu.

grouping object
text object
numeric object

control object
event log viewer
status object

data log viewer

Thissectiondescribesthevarioustypesofdiagramobjectsandexplainshowyou
canuseeachtypetoaddafunctiontoyouruserdiagram.

The Enable Undo Option

TheEnableUndooptionenablesordisablestheundofeatureinVista.Withthis
optionactive,youareallowedtoundoorstepbackwarduptothreetimes.This
featureisenabledbydefault.Ifyoudisabletheundofeature,youlosetheability
toundoanypreviouschanges.Youcannotenablethefeatureandundochanges
madepriortoenablingthefeature.AcheckmarkappearsbesideEnableUndoin
theOptionsmenuwhenthisoptionisselected.

NOTE
The Show Toolbox option must be selected for the Enable Undo option to become active it remains
unselectable otherwise.

Types of Diagram Objects

Eachdiagramobjectperformsasinglefunction;forexample,asinglenumeric
objectplacedinauserdiagramdisplaysnumericdatafromasinglesource.Vista
offersseventypesofdiagramobjects.
Grouping Object
Groupanumberofrelatedobjectswithinaseparategroupingwindow.Clickona
groupingobjecttoopenthegroupingwindowanddisplayitscontents.
Text Box Object
Displayindependentheadings,titles,andcommentsinauserdiagram.
Numeric Object
DisplayrealtimenumericvaluessuchasVolts,AmpsorkW.

Page 118

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Status Object
DisplayBooleandata(On/Off,Yes/No,1/0,etc.)toindicatethestatusofadigital
output(relay),digitalinput(statusinput)orsetpoint.Theimagecanbe
customizedtouseanimation.
Data Log Viewer
DisplaydatalogsstoredintheIONdatabase(includingarchivesfromprevious
versionsofIONEnterprise),showwaveformdata(waveformcapture,waveform
recorder)andtrends(datarecorders)usingtables,andprovidedataforplotting.
Event Log Viewer
DisplayeventlogsstoredintheIONdatabase(includingarchivesfromprevious
versionsofIONEnterprise),showeventrecordsfromdevicesandother
components,anddisplayandacknowledgealarms.
Control Object
Sendcommandstoadeviceonyournetwork(forexample,clearanenergy
accumulator,togglearelay,resetacounter,oradjustthevalueofananalogoutput
device).
Toaddafunctiontoauserdiagram,choosethetypeofdiagramobjectyouwant,
dragitintotheuserdiagramthenlinkittotheappropriatenode.Thefollowing
sectionsexplainhowtoaddandlinkadiagramobject.
SeeMonitoringYourSysteminVistaonpage 84formoreinformationonthe
functionandbasicuseofeachtypeofdiagramobject.

Adding a Diagram Object to a User Diagram

Youcanaddanewdiagramobjecttoauserdiagrambydraggingitfromthe
DiagramObjectstoolbox.
Adding a diagram object to a user diagram
1.

SelectOptions>ShowToolboxifthetoolboxisnotdisplayed.Thetoolbox
appearsintheworkspace.

2.

Clickonthediagramobjectyouwantanddragitfromthetoolboxtothe
diagram.

Inmostcases,theobjectappearsinthewindowasanicon,justasitdidinthe
toolbox.However,therearetwoexceptions:
Atextboxappearsinthewindowasarectangularboxdisplayingthedefault
message:Yourtextgoeshere.
Anumericobjectappearsinthewindowasarectangularboxwithacolon.This
indicatesthattheobjectisnotyetlinkedtoanode.

2007 Schneider Electric. All rights reserved.

Page 119

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Afteryouplaceanobject,youcanmoveitanywhereinthediagram.Theobjectis
nowreadytobelinkedtoarealtimeorloggeddatasource.RefertoLinkinga
DiagramObjecttoaDataSourceonpage 125fordetails.

NOTE
When a diagram object is placed in a window, it automatically uses the same node as the window. If you
want to change this source, you can relink each diagram object or you can change the default window
link before placing the objects.

Moving a Diagram Object

Youcanmoveasinglediagramobjectoragroupofdiagramobjectswithinasingle
windoworfromonewindowtoanother.
Aselecteddiagramobjectisidentifiedbyhandlesalongtheedges.Whenmoving
adiagramobject,becarefultopositionthemousepointerontheobjectitself
grabbinganobjectbythehandleresizestheobject.
Diagram object (selected) with handles
Diagram object (not selected)

Moving a single diagram object

1.

Selecttheobjectyouwanttomove.

2.

Dragtheselectedobjecttothenewlocation.

Moving a group of diagram objects

1.

Dooneofthefollowing:
HolddownShiftthenclickoneachobjectyouwanttomove.
Clickoutsideofthegroupanddragaselectionboxaroundtheobjects.

2.

Dragtheselectedobjectstothenewlocation.

Whenmovingoneormoreobjects,youcanusetheAlignment,Grid,andSize
optionstoassistyouinadjustingthespacing,layoutandappearanceofyour
selection.RefertoArrangingObjectLayout:Alignment,Grid,andSizeon
page 121fordetails.
Youcanalsousethearrowkeysonthekeyboardtonudgetheselecteddiagram
object(s)onespaceatatime.
Whendiagramobjectsoverlap,youcanusetheSendtoBackcommandtoplace
oneobjectbeneaththeothers.ClicktheobjecttoselectitthenselectEdit>Sendto
Back(orpressALT+E+B).

Page 120

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Resizing a Diagram Object

Youcanadjustthesizeofadiagramobjecttomakeitlargerorsmalleroryoucan
stretchithorizontallyorverticallytochangeitsshape.
Resizing a single diagram object
1.

Clickonthediagramobjecttoselectit.Theselectedobjectisidentifiedby
handles.

2.

Dooneofthefollowing:
Tomaketheobjectlargerorsmaller,dragacornerhandle.
Tostretchtheobjecthorizontallyorvertically,dragamiddlehandle.

Whenresizingagroupofdiagramobjects,youcanusetheSizetaboftheLayout
boxtoautomaticallyresizeseveraldiagramobjectstoasinglesetofdimensions.

Arranging Object Layout: Alignment, Grid, and Size

UsetheAlignment,Grid,andSizeoptionstoadjustthespacing,layout,and
appearanceofagroupofdiagramobjects.

The Alignment Option

TheAlignmentoptionspecifiesthehorizontalandverticalarrangementofthe
selectedobjects.
Aligning a group of diagram objects
1.

Selectthediagramobjectsthatyouwanttoalign.Toselectagroupofobjects,
holddownShiftthenclickoneachobject,orclickoutsideofthegroupand
dragaselectionboxaroundtheobjects.

2.

SelectEdit>Layoutorclick

3.

SelecttheAligntabtospecifythehorizontalandverticalalignmentofthe
object(s).

.TheLayoutdialogboxappears.

Theoptionnamesineachcolumndescribethecriteriabywhichyoucanalign
diagramobjects.Forexample,ifyouselectLeftsidesunderHorizontaland
SpaceevenlyunderVertical,Vistaalignsallobjectsintheselectionbytheirleft
sides(usingtheleftmostobjectforreference)anddistributesthemevenlyalong
averticalaxis.
4.

2007 Schneider Electric. All rights reserved.

SelecttheoptionsyouwantthenclickOK.

Page 121

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

The Grid Option

TheGridoptionactivatesandconfiguresaninvisiblegrid.Objectsplacedontothe
gridsnaptothenearestgridlinetohelpalignandspacethemevenly.
Activating or deactivating the grid
1.

SelectEdit>Layoutorclick

.TheLayoutdialogboxappears.

2.

SelecttheGridtab.

3.

SelectNoGridtoturnthegridofforGridsizeinpixelstoactivatethegrid.If
youselectGridsizeinpixels,specifythesizeofthegrid(distancebetweengrid
lines)bytypinganumberintotheGridsizeinpixelsbox.

4.

ClickOKtosaveyourchanges.

The Size Option

TheSizeoptionisusefulforautomaticallyresizingagroupofdiagramobjectstoa
single,standardsetofdimensions.
Resizing a group of diagram objects
1.

Selectthediagramobjectsyouwanttoresize.Toselectagroupofobjects,hold
downShiftthenclickoneachobject,orclickoutsideofthegroupanddraga
selectionboxaroundtheobjects.

2.

SelectEdit>Layoutorclick

3.

SelecttheSizetab.Youcaneditthehorizontalandverticaldimensionsofthe
object(s).

.TheLayoutdialogboxappears.

SelectingtheShrinktoSmallestorGrowtoLargestoptionsadjuststhe
widthand/orheighttomatchthatofthesmallestorlargestobjectinthe
selectedgroup.

Page 122

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

SelectingthePixelsoptionactivatesafieldwhereyoucantypetheexact
widthorheightinpixels.
Youcanalsocombinehorizontalandverticaloptionsonasingleselection.
Forexample,selectingShrinktoSmallestintheHorizontalsectionand30
PixelsintheVerticalsectionresizestheentireselectiontothewidthofthe
shortestobjectandthespecifiedheightof30pixels.
4.

ClickOKtosaveyourchanges.

NOTE
You can quickly resize a single diagram object by selecting it then dragging its handles.

Cutting, Copying, and Pasting a Diagram Object

UsetheCut,CopyandPastecommandsontheEditmenutomakeacopyofa
diagramobjectandpasteitintoanotherwindoworuserdiagram.
Youcanpastethecopyasmanytimesasyouliketocreatemultipleversionsofan
object.Eachcopyretainsalloftheattributesandlinkageinformationofthe
original.
Cutting or copying a diagram object
1.

Clickontheobjecttoselectit.Toselectagroupofobjects,holddownShift
thenclickoneachobject,orclickoutsideofthegroupanddragaselectionbox
aroundtheobjects.

2.

Dooneofthefollowing:
Toremovetheoriginal,selectEdit>CutthenclickYestoconfirmthe
deletionorNotocancel.
Toretaintheoriginal,selectEdit>Copy.TheselectioniscopiedtotheION
softwareclipboard.

NOTE
The ION software clipboard is a temporary storage area that holds any information cut or copied from
Vista. It should not be confused with the Windows Clipboard.

OncetheobjecthasbeencopiedtotheIONsoftwareclipboard,youcanpasteit
intotheactivewindow.
Pasting a diagram object

2007 Schneider Electric. All rights reserved.

1.

Clickthewindowyouwanttopastetoifyouhavemorethanonewindow
open.

2.

SelectEdit>Paste.Theobjectappearsintheactivewindow.

Page 123

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Copying a Group of Diagram Objects to a Framework

AVistaframeworkisatemplatethatyoucanusetorecordthelayoutofagroup
ofdiagramobjects.
WhenyouselectCopytoFrameworkfromtheEditmenu,Vistamemorizesthe
typeandlocationofeachdiagramobjectintheselectedgroup.Youcanthenuse
thePastefromFrameworkcommandtocopythegrouplayouttoanotherdiagram
orgroupingwindow.Thisisusefulforreplicatingasingleconfigurationon
multipleworkstations.
TheCopytoFrameworkcommandsavestheselectionasafile.Youcanstorea
savedframeworkwithitsownfilenameandretrieveitanytime.
Copying a group of diagram objects to a framework
1.

Selectthegroupofobjectsyouwanttocopy.HolddownShiftthenclickon
eachobject,orclickoutsideofthegroupanddragaselectionboxaroundthe
objects.

2.

SelectEdit>CopytoFramework.VistadisplaystheCopytoFrameworkdialog
box.

3.

TypeanamefortheframeworkintheFilenameboxthenclickSave.The
frameworkfileextension(.fwu)isaddedautomatically.
Theselectionissavedasaframework.

Onceyouhavecopiedagrouptoframework,youcanpasteittoanotherwindow.
Pasting a group of diagram objects from a framework

Page 124

1.

Clickthewindowyouwanttopastetoifyouhavemorethanonewindow
open.

2.

SelectEdit>PastefromFramework.ThePastefromFrameworkdialogbox
appears.

3.

NavigatetotheframeworkyouwanttopasteandclickOpen.Theframework
selectionappearsintheactivewindow.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Linking a Diagram Object to a Data Source

Afterplacinganobjectinyouruserdiagram,youneedtolinktheobjecttoadata
source.Sometypesofdiagramobjectsrequirearealtimedatasourceandothers
requirealoggeddatasource:
Numeric,status,andcontrolobjectsrequirearealtimedatasource.Youcanlink
thesediagramobjectstoadevice.
EventLogViewersandDataLogViewersrequirealoggeddatasource.Youcan
linkthesediagramobjectstoanyloginyoursystem.

Linking a Numeric, Status or Control Object

Thissectiondescribeshowtolinkanumeric,status,orcontrolobjecttoanION
node.Numeric,status,andcontrolobjectsdisplayrealtimedata.Afteryouhave
placedoneoftheseobjectsintoauserdiagram,youshouldlinkittoasourceof
realtimedata.Anunlinkedobjectcannotreceiveordisplayinformationuntilitis
linked.
Specifying a real-time link to an ION node
1.

Rightclickonthediagramobjectyouwanttolink.

2.

SelecttheLinktabintheObjectConfigurationbox.
TheLinktabcontainstwosections:LinkandLabel.YoucanusetheLinksection
tochoosearealtimesourceandtheLabelsectiontodefinealabelforthe
diagramobject.SeeLinkOptionsonpage 143forinformationontheLabel
section.

3.

SelectInheritfromParentWindoworCustomfromtheLinksection.
IfyouchooseInheritfromParentWindow,theselecteddiagramobject
defaultstothesamenodeusedbytheparentwindow(thewindowinwhich
theobjectresides).Youmustspecifyarealtimeregisterwithinthenode,but
thenodeitselfispreselected.

2007 Schneider Electric. All rights reserved.

Page 125

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

IfyouchooseCustom,youcanselectanewIONnode.SelectIONtochoose
adifferentIONdevicethanthatusedbytheparentwindow.
4.

ClickEditLinktodisplaytheCreateLinkdialogboxwhereyoucanfurther
specifytherealtimelink.
WhenyouclickEditLink,theCreateLinkdialogboxisdisplayed.Usethe
CreateLinkdialogboxtospecifyanode,manager,moduleandoutputregister.

5.

Doubleclickthenodethatcontainsthedatasourceyouwantfromthoseinthe
Nodesbox.IfyouchoseInheritfromParentWindowinthepreviousdialog
box,thenodeinthisboxispreselected.

6.

Doubleclickthemanageryouwant(e.g.PowerMeterModules)fromthe
Managersbox.

7.

DoubleclickthemoduleyouwantfromtheModulesbox(e.g.PowerMeter).

8.

DoubleclicktheoutputregisteryouwantfromtheOutputRegistersbox.

9.

ClickOKontheCreateLinkboxtosaveyourchanges.
TheCreateLinkboxdisappearsandthenewlinkinformationisdisplayedalong
theloweredgeoftheObjectConfigurationdialogbox.

10. ClickOKontheObjectConfigurationboxtoacceptyournewconfiguration.

Configuring a Data Log Viewer or Event Log Viewer

TheEventLogViewerandDataLogViewerdisplayloggeddata.Afteryouhave
placedanEventLogViewerorDataLogViewerobjectintoauserdiagram,you
needtolinkittotheIONQueryService.
Linking the diagram object to the ION Query Service

Page 126

1.

RightclickontheLogViewerobjectyouwanttolink.

2.

SelecttheQueryServertabintheLogViewerConfigurationbox.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

TheQueryServertabofferstwooptions:Inheritfromparentwindowand
CustomQueryServer.
IfyouselectInheritfromparentwindow,theselecteddiagramobject
defaultstothesameQueryServerusedbytheparentwindow(thewindow
inwhichtheobjectresides).Ifyouchoosethisoption,clickOKtoexit,skip
thefollowingsteps,andcontinuewithQueryingtheDatabaseon
page 130.
IfyouselectCustomQueryServer,clickEditLink...todisplayadialogbox
whereyoucanselectanewQueryServerlink.
3.

SelectCustomQueryServerandclickEditLink.
TheCreateLinkdialogboxisdisplayed:thisdialogboxletsyouspecifythe
QueryServer,QueryManager,Querymodule,andQueryregister.

2007 Schneider Electric. All rights reserved.

4.

DoubleclickontheQueryServerthatyouwantfromtheNodesbox.

5.

DoubleclickQueryModulesfromtheManagerbox.

6.

DoubleclickontheQuerymodulethatyouwantfromtheModulesbox.

7.

DoubleclickontheQueryRegisterthatyouwantfromtheOutputRegisters
box.

Page 127

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

8.

ClickOKontheCreateLinkboxtosaveyourchanges.
ThenameoftheselectedIONQueryServiceisdisplayedastheGroupNameon
theQueryServertaboftheObjectConfigurationdialogbox.

9.

ClickOKontheObjectConfigurationboxtoacceptyournewconfiguration.

Onceyouhavelinkedadiagramobjecttoalogserver,youneedtodefineaquery
tospecifythetype(s)ofloggeddatathatyouwanttheobjecttodisplay.

NOTE
If the Query Server has multiple Query modules that are accessing multiple databases, you need to select
the Query module that is connected to the database that contains the data of interest.

Page 128

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Adding a Global Event Log Viewer

LiketheEventLogViewer,theGlobalEventLogViewerdisplayseventdata
storedinthedatabase.ThemaindifferenceistheGlobalEventLogViewerdoes
notrequireauserdiagram;generally,theeventinformationitdisplaysiscommon,
orglobal,totheentiresystem.

ThedifferencebetweentheGlobalEventLogViewerandtheEventLogVieweris
essentialwhensettingupalarming.TheEventLogViewerisassociatedwitha
singleuserdiagram,soalarmsonlyupdatewhentheuserdiagramisopen.The
GlobalEventLogViewerupdatesassoonasyoustartVista.
YoucanaddmultipleGlobalEventLogViewerstotheIONsoftwareworkspace
(ifyouhavesufficientauthority).Youcanchangeeachviewersfiltercriteriato
querythedatabaseforeventsfromaspecificnodeorgroupofnodesorforevents
withacertainprioritylevel.
Adding a Global Event Log Viewer
SelectEdit>AddGlobalEventLogViewer.AGlobalEventViewerwindowis
displayed.
ThenewGlobalEventLogViewerispreconfiguredwithdefaultlinkandquery
information;however,youcanlinktheviewertoanotherlogserverusingthe
proceduredescribedinConfiguringaDataLogViewerorEventLogVieweron
page 126.
IfyouwanttoreconfigureaGlobalEventLogViewer,rightclickintheviewer
windowtodisplaytheEventLogViewerConfigurationoptions.Youcaneditthe
Caption,QueryServer,QueryorAlarmingoptionsjustasyouwouldeditthese
optionsonanindividualEventLogViewer.

NOTE
When you add a Global Event Log Viewer to your workstation, it is automatically added to all Vista
workstations in your network.

2007 Schneider Electric. All rights reserved.

Page 129

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Querying the Database

Vistaprovidestwowaystoviewloggeddata:theDataLogViewerandtheEvent
(andglobalevent)LogViewer.Eachoftheseviewersqueriesthedatabase,extracts
loggeddata,anddisplaysthatdatainVista.
Aqueryisasetofinstructionsthatthelogvieweruseswhenitrequestsdatafrom
thedatabasetodisplayinVista.Eachlogviewermaintainsitsownindividual
query.Editingthisqueryinformationchangeswhatdatathequeryretrievesand
thewayalogviewerdisplaysthatdata.
RightclickonthelogviewerandselecttheQuerytabtoviewthequeryoptionsor
accesstheQueryWizard.Usethequeryoptionstodefinethewayaviewer
displaysdataandtheQueryWizardtoedittheactualquery.

NOTE
Anytime you place and link a new Data Log Viewer or Event Log Viewer, you need to specify a query for
it. You can specify a query using the Query Wizard.

Using the Query Options

Youcandefinethewayalogviewerdisplaysinformationbyconfiguringitsquery
options.
ToviewthequeryoptionsforanEventLogViewer,DataLogViewer,orGlobal
EventLogViewer,rightclickontheviewerobjectandselecttheQuerytab.

TheuppersectionoftheQuerytabofferstwobuttons:EditQueryandEditSQL.
TheEditQuery...buttonstartstheQueryWizard,auserfriendlyinterfacethat
helpsyoueditthequery.
TheEditSQL...buttonaccessestheSQLstatementviaWindowsNotepadifyou
wouldrathereditthequerydirectlyusingSQL.

Page 130

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

NOTE
If you edit a query directly (i.e. by editing the SQL statement), your changes may not be accessible to the
Query Wizard. This is not a problem unless you intend to use the Query Wizard as well.

TheOptionssectionoftheQuerytaboffersthefollowingoptions:
Recordsuploadedatatime:WhenyoustartaDataorEventLogViewer,Vista
contactsthedatabaseanduploadsthespecifiednumberofrecordsintoactive
memory(RAM).Thedefaultnumberofrecordsis100;themaximumvalueis
9999.Asyouscrolldownthelistofrecords,Vistauploadsadditionalrecordsas
needed.Youmaywanttochangethisdefaultvalueif,forexample,youwantto
selectalargenumberofrecordsforplotting,withoutscrollingdownrepeatedly.
Updateautomatically:Thisoptionisdisabled(unchecked)bydefault.TheLog
Viewerdoesnotdisplayanynewrecords;rather,theLogViewerinitially
uploadsthespecifiednumberofrecords(forexample100)anddoesnotupdate
againunlessitisclosed(anditsqueryresultsdeleted)thenreopened.
Withthisoptionselected,theLogViewercontinuallyreceivesanddisplays
newrecordsuptoamaximumof1000records;theLogViewerchecksfornew
recordsevery20seconds.However,theupdatescanconsumeanoticeable
amountofCPUpower,especiallyifseveralLogViewersremainopen
simultaneouslyorifLogViewersareuploadingwaveformdata.
TheGlobalEventViewerishardcodedtoupdateautomaticallyevery10
seconds.Thispreventsyoufrommissingalarms.
Deletequeryonclose:Thisoptionisenabled(selected)bydefault.TheLog
Viewerclearsitstemporaryrecordsfromactivememory(RAM)uponclosingso
thateverytimeaLogViewerisopened,thedatabaseisqueriedagainandall
availablerecordsaredisplayed.(Thisoptiondoesnotaffectanyoriginalrecords
storedinthedatabase.)
Ifthisoptionisdisabled,VistacachestherecordsetreturnedtotheLogViewer,
meaningthatiftheLogViewerisclosedthenreopened,thetableispopulated
frommemoryandnotfromthedatabase.Anynewrecordsinsertedintothe
databaseduringthetimetheLogViewerwasinitiallyopenwillnotappear.

NOTE
Since it is recommended that Update Automatically remain disabled in all but the most compelling
circumstances, it is important that the Delete Query on Close option remains enabled.

Useparentnode:Withthisoptionselected,thelogviewerwillusethesame
nodelinkageastheparentwindow.Thenodewillalsobepreselectedinthe
QueryWizardyoushouldnotselectthisoptionifyouintendtoquerymore
thanonenodeorquerytheglobaleventlog.

X-Parameter for Log View Plotter

ForaDataLogViewer,theXParameterforLogViewPlottersectionisofferedat
thebottomoftheQuerytab.Youcanusethissectiontospecifyacolumntobeused
ontheXaxisoftheLogViewPlotter.Thissectionofferstwooptions:Timestamp
andUsecolumn#.

2007 Schneider Electric. All rights reserved.

Page 131

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

TimestampisselectedastheXparameterbydefault.Insomecases,youmay
needtospecifyadifferentXparameter.Forexample,whenyouareplotting
disturbancesyouneedtoplotyourdataagainsttheDurationcolumn.
Usecolumn#letsyouspecifyanewxparameter.Inthefieldprovided,typethe
columnnumberthatyouwanttouseastheXparameter(e.g.3).Whenyouclick
OKontheDataLogViewerConfigurationbox,thespecifiedcolumnchangesto
blue.

NOTE
In the Data Log Viewer, the column specified for the X-parameter is colored blue for easy identification.

Using the Query Wizard

TheQueryWizardassistsineditinganexistingqueryorcreatinganewqueryfor
aDataLogViewer,EventLogViewer,orGlobalEventLogViewer.
Starting the Query Wizard
1.

Rightclickontheviewerthatyouwanttoconfigure.

2.

SelecttheQuerytabintheLogViewerConfigurationbox.

3.

ClickEditQuery.
TheQueryWizardisdisplayed.TheQueryWizardconsistsoffoursteps
designedtoguideyouthroughtheprocessofeditingaquery:
Selectingthenode(s)toquery.
Specifyinglogswithinthespecifiednode(s).
Specifyingcolumnsandspecifyingfilters.
Choosingasortorder.
Dependingonthetypeofquery(neworexisting),youmaynotneedtoperform
allfoursteps.WhenyoustarttheQueryWizard,itautomaticallyopensonthe
appropriatestepintheprocess.

4.

UsethefourbuttonsatthebottomoftheQueryWizardtomovethroughorexit
theQueryWizard.
UsetheBackandNextbuttonstonavigatethroughthedialogboxes.
ClickCanceltoquittheQueryWizardanddiscardyourchanges.
ClickFinishtoquittheQueryWizardandsaveyourchanges.

5.

ClickOKtosaveyourchangesandclosetheviewerconfigurationbox.

Thefollowingexampledescribeseachstepintheprocessofcreatingatypical
query:configuringaDataLogViewertodisplaywaveformsforthreephases(V1,
V2,V3).

Page 132

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Using the Query Wizard - Step #1: Selecting the node(s)

Step1promptsyoutoselectanodeforyourquery.Ifanodehasalreadybeen
specified,theQueryWizardproceedsdirectlytotheStep2:Specifyinglogs.

NOTE
If you selected Use Parent Node on the Query tab, your query inherits its node link information and this
step is skipped.

TheAvailablelistdisplaysallavailablenodes(deviceorsoftware)andtheSelected
listdisplaysanycurrentlyselectednodes.
Selecting a node
1.

HighlightthenameofthenodethatyouwantfromtheAvailablelistandclick
Add.ThenodeappearsintheSelectedlist.Repeatthisproceduretoaddany
additionalnodesyoumayrequireforthisquery.
IfyouwanttoremoveanodefromtheSelectedlist,highlightthenodeandclick
Remove.ThenodedisappearsfromtheSelectedlist.

2.

ClickNexttocontinue.

NOTE
If you want to view or edit a node's SQL statement directly, highlight the node in the Selected list and click
the SQL... button. The Windows Notepad displays the SQL statement for the specified node.

2007 Schneider Electric. All rights reserved.

Page 133

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Using the Query Wizard - Step #2: Specifying logs

Step2promptsyoutospecifyoneormoredatalogstoquery.Ifavalidqueryhas
alreadybeenspecified,theQueryWizardproceedsdirectlytoStep3:Specifying
columns.

TheAvailablelistdisplaysallthelogsavailableonthespecifiednode.TheSelected
listdisplaysanycurrentlyselectedlogs.
Selecting a log
1.

HighlightthenameofthelogthatyouwantfromtheAvailablelistandclick
Add.ThelogappearsintheSelectedlist.Repeatthisproceduretoaddeach
additionallogyourequire.
Youcanhighlightagroupoflogs,andclickAddtoselectthemall.Forexample,
ifyouwanttoselectwaveformlogsforthreephases,holdtheShiftkeyandclick
WR01WformLog(V1),WR02WformLog(V2),andWR03WformLog(V3).
ClickAddandallthreelogsappearintheSelectedlist.

2.

ClickNexttocontinue.

NOTE
Check for additional tabs. If you selected more than one node in the previous dialog box, this box
requires you to specify logs for each node. Each tab is labeled Node 1, Node 2, etc. and is identified
at the top of each tab. Select Advanced Log View to access any logs whose configuration has changed
over time. This check box enables access to old configurations of snapshot logs.

Page 134

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Using the Query Wizard - Step #3: Specifying Columns and

Filters
Step3promptsyoutochoosecolumnsandspecifyfiltersettings.

UsetheSelectthecolumnstoappearintheLogViewersectiontoaddorremove
acolumnfromyourlogviewerandtheFiltersectiontoestablisharangeforyour
queryandtoscreenoutunwanteddata.
Ifyouselectedmultiplelogsinthepreviousstep,thisboxcontainsatabforeach
log.Specifythecolumnandfilterinformationforeachtab.
Specifying columns to appear in the Log Viewer
TheAvailablelistdisplaystheavailablecolumnsandtheSelectedlistdisplaysthe
currentlyselectedcolumns.TheSelectedlistdisplaysthecolumnsinthesame
orderthattheyappearinthelogviewer(thecolumnslistedfromtoptobottomare
displayedintheviewerfromlefttoright).
TospecifythecolumnstoappearintheLogViewer:
1.

Highlightthenameofthecolumn(s)youwantthenclickAdd.Thecolumn(s)
appearsintheSelectedlist.
Choosingtheasterisk(*)atthetopoftheAvailablelistselectsallavailable
columnsoryoucanselectonlythecolumnsyourequire.
Forexample,ifyouwanttoselectsomebasiccolumnsforthefirstwaveformlog
youchoseinthelaststep,youcouldhighlighttimestamp,node,andV1inthe
Availablelist.

2007 Schneider Electric. All rights reserved.

Page 135

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

NOTE
The * column option shows all inputs connected to a recorder for Data Log Viewers. For example, use the
* option if you are using a framework and the configuration of the data log is different for several meters.
The * option is not available if more than one table is selected, as in the example. To support alarm
annunciation, an Event Log Viewer requires the following three columns: priority, ack_time and recordID.

2.

Repeatthisprocedureforeachcolumnthatyouwant(andforeachtab).

3.

ToadjusttheorderoftheitemsintheSelectedcolumn,highlightthecolumn
nameyouwanttomoveintheSelected(inorder)sectionthenclicktheupor
downarrowstomoveit.Thesectionliststhecolumnsfromtoptobottominthe
ordertheywillappearfromlefttoright.
Forexample,ifyouwanttheTimestampcolumntobethefirst(leftmost)
columninyourlogviewer,highlighttimestampintheSelected(inorder)
sectionthenclicktheuparrowtomoveittothetopofthelist.

Onceyouhaveselectedthecolumnsyouwant,proceedtospecifyfiltersettings.
Specifying a Filter
UsetheFiltersectiontoconstructoneormorefilterstatementsforyourlogviewer.
Filtersareusefulforrestrictingthescopeofyourqueryorspecifyingapriority
rangeforalarms.
Youcaneditanexistingfilterstatementbydoubleclickingonit.

Click here to choose a column Click here to choose an operator

Click here to choose a value

Click here to replace the

selected filter statement
with a new one

Click here to choose an

additional value
Click here to add brackets to
your filter statement

Click here to insert the

new filter statement into
the box below

Use the AND/OR/NOT buttons to

string filter statements together

Click here to delete the

selected filter statement
from the box below

Forexample,ifyouwanttoinstructthelogviewertodisplaydataforthepast
month(excludingtoday),youcouldusethefollowingprocedure:
1.

Inthefirstbox,selecttimestamp

2.

Inthesecondbox,chooseBETWEEN

3.

Inthethirdbox,chooselast_month_to_date()

4.

Inthefourthbox,choosetoday_12AM()

5.

ClickInsert.
Thefollowingfilterappearsintheboxbelowthefiltercontrols:
timestampBETWEENlast_month_to_date()andtoday_12AM()

Page 136

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

NOTE
When setting priorities for a Global Event Log Viewer, you should specify high priorities to prevent the
viewer from filling up with low-priority events.

IfyouwantedtoinstructanEventLogViewertodisplayonlyunacknowledged
alarms,youcancreateafilterthatonlydisplaysalarmsthathaveno
acknowledgementtime(acktime).
1.

Inthefirstbox,selectacktime

2.

Inthesecondbox,selectISNULL

3.

ClickInsert.
Thefollowingfilterappearsintheboxbelowthefiltercontrols:
ack_timeISNULL

Asyouconstructafilterstatement,eachfieldoffersoptionsbasedonyour
selectioninthepreviousfield(s).Forexample,ifyouselectpriorityinthefirst
field,thethirdfieldactsasatextfieldwhereyoucantypeanumericvalue;butif
youchoosetimestampinthefirstfield,thethirdfielddisplaystimebased
options(i.e.now,today12AM,yesterdayetc.).

Time-related functions
now_()

The current time.

today_12AM()

Today at 00:00:00.

yesterday()

Yesterday at 00:00:00.

last_week()

Seven days ago at 00:00:00.

this_month()

The first day of this month at 00:00:00.

last_month_to_date()

The same date of the month one calendar month ago at 00:00:00.

last_month()

The first day of the last calendar month at 00:00:00.

last_quarter_to_date()

The first day of the month three calendar months ago at 00:00:00.

Thesecondfieldoffersastandardsetofoperators.

Operator-Specific Data
Ifyouselectanoperatorthatrequiresadditionalinformation,Vistadisplaysa
dialogboxwhereyoucanspecifytherequireddata.
Forexample,ifyouselectthenodecolumninthefirstfieldthenselecttheIN
operatorfromthesecondfield,aboxappearsrequestingyoutospecifythenode
youwanttouse.

2007 Schneider Electric. All rights reserved.

Page 137

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Ifinstead,youspecifyanycolumnotherthannodethenselectIN,abox
appearsrequestingthenumericvalues.

Onceyouhavespecifiedafilter,clickNexttoproceedtoStep4:ChoosingaSort
Order.

Using the Query Wizard - Step #4: Choosing a Sort Order

Step4promptsyoutospecifyasortorder.Thesortorderistheorderinwhich
recordsappearintheviewer.

Page 138

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

AvailableColumnsdisplaysthecolumnsyouchoseinthepreviousstep;theSort
Orderlistdisplaysthecolumn(s)thatdictatetheorderinwhichtherecordsare
sorted.
Specifying a sort order

2007 Schneider Electric. All rights reserved.

1.

HighlightthenameofthecolumntosortbyintheAvailableColumnslistthen
clickAdd.ThecolumnappearsintheSortOrderlist.

2.

DoubleclickonthecolumnintheSortOrderlisttochooseeitheranascending
ordescendingsortorder.

3.

ClickFinishtoquittheQueryWizardandsaveyourchanges.

4.

ClickOKintheLogViewerConfigurationboxtoacceptthenewconfiguration.

Page 139

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Custom User Diagrams

Thissectionexplainshowtocustomizeauserdiagram.Therearetwomethodsof
customizingauserdiagram:youcancustomizetheappearanceofadiagramobject
withinthediagramoryoucancustomizethediagramwindowitself.

Customizing a Diagram Object

Onceyouhaveplacedandlinkedadiagramobject,youcancustomizeit.Right
clickonadiagramobjectineditmodetodisplaytheconfigurationoptions
availableforthatobjecttype.Thefollowingtableliststhevariousconfiguration
optionsavailableforeachtypeofdiagramobject.

Available Option Tabs

Caption
Grouping
Object

Text

Edit Text

Text Box
Object

Link (or
Node)1

Query
Server2

Display

Action

Box

Annunciation

Query3

Numeric
Object

Status
Object

Data Log
Viewer

Event Log
Viewer

Control
Object

Alarming

x
x

Node is the tab available with Grouping Objects

Query Server is only available on Grouping, Numeric, Status and Control objects when the Action is
set to something other than None.

See Querying the Database on page 130 for information on configuring this option.

Customizing a diagram object

Page 140

1.

Rightclickthediagramobject.Theobjectsconfigurationboxappears.

2.

Selecttheappropriatetabandmakeyourchanges.Repeatthisstepfortheother
tabsuntilyouhavemadeallyourdesiredchanges.

3.

ClickOKtosaveyourchangestothediagramobject.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Caption Options
UsetheCaptiontabtoaddcustom,userdefinedtexttoadiagramobject.The
Captiontabisavailableoneverydiagramobjectexceptthetextboxobject.
Toviewcaptionoptions,rightclickontheobjectthenselecttheCaptiontab.

TheCaptiontabcontainsthreesections:Caption,Font,andPosition.
TheCaptionsectiondetermineswhetheradiagramobjectdisplaysatextual
commentalongwiththediagramobjectsicon.Thissectionoffersthreeoptions:
None,Usedefault,andUsecustom.
SelectNonetodisplaynocaption.
SelectUsedefaulttodisplaythedefaultVistacaption(i.e.thedevicenameor
datasource).
SelectUsecustomtodisplaythetextthatyoutypeintothefieldprovided.
TheFontsectionallowsyoutochangethefontusedinacaption.Youhavetwo
options:InheritfromparentwindowandCustom.
SelectInheritfromparentwindowtousethedefaultfont.
SelectCustomtospecifyacustomfont.ClickFont...todisplaythefontdialog
boxandchangethefont,size,styleorcolor.
ThepositionsectionhastwooptionsTopandBottomthatletyouplacethe
captionaboveorbelowthediagramobjectsicon.

Text Options
Somediagramobjectshaveatextlabelintegratedintothedisplay.Bydefault,this
labelidentifiesthelinkedIONregister.
ToviewtheTextoptions,rightclickontheobjectthenselecttheTexttab.

2007 Schneider Electric. All rights reserved.

Page 141

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

EdittheappearanceofthislabelusingtheoptionsofferedontheTexttab.TheText
tabisavailableonthenumeric,status,control,andtextboxobjects.

TheTexttabhastwosections:FontandPosition.
IntheFontsectionyouhavetwooptions:InheritfromparentwindoworCustom.
SelectInheritfromparentwindowtousethedefaultfont
SelectCustomtospecifyacustomfont.ClickFont...todisplaythefontdialog
boxandchangethefont,size,styleorcolor.
InthePositionsection,selectLeft,Center,orRighttodefinethealignmentofthe
textinrelationtothediagramobject.UsethePreviewarealocatedbesidetheText
tabtoviewyourproposedchanges.

NOTE
You can edit the text displayed in a text label. For a numeric, status or control object, use the Label section
of the Link tab. For a text box object, use the Edit Text tab.

Edit Text Options

UsetheEditTexttabtospecifyatextmessageforthetextbox.TheEditTexttabis
availableonthetextboxobjectonly.
ToviewtheEditTextoptions,rightclickontheobjectthenselecttheEditTexttab.

Page 142

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

TheEditTexttabofferstwooptions:UsedefaultandUsecustom.
Usedefaultdisplaysthewindowlinkinformation(i.e.thenode)
Usecustomdisplaysyourcustomtextmessage.Thisisthedefaultselection.
Thetextboxsupportsmultiplelinesoftext;however,ifyourmessageappears
incompleteortruncated,youcanadjustthedimensionsofthetextbox.Toresizea
textbox,selectitthendragitshandles.
Thefontusedinthetextboxisbasedonthedefaultsettingspecifiedfortheactive
window.UsetheTexttabtospecifyadifferentfontorpositionforthetextbox.To
specifyaborderstyleorchangethebackgroundcolor,selecttheBoxtab.

NOTE
Instead of typing a large block of text into a text box, you can use the Copy and Paste feature to transfer
it from another source (for example, a word-processing program).

Link Options
UsetheLinktabtolinkadiagramobjecttoarealtimesource,andtospecifyanew
textlabel.TheLinktabisavailableonthenumeric,status,andcontrolobjects.

NOTE
To set a real-time source for a grouping object, use the Node tab.

Toviewthelinkoptions,rightclickontheobjectthenselecttheLinktab.

2007 Schneider Electric. All rights reserved.

Page 143

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

TheLinktabcontainstwosections:LinkandLabel.
UsetheLinksectiontospecifyarealtimesourceforthediagramobject.See
LinkingaNumeric,StatusorControlObjectonpage 125formoreinformation.
UsetheLabelsectiontochangetheobjectstextlabel.TheLabelsectioncontains
threeoptions:None,UseNodeLabel,andCustom.
SelectNonetodisplaynolabel.
SelectUsenodelabeltodisplaythenodesregisterlabel.Thisisthedefault.
SelectCustomtodisplaythelabelthatyoutypeintothetextfieldprovided.Any
labelsyoucreateareonlyavailabletousersofyourdiagrambecausecustom
labelsarestoredinthediagram.

NOTE
If you have specified custom labels in your diagram, or custom labels have been applied to an ION meter
at the device level, you can display the default labels at any time by selecting Show Default Labels from
the Options menu. This displays the default label of the data source instead of the label assigned in the
device or in the user diagram.

Query Server Options

UsetheQueryServertabtoconnectadiagramobjecttoaQueryServer.TheQuery
ServertabisavailableontheDataLogViewerandEventLogViewerobjects.See
ConfiguringaDataLogViewerorEventLogVieweronpage 126formore
information.
TheQueryServertabisalsoavailableongroupingobjectsandanyobject
configuredtoopenagroupingwindoworuserdiagram.YouusetheQueryServer
tabtospecifyadefaultQueryServerfortheassociatedgroupingwindoworuser
diagram.SeeQueryServer:SettingaDefaultQueryServerforaWindowon
page 161formoreinformation.

Page 144

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Display Options
UsetheDisplaytabtocustomizetheappearanceofadiagramobject.TheDisplay
tabisavailableonnumeric,status,control,andgroupingobjects.
TheDisplaytaboffersauniquesetofoptionsforeachtypeofdiagramobject.To
viewthedisplayoptions,rightclickonthediagramobjectthenselecttheDisplay
tab.UsethePreviewarealocatedbesidetheDisplaytabtoviewyourproposed
changes.

Customizing the Display of a Numeric Object

Numericobjectsdisplayrealtimedatainyouruserdiagram.Thedefaultnumeric
objectappearsasarectangularalphanumericdisplaywithasingledecimalplace
ofresolutionandnounitsymbol.Youcancustomizethedisplaytochangeanyof
thesedefaultelements.

2007 Schneider Electric. All rights reserved.

Page 145

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

NOTE
Vista supports a maximum of 59 non-alphanumeric numeric objects within a single window. You can
change the way numbers are displayed (thousands separator and decimal point) by using the Regional
Settings option of the Windows Control Panel. You can also use this option to customize the time and
date styles. (The year/month/day format can be modified, and the clock can be changed from am/pm
to 24 hour.)

TheDisplaystyleboxletsyouselectanewstylefromthelistofavailablechoices.
Whenyouclickonastyleinthebox,theupdatedimageisdisplayedinthePreview
section.Thefollowingstylesareavailable:
Alphanumeric:Defaultstyle.Generaluseandtextdisplay.
PartialDial:Generalusevoltage,current,harmonicdistortion,etc.
FullDial:Powerfactor,bidirectionalpowerflow,etc.
HorizontalBar:Generaluse.
VerticalBar:Generaluse.
TimestampedDisplay:Displaysthevalue,andthedateandtimethevaluewas
measuredbytheIED.Usefulformin./max.values.
ScrollingGraphDisplay:Generaluse.Displaysrecentreadingsonascrolling
graph.
ArcMeterDisplay:Generalusevoltage,current,harmonicdistortion,etc.
TimestampOnly:Sameastimestamped,butdoesnotdisplayavalue.Canbe
usedasaclock.
PCTimestampedDisplay:Displaysthevalue,andthedateandtimethevalue
wasreceivedbyVista.
TheUnitsboxletsyoutypetheunitnameforthemeasuredvalue(e.g.Voltsor
Amps).Thisnameisdisplayedonthenumericobject.Iftheunitnamebegins
withK(e.g.kV),M(e.g.MVolts),orG(e.g.GWatts),thedisplayedvalueis
adjustedaccordingly.
TheResolutionboxletsyouspecifythenumberofdecimalplacestobedisplayed
foranumericobject.Thedefaultvalueis1,butthiscanbeincreasedtotake
advantageofanyextraresolutionavailablefromthedatasource.

NOTE
Specifying higher resolution does not result in higher accuracy than the specified accuracy of the device.

TheTicksLabelsFontsectiondefinesfontoptions(suchasstyle,size,andcolor)
forthenumericobject.Thissectionhastwooptions:InheritfromParentWindow
andCustom.
SelectInheritfromParentWindowtousethedefaultstyle.
SelectCustomtospecifyacustomstyle,thenclickFont...todisplaythefont
dialogboxandmakeyourchanges.

Page 146

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

TheFlagsoptionletsyoudefineanormaloperatingrangeanddisplayitonthe
numericobject.Onceflagshavebeenset,youcanusethemtoquicklydetermine
whetherareadingiswithinthepredefinednormalrange.
ClickFlags...todisplayadialogboxwhereyoucanspecifythelowandhighlimits
oftheparametersnormaloperatingrange.

Theeffectofsettingtheselimitsdependsonthedisplaystyleyouhavespecified.
Forexample,onthePartialDial,FullDial,andArcMeterdisplays,flagsappearas
coloredrangesonthedial.

Partial Dial

Full Dial

Arc Meter

Onothertypesofnumericobjects,theflagfunctionchangestheobjects
backgroundcolorwheneveralimitisexceeded.

blue flag =
under limit

no flag =
normal range

red flag =
over limit

Bydefault,LowFlagcolorisblueandHighFlagcolorisred;however,youcan
specifyanycolorsyoulike.SelectOptions>FlagColors...todisplayadialogbox
whereyoucanchangethesevalues.

NOTE
The flags used in Vista are not linked to the setpoints in ION meters. Setpoint activity is automatically
logged by the Log Inserter. Setpoint status can be monitored using a status object and/or data log viewer.

2007 Schneider Electric. All rights reserved.

Page 147

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Other Display Options

Youcanadjustotherdisplayattributesbyrightclickingontheaxesorlabelsofthe
diagramobjectdisplayedintheNumericObjectConfigurationboxsPreview
section.
InthePreviewofaverticalorhorizontalbargraph,rightclicktheaxistochange
theaxisparametersorrightclickthelabeltochangetheformatorspecifyatitle.

Youcanconfiguremeterparametersonpartialdial,fulldialorarcmeterdisplays.
Toviewavailableparameteroptions,rightclickanywhereonthePreview.

OnascrollinggraphPreview,rightclickontheverticalaxis,horizontalaxis,axis
label,orgraphbackgroundtospecifyadditionalsettings(includingthesample
intervalandrelativereset).

Page 148

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Right-click the axis

label to change the
format (decimal,
scientific or
engineering) or to
specify an axis title.

Right-click
anywhere on the
graph background
to specify the
sample interval or
the relative reset
settings (see Note).

Right-click the vertical

axis to change the
range, tick marks,
grid, or line style

Right-click on the
horizontal axis to
change the time
range (in seconds)
or the tick marks

Therelativeresetisapercentagethatdeterminestheamountthescrollinggraph
shiftsbackuponfillingtheplottingarea.(Forexample,arelativeresetof0.5shifts
back50%;arelativeresetof0.99scrollsthemostsmoothly.)

NOTE
The sample interval determines the resolution of the X-axis in seconds. It should be set between one tenth
and one hundredth of the X-axis range; for example, when extending the range to one hour (3600
seconds), the sample interval should be set to approximately 60 seconds.

Customizing the Display of a Status Object

StatusobjectscandisplaythestatusofBooleanon/offconditionsinthreeways:
anindicatorlight,analphanumericfield,oracustomimage.Thedefaultdisplay
styleisanindicatorlight.
Theindicatorlightchangescolortoindicatevariousconditions;bydefault,green
indicatesanOFFcondition,redindicatesanONconditionandanunconnected
lightappearsgray.Youcancustomizethedisplaytochangeanyofthesedefault
elements.
OFF

ON

Toviewastatusobjectsdisplayoptions,rightclickontheobjectthenselectthe
Displaytab.

2007 Schneider Electric. All rights reserved.

Page 149

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

NOTE
You can invert the default color scheme by selecting Invert Active State from the Annunciation tab.

TheCustomimagesoptionletsyouuseacustomizedimagetoshowthecondition
representedbytheassociatedBooleanregister.Customimagesmayshow
animation,customizedbuttons,alarmmessages,etc.Thecustomimagereplacesa
portionofthebackgroundimageinyouruserdiagram.
Currently,theCustomimagedisplaysupportsthefollowinggraphicfileformats:
BMP,WMF(WindowsMetafile),EMF,andAVI(animation).
Youcanusethreedifferentfilestorepresentthethreedisplaystates(On,Off,and
Unconnected)ofastatusobject.Eachofthesefilescanalsobeofadifferenttype
(e.g.BMP,AVI,andWMF).
Tospecifyacustomimageforagivenstate,selectCustomimagesthenenterthe
filenameoftheimageintotheappropriatebox(ON,OFF,orUnconnected).Ifyou
wanttohidethestatusobjectinagivenstate,leavetheappropriateboxblank;
thestatusobjectisthentransparentwheninthatstate.

NOTE
AVI files should not include audio and should be either uncompressed or compressed using RLE8
compression.

NOTE
Vista no longer uses the 6-frame bitmap format for Boolean custom images. However, if you are a user
of an earlier version of Vista and have upgraded, your existing graphics will still work. If the 6-frame
bitmap box is checked, you can use the same file for all three states. Vista uses the first frame to display
the UNCONNECTED state, the second frame for the OFF state, and the last frame for the ON state. As
explained earlier, if no file name is provided in the entry box of a state, nothing is displayed when the
status object is in that state.

Page 150

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

TheAlphanumericdisplaystyleletsyoudisplaytheBooleanstatelabelsstoredin
thedevice,andyoucanchoosecustomcolorstovisuallyindicatethe
correspondingstates.
Forexample,supposeRunninghasbeenstoredinanIONmeterasthelabelfor
theBooleanregisterthatstorestheONconditionofamotorrelay,andStopped
fortheOFFcondition.Youcanshowthisregisterlabeltogetherwiththestatus
labelusingthealphanumericdisplaystyle.

YoucanoverridethemeterlabelsundertheLinktab.ClickONColor...andOFF
Color...tospecifythecolorsassociatedwitheachcondition.

Customizing the Display of a Grouping Object

Thegroupingobjectcanbedisplayedasthedefaultimage,acustomimage,orno
image.Youcancustomizethedisplaytochangeanyofthesedefaultelements.
Toviewagroupingobjectsdisplayoptions,rightclickontheobjectthenselectthe
Displaytab.

TheDefaultimageappearsintheuserdiagramjustasitdoesonthetoolbox:a
smallicon.
Ifyouwouldratheruseacustomimage,selecttheCustomimageoptionandenter
thefilenameoftheimageyouwanttouse.Thefilenameshouldincludethefiles
extension(forexample,.bmp,.wmf,.emf,or.avi).
Ifyouwanttohidethegroupingobject,selectNone.Withnoimagespecified,
thegroupingobjectistransparentunlessyouselectit(displayingthehandles).If
youmovethemouseoveratransparentobject,thestatuslinedisplaysthesizeand
objecttype(forexample,30x30:GroupingObject).

2007 Schneider Electric. All rights reserved.

Page 151

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Hidingagroupingobjectisespeciallyeffectivewhenusingacustombackground
image;youcanintegrateyourtransparentgroupingobjectsintotheimageby
placingthemattheappropriatepointsonthedrawing.Userscandisplaysite
specificinformationbydoubleclickingontheappropriatespotinthebackground.
SeeImage:DisplayingaBackgroundImageonpage 160forinformationon
usingacustombackground.

Customizing the Display of a Control Object

Acontrolobjectappearsdifferentlydependingonthetypeofregistertowhichit
islinked.Thissamecriteriaalsodeterminesthedisplayoptionsavailable.Toview
acontrolobjectsdisplayoptions,rightclicktheobjectthenselecttheDisplaytab.

External Boolean

External Pulse

External Numeric

AcontrolobjectthatislinkedtoanExternalNumericmoduleappearsasan
alphanumericdisplaybox.DisplayoptionsforthisobjectincludeBorderand
BackgroundColor.(SeeBoxOptionsonpage 155formoreinformation.)
AcontrolobjectthatislinkedtoanExternalPulsemoduleappearsasabuttonicon,
offeringthesamedisplayoptionsasthegroupingobject:Defaultimage,Custom
Image,andNone.(SeeCustomizingtheDisplayofaGroupingObjecton
page 151formoreinformation.)
AcontrolobjectthatislinkedtoanExternalBooleanmoduleappearsasaswitch
icon(default).Thisobjectoffersthesamedisplayoptionsasthestatusobject:
CustomOn,OffandUnconnectedimages.(SeeCustomizingtheDisplayofa
StatusObjectonpage 149formoreinformation.)

Page 152

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Action Options
UsetheActiontabtospecifytheresponseofadiagramobjectwhenitisclicked(in
Displaymode)ordoubleclicked(inEditmode).
TheActiontabisavailableonthenumeric,status,grouping,andcontrolobjects.
Toviewtheactionoptions,rightclickonthediagramobjectthenselecttheAction
tab.Dependingonthetypeofdiagramobject,theActiontabdisplaysoneoftwo
setsofoptions:
Specifyanactionforanumeric,status,orgroupingobject
Customizetheactionforacontrolobject

Specifying Action for Numeric, Status, or Grouping Objects

Whenyourightclickonanumeric,status,orgroupingobject,theActiontab
displaystheavailableoptions:

NOTE
If you change the action for a grouping object that is already associated with a grouping window, the
existing window (and any objects within it) is deleted. Vista displays a warning before performing this
action.

Ifyoudonotwanttheobjecttosupportanaction,youdonotneedtodoanything
Noneisthedefaultfornumeric,status,andgroupingobjects.Ifyouwantto
defineanaction,youcanselectoneofthefollowing:
SelectOpenGroupingWindowtoopenagroupingwindowwhentheobjectis
clicked.Youcanusethisgroupingwindowtodisplayadditionalinformation.
Forexample,ifanumericobjectdisplaysatotalvalue(suchastotalkW),you
candisplayspecificinformation(suchaskWreadingsforeachphase)inan
associatedgroupingwindow.
TheOpenDiagramforMeterTemplateoptionisusedbydefaulteachtimea
networkdiagramisgenerated.Eachmetericoninthenetworkdiagramissetto
openthedefaultdiagramsthatmatchthatmetersconfiguration.

2007 Schneider Electric. All rights reserved.

Page 153

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

SelectOpenUserDiagramtohaveauserdiagramopenwhentheobjectis
clicked.(Tospecifyauserdiagram,typethefullpathandfilenameintothefield
providedorclickBrowsetolocatethediagramyouwant.)Usingthisaction,you
canchooseadiagramobjectthatdisplaysarepresentativereadingfroman
independentdiagramanduseittoopentheotherdiagramwhenclicked.
SelectOpenFiletospecifyafiletoopenwhentheobjectisclicked.(Tospecifya
file,typethefullpathandfilenameintothefieldprovidedorclickBrowseto
locatethefileyouwant.)Thefilecanbeathirdpartyprogramorsomeother
document;ifadocumentisspecified,thentheprogramassociatedwiththefile
extensionislaunchedandthespecifieddocumentisloadedintotheapplication.
SelectOpenWebPagetoopenaspecifiedwebpageinyourdefaultwebbrowser
whentheobjectisclicked.(Tospecifyawebpage,typeorcopythecomplete
addressintothefieldprovided.)

NOTE
When you select any action other than None, the Query Server tab is added to the top of the object
configuration box. You can use this tab to specify a source of logged data for the new user diagram or
grouping window. If you enter only the filename into the field provided (and do not specify a directory),
Vista defaults to PML_ROOT2\DIAGRAMS\UD.

Customizing the Action for a Control Object

Whenyourightclickonacontrolobject,theActiontabdisplaystheavailable
actionoptions.

ThisActiontaboffersthreeoptions:Noconfirmation,Messageboxconfirmation,
andPasswordconfirmation.Youcanusetheseoptionstodefinehowthecontrol
objectrespondswhenclicked.
SelectNoconfirmationtohavenoconfirmationmessagedisplayed.
SelectMessageboxconfirmationtodisplayamessageboxwhentheobjectis
clicked.ThemessageboxrequirestheusertoconfirmtheactionbyclickingOK
orCancel.

Page 154

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

SelectPasswordconfirmationtorequesttheuserslogonpasswordwhenan
objectisclicked.
Inthemayoperatelistbox,youcanspecifytheaccesslevelrequiredtoperform
theaction.SeeUserManageronpage 51formoreinformationonaccesslevels
andtheirpermissions.

NOTE
Control objects have a default may operate setting of Controller(3). If you want individuals with User
security access to be able to perform a control objects action, you must change the may operate level
to User(2).

Box Options
UsetheBoxtabtoaddaborderorbackgroundcolortoadiagramobject.TheBox
tabisavailableonthenumericobjectandthetextboxobjectandanystatusobject
thathasbeenconfiguredasanalphanumericdisplay.
ToviewtheBoxoptions,rightclickontheobjectthenselecttheBoxtab.

TheBoxtabhastwooptions:BorderandBackgroundColor.
TheBordersectionletsyouadjustaborderswidthandcoloraswellaswhetheror
notitisdisplayed.SelectHidetoremovetheborderorShowtodisplayit.Ifyou
selectShow,clickColor...todefineabordercolorandtypeanumberintheWidth
inpixelsfieldtochangethelinethickness.
IntheBackgroundsection,selectTransparenttousethebackgroundcolorofthe
parentwindoworselectCustomandclickColor...toselectanothercolor.
Whileconfiguringboxoptions,usethePreviewarealocatedbesidetheBoxtabto
viewyourproposedchanges.Whenyouarefinished,clickOKtosaveyour
changes.

2007 Schneider Electric. All rights reserved.

Page 155

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Annunciation Options
UsetheAnnunciationfeaturetonotifyusersofachangeofstatus.The
AnnunciationtabisavailableontheStatusObjectonly.

NOTE
The Annunciation feature requires that the Status Objects diagram is displayed; if the display is closed
or minimized, then the annunciation feature does not work.

Toviewtheannunciationoptions,rightclickonthestatusobjectthenselectthe
Annunciationtab.

TheAnnunciationtabhasthreeoptions:Commandline,Messagebox,andInvert
activestate.EachoftheseoptionsrepresentsanactionthatVistaperformswhen
thestatusobjectbecomesactive.
SelectCommandlinetoautomaticallylaunchanotherapplication(forexample,
mplay32/playtoexecutea.wavfile)intheeventofachangeinstatus.Enterthe
programsexecutable(.exe)commandintothefieldprovided.
SelectMessageboxtospecifyanannunciationmessage.Typeyourmessageinto
thefieldprovided.Thefirstlineoftextappearsasthetitleofthemessagebox.
SelectInvertactivestatetochangethewaythestatusobjectreactstoanactive
state.Whenthisoptionisselected,thestatusobjecttreatsanactivestateasinactive
andviceversa.Thisisuseful,forexample,incaseswhenyouwanttobenotified
ifafunction(suchasacoolingfan)switchesoff.

NOTE
Selecting the Invert active state check box also inverts the default colors of the status object.

Page 156

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Alarming Options
EverytypeofeventthatoccursinanIONsoftwarenetworkhasaprioritizedvalue
thatidentifiesitsrelativesignificanceonascaleofzeroto255.Bydefault,Vista
identifiesanyeventwithapriorityof128orgreaterasanalarm.
UsetheAlarmingtabtocreateordeleteapriorityrange,specifythesecuritylevel
requiredtoacknowledgeanalarm,orcustomizethewayVistaannunciatesan
alarm.
ToviewtheAlarmingoptions,rightclickontheEventorGlobalEventLogViewer
thenselecttheAlarmingtab.

TheAlarmingtabhasthreemainsections:Priorityranges,mayacknowledge,and
Annunciation.
Priorityrangesliststhecurrentlyconfiguredalarmranges.Whenyouclickona
rangeinthePriorityrangessection(forexampleRange192255),theother
sections(mayacknowledgeandAnnunciation)displaythecurrentsettingsforthat
range.Youcanproceedtomodifyanyofthesesettingsforthespecifiedrange.
(Yourchangesaffectonlythecurrentlyselectedpriorityrange.)
UsetheNewandDeletebuttonstoaddanewpriorityrangeortoremovean
existingone.Tospecifyanewrange,clickNew.InthePrioritybox,typeanumber
representingthelowerlimitofthenewrangethenclickOK.

Theupperlimitofthenewrangeisautomaticallydefinedbythelowerlimitofthe
existingrange.Forexample,ifyouhaveanexistingrangeof128191,youcantype
100thenclickOKandtherange100127appears.Ifyouwanttodeleteanexisting
range,selectitandclickDelete.

2007 Schneider Electric. All rights reserved.

Page 157

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Themayacknowledgelistboxspecifiestheaccesslevelrequiredtoacknowledge
alarmsintheselectedrange.Bydefault,thisoptionissettoController.
TheAnnunciationsectionletsyoucustomizethewayVistaannunciatesanalarm
SelectBeeptoplayabeepingsound.
SelectFlashtohaveaflashingdisplay.
SelectCommandLinetohaveVistatoautomaticallylaunchanotherapplication
intheeventofanalarm.Whenyouselectthisoption,typetheprograms
executable(.exe)commandintothefieldprovidedoruseBrowsetolocatethe
appropriatefile.Thisoptionisusefulforautomaticallyalertingotherusersof
specificeventsthroughpagingsystems,faxtransmissions,oranyother
commandlinecapableapplication.
SelectMessageboxtodisplayanannunciationmessage.Whenyouselectthis
option,typeyourmessageintothefieldprovided.Thefirstlineoftextappears
asthetitleofthemessagebox.

Bydefault,Vistausesabeepingsoundtoannunciateaneventwithapriority
between128191andabeepingsoundcombinedwithaflashingdisplayto
annunciateaneventwithaprioritybetween192255.

NOTE
If your computer is equipped with a sound card, you can replace the default alarm sound with a custom
sound. Save the sound file you want to use as alarm.wav and store it in the ETC directory.

Page 158

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Customizing a Diagram Window

Youcancustomizetheappearanceandconfigurationofanywindowwithinauser
diagram.Youcancustomizeawindowsfontorbackgroundcolor,orconfigure
windowpropertiessuchasbackgroundimage,realtimeandloggeddatalinks,
doubleclickaction,andstaledatasettings.
Inmanycases,Vistausesthepropertiesspecifiedfortheparentwindowasthe
defaultsettingsforanydiagramobjectscontainedwithin.Bymodifyingasetting
intheparentwindow,youautomaticallymodifythesamepropertyonallobjects
insidethewindowthatsharethissetting.(Forexample,anyobjectwithanoption
settoInheritfromParentWindowsharesthisinformation.)Thiscanbeuseful
whenaddingmultiplediagramobjectsthatarealllinkedtothesamesource.
Toaccessanyoftheseoptions,rightclickanywhereinthebackgroundoftheuser
diagramorwindowthatyouwanttocustomize.

NOTE
Right-clicking in the background of a window displays a pop-up menu of available options; however,
right-clicking on any object in the window while in Edit mode (including transparent objects such as text
boxes or grouping windows) displays the configuration options for that object.

Default Font
Youcanchangeawindowsdefaultfont.Thefontyouselectisthedefaultsetting
forallcaptionsandtextlabelswithinthewindow.
Changing the default font
1.

RightclickanywhereinthebackgroundofauserdiagramandselectDefault
Font.

2.

Setthedefaultfont,style,size,effects,color,andformatthatyouwantfromthe
Fontdialogbox.

3.

ClickOKtosaveyourchanges.

Background Color
Youcandisplayanysolidcolorasabackgroundforanywindowinyouruser
diagram.Thedefaultbackgroundcolorisgray.
Changing the background color

2007 Schneider Electric. All rights reserved.

1.

Rightclickanywhereinthebackgroundofauserdiagramandselect
BackgroundColor.

2.

ClickonthecolorthatyouwantfromtheColordialogbox,orclickDefine
CustomColorsformoreoptions.

3.

ClickOKtosaveyourchange.

Page 159

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

Configuring Window Properties

ToviewtheWindowPropertiesConfigurationoptions,rightclickanywhereinthe
backgroundofanywindowinyouruserdiagramandselectProperties.
TheWindowPropertiesConfigurationboxappearswithfiveoptiontabs:Image,
QueryServer,Node,ActionandUpdates.

Image: Displaying a Background Image

YoucanusetheImagetab inthePropertiesdialogtospecifyabackgroundimage
fortheactivediagramorgroupingwindow.
Toviewtheimageoptions,selecttheImagetabontheWindowProperties
Configurationbox.

TheImagetabhastwochoices:NoneorCustomimage.
SelectNoneifyoudonotwanttodisplayabackgroundimage,orifyoupreferto
displayasinglecolor.
Todisplayabackgroundimage,selectCustomimageandspecifytheimageyou
wanttodisplay.Vistaacceptsanyimagesavedinthefollowingformats:Windows
bitmap(.bmp),Windowsmetafile(.wmf),orWindowsEnhancedmetafile(.emf).
Youcancreateyourownbackgroundimageusingascannedphotographora
drawingcreatedwithinastandardpaintprogram.Someideasinclude:
Anengineeringdrawingofyourinstallationdepictingthepowerdistribution
systemandthelocationofcriticalelements.
Asinglelinediagramillustratingthepowerdistributionnetworkorthe
individualcomponentsofyourfacility.
Anaerialphotographofyourfacilitydepictingtheapproximatelocationofyour
monitoringequipment.

Page 160

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Asatelliteimageorgeographicalmapdepictingyourtransmissionand
distributionnetwork.
ThefollowingillustrationdepictsasampleVistabackgroundwithhidden
diagramobjects(heretheobjectisvisiblebythehandlesbecauseitisselectedin
Editmode):

Youcanintegrateyourdiagramobjectsintotheimagebyplacingthematthe
appropriatepointsonthedrawing.Usersthendisplaysitespecificinformationby
clickingontheappropriatespotinthebackground.
Specifying a custom background image
1.

Rightclickanywhereinthebackgroundofthewindowyouwanttocustomize
andselectProperties.

2.

SelecttheImagetabontheWindowPropertiesConfigurationdialogbox.

3.

SelectCustomimageunderBackgroundImage,andclickBrowse.

4.

SelecttheimagefileyouwanttouseandclickOpen.

5.

ClickOKtosetthisimageasthebackground.

Query Server: Setting a Default Query Server for a Window

UsetheQueryServertabtospecifyaloggeddatasourceforanywindowinauser
diagram.TheQueryServerthatyouchooseprovidesthedefaultsourceoflogged
dataforallEventLogViewers,DataLogViewersandGroupingObjectswithinthe
window.
Setting a default Query Server for a window

2007 Schneider Electric. All rights reserved.

1.

RightclickanywhereinthebackgroundofthewindowandselectProperties
fromthepopupmenu.

2.

ClicktheQueryServertabintheWindowPropertiesConfigurationbox.

Page 161

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

3.

SelecteitherInheritfromparenticonorCustomQueryServer.

SelectInheritfromparenticonfortheactivewindowtodefaulttothesame
QueryServerusedbytheparenticon.(Theparenticonisthediagramobject
thatyouclickedtoopenthiswindow.)
SelectCustomQueryServerthenclickEditLink...todisplayadialogbox
whereyoucanselectanewqueryserverlink.
WhenyouclicktheEditLink...button,theCreateLinkdialogboxisdisplayed.
T

UsetheCreateLinkdialogboxtospecifyaquery.
1.

DoubleclickontheQueryServerthatyouwantfromtheNodesbox.

2.

DoubleclickonQueryModulesfromtheManagerbox.

3.

DoubleclickontheQuerythatyouwantfromtheModulesbox.

4.

DoubleclickonthequeryregisterthatyouwantfromtheOutputRegistersbox.

5.

ClickOKtoacceptyournewconfiguration.

ThenameoftheselectedQueryServerandregisteraredisplayedastheGroup
NameontheQueryServertaboftheWindowPropertiesConfigurationbox.

Page 162

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

Node: Setting the Default Node for a Window

UsetheNodetabtospecifyarealtimesourceforanywindow(orgroupingobject)
inauserdiagram.Thenodethatyouchooseprovidesthedefaultsourceofreal
timedataforallnumeric,status,andcontrolobjectswithinthewindow.Italsois
theparentnodeforanyDataLogViewerorEventLogViewerobjectsplacedinthe
window.

TheNodetabofferstwooptions:InheritfromparenticonandCustom.
SelectInheritfromparenticonforthewindowtousethesamenodeastheparent
icon.(Theparenticonisthediagramobjectthatyoudoubleclickedtoopenthis
window.)
SelectCustomtoselectanewIONnode.SelectIONtochooseadifferentIONnode
thanthatusedbytheparenticon.
Onceyouhavemadeyourselections,clickSelecttodisplayadialogboxwhere
youcanchoosetherealtimesource.
Setting a default node for a window
1.

RightclickanywhereinthebackgroundofthewindowandselectProperties
fromthepopupmenu.

2.

SelecttheNodetabintheWindowPropertiesConfigurationbox.

3.

Dooneofthefollowing:
SelectInheritfromparenticonandclickOKtosavetheconfigurationand
exittheWindowPropertiesConfigurationdialog.
SelectCustom,thenselectION,andclickSelecttocontinue.TheSelect
Nodeboxisdisplayed.Youcannowselectadefaultrealtimesourcefor
thewindow.SeeSpecifyingadefaultlinktoanIONnode(below).

Specifying a default link to an ION node

IfyouselectedanIONlink,theSelectNodeboxisdisplayed.

2007 Schneider Electric. All rights reserved.

Page 163

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

1.

SelectanodethenclickOK.
ThenewlinkinformationisdisplayedontheNodetab.

2.

ClickOKontheWindowPropertiesConfigurationboxtoacceptyournew
configuration.

Action: Specifying an Action for a Window

YoucanspecifyanactionforVistatoperformuponopeningorclosingaparticular
window.Forexample,ifyouwantVistatoautomaticallyengageamodemtool
(suchastheConnectionManager)everytimeyouopenacertaingrouping
window,youcanspecifythetoolasanaction.
Specifying an Open or Close action
1.

Rightclickanywhereinthebackgroundoftheuserdiagramorgrouping
windowthenselectProperties.

2.

SelectCommandLineonOpenorCommandLineonCloseontheActiontab.

3.

ClickBrowse.IntheBrowsedialogbox,locatetheprogramyouwant,selectthe
.exefile,andclickOpen.
Thespecifiedfileandpathnameappearsintheboxbelowtheselectedoption.

4.

Page 164

ClickOKtosaveyourchanges.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 4 - Vista

NOTE
To remove an action, clear the check box beside the option.

Updates: Setting the Time Interval

Datathatisnotupdatedisconsideredstaledata.Vistadetectsstaledataasit
occursandidentifiesitwithacoloredborder.

OntheUpdatestab,youcanspecifyhowoftenVistaupdatesthedatadisplayed
theintervaloftimeVistausestodetectstaledataVista.TheUpdatetabhastwo
sections:UpdatePeriodandStateData.
TheUpdatePeriodsectionallowsyoutospecifyhowoftendatainthatwindowis
refreshed.
TheStaleDatasectionallowsyoutospecifywhetherdataishighlightedandhow
olddatamustbetobeconsideredstale.

NOTE
The Update Period and Stale Data settings in the Vista diagrams define these settings in WebReach.

Changing the update and stale data settings

2007 Schneider Electric. All rights reserved.

1.

Rightclickanywhereinthebackgroundofthewindow,selectProperties,then
clicktheUpdatetab.

2.

EnteranumericvalueinsecondsineithertheUpdatePeriodorDatastaleafter
fieldstosettheintervals.

3.

SelectorclearHighlightStaleDatatoenableordisablecheckingforstale
data.

Page 165

Chapter 4 - Vista

ION Enterprise 5.6 User Guide

4.

ClickOKtosaveyourchanges.

Tochangethecoloroftheborder,closetheWindowPropertiesConfigurationbox,
thenclickOptions>FlagColors.IntheFlagColorsbox,clickEdit...besideStale
FlagColortodisplayadialogboxwhereyoucanselectadifferentcolor.

Page 166

2007 Schneider Electric. All rights reserved.

WebReach
WebReachenablesIONEnterprisetodisplayVistadiagramsinawebbrowser.
WithWebReach,multipleuserscanaccessanddisplaynetworkandother
diagramscreatedinVista,withouthavingtoinstalladditionalsoftware.

NOTE
Currently only the Microsoft Internet Explorer (version 6.0 and later) web browser is supported by
ION Enterprise.

In This Chapter
WebReach Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
WebReachInstallationAfterIONEnterpriseisInstalled .................. 168
PreliminarySetup ................................................... 169
DisplayingVistaDiagramsOnline..................................... 169
ViewingHistorical(Trend)Data ....................................... 170
ViewingMeterEvents ................................................ 172
AddingaGlobalEventViewer ........................................ 173
StaleDataorErrorIndicators.......................................... 174
Advanced WebReach Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
CustomNetworkDiagramSetup...................................... 174
WebReachRegistrySettings........................................... 175
AdditionalInformation............................................... 176
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

2007 Schneider Electric. All rights reserved.

Page 167

Chapter 5 - WebReach

ION Enterprise 5.6 User Guide

WebReach Support
TheWebReachcomponentofIONEnterpriseemploysathinclientdesign,
allowinguserstoaccessanddisplayVistascreensinawebbrowser.WebReach
managesallthenecessarydataprocessingandsystemfunctionsattheserverand
usestheXMLtoprocessVistaobjectsanddatafordisplayonthewebpages.
UseawebbrowserfromanymachineonyournetworktoviewtheVistadiagrams
ofdevicesinyourpowermanagementsytem.Objectsdisplayedintheweb
browserincluderealtimenumericdata,fullorpartialgauges,background
graphicsordiagrams,andbasicviewsofevent,dataandwaveformlogs.
AlthoughidenticalinmanywaystoVista,WebReachhascertaindifferencesand
limitations:
AccesstothescreensgeneratedbyWebReachiscontrolledaccordingtothe
usersnetworkpermissions.
AVIobjectsarenotsupported;theyappearasgreyboxesonscreen.
ThescreensdisplayedbyWebReacharereadonly;controlobjectssuchas
On/OffandTriggerswitchesaredisabled.
ThetimedisplayedbyWebReachisthelocaltimeatthewebserver,notatthe
clientcomputer.

NOTE
To ensure the correct local time is displayed in WebReach, check that each device (meter) in the network
is configured correctly. To do this, use Designer to open the meters Clock module and check its settings.
Ensure that the following setup registers are properly configured: TZ Offset, DST Start, DST End, and DST
Offset.

WebReach Installation After ION Enterprise is Installed

WebReachisautomaticallyinstalledandenabledifIIS(InternetInformation
Services)isdetectedduringtheIONEnterpriseprimaryserverinstallation.
ToinstallWebReachafterIONEnterprisehasalreadybeeninstalledonthe
primaryserver:

Page 168

1.

InstalltheIISWindowscomponent(consultWindowshelpifyouneed
assistance).

2.

OpenControlPanelanddoubleclickAddorRemovePrograms.

3.

SelectChangeorRemovePrograms.SelectIONEnterprise,thenclickChange.
TheInstallShieldWizardstarts.

4.

SelectModifythenclickNext.

5.

FollowtheinstallerdirectionstoinstallWebReach.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 5 - WebReach

Preliminary Setup
BeforeyoucanseetheWebReachpages,anetworkdiagram(network.dgm)
mustexist.WebReachprocesseseachelementinthenetworkdiagramand
convertsthemfordisplayinthewebbrowser.Theeasiestwaytocreateanetwork
diagramistoautomaticallygenerateitinVista.
Generating the network diagram automatically
1.

StartVista.

2.

ClickFile>Generatenetworkdiagram.

3.

ClickFile>Save.

ThisgeneratednetworkdiagramiswhatWebReachusestodisplayasitshome
page.

Displaying Vista Diagrams Online

UseawebbrowsertoviewthewebversionoftheVistanetworkdiagram:
1.

StartInternetExplorer.

2.

Ontheaddressbar,enterhttp://ComputerName/ION,whereComputerName
istheserverscomputername(e.g.http://Workstation2/ION),oritsIPaddress
(e.g.http://10.1.1.1/ION).Ifyouareusingawebbrowserontheactualserver,
youcanusehttp://localhost/IONtoviewtheWebReachgeneratedVista
diagrams.

NOTE
If you changed the default virtual root, substitute the appropriate value for ION in the address.

2007 Schneider Electric. All rights reserved.

3.

Theinitialviewdisplaysagroupingobjectforeachgroupthatexistsinyour
IONnetwork.Clickagroupingicontodisplayitscontents(e.g.meters
belongingtothatgroup).

4.

ClickametericontodisplayitsVistauserdiagram.

Page 169

Chapter 5 - WebReach

ION Enterprise 5.6 User Guide

Viewing Historical (Trend) Data

WebReachprovidesawebbasedgraphingutilityforviewinghistoricaldata.This
utilityallowsyoutoselectthedaterangeanddatathatyouwanttoview.
Viewing historical data graphically
1.

Clickthemetericontoopenitsdiagram,thenclickthelinkortabthatcontains
thebuttonforthetrendinginformationyouwanttoview.

2.

ClicktheDataLogViewerbutton
thatcorrespondstothedatalogyouwant
toview.Thedateselectionscreendisplays:

The week ranges begin on Sunday and

end on Saturday

3.

Setthedaterange,thenclickShowTable.Thedatalogscreendisplays:
To go back to the main device diagram
screen, click Device Diagram.
To change the dates to display, click
Change Date Range.

Page 170

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 5 - WebReach

4.

Selectthecheckboxesfortheparametersyouwanttograph,thenclickShow
Graph.

5.

Selectorclearthecheckboxesinthelegendtoshoworhidethecorresponding
datainthegraph.

6.

Youcanmanipulateandcontrolthedisplayedscreenbydoingthefollowing:
Tozoominonthegraph,clickanddragyourmousetoselecttheportion
youwanttozoominon,thenreleasethemousebutton.
Tomoveacrossthegraph,rightclickanddragyourmouseinthedirection
youwanttomove.

NOTE
You can return to the original view of the graph by refreshing your browser display (i.e. press F5). Click
the Show Table button to return to the data table screen.

Editing the graph

Tochangetheappearanceofthegraph,clickEditGraph(nearthetoprightcorner
ofthescreen).TheEditingdialogboxdisplays,whereyoucansetparametersthat
changethegraphsappearance.Youcanalsoexportthegraphtovariousimage
formatsandconfigureoptionsforprintingthegraph.

2007 Schneider Electric. All rights reserved.

Page 171

Chapter 5 - WebReach

ION Enterprise 5.6 User Guide

RMS Waveform Plotting

WebReachplotsthecalculatedRMSvaluesforwaveforms.Youcanshoworhide
theseRMSvaluesbyselectingorclearingtheappropriatebox.

Viewing Meter Events

ViewingMetereventsissimilartoviewinghistoricaldata.

NOTE
You cannot acknowledge alarms on the screens generated by WebReach since control functions are not
supported.

Viewing the Meter events

Page 172

1.

Clickthemetericontoopenitsdiagram,thenclickthelinkortabthatcontains
thetheMetereventsbutton.

2.

ClicktheMetereventsbutton

.Thedateselectionscreendisplays.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 5 - WebReach

3.

Setthedaterange,thenclickShowTable.TheMetereventsscreendisplays:

Adding a Global Event Viewer

TodisplaytheVistaGlobalEventVieweronline,youneedtocreateanEventLog
ViewerobjectintheVistadiagramandlinkittotheGlobalEventLog.Toaddthis
objecttothehomepageforWebReach:
1.

Opennetwork.dgminVistaandmakesureyouareatthetoplevel(i.e.titlebar
displaysUserDiagram:network).

2.

Switchtoeditmode(i.e.Options>ShowToolboxisselected).

3.

DraganEventLogViewerobjectontothediagram.

4.

Rightclicktodisplayitsproperties.Addacustomcaption,ifyoulike.

5.

ClicktheQuerytab.ClickEditQuery.

6.

SelectGlobal,thenclickAdd.ClickNext.

7.

SelectAdvancedlogview.SelectGlobalEventLog,thenclickAdd.ClickNext.

8.

IntheAvailablearea,selectthecolumnsyouwanttodisplay,thenclickAdd.
IntheSelectedarea,ifyouwanttochangetheorderofthecolumns,selectthe
column,thenusetheupordownarrowbuttonstomoveitaccordingly.Click
Next.

9.

Selectthecolumnyouwanttoassignasthefirstsortingcriteria,thenclickAdd.
Repeatforthesecondsortingcriteria,andsoon.IntheSortOrderarea,
doubleclickthecolumntochangeitssortorder(e.g.changefromascending
todescending).

10. ClickFinish.
11. ClosetheToolbox(i.e.switchtoviewmode).
12. ClickFile>Save.

2007 Schneider Electric. All rights reserved.

Page 173

Chapter 5 - WebReach

ION Enterprise 5.6 User Guide

Stale Data or Error Indicators

WebReachusestheVistastaledatasettingsforitsdiagrams.Staledataanderrors
aredisplayedinthewebbrowserasfollows:
Ayellowbordersurroundinganobjectindicatesstaledata.
Anorangebordersurroundinganobjectindicatesanerrorincommunications,
securityaccess,configuration,orothersystemerror.

NOTE
See the Vista chapter for the definition of stale data. Although you can change the stale and error flag
colors in Vista, the color indicators for these flags do not change in WebReach. Contact Engineering
Services if you need to change the default WebReach flag colors.

Advanced WebReach Configuration

Thissectionisintendedforadvancedusersonly.Customizationandadvanced
configurationinformationforWebReachiscoveredhere.

CAUTION
If you use Registry Editor incorrectly, you may cause serious problems that may require you to reinstall
your operating system.

Custom Network Diagram Setup

ThissectiondescribeshowtochangethedefaulthomepagethatWebReach
displays.
Ifyouhaveacustomnetworkdiagramontheprimaryserveryouwouldliketouse
insteadoftheautomaticallygeneratednetworkdiagram:
1.

StartWindowsRegistryEditorandnavigateto:
HKEY_LOCAL_MACHINE\SOFTWARE\SchneiderElectric\ION
Enterprise\5.6\WebReach

2.

RightclicktoaddanewstringvalueandnameitNetworkDiagram.

3.

RightclickNetworkDiagram,selectModify,thentypethepathandnameof
yourcustomnetworkdiagramintheValuedatafield.ClickOK.

Formoreinformation,refertotheNetworkDiagramiteminthetableunderthe
sectionWebReachRegistrySettings.IfthereisnoNetworkDiagramentryinthe
registry,thenthedefaultvaluexpml:/diagrams/ud/network.dgmisused.
TheNetworkDiagramnavigationbuttonlocatedonthedaterangepageandthe
resultspageisautomaticallyupdatedtolinktothecustomnetworkdiagramyou

Page 174

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 5 - WebReach

specified.However,theNetworkDiagrambuttonthatexistsineachmeteruser
diagramusesahardcodedlinktoxpml:/diagrams/ud/network.dgm.UseVista
tomanuallyupdatetheNetworkDiagramlinkinthemeteruserdiagrams.
Changing the link for the Network Diagram button
1.

StartVista.

2.

Makesurethetoolboxisdisplayed(selectOptions>ShowToolbox).

3.

RightclicktheNetworkDiagrambutton.SelecttheActiontab.
MakesuretheOpenUserDiagramoptionisselected.

4.

ClickBrowse...tolocateyourcustomnetworkdiagram.Selectthediagram
filename,thenclickOpen.

5.

ClickOK.Saveyourchanges.

WebReach Registry Settings

TheregistrykeysforWebReacharelocatedin
HKEY_LOCAL_MACHINE\SOFTWARE\SchneiderElectric\ION
Enterprise\5.6\WebReach.
ThistableliststhedefaultWebReachregistryentriesandsettings:

Default Registry Entries

Default Setting

Description

AutoDiagramTimeout

20000 milliseconds

Timeout period for the autodiagram components to communicate with the device
and determine the appropriate template to open.

ExpireTimeLimit

20 seconds

Time limit for a diagram subscription to update its timestamp. If the subscription
is not updated within this time period, it is considered expired and is removed.

SubscriptionObject

pmlitem:webreachstore:

The name (tag) that the subscription service uses to find WebReach-related
information.

VirtualDirectory

ION

The part of the web address that points to the WebReach-generated Vista
diagrams for displaying in the browser.

XMLRefreshInterval

3000 milliseconds

The real time data update rate on the web page.

Thistableliststheoptionalregistryentriesyoucansetforcustomfunctionality.

Optional Registry Entries

NetworkDiagram

QueryTimeout

Default Setting
x-pml:/diagrams/ud/
network.dgm

See description

2007 Schneider Electric. All rights reserved.

Description
This key lets you specify the network diagram you want to display as the default
for WebReach. The value can be a relative path, such as the default setting, or it
can be an absolute file path (e.g. D:\customdiagrams\ud\networkB.dgm).
This value determines how long WebReach waits for the results of a query to
return from the database before timing out. If this registry entry is not created or
no QueryTimeout value is specified, WebReach times out after 60 seconds.
This optional registry entry is useful if you know that a query will take more than
60 seconds to return its results and you do not want WebReach to time out before
then. Specify a value that gives you enough time to get your query results.

Page 175

Chapter 5 - WebReach

ION Enterprise 5.6 User Guide

Additional Information
Virtual Root
Virtualrootreferstotherootdirectoryyouseewhenyouenterawebaddressina
webbrowser.ThevirtualrootsettingisconfiguredthroughtheIIScontrolpanel.
ThedefaultvirtualrootforWebReachisION(http://ComputerName/ION).
VirtualrootpointstothefolderontheserverwhereWebReachstoresandaccesses
thefilesitneedstoprocessthedatafordisplayinginthebrowser.Theactualfolder
locationforvirtualrootis...\IONEnterprise\System\WebReach.

Virtual Directory
Avirtualdirectoryisthenetworksharenameforafolder.Itcorrespondstothe
actual(target)folderontheserver,whichIISpointstowhendisplayingwebpages
onthebrowser.Virtualdirectoriesallowyoutosetthefolderpermissionsfor
individualsornetworkusergroups.
ConsiderhowIIS(InternetInformationServices)isdeployedontheserverwhen
settingpermissionsonyourvirtualdirectories.Factorstoconsiderinclude
accessibility(privateintranetuseonlyorpublicinternetaccess),traffic(numberof
concurrentusers),probabilityofhackeractivity,etc.
Virtualdirectoriesshouldonlyuseanonymouspermissions(Windowsintegrated
loginsshouldnotbeallowed).Ifyouuseanonymouspermissionsincombination
withproperdrive,folder,andregistryhivesecurity,youcanensureagood
balancebetweenprovidingconvenienceforpotentialwebclientsandminimizing
securityrisks.Toensurepropersecurity,theEveryonegroupsdefault
permissionsforalldrives,subdirectories,andregistryhivesshouldbemodified
accordingtoyourcompanysITsecuritypolicy.RefertotheMicrosoftMSDN
websitefordefinitions,proceduresandconfigurationdetails.

NOTE
By default, the Everyone group includes the IUSR_[pc name] account and the IWAM_[pc name] account.

Page 176

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 5 - WebReach

WebReach Folder Permissions

IfyouareusingthedefaultWindowspermissionsettings,youmaynotneedto
makethechangesbelow,sincetheEveryonegrouphasfullcontrolonalldrives,
includingallnonadministratorsharesandallregistryhives,bydefault.
Location
...\ION Enterprise\system\webreach

Account(s)

Permissions

IUSR_[pc name]

deny write

IUSR_[pc name]

deny write

IWAM_[pc name]

deny write

C:\WINNT\system32\msvbvm60.dll2

IUSR_[pc name]

allow read and execute

HKEY_LOCAL_MACHINE3

Everyone Group

allow full control

C:\Inetpub\wwwroot1

The C:\Inetpub\wwwroot folder is the only sub-folder that requires these permissions, unless the FTP
server is being used. If using the FTP server, then C:\Inetpub\ftproot requires these permissions too.

This is a mandatory requirement for WebReach to function properly.

This is required for proper ASP functionality. Run regedt32 to modify the registry if necessary.

Troubleshooting
WebReachdependsontheIONXMLSubscriptionServiceandIONXML
SubscriptionStoreServicetofunctionproperly.Ifyouareexperiencingdifficulties
withWebReachpages(suchasgettinganerrormessagewhenyoutrytoopena
devicediagram),checktomakesurethisservicehasbeenstarted.
No real-time data is displayed
ThismaybecausedbysecuritysettingsbeingresetbyaMicrosoftWindows
update.Ifthisisthecase,openInternetExplorer,selectTools>InternetOptions,
thenclicktheSecuritytab.ClicktheTrustedsitesicon,thenclickSites.Addthe
WebReachwebsite(i.e.http://<computername>/<WebReachvirtualroot>)to
theTrustedsiteszone.
Page cannot be displayed error
Thismaybecausedbycomplexorlargequeries,suchthattheresultsdonotarrive
withinthedefaultWebReachtimeoutsettingof60seconds.Ifyoususpectthisto
bethecase,addthecustomDWORDregistrykeyQueryTimeoutandsetittoa
higherdecimalvalue(e.g.120).
Tick labels for gauges are unreadable
ThismayoccurifyouspecifyanunsupportedfontfortheTicksLabelFont.Tofix
this,selectonlyTrueTypeorOpenTypefonts.

2007 Schneider Electric. All rights reserved.

Page 177

Chapter 5 - WebReach

Page 178

ION Enterprise 5.6 User Guide

2007 Schneider Electric. All rights reserved.

Reporter
ReporteristheIONEnterpriseprogramthatdefines,generatesandmanages
comprehensivereports,basedoninformationcontainedinyourdatabase.
ReporterprocessesselecteddataandgeneratesafinishedreportinMicrosoftExcel
format.

NOTE
Microsoft Excel 2003 must be installed on your machine for Reporter to function.
Microsoft Outlook 2003 must be installed if you require reports to be emailed.

In This Chapter
Reporter Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Starting Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Creating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
WizardStep1:SelectTemplate ....................................... 181
WizardStep2:SelectDatabaseandSources ............................ 181
WizardStep3:SetUptheReportOptions.............................. 183
PreviewingtheReport................................................ 185
Generating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Types of Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
EnergyandDemand................................................. 186
LoadProfile......................................................... 187
PowerQuality....................................................... 187
EN50160............................................................ 189
IEC61000430 ...................................................... 190
Waveforms ......................................................... 191
ModifyingtheFinishedReport........................................ 192
UpgradeConsiderations .............................................. 192
CustomTemplates ................................................... 192
Creating a Report Without a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Automatic Report Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Using Reporter on Secondary Server or Client . . . . . . . . . . . . . . . . . . . . . 194
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

2007 Schneider Electric. All rights reserved.

Page 179

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Reporter Basics
Reporterfeaturesawizardthatguidesyouthroughthereportcreationprocess.
Thisinvolvesselectingareporttemplateanddatabase,whichthenallowsthe
wizardtodisplaythosesourcesintheIONnetworkthatcontainthetypeofdata
requiredtocreatethereport.
Whenthereportisgenerated,ReporterretrievesdatafromtheIONdatabase,uses
thereporttemplatetoprocessthedata,thencreatesafinishedreportinMicrosoft
Excelformat.
Reporttemplatesarepreconfiguredforthemostcommonreportingneeds.The
followingreporttemplatesaresuppliedwithIONEnterprise5.6:
EnergyandDemand
LoadProfile
PowerQuality
EN50160_General
EN50160_Summary
EN50160_Mains_Signal
IEC61000430_10Min
IEC61000430_2Hr
IEC61000430_3Sec

Starting Reporter
YoucanstartReporterusingoneoneofthefollowingmethods:
UsetheIONEnterpriseshortcutonyourdesktoptoopenthetaskpad,thenclick
Reporter
OpentheIONEnterpriseToolsfolderonyourdesktop,thendoubleclickthe
Reportericon
ClickStart>Programs>SchneiderElectric>IONEnterpriseTools>Reporter.
ReporteropenswitheitherManageReportsorGenerateReportspreselected,
dependingonwhetherornotanyreportshavealreadybeencreated.Youcannot
generatereportsuntilyouhavecreatedatleastone.

Creating a Report

Page 180

1.

StartReporter.

2.

SelectManageReports,thenclickNew.Thisstartsthenewreportwizard.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

Wizard - Step 1: Select Template

1.

TypethenameofthereportintheReportNamebox.

2.

SelectthetemplateyouwanttouseintheReportTemplatelist.

3.

ClickNext.

Wizard - Step 2: Select Database and Sources

1.

Specifyyourdatabase(ION_Dataisselectedbydefault).Toconnecttoa
differentdatabase(e.g.anarchiveddatabase),usetheDatabasebox,orclick
More.

2.

Selecttheboxbesideeachsourcename(device)thatyouwanttoincludein
yourreport.SelecttheShowDetailsboxifyouwanttoseeadditional
informationforthedevices.

NOTE
Show Details is only available when "Show only sources applicable to the template" is selected.

3.

IfthereporttemplateyouareusingrequiresaTOUschedule(suchasEnergy
andDemand),selectonefromtheTOUSchedulebox,orclickManageto
createanewone.

TOU Schedules
AtypicalTOUschedulehasOnPeak,OffPeakandShoulderPeakperiods.The
EnergyandDemandreporttemplaterequiresaTOUschedule.Ifyoudonotwant
touseaTOUschedule,simplycreateaTOUschedulewithasingleTariffperiod.
Creating a New TOU Schedule
1.

IntheTOUScheduleswindow,clickNew.ThiscreatesablankTOUschedule
withasingletariff.
IntheTOUSchedulePropertieswindow,usetheleftpanetoselecttheitemyou
wanttoedit,thenusetherightpanetoenter,modifyorsetthevalues.

NOTE
If an existing (configured) TOU Schedule appears in the list, you can use it as a template to create a new
one with similar On Peak/Off Peak periods. See Copying an Existing TOU Schedule on page 183.

2007 Schneider Electric. All rights reserved.

2.

SelectNewTOUSchedule,thenusetheTOUScheduleNameboxtorename
it(forexample,2007TOUSchedule).

3.

SelectTariff1todisplaytheTariffDetailsontherightpane,thenusetheName
boxtotypeatariffnameforit(forexample,OffPeak).

Page 181

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Usetherateboxes($/kWh,$/kWetc)toenterthetariffrates.
4.

Ontheleftpane,clickthe+besidethetarifftoexpandit.Selectthetext
underneathit(AllDay,EveryDay...)todisplaytheTariffPeriodfields.Usethe
FromandToboxestosetatimerangeandadaterangeforthetariffperiod.

Tocreateanothertariffperiod,selectthetariffperiodyoujustconfigured,then
clickNewtoaddanewtariff.Setthetimerangeanddaterangeforthisnew
tariffperiod.
5.

Tocreateanewtariff(forexample,OffPeak),selectthetariffname,thenclick
New.Repeattheaboveproceduretorenamethetariff,settherates,andsetthe
tariffperiods.

Holidays

Page 182

1.

SelectoneoftheOffPeakperiods,thenclickNew.

2.

Renamethetariff(forexample,Holidays)andclickonthedayandtimes
underneathtoconfigurethetariffperiod.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

3.

Selecttheappropriatecountryholidaysfromthelist.

4.

Addorremoveindividualholidaysasrequired.

CAUTION
Make sure there are no gaps or overlapping date or time ranges in the TOU Schedule.

Copying an Existing TOU Schedule

TocreateaTOUScheduleusinganexistingoneasatemplate,selectitthenclick
Copy.Renamethecopyandandmodifyitspropertiesasneeded.

Wizard - Step 3: Set Up the Report Options

Thereportoptionsareorganizedinthedifferenttabsofthewindow,namedas
follows:DateRange,Distribution,Validation,Display,andNotes.

Date Range
Selectthedaterangeyouwanttouseforyourreport:
AskforDateRangewhenreportisgeneratedpromptsyoutosupplyadate
rangewhenthereportisrun(interactivemode).
PrespecifiedDateRangeletsyouselectaspecificperiod.Forexample,select
LastMonthtosetReportertorunthereportusingdatafromtheprevious
month.SelectFixedRangetospecifyastartandendtime/date.SelectCustom
RelativeRangetospecifyadaterangerelativetothecurrenttimeanddate.

NOTE
In applications where a report is generated based on a power quality system event or similar setpoint
condition, specifying Custom Relative Range can include data that shows how the system was behaving
before the event occurred.

2007 Schneider Electric. All rights reserved.

Page 183

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Distribution
SelectanyoralloftheDistributionoptions(youmustselectatleastone):
Showreportonscreenisselectedbydefault;thisdisplaysthereportonscreen
eachtimethereportisgenerated.Clearthisboxtodisabledisplayingofthe
report.
SaveExcelreporttofolderstoresthereportinthefolderyouspecifyusingthe
Browsebutton.
SaveHTMLreporttofoldersavesanHTMLversionofthereportinthefolder
youspecifyusingtheBrowsebutton.
NotethattherearecertainelementsandbehaviorsintheHTMLreportthat
mayappeardifferentlyfromtheoriginalExcelreport.ThisisduetotheHTML
conversionprocessinExcel.SearchtheMicrosoftsupportknowledgebasefor
moreinformation.
Sendreporttoprinterprintsthereporteachtimeitisgenerated.Selectthe
printeryouwanttousefromthelist.
Emailreporttorecipientssendsthereport(inExcelformat)toanemailaddress,
usingMicrosoftOutlook2003.ClickNewtoaddanewemailaddressorDelete
toremoveanexistingonefromthelist.

Validation
SelectReportduplicateandmissingentriestoenableerrorchecking.
UsetheHours,MinutesandSecondsboxestospecifyanexpectedtimeinterval
betweeneachrecord.
SelectRemoveduplicaterecordstodeleteredundantrecordsfromthereport.
IfyouwantReportertoinsertrecordsautomaticallyforonesthataremissing,
selectReplacemissingrecordswith:thenselecteitherValuesfromthe
previousroworAnemptyrow.

Display
SelectoneoftheoptionstocontrolhowReporterhandlesrawdatasheetsinthe
report(Show,Hide,orDelete).

NOTE
The Delete (raw data sheets) option is useful when you want to reduce the reports file size (this
particularly applies to those reports that contain a significantly large amount of data).

TheDisplayOptionsgridlistsotheroptionsyoucanturnonoroff.Doubleclick
theappropriaterowtoturntheoptiononoroff.

Notes
UsetheNotestabtoenterdetailsaboutyourreporttemplate,suchasrevision
history.Toinsertalinebreak,holddownCTRLandpressENTER.

Page 184

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

Previewing the Report

Toseewhatthereportwouldlooklikewithoutsavingordistributingit,click
Preview.ClickBackToReportGeneratorbuttontoreturntothemainReporter
window.Modifythesettings,ifnecessary.Otherwise,clickFinishtosaveyour
reportandreturntothemainReporterscreen.

Generating a Report
1.

OnthemainReporterscreen,selectGenerateReports.

2.

Selectthenameofthereportyouwanttorun.Ifyouwanttoviewitsoption
settings,clickSummary.ClickOKtoclosethesummarywindow.

3.

ClickGenerate.Awindowdisplaystheprogressofthereportgeneration.

4.

ClickClosetoviewthereport.

Types of Reports
ThissectionshowsbasiccharacteristicsoftheMicrosoftExcelreportsgenerated
fromtheReportertemplates.Thefirsttabintheworkbookiscreatedfromthe
Presentationsheetofthereporttemplate.Youcanmodifythelookand
functionalityofareportbyeditingitspresentationsheet.SeeModifyingthe
FinishedReportonpage 192fordetails..

2007 Schneider Electric. All rights reserved.

Page 185

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

NOTE
The presentation sheet contains references that automatically update the data each time the report is
generated. Be careful not to overwrite these references.

Energy and Demand

UsetheEnergyandDemandtemplatetocreateatabularreportonenergy
consumptionandpeakdemandlevelsoveraperiodoftime,categorizedbytime
ofuse.TOU(TimeOfUse)schedulesaretypicallysetuptomatchanenergy
providerstariffschedule.
TheEnergyandDemandtemplateusesquantitiesfromtheEnergyandDemand
log(kWh,kVARh,kVAh,kWDemand,kVARDemand,kVADemand)thatis
availableonmostPowerLogicIONdevices.

TOU Schedule
ReporterrequiresaTOUschedulewhencreatingareportusingtheEnergyand
Demandtemplate.AsampleTOUscheduleisincludedthisallowsyouto
definetimeperiodsthatcoincidewithtimeperiodsinyourenergyproviderstariff
schedule,suchasOnPeakandOffPeaktimes.IfyoudonotneedtouseaTOU
schedule,simplycreateanewTOUschedulewithonlyonetimeperioddefined.

Sample Energy and Demand Report

This column contains
the calculated costs for
each tariff period
This column contains
the KWh, KVARh, and
KVAh value that
applies to each tariff

The tariff (cost in dollars)

appears in this column

TheAggregateEnergy&Demandtabcontainsasummaryofthecombinedenergy
anddemandvalues.Energyanddemandinformationfromdifferentsourcesare
storedinseparatetabsintheworkbook.

Page 186

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

Load Profile
UsetheLoadProfiletemplatetocreateagraphicalrepresentationofdemandor
loadlevelsoveraperiodoftime.Theprofileshowspeakloadspointsonthe
graphwherepeakelectricitydemandishigh.Aloadprofilereportcanbeusedto
analyzetheelectricalloadsatthetimeofmaximumdemand.Thisinformation
createsopportunitiesfordevelopingstrategiestoimproveenergymanagement.
SimilartotheEnergyandDemandtemplate,theLoadProfiletemplateusesdata
fromtheEnergyandDemandlog(kWDemand,kVARDemand,kVADemand),
exceptitdoesnotuseaTOUschedule.

Sample Load Profile Report

Peak power usage for the
specified date range
This graph represents
the power usage for the
specified date range
Timestamps

TheLoadtabcontainsagraphicalrepresentationofthepowerusageofyour
systemovertime(totalloadprofile).Loadprofilesfromdifferentsourcesare
storedinseparatetabsintheworkbook.

Power Quality
UsethePowerQualitytemplatetocreateareportthatsummarizesthenumber
andseverityofvoltagesags,swellsandtransientsoveraperiodoftime.The
finishedreportalsoincludesagraphicalrepresentationofthedisturbances,andan
interactiveselectionofgroupevents.
ThePowerQualitytemplateusesdatafromallthreePowerQualitylogfilesthat
arefoundonIONmeterswithsag/swellandtransientdetectioncapabilities:
Sag/SwellLog
TransientLog
WaveformLog

2007 Schneider Electric. All rights reserved.

Page 187

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Sample Power Quality Report

This graph displays the worst

disturbances recorded.

Click on any incidents

timestamp to view its
details.

ThePowerQualitySummarytabdisplaysachartthatidentifiestheworstline
disturbancesandalistofincidentslinkedtotheirdetails.Anincidentismadeup
ofseveraldisturbances.
ThePowerQualityreportshowsasystemslinefluctuationsforthespecifieddate
range.UsetheInteractivePowerQualitytoolbartochangethetimeinterval
betweenincidents:
Select the incident
interval (time between
power quality events)

ClickthetimestampoftheincidentintheWaveformstabtoviewagraphical
representationofthedisturbance.

Click Show Complete to

display individual waveforms.
Click the magnify buttons to
zoom in or out.

Page 188

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

EN50160
EN50160isasetofpowerqualitystandardsusedbyenergysuppliersandenergy
consumersinEuropeancountries.ThreeEN50160templatesareavailablein
Reporter:

EN50160_General
UsetheEN50160_Generaltemplatetocreateareportcontainingdetailedanalysis
ofallEN50160compliancedataloggedbyasinglemeter.Dataisrecordedforeach
observationperiod.Theworksheetscontainpercentagesofnoncompliant
EN50160measurementssuchasPowerFrequency,SupplyVoltageMagnitude,
andFlicker.
TheEN50160_GeneraltemplateusesdatafromthesefourteenEN50160logfiles:
EN50160VltDp1toEN50160VltDp5(supplyvoltagedips)
EN50160Ovrvlt1toEN50160Ovrvlt3(temporaryovervoltages)
EN50160Vunbal(supplyvoltageunbalance)
EN50160HrmVlt(harmonicvoltage)
EN50160IhmVlt(interharmonicvoltage)
EN50160Frq/Mg(frequencyandmagnitude)
EN50160Flicker(flicker)
EN50160Intrp(shortandlongterminterruptions)

EN50160_Summary
UsetheEN50160_Summarytemplatetocreateareportcontainingcomprehensive
analysisofallEN50160compliancedataloggedbymultiplemeters.The
compliancesummaryisbasedontheEN50160limitsforeachobservationperiod:
eachdefaultEN50160measurementindicatesapassorfailonthecompliancetest
withaY(yes)orN(no)respectively.
TheEN50160_Summarytemplateusesdatafromthesamelogfilesasthe
EN50160_Generaltemplate.
Anobservationsheetisgeneratedforeveryobservationperiod,howeveritis
hiddenbydefault.Youcanaccessspecificobservationsheetsbyunhidingthe
specificsheetforthegeneratedreportinMicrosoftExcel(Format>Sheet>Unhide
>observationsheet).

EN50160_Mains_Signal
UsetheEN50160_Mains_Signaltemplatetocreateareportforsignalline
frequencystatisticsforasinglemeter,foreachobservationperiod.
TheEN50160_Mains_SignaltemplateusesdatafromtheEN50160MSignallog.

2007 Schneider Electric. All rights reserved.

Page 189

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Sample EN50160 Report

IEC 61000-4-30
IEC61000430arepowerqualitystandardsthatdefinemeasurementmethodsfor
50Hzand60Hzpowerqualityinstruments.ThreeIEC61000430templatesare
availableinReporter:

IEC61000-4-30_10Min
UsethistemplatetocreatetheIEC61000430reportbasedona10minuteinterval
samplingperiod.

IEC61000-4-30_2Hr
UsethistemplatetocreatetheIEC61000430reportbasedona2hourinterval
samplingperiod.

IEC61000-4-30_3Sec
UsethistemplatetocreatetheIEC61000430reportbasedona3secondinterval
samplingperiod(i.e.150cyclesfor50Hz;180cyclesfor60Hz).

Page 190

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

Sample IEC6100-4-30 Report

Waveforms
Youcanalsogenerateareportfromlogsthatcontainvoltageandcurrent
waveformdata,byselecting<notemplate>andsettingtheLogtoWaveforms.See
CreatingaReportWithoutaTemplateonpage 192fordetails.

Oncethereportisgenerated,clickthetabnamedforthewaveformquerytoview.
Theleftpanecontainstimestampsthatlinktothewaveformchartontheright
pane.Clickatimestamptoviewthewaveform.
Toviewthewaveformsforeachcurrentandvoltagephase,clickShowComplete
ontheWaveformstoolbar.Usethemagnifyingglassiconstozoominorzoomout.

2007 Schneider Electric. All rights reserved.

Page 191

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Modifying the Finished Report

ThisdescribeshowtoedittheMicrosoftExcelpresentationsheetforyourreport:
1.

OnthemainReporterwindow,selectthereportyouwanttomodify,thenclick
Preview.

2.

UsethePresentationSheettocreatereferencestoelementsinthedatasheetsthat
youwanttoincludeinthefinalreport.UseMicrosoftExcelsdataanalysisand
chartingtoolstoprocesstheinformationinthedatasheets,thenaddthe
appropriatereferencestothepresentationsheet.

NOTE
The company name that appears in the report is the Company name entered when Microsoft Excel was
installed on the computer.

3.

Layoutandformattheelementsasyouwouldlikethemtoappearinthereport.

4.

Saveyourchanges.

Upgrade Considerations
ReportsthatwerecreatedfromearlierversionsofIONEnterprisearesupported.
Youmaycontinuetogeneratethereportsasusual,youcaneditthereports
(includingthequeries)oryoucanusetheReportertemplatestorecreatethese
reports.

Custom Templates
ContactEngineeringServicesifyourequireotherspecializedreporttemplates.

Creating a Report Without a Template

YoucanuseReportertocopyrawdatafromadatabaseandpasteitintoMicrosoft
Excel:
1.

InthemainReporterwindow,selectManageReports,thenclickNew.

2.

FillintheReportNamebox,select<NoTemplate>,thenclickNext.

3.

ClickNewtocreateasource/logqueryforthereport.SettheQueryProperties:
Name:Newqueriesareautomaticallynamedinasequentialmanner,but
youcanalsorenamethemasrequired.
Source:Selectthesourceofthequery(e.g.powermeter).
Log:Choosethedatalogthatyouwanttocopyrawdatafrom.
Database:ION_Data<SQL>isthedefaultsetting.Tochangethedatabase
source,selectonefromthelist,orclickMore.

Page 192

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 6 - Reporter

IfaTOUscheduleisrequired,selectApplyTOUScheduletodatabasequeries,
thenselectonefromthelist,orclickManagetocreateone.
4.

Toaddanotherquery,clickNew,thensetthequerypropertiesasdescribed
above.

5.

Whenyouhaveaddedandconfiguredallyourqueries,clickNext.

6.

Configurethereportoptionsasdescribedinthesection,WizardStep3:SetUp
theReportOptionsonpage 183.

Automatic Report Generation

YoucanusetheWindowsScheduledTasksutilitytogeneratereportsonaset
schedule:
1.

ClickStart>Settings>ControlPanel.DoubleclickScheduledTasks.

2.

DoubleclickAddScheduledTask.UsethewizardtoselectReporterfromthe
listofprograms.

3.

Assignanameforthisnewscheduledtaskandspecifyhowoftenthistask
shouldbeperformed.

4.

Setthestarttimeandotherrelevantdataforyourschedule.ClickNext.

5.

Whenprompted,enteryourusernameandpassword(andconfirmthe
password).ClickNext.

6.

Asummaryscreenofyourscheduleappears.SelectOpenadvancedproperties
forthistaskwhenIclickFinish,thenclickFinish.

7.

ThePropertiesscreenofyourtaskopens.TheTasktabdisplaysthecommand
linetorunReporter.Addaspaceattheendofthecommandlineandappend
r<ReportName>(whereReportNameisthenameofthereportyouwantto
scheduleforautomaticgenerationnotethatspacesinthereportnamearenot
supported):
...\system\bin\repgen.exer<ReportName>
Reporteralsosupportsmultiplereportgeneration.Separatethereportnames
withacomma.Forexample,ifyouhavereportsnamedRep1andRep2,the
commandlinemightlooklikethis:
D:\SchneiderElectric\IONEnterprise\system\bin\repgen.exerRep1,Rep2

8.

VerifyyourschedulesettingsintheScheduletab.Tocreatemoreschedules,
selecttheShowmultipleschedulescheckbox.ClickNewtocreateanew
schedule.

9.

ClickOK.

NOTE
Check the properties of your report to make sure you have specified a valid Date Range for your report
and that the Show Report on screen option is cleared.

2007 Schneider Electric. All rights reserved.

Page 193

Chapter 6 - Reporter

ION Enterprise 5.6 User Guide

Using Reporter on Secondary Server or Client

WhenDatabaseManagerarchivesION_Data,itcreatesaregistrykeyexportfile
thatincludestheDSN(datasourcename)itcreated.Theregistryfileiscalled
ION_DsnKeys.reg,andisstoredontheprimaryserverinthisfolder:
...\IONEnterprise\config\cfg\
IfyouwantanIONEnterprisesecondaryserverorclientinstallationtoreporton
theIONEnterpriseSQLdatabaseusingReporter,importthisregistrykeytothe
secondaryserverorclientbeforegeneratingthereports.
Importing the registry key export file
1.

LocatetheprimaryserversIONEntshare(typically
\\ComputerName\IONEnt,whereComputerNameisthecomputername
ofthePrimaryServer)onyournetworkandnavigatetothe...\ION
Enterprise\config\cfgfolder.

2.

DoubleclickthefilenamedION_DsnKeys.regtoimportitintoyourregistry.

Troubleshooting
Excel file does not open when you double-click its icon
ThismightoccurwhenaMicrosoftExcelprocesshangs.Tofixthis,startExcel,
openafile(orcreateanewone).ClickTools>Options,thenintheGeneraltab,
clearIgnoreotherapplications.CloseandexitExcel.

Page 194

2007 Schneider Electric. All rights reserved.

Designer
UseDesignertoconfigureIONcompliantnodesonyournetwork.AnION
compliantnodecanbeasoftwarecomponentorahardwaredevice.
Designersgraphicaluserinterfacehelpsvisualizeanodesconfiguration.Youcan
linkIONmodulestogethertocustomizeanodeforyourparticularapplication.
Youcanalsocut,copyandpastefunctionalitywithinasinglenodeorbetween
differentnodes.

In This Chapter
Getting Started with Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
StartingDesigner.................................................... 196
TheDesignerInterface ............................................... 197
DisplayModeandEditMode ......................................... 198
DesignerShortcuts................................................... 198
QuittingDesigner.................................................... 199
The Node Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
UsingaNodeDiagram ............................................... 200
Icons ............................................................... 202
GroupingWindows .................................................. 206
Windows ........................................................... 208
Working with ION Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
UsingIONModules.................................................. 210
LinkingandConfiguringIONModules................................. 220
DeletingLinks ...................................................... 225
ConfiguringIONModules ............................................ 228
CopyingandPastingIONModules.................................... 235
ViewingOutputRegisters,SetupRegisters,andInputs................... 244
Time of Use (TOU) Program Management . . . . . . . . . . . . . . . . . . . . . . . . 246
AdvancedTOUScheduleConfiguration ................................ 247
Virtual Processor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
UsingtheVirtualProcessor........................................... 249
DistributedControl.................................................. 250
ModbusCommunications ............................................ 253
CommonVirtualProcessorApplications................................ 255
SettingGlobalParameters ............................................ 257

2007 Schneider Electric. All rights reserved.

Page 195

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Getting Started with Designer

Designerisaprogrammingtoolintendedforadvancedusersonly.Familiarity
withIONarchitectureisessential,asDesignerisbasedonIONarchitecture.
IONtreatsthefunctionsusedintraditionalpowermonitoringasdiscretemodular
objectsthatcanbeinterconnectedandcustomized.Theseobjects,knownasION
modules,arethebasicbuildingblocksthatcompriseanode.
DesignerisusedtomakeanychangestotheoperationofanIONnode.ION
devices,theVirtualProcessorandLogInserterareallconfiguredusingDesigner.
ForthosealreadyfamiliarwithDesigner,refertothesection,DesignerShortcuts
onpage 198foralistofthemostcommonlyusedcommands.

Starting Designer
TostartDesigner,useoneofthefollowingmethods:
1.

DoubleclickontheIONEnterpriseicononyourdesktopthenselect
ManagementConsole.Fromthetoolsmenu,selectSystem>Designer.

2.

OpentheIONEnterpriseToolsfolderonyourdesktopanddoubleclickthe
Designericon.

Logging in
TomakechangesinDesigner,youneedtologinwithauseraccountthathas
Supervisorlevelaccess.Refertothesection,UserManageronpage 51for
details.
Tologinwithoutausernameandpassword,clickViewOnly.StartingDesigner
thiswayallowsyoutoviewnodediagrams,butnotmakechangestothem.

Page 196

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

The Designer Interface

TheDesignerinterfaceconsistsofamainscreenwithatitlebar,amenubar,a
toolbar,aworkspace,andastatusbar.
.

Title bar
Menu bar
Tool bar
Workspace
Communication
status lights
Status line

Time display

Progress indicator

Title bar
Thetitlebardisplaysthenameoftheprogram(Designer),theusername(for
example,guest)andthenameoftheactivenodediagram.

Menu bar
Belowthetitlebaristhemenubar.Clickonamenunametodisplayalistof
availablecommands.

Toolbar
TheToolbarconsistsofarowofbuttons,offeringquickaccesstothecommands
usedmostfrequently.Eachcommandofferedonthetoolbarisalsoavailablefrom
themenubar.
Open

Reset Module

Cut

Paste

Save

Create a Link

Copy

Help

Tochooseacommandfromthetoolbar,clickonthecorrespondingbutton.When
youpointatatoolbarbutton,adescriptionofitappearsinthestatusbaratthe
bottomofthescreenandonasmallToolTipbesidethebutton.

Workspace
Themainareainthecenterofthescreenistheworkspace,whereyouviewandedit
nodediagrams.

2007 Schneider Electric. All rights reserved.

Page 197

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Status bar
ThestatusbardisplaysinformationonspecificDesignerfunctions.The
components,fromlefttoright,are:
Statusline:Describesanyactiveprocessesandprovidesbriefdescriptionsofthe
currentlyselectedcommandortoolbarbutton.Forexample,whenyoumovethe
pointeroveratoolbarbuttonorclickonamenuname,abriefdescriptionofthe
itemappearsinthestatusline(e.g.CreateaLink).
Timedisplay:Displaysthecurrenttimeontheworkstation.
Progressindicator:Depictstheprogressonanactionbeingperformed
Communicationstatuslights:IndicateifDesigneriscurrentlyreceivingand
transmittingdataontheIONnetwork.

Display Mode and Edit Mode

TherearetwomodesinDesignerDisplaymodeandEditmode.Designerisin
DisplaymodewhentheToolboxishidden(Options>ShowToolboxiscleared).
DesignerisinEditmodewhentheToolboxisdisplayed(Options>ShowToolbox
isselected).YoucanmakemodificationsonlywheninEditmode.
Topreventaccidentallymovingordeletingmodulesorlinks,useDisplaymode
whennavigatingnodediagrams.

Designer Shortcuts
DesignerprovidesseveralfunctionstoassistinprogrammingtheIONnodes.
ThesefunctionsareaccessedbyusingdifferentcombinationsoftheSHIFTand
CTRLkeys,whileclickingorrightclickingamodulesinputoroutputsymbol.
Input

Output

Thetablebelowliststhedifferentmouseandkeyboardcombinationsyoucan
performonamodulesinputoroutputsymbol,andtheircorrespondingfunctions:

Action

Result

Left-click on input

The list of inputs appears - you can select an input and link it to another module's output register

Shift + left-click on input

The list of inputs appears with the current input values displayed in square brackets

Right-click on input

The Delete Link dialog appears - you can break links from this dialog.

Shift + right-click on input

The Delete Link dialog appears, showing inputs and current input values in square brackets

Left-click on output

The list of output registers appears

Shift + left-click on output

The list of output registers appears with the current register value displayed in square brackets

Ctrl + left-click on output

The list of setup registers appears - these setup registers can be linked to inputs on other modules

Shift + Ctrl + left-click on output

The list of setup registers appears with the current register settings displayed in square brackets

Right-click on output

The list of output register owners appears - you can break links from this dialog

Ctrl + right-click on output

The list of setup register owners appears - you can break links from this dialog

Page 198

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

NOTE
To create a shortcut to an ION module, see Creating a Shortcut to an ION Module on page 218.

Quitting Designer
WhenyouarefinishedusingDesigner:
1.

SelectFile>Exit.
Amessageboxappears,promptingyoutoconfirmyourintentiontoexit.

2.

ClickYestoquitorNotoreturntoDesigner.

Ifyouattempttoquitwithoutsavingyourwork,Designerpromptsyoutosave
yourchanges.

2007 Schneider Electric. All rights reserved.

Page 199

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

The Node Diagram

AnodediagramisagraphicalrepresentationofanIONcompliantnode.Thenode
diagramdisplaystheactualconfigurationofthenode.Moduleiconsrepresentthe
IONmodulesinthenode,whilelinesdrawnbetweenthesemoduleiconsdepict
linksbetweentheIONmodules.

Module links

Module icon

Grouping object

Insomecases,groupsofmodulesareorganizedinsidegroupingwindows.When
closed,agroupingwindowappearsasagroupingobject(aniconthatlookslikea
folder).Doubleclickingagroupingobject(inEditmode)opensthegrouping
windowthatcontainsthemoduleicons.

Using a Node Diagram

TheIONnodeisdepictedasanodediagraminDesigner.Thenodediagram
containsanumberofIONmodules,whichrepresentthenodescurrent
configuration.Youcanchangetheconfigurationofthenodesimplybyeditingits
nodediagram.Forexample,whenyoudeleteamodulefromanodediagram,the
moduleisremovedfromboththediagramandthenode.Youcanadd,configure,
linkanddeletemodulesonthenodebymakingthecorrespondingchangestothe
moduleiconsinthenodediagram.Amodulessetupregisterscanbeaccessedand
changedthroughthemoduleicon.
Youcanconfigurehardwarenodes(e.g.IONmeters)orsoftwarenodes(e.g.
VirtualProcessororLogInserter)usingDesigner.

Page 200

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Automatic Diagrams in Designer

WhenameterisopenedinDesigner,thedefaultdiagramsfortheappropriate
meteranddefaulttemplateareloadedautomatically.Thisisespeciallyhelpful
withmetersthathaveseveraldifferentformfactors.

Opening a Node Diagram

1.

SelectFile>Open.

2.

IntheSelectNodedialogbox,selectthenodeyouwanttoopen.ClickOK.
Whenyouselectanodefromthelist,Designercommunicateswiththespecified
nodeandopenstheapplicablenodediagram.

CAUTION
Do not open a node diagram if the node is currently being configured from its front panel.

WhenDesignerloadsanodediagram,itcomparesthediagramwiththe
configurationofthenode.Ifthereareanydiscrepanciesbetweenthediagramand
thenode,Designerupdatesthediagramtomatchthenode:
Ifadiagramdepictsamodulethatdoesnotexistonthenode,Designerdeletes
themoduleiconfromthediagram.
Ifanodecontainsamodulethatisnotdepictedinthediagram,Designeradds
themoduleicontothediagram.
Ifthelinksbetweenmodulesdifferfromnodetodiagram,Designeradjuststhe
diagramtomatchthenode.
Anodediagramtypicallydoesnotdifferfromthenodestrueconfigurationunless
thenodesconfigurationwaschangedthroughothermeans(forexample,witha
remotedisplayunit.)

Saving a Node Diagram

Savinganodediagramservestwopurposes:itsavesyourchangestothediagram,
andappliesyourchangestothenode.
Tosavetheactivenodediagram,selectFile>Send&Save.
Tosaveallopennodediagrams,selectFile>Send&SaveAll.

2007 Schneider Electric. All rights reserved.

Page 201

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Closing a Node Diagram

Toclosethenodediagram(s):
SelectFile>Closetoclosetheactivediagram,or
SelectFile>CloseAlltocloseallopendiagramsandwindows.
Ifyouattempttocloseadiagramwithoutfirstsavingyourchanges,Designer
displaysawarningandalistofthemodulesaffected.

Youcanthendooneofthefollowing:
ClickOKtoreturntothediagram.YoucanthenselectFile>Send&Saveto
saveyourworkbeforeclosingthediagram.
ClickCloseAnywaytodiscardanyunsavedchangesandclosethediagram.

NOTE
If you reopen a diagram containing unsaved changes, Designer may list the unsaved changes as offline
modules.

Icons
Ineachnodediagram,Designerusesiconstorepresenttheconfigurationofthe
node.Therearetwobasictypesoficons:moduleiconsandgroupingicons.
ModuleiconsrepresentIONmoduleslocatedonthenode.Groupingicons
representagroupofmoduleicons.

NOTE
A module icon with a symbol

in the lower corner is called a shortcut icon.

Module Icons
Allmoduleiconssharefourcommonelements:alabel,agraphic,aninputsymbol
andanoutputsymbol.

Page 202

Label
Input Symbol

Graphic
Output Symbol

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Thelabeldisplaysthenameofthemodule.Whenthemoduleisfirstcreated,the
labeldisplaysthemodulesdefaultname.Thiscanbechanged;seeDisplaying
defaultlabelsorcustomlabelsonpage 204.
Thegraphicshowsapicturetodistinguishonetypeofmodulefromanother.
Theinputandoutputsymbolsprovideaccesstothemodulesinputandoutput
registers.Clickingontheleftsymboldisplaysalistofinputs;clickingonthe
rightsymbollistsoutputregisters.SeeLinkingandConfiguringION
Modulesonpage 220formoreinformation.
Somemoduleiconshaveadoubleborderwhileothersdonot.Moduleiconswith
adoubleborderrepresentcoremodules;moduleiconswithasingleborder
representstandardmodules.

Grouping Icons
Groupingiconsrepresentgroupingwindows.Doubleclickagroupingicon(while
inEditmode)toopenitsassociatedgroupingwindow.

Groupingwindowscontainmoduleicons.Youcanusegroupingwindowsto
groupmoduleiconsbyapplication;forexample,asinglegroupingwindowmay
containallmoduleiconsrequiredfordemandoradvancedsetuproutines.
Youcanuseagroupingwindowmuchlikeastandardwindow.Youcancreate,
renameordeleteagroupingwindow;youcanmoveagroupingwindowwithina
diagram,andyoucanmoveamoduleintooroutofagroupingwindow.
Whenyouhavefinishededitingthegroupingwindow,closeittominimizethe
windowtoitscorrespondinggroupingiconinthenodediagram.
Opening a grouping window
Doubleclickonthegroupingicon.
Closing a grouping window
ClicktheClosebuttoninthetoprightcornerofthegroupingwindow.

Displaying Default or Custom Icon Labels

Moduleiconscandisplaytwotypesoflabels:defaultlabelsandcustomlabels.You
candisplayeithertypebyselectingordeselectingtheShowDefaultLabelsoption
ontheOptionsmenu.(Thisisaglobalsettingthatappliestoallnodediagrams.)

Allmoduleshaveadefaultlabel.Thedefaultlabelappearsinnodediagrams,user
diagramsandeventlogsunlessacustomlabelisavailable.Eachdefaultlabel
identifiesthemodulebytypeandifapplicable,bynumber.

2007 Schneider Electric. All rights reserved.

Page 203

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Customlabelsareavailableonlyiftheyhavebeenpreconfiguredbyauser.A
customlabelusuallyidentifiesamodulebyitsfunctionorpurpose.Customlabels
areusefulfordescribingmodules,setupregisters,outputregisters,andBoolean
ON/OFFconditions.
Displaying default labels or custom labels
SelectOptions>ShowDefaultLabelstotoggletheoptiononoroff.
WhenShowDefaultLabelsisselected,defaultlabelsaredisplayed.
WhenShowDefaultLabelsisnotselected,customlabelsaredisplayed.

Moving and Arranging Icons in a Node Diagram

Youcanmovemoduleandgroupingiconsanywhereinanodediagram.Thisis
usefulfororganizingyourdiagram(forexample,byfunctionortype)sothatyou
caneasilyfindaparticularmodule,orvisualizetheworkingsofyournodes
configuration.Youcanmoveasingleiconorgroupoficonswithinasinglenode
diagram,orintoanopengroupingwindow.
YoucanusetheAlignmentandGridoptionstoadjustthespacingandlayoutof
themoduleandgroupingiconsinyournodediagram.UsetheAlignmentoption
tospecifythehorizontalandverticalarrangementoftheselectedicons,andthe
Gridoptiontoactivateandconfigureinvisibleguidelines.
Thissectiondescribeshowtomoveoneormoreicons,andhowtousethe
AlignmentandGridoptionstoarrangeagroupoficons.

NOTE
Simply moving or arranging the icons in a node diagram does not affect the function of the modules or
the node in any way.

Moving a single icon

Moveaniconbyselectingitanddraggingittothenewlocation.Aselectediconis
identifiedbyhandlesalongtheedges.

NOTE
When a grouping icon is selected, all icons within the associated grouping window are automatically
selected as well.

Moving a group of icons

Youcanmoveagroupofselectedicons:
1.

Page 204

Selectthegroupoficonsbydoingoneofthefollowing:

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

HolddownShiftandclickeachiconyouwanttomove(clickingaselected
iconwillclearit).
Clickoutsideofthegroupanddragaselectionboxaroundtheicons.
2.

Dragtheselectiontothenewlocation.

NOTE
When selecting a group of icons, you can only choose icons from within the active window.

Changing the order of layered or stacked icon

Sometimesspaceconstraintsrequireyoutolayerorstackiconsontopofeach
other.Ifaniconappearsontopofaparticulariconyouwanttobringtothefront,
selecttheiconthatissittingontop,thenclickCTRL+K(orclickEdit>Sendto
Back).
Aligning Icons
Youcanspecifythealignmentoficonsbyselectingthemodulesyouwanttoalign
andselectingEdit>Layout.IntheLayoutdialogbox,selecttheAligntabto
displaytheavailablehorizontalandverticalalignmentoptions.

Theoptionnamesineachcolumndescribethecriteriabywhichyoucanalign
modules.Forexample,ifyouselectLeftSidesunderHorizontalandSpaceEvenly
underVertical,Designeralignsallobjectsintheselectionbytheirleftsides(using
theleftmostobjectforreference)anddistributesthemevenlyalongaverticalaxis.
1.

Selecttheiconsthatyouwanttoalign.(Toselectagroupoficons,holddown
Shiftandthenclickoneachone,orclickoutsideofthegroupanddraga
selectionboxaroundtheicons).

2.

SelectEdit>Layout.

3.

IntheLayoutbox,selecttheAligntab.Specifythehorizontalandvertical
alignmentoftheicons.

4.

SelecttheoptionsyouwantandclickOK.

Using the grid

Toassistyouinlayingoutmoduleandgroupingicons,Designerprovidesan
invisiblegrid.Iconsplacedontothegridsnaptothenearestgridline,helpingyou
tospacethemevenly.
SelectEdit>LayoutthenselecttheGridtabtoviewtheGridoptions.

2007 Schneider Electric. All rights reserved.

Page 205

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

OntheGridtabyoucanactivateordeactivatethegrid,andspecifythedistance(in
pixels)betweengridlines.
Activating and deactivating the grid
1.

SelectEdit>Layout.

2.

IntheLayoutdialogbox,selecttheGridtab.

3.

OntheGridTab,selecteitherNoGridtoturnthegridofforGridSizeinPixels
toactivatethegrid.Youcanspecifythesizeofthegridbytypinganumberinto
theGridSizeinPixelsfield.

4.

ClickOK.

Grouping Windows
Agroupingwindowislikeafolderorsubwindowwhereyoucanstoreanyicons
thatyouwanttokeeptogether.Openagroupingwindowbydoubleclickingits
groupingicon.

Thissectiondescribeshowtomoveaniconintoagroupingwindow,andhowto
add,renameanddeleteagroupingwindow.

Moving Icons into a Grouping Window

Youcanmoveanicon(orgroupoficons)toorfromanopengroupingwindowby
selectingitanddraggingittothenewlocation.
1.

Doubleclickonagroupingicontoopenthegroupingwindow.
Thegroupingwindowisdisplayed.Grabthewindowbythetitlebarand
positionitsothatyoucanseetheicon(s)thatyouwanttomove.

2.

Page 206

Selecttheiconorgroupoficonsanddragitintothegroupingwindow.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Whenyoumovealinkedmoduleiconintoagroupingwindow,anylines
representinglinkstomodulesoutsidethewindowwilldisappear.Althoughthe
modulesremainlinked,thevisiblelineswillnotextendbeyondthegrouping
window.

NOTE
You can nest grouping windows by placing a grouping object inside another grouping window.

Creating a New Grouping Window

Youcancreateanewgroupingwindowbydraggingthegroupingobjectfromthe
IONmodulestoolboxanddroppingitontothenodediagram.

TheIONmodulestoolboxisacollectionofIONmodulesandgenerictoolsthat
youcanaddtoanodediagram.IftheIONmodulestoolboxisnotdisplayed,select
ShowToolboxfromtheOptionsmenu.SeeDisplayingtheIONModules
Toolboxonpage 212formoreinformation.
Whenyoupointtoanobjectinthetoolbox,thenameoftheobjectisdisplayedon
aToolTip.YoucanuseToolTipstoidentifythegroupingobjectinthetoolbox.
OntheIONModulestoolbox,clickonthegroupingobjectanddragitontothe
nodediagram.Whenyoureleasethemousebutton,agroupingiconappearsinthe
diagram.

Renaming a Grouping Window

Whenyoucreateanewgroupingwindow,thedefaultnameisthatofthenode
diagram.Youcanchangethenameofagroupingwindowbyrenamingthe
groupingicon.

2007 Schneider Electric. All rights reserved.

1.

Rightclickonthegroupingicontoviewtheavailableoptions:

2.

SelectUseCustomfromtheCaptionsectionandtypethenewnameintothetext
box.ClickOK.

Page 207

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Changing the Font of a Grouping Window

Youcancustomizetheappearanceofacaptionbychangingitsfont,style,andsize.
1.

IntheFontsection,dooneofthefollowing:
Tousethedefaultwindowfont(thatis,thefontspecifiedfortheparent
window)selectInheritfromParentWindow.
Touseadifferentfont,selectCustom,thenclickFont,todisplaythe
standardWindowsfontdialogbox.Selectthefontoptionsyouwantthen
clickOKtocontinue.

Changing the Position of the Caption

Youcanchangethelocationofthecaption.
1.

InthePositionsection,selecteitherToporBottomtospecifyacaptionposition
aboveorbelowthegroupingicon.

2.

ClickOK.

Deleting a Grouping Window

NOTE
When you delete a grouping window, any modules inside are deleted as well. (Designer warns you before
deleting modules. See Removing an ION Module on page 214 for more information on deleting
modules.)

1.

Selectthegroupingwindowyouwanttodeletebyclickingonitsgrouping
icon.

2.

PresstheDeletekey.

NOTE
If the grouping window contains modules, Designer displays a list of modules that will be deleted.

Windows
Tocreatelinksbetweenseveralnodediagramsorgroupingwindows,youneedto
positiontheopenwindowssoyoucanseeallthemodulesinvolved.Usethe
Windowmenutoorganizeopenwindowsintheworkspace.

Arranging windows in your workspace

DooneofthefollowingfromtheWindowmenu:
Tolocateanopenwindowandmoveittotheforeground,choosethewindow
namefromthelistofopenwindowsontheWindowmenu.
Toarrangeallopenwindowsintheworkspace,selectArrangeAll.

Page 208

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Changing a Windows Background Color

Bydefault,thebackgroundcolorofallwindowsinanodediagramislightgray.
(ThiscolorsettingisindependentoftheWindowscolorsettingsspecifiedinthe
Windowscontrolpanel.)Youcanchooseanewbackgroundcolorforanywindow
inanode.
1.

Rightclickanywhereonthebackgroundofanodediagramorgrouping
window(avoidingclickingonmodules).

2.

Fromthepopupmenu,selectBackgroundColor.TheColordialogboxis
displayed.

3.

SelectthecoloryouwantorclickDefineCustomColorstocreateyourown
color.

4.

ClickOK.

Whenchoosingabackgroundcolor,considerhowthecoloraffectsthevisibilityof
iconsandlinks.Links,highlightsandshadoweffectsusedtodepictthevarious
statesofanIONmodulemaynotappearagainstcertainbackgroundcolors.For
thisreason,youshouldavoidusingcertaincolorsforyourbackground,
particularlywhite,darkgrayandblack.

Changing a Windows Default Font

Youcanspecifyadefaultfonttobeusedforallmoduleicons,groupingiconsand
textboxesinawindow.(Fontscanalsobespecifiedindividuallyforgrouping
windowsandtextboxes.)

2007 Schneider Electric. All rights reserved.

1.

Rightclickanywhereonthebackgroundofthewindow.

2.

Fromthepopupmenu,selectDefaultFonttodisplaythestandardWindows
Fontdialogbox.Specifythedefaultfont,sizeandstyle.

3.

ClickOK.

Page 209

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Working with ION Modules

Onceyouhaveopenedanodediagram,youcanvieworeditthenodes
configurationbyworkingwithitsIONmodules.Asdescribedearlier,each
moduleperformsaspecificfunction.UsingDesigner,youcanadd,removeorlink
modulestogethertocustomizethefunctionofthenode.
ThissectionexplainshowtoaddandremoveIONmodulesfromyournode
diagram.Itdescribesthebasictypesofmodules,andexplainshowyoucan
organizeyournodediagrambygroupingmodulestogether,arrangingthem,and
labelingthem.
FormoreinformationonIONmodules,seetheIONReferencemanual.

Using ION Modules

Youcanchangethefunctionofanodebyeditingtheappropriatemodule(s)inthe
nodediagram.Thissectiondescribeshowtolocateanexistingmodule,howtoadd
anewmodule,andhowtodeleteamodule.Italsoexplainshowtocreatea
shortcuttoamoduleandhowtoviewthecontentsofamoduleintextformat.
Onceyouhavelocatedoraddedthemoduleyouwant,youcanconfigureitusing
theproceduredescribedinLinkingandConfiguringIONModulesonpage 220.

Module Status: Online and Offline

Thetermsonlineandofflinedescribewhetheramoduleiscurrentlyactiveor
not.Amoduleisdescribedasonlinewhenitisfunctioningnormally(monitoring
itsinputandupdatingitsoutputregisters).Anofflinemoduleisinactive.
Anytimeyousendandsavechangestoanode,Designertemporarilytakesthe
affectedmodulesofflineandprogramsthemwithyourchanges.Oncetheyhave
beenprogrammed,themodulesarethenplacedbackonline.
Normally,thisisaroutineprocedure;however,certaincircumstancesmay
preventamodulefromreturningonline.Forexample,ifthenodelackssufficient
processingpowertooperatethemodule,themoduleremainsoffline.
Youcaneasilyidentifyanyofflinemodules:allofflinemodulesarehighlighted
witharedoutline.Inaddition,wheneveryouopenanodediagram,Designer
displaysalistofallofflinemodulesinthenode,includingthosethatarenot
immediatelyvisible(forexample,thoselocatedinagroupingwindow).

NOTE
If you have offline modules in your node, you may be able to put them back online by selecting File >
Send & Save.

Page 210

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Module Status: Programmed vs. Pending

Thetermsprogrammedandpendingrefertowhetherornotamodules
representationinthenodediagrammatchesthenodeitself.Aprogrammed
moduleisonethatisthesamebothinthenodediagramandinthenode.Thelinks,
labelsandsetupregistervaluesinthenodediagramexactlymatchthoseonthe
node.Whenyoufirstopenanodediagram,allthemodulesappearprogrammed
sincetheyarereaddirectlyfromthenodeitselfandthendisplayedinthenode
diagram.

Onceyoustarteditinganodediagram,moduleiconsappeardifferentlytoindicate
thattheyhavebeenedited.Ifyouchangeamoduleinthenodediagram(for
example,relinkitoredititssetupregisters),itwillnotmatchthenodeuntilyou
selectSend&SavefromtheFilemenu.Untilitissaved,theeditedmoduleis
depictedaspendingtoindicatethatitdoesnotmatchtheconfigurationonthe
node.Whenyousendandsaveyourchangestothenode,themodulewillbecome
programmed.

Core Modules and Standard Modules

TherearetwobasictypesofIONmodules:coremodulesandstandardmodules.

CoremodulesarerequiredIONmodulesthatarefundamentaltotheoperationof
thenode.Youcannotaddordeletecoremodulesand,insomecases,youcannot
configurethem.Coremoduleiconsareidentifiedbyadoubleborderaroundthe
edge.ThePowerMetermoduleisanexampleofacoremodule.
StandardmodulesarereusableIONmodules.Generally,mostmodulesinanode
arestandardmodules.Youcanaddordeletestandardmodulesasrequired.
Standardmodulesarerepresentedbyiconswithsingleborders.TheSetpoint
moduleisanexampleofastandardmodule.

Persistent Modules
SimilartoCoremodules(theycannotbeaddedordeleted),Persistentmodulesare
StandardmodulesthathavebeenconvertedtoCoremodules.Thesemodulesare
createdatthefactory,andcanneverberemovedfromthemeterframeworks.
Persistentmodulesarerepresentedbyiconswithsingleborders.
AnexampleofaPersistentmoduleisExternalPulsemodule#1ontheION8600
meter;thismodulepulseswhentheDemandResetswitchispressedonthemeter.

2007 Schneider Electric. All rights reserved.

Page 211

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Displaying the ION Modules Toolbox

TheIONModulestoolboxisacollectionofIONmodulesandgenerictoolsthat
youcanaddtoanodediagram.TodisplaytheIONModulestoolbox,selectShow
ToolboxfromtheOptionsmenu.

Thetypeandquantityofmodulesofferedonatoolboxvariesdependingonthe
typeofnodeyouareconfiguring;however,thegenerictools(thegroupingand
textobjects)areavailableforallnodes.

NOTE
To identify a module in the toolbox, point to it with the mouse - the module type is displayed as a ToolTip
beside the module and on the status line at the bottom of the screen.

Youcanaddamoduletoyournodediagram(andtothenodeitself)bydragging
itsiconfromthetoolboxintothediagramwindow.
Opening the ION Modules toolbox
FromtheOptionsmenu,selectShowToolbox.
Closing the ION Modules toolbox
ClicktheClosebuttoninthetoprightcornerofthetoolboxorclearShowToolbox
ontheOptionsmenu.

Locating an Existing ION Module

Beforeyoucaneditamodule,youmustfirstlocateitinthenodediagram.Ifyou
donotknowwheretofindthemodule,youcanlocateitusingthemoduletray
featureoftheIONModulestoolbox.Themoduletraydisplayslinkstoallmodules
ofthespecifiedtypethatarecurrentlyinuseonthenode.

NOTE
If the toolbox is not displayed, select Options > Show Toolbox.

Page 212

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Todisplaythemoduletray,findthetypeofmoduleyouwantontheIONModules
toolbox,andthenrightclickit.Themoduletrayappearsbesidethetoolbox.

In this example, there are

eight Display modules on
the module tray.

Insidethetrayarelinkstoallmodulesofthespecifiedtypethatarecurrently
programmedonthenode.Toidentifyalinkinthetray,pointtoitthemodules
labelisdisplayedonthestatuslineatthebottomofthescreen.
Tolocatethemodule,clickonitslinkinthemoduletray.Designerlocatesthe
selectedmoduleanddisplaysitinthecenteroftheworkspace.Ifthemoduleis
locatedinsideagroupingwindow,Designeropensthewindowtodisplaythe
module.
Toclosethemoduletray,clickonadifferentmoduleintheToolbox.
Locating an existing module from the module tray
1.

IntheIONModulestoolbox,rightclickontheiconofthemoduletypethat
youwanttolocate.Themoduletrayisdisplayed.

2.

Inthemoduletray,clickonthemoduleyouwanttolocate.Designerlocatesand
displaysthemodule.

NOTE
To close the module tray, click on any module icon in the Toolbox.

Adding a New ION Module

Mostnodesarepreprogrammedatthefactorywithaselectionofmodules
designedtoprovidethemostcommonlyrequiredfunctions.However,ifthe
factorydefaultconfigurationisnotappropriateforyourapplication,youmayadd
anewIONmodule.
Toaddamoduleonanode:
1.

OntheIONModulestoolbox,clicktheiconofthemoduleyouwanttoadd,
anddragitontothenodediagram.
Asyoudragtheicon,thecursorchangesshapetoindicateyouareplacingan
object.

2.

Releasethemousebuttontoplacethemoduleinthediagram.

Designeraddsthemoduleandplacesapendingmoduleiconintothediagram.
Youcanthenlinkandconfigurethemodule.

2007 Schneider Electric. All rights reserved.

Page 213

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Removing an ION Module

YoucanremoveastandardIONmodulefromanodebydeletingitsiconfromthe
nodediagram.Byremovingunnecessarymodulesfromthenode,youcanfreeup
resourcesforuseelsewhere.
Whiletheactionofremovingamoduleiseasy(simplyselectthemoduleiconand
presstheDeletekey),itisimportanttoconsidertheeffectthishasonother
functionsinthenode.
Eachtimeamoduleisdeleted,allofitsoutputregisters,setupregistersandinput
linksaredeletedaswell.Removingthisinformationfromthenodeaffectsthe
operationofanymodulesthatdependonit.Forthisreason,youshouldbeaware
ofalldependentmodules(alsoknownasowners)beforedeletinganything.

Checking for Dependent Modules

Whentwolinkedmodulesarelocatedinthesamewindow,Designerdepictsthe
linkasathinlinethatrunsfromtheoutputregisterofthefirstmoduletotheinput
ofthesecond.Youcaneasilyidentifythedependentmodule(orowner)bytheline
runningtoitsinput.However,ifoneofthelinkedmodulesislocatedinadifferent
window,theconnectionisnotvisible.Amoreeffectivewaytolocateamodules
ownersistoviewtheownersofitsregisters.
Viewing the owners of a module's setup and output registers
Aregisterisatypeofmemorybankthatstoresamoduleslinkingand
configurationinformation.Eachmoduleusestwotypesofregisters:output
registersandsetupregisters.Byviewingaregistersowners,youcanquickly
identifyalldependentmodulesonthenode.Youcandeterminewhatpurposethe
modulesserve,andthendecidewhethertodeletethemornot.
1.

Dooneofthefollowing:
Toviewtheoutputregistersowners,rightclickontheoutputsymbol(the
symbolontheright).
Toviewthesetupregistersowners,holdtheCtrlkeyandthenrightclick
ontheoutputsymbol.

Adialogboxappears,listingallofthemodulesregistersandanydependent
modulesonthenode.(dependentmodulesonothernodesarenotdisplayed)

Page 214

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

2.

Clickonaregisterinthelistonthelefttodisplayalllocalownersofthatregister
intheboxontheright.Ownerinformationincludesthemodulenameorlabel
anditsrelevantinput.NotethatownerslocatedonadifferentnodeareNOT
displayedinthisdialogbox.

3.

Ifnecessary,youcandeletethelinkbetweenaregisterandoneofitsownersby
selectingtheownerfromthelistandclickingUnlink.(SeeDeletingLinkson
page 225formoreinformationondeletingmodulelinks.)

4.

Whenyouhavefinishedviewingtheregisterowners,clickOK.

Displayingamodulesregisterownersisaneffectivewayoflocatingalldependent
modulesontheselectednode;butrememberthatanydependentmodulethatis
locatedonanothernodewillnotappearonthelistofowners.
Viewing owners on other nodes
Ifyouremoveamodulewithadependentmoduleonanothernode,thedependent
modulesinputsarenotreset.Itcontinuestolookforthedeletedoutputregister.
Ifyouarenotsurewhetheramodulehasdependentsonothernodes,checkwith
thepersonwhoprogrammedthemtoensureyoudonotdisrupttheoperationof
anymodulesonthatnode.Ifyoustillwanttoremovethemodule,youmaywant
todirectlydeletethelinkontheothernodefirst.Thisensuresthatthemoduleis
notinadvertentlylinkedtothenextmoduletooccupythelocationofthedeleted
module.

Deleting or Cutting an ION module

OnceyouhavedeterminedthatyoucansafelyremoveanIONmodulewithout
disruptingotherfunctions,therearetwowaysyoucanremoveit.Youcaneither
deletethemodulebyselectingtheiconandthenpressingtheDeletekeyoryou
cancutitbyselectingtheiconandthenselectingCutfromtheEditmenu.
Ineithercase,Designerimmediatelyremovestheiconfromthenodediagramand
deletesthemodulefromthenode.Thedifferenceis,whenyoudeleteamodule,it
isdiscarded;whenyoucutamodule,itcanberestored(byselectingPastefrom
theEditmenu).

NOTE
You do not have to select Send & Save Changes to delete a module. Designer immediately removes the
module from both the diagram and the node.

Removing an ION module from the node

1.

Selecttheiconofthemoduleyouwanttoremove.(Toselectagroupoficons,
holddowntheShiftkeyandthenclickeachone.)

2.

Dooneofthefollowing:
Tocutthemodule,selectEdit>Cut.
Todiscardthemodule,presstheDeletekey.

2007 Schneider Electric. All rights reserved.

Page 215

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

NOTE
If a module has a dependent module on another node, Designer does NOT alert you of the dependency
when you delete it. Before you delete a module, ensure that you are aware of all links to modules on other
nodes.

Designerdisplaysasummaryoftheproposedchanges.

Thesummarylistsallselectedmodules,andidentifiesthoseintheselectionthat
willbedeleted(includingthosewithdependents),andthosethatwillnot.
Clickingonamoduleinthislistdisplaysanyadditionalinformationavailable.
3.

ClickOKtoremovetheselectedmodules(orCanceltoaborttheprocedure).

Designerremovesthemoduleiconfromthenodediagram,anddeletesthemodule
fromthenodeitself.

NOTE
If you delete a shortcut icon, the original module is not affected; however, when you delete the original
module, all shortcuts to that module are also deleted.

Viewing the Text of an ION Node or Module

Youcandisplayastextthecompletecontentsofoneormoremodulesoranentire
IONnode.Usethisoptiontoviewthespecifiedinformationonyourscreen,sort
it,orprintacopyforyourrecords.
TheViewDiagramTextfunctioncanbeusefultoanyoneperformingadiagnostic
analysisofyoursystemorcreatingadetailedrecordofyournodesconfiguration.
1.

Selectthemodule(s)thatyouwanttodisplay:
Toselectasinglemodule,clickonthemodule.
Toselectagroupofmodules,holdtheShiftkeyandclickoneachmodule.
Toselectallmodulesinthenode,leftclickanywhereinthebackgroundof
themainnodewindow(beingcarefulnottoclickonamoduleicon)and
thenselectEdit>SelectAll.

Page 216

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

NOTE
Clicking in the background of any window displays the text for all modules contained within that window
(and within any of its grouping windows). To select all modules in the node, make sure you click in the
background of the main (root) window of the node diagram.

2.

SelectOptions>ViewDiagramText.Thetextwindowisdisplayed.Thetextof
anymodulesthatareofflineappearsinred.

TheTextViewscreenoffersseveralwaystoview,sortandfindinformation:
View:Selectoneoftwoviewmodes:ArchiveorDiagnostic.
UsetheArchivemodetodisplayinformationusefulforarchivingthenodes
configuration.UsetheDiagnosticmodetodisplaydiagnosticinformationon
theselectedmodule(s).
SortBy:TheSortByboxoffersseveralsortparameters.
Archive View

Diagnostic View

Sorts by

Default

Default

Module label

Module Class

Module Class

Type of module

Module Name

Module Name

Default label

Module State

Displays offline modules first followed by online modules.

Sorts alphabetically within each group.

Module Update
Period

Displays event dirven modules first, then inactive (not

updating) modules, followed by high-speed (one cycle
updates) modules, and finally high-accuracy (one second
updates) modules. Sorts alphabetically within each group

Find:Tolocateatextstring,typethetextintheFindboxandclickFind.
Refresh:Toresetthetextviewafteryouhavemadeaconfigurationchange,click
Refresh.

2007 Schneider Electric. All rights reserved.

Page 217

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Ifyouwanttoprintacopyofthetextviewinformation,clickPrint,inthelower
rightcorneroftheTextViewwindow.Whenyouhavefinishedviewingthetext
viewinformation,clickClose.

Creating a Shortcut to an ION Module

Tosavetimeswitchingbetweenmodulesindifferentwindows,createashortcut
iconinonewindowthatrepresentstheoriginalmoduleintheotherwindow.

Ashortcuticonisidentifiedbya
icon.

symbolinthelowerleftcornerofamodule

Creating a shortcut icon

HolddownShift+Ctrlthenclickonamoduleiconanddragittothewindow
whereyouwanttheshortcuttogo.
Youcancreatemultipleshortcutsbyselectingagroupoficons,andthen,holding
Shift+Ctrl,clickononeofthegroupanddragittothenewlocation.
Onceyouhavecreatedashortcuticon,youcanuseitinthesamewayyouwould
usetheoriginalmoduleicon.Bothiconssupportthesamefeatures;however,if
youdeletetheshortcuticon,theoriginalmoduleiconisnotdeleted.Deletingthe
moduleicondeletesallshortcutstothatmodule.

NOTE
You cannot create more than one shortcut icon per window for a single module.

Adding a Text Box

Atextboxdisplaysanytextyoutypeintoit.Youcanplaceatextboxanywherein
anodediagram,andmoveitorresizeitasnecessary.Youcanuseatextboxto
describeanyprocessorfunctioninyoursystem;forexample,youcanlabel
individualcomponentsofyoursystemordisplayablockofdescriptivetextor
instructions.

NOTE
If the toolbox is not displayed, select Options > Show Toolbox.

Adding a new text box

1.

Page 218

OntheIONModulestoolbox,clickontheTextobject(
thenodediagram.

)anddragitonto

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Whenyoureleasethemousebutton,atextboxappearsinthediagramwiththe
defaultmessage:Yourtextgoeshere.
2.

Toreplacethismessagewithyourtext,rightclickonthetextbox.
TheTextBoxConfigurationdialogboxisdisplayed.

3.

OntheEditTexttab,dooneofthefollowing:
Todisplaythenameofthenodeinthetextbox,selectUseDefault.
Todisplayyourownmessage,selectUseCustomandtypeyourtextinto
thefieldprovided.

4.

ClickOK.Thetextboxdisplaysyourspecifiedtext.

Resizing a Text Box

Ifthetextinatextboxappearsincompleteortruncated,youmayneedtoadjust
thesizeofthetextbox.
\

Toresizeatextbox:
1.

Clickonthetextboxtoselectit.Theselectedboxisidentifiedbyhandles.

2.

Dooneofthefollowing:
Tomaketheobjectlargerorsmaller,dragacornerhandle.
Tostretchtheobjecthorizontallyorvertically,dragamiddlehandle.

Changing the Font of a Text Box

Thefont,sizeandstyleofthetextusedinthetextboxisbasedonthedefault
settingspecifiedfortheactivewindow.Ifyouwanttouseadifferentfontwithout
resettingthedefault,youcanspecifyanewfontforthetextbox.
1.

2007 Schneider Electric. All rights reserved.

Rightclickonthetextbox.

Page 219

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

2.

IntheTextBoxConfigurationdialogbox,selecttheTexttab.

3.

IntheFontsection,dooneofthefollowing.
Tousethedefaultwindowfont(thatis,thefontspecifiedfortheparent
window)selectInheritfromParentWindow.
Touseadifferentfont,selectCustom,thenclickFont,todisplaythe
standardWindowsfontdialogbox.Specifyafont,style,andsize.ClickOK
tocontinue.

4.

ClickOK.

Changing the Position of the Text

Youcanchangethepositionofthetextinthetextbox.
1.

InthePositionsection,selectLeft,Center,orRight.

2.

ClickOK.

Adding a border or background color to a text box

Youcanaddabordertoatextbox,changeitsbackgroundcolor,orboth.

1.

Rightclickonthetextbox.

2.

IntheTextBoxConfigurationdialogbox,selecttheBoxtab.

3.

Dooneofthefollowing:
IntheBordersection,selectShow,andclickColor,tochooseabordercolor.
IntheWidthinPixelsfield,typeaborderwidth.
IntheBackgroundColorsection,selectCustom,andclickColor,tochoosea
backgroundcolor.

4.

ClickOK.

Linking and Configuring ION Modules

LinkingIONmodulestogetheristhefoundationofprogrammingIONcompliant
nodesintheIONsoftware.AlthoughanIONmodulecanperformafunctionin
isolation,thestrengthandflexibilityoftheIONarchitecturecomesfromtheability
tointerconnectmodulestobuildmoresophisticatedfunctions.

Choosing which ION Modules to Link

Thefirststepinlinkingmodulesistodecidewhichmodulesyouwanttouse.
Whenchoosingamoduletolink,youhavetwochoices:youcanaddandlinka
newmodule,oryoucanrelinkanexistingmodule.
Insomecases,youmaynotwanttoaddanewmodule.Forexample,ifallthe
modulesofaparticulartypearealreadyused,youwillwanttorelinkoneofthem
toperformthenewfunction.Somedevicesarepreconfiguredatthefactoryto
providecommonmeasurementsandcalculations.Ifanyofthesefactorydefaults

Page 220

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

areunnecessaryinyourapplication,youcanunlinkthemodulesinvolvedand
reusethem.
Planaheadbeforedraggingout(i.e.creating)IONmodules.Unlinkedmodules
arewastedresources.
Youmayfindalinkedmodulethatyoucanusetoaddanewlink,inorderto
augmentthefunctionitisperforming.Forexample,ifyouhaveaSetpointmodule
thattriggersawaveformrecording,thenlaterdecidetousethistriggertoreseta
counter,youcanlinkthatCountermoduletothesameSetpointthatcontrolsthe
WaveformRecordermodule.

Linking ION Modules Graphically

Linkingmodulesgraphicallymeanspointingandclickingamodulesinput,then
clickinganothermodulesoutputregistertolinkit(notebothinputandoutput
registerclassesmustbecompatible).Youcanusethismethodtolinktomodules
onthesamenodeortocreatelinksacrossnodes.
YoucanusetheautolinkingfeaturetospeeduptheprocessoflinkingION
modules.Typically,linkingIONmodulesinvolvesconnectingtheoutputregister
ofonemoduletotheinputofanother.Inmanycases,onlyoneofthemodules
inputshavethesameregisterclassastheselectedoutputregister.
Ifautolinkingisenabled,Designerautomaticallyselectstheappropriateinputand
establishesthelink.Ifnecessary,itoverwritesanexistinglink.Thisrelievesyou
fromhavingtomanuallyselecttheinput;however,italsopreventsyoufrom
seeingwhatinputyouarelinkingto.
Bydefault,autolinkingisdisabled.Youshouldonlyuseautolinkingifyouare
thoroughlyfamiliarwithalltheinputsandoutputregistersofthemodulesyouare
workingwithtoensureyoudontinadvertentlycreateundesirablelinks.
Enabling autolinking
FromtheOptionsmenu,selectEnableAutolinking.Acheckbesidetheoption
indicatesitisselected.
Disabling autolinking
FromtheOptionsmenu,selectEnableAutolinkingagaintocleartheoption.

Linking ION Modules on the Same Node

IftheselectednodeisametersuchastheION7650,theprocessofconfiguringthe
nodeprimarilyinvolvescreatinglinksbetweentheIONmodulesonthatnode.

NOTE
To cancel a link-in-progress, click anywhere in the background of the window or press the ESC key.

2007 Schneider Electric. All rights reserved.

Page 221

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Linking modules using the point and click method

1.

Tolistamodulesoutputregisters,clickthe
symbolontherightsideofthe
moduleicon.(Tolistthemodulessetupregisters,holdtheCTRLkeywhile
clickingthe
symbol.)
Inmostcases,apopupmenuappearslistingtheavailableregisters.Ifthe
modulehasmanyregisters,adialogboxappearsinstead.

2.

Inthemenu,clickontheregisteryouwanttoselect.Inthecaseofthedialogbox,
doubleclickonanoutputregisterorclicktheregisterandclickSelect.

3.

Dragthecursortowardsthemoduleyouwanttolinkto;thecursorchangesand
adottedlinefollowsitacrossthenodediagram.Thisindicatesyouareinthe
processofcreatingalinkanditshowswheretheconnectinglinewillappearin
thenodediagram.
Ifyoulinktoamodulethatisinadifferentwindowthantheoriginalmodule
(eitherinadifferentnodediagramorgroupingwindow)thedottedline
disappearsbutthecursorstillindicatesthatalinkisinprogress.
Ifthemoduleyouwantisobscuredbyanotherwindow,clickonthetitlebarof
thewindowcontainingthemodule.Thisbringsthewindowtotheforeground
withoutcancelingthelink.(Ifyouclickonthebackgroundofthewindow,the
linkiscancelled.)

4.

Clickthesymbolontheleftsideofthemoduleicontodisplaythemodules
inputs.Inmostcases,apopupmenuappearslistingthemodulesinputs.Those
thatareofadifferentclassthantheselectedoutputregisteraregrayedoutto
indicateyoucannotselectthem.
Iftheinputisalreadylinked,thelabeloftheregisteritislinkedtois
displayedbesidetheinput.Ifyouselecttheinput,theexistinglinkwillbe
overwritten.
Iftherearealargenumberofinputs,adialogboxsimilartotheMore
OutputRegistersdialogappearsinstead.

Page 222

5.

Choosetheinputyouwant,orinthecaseofthedialogbox,clickSelect.

6.

Ifthetwomodulesareinthesamewindow,thedottedlineremainsonthescreen
toshowthelinkbetweenthemodules.Whenyousavethischangetothenode,

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

thelinechangesfromadottedlinetoathinblacklinetoindicatethatthelinkis
nowprogrammedonthenode.
Theproceduredescribedabovecanalsobeperformedinreverseorder.Youcan
selectamodulesinputfirstandthenlinkittoanothermodulesoutputregister.

NOTE
Some modules, such as AND/OR modules, Data Recorder modules, and Log Acquisition modules have
a variable number of inputs. In these cases, when you click on the input symbol, the pop-up menu offers
one instance of the variable input as well as any fixed inputs the module may have.

Whenlinkingtooneofthesemodules,youcanselecttheNEWSourceitemtoadd
anewlinkoryoucanselectanexistinglinkandoverwriteit.

Linking ION Modules Across Different Nodes

Iftheselectednodeisasoftwarenode,suchastheVirtualProcessororLog
Inserter,manyofthelinksyoucreatewillbetomodulesonothernodes.Whenyou
createlinksacrossdifferentnodes,itisimportanttokeeptrackoftheselinksand
notewhatmodulesaredependentonothers.Thiswillhelpyoudeterminewhat
willhappenifyoueverwanttodeleteamodulethatislinkedtoamoduleon
anothernode.

NOTE
You cannot link modules on one device to another. For example, you cannot create a link between a
module on an ION7330 to a module on a different ION7330 or to a module on another meter.

2007 Schneider Electric. All rights reserved.

1.

Openthenodediagramsthatcontainthemodulesyouwanttolink.

2.

Positionthediagramswithintheworkspacesoyoucanseethetwomodulesyou
wanttolink.

3.

Inthefirstnodediagram,clickonthe
symbolontherightsideofthemodule
icon.Apopupmenuappearslistingthemodulesoutputregisters.(Ifthe
modulehasmanyoutputs,adialogboxwillappearinstead.)

4.

Inthelistofoutputregisters,clickontheregisteryouwant.(Inthecaseofthe
dialogbox,clickaregisterandthenclickSelect.)

5.

Dragthecursorfromthefirstnodediagramtowardsthemoduleyouwantto
linktointhesecondnodediagram.Thedottedlineceasestofollowthecursorif
itcrossesthewindowboundarybutthecursorchangestoindicatealinkisin
progress.

6.

Clickonthe
symbolontheleftsideofthemoduleiconinthesecondnode
diagramtoseethemodulesinputs.Apopupmenuappearslistingthe

Page 223

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

modulesinputs.Thosethatareofadifferentclassthantheselectedoutput
registeraregrayedouttoindicateyoucannotselectthem.
7.

Choosetheinputyouwant,orinthecaseofthedialogbox,clickSelect.
Designerdoesnotgraphicallyrepresentlinksbetweenmodulesondifferent
nodessoyouwillnotseealineconnectingthemodules.

8.

Clickinthetitlebarofthesecondnodediagram.SelectFile>Send&Saveto
saveyourchangestothesecondnode.

Thisprocedurecanalsobeperformedinreverseorder.Youcanselectamodules
inputfirstandthenlinkittoanothermodulesoutputregister.

NOTE
If the input is already linked, the label of the register it is linked to is displayed beside the input. If you
select this input, the existing link will be overwritten.

A Note About Performance

Whilecreatinglinks,youmaynoticethecircleattheendofthearrowcursoris
sometimesblack(
).
ThisindicatesthatDesignerisintheprocessofretrievinginformationabouta
module.Youcanstillclickontheinputsoroutputsofothermodules,butDesigner
abortstheoriginalrequest.Tominimizetheamountofcommunicationsbetween
Designerandtheconnectednodes,avoidunnecessaryclickingonthe
symbols.
Ifyouclickonseveralitemsinarow,youonlyseethemenuforthelastitemyou
click;however,Designerinitiatesmanyrequestsforinformation,whichmay
impactitsperformance.

Linking ION Modules Using the ION Tree

Insomecases,youmaywanttousetheIONtreetoselecttheregisterforlinking.
TheIONtreeisahierarchicallistingofeverynode,manager,module,andregister
intheIONsoftwarenetwork.Itallowsyoutoselectaregisteronanodewithout
openingthenodediagram.Generally,youwouldusetheIONtreeforcreating
linksacrossnodes.
TheIONtreeisalsotheonlywaytoselectregistersfromdevicesthatarenotION
compliant(andusetranslatorstomakedataavailable)suchas3000seriesmeters.
Forexample,ifyouareprogrammingaVirtualProcessornodeandyouwantto
sumdatafromseveral3720ACMs,youmustaccessthe3720ACMregisterviathe
IONtree.
UsingtheIONtreeisfasterthanopeninganodediagram.Itisusefulifyouwant
tolinktoaregisteronanodewhosediagramhasnotyetbeenopened.Itisalso
usefulifyouwanttolinktoaregister,butyouarenotacquaintedwiththe
configurationofthenodeinwhichitresides.Youcangostraighttotheregister
withouthavingtoclickthroughanunfamiliarnodediagram.Also,sincea
diagramcanonlybeaccessedbyoneuseratatime,youmayneedtousetheION
treetolinktoaregisteronanothernodewherethediagramisalreadyopen.

Page 224

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

To link modules using the ION Tree

1.

Clickthe
symbolontheleftsideofthemoduleicon.Alistofthemodules
inputsisdisplayed.

2.

Inthelistofinputs,clickontheinputyouwant.

3.

Clickthe
buttoninthetoolbar.(Tolinkamodulessetupregister,hold
theCTRLkeywhileclickingthisbutton.)
TheCreateLinkdialogboxappears,providingaccesstotheIONtree.

Double-click the node,

the manager, and the
module to get to the
list of output registers
for you to link to.

4.

UsetheCreateLinkdialogboxtospecifyanode,manager,moduleandoutput
register.StartbydoubleclickingthenodeyouwantintheNodesbox.All
managerswithintheselectednodeappearintheManagersbox.Youcanthen
doubleclickthemanageryouwant,andrepeatthisprocedureforthemodules
andregisters.
Themodulewhoseinputschangedappeargrayedouttoindicateitisnow
pending.

5.

SelectFile>Send&Save.Thenewlinkisestablishedandthemoduleappears
programmed.

Ifthemoduleyouarelinkingtoisonanothernodeorinadifferentwindowfrom
thesourcemodule,nolineappearsbetweenthetwomodules.Thelinkisstillthere
butDesigneronlydrawslinesforlinksbetweenmodulesinthesamewindow.
Theproceduredescribedabovecanalsobeperformedinthereverseorder.You
canclickthe
buttonfirst,selectanoutputregister,andthenclickthe

symbolontheleftsideofamoduleicontoselectoneofitsinputs.

Deleting Links
Ifyouwanttodisassembleagroupoflinkedmodulesandusethemforanother
function,youcandeletethelinksbetweenthemodulesratherthandeletingthe
modules.
Mostlinksbetweenstandardmodulescanbedeleted;however,somelinks
betweencoremodulesarefixedandcannotbedeleted.Thesefixedlinksinclude:

2007 Schneider Electric. All rights reserved.

Page 225

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

DataAcquisitionmoduleandallPowerMetermodules
DataAcquisitionmoduleandallFFTmodules
FFTmoduleandallHarmonicsAnalyzermodules
FFTmoduleandallSymmetricalComponentsmodules
Ifyouattempttodeleteafixedlink,Designerinformsyouthatthelinkcannotbe
deleted.
Designerprovidesseveralwaysofdeletinglinks.

Deleting Visible Links

Ifthelinkedmodulesareinthesamewindow,youcansimplyclickonthelinkline
andthenpresstheDeletekey.Thisistheeasiestmethodaslongasyouknow
whichoutputregisterandinputareinvolved.Forexample,inthesituationbelow,
theSlidingWindowDemandmodulehasacustomlabelthatidentifiesthevalue
forwhichitiscalculatingdemand(kWtotal).Inthiscase,theeasiestwaytodelete
thelinkistoclickonthelinejoiningthePowerMeterandtheSlidingWindow
Demandmodule(itscolorwillreversetoindicateitisselected)andpressDelete.

Iftherearemultiplelinesbetweenthesamemodulesandyouonlywanttodelete
oneofthelinks,youmaywanttousethemethoddescribedinthenexttopic,
DeletingLinkswithaHiddenLine.

Deleting Links with a Hidden Line

Ifyoucannotseethelinethatlinksthemodules(forexample,iftheyarein
differentwindows),oryouneedtoknowwhichoutputregistersandwhichinputs
areinvolved,youmustuseadialogboxtodeletethelinkbetweenmodules.You
canlookeitherattheoutputregisterownersofthefirstmodule,oryoucanlookat
theinputsofthesecondmoduletoseewhattheyarelinkedto,andthendeletethe
linkfromthere.

Deleting a Module's Input Links

Deletinglinksatamodulesinputsisgenerallyfasterthandeletingthematthe
modulesoutputregistersbecauseDesignerdoesnotneedtochecktheentirenode.
Ontheotherhand,thereislessinformationavailableifyouviewinputlinks.All
youseeisthelabeloftheoutputregisterthatislinkedtotheinput.Ifthisis
sufficientinformation,proceedwiththismethod;ifnot,gototheoutputregisters
todeletethelink.

NOTE
If the link you want to delete is between modules on different nodes, you must delete the link at the
module's inputs.

Page 226

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Viewing a module's input links

1.

Rightclickonthe
symbolontheleftsideofthemoduleicon.Thefollowing
dialogboxappears.

2.

Eachinputandthelabeloftheoutputregisteritislinkedtoaredisplayedinthe
listbox.Todeleteoneormoreoftheselinks,clickontheinputandclickUnlink.
Theoutputregisterlabelisreplacedwithdashedlines.

3.

Whenyouhaveunlinkedallthemodulesyouwant,clickOK.

ThenexttimeyouselectSend&Save,themoduleswillbeunlinkedonthenode.

NOTE
When clicking links, you can hold the Shift key to select a range of links, or the Ctrl key to select a group
of individual links.

Deleting a Module's Output Links

Asdescribedearlier(CheckingforDependentModulesonpage 214),youcan
viewtheownersofamodulesoutputregisters(i.e.allthelocalmodulesthatare
linkedtoit);youcanalsodeletetheselinksfromthesamedialogbox.Thismethod
givesyouthemostinformationaboutthelinkyouaredeleting(theoutputregister
label,andtheinputandlabelofthemoduleitislinkedto).
Viewing a module's output links
1.

Rightclickonthe
symbolontherightsideofthemoduleicon.(Tolistthe
modulessetupregisters,holdtheCTRLkeywhilerightclickingonthe
symbol.)
Thefollowingdialogboxappears:

2007 Schneider Electric. All rights reserved.

Page 227

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

2.

ClickontheoutputregisteryouwantandtheOwnerslistboxlistsallthe
moduleinputstowhichitislinked.

3.

Todeleteoneormoreoftheselinks,clickonthemoduleinputintheOwnerslist
boxandclickUnlink.Theinputnameswillbereplacedwithdashedlines.

4.

Whenyouhaveunlinkedallofthemoduleinputsyouwant,clickOK.

ThenexttimeyouselectSend&Save,themoduleinputswillbeunlinkedonthe
node.

NOTE
Owners that reside on a different node are NOT displayed in this dialog box. If you need to delete a link
between modules on different nodes, use the procedure described in the previous section, Deleting a
Module's Input Links.

Configuring ION Modules

OnceyouhaveplacedanIONmoduleinanodediagram,youcanconfigurethe
varioussetupparametersofthemodule.Itisnotnecessarytodothisbeforeyou
linkthemodulesbutyoushouldensurethemoduleissetupcorrectlybefore
sendingtheconfigurationtothenode.
Modulesetupparametersincludethemoduleslabel;itssetupregisters,labelsand
values;anditsoutputregisterlabels.Theseareaccessedbyrightclickingonthe
symbolinthecenterofthemoduleicon.

TheIONModuleSetupdialogboxappears.

TheSetupRegistersboxlistsallthesetupregistersofthemodulealongwiththeir
currentvaluesorsettings.Ifyouwanttochangeanyofthesettingsorassigna
customlabeltoasetupregister,clickontheregisterlabel,thenclicktheModify

Page 228

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

button(ordoubleclickontheregisterlabel).Aseconddialogboxappearswhere
youcanmakemodifications.
Inmostcases,configuringasetupregisterisasimplematterofenteringanumber,
enteringtext,orchoosinganoptionfromalist.(Todeterminetheoptionsorranges
availableforasetupregister,refertothemodulesdescriptionintheION
Reference.)
Whenyouhavecompletedallyourmodificationstothemodule,clickOKto
returntothenodediagram.Themoduleiconappearspendinguntilyousendand
saveyourchanges.

NOTE
For legacy meters such as the ION7700, try to limit the number of custom labels you use for setup
registers; these legacy devices have a fixed number of custom labels available and they may be more
useful for labeling output registers or Boolean conditions.

Modifying Enumerated, Numeric Bounded, and String Setup

Registers
Iftheregisteryouhaveselectedisanenumerated,numericboundedorstring
register,oneofthefollowingdialogboxesappearwhenyouclickModify:

Note that labels can be up to 15 characters long.

Tomodifyanenumeratedregister,selectanoptionfromtheOptionslist.
Tomodifyanumericboundedregister,typeanumberintheValuebox.The
allowablerangeisshownundertheValuebox;youarealertedifyoutypea
numberoutsidethisrange.
Toenteraformattednumericvalue,clickFormat.IntheFormattedNumeric
Valuedialogbox,youcanenterthenumericvalueasadate(offsetfromJan1,
1970)oratimeinterval.
Tomodifyastringregister,typeyourtextintheStringbox.

2007 Schneider Electric. All rights reserved.

Page 229

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

NotethatwhenyouclickModifyforastringregisterthatistheconnectionstring
foraLogAcquisitionmoduleorQuerymodule,theModifyDatabaseConnection
Propertieswindowdisplays:

Modifying a custom label for a setup register

Dooneofthefollowinginthedialogbox:
Tocreateacustomlabel,selectUseCustomLabelandthentypeanameforthe
labelinthebox.
Iftheregisterisalreadyusingacustomlabelandyouwanttoreverttothe
defaultlabel,selectUseDefaultLabel.
Whenyouhavecompletedallyourmodificationstotheselectedsetupregister,
clickOKtoreturntotheSetupdialogboxforthemodule.

Modifying Calendar Setup Registers

TheIONSchedulermodulehasaspecialclassofsetupregistercalledacalendar
register.Configuringacalendarregisterismoreinvolvedthanconfiguring
enumerated,numericboundedandstringsetupregisters,anditisonlynecessary
fornodesthathaveaSchedulermodule.Fordetailedinformationabouthowto
configureacalendarregister,refertothedescriptionoftheSchedulermodulein
theonlineIONReference.

Modifying Address Setup Registers

AllDistributedNumeric,DistributedBoolean,andDistributedPulsemodules
containanAddressSetupRegisterthatreferencesanotherregister.Youcanspecify
anewvalueorclearanexistingvalueasrequired.(Currently,theVirtualProcessor
istheonlynodeofferingthesetypesofmodules.)

NOTE
Currently, you can only link the Address Setup Register to External Numeric, External Boolean, and
External Pulse registers.

Page 230

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Modifying an Address Setup Register

1.

RightclickonaDistributedNumeric,DistributedBooleanorDistributed
PulsemoduletodisplaytheIONModuleSetupdialogbox.

2.

IntheSetupRegistersbox,clickonaregistertohighlightit,andthenclickthe
Modifybutton.TheModifyAddressRegisterboxisdisplayed.

3.

IntheModifyAddressRegisterdialogbox,doubleclickonthenode,manager,
moduleandoutputregisteryouwanttouse.ClickOKtocontinue.

4.

IntheIONModuleSetupdialogbox,clickOKtoacceptyourchoice.

NOTE
You can clear the value of an address setup register. On the Modify Address Register dialog box, select
the Reset Register Value box, and then click OK.

2007 Schneider Electric. All rights reserved.

Page 231

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Parent Module and Shared Setup Registers

Setupregistersthataresurroundedbyasterisks(e.g.**PM1PTSec**),indicate
thatthemodulesharesitssetupregisterswithanother(parent)module.An
exampleofthisistheHighSpeedorMeterUnitsPowerMetermodule(HSPower
Meter,MUPowerMeter).Theysharetheirsetupregisterswiththeparent
module,PowerMeter.
Ifyoutrytomodifyasharedsetupregister,apromptidentifiesthenameofthe
parentmodule:

Navigatetotheparentmoduleandchangeitscorrespondingsetupregister.

Using Custom Labels

TheIONarchitectureofferstheoptiontoassigncustomlabelstomodules,setup
registers,outputregisters,andBooleanON/OFFconditions.Allmodulesand
registershaveadefaultlabelandthislabeliswhatyouseeinnodediagrams,user
diagramsandeventlogsunlessyouspecifyacustomlabel.
Creatingcustomlabelsallowsyoutoclearlydescribewhatthemoduleandits
registershavebeensetuptodo.
However,carefullyconsiderwhichmodulesandregistersshouldbeassigned
customlabels.Thereisafixednumberoflabelsavailable,buttherearethousands
ofregistersyoucanassignthemto.Manyoftheseregistersdonotbenefitfrom
customlabels.Forexample,mostsetupregisterscanbeleftattheirdefaultnames
sincetheonlyplacetheirnamesmightappearisintheeventlog.

NOTE
Some devices, such as the ION7300 and ION7700 have a 15-character limit for labels.

Customizing Module Labels

TheIONModuleSetupdialogboxallowsyoutoeditthemodulelabel.The
modulelabelisthetextthatappearsacrossthetopofthemoduleiconinthenode
diagram.Itisalsothelabelthatisusedineventlogsandinthedialogboxforthe
IONtree.Ifyouwanttospecifyacustomlabel,typeitintotheModuleLabelbox.
1.

IntheIONModuleSetupdialogbox,dooneofthefollowing:
Tocreateacustomlabel,selectUseCustomLabelandthentypeanamefor
thelabelinthebox.
Ifthemoduleisalreadyusingacustomlabelandyouwanttoreverttothe
defaultlabel,selectUseDefaultLabel.

Page 232

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

2.

ClickOKtoreturntothenodediagram.

Customizing Output Register Labels

YoucanalsospecifycustomlabelsforoutputregistersintheSetupdialogbox.By
customlabelingoutputregisters,youcanclearlyindicatetheinformationthey
contain.Forexample,ifyouhavelinkedtheVlnaoutputregisterofaPowerMeter
moduletoaThermalDemandmodule,andinturnlinkedtheThrmDemand
outputregistertoaMaximummodule,youmaywanttolabeltheMaximum
modulesoutputregisterasVaTDMaximum(insteadofusingthedefaultname
ofjustMaximum1).
Editing a custom output register label
1.

IntheIONModuleSetupdialogbox,clickontheoutputregisterintheOutput
Registersbox,andthenclickModify.
TheModifyLabeldialogboxisdisplayed.

2.

IntheModifyLabeldialogbox,dooneofthefollowing:
Tocreateacustomlabel,selectUseCustomLabelandthentypeanamefor
thelabelinthebox.
Ifthemoduleisalreadyusingacustomlabelandyouwanttoreverttothe
defaultlabel,selectUseDefaultLabel.

3.

ClickOKtoreturntotheIONModuleSetupdialogbox.

Customizing Boolean Output Register Labels

IftheoutputregistersofthemoduleareBoolean,youcancreatecustomlabelsto
associatewiththeONandOFFconditionsoftheseregisters.Theselabelscanbe
veryhelpfulforclarifyingexactlywhattheONorOFFconditionsrepresent.For
example,ifaBooleanoutputregisterisusedtoswitchafanonandoff,youcould
createaBooleanONlabelcalledFanRunningandanOFFlabelcalledFanNot
Running.
Editing Boolean ON/OFF labels
1.

IntheIONModuleSetupdialogbox,clickontheBooleanoutputregisterand
thenclickModify.
TheModifyBooleanRegisterdialogboxisdisplayed.

2007 Schneider Electric. All rights reserved.

Page 233

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

2.

IntheModifyBooleanRegisterdialogbox,dooneofthefollowing:
Tocreatecustomlabels,selectUseCustomLabelandthentypenamesfor
theRegisterLabel,OnLabelandOffLabelintheappropriateboxes.
Ifthemoduleisalreadyusingcustomlabelsandyouwanttoreverttothe
defaultlabels,selectUseDefaultLabel.

3.

ClickOKtoreturntotheIONModuleSetupdialogbox.

Resetting ION Modules in a Node Diagram

Designerallowsyoutoundocertainchangesyouhavemadeinanodediagram
sincethelasttimeyousavedandsentyourchangestothenode.Itwillrefreshthe
selectedmoduleiconssotheyreflectwhatisactuallyonthenode.Reversible
changesinclude:
changingthevalueofasetupregister
changingmoduleorregisterlabels
changingthelinkbetweenmodules
Sinceaddinganddeletingmoduleshappenimmediatelyonanode,youcannot
refreshadeletedmodule(norcanyouundothecreationofamodule).
1.

Selecttheicon(s)ofthemodule(s)youwanttoreset.

2.

SelectEdit>Reset.

Allthechangesmadetotheselectedmodulessincethelasttimeyousentand
savedthenodediagramarediscarded.Modulesnotincludedintheselectionare
unaffected(thatis,iftheyhadpendingchanges,thechangeswillstillbepending.)

Fast-linking ION Modules in the Log Inserter

WhenlinkingmodulesintheLogInserter,youcansavetimebyusingtheFast
Linkerutility.TheFastLinkerautomatesmuchofthelinkingprocess,enabling
youtoquicklylinkanycombinationofevent,dataorwaveformrecorders.To
accesstheFastLinkeroptions,pressCtrlandclickontheLogInserterinputs.
FormoreinformationonusingtheFastLinkerutility,seethedescriptionforthe
LogAcquisitionmoduleintheonlineIONReference.

Page 234

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Copying and Pasting ION Modules

Youcaneasilycreateanewfunctioninanodediagrambycopyingandpasting
modules.YoucancopyandpasteasingleIONmodule,agroupofmodules,
groupingicons,textobjects,ortheentirenode.
Youcancopymodulesfromonenodeandpastethemintoanother,aslongasthe
nodesupportstheselectedmodulesandhassufficientresources.Whenpasting
IONmodules,youcanreplaceexistingmodulesoraddnewones.
YoucanalsocopyIONmodulesandsavethemasaframework.Youandother
userscanthenreusethisframeworkinothernodes.Savinganodesconfiguration
asaframeworkprovidesafastandeasywaytoprogramalargenumberofnodes
atonce.

CAUTION
Persistent modules cannot be deleted, but they can be overwritten during a framework paste. Overwriting
a persistent module effectively relinks its outputs and rewrites its label, but its core functionality remains
intact (e.g. the Master Reset module may be relabelled, but pulsing this module still initiates a master
reset). When pasting a default framework onto a meter, use lock-paste to ensure that all persistent
modules in the "old" default framework are overwritten by the corresponding persistent module in the
"new" default framework. Persistent modules are listed in the "ION Device Template Reference".

Copying Modules
DesignerofferstwowaystocreatecopiesofIONmodules:copyandpasteusing
theIONsoftwareclipboard,orcopyandpasteusingaframework.

NOTE
The ION software Clipboard is a temporary storage area that holds any information cut or copied from
Designer. This clipboard should not be confused with the Windows Clipboard.

WhencopyingaselectionofIONmodules,youcanuseeithertheCopyorCut
commandsortheCopytoFrameworkcommand.(TheCopyandCutcommands
savetheselectionontheclipboard;theCopytoFrameworkcommandsavesthe
selectionasafile).
WhenpastingIONmodulesintothenode,youcanchooseeitherPaste(from
clipboard),orPastefromFramework.Pastingmodulesisalittlemorecomplicated
thancopyingthem,becausetheactionofaddingmodulesinthenodemayrequire
youtoreplaceexistingmodules.WhetheryouchoosePaste(fromclipboard)or
PastefromFramework,DesignerdisplaysaPasteSummarydialogboxthat
explainseachaspectoftheproposedchanges.
YoucanusethePasteSummaryboxtodefinehowtointegratethesourcemodules
intothedestinationmodules.Forexample,ifasourcemoduleisbeingpastedtoa
destinationthatisalreadyoccupied,youcaneitherlockpastethenewmodule
overtheexistingone,orfreepastethenewmoduleintothenextavailable
destination.

2007 Schneider Electric. All rights reserved.

Page 235

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Additionalconsiderationsincludepastingwithshortcuts,modulesthatcannotbe
pasted,andcloninganode(copyingandpastingacompletenodeconfiguration
fromonenodediagramtoanother).
Cutting or Copying ION Modules to the Clipboard
UsetheCutorCopycommandtosaveatemporarycopyoftheselectedmodules
totheclipboard.YoucanthenusethePastecommandtotransfertheselection
fromtheclipboardintoanynodediagram.Eachcopyretainsthesetupregister
values,customlabels,linkinformationandlayoutoftheoriginalselection.

NOTE
When selecting modules to be cut or copied, you can also include grouping icons and text objects. If you
select a grouping icon, all modules within the group are copied, as well as any nested grouping icons.

1.

Clickonthemoduleicontoselectit.(Toselectagroupofmodules,holddown
Shiftandthenclickoneachicon,orclickoutsideofthegroupanddraga
selectionboxaroundtheicons).

2.

Dooneofthefollowing:
Tocuttheselectiontotheclipboard(andremovetheoriginal),selectEdit>
Cut.
Tocopytheselectiontotheclipboard(andretaintheoriginal),selectEdit>
Copy.
Designercopiestherequestedinformationtotheclipboard.

Oncetheselectionhasbeencopiedtotheclipboard,youcanpasteitintoanyuser
diagramusingthePastecommandontheEditmenu.
Copying ION Modules to a Framework
YoucanusetheCopytoFrameworkcommandtocreateaframeworkfromthe
selectedmodules.Aframeworkisatemplatethatyoucanusetoreproducea
groupofIONmodules.Unlikeregularcopyingandpasting,aframeworkisstored
asafile,soyoucanpasteitlater.
WhenyouselectCopytoFrameworkfromtheEditmenu,Designercopiesthe
layout,linkageandconfigurationinformationofeachIONmoduleintheselected
group.Itsavestheframeworkasan.fwnfile.YoucanthenusethePastefrom
Frameworkcommandtopastethegroupinanothernodediagram.
Youcanuseframeworkstosimplifytheprocessofprogrammingmultipledevices
withsimilarconfigurations.Forexample,ifyouwantedtoprogramasingle
functionintoseveralnodes,youcouldprogramthefirstnodeandthencopythe
configurationtoaframework.Youcouldthenquicklyprogramtheothernodesby
simplyopeningtheirnodediagramsandpastingtheframeworkyoucreated.You
canalsouseframeworkstoprogramanentirenodeatonce,considerablyreducing
theamountoftimerequiredtosetupalargeinstallation.
Beforeyousaveagroupofmodulesasaframework,considercarefullywhich
modulesyouwanttoinclude.Ifyouincludecoremodulesinyourframework,you
willnotbeabletopastethemunlessyouoverwritetheexistingcoremodulesthat
correspondtothoseinyourframework.Anotherapproachistoselectthemodules

Page 236

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

downstreamofthecoremoduleandsavethemasaframework.Thenwhenyou
pastetheframeworkintoanothernodediagram,youcanusetheMaintain
ExternalInputsoptiontopreserveyourlinkstotheoriginalcoremodules.(See
UsingthePasteSummaryBoxonpage 238formoreinformation.)

NOTE
Once you have saved a framework, it can be used in another node diagram, as long as the node supports
the modules included in the framework. Although it is possible to create a framework from one node type
and use it with another node type, it is advisable to restrict your use of frameworks to nodes of the same
type.

Copying a group of ION modules to a framework

1.

Selectthegroupofmoduleiconsyouwanttocopy.(HolddownShiftandthen
clickoneachicon,orclickoutsideofthegroupanddragaselectionbox
aroundtheicons).

2.

SelectEdit>CopytoFramework.

3.

DesignerdisplaystheCopytoFrameworkdialogbox.IntheFileNamebox,
typeanamefortheframework,thenclickSave.Theframeworkfilename
extension(.fwn)willbeaddedautomatically.
Theselectionissavedasaframeworkfile.

Onceyouhavecopiedagrouptoaframework,youcanpasteitintoanode
diagramusingPastefromFrameworkontheEditmenu.

Pasting ION Modules

YoucanpasteasavedcopyofoneormoreIONmodulesintoanynodediagram.
Designerofferstwowaystopastemodules:PasteandPastefromFramework.
ThePastecommandinsertsaselectionthathasbeenplacedontheclipboardusing
theCutorCopycommand;thePastefromFrameworkcommandinsertsa
selectionthathasbeensavedasafile.Bothofthesecommandsareaccessedfrom
theEditmenu.(SeePastingIONModulesfromtheClipboardoraFramework
onpage 237formoreinformation.)
Ifyoupasteaselectionthatcontainsashortcut,Designermaypastetheshortcutas
amodule.(SeePastingShortcutsonpage 241formoreinformation.)
Insomecases,Designermaynotpasteeverymoduleinyourselection.(See
ModulesthatCannotbePastedonpage 242formoreinformation.)
Pasting ION Modules from the Clipboard or a Framework
WhenpastingIONmodules,thefirstthingtodoischoosethenodediagramand
windowwhereyouwantthemodulestogo.Ifyouhavemorethanonewindow
open,youcanclickonthetitlebarofthewindowyouwanttomakeittheactive
window.(Theselectionyoupasteisplacedintotheactivewindow.)

2007 Schneider Electric. All rights reserved.

Page 237

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

NOTE
You can paste ION modules into the same node diagram they were copied from, or into a different one.

YoucanpasteIONmodulesfromtwosources:theclipboardoraframework.
Whenyoupasteaselectionfromeithersource,Designerdescribestheproposed
changesonthePasteSummarydialogbox.YoucanusethePasteSummaryboxto
reviewyourchangesandmakemodificationsasnecessary.

CAUTION
The lock paste option in the Paste Summary box instructs Designer to overwrite existing destination
modules as necessary. Use lock paste with caution to avoid accidentally overwriting required modules.
(See Using the Paste Summary Box on page 238 for more information.)

Pasting ION modules into a node diagram

1.

OpenthewindowwhereyouwanttheIONmodulestogo.Clickinthe
backgroundofthewindowtoclearanyselectedmodules.

2.

Dooneofthefollowing:
Topasteaselectionfromtheclipboard,choosePastefromtheEditmenu.
Topasteaselectionfromaframework,choosePastefromFrameworkfrom
theEditmenu.InthePastefromFrameworkbox,selectthefileyouwant
andthenclicktheOpenbutton.

3.

ThePasteSummarydialogboxisdisplayed.UsethePasteSummaryboxto
reviewtheproposedchanges(seeUsingthePasteSummaryBox,below,for
moreinformation).Whenyouaresatisfiedwiththesummary,youcanclickOK
tocompletetheprocedure.

Theselectionispastedintotheactivewindow.Theentireselectionisautomatically
selectedsoyoucaneasilymoveittoaclearareainthewindow.Allmoduleicons
intheselectionappearsaspendinguntilyousendandsavethechangestothe
node.

Using the Paste Summary Box

BeforeDesignerpastesaselection,itdisplaysthePasteSummarybox.Youcanuse
thePasteSummaryboxtoreviewandmodifytheproposedchangestothenode
diagram.
ThePasteSummaryboxlistseachmoduletobepastedandindicatesits
destinationinthenode.Foreachmodule,thisboxprovidesashortsummaryofthe
proposedmodification,andamoredetaileddescriptionofhowthemoduleis
pasted,orwhyitcannotbepastedasrequested.

Page 238

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

ThefollowingsectionsdescribethevariousareasofthePasteSummarybox.
Source
TheSourcecolumnlistseachmodulethatwascopiedtotheclipboardor
framework.Eachsourcemoduleislistedbyitsdefaultlabelunlessacustomlabel
hasbeenspecified(inwhichcasethedefaultnameappearsinbracketsafterthe
label).Clickonamoduleinthiscolumntoviewadditionalinformationinthe
Detailsboxbelow.
Destination
TheDestinationcolumnindicateswherethecopyofeachsourcemoduleisplaced
inthenodediagram.ThemodulelabellistedintheDestinationcolumnmayor
maynotmatchthemodulelabellistedintheSourcecolumn.(Ifthedestination
moduleistobeoverwritten,itisreused;otherwise,thenextavailablemoduleis
used.)
Summary
TheSummarycolumnindicateswhetherthesourcemoduleiscopiedintothe
destinationasanewmodule,orifitreplaces(overwrite)anexistingmodule.This
columnalsoindicatesifamodulewillnotbepasted.

NOTE
You can sort the paste summary information alphabetically by source or destination, or by importance of
summary. Clicking on the Source, Destination, or Summary column headers sorts the list by the chosen
criteria.

Details
TheDetailsboxlocatedbelowthelistsectionexpandsuponthedescriptioninthe
Summarycolumn.WhenyouclickonamoduleintheSourcecolumn,youcan
viewadescriptionoftheproposedtransactionintheDetailsbox.Thisdescription
explainshowamoduleispastedoroffersreasonswhyitwillnotbepasted.

2007 Schneider Electric. All rights reserved.

Page 239

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

NOTE
You can create a copy of the information displayed in the Details section of the Paste Summary box. To
copy it, use the mouse to highlight the text you want, right click on the selection, and then choose Copy.
You can then paste this selection into a word-processing program.

Maintain External Inputs

TheMaintainExternalInputscheckboxofferstheoptionofpastingthemodule
selectionwithallexternallinksintact.Ifthischeckboxiscleared,allexternallinks
(linkstomodulesoutsidetheselection)arediscarded.
ThefollowingexampledepictsanexternallinktoaPowerMetermodule.

IfyoucopiedthetwomodulesontherightbutomittedthePowerMetermodule
fromtheselection,thelinktothePowerMetermodulewouldbeexternal.Upon
pastingtheselection,theexternallinktothismodulewouldbelostunlessyou
selectedMaintainExternalInputsonthePasteSummarybox.
Check boxes (free paste/lock paste/no paste)
Thecheckboxestotheleftofeachmoduleindicatetheproposedaction(thatis,
howthemodulewillbepasted).
Agreencheckmark indicatesafreepaste,acheckmarkwithalock
symbol
indicatesalockpaste,andaredXsymbol indicatesthemodule
willnotbepasted.AnXsymbolwithoutacheckbox identifiesamodulethat
hasnopossibledestination,andcannotbepasted.

Youcanclickonacheckboxtochangetheproposedaction.Forexample,clicking
onafreepaste
orawillnotbepasted
symbolchangesittoalock
paste
symbol.Whenyouchangethetypeofpaste,thedescriptionsinthe
SummarycolumnandtheDetailsboxalsochangetodescribethenewaction.(See
FreePasteorLockPaste?,below,formoreinformation.)
Whenspecifyingafreepasteorlockpasteformultiplesourcemodules,youcan
multiselectagroupandthenconfigureallmodulesinthegroupatonce.Hold
theShiftkey,andthenclicktwomodulestoselectallmodulesinbetween,orhold
theCtrlkeyandthenclickeachindividualmoduleyouwant.Onceyouhave
selectedthemodules,youcanclickanycheckboxtochangethepastefortheentire
selection.

Page 240

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Free Paste or Lock Paste?

YoucanusetheFreePasteandLockPasteoptionstoinstructDesignerhowto
respondtopotentialconflicts.Forexample,ifyouarepastingthemodule
Setpoint1intoadiagramthatalreadyhasaSetpoint1module,youhavetwo
options.Youcaneitheraddthenewmoduleunderanewname(forexample,
Setpoint2)oryoucanoverwritetheexistingmodulewiththenewoneandreuse
theoldname.
Thefirstoptionintheaboveexample,freepasting,canbeusedtopastenew
modulesintoadiagramwithoutdeletinganyexistingmodules.Thisisusefulfor
integratingnewfunctionsintoanodewithoutdisruptingthenodesexisting
functionality.Althoughthismayseemdesirable,itisnotalwaysthebestoption.
Byleavingexistingmodulesintact,afreepastecanresultinneedlessduplication
offunctions.Inaddition,somegroupsofmodulesareinterdependentandmay
requirealockpastetooperatecorrectly.
AlockpasteinstructsDesignertorecreatethesourcemodulesexactly,evenifthis
requiresDesignertooverwriteexistingmodulesinthediagram.Whenusedto
quicklyreplaceoldmoduleswithnewones,lockpastingisanefficientalternative
tothetimeconsumingprocessofdeletingamodule,addinganewoneandthen
configuringit.
Whendecidingwhethertousefreepasteorlockpaste,rememberthatyoucanuse
acombinationofbothwithinasinglepasteoperation.

NOTE
You can pre-select modules for Designer to reuse when free pasting. In the actual diagram where you
paste the selection, press Shift and then click on any module icons that you don't want. When you paste
the new selection, Designer has the option of replacing any of the selected modules with the new ones.

NOTE
Overwriting a module is not the same as deleting the module and then pasting a replacement module.
If a module is overwritten, links from the outputs of that module are retained at the inputs of other
modules. If a module is deleted, these links are also deleted and will not exist after the replacement
module is pasted.

Pasting Shortcuts
Identifiedbythesymbol
,ashortcuticonisarepresentationofamoduleicon
thatislocatedinanotherwindow.

Youcancopyashortcutinthesamewayyouwouldcopytheoriginalmodule;but
whenyoupasteashortcut,oneoftwothingshappen.Iteitherispastedasa
shortcuttoanexistingmodule(ifoneisavailable),orasanewmodule.Ineither
case,itcontinuestoperformitsfunctionasbefore.

2007 Schneider Electric. All rights reserved.

Page 241

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Thereisabasicreasonforreplacingashortcutwithamodule:ashortcutcannot
existinanodewithoutthemoduleitrepresents.Whenyoupasteaselection
containingashortcut,Designersearchesboththeselectiontobepastedandthe
destinationtolocatethemoduletheshortcutrepresents.Ifitfindsthemodule,it
pastestheshortcutasashortcut.Ifitdoesntfindthemodule,itreplacesthe
shortcutwithacopyofthemodule.Inthisway,Designerensuresthatthepasted
selectioniscompleteandnotdependentonamodulethatisunavailableinthe
destinationnode.
Designerperformsthisprocessautomatically,requiringnoinputfromyou.

Modules that Cannot be Pasted

Somemodulescannotbepastedbecausetheirsettingsarenontransferable
betweennodes.AllFactory,Communications,andDiagnosticsmodulesmustbe
individuallyconfiguredforeachnode.

WhenpastingaselectionthatcontainsaFactory,CommunicationsorDiagnostics
module,Designerpastesthelocationoftheiconsonly.

Cloning a Node
Youcanquicklyconfiguremultiplenodesbycloninganode.Essentially,cloning
anodeinvolvescopyinganodescompleteconfigurationtoaframework,andthen
pastingitontoanothernode.Thiseffectivelyreprogramsthenodereceivingthe
frameworkasanexactcopyoftheoriginal.

NOTE
When you paste an entire node's configuration, the Factory, Communications, and Diagnostics modules
will not be pasted because they could disrupt the operation of the device's communications. If you need
to change the settings of these modules, you can do so manually.

Copying a node's complete configuration

1.

Openthenodediagramofthesourcenode(thenodeyouwanttocopy).
Ensurethatthemainorrootwindowofthediagramisselectedbyclickingon
itstitlebar.

2.

SelectEdit>SelectAll.Allcoremodules,standardmodules,grouping
windowsandtexticonsareselected.

3.

SelectEdit>CopytoFramework.

4.

DesignerdisplaystheCopytoFrameworkdialogbox.IntheFileNamebox,
typeanamefortheframework,andthenclickSave.Theframeworkfilename
extension(.fwn)willbeaddedautomatically.
Thecompletenodeconfigurationissavedinthisframeworkfile.

Page 242

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Onceyouhavesavedthesourcenodesconfigurationasaframework,youcan
pasteittoothernodesofthesametype.Thisfilecanalsoserveasabackupincase
youwanttorestoretheconfigurationofthesourcenode.
Beforepastingthesourcenodesconfigurationontoanothernode,youshouldfirst
openthediagramoftheothernodeanddeleteitscontents.Adialogboxwillbe
displayedindicatingthatthecoremodulescannotbedeleted.(Thisdoesnotpose
aproblembecauseyouaregoingtobeoverwritingthecoremodules.)
Pasting a node's complete configuration into another node
1.

Openthenodediagramofthenodethatwillreceivethenewconfiguration.

2.

SelectEdit>SelectAll.PresstheDeletekeytoremovethenodesexisting
configuration.Adialogboxappearslistingthestandardmodulesthatwillbe
deletedandthecoremodulesthatcannotbedeleted.ClickOKtocontinue.
Thestandardmodulesandtexticonsaredeleted,andthecoremodules(andany
groupingwindowscontainingcoremodules)remain.

3.

Withthemodule(andgrouping)iconsselected,selectEdit>Pastefrom
Framework.(Iftheremainingiconshavebeendeselected,chooseEdit>Select
Allagain.)InthePastefromFrameworkbox,selecttheframeworkfile
containingthenodeconfigurationyouwantandthenclickOpen.
ThePasteSummarydialogboxisdisplayed:

4.

Selectallmodulesinthelist(clicklastitem,holdShift,andthenclickfirstlist
itemtheentirelistappearshighlighted).

5.

Changethepastetypetolockpaste(holdShift,andthenclickthepastetype
checkboxuntilallmodulesaresettolockpaste ).

6.

ClickOKtocompletetheprocedure.

Theselectedframeworkispastedintothenodediagram.Allmoduleiconsinthe
selectionappearaspendinguntilyousendandsavethechangestothenode.

2007 Schneider Electric. All rights reserved.

Page 243

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Viewing Output Registers, Setup Registers, and Inputs

Asdescribedearlier,eachmoduleiconhasaninputsymbol
andanoutput
symbol
.Theinputsymbol(ontheleft)providesaccesstothemodulesinputs,
andtheoutput symbol(ontheright)providesaccesstothemodulesregisters.

AregisterisatypeofmemorybankthatstoresanIONmoduleslinkingand
configurationinformation.EachIONmoduleusestwotypesofregisters:output
registersandsetupregisters.Bothtypesofregistersserveasstoragelocationsfor
themodule.Outputregistersstoredatathathasbeenprocessedbythemodule
(suchasnumericvalues,eventlogentries,andwaveformdata).Setupregisters
storethemodulesconfigurationinformation.

Viewing Output Register Information

Outputregisterinformationincludesthemodulesavailableoutputregisters,the
outputregisterrealtimevalues,andtheoutputregisterowners.Eachofthesecan
beaccessedfromtheoutputsymbollocatedontherightsideofthemoduleicon.

Viewing available output registers

Clicktheoutputsymbol.
Viewing output register real-time output values
PressShiftandclicktheoutputsymbol.
Viewing output register owners
Rightclicktheoutputsymboltoviewoutputregisterowners.
Thisdisplaysanoutputregistersownerssoyoucanidentifyalldependent
modulesonthenodeanddeterminethepurposeofeachdependentmodule.This
isusefulwhendeterminingtheeffectsandconsequencesofdeletingamodule.

Viewing Setup Register Information

Amodulessetupregisterscontainitsconfigurationinformation.Whenamodule
processesdata,itmanipulatesthedataaccordingtotheguidelinesstoredinits
setupregisters.Setupregisterinformationincludesthemodulesavailablesetup
registers,thesetupregistersettings,andthesetupregisterowners.Eachofthese
canbeaccessedfromtheoutputsymbollocatedontherightsideofthemodule
icon.

Page 244

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Viewing setup registers

PressCtrlandclicktheoutputsymbol(orrightclickthegraphicinthecenterof
themoduletodisplaytheIONModuleSetupdialogbox).
Viewing setup register settings
PressCtrl+Shiftandclicktheoutputsymbol(orrightclickthegraphicinthe
centerofthemoduletodisplaytheIONModuleSetupdialogbox).
Viewing setup register owners
PressCtrlandrightclicktheoutputsymbol.

Viewing Input Information

Inputinformationincludesthemodulesinputsandasampleofitsrealtimeinput
values.Eachofthesecanbeaccessedfromthemodulesinputsymbol.

Viewing inputs
Clicktheinputsymbol.
Viewing real-time input values
PressShiftandclicktheinputsymbol.

2007 Schneider Electric. All rights reserved.

Page 245

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Time of Use (TOU) Program Management

Tariffschedules,orTimeofUseprograms,areeasilycreated.Onceyouhave
createdatariffscheduleyoucanmanagethesefilesusingtheTOUProgram
Manager.
Creating a Time of Use Schedule
1.

ChooseOptionsfromthemainmenuandEditTOUPrograms...

2.

ClickMakeaNewTOUProgram.
ANewProgramappearsintheleftwindowofthedisplay.Clickonthisto
renameit.

3.

ClickEdit(LaunchProgramEditor).

4.

FollowtheinstructionsonscreenandclickFinishwhenyouaredoneandClose.

Downloading a Time of Use Schedule into an ION meter

1.

StartDesignerandconnecttoyourmeterusingthesoftware.

2.

FromtheFactoryConfigurationscreen,rightclicktheSampleTOUmodule
underTimeOfUseSetup.

3.

ClicktheQuickTOUbutton.

4.

SelecttheTOUscheduleyouwantandclickOK.

ThestepsfordownloadingaTimeOfUsescheduleintoanIONmeterdifferwhen
tryingtodosowithMeterShop.Usethefollowingstepsinthissituation:

Page 246

1.

ConnecttothemeterusingVistaandselectMeterSetupfromthemainmenu.

2.

ClicktheTOUschedulebuttonintheBasicSetupdiagram.

3.

SelectthescheduleyouwantandclickOK.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Advanced TOU Schedule Configuration

TheTOUprogrameditorprovidesanadvancedmodethatletsyoumake
configurationssupportedbythemeterbutthatarenotprovidedintheTOUEditor
describedabove.TheadvancedTOUisusefulinthefollowingcases:
WhenTOUseasonsdonotuseafixedstartorenddatethatisthesameinevery
calendaryear.
Alternatedaysdefinedasaspecificdateandarenotaparticulardayofthe
week.
Accessing advanced TOU mode
1.

InDesigner,selectOptions>EditTOUPrograms...SelectaTOUProgramor
createanewoneandclickEdit(LaunchProgramEditor).

2.

HoldtheCtrlkeyandrightclickthemouseinthetextintheSeasonssectionof
theSeasonsandRateDefinitionsscreen.
Adialogappearsthatletsyouaddasetupregisteroverrideordeleteormodify
anexistingsetupregisteroverride.

2007 Schneider Electric. All rights reserved.

3.

Toaddanewsetupregisteroverride,clickAdd....

4.

Selectasetupregisterfromthedropdownlistandtypeintheregistervalue
(availableregistersare:Seasons1,2,3,and4,andAlt1,and2Days).

Page 247

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

NOTE
Be sure to follow the syntax rules described in the TOU module section of the ION Reference. If the syntax
is incorrect the meter will not accept the configuration.

Todeleteanexistingsetupregisteroverride,selectitfromthelistandclick
DeleteandOK.
Tomodifyaregister,selectitfromthelistandclickModify.Makeyour
changesandclickOK.

5.

ClickOKtoreturntotheTOUProgramEditor.

6.

ClicktheSummarytabintheTOUProgramEditor.Thiscompilestheschedule
toincludethesetupregisteroverridesyoujustdefined.
TheDeviceSetupRegisterValuessectionofthesummarydisplaystheregister
valuesthatwillbesenttothemeterandincludetheconfiguredvalues.TheTOU
ProgramLogOutputsectionofthesummarydisplaystheloggeneratedwhile
theTOUscheduleiscompiled.Anysetupregisteroverridesthataredefined
appearasentriesinthislogfile.

Page 248

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Virtual Processor Service

TheVirtualProcessorisaservicethatoperatesontheIONEnterpriseserver,
providingcoordinateddatacollection,dataprocessing,andcontrolfunctionsfor
groupsofmeters.Thismakesdistributedoperationspossible,providing
customizedsolutionstoavarietyofindustrial,commercial,andpowerutility
needs.
TheVirtualProcessorletsyoutogathertheinformationavailablefromyour
networkofpowermonitoringdevices,andenablesyoutocategorize,manipulate,
and/orcustomizethedatabeforedistributingtheinformationtothedifferent
departmentsinyourcompany.YoucouldthinkoftheVirtualProcessorasa
virtualdevice,capableofcollectingandprocessingdatafromseveralpower
monitoringdevices,analyzingtheinformationandperformingcontrolfunctions
asrequired.TheVirtualProcessorsnameimpliesitscharacteristics:
VirtualTheVirtualProcessorrunsinthememoryofyourPC,notasaremote
device.
ProcessorTheVirtualProcessorcontainsawideselectionofIONmodules,
whichitusestoprocessinformation.

Using the Virtual Processor

TheVirtualProcessorisnotconfiguredatthefactory.Toperformdatacollection,
dataanalysis,Modbuscommunications,ordistributedcontrol,youmustfirst
createIONmoduleframeworks,usingDesignersoftware.ConsulttheonlineION
ReferenceforcompleteoperationaldetailsoneachIONmodule.

Configuring the Virtual Processor with Designer

AllVirtualProcessorconfigurationisdoneusingDesigner,includingaddingnew
IONmodules,configuringmodulesetupregisters,andlinkingmoduleinputsand
outputregisterstoothermodules.

Creating a Second Virtual Processor

CreateasecondIONVirtualProcessorServiceandstartitusingthefollowing
steps:
1.

Openacommandpromptwindow.

2.

RegistertheVirtualProcessorasaservicefromtheIONEnterprise\system\bin
folderbytyping:vip.exeServiceN<customVirtualProcessorname>

3.

OpenControlPanel>AdministrativeTools>Servicesandstartthenew
registeredVirtualProcessor.

Viewing Virtual Processor Data with Vista

OnceyouhaveusedDesignertoaddandlinkmodulesintheVirtualProcessor,
youcancreateauserdiagraminVistaandlinkittothemodulesintheVirtual

2007 Schneider Electric. All rights reserved.

Page 249

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

Processor.Youcanthenuseyouruserdiagramtodisplaysystemdata,monitor
alarms,andcontrolbasicfunctionsinyourVirtualProcessorframework.
Configuring the Virtual Processor to interact with the desktop
1.

OpenControlPanel>AdministrativeTools>Services.

2.

RightclicktheIONVirtualProcessorService,andselectProperties.

3.

SelecttheLogOntab.

4.

SelecttheAllowServicetoInteractwithDesktopcheckbox,andclickOK.

5.

StopandrestarttheIONVirtualProcessorService.

Distributed Control
VirtualProcessorDistributedControlmodulesareameansoftransferring
informationbetweenthedifferentdevicesinyournetwork.Thesemodulescanbe
usedtobuildframeworksforcontrolprocessessuchasalarmannunciation,plant
widedemandcontrol,powerfactorcontrol,loadshedding,paging,andgenerator
switching.
BeforedecidingtouseaVirtualProcessortoimplementacontrolsystem,itis
importanttounderstandthevariousfactorsthatinfluencethespeedwithwhich
theVirtualProcessorisabletogenerateacontrolaction.Someofthesefactors
includenetworktraffic,thenumberofpolleddevicesinyournetwork,the
reliabilityofyourcommunicationsnetwork,andtheVirtualProcessor
workstationsCPUusage.

CAUTION
Do not use the Virtual Processor in any capacity where a failure to execute an expected control action
could result in equipment failure or danger to personnel. Do not use the Virtual Processor for time-critical
functions.

Theinformationpresentedinthissectionassumesthatyouarefamiliarwiththe
variousIONmodulesandtheirfunction.RefertotheonlineIONReferencefor
detailsonDistributedControlandothermodules.

Distributed Control Modules

TheVirtualProcessorusesfourmodulestoimplementDistributedControl
frameworks.ThreetypesofDistributedControlmodules(DistributedBoolean,
Numeric,andPulsemodules)receivedatafromdevicesorotherVirtual
Processorswithinyournetworkandtransferthisdatatothenodeaddress
specifiedinthemodulessetupregisters.TheDataMonitoringmoduleisusedas
ameansofdisablingacontrolmodule,ifthedataatthesourceinput(whichisused
tomakethecontroldecision)becomesstale.
Distributed Control Module Setup Registers
AllDistributedControlmodules(DistributedBoolean,DistributedNumeric,and
DistributedPulsemodules)haveaSourceinputandanActivateinput.TheActivate
inputmustbelinkedtoanothermodule,anditmustbeonforaDistributed

Page 250

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Controlmoduletofunction.ThesemodulesalsocontainaDestinationsetup
registerthatspecifiesthenodereceivingthedata.
Distributed Boolean Module
AllDistributedBooleanmoduleshaveoneinputthatmustlinkedtoanExternal
Booleanoutputregister.WheneverthisregistersBooleanvaluechangesstate,the
newvalueissenttothenodedefinedintheDestinationsetupregister.
Distributed Numeric Module
ADistributedNumericmodulesinputmustbelinkedtoanExternalNumeric
module.ThisinputsvalueissenttothenodespecifiedintheDestinationsetup
register.Thismodulehastwoadditionalsetupregistersusedtodeterminewhen
andhowoftennewdataissenttotheDestinationnode.
Distributed Pulse Module
AllDistributedPulsemoduleshaveoneinputthatmustlinktoanExternalPulse
module.ThismodulespulseissenttothenodedefinedintheDestinationsetup
register.
Data Monitoring Module
TheDataMonitormoduleprovidesameansofalertingyoutocommunication
problemsthatmayoccurbetweentheVirtualProcessorandanyIONnode
referencedbytheDataMonitorsSourceinputs.

NOTE
ION meters with Advanced Security enabled do not accept control operations from the Virtual Processor.
In order to enable these control operations, you will need to provide a device password in Management
Console for these applications to use. See Accessing Meters with Advanced Security on page 30 for
information on configuring Advanced Security.

ItisimportanttomaximizethespeedatwhichtheVirtualProcessorreceivesthe
datausedtomakecontroldecisions.TheperformanceofaVirtualProcessorusing
DistributedControlissensitivetofactorssuchasnetworktraffic,theVirtual
Processorsglobalparameters,andtheworkstationsCPUusage.

Distributed Control Network Performance

Thefollowingsectionsprovidesomeguidelinesforimprovingadistributed
controlnetworksperformance.
System Configuration
Minimizethenumberofdevicespersiteforsitesincludingdevicesusedfor
distributedcontrol
Minimizethenumberofapplications(suchasVistadiagrams)thatare
requestingdatafromthecontrolsite
DecreasetheVirtualProcessorsClientPollingPeriod
Maximizethesitesbaudrate

2007 Schneider Electric. All rights reserved.

Page 251

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

CPU Performance
DedicateasingleVirtualProcessorforcontrolpurposes;anadditionalVirtual
Processorcanberunforlesscriticalfunctions.
DonotrunCPUintensivefunctionsonthesameworkstationasyourdistributed
controlVirtualProcessor.

Distributed Control Applications

TheVirtualProcessorsDistributedControlframeworkscanperformvarious
controlprocesses;twoexamplesarepresentedbelow.Ensurethatyouarefamiliar
withthesectionsabovebeforeusinganyofthesemoduleframeworksinacontrol
system.
Passing a Value Between Devices
ThefollowingexampleshowshowthenumericoutputoftheIntegratormodules
inIONmeterAissenttoanExternalNumericmoduleinIONmeterB.

Virtual Processor
ION meter A
Integrator

Output

Distributed
Numeric Module
Source
Activate

ION meter B

Destination: ION meter B

Data Monitor
Module

External Numeric
Output
Module

Status

Source

NotethattheDistributedNumericmoduleisdisablediftheDataMonitormodule
detectsacommunicationproblembetweentheIONmeterAandtheVirtual
Processor(e.g.,timeoutsorslownetworkconnections).Thishelpstoensurethat
controlactionsareonlyperformedbasedonfreshdata.
Device Control
Thisexampleframeworkmonitorstotalharmonicdistortion(THD),whichcould
causeapieceofequipment(likeapowertransformer)tooverheat.Whenasetpoint
isreached,thesystemsendsanetworkmessagetoaworkstationandturnsona
fan.

Page 252

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Virtual Processor

ION meter
Setpoint
Module

Harmonics Analyzer
Module

Distributed
Boolean Module

Status

Source

Total HD

Source
Activate

External
Boolean
Module

State

Digital Output
Module #1

Data Monitor
Module
State

Destination: ION meter,

External Boolean module,
Switch register

Status
Trigger

Source

Source

Launching
Module

Digital
Outputs

Launch

RunCommand = net send Workstation1

Current THD is high!
Signal to turn on cooling fan has been sent

Fan Switch

Modbus Communications
ModiconModbusRTUisanindustrystandardcommunicationsprotocolusedin
controlandpowermonitoringindustries.ThedevicesinaModbusnetworkhave
aMaster/Slaverelationshipwithcommunicationtransactionsoccurringbetween
theMasterandoneormanyslaves(upto247slavedevicescanexistinonesite).
TheVirtualProcessorcanactasaModbusSlavebyrespondingtorequestsfroma
ModbusMasterandprovidingitwithpowermonitoringsystemdata.

Providing Data for a Modbus Master

ThefollowingdiagramillustrateshowtheVirtualProcessorcanmakevaluesin
IONregistersavailabletoaModbusMasterdevice.AssumetheModbusSlave
modulessourceinputsarelinkedtonumericorBooleanoutputregistersfrom
otherIONmodules.Inthisexample,thevaluesobtainedfromthoseregistersare
convertedtotheproperModbusformat(accordingtohowtheModbusSlave
modulessetupregistersareconfigured).TheModbusSlavemodulerespondstoa
readrequestfromtheremoteModbusMasterdeviceandsendstheModbusdata
tothespecifiedModbusregisters(again,accordingtohowtheModbusSlave
modulessetupregistersareconfigured).
Virtual Processor

1. Read request by remote Modbus Master.

READ
Modbus Slave
Module

Modbus Value 1

Remote Modbus Device

Modbus Value 2

Modbus Register Map

Source 1
Source 2

.
.
.
Source 16

Modbus Value 32
Modbus Base
Modbus Link
Event

2. Requested data is sent from the Slave Module

to the specific Modbus registers.

2007 Schneider Electric. All rights reserved.

Page 253

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

The Virtual Processor's Modbus Slave Module

AstandardModbusSlavemodulecantakeupto16IONregistervaluesandmake
themavailabletoaModbusmaster.IntheVirtualProcessor,theModbusSlave
modulecanalsobeusedtobringModbusdataintoyourpowermonitoringsystem
(itpermitsaModbusmastertopushdataintotheVirtualProcessor).

NOTE
Refer to the ION Reference for complete details about the Modbus Slave module.

WhenaModbusSlavemoduleintheVirtualProcessorhasnolinkstoitsinputs,
theoutputregistersofthemoduleshowthecontentsoftheModbusregistermap.
Currently,onlytheModbusSlavemodulesintheVirtualProcessorhavethis
additionalcapability(theModbusSlavemodulesinIONmeterscannotdothis).
UsetheModbusSlavemoduletobringModbusdataintoyourpowermonitoring
systemasfollows:
1.

AfterstartingtheVirtualProcessorandopeningitinDesigner,addaModbus
Slavemodule(draganddroponefromthetoolbox):

2.

ConfiguretheModbusSlavemodulesinputs.
LeavetheinputsoftheModbusSlaveModuleunlinked.TheModbusSlave
modulewillnotreadtheModbusregistermapifanyofitsinputsarelinked(the
moduleprovidesthelinkeddatatotheModbusregistermap).

3.

ConfiguretheModbusSlavemodulessetupregisters.
TheModbusSlavemodulereadstheregistermapstartingattheaddress
specifiedinBaseAddrsetupregisteruntileachoutputregisterisfilled.
IftheFormatsetupregisterisa
16bitformat,16bitdataisputintoeachoftheModValoutputs.
32bitformat,twopiecesof16bitdataarecombinedintoone32bitModVal
outputregister.
PackedBoolean,thenthedataisputintotheModVal1outputregisterin
PackedBooleanform.

Page 254

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

IgnoretheScaling,InZero,InFull,andOutZero,OutFullsetupregisters;thereis
noscalingappliedtoanyoftheModbusregistermapvalues.
4.

ConfigureModbusSlavemodulesoutputs.
YoucannowlinktheoutputsoftheModbusSlavemoduletotheinputsofother
IONmodulesoftheVirtualProcessor.Threesuchexamplesare:
DataRecordermodulesfordatalogging
SetpointandRelativeSetpointmodulesforalarming
DistributedNumericmoduleforredistributiontoIONmeters(for
automatedplantwidedemandorpowerfactorcontrol)

Common Virtual Processor Applications

TheVirtualProcessorcanbeusedtocreatenumerousanalysis,recording,and
controlfunctions.ThissectiondescribesthreecommonVirtualProcessor
applications.
Theexamplesshownonthefollowingpagesassumethatyouunderstandthe
functionsandoptionsofthevariousIONmodulesused.RefertotheonlineION
ReferenceforIONmoduledetails.SeethepreviouschaptersforcommonModbus
andDistributedControlapplications.

Event Driven Report Generation

TheVirtualProcessorcanbeusedinconjunctionwithadeviceandtheLog
Insertertogeneratereportsinresponsetosystemevents.Inthefollowingexample,
aPowerQualityreportisautomaticallygeneratedintheeventofasystem
disturbance.

2007 Schneider Electric. All rights reserved.

Page 255

Chapter 7 - Designer

ION Enterprise 5.6 User Guide

ION meter

Log Inserter
Log Acquisition
Module

Trans Max

Transient
Module

Data Recorder
Module

Trans Dur

Source
Data
Log 1

V1
V2

Log Monitor
Module

Source 1

V3
V Nom

Source 2

Records
Processed

Source

Virtual Processor
Arithmetic
Module

Setpoint
Module

Result

Source

One-Shot Timer
Module

Trigger

Source
High Limit: 0
Low Limit: 1
Eval Mode: Greater Than

Formula: IF(S1-P1(1)>0,1,0)

Trigger

Start
Duration: 300 sec

Launching
Module
Launch
RunCommand: %PML_ROOT1%\bin\Repgen.exe -r Power_Quality

Astransientsoftenoccuringroups,thefiveminutedelaymadewiththeOneShot
timermoduleallowsmultipletransientstoappearinonePowerQualityreport.

NOTE
Using the Virtual Processors Launching module may require that the Virtual Processor be run as an
application instead of a service. Contact Technical Support if you require more information.

Data Aggregation
Inthefollowingexample,metersmonitoraveragecurrentvalues(Iavg).Every
dayataspecifiedtime(determinedbythePeriodicTimermodule),theData
RecorderModulestoresthemaximumaveragecurrentvalueateachmeter.
ION meter A
Power Meter
Module

Virtual Processor

Maximum Module
Source
Reset

l avg

Maximum Module
Source
Reset

ION meter B
Power Meter
Module

l avg

ION meter C
Power Meter
Module

Page 256

Maximum Module
Source
Reset

One-Shot Timer
Module

Maximum

Maximum

Maximum

Recorder Module

Trigger

Start

Source 1

External Control
Module

l avg

Periodic Timer
Module

Trigger

Rec Log

Source 2
Switch 1

Source 3
Enable
Record

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 7 - Designer

Logging Data From meters

TheVirtualProcessorcanbeusedtologdatafrommetersthatdonothaveData
Recorders.Inthefollowingexample,thetotalkWhfromanIONmetersIntegrator
moduleisrecordedevery15minutesbyaVirtualProcessorsDataRecorder
module.
ION meter
Power Meter
Module

kW tot

Integrator Module

Virtual Processor

Data Recorder
Module

Data Log

Source
Record

kW tot

Integrand

Periodic Timer

Trigger

Period: 900 sec

Setting Global Parameters

TheVirtualProcessorglobaloperatingparametersandmodbusnetworksetupare
configuredusingVirtualProcessorSetup.
Theglobalparametersdonotneedtobechangedfornormaloperation;theVirtual
Processoroperatesproperlyinmostapplicationswiththedefaultsettings.See
ModifyingtheGlobalParametersonpage 73fordetails.
TosetuptheVirtualProcessorsModbusnetwork,seeConfiguringtheVirtual
ProcessorsModbusServiceonpage 68.

NOTE
The Virtual Processor service must be restarted for any changes to take effect, as the Virtual Processor
only reads the vipsys.dat file once on startup. The Virtual Processor service can be restarted, like any other
service, using the Services window found via the Control Panel service applet.

2007 Schneider Electric. All rights reserved.

Page 257

Chapter 7 - Designer

Page 258

ION Enterprise 5.6 User Guide

2007 Schneider Electric. All rights reserved.

Modbus Device Importer

TheModbusDeviceImporterutilityenablesIONEnterprisesoftwaretorecognize
andeasilyintegratethirdpartyModbusdevicesintotheIONEnterprisenetwork.

In This Chapter
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
ION Object Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Managers ........................................................... 262
Modules............................................................ 262
Registers ........................................................... 262
Main Console Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Main Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
FileMenu........................................................... 264
EditMenu.......................................................... 264
ViewMenu......................................................... 267
ToolsMenu ......................................................... 268
SettingsMenu ....................................................... 271
HelpMenu ......................................................... 272
ConfigureLoggingandCalculationButton.............................. 272
Editing a Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
RegisterPropertiesDefined........................................... 273
Key Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
GeneralKeyShortcuts................................................ 278
RegisterQuickEditMode............................................. 278
TreeviewPane ...................................................... 279
ModbusRegisterListViewPane....................................... 280
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
DataFormats........................................................ 281
Configuring Logging and Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
ScreenOverview .................................................... 283
ConfiguringRegisterLogging ......................................... 284
ConfiguringLow,HighandMeanCalculationandLogging ............... 285
ConfiguringStaleDataSettings........................................ 285
ConfiguringDownstreamDeviceFunctionality .......................... 286
SavingandExiting ................................................... 287

2007 Schneider Electric. All rights reserved.

Page 259

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Introduction
TheModbusDeviceImportercreatesthefilesandsoftwaresupportnecessaryto
displaydatafromanyModbusdeviceusingtheVistaapplicationofION
Enterprise.TheModbusDeviceImporteruserinterfacesetsupusefulcommon
Modbusparametersbydefault,butalsoallowsyoutoconfigureallModbus
specificanddevicerelatedparameters.TheModbusDeviceImporteralsohas
builtinerrorcheckingtovalidatethefilesyoucreated,orthosefromother
sources.

Process Overview
CreatinganewModbusdevicetypeinvolvesthefollowingsteps:
1.

Identifythenewdevicetype(devicename,filename,etc.)

2.

CreateaModbusmapfileforthedevicetype:
IdentifyaModbusregistertobeadded.
FindanappropriateregistertomaptointheIONtree.
Selectappropriatedataformat,scalingfactors,etc.

3.

ConfigureadditionalModbusdevicefunctionality(ifrequired).

4.

Validateandcheckthedevicetype.

5.

AddthenewModbusdevicetypetothenetworkconfigurationdatabase
(NOM).

OncedefinedintheNOM,thenewModbusdeviceisavailableinIONEnterprise
justlikeanyotherPowerLogicdevice.SimplyselecttheModbusdevicetypefrom
thedropdownlist.IONEnterprisetreatsthisdevicelikeanyother.

Default Modbus Device Types

IONEnterpriseisshippedwithnumerouspreconfiguredModbusdevicetypes.
Foracompletelist,navigatetoTools>ViewcurrentDeviceTypesfromthe
ModbusDeviceImportermainconsole.Thesepreconfigureddevicetypesmay
alsobemodifiedasrequired,usingtheModbusDeviceImporter.

The ION Tree File

TheModbusDeviceImportercreatesandeditsIONtreefiles(.ion)forthedevice,
whicharethensavedandenteredintotheNOM,allowingIONEnterpriseto
recognizeandusethedevice.ThetreefiledefinesthelookandfeeloftheION
managers,modulesandregisters.

The Modbus Map File

TheModbusDeviceImportercreatesandeditsmappingfilesforthedevice,
linkingModbusregisterswithIONregisters.AModbusmapfileisanXMLfile
thatmustrefertotheXMLschemadefinedin.../config/translators/modbus
schema.xml.
Italsodefineshowtoconvertthemoduleregistervalueintothevalueshownin
theIONregister.

Page 260

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Map File Format

EachdistinctModbusdevicetypehasitsownspecialaddressrangesandrequires
itsownModbusmapfile.Vlnavg,onanION6200,forexample,islocatedat40103.
Itcouldbeinadifferentlocationonanyotherdevice.Ineithercase,itwouldbe
mostlogicallymappedtothePowerMeterModulesVlnavgoutputregister
(0x5803)inthedefaulttree.
Theexamplemapfileshownbelowillustratesthemapfileformat:
<?xml version="1.0" encoding="UTF-8"?>
<!--Created by Modbus Device Importer v 3.21.0 at: 3/22/2007
10:41:56 AM-->
<ModbusMap xmlns="x-schema:modbus-schema.xml">
<DeviceInfo Type="Example Device"
MultiplePresetSupported="0"
GlobalNotAvailable="NotSpecified" MaxRequestRegisters="125"
LowSpeedUpdateRate="30" HighSpeedUpdateRate="5"/>
<ModbusInfo IONHandle="134217729" Name="Baud Rate"
ModbusAddress="40001" RequestType="RW" Format="UINT16"
Scale="1" Offset="0" Multiplier="1"
DefaultEnumValue="Invalid Data">
<Enumeration Value="300 Baud"/>
<Enumeration Value="2400 Baud"/>
<Enumeration Value="9600 Baud"/>
<Enumeration Value="115200 Baud"/>
</ModbusInfo>
<ModbusInfo IONHandle="134217985"
Name="VoltsA@!!DeviceName!!Meter01" ModbusAddress="40002"
RequestType="R" Format="UINT16" Scale="1" Offset="0"
Multiplier="1"/>
<ModbusInfo IONHandle="134217986" Name="VoltsB@Meter01"
ModbusAddress="40003" RequestType="R" Format="UINT16"
Scale="1" Offset="0" Multiplier="1"/>
<ModbusInfo IONHandle="134217987" Name="VoltsC@Meter01"
ModbusAddress="40004" RequestType="R" Format="UINT16"
Scale="1" Offset="0" Multiplier="1"/>
<CalcInfo IONHandle="135266304" Name="Averaging 1"
Function="Averaging_Module"/>
<CalcInfo IONHandle="136314880" Name="Minimum 1"
Function="Minimum_Module"/>
<CalcInfo IONHandle="137363456" Name="Maximum 1"
Function="Maximum_Module"/>
<CalcInfo IONHandle="138412032" Name="Data Rec 1"
Function="DataRecorder_Module"/>
<CalcInfo IONHandle="139460608" Name="Feedback 1"
Function="Feedback_Module"/>
<CalcInfo IONHandle="140509184" Name="Periodic Tmr 1"
Function="PeriodicTimer_Module"/>
<CalcInfo IONHandle="131072000" Name="Diagnostics 1"
Function="Diagnostics_Module"/>
</ModbusMap>

2007 Schneider Electric. All rights reserved.

Page 261

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

ION Object Descriptions

IONobjectsaresoftwareitemsthatarerecognizedbyIONEnterprisesoftware.
IONobjectsconsistofdevicemanagers,modules,andregisters.Managers
separatedifferentmoduletypes,bygroupingtogethermodulesofthesametype.
Modulesgroupregistersintoconvenientorlogicalgroups.Registersarethe
objectsthatactuallyholdtheModbusregisterinformation.
FormoreinformationonIONarchitecture,seetheIONReferencemanual.

Managers
ManagersorganizetheModbusmapfileintoaformattedstructure.Therearethree
differenttypesofmanagerssupportedintheModbusDeviceManager:
ExternalBooleanManager:holdsBooleantyperegisters
ExternalNumericManager:holdsNumerictyperegisters
ExternalPulseManager:holdsPulsetyperegisters
Youcancreateupto127managers.Onceyoucreateamanager,youcannotchange
itsmanagertype.

Modules
Similartomanagers,modulesalsohelporganizethemapfilestructure.Youcan
createupto4095modulesinsideagivenmanager.Usemodulestoarrange
registersintologicalgroupingsorsimilarregistertypes.Whennamingamodule,
chooseanamethatisrelevanttothetypeofregistersitcontains.Modulesinherit
theclasstypeoftheirparentmanager,soyoucannotchangeamoduletypeonce
ishasbeencreated.

Registers
AregisterisanobjectthatcanbelinkedtoaphysicalregisteronaModbusdevice,
wheredataisreadfromorwrittento.YoucanmapregisterstoaModbusaddress,
thenuseVistatoreadandwritedatatothisModbusdevice.
Whenyoucreatearegister,itinheritsthetypeofitsparentmodule.Youcancreate
upto255registerspermodule.
Therearethreedifferentregistertypes:
Boolean Registers
BooleanregistersholdBooleandata,i.e.alogicalTrueorFalse(1or0).Youcan
attachalabeltotheregistertoindicateONorOFFstate.Ifanumericregisteris
mappedtoaBooleanregister,avalueof0(zero)putstheBooleanregisterinan
OFFstate,whileanyothervalueturnstheBooleanregisterON(unlessamaskis
applied).

Page 262

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Ifanyofthebitsexposedbythemaskareset,thevalueisinterpretedasaTrue.
OtherwiseitisinterpretedasFalse.MaskedBoolcanbeusedtosiftoutindividual
BooleansthatarestoredasarraysofbitsinModbus.Ifnomaskisspecified,allbits
arerelevant.Booleanregistersmaybe16or32bitslong.
Numeric Registers
Numericregistersholdnumericdata.
Pulse Registers
PulseregistersareusedinVistatosendapulsetothespecifiedaddress.Theyare
usedspecificallytowritevaluestoadevice.Theusermayspecifytheexactvalue
tosendoutasapulseforeachregister.Pulseregisterscanonlywrite16bitsworth
ofdata.
Factory Registers
YoucannotaddorremoveFactoryobjectsbutyoucaneditthem.AllFactory
registersareinitiallysettoadefaultconstantvalue.Youmaychangethese
constantvalues,ormaptheregisterstoavalidModbusaddress(seeEditinga
Register).Therearefouruserdefinedfactoryregistersthatyoumaychangeifthe
requiredregistersarenotalreadypresentinthedefaultlist.

Main Console Screen

OpentheManagementConsole.FromtheToolsmenu,selectModbusDevice
Importer.
Themainconsolescreenappearsasfollows:
Configure Logging and
Calculation Button

Tree-view Pane

Register Pane

ThemainconsoleiswheremostactionsareperformedandIONobjectsare
managed.Thedevicemanagers,modules,andregistersaredisplayedinthetree
viewpaneonthelefthandsideofthescreen.Informationspecifictoregistersis
displayedontherighthandsideofthescreenintheregisterpane.Ifyouselectan
objectinthetree,allregistersbelowitwillhavetheirinformationdisplayed.

2007 Schneider Electric. All rights reserved.

Page 263

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Navigatethroughthetreeviewbyclickingonthespecificobjectsorbyusingthe
arrowkeysonthekeyboard.
WhentheapplicationisstartedortheFile>Newmenuisselected,adefault
configurationisloaded.Theonlyobjectincludedinthedefaultconfigurationisthe
factorymanagerandassociatedregisters.Bydefaultyoumaynotspecificallysee
thefactoryobjectssoablanktemplateisdisplayed.

Main Toolbar
File Menu
ThefollowingmenuitemsareaccessedbyclickingFileonthemaintoolbar.
New:Createsanew,blankmapfile.
Open:Opensanexistingmapfile.
Save:SavesthecurrentmapfiletemplateandthecorrespondingIONtreefile
template.

NOTE
Saving the template to a folder other than ...\system\translators or ...\config\translators will not affect
devices currently being used. You must add or update the device for the change to be reflected in ION
Enterprise.

SaveAs...:Letsyousavethecurrentmaptemplatetoadifferentlocation.
RecentlyOpenFiles:Liststhethreemostrecentlyopeneddevicetemplates.
Exit:Closestheprogram.

Edit Menu
Youcanaddnewobjectsbyeitherrightclickinginthetreeviewpaneorselecting
theappropriateoptionfromtheEditmenu.
Objectsareplacedeitheraschildrenorsiblings.Forexample,youmayaddanew
managertothedevice(siblingofanexistingmanager)oranewmoduletoan
existingmanager(childofamanager).Thesamerelationshipappliestomodules
andregisters.
NewManager:Addsanewmanager.

Page 264

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Adding a new manager

1.

Enteramanagername.

2.

Selectamanagertype,usingthedropdownbox.ChoicesareExternalBoolean
Manager,ExternalNumericManager,andExternalPulseManager.Thedefault
isExternalNumeric.

NOTE
The manager type you choose determines parameters in the modules and registers under it.

3.

ClickOK.
NewModule:Addsanewmodule.

Adding a new module

1.

Enteramodulename.Thedefaultisthenextavailablenumberofthatmodule
typewithinthecurrentmanager(e.g.ExtNum3).
Thenameofthemoduledeterminesthedefaultnamesoftheregistersunder
it.Notethatthemodulenamecanbechangedlater,ifrequired.

2.

ClickOK.

NOTE
Duplicate names are permitted but not recommended.

NewRegister:Addsanewregister.SeeEditingaRegisterformore
informationonusingthisdialogbox.
Onceyouenterallthenecessaryinformation,clickOK.
NewRegister(Quick):Addsanewregister,usingalldefaultsettings.Nodialog
boxisassociatedwiththiscommand.Ifnoregisterscurrentlyexistinthetarget
module,thenthisistreatedascreatinganewregisterwithadialogbox.
TheModbusaddressisautomaticallyincrementedasappropriatebasedonthe
registertypeandsize.
Copying and Pasting Objects
Youcancopyandpastemodulesandregisters.Afteryoucopyanobject,youmay
pasteitintoadifferentlocationinthetree.Youmaynotpasteregistersormodules
fromoneclasstypetoanother(i.e.,youcannotcopyaBooleanregisterandpaste
itintoanumericmodule).
Copy:Copiesyourselection(s)totheclipboard.

2007 Schneider Electric. All rights reserved.

Page 265

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

NOTE
You can also copy multiple registers by selecting the registers in the register pane and selecting Copy.

Therearethreedifferentpasteoptions:Paste,PasteCloneandPasteMultiple.
Paste:PastingregistersnormallywillautomaticallyincrementtheModbus
addressbasedontheregisterdatatype.InthecaseofMaskedBool,itwill
incrementthebitmaskbyoneuntilitreaches0x8000,whentheModbusaddress
incrementsbyoneandthemaskresetsto0x0001.
ThenewregisterlabelisresettoadefaultlabelsuchasPowerMeter
Module.0004.
PasteClone:PastingaCloneisthesameaspastingnormallywiththeexception
thattheModbusaddressoftheregisterisnotbeincreased.Thisisauseful
featureforpastingmultipleregisterswiththesameModbusaddressbut
applyingdifferentmasks.
ThenewregisterlabelisresettoadefaultlabelsuchasPowerMeter
Module.0004.
PasteMultiple:Pastingmultiplecopiessimplyperformsanormalpastea
determinednumberoftimes,eachcopyincrementingtheaddressthe
appropriatenumberofaddresses.
Moving Objects
Youcanmovebothmodulesandregisters.Thisisdonebyselectingthedesired
object(s)ineitherthetreevieworregisterpaneandthenholdingdowntheALT
key.Youmaymovethemoduleorregistertoanyotherholdingobject,butthe
samerulesapplyaspasting.Itmustbemovedtothesamedatatype.
Editing Objects
YoucaneditallobjectsintheModbusDeviceImporterbyrightclickingonthem
andselectingProperties.SeeEditingaRegisterformoreinformation.
Deleting Objects
YoucandeleteallobjectsintheModbusDeviceImporterbyrightclickingonthem
andselectingDeleteselected<typeofobject>.Ifyoudeleteanobject,allchildren
(objectsbeneathit)arealsodeleted.Youcandeletemultipleregistersatonceby
selectingthemintheregisterpaneandthenclickingDeleteselectedRegisters.
Advanced Properties
SelectingthismenuitemopenstheDevicePropertiesdialogbox.Youcanalso
openthisdialogboxusingView>DeviceProperties.Formoreinformation
regardingdeviceproperties,refertothesectionontheViewmenu.

Page 266

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

View Menu
ThefollowingmenuitemsareaccessedbyclickingViewonthemaintoolbar.
Refresh:Refreshesthemainconsolescreen.
CollapseAll:Collapsesthetreeview.
DeviceProperties:ClickView>DeviceProperties,orrightclickonthetree
viewrootandselectProperties.Thefollowingdialogboxappears:
DevicePropertiesTab

EnterthenameoftheDeviceTypeinthisfield.

NOTE
Changes made here are not be reflected in ION Enterprise until you add or update the device type.

FactoryInformationTab

2007 Schneider Electric. All rights reserved.

Page 267

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Thesefieldsareusedtoidentifythedevicetype.Bydefault,allvaluesare
constantvalues,butyoucanmapthemtoModbusregistersifrequired.
AdvancedTab

DefaultDiagramTemplateLabelfield:Thisisusedifthedevicehasadefault
Vistadiagram.Thestringenteredinthisfieldisaninternalidentifierandis
onlyusediftheAddGenerateNetworkDiagramSupportfeatureisused.
Maximumnumberofregistersforasinglerequestsetting:Themaximum
numberofregistersrequestedforthedevicecanbesetanywherefrom1to125.
Itisrecommendedthatyoudonotchangethissettingunlessthespecificdevice
hasspecialrequirements.
MultiplePresetWritecheckbox:Besurethatyoumatchthischeckboxwith
thedevicetype:selectthecheckboxifthedevicetypesupportsMultiplePreset
Writeforregistersandcoils;clearthecheckboxifthedevicetypeonlysupports
SinglePresetWrite.
Disable1checkbox:ThisisaspecialfeatureforIONpowermeters.ION
powermetersreturna1ifaspecifiedregisterisnotavailableandthesystem
interpretsthatvalueasacontrolsignal.Mostdevicesusethevalueof1asa
validdatavalue,soitisrecommendedthatthisfeatureisturnedoffforallnon
IONpowermeters.
Requestedupdateperiodforanycalculatedregisterssetting:Enteranumber
(inseconds)tospecifyhowoftenthephysicalModbusdeviceispolledto
updatetheregistersusedforcalculations.

Tools Menu
ThefollowingmenuitemsareaccessedbyclickingToolsonthemaintoolbar.
AddDeviceType:Afteryoucorrectlyconfigureadevice,youcanaddittothe
IONEnterprisedevicetypedatabase(NOM).
ByaddingadevicetotheNOM,youcannowcreatenewdevicesofthedevice
typeintheManagementConsole.Beforeyoucanaddthedevicetype,youmust
gototheDevicePropertiesandconfigurethedevice(SeeViewMenu).

Page 268

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

ToaddthedevicetypeclickTools>AddDeviceType.Afterthedevicetypeis
added,anewscreenappearsthatshowsthedevicetypescurrentlyintheNOM
(SeeViewCurrentDeviceTypes).Ensurethatthedevicetypeyouaddedis
presentandtheconfigurationiscorrect.
UpdateDeviceType:IfyouaddadevicetypetotheNOMbutchangeswere
madetothetemplate,thenyoucanupdatetheNOMtoreflectthesechanges.
Youwillbenotifiediftheupdateissuccessfulornot.Ifitfails,youmust
removeanydevicesofthespecifieddevicetypefromtheManagementConsole
andthenupdatetotheNOMagain.

NOTE
The NOM update may fail if the device type you are updating is currently being used in the Management
Console. If this occurs you must remove all devices of the specified type before the update will be
successful, or contact Technical Support for possible workarounds.

AddGenerateNetworkDiagramSupport:IfaVistadiagramhasbeen
createdforadevicetype,thenyoucansetitupasthedefaultnetworkdiagram
inVista.
Thisenablesalldeviceswhicharethenewdevicetypetohavedefaultdiagrams
inVistawhentheGenerateNetworkDiagramfeatureisutilized.Itis
recommendedthatthedefaultVistadiagramiscreatedbeforerunningthis
feature.
Youmustconfigurethefollowingfactoryregistersinorderforthisfeatureto
workcorrectly:
FAC1DeviceTyperegister
Thisregistermusthaveaconstantvalue.ThisissetintheDeviceProperties
windowastheDeviceType.Useadescriptivenamethateasilyidentifiesthe
device.
FAC1Templateregister
Thisregistermusthaveaconstantvalue.Usesomethingspecifictothecurrent
register.Forexample,adevicecalledTest_Devicecouldbe
Test_Device_Rev1.0.3.Thetemplateshouldreflectthedevicetype,aswell
asthecurrentversion,toavoidfutureconfusionifsimilardevicesareadded.

NOTE
Both of these registers must have constant values. Modbus Device Importer does not support the Add
Generate Network Diagram support feature for devices that get either of these register values
dynamically (i.e., mapped to a Modbus register).

Afteryouenterthecorrectregistervalues,youcanfindtheAddGenerate
NetworkDiagramsupportfeatureundertheToolsmenu.Thisfeatureisvery
usefulifyouhavemultipleversionsofaspecificdevicetype.
Thisfeaturewillcreatethenecessaryregistrykeysandsetuptherequired
directorystructureforgeneratinganetworkdiagram.

2007 Schneider Electric. All rights reserved.

Page 269

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

NOTE
By default the diagram is a blank diagram. You must modify this diagram to actually correspond to the
specified device.

SaveIONHandleList:Sometimesitisusefultoviewthelistoftheregisters
alongwiththeircorrespondingIONhandles.Youcanusealistlikethistocreate
aVistadiagramwithoutanactivedeviceconnected.
YoucancreatethislistbyclickingTools>SaveIONHandleList.Thiscreates
atextfileinthecurrentModbusDeviceImporterinstallationfolder.Thename
ofthetextfileisintheformat<currentDeviceName>.csv.
ValidateTemplate:Youcanvalidatethecurrentconfigurationbyclicking
Tools>ValidateTemplate.

Doingthisperformsvariousvalidationandintegritytestsonthecurrent
configurationoftheIONandModbusobjects.Itlistspotentialerrorssuchas
registersthatsharethesameModbusregisteraddressorregistersthathave
conflictingmasks.Theerrorchecksthatareperformedmaybetoggledonor
off,usingthecheckboxesinthedialogbox.

NOTE
You must manually fix any errors or else you will not be able to add or update the device type.

ViewCurrentDeviceTypes
YoucanviewthedevicetypescurrentlyintheNOMbyclickingTools>View
CurrentDeviceTypes.

Page 270

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Fromhereyoucandeleteolddevicetypesthatarenotbeingused.
Notethatyouwillseemultipleentriesforthesamephysicaldeviceinthe
devicetypelistings(forexample,6200RTUand6200ModTCP).TheModbus
DeviceImporterclassifieseachdifferentprotocolasaseparatedevicetype.

NOTE
You may not delete a device type that is currently being used by the Management Console.

Calculator:ThisloadsthedefaultWindowscalculator.

Settings Menu
ThefollowingmenuitemsareaccessedbyclickingSettingsonthemaintoolbar.
ChangetheDefaultTemplatepath:Thedefaulttemplatepathisusedfor
loadinganewtemplate.Usethiscommandtochangethepathifrequired.
EnableAutoValidation:Thisisselectedbydefault.
StartApplicationMaximized:ThismakestheModbusDeviceImporteropenin
amaximizedstate.
Showpropertieswindowonadoubleclick:Allowsanobjectsproperty
windowopenifitisdoubleclickedinthetreeviewpane.
AutoselecttextonEditinRegisterInformation:Allowsafieldthatisclicked
onintheregisterpanebefullyselectedwhentheeditscreenopens.Thisis
usefulifyouneedtochangetheentirefield.
Advanced:Youcanaccesstwofeaturesfromthissubmenu:
ShowFactoryObjects
Makesthefactoryobjectsvisibleinthetreeviewpane.Withthisfeature
enabled,youcaneditthepropertiesoftheFactoryobjects.

2007 Schneider Electric. All rights reserved.

Page 271

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

ShowModbusAddressesinHex
Withthisfeatureenabled,allModbusaddressesintheregisterpaneare
displayedinhexadecimalformat.

NOTE
If this setting is enabled, registers cannot be edited in the register pane.

Help Menu
ThefollowingmenuitemsareaccessedbyclickingHelponthemaintoolbar.
ModbusDeviceImporterHelp:OpenstheHelpfilefortheprogram.
About:Providesversioninformationfortheprogram.

Configure Logging and Calculation Button

ClickthisbuttontoentertheConfigureLoggingandCalculationutility.This
screenallowsyoutoconfigureadvancedfunctionsforModbusdevices,suchas
enablinglogging,andshouldonlybeusedbyadvancedusers.Seethe
ConfiguringLoggingandCalculationsectionformoreinformation.

Editing a Register
Thefollowingdialogboxdisplaystheregisterinformation.Dependingonthetype
ofregisterbeingedited,differentdatafieldsmayappear.

Youmayalsoeditaregisterbydoubleclickingintheregisterpane.Thisisafaster
waytoeditbasicregisterproperties.WhentheEditModeisinitiatedintheregister
pane,theselectedregisteropensupintoaneditmode:

Page 272

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

YoucanscrollthroughthelistinEditmodeusingthePageUpandPageDown
keys.Aftereditingthevalues,pressEntertosavethechanges.

NOTE
If you use the Page Up and Page Down keys then the changes made are saved as if Enter was
pressed.

YoucancancelanychangesyoumadebypressingEscapeorclickingthemouse
wheel(ifoneispresent).

Register Properties Defined

Thefollowingregisterpropertiescanbeconfigured:
Register Label
Thelabelisadescriptionattachedtotheregister.Youcanchangethisvalueatany
time;itisonlyanidentifierfortheregister.

NOTE
The register label string has a maximum character limit of 50, including spaces. Keep this in mind
especially when creating labels for downstream devices since they may require additional space in the
label name.

Make this register a constant value

Ifthisboxisunchecked,thentheIONregisterismappedtoaModbusregisterand,
whenviewingitinVista,youwillseetherealvaluesfromthemeter.Ifthisis
checked,thenitissettoaconstantvalue.Youcanuseaconstantvaluetohold
dynamicconstantvalues,deviceidentificationorothervalues.
ION Setup Register
YoucanconfigureanyregistertobeanIONsetupregister.Setupregistersdonot
appearintheVistaregisterlistunlessyouselecttoviewthesetupregisters.

NOTE
This does not affect the read/write capabilities of a valid Modbus register; it is a feature specific to Vista.

Data Type
Thisdatatypeisusedfordecodingthevaluesreturnedfromthemeter.The
selecteddatatypeformatmustmatchtheformatdeliveredbythedevice.Each
supporteddatatypeisexplainedunderAdditionalInformationintheData
Formatssection.

2007 Schneider Electric. All rights reserved.

Page 273

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Register Type
ThisisaconvenientwaytochangetheModbusregistertype.Itonlychangesthe
mostsignificantnumberintheModbusaddresstocorrespondtothespecified
registertype.Thisregistertypemustmatchtheregistertypespecifiedbythe
devicedocumentation.TheregistertypealsodeterminestheModbusfunction
codeusedwhentalkingtothedevice.
Modbus Address
Thisisthephysicaladdressofthespecifiedregister.Youcanfindthisnumberin
thedevicedocumentation,andyoucanenterthenumberineitherdecimalor
hexadecimalformat.Addressrangescorrespondtoregistertypesasfollows:
COILSTATUS=0xxxx
INPUTSTATUS=1xxxx
INPUTREGISTER=3xxxx
HOLDINGREGISTER=4xxxx

NOTE
When entered in hexadecimal format, the value is only the register offset and does not include the
Register Type identification.

Request Type
Thistellsthesystemwhetherornotitcanread(R),write(W)ordoboth(RW)
actionstothespecifiedregister.
Register Mask
Thismaskisappliedtotherawdatareceivedfromtheregister.Themaskis
appliedinanANDfashion.
Forexample,ifthemask0x4isapplied,thentheregistervaluedisplayedwill
onlybenonzeroifthe3rdleastsignificantbitintheregisterisa1.
YoucanapplymaskstobothnumericandBooleandatatypes.Applycustom
masksbyscrollingdownthelistandselectingtheCustom...option.When
prompted,enterthevalueinDecimal,Binary,orHexadecimalformat.

NOTE
For integer values, the bit order of the mask corresponds to the bit order of the actual data and NOT the
order in which the bytes representing the data are returned over Modbus. The high-order nibble of a 32bit value is selected as 0xf0000000 regardless of whether the format is U32_4321 or U32_2143. It
should also be noted that the resulting value of a masked integer is NOT bit shifted. A mask of 0xf000
applied to a 16-bit value of 0x1234 results in 0x1000 (4096 decimal) and NOT 1.

Register Scale / Multiplier

Thisspecifieswhatthescalefactorofthedatabeingrequestedshouldbe.Thescale
maybesettoanyconstantdecimalvaluewithintherangeof3.402823466E+38
to3.402823466E+38.Ifyoucanobtainthescaleforaspecificregisterfromthe
device,thenyoucanmapthescalevaluetoanotherregister.Youcanonlymapthe
scalefactortoregistersalreadycreatedintheModbusDeviceImporter.

Page 274

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

ThemappedregisterusedcanbeavalidModbusmappedregisteroraregister
withaconstantvalue.Mappingthescaletoaconstantregisterisaconvenient
feature;youcanchangethescaleformanyregistersbychangingtheconstant
valueinonelocation.
Mapping the scale factor to another register
1.

SelecttheReferenceanotherregisterforthescalecheckbox.Thefollowing
dialogboxappears:

2.

Usethedropdownmenustonavigatetotherequiredregister.ClickOK.

ThescaletobeusednowappearsintheRegisterScalefield.
Register Offset
Theregisteroffsetisusediftheregistervaluereturnedmustbeoffsetbyavalue.
Thescalemaybesettoanyconstantdecimalvaluewithintherangeof
3.402823466E+38to3.402823466E+38

NOTE
If 10 is entered, then 10 is subtracted from the received value. To add 10, enter -10.

Scale/MultiplierandOffsetapplied:

Modbus value

scale * ION value + offset

(1)

multiplier

OR

ION value

(Modbus value - offset) * multiplier

(2)

scale

Iftheoffsetforaspecificregistercanbeobtainedfromthedevicethenyoucanmap
theoffsetvaluetoanotherregister.Youcanonlymaptheoffsetfactortoregisters
alreadycreatedintheModbusDeviceImporter.

2007 Schneider Electric. All rights reserved.

Page 275

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

ThemappedregisterusedcanbeavalidModbusmappedregisteroraregister
withaconstantvalue.
Mappingtheoffsettoaconstantregisterisaconvenientfeature;youcanchange
theoffsetformanyregistersbychangingtheconstantvalueinonelocation.
Mapping the offset factor to another register
1.

SelecttheReferenceanotherregisterforOffsetcheckbox.

2.

SeeMappingthescalefactortoanotherregistersectionfordetails.

Register Not Available Value

Iftheregisterhasacontrolsignalvaluetoindicatethattheregisteriscurrentlynot
available,thenyoucansetthevaluehere.Thevaluemustmatchthedatathatis
receivedfromtheregisteronthedevice.Ifavalueisreceivedthatmatchesthis
propertyvalue,thestringNotAvailableisdisplayedwhenviewingtheregister
inVista.
Boolean Labels
ThisoptionisonlyavailabletoBooleanregisters.Youcansetdefaultlabelsfor
StatusObjectsinVista.
Value to send out as a Pulse
Thisoptionisonlyavailabletopulseregisters.YoucanspecifytheexactModbus
valuesenttothedevicewhenapulseregisterisactivatedinVista.
Constant String Value
Aconstantformanipulatingdataretrievedfromthedevice.
Number of registers to request
ThisoptionisonlyavailableifthedatatypeissettoASCIIorASCIIReverse.You
canspecifythenumberofregisterstoretrievefromthedeviceonarequestfrom
here.
Enumeration
Enumerationisusefulforconvertingnumericvaluerepresentationintohuman
readablestringvalues.
Forexample,youcanuseenumerationonaBaudrateregister.Thevalueis
representedasanumberfrom0to3,where0=300Baudand3=115200Baud.With
enumerationyoucanmapthereturnvaluestocorrespondingstringvalues.In
Vista,whenyouviewtheregister,itdisplaysthecorrespondingstringvalue
insteadoftheactualreturnvalue.
Youcanalsouseenumerationtogeneratenoncontiguousscalingvaluesforother
registers.Forexample,aModbusscaleregisterreturns2,1,0,+1and+2,which
indicatescalingof102,101,1,101and102respectively.Inthiscase,youwoulduse
anenumeratedordinalof2through+2withenumeratedlabels0.01through
100.
Youcanaccessenumerationforaregisterfromtheregisterpropertieswindow,the
EditModewindowandalsofromthetoolbar.

Page 276

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Whenselected,thefollowingscreenappears:
Youmayaddorremoveenumeration
valuesbyselectingthemandclickingthe
appropriatebutton(AddNewor
Remove).Whennewenumerationsare
added,theyareappendedtothebottom
ofthelistandaregiventhenext
sequentialordinalvalue.Youcanrelocate
valuesupanddownwiththe

and
buttons.
Youcanchangetheordinalvalueforthe
enumerationsbydoubleclickinginthe
OrdinalValueslist.Thechangepropagatesdowntothebottomofthelist,ensuring
thatthelistgoesfromsmallestnumbertolargestnumber.

2007 Schneider Electric. All rights reserved.

Page 277

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Key Mappings
General Key Shortcuts
Keystrokes

Action

CTRL-N

Opens a new template (after a save prompt).

CTRL-O

Opens an existing template (after a save prompt).

CTRL-S

Quick saves the current template.

CTRL-A

Saves the current template in a new location.

CTRL-D

Adds the device to the NOM.

CTRL-U

Updates the device in the NOM.

CTRL-G

Adds Network diagram support for the device to the system.

CTRL-P

Opens the device properties window.

F5

Refreshes the tree-view pane, collapsing all nodes except the currently selected
node.

F6

Collapses all nodes in the tree-view.

F11

Saves the current ION Handle list.

F12

Views the current device types in the NOM.

Register Quick Edit Mode

Keystrokes

Page 278

Action

TAB

Cycles through the data fields.

Enter

Saves the changes to the current register and exits edit mode.

Page Up

Saves the changes to the current register and displays the edit mode for the
register above the current register.

Page Down

Saves the changes to the current register and displays the edit mode for the
register below the current register.

Escape or MouseWheel Click

Cancels the changes to the current register and exits edit mode.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Tree-view Pane
Keystrokes

2007 Schneider Electric. All rights reserved.

Action

Right Arrow

Expands a node or selects a child if children are already expanded.

Left Arrow

Collapses a node or selects a parent node if no children are expanded.

Up Arrow

Scrolls up through the list of nodes.

Down Arrow

Scrolls down through the list of nodes.

Mouse RightClick

Brings up the pop-up edit menu.

Enter, Space Bar

or CTRL-X

Opens the properties window for the selected object.

F1

If the root device type is selected, a new manager is created and the manager
properties window is displayed.

F2

If a manager is selected, a new module is created and the module properties

window is displayed.

F3

If a module is selected, a new register is created and the register properties

window is displayed.

F4

If a module is selected, a new register is created but the register properties

window is not displayed.

Insert

- It is equivalent to F1, F2 or F3 depending on which object is currently selected.

- If a register is selected then the enumeration window is displayed.

Delete

- If a manager is selected, a prompt to delete the manager is displayed.

- If a module is selected, a prompt to delete the module is displayed.
- If a register is selected, a prompt to delete the register is displayed.

Holding ALT
while dragging
an object

- If the object is a module it can be dragged and dropped into another manager
of a similar class.
- If the object is a register it can be dragged and dropped into another module
of a similar class.

CTRL-C

- If a module is selected, then the module is copied.

- If a register is selected, then the register is copied.

CTRL-V

- If a manager is selected and a module has been copied, then the module is
pasted.
- If a module is selected and one or more registers have been copied, then the
registers are pasted.

CTRL-B

If a module is selected and one or more registers have been copied, then the
registers are clone pasted.

CTRL-Z

If a module is selected and one or more registers have been copied, then a
prompt comes up asking how many copies to paste.

Page 279

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Modbus Register List View Pane

Keystrokes

Page 280

Action

Up Arrow

Scrolls up through the list of registers.

Down Arrow

Scrolls down through the list of registers.

Mouse RightClick

Brings up the pop-up edit menu.

Enter, Space Bar

or CTRL-X

Opens the quick edit window for the selected register.

Insert or F3

A new register is created in the module of the currently selected register and the
register properties window is displayed.

F4

A new register is created in the module of the currently selected register but the
register properties window is not displayed.

Delete

A prompt is displayed asking to confirm the delete of the selected registers.

Holding ALT
while dragging
one or more
objects

The selected registers can be dragged and dropped over to a new module of
similar class in the tree-view.

Insert

It is equivalent to F1, F2 or F3 depending on which object is currently selected. If

a register is selected then the Enumeration window is displayed.

Delete

- If a manager is selected a prompt to delete the manager is displayed.

- If a module is selected a prompt to delete the module is displayed.
- If a register is selected a prompt to delete the register is displayed.

Holding ALT
while dragging
an object

- If the object is a module it can be dragged and dropped into another manager
of a similar class.
- If the object is a register it can be dragged and dropped into another module
of a similar class.

CTRL-C

The selected registers are copied.

CTRL-V

The registers that have been copied are pasted into the current module.

CTRL-B

The registers that have been copied are clone pasted into the current module.

CTRL-Z

The registers that have been copied are pasted multiple times into the current
module. A prompt comes up asking how many copies to paste.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Additional Information
Data Formats
Typically,ModbusdataistransmittedinbigENDIAN(bigendin)formatbut
alternatesinwhichtheindividual16bitwordsareswappedarenotuncommon.
TheformatssupportedbytheIONEnterprise5.6UserGuideare:

Format Type

Description

SINT16

A 16-bit signed value in 2-1 (or big ENDIAN) format. The high order byte is first, the low-order byte second.

UINT16

A 16-bit unsigned value in 2-1 (or big ENDIAN) format. The high order byte is first, the low-order byte second.

SINT32 or S32-4321

A 32-bit signed value returned in two consecutive 16-bit registers. The high-order word is returned in the first
register, the low order word in the second. In effect, the 4 bytes are returned in 4-3-2-1 (or big ENDIAN) format.

UINT32 or U32-4321

A 32-bit unsigned value returned in two consecutive 16-bit registers. The high-order word is returned in the first
register, the low-order word in the second. In effect, the 4 bytes are returned in 4-3-2-1 (or big ENDIAN) format.

S32-2143

A 32-bit signed value returned in two consecutive 16-bit registers. Contrary to S32_4321, the high-order word is
returned in the second register, the high-order word in the first. In effect, the 4 bytes are returned in 2-1-4-3 format.

U32-2143

A 32-bit unsigned value returned in two consecutive 16-bit registers. Contrary to U32_4321, the high-order word is
returned in the second register, the low-order word in the first. In effect, the 4 bytes are returned in 2-1-4-3 format.

S32-MFP or
S32-M10k-4321

A 32-bit signed value returned in two consecutive 16-bit registers. The word stored in the first 16-bit register is
multiplied by 10000 and added to the word stored in the second 16-bit register. Also known as signed Modulo
10000.

U32-MFP or
U32-M10k-4321

A 32-bit unsigned value returned in two consecutive 16-bit registers. The word stored in the first 16-bit register is
multiplied by 10000 and added to the word stored in the second 16-bit register. Also known as unsigned Modulo
10000.

S32-M10k-2143

A 32-bit signed value returned in two consecutive 16-bit registers. Contrary to S32_M10k_4321, the word stored in
the second 16-bit register is multiplied by 10000 and added to the word stored in the first 16-bit register.

U32-M10k-2143

A 32-bit unsigned value returned in two consecutive 16-bit registers. Contrary to U32_M10k_4321, the word stored
in the second 16-bit register is multiplied by 10000 and added to the word stored in the first 16-bit register.

S48-M10k-21-65

A 48-bit signed value returned in three consecutive 16-bit registers. R3*10,000^2 + R2*10,000 + R1, where R3 is
the last register and R1 is the first register. Each registers range is -9,999 to +9,999

U48-M10k-21-65

A 48-bit unsigned value returned in three consecutive 16-bit registers. R3*10,000^2 + R2*10,000 + R1, where R3
is the last register and R1 is the first register. Each registers range is 0 to +9,999

S64-M10k-21-87

A 64-bit signed value returned in four consecutive 16-bit registers. R4*10,000^3 + R3*10,000^2 + R2*10,000
+ R1, where R4 is the last register and R1 is the first register. Each registers range is -9,999 to +9,999

U64-M10k-21-87

A 64-bit unsigned value returned in four consecutive 16-bit registers. R4*10,000^3 + R3*10,000^2 +
R2*10,000 + R1, where R4 is the last register and R1 is the first register. Each registers range is 0 to +9,999

S64-87-21

A 64-bit signed value returned in four consecutive 16-bit registers. The highest order word is returned in the first
register, the lowest order word in the fourth. In effect, the 8 bytes are returned in 8-7-6-5-4-3-2-1 (or big ENDIAN)
format.

U64-87-21

A 64-bit unsigned value returned in four consecutive 16-bit registers. The highest order word is returned in the first
register, the lowest order word in the fourth. In effect, the 8 bytes are returned in 8-7-6-5-4-3-2-1 (or big ENDIAN)
format.

S64-21-87

A 64-bit signed value returned in four consecutive 16-bit registers. The highest order word is returned in the fourth
register, the lowest order word in the first. In effect, the 8 bytes are returned in 2-1-4-3-6-5-8-7 (or little ENDIAN)
format.

2007 Schneider Electric. All rights reserved.

Page 281

Chapter 8 - Modbus Device Importer

Format Type

ION Enterprise 5.6 User Guide

Description

U64-21-87

A 64-bit unsigned value returned in four consecutive 16-bit registers. The highest order word is returned in the
fourth register, the lowest order word in the first. In effect, the 8 bytes are returned in 2-1-4-3-6-5-8-7 (or little
ENDIAN) format.

S16-1-15

A 16 bit signed value. Bits 1 to 15 bits are unsigned data. If bit 16 is 0 the value is positive, if bit 16 is 1 the value is
negative.

IEEEFloat or F32-4321

A 32-bit IEEE floating point value returned in two consecutive 16-bit registers. The high-order word is returned in the
first register and the low order word in the second. In effect, the 4 bytes are returned in 4-3-2-1 format.

SwappedFloat or
F32-2143

A 32-bit IEEE floating point value returned in two consecutive 16-bit registers. Contrary to F32_4321, the highorder word is returned in the second register and the low order word in the first. In effect, the 4 bytes are returned in
2-1-4-3 format.

MaskedBool or
PackedBool

A 16-bit value that is interpreted according to the bit pattern described by the Mask attribute (see below). Bits
exposed by the mask can be read or written without affecting the value of other bits. Unmasked bits are interpreted
as 0 on a read and are unaffected on a write. Undeclared bits of a mask are interpreted as unmasked (i.e.,
mask="0x7F" is interpreted as 0x007F). The value that is read or written is determined by using enumeration
ordinals, described below. If used for read-only Boolean data, enumerations are not required. If no mask is
specified, all bits are relevant.

PF-Nexus

A 16 bit unsigned value, range 0 to 3999, representing 3 decimal places of accuracy.

BCD (Binary Coded

Decimal)

A number is expressed as a sequence of decimal digits and then each decimal digit is encoded as an 8-bit binary
number For example, decimal 92 would be encoded as 00001001 00000010.

Packed BCD

A number is expressed as a sequence of decimal digits and then each decimal digit is encoded as an 4-bit binary
number (nibble) For example, decimal 92 would be encoded as 1001 0010.

The following data types can have their length specified by the Number of Registers to Request setting. The default is two.
ASCII

A sequence of bytes representing the ASCII character set. Each word stores two ASCII characters. Trailing spaces will
be removed.

ASCII-Reverse

Same as ASCII except every second character is in the reverse order.

Page 282

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Configuring Logging and Calculation

UsetheConfigureLoggingandCalculationscreentoperformadditionalModbus
deviceconfiguration,including:
enablingregisterlogging,includingsettinglogfrequency
enablinglow(minimum),high(maximum)andmean(average)calculationsand
logging
configuringstaledatasettings
appendingdownstreamdeviceinformationtolabels

NOTE
Only numeric output registers can be calculated and logged. All other types of registers (for example,
enumerated) will not appear on the Configure Logging and Calculation screen.

Screen Overview
ClicktheConfigureLoggingandCalculationbuttonfromthemainModbus
DeviceImporterscreentoopentheapplication.
Thefollowingscreenappears:

Check this to make the

downstream device
columns appear

Per-register
edit area

Stale data
link

Low area

High area

Mean area

Help link

Global register edit area

Use this area to globally edit all
rows selected in the upper pane

2007 Schneider Electric. All rights reserved.

Page 283

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

AlltheregisterinformationfromthemainMDIscreenisprepopulatedinthis
tablewhenyouopentheapplication.
Showdownstreamdevicecolumnsselectthistoshowallthecolumnsfor
selectingandsettingthedownstreamdevicepropertiesforregisters.
Perregisterareausethisareatoindividuallyconfigureregisters.
Lowareayoucanenablecalculationandsetloggingoflowvaluesinthisarea.
Highareayoucanenablecalculationandsetloggingofhighvaluesinthisarea.
Meanareayoucanenablecalculationandsetloggingofmeanvaluesinthisarea.
Globalregistereditareausethebottomhalfofthescreentoeditindividual
registersormultipleregisters,afterselectingtheminthelist.
HelplinkclickthislinktoopentheModbusDeviceImporteronlinehelp.
StaledatalinkclickthislinktoopentheConfigureStaleDataSettingsdialog.

Filtering and sorting columns

Clickthefiltericoninacolumntoselectafilter.
Filter icon

Clickonthecolumnheadertosortinascendingorder.Clicktheheaderagainto
sortindescendingorder.

Configuring Register Logging

Toeditregistersonanindividualbasis,selecttherowoftheregisterandeditthe
cellsintheroworusetheeditingtoolsintheGlobalarea.
Toeditmorethanoneregister,selecttherowsyouwanttoconfiguresimilarlyand
usetheeditingtoolsintheGlobalarea.
Logselecttoenableloggingoftheregister.
Intervalthisvaluedeterminestheloggingfrequencyfortheregister.Notethat
thisvaluealsocontrolstheresetintervalforthemin,maxandaveragingmodules,
evenifthesecalculationsarenotbeinglogged.Validrangeis1to4,000,000
seconds;defaultis900secondsor15minutes.

Page 284

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Configuring Low, High and Mean Calculation and Logging

YoucaneditthesuffixusedforLow,HighandMeanbyclickingontheapplicable
link.Forexample,ifyouchangethesuffixtoMaximum,VoltsAHighbecomes
VoltsAMaximum.
Low
SelectCalculatetoenablecalculationoflow(minimum)valuesforthisregister.
SelectLogtoenableloggingofthisvalue.Notehowthelabelisappendedtoreflect
thatthisisthelowvalue.
High
SelectCalculatetoenablecalculationofhigh(maximum)valuesforthisregister.
SelectLogtoenableloggingofthisvalue.Notehowthelabelisappendedtoreflect
thatthisisthehighvalue.
Mean
SelectCalculatetoenablecalculationofmean(average)valuesforthisregister.
SelectLogtoenableloggingofthisvalue.Notehowthelabelisappendedtoreflect
thatthisisthemeanvalue.

Configuring Stale Data Settings

Datasstalenessismeasuredfromtimedatawaslastreadfromaphysicaldevice
untilthecurrenttime.
ClicktheAll(StaleData)linktoopenthedialog.

Markdatastaleafterenterthetimeyouwanttoelapsebeforedatafromthis
registerismarkedstaleinthedatarecorder.Validrangeis0to7200seconds;
defaultis120seconds.
Whendataisstaleselecthowyouwantstaledatavalueslogged.Thesettinglog
anemptyrowlogsanemptyrowinthedatarecorder,whileuselastknown
valuelogsthelastnonstalevalueinthedatarecorderuntiltheendofthecurrent
interval.Thedefaultisloganemptyrow.

NOTE
Stale data settings are global (apply to all registers).

2007 Schneider Electric. All rights reserved.

Page 285

Chapter 8 - Modbus Device Importer

ION Enterprise 5.6 User Guide

Configuring Downstream Device Functionality

YoumustselecttheShowdownstreamdevicecolumnscheckboxbeforeyoucan
editdownstreamdevicefunctionality.
Thescreenappearsasfollows:

Check this to make the

downstream device
columns appear

Is Downstream
Device

Downstream
Device

Include Name
of Device

IsDownstreamDeviceselectthistoindicatetheregisterbelongstoa
downstreamdevice.
DownstreamDeviceNameenterthedownstreamdevicesnameinthisfield.
Theregisterlabelisappendedwiththisname.Forexample,ifthedevicenameis
Meter01,theregisterlabelbecomesVoltsA@Meter01.

NOTE
Using this option without also using the Include Name of Device Instance option will cause multiple
devices to appear as a single device in your energy management system. Do not use this option on its
own unless only a single instance of this device is present in your system.

IncludeNameofDeviceInstanceselectthistoappendtheactualdeviceinstance
nametotheregisterlabel.Theplaceholder!!DeviceName!!isthenaddedtothe
labelthenameoftheactualdeviceinstancegetsinsertedwhenitiscreatedin
IONEnterpriseManagementConsole.

Page 286

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 8 - Modbus Device Importer

Forexample,ifthedeviceinstanceisnamedDevice01:
VoltsA@!!DeviceName!!Meter01
isreplacedwith
VoltsA@Device01Meter01
ThisallowseasycreationofuniquenameswithinIONEnterprise,aswellas
enablingeachdeviceinstancetoappearinIONsoftwareasmultiplevirtual
devices.
Formoreinformationondownstreamdevicesandnamingconventions,seethe
DownstreamDeviceAssistantchapter.

Saving and Exiting

ToexittheConfigureLoggingandCalculationscreen:
clicktheOKbuttontosaveyoursettings.
clicktheCancelbuttontoexitwithoutsaving.
YouarereturnedtothemainModbusDeviceImporterconsolescreen.

2007 Schneider Electric. All rights reserved.

1.

ClickFile>Savetosavethetemplatefiles.

2.

ClickTools>UpdateDeviceTypetosendthetemplatefilechangestotheNOM.

Page 287

Chapter 8 - Modbus Device Importer

Page 288

ION Enterprise 5.6 User Guide

2007 Schneider Electric. All rights reserved.

Database Management
DatabaseManagerhelpsyoumaintaintheinformationcontainedinyourdatabase
throughperiodicbackupsandarchives.

In This Chapter
Microsoft SQL Server Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
TheNetworkConfigurationDatabase.................................. 290
TheSystemEventsDatabase.......................................... 290
TheIONDatabase................................................... 291
Database Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
ManualTasks....................................................... 295
ScheduledTasks ..................................................... 303
DetachingthenReattachingDatabases ................................. 307
AttachingaDatabaseUsingDatabaseManager .......................... 307
RestoringanIONDatabasefromaBackup .............................. 308
AccessingtheIONDatabasewith3rdPartyApplications ................. 309
OptimizingDatabaseQueryTime ..................................... 310
Log Inserter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
LogInserterComponents ............................................. 313
ConfiguringtheLogInserter.......................................... 314
OptimizingLogInserter.............................................. 317

2007 Schneider Electric. All rights reserved.

Page 289

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Microsoft SQL Server Database

MicrosoftSQLServer2005ExpressEdition(SQLServerExpress)comeswith
IONEnterprisebydefault.SQLServerExpressisthedatabaseenginethat
managestheIONEnterprisedatabases:theIONdatabase(ION_data),the
NetworkConfigurationdatabase(ION_Network),andtheSystemEvents
database(ION_SystemLog).Toconnecttothedatabases,IONEnterpriseusesa
SQLServerinstancecalledION,whichwouldhavebeencreatedwhenION
Enterprisewasinstalled.
Alternatively,ifaSQLServer(2000or2005)instancealreadyexisted,theuser
couldhavechosentousethatSQLServerinstancewhenIONEnterprisewas
installed.

The Network Configuration Database

TheNetworkConfigurationdatabase(ION_Network)istheinformationstore
containingallthedetailsrelatedtocommunicationwiththenetworkofION
devices(andotherpowermonitoringdevices).Thisinformationisusedbythe
communicationsservices(e.g.IONNetworkRouterService,IONSiteService)and
othersoftwarecomponentstomanagedataandcontrolrequeststoandfromthe
devicesandtheotherIONsoftwarecomponents(i.e.Vista,Designer,Log
Inserter).
Scheduled backup at 1:00 am every day
Bydefault,ION_Networkisautomaticallybackedupeverydayat1:00am.This
scheduledbackupisconfigurableusingDatabaseManager.
ScheduledmaintenanceforION_Networkoccurseverydayat7:30am.See
ScheduledMaintenanceonpage 303formoreinformation.
TheDatabaseManagertasksyoucanperformonION_NetworkareDetach,
Backup,andRestore.

The System Events Database

TheSystemEventsdatabase(ION_SystemLog),isresponsibleforstoringdata
foreventsthatoccurduringtheoperationofIONEnterprisecomponents.For
example,theeventdetailsaboutthecommunicationservicessinteractionswith
devices,detailsaboutcontrolsinitiatedthroughVista,andgeneraloralarmlevel
eventsthatoccurintheVirtualProcessorareallinsertedintotheSystemEvents
databaseandmadeavailablethroughtheManagementConsole(Eventstab),and
throughaccesstothemainIONdatabaseusingVista(EventLogViewer).
UnliketheNetworkConfigurationdatabase,ION_SystemLogisnotbackedup.
SomecontentsoftheSystemLogSystemEventswithapriorityof192orgreater
areautomaticallyinsertedintothemainIONdatabaseonaregularbasisand
areviewablethroughVista.

Page 290

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Scheduled trim at 1:30 am every day

TheSystemLogdatabaseisautomaticallytrimmedofallnoncurrentdatadata
olderthan30daysinordertokeepitssizemanageable.Bydefault,thetrim
occurseverydayat1:30am.ThisscheduledtrimisconfigurableusingDatabase
Manager.
ScheduledmaintenanceforION_SystemLogoccurseverydayat7:05am.See
ScheduledMaintenanceonpage 303formoreinformation.
TheDatabaseManagertasksyoucanperformonION_SystemLogareDetachand
Trim.

The ION Database

TheIONdatabase(ION_Data)containsalltheinformationcollectedfromevery
devicethathastheabilitytorecorddataandfromeveryIONsoftwarecomponent.
ThisdatabaseusestheLogInsertertogatherdatafromalloftheavailablesources,
andthenmakesthedataavailabletoIONsoftwarecomponentslikeVista(through
theIONQueryService)orReporter(throughdirectdatabasequeries).
Scheduled backup at 12:00 am every Friday
ThisscheduleisinitiallydisabledwhenIONEnterpriseisfirstinstalled.When
enabled,thedefaultscheduledbackupoccurseveryFridayat12:00am.This
scheduleisconfigurableusingDatabaseManager.
ScheduledmaintenanceforION_SystemLogoccurseverydayat2:00am.See
ScheduledMaintenanceonpage 303formoreinformation.
TheDatabaseManagertasksyoucanperformonION_DataareDetach,Restore,
Backup,Archive,andTrim.

2007 Schneider Electric. All rights reserved.

Page 291

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Database Manager
YoucanuseDatabaseManagertomanuallyperformmaintenanceoperationson
theIONEnterprisedatabases,oryoucanconfigurescheduledtaskstoperform
theseoperations.
Starting Database Manager
1.

StartManagementConsole.

2.

ClickTools>DatabaseManager.

3.

Loginwithasupervisorlevelaccessusername.SeeUserManageron
page 51formoreinformation.

DatabaseManagerusestheMicrosoftManagementConsolewindow.Expandthe
treeviewintheleftpanetodisplaytheDatabasesandSchedulesitems.Selectan
itemintheleftpanetodisplaythetasksyoucanperformintherightpane.

SQL Server Instance

ThedefaultSQLServerinstancethatIONEnterpriseusesforitsdatabasesis
namedCOMPUTERNAME\ION,whereCOMPUTERNAMEisthenameofthe
serverwherethedatabaseresides.
Databases
SelectDatabasestodisplaythetaskiconsintherightpane.Youcanalsorightclick
onDatabasesandselectAllTaskstobringupthecompletelistoftasksavailable
toyou(refertoManualTasksonpage 295forindividualtaskinformation).

Page 292

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

NOTE
Selecting Show Non ION Databases displays the green database icons, which identify the rest of the
databases on the SQL Server instance that do not relate to ION Enterprise. Selecting Show Archives
displays the ION database archives (blue database icons).

SelectinganindividualIONEnterprisedatabase(i.e.ION_Data,ION_Network,or
ION_SystemLog)limitstheiconsintherightpanetothosetasksthatareavailable
forthatdatabase.Similarly,whenyourightclickoneoftheseindividualdatabase
entriesandselectAllTasks,onlythetasksthatcanbeperformedonthatparticular
databaseareavailabletoyou:
ION_Data

ION_Network

ION_SystemLog

SelectinganindividualdatabaseintheleftpaneandthenselectingtheStandard
tabatthebottomoftherightpaneliststhepropertiesforthatdatabase.The
propertieslistedare:
Size:Thecurrentsizeofthedatabase.
PrimaryFileLocation:Thefilepathfortheprimarydatabase(.mdf)file.
TransactionLogLocation:Thefilepathforthetransactionlog(.ldf)file.
CreationDate:Thedateandtimewhenthedatabasewascreated.
LastBackupDate:Thedatewhenthelastbackupwasperformed.
DiskSpaceAvailable:Theamountoffreespaceavailableonthediskwherethe
databaseresides.
ServerVersion:ThetypeandversionoftheSQLServerinstancethatishosting
thedatabase.
Schedules
SelectSchedulestobringupthescheduledtasksintherightpane.Notethatitmay
takeafewsecondsforDatabaseManagertogathertheinformationfordisplay.

2007 Schneider Electric. All rights reserved.

Page 293

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Doubleclickascheduledtaskintherightpane(orrightclickandselect
Edit<database><task>)toopenthatscheduledtaskspropertydialogwhereyou
canthenconfigurethesettingstosuityourneeds.Forexample,doubleclickthe
scheduledbackupontheION_Networkdatabaseifyouwanttoopenthat
databasesScheduledBackupdialogandenabletheschedule.Notethatyou
cannotconfigurescheduledMAINTENANCEtasks.
Theiconsontherighthandpaneillustratewhetherascheduledtaskisenabledor
disabled(grayedout),aswellaswhetherthetaskcompletedsuccessfullyorfailed
(redslashthroughicon).
RightclickanyscheduledtaskandselectViewtaskhistory...toopenthe
followingdialog,whichyoucanusefortroubleshootingpurposes:

Therundate,status(successfulorfailure),anddurationareavailableforall
scheduledtasks,includingmaintenancetasks.
SelectShowonlyfailedtaskstofilteroutcompletedtasksfromthelist.

Page 294

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Manual Tasks
Tostartamanualtask,clickitsiconintherightpane(ontheManualTaskstab),or
rightclicktheiconintheleftpaneandselectthetasknamefromtheAllTasks
shortcutmenu.

Alarm Configuration...
ClicktheDatabasesiconontheleftpanetodisplaytheAlarmConfigurationicon
ontherightpane.ClickAlarmConfiguration.

Database Size
Thissectionletsyoudisableorenablelocalalarmsthatmonitordatabasesize.You
canalsosetthesizethresholdthattheIONdatabaseand/ortheSystemEvents
databasemustexceedbeforeyoureceiveanalarmnotification.TheNetwork
Configuration(ION_Network)databaseisnotmonitored.
Hard Drive Space
Thissectionletsyoudisableorenablethealarmthatmonitorsyourharddrive(s).
Youcanchoosetomonitorallharddrivesorjusttheharddrivescontainingthe
IONdatabases.Youcanalsoadjustthethresholdfortheminimumamountof
spaceremainingbeforeyoureceiveanalarmnotification.
Send Network Message
Thissectionletsyouspecifythecomputerthatreceivesalarmnotificationsvia
networkmessages.
Send Email
ThissectionletsyouspecifythenameoftheSMTPserveraswellastheemail
addressesoftherecipientsyouwanttosendthealarmnotificationsto.

2007 Schneider Electric. All rights reserved.

Page 295

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Archive...

NOTE
The Database to archive list only shows your live ION database. To display the archives, right-click the
Databases icon and make sure Show Archives is selected on the All Tasks submenu.

Whenyouchooseastartdateforthearchiveprocedureinsteadofusingthe
beginningofthedatabase,theoptiontotrimthelivedatabaseisdisabled,evenif
youselectedthetrimoptionbeforesettingthedaterange.
Thedirectory...\IONEnterprise\config\cfg\Archives\Dataisthedefault
locationwherethearchiveissaved,butyoucanspecifyanotherlocaldirectoryif
youwant(youcanonlysaveanarchivetoalocaldirectory).Likewise,thearchive
youcreatehasadefaultfilename,butyoucanrenamethearchivetofollowyour
conventions.
Youcanalsochoosewhichdatatypestoarchiveandwhatdaterangetousewhen
performinganarchive.
TheProgressfielddisplaysthecurrentprogressofthearchiving.Ifamanual
archivingfails,youcanexaminetheProgressfieldtodiscoverwherethetaskfailed
theDatabaseArchivedialogremainsopenwiththeOKbuttongreyedout.Ifthe
archiveissuccessful,thedialogclosesautomatically.
Whenyouarchive,DatabaseManagercreatesaDataSourceName(DSN)entryon
theprimaryserver(i.e.,thecomputerrunningDatabaseManager).Database
ManageralsocreatesafilteredODBCregistrykeyexportfilecalled
ION_DsnKeys.regthatincludesitemsonlyrelatedto<SQL>DSNs.Thisregistry
fileiscreatedeverytimeyouarchivesothatthefileprovidescomplete,current
information.Itisstoredinthedirectory...\IONEnterprise\config\cfgonthe

Page 296

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

primarymachine,allowingclientinstallationsandsecondaryserversaccess
throughtheIONEntshare.

Attach...

Thisletsyoureattachadetacheddatabase.Toattachadatabase:
1.

StopallIONEnterpriseservices.

2.

SelecttheDatabasesicon,thenclickAttach.

3.

IntheAttachDatabasedialog,selectthedatabasetoattach,andspecifythe
nameintheAttachasbox.

4.

RestartallIONEnterpriseservices.

Backup...

ThistaskletsyoucreatecompletebackupsfortheION_Data,ION_Network,and
ION_SystemLogdatabases.Bydefault,thebackupsarestoredinthe
...\config\cfg\DBBackups\Data\directory.
IfyouhaveShowArchivesselected(ontheAllTaskssubmenuwhenyouright
clicktheDatabasesicon),youcanalsochoosetobackupyourarchives.Youcan
savethebackuptoyourlocalcomputerortoyournetworkusingaUniversal
NamingConvention(UNC)pathoramappeddrive.TheDescriptionofbackup
fieldisincludedsothatyoucanprovideinformationaboutthenatureofthe
manualbackup.

2007 Schneider Electric. All rights reserved.

Page 297

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Defragment...

YoucanchoosetodefragmenttheION_Data,ION_Network,andION_SystemLog
databases.Thesedatabasesaredefragmentedeverymorningbydefault,butthis
taskallowsyoutodefragmentadatabase,suchasanewlyattachedarchiveor
backupdatabase,anytime.Thedefaultdefragmentationtaskthatispartofall
Maintanancetasksonlyoccursif10%ormoreofthedatabaseisfragmented.

Detach...

ThistaskletsyoudetachadatabasefromtheSQLServersothattheexisting
databasefilescanbecopied,allowingtheoptiontoreattachalternateordefault
copiesofthesefilesifnecessary.
Todetachadatabase:
1.

StopallIONEnterpriseservices.

2.

ClearanyexistingconnectiontotheIONEnterprisedatabases(ION_Data,
ION_NetworkandION_SystemLog).

3.

ClickDetach,thenselectthedatabasetodetach.

4.

Afterperformingtherequiredmaintenance,reattachthedatabase(see
Attach...onpage 297fordetails).

5.

RestartallIONEnterpriseservices.

CAUTION
Do not move the ION_Network and/or ION_SystemLog databases unless absolutely necessary.

Page 298

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Export Database Registry Key...

Notethat...\IONEnterprise\config\cfg\isthedefaultsavelocationforthe
exporteddatabaseregistrykey.
ThistaskisparticularlyusefulifyouneedtosetupIONEnterpriseclientsina
systemwheretheprimaryIONEnterpriseserversdatabasesettings(server
instancename,databasename,orpassword)arecustomized.Onceyouexportthe
settingstoaregistry(.reg)file,youcanrunthatregistryfileontheclientmachine.

Modify Login...

TheModifyLogintaskletsyouchangethedefaultSQLServerpassword.
Modifying the SQL Server password using Database Manager

2007 Schneider Electric. All rights reserved.

1.

StoptheIONLogInserterServiceandtheIONQueryServiceusingthe
MicrosoftWindowsServicesapplication.KeeptheServiceswindowopen.

2.

StartDatabaseManager,thenselectDatabasesintheleftpane.

3.

ClicktheModifyLogin...icontoopenthedialog,andenteryournewpassword
inthePasswordfield.ClickOK.

4.

GobacktotheServiceswindowandrestarttheIONLogInserterServiceandthe
IONQueryService.

Page 299

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

New ION Database...

ThiscreatesablankversionoftheION_Datadatabase.

UsetheDatabaseNamefieldtonameyournewlycreatedIONdatabase(donot
nameitION_DataasthisisthedefaultnamefortheexistingIONdatabase).

Restore...

Dependingonthedatabaseyouarerestoring,thisprocedurereplacestheexisting
ION_Networkdatabase,ION_SystemLogdatabase,orION_Datadatabasewith
thedatabasefromtheappropriatebackupfile.Thesebackupfilesarelocatedinthe
followingdirectorybydefault:...\IONEnterprise\config\cfg\DBBackups.
Restore from
Thissectionofthedialoglistsalltheavailabledatabasebackups.Youcanverify
thatadatabaseisselectedwhenthereisablackarrownexttothedatabase.
ClicktheProperties...buttontoopenapropertyboxfortheselecteddatabase.The
informationdisplayedisthedatabasename,size,startdate,finishdate,location,
andbackupdescription.
Restore as
Thisfieldletsyourenamethebackupdatabasewhenitisrestored.

NOTE
It is not possible to simply detach the live file, copy the backup file into the live file location, and reattach
the file. The backup file is a file copy of the live database, but it must have some operations performed
on it to allow it to replace the live database. The Restore command performs these operations.

Page 300

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Show Archives
SelectthisoptionifyouwanttheDatabasesentryintheleftpaneofDatabase
Managertoincludeallarchiveddatabasesalongwiththelivedatabasesalready
displayed.OnceShowArchivesisselected,youhavetheoptiontoperformanyof
thetasksavailablefortheliveIONdatabaseonyourarchiveddatabases.This
meansyoucanarchive,backup,restore,detach(andattach),andtrimyour
archiveddatabases.Toperformthesetasks,eitherrightclickthedatabasearchive
listedbelowDatabasesintheleftpaneofDatabaseManagerandselectAllTasks,
orselectthedesireddatabasearchivefromthelistboxoneachtasksdialog.
CleartheShowArchivesoptiontohidethearchiveddatabasesfromviewandto
preventtheabilitytoperformthetasksmentionedaboveondatabasearchives.

Show Non ION Databases

Selectthisoptionifyouwanttodisplaythegreendatabaseiconsontheleftpane
(whichidentifytherestofthedatabasesontheSQLServerinstancethatdonot
relatetoIONEnterprise).

SQL Editor...
Whenyouchoosethistask,youarepresentedwiththefollowingwarning:

ClickOKtoproceedtotheSQLEditor.

CAUTION
The SQL Editor is intended for advanced users only. Changes made through the SQL Editor are in some
cases irreversible.

TheSQLEditortaskisincludedwithinDatabaseManagerforanumberofreasons:
TheSQLEditorletsyouexportdatabaseinformationfortroubleshooting
purposes.
WiththeSQLEditor,youcanwritecustomqueriesthatletyouviewwhatever
datayouwant.

2007 Schneider Electric. All rights reserved.

Page 301

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

TheSQLEditorprovidesamethodforimplementingcustomchangestothe
databases.Forexample,thisallowsyoutoexecuteacustomSQLscript
providedbySchneiderElectric.

NOTE
Ensure that you select the appropriate database before executing your SQL statement.

Trim...

YoucanperformtheTrimtaskontheION_DataandION_SystemLogdatabases.
IfyouhaveShowArchivesselected(ontheAllTaskssubmenuwhenyouright
clicktheDatabasesicon),youcanalsoperformatrimonthearchiveddatabases.
Youmustselectthedatatypesyouwanttotrimonlyifyouareworkingwiththe
ION_Datadatabase(oranarchive).Youcanselectanycombinationofdatatypes
totrim.

Update Statistics...

Statisticsonnumbersofrowsandrangesofkeyvaluesinthedataprovidedcanbe
usedbySQLServertodeterminethemostefficientwaytoaccessthebasetables,
thusimprovingtheperformanceofdistributedqueries.UpdateStatistics
recalculatesthesevaluesforbetterperformance.

Page 302

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Upgrade Database...

Thistaskupgradestheselecteddatabasewiththelatestdatabaseschema.
TheIONEnterpriseinstallerautomaticallyupgradesyourdatabaseswiththenew
databaseschemaswhenyouinstallIONEnterpriseonanexistingIONEnterprise
server.IfyouinstallthelatestversionofIONEnterpriseonadifferentserverso
thatyoucanmanuallycopyolderdatabasefilestothenewcomputer,youcanrun
thistaskontheolderdatabases(i.e.theION_Data,ION_SystemLog,and
ION_Networkdatabases,andarchives)toupgradethemwiththenewschema.

Scheduled Tasks
DatabaseManagerhasanumberofpreconfiguredscheduledtasks.Seethe
followingtablefordetails:

Database

ION database (ION_Data)

Network database (ION_Network)

System Events database (ION_SystemLog)

Scheduled Task

Enabled by Default?

Archive

No

Backup

Yes

Maintenance

Yes

Backup

Yes

Maintenance

Yes

Trim

Yes

Maintenance

Yes

Scheduled Maintenance
Thescheduleforthemaintenancetasksisfixed.However,youcanchoosetoview
thehistoryforamaintenancetask:rightclickthetaskandselectViewtask
history....Thisallowsyoutoseethelastrundate,status(successfulorfailed),and
duration,fortroubleshootingpurposes.
Thereareanumberoftasksperformedonthedatabasewhenamaintenancejobis
executed.Thefollowingisanorderedbreakdownofascheduledmaintenance:

2007 Schneider Electric. All rights reserved.

1.

Checkdatabasefragmentationanddefragmentifthefragmentationlevelis
morethan10%.

2.

Updatestatisticsforallthetablesinthedatabase.

3.

Checkandtrackthedatabasesize.

4.

Sendanemailalertifanymaintenancestepfails.

Page 303

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Themaintenancescheduleforeachdatabaseisasfollows:
ION_Datamaintenancejoboccursdailyat2:00AM.
ION_SystemLogmaintenancejoboccursdailyat7:05AM.
ION_Networkmaintenancejoboccursdailyat7:30AM.
(Notethatthediskusagemonitorstartsat7:00AM,takingonlyafewsecondsto
complete.)

Scheduled Archive
ThedefaultsettingsforthescheduledarchivethatisperformedontheION_Data
databaseareshownbelow:

You must select this

checkbox to enable
the scheduled archive.

Data Types
Ascheduledarchiveispreconfiguredtoarchivealldatatypesandtotrimeachof
thedatatypesafterthearchivecompletesallcheckboxesareselected.Clearthe
Trimafterarchivecheckboxforadatatypeifyouonlywanttoperformanarchive
withoutsubsequentlydeletingthatdata.

CAUTION
Trimming data permanently removes it from the database. Trimming without archiving is not
recommended for data records.

Amount of Live Data

Thissettingdeterminesthenumberofcompletemonthsoflivedatathatyouwant
keptintheIONdatabase.

Page 304

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Archive Interval
ForSQLServer2005Express:ClickSelectMonths,thenspecifythemonthsfor
whichyouwantthearchivetooccur.
ForSQLServer2005(StandardEdition),SQL2000,orMSDE:Selectoneofthe
followingoptions:
Monthly
Bimonthly(every2months)
Quarterly
Semiannually
Annually
Every2years
Every3years
Every4years
Every5years

NOTE
The Database Manager scheduled jobs uses the current year and month in the archive file name. If you
use SQL Server Manager Studio or SQL Server Enterprise Manager to schedule the database archives,
do not set the archive frequency to more than once a month to prevent failures.

Schedule
Youcanselectanydayoftheweekforyourscheduledarchive(thedefaultis
Saturday).Thearchiveisperformedatthespecifiedtimeonthefirstoccurenceof
thatdayinthemonth.Forexample,ifyouconfigurethescheduledarchiveto
performmonthlyonSundayat5:30:00AM,thenDatabaseManagerarchivesthe
IONdatabaseat5:30AMonthefirstSundayofeverymonth.

NOTE
When ION Enterprise is first installed, Scheduled Archive is disabled by default. You must select the
Schedule Enabled checkbox to enable it.

Scheduled Trim
Thedefaultsettingsforthescheduledtrimareshownbelow:

2007 Schneider Electric. All rights reserved.

Page 305

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

TheSystemEventsdatabasehasthescheduledtrimtaskconfiguredandenabled
bydefault.
Schedule
ClicktheChangebuttonandtheEditScheduledialogappearswhereyoucan
reconfiguretheoccurrenceandtime(notshown)ofthescheduledtrim.
TheEditScheduledialogdiffersaccordingtotheoccurrenceyouchoose.

NotethatifyouchooseaWeeklyoccurrence,youcanselectmultipledaystohave
thetrimtaskperformed.

Scheduled Backup
Thefollowingdialogsillustratethedefaultsettingsforbothscheduledbackups.

BoththeIONdatabaseandtheNetworkdatabasehavescheduledbackuptasks
configuredandenabledbydefault.Thesavelocationisadifferentfolderforeach
database,althoughbothdatabasessharethesameparentdirectory:\ION
Enterprise\config\cfg\DBBackups\.
Specifythenumberofbackupsrangingfrom1to4thatDatabaseManager
keepsavailable.

Page 306

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Scheduled
ClicktheChangebuttonandtheEditScheduledialogappearswhereyoucan
reconfiguretheoccurrenceandtimeofthescheduledbackup:

TheEditScheduledialogforascheduledbackuphasthesameselectionsasthe
EditScheduledialogforscheduledtrims(seeScheduledTrimonpage 305).

Detaching then Re-attaching Databases

Thefollowingprocedureexplainshowtodetachaconnecteddatabaseandthenre
attachanewdatabaseinitsplace.
Detaching and reattaching a database
1.

OpentheMicrosoftWindowsServicesapplication.

2.

StopalltheIONEnterpriseservicesthatarerunning.KeeptheServiceswindow
open.

3.

StartDatabaseManager,thenselectDatabasesintheleftpane.Iconsforthe
ManualTasksappearintherightpane.

4.

ClicktheDetach...icon.ThisopenstheDetachDatabasedialog.

5.

Selectthedatabaseyouwanttodetachusingthelistbox,ensuringthereareno
connectionstothedatabase,andclickOK.ClickOKonthemessagebox.

6.

ClicktheAttach...iconintherightpaneofDatabaseManager.Thisopensthe
AttachDatabasedialog.

7.

Specifythepathandnameofthedatabaseyouwanttoattachbyclickingthe
buttonnexttotheDatabasetoattachfield.YoucanedittheAttachasfieldwith
yourownnameoryoucanacceptthedefaultname.ClickOK.

8.

GobacktotheServiceswindow.RestartalltheIONEnterpriseservices.

Attaching a Database Using Database Manager

IfyouareattachingadatabasetotheIONEnterprisesystemviaDatabase
Manager,youmustkeepallIONEnterpriseservicesrunning.Thisdiffersfromthe
Detach/AttachproceduredescribedinDetachingthenReattachingDatabases,
above.

2007 Schneider Electric. All rights reserved.

Page 307

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Attaching a Database Using Database Manager

1.

StartDatabaseManager,thenclickDatabasesintheleftpane.Iconsforthe
ManualTasksappearintherightpane.

2.

ClicktheAttach...icon.ThisopenstheAttachDatabasedialog.

3.

Specifythepathandnameofthedatabaseyouwanttoattachbyclickingthe
buttonnexttotheDatabasetoattachfield.YoucanedittheAttachasfieldwith
yourownnameoryoucanacceptthedefaultname.ClickOK.Thefollowing
messageboxappearswhenthetaskissuccessful:

4.

ClickOK.

Restoring an ION Database from a Backup

Thesimplestmethodforrestoringthedatabasefromabackupisamanualmethod.
Torecoveradatabaseafterafullbackup,thebackupdatabasefilesimplyreplaces
thelostorcorrupteddatabase.
Restoring a database using Database Manager
1.

StarttheMicrosoftWindowsServicesapplication.

2.

StopalltheIONEnterpriseservices.KeeptheServiceswindowopen.

3.

StartDatabaseManager,thenclickDatabasesintheleftpane.Iconsforthe
ManualTasksappearintherightpane.

4.

ClicktheRestore...icon.ThisopenstheRestoreDatabasedialog.

5.

SelecttheappropriatedatabasetorestorefromtheRestorefromfield.Editthe
Restoreasfield.

6.

GobacktotheServiceswindowandrestartalltheIONEnterpriseservices.

NOTE
There are blank database and transaction log backup files available in the event of a complete database
loss or corruption. They are located in the ...\ION Enterprise\system\etc\ directory. The task in Database
Manager called New ION Database uses these files.

Page 308

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Accessing the ION Database with 3rd-Party Applications

ThefollowingexampleusesMicrosoftExceltoretrievedatafromtheION
database.

NOTE
The database uses Universal Coordinated Time (UTC) time. When you import data into Excel, the meters
Clock modules Time Zone Offset register is applied.

1.

InordertocreateadatabasequeryinExcel,clickData>ImportExternalData
>NewDatabaseQuery.

2.

LocatetheIONDatabasedatasourcenamefromthelistofavailabledatabases.
ChooseOKthenprovidethefollowingdatabaseUserIDandPassword.
UserID:Report
Password:reporter!(SQLServer2005)orreport(SQLServer2000)

2007 Schneider Electric. All rights reserved.

3.

Scrolldownthelistofavailablelabelsandcolumnsuntilthepredefinedcustom
viewnameappears.

4.

Selectthenameandclicktherightarrow.Alistofallthecolumnsinthecustom
viewareshowninthedialogboxbelow.

Page 309

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

5.

Onceyouhaveselectedthedatayouwishtoview,twomoredialogboxescanbe
usedtofilterandsortthedatathatisreturnedtoExcelfromthedatabase.When
doneselectFinish.

6.

ThelaststepaskswheretoplacethedataontheExcelspreadsheet.

7.

ClickontheOKbuttonandtheQueryisdone.

Optimizing Database Query Time

Therearestepsyoucantaketooptimizethedatabasequerytime.
UseDatabaseManagertodefragmenttheappropriatedatabase.
UseDatabaseManagertoUpdateStatisticsontheappropriatedatabase.

NOTE
Instructions on how to perform the Defragment and Update Statistics operations can be found in the
section Manual Tasks on page 295.

Page 310

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

RunonlyoneinstanceofSQLServer2005.
RunSQLServer2005StandardEditioninsteadofSQLServer2005Express
Edition.

Limiting SQL Server Memory Usage

Bydefault,SQLServer2005StandardEditionandSQLServer2005ExpressEdition
areconfiguredtodynamicallyadjusttheamountofmemoryusedbasedon
demand.
Undersomecircumstances,itispossibleforSQLServertouseupmemorytoa
pointwheretheoverallsystemperformanceisaffected.Youcanadjustthe
amountofmemoryreservedbyusingaconfigurationtoolsuchasSQLServer
EnterpriseManagerorMicrosoftSQLServerManagementStudioExpress.
Using SQL Server Enterprise Manager to Limit Memory Usage
1.

SelecttheSQLServerinstanceforwhichyouwanttochangememoryuse.

2.

ClickTools>SQLServerConfigurationProperties....

3.

ClicktheMemorytab.MovetheMaximum(MB)sliderrighttoincreasethe
maximumamountofRAMtoreserveforSQLServeruse,orlefttodecrease.
ClickOK.

Using SQL Server 2005 Management Studio Express to Limit Memory Usage

2007 Schneider Electric. All rights reserved.

1.

OntheObjectExplorerpane,rightclicktheSQLServerinstancethat
correspondstotheIONEnterprisedatabase(i.e.thedatabaseiconattheroot
levelofthetreeview),thenselectProperties.

2.

IntheSelectapagesection,selectMemory.

3.

UsethecontrolsontheMemorypagetoadjustthememoryallocation.

Page 311

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

4.

ClickOK.

Alternatively,youcanuseManagementConsoletoenteraSQLcommandtolimit
theamountofmemoryusedbySQLServer/MSDE:

CAUTION
Entering SQL commands in ION Enterprise should only be performed by advanced users who understand
the SQL language. Certain syntax errors could damage the system.

1.

InManagementConsole,holddowntheCTRLkeywhileyourightclickthe
titlebartodisplaytheshortcutcommands.ClickCustomSQL.

2.

ClickOKonthewarningprompt,thentypethefollowingSQLcommandinthe
CustomSQLbox.Inthisexample,thevalue250setsthemaximummemoryto
250MBforSQLServeruse:
USEmaster
EXECsp_configureshowadvancedoption,1
RECONFIGURE
EXECsp_configuremaxservermemory(MB),250
RECONFIGURE

3.

Page 312

ClickExecute.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Log Inserter
TheLogInsertercomponentofIONEnterprisecollectsdatafromIONdevicesand
buildsthatdataintothedatabase.Bydefault,LogInserterautomatically
configuresitselftocollectdatafromeveryavailablerecorderineveryIONdevice
orIONsoftwarecomponentandinputsthisdataintothedatabase.
LogInserteristypicallyrunonlyonthePrimaryworkstation.Mostsystemsuse
onlyasingleLogInserter,andIONEnterpriseautomaticallyconfiguresitto
performallrequiredloggingfunctions.IfyouneedtomodifytheLogInserters
operation,familiarizeyourselfwiththedifferentmodesofoperationandthe
functionsoftheinternalcomponentsfirst.

Log Inserter Components

TheLogInserteriscomposedofseveralcomponentsthatinteractwithother
informationsystemcomponents.Understandingtheprimaryfunctionsofthe
mainLogInsertercomponentshelpsyoudecidehowtoconfiguretheloggingin
yoursystem.
AtypicalLogInserterinstallationincludesthefollowingIONmodules:
FactorymoduleletsyouviewyourLogInsertersrevisioninformation,serial
numberandcomplianceinformation.
LogAcquisitionmodulestoresandretrievesindividualdata,eventand
waveformlogstoandfromthedatabase.
SystemLogControllermoduleconvertsallsystemeventsloggedbyION
softwareapplicationsintoanIONcompatibleformatthatisstoredinthe
database.

NOTE
For more information on these modules, see the ION Reference.

Log Acquisition Module Function

TheLogAcquisitionmodulecollectslogsfromthedevicesandtheVirtualProcessor
andinsertsthelogsintotheIONdatabase.AnExternalBooleanmodulecanbe
createdinDesignerandlinkedtotheLogAcquisitionmoduleinordertoprovide
operatorcontrolformanuallyenablinganddisablinglogacquisition.

2007 Schneider Electric. All rights reserved.

Page 313

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Data, Waveform and Event

Logs from power meters and
Virtual Processors
Log Acquisition
Module

External Boolean
Module

External Boolean module provides

optional ON/OFF control of logging

Database

System Log Controller Module Function

TheSystemLogControllermodulecollectssystemeventsfromthesystemlog
databaseandcompilesasystemeventlog.Systemeventsarethosegeneratedby
applications,notbythepowersystem.Aswithallotherlogregisters,theSystem
LogControllersoutputisconnectedtoaLogAcquisitionmoduleforinsertioninto
thedatabase.
System Event
data
System Log
Controller
Module

ION Enterprise
Workstation

External Boolean
Module

Log Acquisition
Module

External Boolean module provides

optional ON/OFF control of logging

Database

Onlysystemeventswithaprioritygreaterthanorequalto192aretransferredinto
theIONdatabase.Thiscutoffissetto192bydefault.

External Boolean Module Function

AddExternalBooleanmodulesandlinkthemtotheEnableinputsoftheLog
Acquisitionmodules.Thisletsyouenableordisableloggingviaacontrolobject
withinVista.

Configuring the Log Inserter

TheLogInsertercontrolstheflowofdataintothedatabase;itinitiatesandcontrols
datacollectionandorganizesdatastorage.YoucanconfiguretheLogInserter
yourself,oryoucanlettheLogInserterperformandmaintainitsconfigurationfor
you.TheLogInsertersAutoModeprovidesautomaticconfigurationofallofthe
requiredlinksbetweenthedatabaseanddevicelogregistersandsystemevent
logs.WheninAutoMode,theLogInserterautomaticallyreconfiguresitselfwhen
nodesorworkstationsareaddedorremovedfromyoursystem.AutoModeis
recommended,providedyoursystemdoesnotincludealargenumberoflogging
devices.
YoucanmanuallyconfiguretheLogInserterusingIONEnterprisetocreateeach
linkbetweendevicerecordersandthedatabase.Manualconfigurationisrequired

Page 314

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

ifyouhaveaverylargesystemorifyouusemultipleLogInserters.Manual
configurationalsoprovidesincreasedcontroloverloggingfunctions.

Log Inserter Auto-Mode

TheLogInserterserviceisconfiguredforAutoModebydefaultwhenION
Enterpriseisinstalled.ThefirsttimetheLogInserterrunsinAutoMode,it
automaticallyconfiguressystemeventloggingforyou:linksthatexistbetweenlog
registersandLogAcquisitionmodulesareignored.Allnodesandworkstationsin
yournetworkareincludedintheLogInsertersconfiguration.

NOTE
Auto-Mode functions only in systems with a single Log Inserter. If you upgraded a large system that
included multiple Log Inserters, and you want to reconfigure your system to include only one Log Inserter,
you may have to configure the Log Inserter to run in Auto-Mode.

LogInsertercontinuallymonitorsthenetwork.Whennewdevicesareaddedto
yoursystem,LogInserterrecognizesthenewlogregisters.Theselogregistersare
automaticallyreadanduploadedforinsertionintothedatabase.AslongasLog
InserterremainsinAutoMode,allsystemeventlogsarewrittentothedatabase.

CAUTION
Auto-Mode should only be deactivated when manual configuration is absolutely necessary.

IfyourestarttheLogInserterwithouttheaswitch(seethenexttopic,Turning
OnLogInsertersAutoMode),allSystemLogcontrollermodulesmustbe
manuallylinkedtoLogAcquisitionmodulesforsystemeventloggingtoresume.
WhenmanuallylinkingLogAcquisitionmodules,usetheFastLinkoptionto
selecttheeventrecordersfromalltheavailablenodes.ThisensuresthatnoEvent
Recordersaremissed.FastLinkcanbeaccessedbypressingandholdingtheCTRL
keywhileclickingtheInputtotheLogAcquisitionModule.
Createandmaintainarecordofthedatasourcespickedfromeachdevice.Keepin
mindthatanynewrecorderaddedtothesystemmustbemanuallylinkedinorder
tologitsdatainthedatabase.
Turning On Log Inserters Auto-Mode
ToactivateAutoMode,modifytheLogInsertersstartupcommandline
parameterstousetheaattribute.

2007 Schneider Electric. All rights reserved.

1.

StoptheLogInserterservice.

2.

Openacommandpromptandchangetothe...\IONEnterprise\system\bin
directory.

3.

Executethecommandlogsrv.exeunregserver.

4.

Executelogsrv.exeserviceatoactivateAutoMode.

5.

RestarttheLogInserterservice.

Page 315

Chapter 9 - Database Management

ION Enterprise 5.6 User Guide

Turning Off Log Inserters Auto-Mode

TodeactivateAutoMode,modifytheLogInsertersstartupcommandline
parameterstoremovetheaattribute.ThisturnsoffAutoModeandmakesthe
LogInsertermanuallyconfigurable.YoushouldonlydeactivateAutoMode
whenmanualconfigurationisabsolutelynecessary.

CAUTION
If you used the Microsoft Windows Services application to stop the ION Log Inserter Service, you must
close the Services window before unregistering and re-registering the service. If you do not do so, an error
message appears indicating that the Log Inserter is marked for deletion.

1.

StoptheLogInserterservice.

2.

Openacommandpromptandchangetothe...\IONEnterprise\system\bin
directory.

3.

Executethecommandlogsrv.exeunregserver.

4.

Executelogsrv.exeservicetodeactivateAutoMode.

5.

RestarttheLogInserterservice.

Oncerestarted,theLogInsertercanthenbecustomizedusingDesigner.
Customizing Log Inserter to record only manually linked data
TocustomizeLogInsertertorecordonlymanuallylinkeddata,settheLogSource
setupregisterfromALLtoINPUTLOGS.Then,manuallylinktherelevantrecorders
fromthedevicesthatyoupreviouslyidentifiedasrequiredtotheLogAcquisition
module.
How to start Log Inserter in a Mode where only new records are uploaded
Ifanewsystem(ornewdatabase)isstartedandnopreexistingdatafromthe
metersisrequired,usetheqquickstartLogInsertercommandlineargument.
Whenstartedwithqasanargument,theLogInserterwilluploadrecordswitha
timestampgreaterthanNOW(i.e.thecurrenttimewhenLogInserterwasstarted).
Thiscanmakethestartupprocessmuchfasterifmetershavealreadystoredmany
records.
ToputtheLogInserterinquickstartmode:
1.

UnregistertheLogInserterservice(logsrvunregserverinacommand
prompt).

2.

Reregistertheservicewiththeqargument(logsrvServiceqa).Notethat
theaalsoturnsonAutoMode.

CAUTION
Once the system is caught up, be sure to shut down the ION Log Inserter Service, unregister it, and then
re-register it without the -q. If you fail to do this, on every subsequent restart, the Log Inserter will only
upload new data.

Page 316

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 9 - Database Management

Optimizing Log Inserter

Increasing Log Retrieval Capacity
TheLogInserterretrievesrecordsfromthedeviceusingoneshotprograms.Ina
systemwithaheavyloggingburden,thefollowingchangescanbemadeto
improverecordretrievalbytheLogInserter.
1.

InManagementConsole,settheUpdatePeriodforeachdevicefrom500 ms
(default)to10000ms.Thissettingspecifiesthefrequencyatwhichdata
collectedbyapolledprogramisretrievedfromthedevice.

NOTE
Increasing the time period for polled programs gives Log Inserter more opportunity to send out one-shot
programs.

2.

CreateaDWORDregistryvaluecalledOneshotRatiounderthe
HKEY_LOCAL_MACHINE\SOFTWARE\SchneiderElectric\ION
Enterprise\5.6key.

3.

SettheOneshotRatiovalueto20.Thisnumberdefinesthenumberofoneshot
programsthatareprocessedforeachpolledprogram.IftheOneshotRatiovalue
doesnotexistintheWindowsRegistry,thedefaultvalueis4.

Increasinglogretrievalcapacityisusefulduringfirsttimesystemstartup,
especiallyifalargebacklogofrecordsmustberetrieved.

Improving System Performance By Changing Siteserver

Thread Pool Size
Forasystemconsistingofmanysimultaneouslyconnectedsites,communications
performanceislessthanoptimal.Forexample,updatesinVistamaybeinfrequent
whentheLogInserterisrunning.
ThesiteservprocessusestwopoolsofthreadstoservicethesitesdefinedinanION
Enterprisenetwork:onepoolforconnectedsitesandonepoolfordisconnected
sites.Thethreadpoolforconnectedsiteshasadefaultmaximumsizeofsixteen.In
asitewithalargenumberofcontinuouslyconnectsites,systemperformancecan
beimprovedbyincreasingthisthreadpoolsize.
Tochangethesizeofthethreadpoolavailabletoconnectedsites:
1.

UndertheHKEY_LOCAL_MACHINE\Software\SchneiderElectric\ION
Enterprise\5.6registrykey,createanewRegistryDWORDvaluecalled
ConnectedThreadPoolSize.

2.

Assignthekeyadecimalnumbervalueof50.

YoudonotneedtorestartLogInsertertodetectthischange.Thenewvalueis
detectedimmediately.

2007 Schneider Electric. All rights reserved.

Page 317

Chapter 9 - Database Management

Page 318

ION Enterprise 5.6 User Guide

2007 Schneider Electric. All rights reserved.

10

Alert Monitor Service

TheIONAlertMonitorServicereceivesandprocessesalarmnotificationscoming
frommodemconnectedmetersonremotepowermonitoringlocations.

In This Chapter
Alert Monitor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
HowItWorks................................................... 320
SettingUptheAlertMonitorService................................... 321
ConfigurationFileComponents.................................... 322
MultiStationSetup .............................................. 324
Diagnostics ..................................................... 324
StartingtheAlertMonitorService...................................... 324

2007 Schneider Electric. All rights reserved.

Page 319

Chapter 10 - Alert Monitor Service

ION Enterprise 5.6 User Guide

Alert Monitor Service

AlertMonitorisanewWindowsservice(IONAlertMonitorService)that
replacestheAlarmServerprogramfrompreviousIONEnterpriseversions(the
legacyalarmsrv.exeprogramisstillfunctionalandavailableinthe...\system\bin
folder).
AlertMonitorresidesontheIONEnterpriseworkstation,whereitreceivesand
processesincomingalarmsfromaremoteIONmetersAlertmodule.

WiththeimplementationoftheAlertMonitorservice,alarmnotificationis
improvedandsimplified:
SinceAlertMonitorrunsasaWindowsservice,auserisnolongerrequiredto
logintoIONEnterpriseinordertostartmonitoringthesystemforalarm
conditions.
AlertMonitorcanhandleincomingcallsfrommultiplecommunicationsports.
Whenalarmsarereceived,AlertMonitorusestheIONConnectionManagement
Servicetoestablishamodemconnection,ratherthanusingthelegacycommand
lineexecutable,conman.exe.
IONConnectionManagementServiceallowsyoutosetupspecificmodem
connectionrequestproperties,suchasMinimum/MaximumConnectionTime,
DisconnectonCaughtup,etc.ThesepropertiesaresetupintheAlertMonitors
configurationfileseeSettingUptheAlertMonitorServiceonpage 321.

NOTE
Alert Monitor does not support TAPI modem drivers for Windows (WinModems).

How It Works
TheAlertMonitorservicerespondstoalarmmessagesoriginatingfromtheAlert
moduleintheIONmeter.Forexample,analarmmessageisinitiatedasaresultof
apowerqualityevent:

Page 320

1.

AnalarmconditionpromptstheIONmodule(e.g.Setpointmodule)tosenda
pulsesignaltotheTriggerinputoftheIONmetersAlertmodule.Referto
AlertModuleintheIONReferenceformoreinformation.

2.

TheAlertmoduleinitiatesmodemcommunication,andcallsthephonenumber
specifiedintheAlertmodulesDestinationsetupregister.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 10 - Alert Monitor Service

3.

TheIONEnterprisestationanswersthemodemcallfromtheIONmeterand
completesthecommunicationconnection.Themeterthensendsthefollowing
informationtoIONEnterprise:atimestampindicatingwhenthealarm
conditionoccurred,thenodename,andthemessage(i.e.contentsoftheAlert
modulesMessagesetupregister).

4.

AlertMonitorreceivesthealarmdataandplacesitinthequeueforprocessing.
Whenthealarmisprocessed,thecommandsspecifiedintheCOMport
configurationsettingsareexecuted.Atthesametime,aconnectionrequestis
senttothenodespecifiedinthealarmdata.

5.

Thenewconnectionrequestisreceivedandplacedinthequeue.Ifother
connectionrequeststothesamesitealreadyexist,thenewrequestismerged
withtheothers.

6.

IONConnectionManagementServiceestablishesaconnectiontothemeterthat
originatedthealarm,thenLogInserterdownloadsalloutstandingeventand
datalogs.

NOTE
ION Connection Management Service uses a modem (from the modem pool) to establish connection to
the remote site.

7.

IONConnectionManagementServicedisconnectsaftertheIONLogInserter
Servicehasfinisheddownloadingalloutstandinglogs.Whenthishasbeen
completed,thestatusofthesiteisconsideredCaughtup.

Setting Up the Alert Monitor Service

NOTE
This section is intended for advanced users. Contact Engineering Services if you need assistance.

TheconfigurationsettingsforAlertMonitorarestoredinaconfigfilethatfollows
thefilenameconvention{MachineName}.AlertMonitor.config.Anexample
configfilewiththisnameisprovidedinthe
...\IONEnterprise\config\AlertMonitorfolder.AnXMLschemafilenamed
AlertMonitorSchema.xmlisalsoprovidedinthesamefolder,foryour
reference.YoucanusethisschematovalidatetheconfigfileusingavailableXML
validationtools.
UseatexteditororXMLauthoringtooltocreateandedittheconfigurationfile.
Remembertorenametheconfigfiletomatchthemachinename(e.g.iftheprimary
serverisnamedComputerOne,renametheconfigfileto
ComputerOne.AlertMonitor.config).

2007 Schneider Electric. All rights reserved.

Page 321

Chapter 10 - Alert Monitor Service

ION Enterprise 5.6 User Guide

Configuration File Components

ChannelsdefinethecommunicationportandmodemthattheAlertMonitoruses,
whileActionsdefinethecommandstobecarriedoutinresponsetoanalarm.
AChannelcontainsthemodemdefinitionandconfigurationsettingsfortheport.
ThefollowingtableliststheattributesyoucanassignforaChannel:

Channel attribute

Description

Name

Name of the comm port the modem is connected to. Default value is
COM1.

ModemType

The type of modem. The value entered here must exactly match the
displayed value under Modem Type property in the Dial Out Modem
Options dialog.

BaudRate

The modems baud rate. Default value is 9600.

AlertMonitorNodeName

The node name, as it appears in the system log messages. The text
specified here defines the value for the %a command parameter
(described below). Default value is AlertMonitor.[ComputerName]

NoLog

This controls whether all alarms are logged to the ION Enterprise system
log. Default value is YES (log all alarms). A value of NO disables all
alarm logging.

NumTries

This specifies how many times a connection attempt should be retried if

there are communication errors.

TIP
Open the example file {MachineName}.AlertMonitor.config in a text editor program and refer to it
when reading this section to see the proper usage of the elements and attributes in the ION Alert Monitor
configuration file.

ActionsaregroupedinsideActionSetelements,whichcontainconnection
requestsand/orcommandstoexecutewhenalarmsarereceived.Specify
ConnectionRequesttosetupanActionSettosendaconnectionrequest;specify
CommandtosetupanActionSettoexecuteanoperatingsystemcommand
whenthealertisreceived.YoucanspecifyattributestoActionSets:
IftheChannelattributeisusedintheActionSet(forexample,<ActionSet
Channel=COM1>),thentheactions(commands)listedintheActionSetare
executedforallalarmscomingthroughthecommunicationsportandmodem
specifiedforthatChannel(i.e.COM1).
IftheLocationattributeisusedintheActionSet,thentheactions(commands)
listedintheActionSetareexecutedforallalarmsoriginatingfromthespecified
Location(regardlessofChannel).
Ifnoattributeisspecified,thentheactions(commands)listedintheActionSet
areexecutedforallalarmsoriginatingfromanycommunicationportorlocation.
IftherearetwoActionSets:onespecifyingaChannelattribute,andtheother
specifyingLocationattribute,thentheonethatspecifiestheLocationattribute
takespriority.

Page 322

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 10 - Alert Monitor Service

NOTE
The value of the Location attribute is specified in the Location setup register of the Alert module for the
meter that is sending the alert. For details, refer to Alert Module description in the ION Reference.

Commands(i.e.commandlinesthatrunseparateapplicationssuchasnetsend)
containedintheActionSetcanincludeparametersthatreturndatavalues,as
describedinthefollowingtable:
Command Parameter

Description

%U

Universal time: seconds since January 1, 1970

%u

Universal time: YYYY-MM-DD HH:MM:SS.FFF

%T

Local time: seconds since January 1, 1970

%t

Local time: YYYY-MM-DD HH:MM:SS.FFF

%n

Node name (e.g. device name)

%g

Gate name (e.g. site name)

%p

Priority name

%P

Priority number

%m

Alarm message without delimiters

%M

Alarm message with delimiters

%a

The value of the AlertMonitorNodeName attribute. If this attribute is not

used, the default value is AlertMonitor.[ComputerName].

TheConnectionRequestelementcontainedintheActionSethasattributesthat
youcandefine,asdescribedinthefollowingtable:

2007 Schneider Electric. All rights reserved.

ConnectionRequest Attribute

Description

MaxConnectTimeSeconds

Maximum time (in seconds) a connection to the site is maintained.

Default value is 300 seconds.

MinConnectTimeSeconds

Minimum time (in seconds) a connection to the site is maintained.

Default value is 60 seconds.

RequestLifetimeHours

Defines how many hours a connection request remains valid,

before it is discarded (even if attempts to connect to the site fail).
Default value is 0.

RequestPriority

Priority of the connection request, which range from 0 to 2000.

Highest priority is 2000. The default value is 1999.

DisconnectOnCaughtUp

This specifies to automatically disconnect from the site after Log

Inserter has finished downloading all outstanding logs, including
event and data logs. Default value is No.

Device

This explicitly defines which specific device to connect to in the site.

This attribute overrides data contained in the alarm message.

Site

This explicitly defines which site to connect to. This attribute

overrides data contained in the alarm message.

Page 323

Chapter 10 - Alert Monitor Service

ION Enterprise 5.6 User Guide

Multi-Station Setup
ItispossibletoruntheAlertMonitorserviceonmorethanonemachineintheION
Enterprisesystem.However,theconfigurationfilesmustbestoredintheprimary
server,followingtheconventionComputerName.AlertMonitor.config.
Forexample,theAlertMonitorrunningonasecondaryservernamed
ComputerTwousestheconfigurationfilenamed
ComputerTwo.AlertMonitor.configlocatedintheprimaryserver.

Diagnostics
DiagnosticanderrormessagesareloggedintheIONEnterprisesystemlog,with
sourceAlertMonitor.

Starting the Alert Monitor Service

Bydefault,theAlertMonitorserviceisstopped,andsettoManualstartuptype.
ToautomaticallystartAlertMonitoronWindowsstartup,changethestartup
propertiesofthisWindowsservicetoAutomatic,thenstarttheservice.Referto
yourWindowsdocumentationfordetails.

Page 324

2007 Schneider Electric. All rights reserved.

11

Downstream Device Assistant

DownstreamDeviceAssistantletsyoumanagedownstreamdevices.Withthis
tool,youcanrenamedownstreamsources,changewhichmeasurementis
associatedwithspecificdatafromasource,andapplythesechangestopreviously
recordeddatainION_Data(historicaldatabase).Youcanalsodisplayand
manageallthephysicalsources(devices)inyournetwork.
DownstreamDeviceAssistantisintendedfor,andshouldonlybeusedby,ION
Enterpriseuserswithadvancedtechnicalskillsandaclearunderstandingofhow
dataisinterpretedandstoredintheIONdatabase.

In This Chapter
Detecting Downstream Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Downstream Device Assistant Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
StartingtheDownstreamDeviceAssistant.............................. 327
BasicView .......................................................... 327
AdvancedView..................................................... 328
DisplayingPhysicalSources........................................... 329
SortingData ........................................................ 329
Options ............................................................ 329
Downstream Device Assistant Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 332
RenamingtheAssignedSource ........................................ 332
CancellingChanges .................................................. 333
ChangingtheMeasurementMapping.................................. 333
AddingaNewDownstreamDeviceMapping........................... 334
UpdatingtheHistoricalDataataLaterTime............................ 334
ActivityLog ........................................................ 335
Description of Columns and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 335
DownstreamDeviceAssistantColumns ................................ 336
DownstreamDeviceAssistantCommands.............................. 338

2007 Schneider Electric. All rights reserved.

Page 325

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

Detecting Downstream Devices

Adownstreamdeviceisonewhosedataisloggedbyaremotedatarecorder,for
example:
AModbusslavedevicewhoseoutputregistersarebeingloggedbyanION
devicewithModbusMasteringcapability(seeillustrationbelow).
AModbusdevicewhoseoutputsareloggedbytheVirtualProcessor.
Anyofvariousmultiplesourcesinwhichthesamemeasurementisbeing
loggedonasingledevice,e.g.anRTUthatiscollectingkWhpulsesfrom
multiplesources,orasingleBranchCircuitMonitorthatiscollectingcurrent
readingsonmultiplecircuits.
Data Recorder

ION Enterprise server

Physical Source
(Modbus Master)
Downstream Devices
(Modbus Slaves)

IONEnterpriseautomaticallydetectsdownstreamdevices.TheLogInserter
componentdoesthisbylookingfordevices(calledphysicalsources)thatrecord
orhostdatacomingfromvariousdownstreamdevices(forexample,anIONmeter
thatutilizesaModbusImportmoduletopassthroughdataoriginatingfroma
downstreamModbusdevice).
LogInserterresolvesthedatafromeachofthesedownstreamdevicestothe
appropriatemeasurement(forexample,thelabelVllabresolvestothe
measurementVoltagePhasesAB).Fordatathatcannotberesolved,Log
InsertercreatesmeasurementswhosenamesarebasedontheIONregisterlabels.
LogInserterusesalogicalnamingschemetoassignnamestothedownstream
devices.Forexample,Modbus.34isthenameassignedtothedownstream
Modbusdevicewithaslaveaddress34.

Page 326

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 11 - Downstream Device Assistant

Downstream Device Assistant Basics

UseDownstreamDeviceAssistanttoeditthenamesassignedtodownstream
devices,ortoassignthecorrectmeasurementlabelforaregisterthathasan
incorrectmeasurementmapping.
IMPORTANT:BeforeusingtheDownstreamDeviceAssistant,makesureyou
saveacopyoftheION_NetworkandION_Datadatabases,incaseyouneedto
reverttotheoriginalconfigurationofthesedatabases.

Starting the Downstream Device Assistant

1.

RuntheprogramnamedDownstreamDevices.DownstreamAssistant.exein
the...\IONEnterprise\system\binfolder.

2.

LoginusingyourIONEnterprisecredentials.
Amessagedisplays,remindingyoutobackupyourION_Networkand
ION_Datadatabases.ClickOKtocontinue.

3.

DownstreamDeviceAssistantopensinBasicvieworAdvancedview,
dependingonthelastviewitwasinbeforeitwasclosed.Ifthisisthefirsttime
DownstreamDeviceAssistantisstarted,itopensinBasicview.

Basic View
ToswitchtoBasicview,clickView>Options...IntheAdvancedsection,clearthe
enableadvancedfeaturescheckbox.ClickOK.

InBasicview,whenyouenteranewnameintheUpdatedAssignedSource
column,allrowsthatcontainthesameAssignedSourcenameareautomatically
filledinwiththenew(UpdatedAssignedSource)name.Existingdatainthe
historicaldatabase(ION_Data)isalsoautomaticallyupdatedtoreflectthechange.

2007 Schneider Electric. All rights reserved.

Page 327

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

Advanced View
ToswitchtoAdvancedview,clickView>Options...IntheOptionsdialogbox,
undertheAdvancedsection,selecttheenableadvancedfeaturescheckbox.Click
OK.

InadditiontothecolumnsdisplayedinBasicview,Advancedviewdisplaysallthe
othercolumnsforeditingindividualsourcemeasurementdefinitions(i.e.
UpdatedMeasurement,Handle,EnteredBy,UpdateHistoricalDatabase,and
Manual).InAdvancedview,youcan:
Selectandmakechangestoaspecificrowwithoutaffectingtheotherrows.For
example,youmaywanttochangethesourcenameforoneparticular
measurementwhileleavingtheoriginalsourcenameunchangedforallthe
othermeasurements.
Selectadifferentmeasurementforonethatisincorrectlymappedtoaparticular
registerhandle.
Choosewhetherornottoupdatehistoricaldataforachangedsourcenameor
measurementdefinition,byselectingorclearingtheUpdateHistoricalData
checkbox,respectively.Changinganameordefinitionautomaticallyselects
thischeckbox.
ChoosewhetherornottoallowLogInsertertoresolvetheregisterhandletoa
particularsourcemeasurement,byclearingorselectingtheManualcheckbox,
respectively.Thedefaultsettingiscleared(i.e.LogInserterautomatically
resolvestheregisterhandletothesourcemeasurementdefinition).Ifyouwant
toforcethechangesoLogInserterdoesnotresolvethehandletothenew
measurement,selecttheManualcheckbox.

Page 328

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 11 - Downstream Device Assistant

Displaying Physical Sources

ThedefaultviewforDownstreamDeviceAssistantdisplaysonlythedownstream
devices.Todisplaythephysicalsourcesaswell:
1.

ClickView>SelectPhysicalSources...

2.

Selectthecheckboxbesidethephysicalsourcesyouwanttodisplay.Selectthe
Select/ClearAllcheckboxtochooseallphysicalsources,orclearittochoose
none.ClickOK.

NOTE
The Physical Sources will not be displayed if you restart Downstream Device Assistant. By default, only
downstream devices are displayed when Downstream Device Assistant is started.

Sorting Data
Clickacolumnheadingtosorttherowentriesinascendingordescending
alphanumericorder,accordingtothatcolumn.

Options
ClickView>OptionstodisplaytheOptionsdialogbox:

2007 Schneider Electric. All rights reserved.

Page 329

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

CertainoptionssuchasshowallmeasurementsandtheHandlesdisplay
optionsaredisabledinBasicView.Toenablethem,switchtoAdvancedView
first.

Advanced
TheenableadvancedfeaturescheckboxsetstheviewtoBasicViewifitis
clearedorAdvancedViewifitisselected.

Measurements
SelectdisplayIONlabelstodisplaythedefaultIONlabel(e.g.Vlnavg)inthe
Measurementcolumn,orselectdisplaymeasurementnamestodisplaythefull
descriptivenameofthemeasurement(e.g.AverageVoltageLinetoNeutral).
InAdvancedViewonly,selecttheshowallmeasurementscheckboxtodisplay
allavailablemeasurementsinthelistwhenpickingameasurementintheUpdated
Measurementcolumn.Clearthischeckboxtodisplayonlythemostcommon
measurementsinthelist.

NOTE
In some situations, if "display ION labels" is selected, the displayed label may not match the label on your
meter (for example if a custom label was used). Instead, it will display the known default label for that
particular measurement.

Historical Data
Iftheshowconnectiondialogcheckboxiscleared,theION_Datadatabaseis
automaticallysetastheDefaultConnection(forhistoricaldata).
Ifyouwanttoselectadifferentdatabase,makesuretheshowconnectiondialog
boxisselected.Withthissettingenabled,thedatabaseconnectiondialogboxis
displayedeverytimeyousaveyourchanges.Whenthedialogboxdisplays,select
CustomConnectionandspecifyyourdatabaseconnectiondetails.

Page 330

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 11 - Downstream Device Assistant

Handle
AvailableinAdvancedViewonly,theseoptionssethowregisterhandlesare
displayed.Selectdisplayhexoptiontoshowthehexadecimalvalue(withthe0x
prefix),orselectdisplaydecimaloptiontoshowthedecimalvalueoftheregister
handles.

2007 Schneider Electric. All rights reserved.

Page 331

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

Downstream Device Assistant Functions

ThissectiondescribesdifferentfunctionsyoucanperformusingtheDownstream
DeviceAssistant.

Renaming the Assigned Source

OneoftheprimaryreasonsforusingtheDownstreamDeviceAssistantisto
changethedefaultnameassignedtoadownstreamdevicebytheLogInserter.For
instance,insteadofModbus.34,youmaywanttorenamethatdeviceto
somethingmoremeaningfulsuchasSM_Bldg2_Boiler7.
RenaminganAssignedSourcetypicallyonlyappliestodownstreamdevices.
Tochangethedownstreamdevicenameforallmeasurementsassociatedwiththe
downstreamdevice,makesureyouareinBasicViewbeforeyoumakethe
change.
Toonlychangethedownstreamdevicenameforoneormoreselected
measurements,switchtoAdvancedViewfirstbeforemakingyourchanges.In
AdvancedView,allotherrowsremainunchangedafteryouchangethe
downstreamdevicenameforaparticularmeasurement.
Renaming the assigned source for ALL its measurements
1.

SwitchtoBasicView.

2.

Findthesourceyouwanttorename.EnterthenewnameintheUpdated
AssignedSourcecolumn.Allrowswithmeasurementsassociatedwiththe
renamedsourceareautomaticallyupdated.

3.

ClickFile>Save.

4.

Adialogboxpromptsyouwithasummaryofthechanges.ClickYesto
continue.

NOTE
If you do not want to assign the existing data in the database to the new source name, click No. Switch
to Advanced View first, then clear the Update Historical Database check box for all appropriate rows.

5.

Page 332

Aprogressindicatorprovidesthestatusoftheupdate,thenapromptdisplays
whentheoperationiscompleted.ClickOK,thenClose.

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 11 - Downstream Device Assistant

Renaming the assigned source for one or more measurements

1.

SwitchtoAdvancedView.

2.

Selecttherow(s)youwanttorename.Toselectarow,clicktheareajusttothe
leftofthefirstcolumn.Therowwillbehighlightedtoindicatethatitisselected.
Toselectcontiguousrows,selectthefirstrowyouwanttoupdate,hold
downtheSHIFTkey,thenclickthelastrowyouwanttoupdate.
Toselectnoncontiguousrows,selectthefirstrowyouwanttoupdate,hold
downtheCTRLkey,thenindividuallyclickeachrowyouwanttoupdate.

3.

ClickEdit>RenameSource.

4.

IntheSourceRenamebox,typethenewnameforthedownstreamsource.
ClickOK.

NOTE
By default, the Update Historical Database check box is selected for all affected rows this applies the
change to existing data in the database. To make the change only to data going into the database from
this point forward, clear the Update Historical Database check box for the affected rows.

5.

ClickFile>Save.Adialogboxpromptsyouwithasummaryofthechanges.

6.

ClickYestocontinue.Aprogressindicatorprovidesthestatusoftheupdate.

7.

Whentheoperationhascompleted,clickOK,thenclickClose.

Cancelling Changes
1.

Toundoalltheunsavedchanges:
ClickEdit>Reset,or
ClickView>Refresh

2.

ClickYestoconfirm.

Changing the Measurement Mapping

LogInserterautomaticallyassociatesloggeddatawithameasurementby
searchingforamappingbetweenthelabelandthemeasurement.However,in
caseswherenomappingexists,LogInsertercreatesameasurementthatisbased
ontheregisterlabel.Youcanmanuallychangethismeasurementmapping:
1.

2007 Schneider Electric. All rights reserved.

SwitchtoAdvancedView.

Page 333

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

2.

ClicktheUpdatedMeasurementcellthatyouwanttochange,thenselectthe
newmeasurementyouwanttomapfromthelist.

3.

SelecttheManualcheckbox.

4.

Bydefault,theUpdateHistoricalDatabasecheckboxisselectedthisapplies
thechangetoexistingdatainthedatabase(if,forexamplethesourceand
measurementmappingyouareaddingalreadyexists).Tomakethechangeonly
todatagoingintothedatabasefromthispointforward,cleartheUpdate
HistoricalDatabasecheckbox.

5.

ClickFile>Save.Adialogboxpromptsyouwiththechanges.ClickYes.

6.

Ifprompted,selectwhichdatabasetoupdate.ClickOK.

Adding a New Downstream Device Mapping

Toaddanewaddressmappingthatassociatesthesourceandmeasurementtoa
specificloggedquantityinthedatabase:
1.

Scrolldowntotheendofthetableandclickthelastrow(theonewiththe
asteriskbesideit).

2.

FillintheUpdatedAssignedSourceandPhysicalSourcecolumns.Ifthe
sourceisaphysicaldevice(i.e.notdownstream),thesamenamemustbe
enteredexactlyinbothcolumns.

3.

ClicktheUpdatedMeasurementcell,thenselectthemeasurementfromthelist.

4.

IntheHandlecell,typetheregisterhandleforthismeasurement.

5.

Bydefault,theUpdateHistoricalDatabasecheckboxisselectedthisapplies
thechangetoexistingdatainthedatabase(if,forexamplethesourceand
measurementmappingyouareaddingalreadyexists).Tomakethechangeonly
todatagoingintothedatabasefromthispointforward,cleartheUpdate
HistoricalDatabasecheckbox.

6.

ClickFile>Save.Adialogboxpromptsyouwiththechanges.ClickYes.

7.

Ifprompted,selectwhichdatabasetoupdate.ClickOK.

Updating the Historical Data at a Later Time

WhenyousaveyourchangesusingtheDownstreamDeviceAssistant,arecordof
changestothesourcemeasurementdefinitionsissavedinthefolder:
...\IONEnterprise\config\Diagnostic\DownstreamDeviceAssistant\
withthefilename:
DownstreamDeviceDefinitionsYYYYMMDD_hh.mm.ss.csv,whereYYYY
MMDD_hh.mm.ssmeanscurrentYEARMONTHDAY_hour.minute.second.
IfyouclearedtheUpdateHistoricalDatabasecheckboxwhenyousavedyour
changesthefirsttime,youstillhavetheoptionofupdatingtheexistingdatainthe
databaseatalatertime,throughtheuseofthecsvfile.

Page 334

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 11 - Downstream Device Assistant

How to use the Downstream Device Assistant csv file

Toupdatetheexistingdatainthedatabasewiththesourcemeasurementchanges
containedinthecsvfile:
1.

ClickEdit>HistoricalData.TheUpdateHistoricalDatawindowopens.

2.

ClickFile>ImportCSV...

3.

DownstreamDeviceAssistantopensthefoldercontainingallthecsvfiles.Select
theDownstreamDeviceDefinitionsfileyouwanttouse,thenclickOpen.

4.

ClickFile>UpdateHistoricalData.

5.

TheHistoricalDataUpdatepromptdisplayshowmanysourcemeasurement
pairswillbeupdated.ClickYes.

6.

ClickYesattheHistoricalDataUpdateprompt.

7.

Aftertheoperationhascompleted,clickOK,thenClose.

YoucanupdateonlyoneIONdatabaseatatime.Toselectadifferentdatabase,
firstmakesurethetheshowconnectiondialogcheckboxisselectedunder
View > Options.Youcanthenusethedatabaseconnectiondialogboxtospecify
whichdatabaseyouwanttoupdate.

NOTE
If you update address definitions that affect multiple historical databases, only the first historical database
you select will be automatically updated. To update the remaining historical databases, you must import
the address definitions to each one, using Select Edit > Update Historical Data.

Activity Log
AllsavedchangesintheDownstreamDeviceAssistantarestoredinalogfile
namedDownstreamDeviceHistoricalUpdatesYYYYMMDD_hh.mm.ss.txt,
thatcontainsadescriptionoftheactivitiescarriedoutwhenDownstreamDevice
Assistantwasupdatingthesourcemeasurementdefinitions.

Description of Columns and Commands

Thissectiondescribesthedifferentcolumnsandcommandsavailablein
DownstreamDeviceAssistant.

2007 Schneider Electric. All rights reserved.

Page 335

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

Downstream Device Assistant Columns

ThefirstfivecolumnsoftheDownstreamDeviceAssistant(below)aredisplayed
inbothBasicandAdvancedviews:
IsDownstream
TheIsDownstreamcolumnidentifieswhichdevicesintheAssignedSource
columnaredownstreamdevices.IftheIsDownstreamcheckboxisselected,it
meansthatthedeviceidentifiedintheAssignedSourcecolumnisdownstreamto
aphysicaldevice,whosenameisindicatedinthePhysicalSourcecolumn.A
clearedIsDownstreamcheckboxindicateaphysicalsource.Notealsothata
physicalsourcehasthesameAssignedSourcenameandPhysicalSourcename,
bydefault.

NOTE
Do not change the value of IsDownstream when making changes to source/measurement definitions,
as it is automatically set by the Downstream Device Assistant.

Assigned Source
ThisisthedefaultnamethatLogInserterassignedtoadownstreamorphysical
device.Forexample,Modbus.109:MainFeed.PM7650isthedefaultname
assignedforthedownstreamModbusdevicewithunitID109,whose
measurementsarebeingloggedtoadatarecorderonaModbusMasterdevice
namedPM7650,thatispartoftheMainFeedsite(group).
Updated Assigned Source
ThistextfieldallowsyouchangethecurrentnameunderAssignedSource.
InBasicview,allrowsthatcontainthesameAssignedSourcenameare
automaticallyupdatedtothenewnamewhenyouenteritintheUpdated
AssignedSourcecolumn.
InAdvancedview,youcanselectoneormorerowsandrenamethesourceusing
theUpdatedAssignedSourcecolumn,whileleavingtheotherrowsunchanged.
SeethesectionRenamingtheAssignedSourceonpage 332formoredetails.
Physical Source
Thisidentifiesthenameofthephysicaldevice(e.g.aModbusMasterdeviceorthe
VirtualProcessor)thatisperformingthedataloggingforadownstreamdevice.

NOTE
Do not use the Physical Source column to modify the existing name of a valid physical device, as Log
Inserter uses this name to perform proper data logging.

Measurement
DependingontheView>Optionssetting,thiscolumndisplayseithertheION
label(e.g.Vlnavg)orthedescriptivenameofthemeasurement(e.g.Average
VoltageLinetoNeutral).Tochangethesetting:

Page 336

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6 User Guide

Chapter 11 - Downstream Device Assistant

1.

ClickView>Options.

2.

IntheMeasurementssection,selectdisplayIONlabelstodisplaytheIONlabel
ordisplaymeasurementnamestodisplaythefullnameofthemeasurement.

Thenextsetofcolumns(describedbelow)areavailableonlyinAdvancedview:
Updated Measurement
ThisletsyouredefinewhatiscurrentlyassignedintheMeasurementcolumn.
Clickthecelltodisplaythelistofmeasurementstochoosefrom.Dependingon
theView>Optionssetting,youcanselectfromalistcontainingonlythemost
commonmeasurementdefinitions,orfromacompletelistofallavailable
measurements.Tochangethesetting:
1.

ClickView>Options.

2.

IntheMeasurementssection,selecttheshowallmeasurementscheckboxto
displaythelistcontainingallavailablemeasurements.Todisplaytheshorterlist
thatcontainsonlythemostcommonmeasurements,cleartheshowall
measurementscheckbox.

Handle
Thiscolumndisplaysameasurementsregisterhandleeitherinhexadecimal
formatordecimalformat,dependingontheView>Optionssetting.Tochange
thesetting:
1.

ClickView>Options.

2.

IntheHandlessection,selectdisplayhextodisplaytheregisterhandlein
hexadecimalformatordisplaydecimaltodisplayitindecimalformat.

Ifyouwanttomanuallyresolvearegisterhandletoaspecificmeasurement,edit
thevalueintheHandlecell,thenselecttheManualcheckboxbeforesavingthe
changes.
Entered By
Thisidentifieswhichusermadeachangetothesourcemeasurementdefinition.
Update Historical Database
TheUpdateHistoricalDatabasecheckboxisautomaticallyselectedafterentering
changesintheUpdatedAssignedSourceorUpdatedMeasurementcell.This
meansthatallhistoricaldatabaseentriesthatcontaintheoldAssignedSource
nameorMeasurementwillbeupdatedwiththenewnameormeasurement.
Ifyouwanttoleavetheexistingdatainthedatabaseunchanged,cleartheUpdate
HistoricalDatabasecheckboxbeforesavingthechanges.
Manual
Bydefault,LogInserterautomaticallyassociatesthepropermeasurementtothe
appropriatepieceofdatainthedatalog.Normally,theManualcheckboxshould
remaincleared.However,ifyouwanttospecificallychangethemeasurementor
registerhandleassociatedwithaparticularaddressdefinition,selecttheManual
checkboxforthatmeasurement.ThiswillmanuallyoverrideLogInsertersothat

2007 Schneider Electric. All rights reserved.

Page 337

Chapter 11 - Downstream Device Assistant

ION Enterprise 5.6 User Guide

itusesthisnewaddressmappingfromnowon(i.e.LogInserterwillnotattempt
toresolvethataddresseveragain).

CAUTION
Selecting the Manual check box is not recommended. By doing this, you are reserving the ION register
for which Manual is checked for the measurement you have chosen. This mapping remains in place even
if the device is reconfigured such that this register is used in an entirely different context. This may cause
unexpected problems in the ION_Data database. It should be used only if you are certain that the
configuration you have chosen is permanent.

Downstream Device Assistant Commands

ThefollowingsummarizesthecommandsavailableintheDownstreamDevice
Assistant:
File>Save:Savesyourchanges.Acopyofthechangesaresavedforfuture
reference,inacommaseparatedvalue(.csv)datafileinthe
...\config\Diagnostic\DownstreamDeviceAssistant\folder.
File>Exit:ClosestheDownstreamDeviceAssistant.
Edit>Reset:Clearsallmodificationsmadesincethelastsave.
Edit>Delete:Deletestheselectedrows.
Edit>RenameSource:LetsyouchangethenameofanAssignedSource.See
RenamingtheAssignedSource.
Edit>UpdateHistoricalData:OpenstheUpdateHistoricalDatawindow
thatallowsyoutoopenapreviouslysavedsourcemeasurementdefinitiondata
file(witha.csvfileextension),forthepurposeofupdatingexistingdatainthe
database.Youcanalsomanuallyadd,editordeletedataentries.SeeUpdating
theHistoricalDataataLaterTime.
View>Refresh:Loadsthecurrentdownstreamdefinitionsfromthedatabase.
FunctionallythesameasEdit>Reset,asthiscommandclearsallmodifications
madesincethelastsave.
View>Options:DisplaystheOptionsdialogboxwhereyoucanchangethe
settingsthatcontrolwhatlevelofdetailisdisplayedforthesource
measurementdefinitions.
View>SelectPhysicalSources:DisplaystheSelectPhysicalSourcesdialog
boxwhereyoucanselectwhichphysicaldevicesyouwantdisplayedinthe
DownstreamDeviceAssistant.

Page 338

2007 Schneider Electric. All rights reserved.

ION Enterprise 5.6

User Guide

For further assistance please contact us at:

Schneider Electric
Power Monitoring and Control
2195 Keating Cross Road
Saanichton, BC
Canada V8M 2A5
Tel: 1-250-652-7100
295 Tech Park Drive, Suite 100
Lavergne, TN 37086
USA
Tel: 1-615-287-3400
Electropole (38 EQI)
31, rue Pierre Mends France
F - 38050 Grenoble Cdex 9
Tel : + 33 (0) 4 76 57 60 60

Electrical equipment should be installed, operated, serviced, and

maintained only by qualified personnel. No responsibility is assumed by
Schneider Electric for any consequences arising out of the use of this
material.

Getting technical support:

Contact your local Schneider Electric sales representative
for assistance or go to the www.powerlogic.com website.

70002-0283-00
2007 Schneider Electric. All rights reserved.
04/2007