ION Enterprise 6.0 User Guide

70002-0298-00 06/2009
PowerLogic ION Enterprise 6.0

Power management software
User guide
Notices
Thissectiondescribesthesymbolsusedinthisguide. Danger Thisalertsyoutothingsthatmaycauseseriousinjurytoaperson. Onlyqualified,properlytrainedpersonnelshouldperformthese procedures. Caution Thisalertsyoutothingsthatmaycauselossofdata,damagetoyour computeroryourdevice. Note Anoteprovidesyouwithadditionalinformationthatyoumightwant toconsider. Tip Thisdrawsyourattentiontoinformationthatcanhelpyouperforma taskmorequicklyoreasily.
Documentation Conventions
Thissectiondescribesthetermsusedtodescribecommonmethodsorprocedures usedthroughoutthisguide.
Clear Click Double-click Drag Enter Hover Point Press Right-click Select Type
1
Place the mouse cursor over the check box, then click the mouse button1 to remove the check mark from the box. Place the mouse cursor over a button or item, then press and release the mouse button. Place the mouse cursor over a button or item, then press and release the mouse button twice. Hold down the mouse button while moving the mouse cursor to highlight the selection or move the selected item, then release the button. Type the information, then press ENTER on the keyboard. Move the mouse cursor over an object (i.e., a button) and pause over the object. Position the mouse cursor over an item such as a menu command. Press the specified key or combination of keys (for example, CTRL+ALT+DEL) on your keyboard. Place the mouse cursor over an item, then press and release the right mouse button. Place the mouse pointer over an option or check box, then click the mouse button to mark your selection. Type the information in the space or box. DO NOT press the ENTER key.
Mouse button means the primary mouse button (left, by default), while right mouse button means the secondary mouse button. This configuration can be switched for accessibility.
Contents
Chapter 1 Introduction ................................................................ 13
ION Enterprise Software Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 MonitoringApplications............................................... 14 ManagementApplications ............................................. 14 ProgrammingApplications ............................................ 15 ION Enterprise Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 ION Enterprise Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 StartingaComponentofIONEnterprise................................. 19 LoggingintoaComponentofIONEnterprise ............................ 19 EndingaSession ..................................................... 19 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Customizing and Navigating Interface Displays . . . . . . . . . . . . . . . . . . . . . 22 AdjustingtheDisplayofaWindoworDialogBox ........................ 22 GridTableControls ................................................... 23
Chapter 2
Management Console ................................................. 27

The Management Console Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Management Console Network Components . . . . . . . . . . . . . . . . . . . . . . . 31 Setting Up Your Network in Management Console . . . . . . . . . . . . . . . . . . . 33 AddingaServer ...................................................... 33 SettingUpDevicesforDirectSerialCommunications ..................... 34 SettingUpDevicesforEthernetGatewayCommunications ................ 34 AddinganEthernetDevice ............................................ 35 SettingUpDevicesforOPCCommunications............................ 35 AddingaModem..................................................... 36 EditingaNetworkComponent......................................... 36 DeletingaNetworkComponent ........................................ 37 Accessing Meters with Advanced Security . . . . . . . . . . . . . . . . . . . . . . . . . 38 Configuring Connection Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 System Log Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Setting Up Large Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 TheDuplicateandConfigureInterface .................................. 43 CreatingMultipleCopiesofaDevice .................................... 45 ConfiguringMultipleDevices.......................................... 48 EditingDuplicatedDeviceInformation .................................. 50
Chapter 3
Management Console Tools ......................................... 53

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 User Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Users ............................................................... 56 Groups .............................................................. 58 License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Reporting Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Event Watcher Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 CreatingaTemplate .................................................. 63 AddinganEventWatcher ............................................. 64 Diagnostics Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 StartingDiagnosticsViewer ............................................ 66 ServiceDiagnostics ................................................... 67 CommunicationsDiagnostics .......................................... 68 AdditionalCommands................................................ 70 Device Upgrader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 UsingDeviceUpgrader................................................ 71 FirmwareUpgradeErrorCodes ........................................ 73 Remote Modem Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 UsingRemoteModemSetup ........................................... 74 Virtual Processor Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 ConfiguringtheVirtualProcessorsModbusService....................... 75 ModifyingtheGlobalParameters ....................................... 79 Time of Use Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 AddingorEditingaSchedule.......................................... 81 AddingorEditingaSubSchedule...................................... 82 ConfiguringSeasons.................................................. 83 AddingSpecialDays .................................................. 85 ConfiguringDayGroups .............................................. 86 ConfiguringTOUNamesandTOUPeriods.............................. 87
Chapter 4
Vista .......................................................................... 89
The Vista Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Vista User Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Monitoring Your System in Vista . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Viewing Real-Time Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 ViewingDatawithNumericObjects .................................... 98 ViewingDatawithStatusObjects ....................................... 99 Viewing Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 UsingaDataLogViewer............................................. 100
UsingtheEventandGlobalEventLogViewers .......................... 102 DisplayingtheGlobalEventLogViewer................................ 103 AcknowledgingAlarms .............................................. 105
Controlling System Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Plotting Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 PlottingLoggedData................................................. 108 The Log View Plotter Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 ViewingthePlotDisplayTab ......................................... 112 ViewingtheHarmonicsAnalysisTab .................................. 115 ViewingthePhasorDiagramTab ...................................... 116 PlottingWaveformsfromDeviceswithHighSamplingRates.............. 118 AddingParameterstoaLogViewPlotter ............................... 119 CustomizingtheLogViewPlotterDisplay .............................. 121 OverlayingCurvesintheLogViewPlotter.............................. 125 Creating and Customizing a User Diagram . . . . . . . . . . . . . . . . . . . . . . . 127 Editing a User Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 TheEnableUndoOption ............................................. 128 AddingaDiagramObjecttoaUserDiagram ............................ 128 Cutting,Copying,andPastingaDiagramObject......................... 129 CopyingaGroupofDiagramObjectstoaFramework .................... 130 AdjustingDiagramObjectLayoutandSize ............................. 131 Customizing a Diagram Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 CaptionOptions ..................................................... 134 TextOptions........................................................ 134 EditTextOptions .................................................... 135 LinkOptions ........................................................ 135 QueryServerOptions................................................ 136 DisplayOptions ..................................................... 136 ActionOptions ...................................................... 142 BoxOptions......................................................... 143 AnnunciationOptions................................................ 144 AlarmingOptions ................................................... 144 Linking a Diagram Object to a Data Source . . . . . . . . . . . . . . . . . . . . . . . 146 Querying the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 UsingtheQueryOptions............................................. 148 UsingtheQueryWizard .............................................. 150 Customizing a Diagram Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 DefaultFont ........................................................ 155 BackgroundColor................................................... 155 ConfiguringWindowProperties ....................................... 156
Chapter 5
WebReach ................................................................ 161

WebReach Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 WebReachInstallationAfterIONEnterpriseisInstalled .................. 162 PreliminarySetup ................................................... 163 DisplayingVistaUserDiagramsOnline ................................ 163 ViewingHistorical(Trend)Data ....................................... 164 ViewingMeterEvents ................................................ 166 AddingaGlobalEventLogViewer .................................... 166 StaleDataorErrorIndicators.......................................... 167 Advanced WebReach Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 CustomNetworkDiagramSetup...................................... 168 WebReachRegistrySettings........................................... 169 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Chapter 6
Web Reporter ........................................................... 171

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 ReportingConfiguration.............................................. 172 Web Reporter Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Report Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 DefaultReportDefinitions............................................ 175 CreatingaNewDefinitionfromaDefaultReportDefinition............... 179 Generating and Viewing a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 ReportOwnershipandAccess......................................... 180 EnteringReportInputs............................................... 180 SavingaReportwithitsInputsDefined ................................ 184 GeneratingaReport.................................................. 184 ViewingaReport .................................................... 184 PrintingaReport.................................................... 185 SavingaReport ..................................................... 185 ExportingaReport................................................... 186 Report Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 ManagingaReport .................................................. 187 SharingaReport..................................................... 187 CreatingReportSubscriptions ......................................... 188 Installing a Report Definition or a Report Pack . . . . . . . . . . . . . . . . . . . . . 191 Custom Report Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Running the ION Power Quality Aggregation Service Manually . . . . . . . . 193
Chapter 7
Designer .................................................................. 195

Getting Started with Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Node Diagrams and the Designer Interface . . . . . . . . . . . . . . . . . . . . . . . 197 TheDesignerInterface ............................................... 197 TheNodeDiagram .................................................. 198 DisplayModeversusEditMode ....................................... 200 DesignerShortcuts................................................... 200 DesignerIcons ...................................................... 201 DesignerWindows .................................................. 206 ION Module Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Using ION Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 AddingaNewIONModule .......................................... 210 DeletingorCuttinganIONModule .................................... 211 ViewingaNodeorModuleasText .................................... 213 CreatingaShortcuttoanIONModule.................................. 214 AddingaTextBoxtoaNodeDiagram ................................. 215 Linking ION Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 LinkingIONModulesGraphically ..................................... 217 LinkingIONModulesontheSameNode............................... 218 LinkingIONModulesAcrossDifferentNodes........................... 219 LinkingIONModulesUsingtheIONTree .............................. 220 DeletingLinks ...................................................... 222 Configuring ION Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Copying and Pasting ION Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 Viewing Output Registers, Setup Registers, and Inputs . . . . . . . . . . . . . . . 239 ViewingOutputRegisterInformation.................................. 239 ViewingSetupRegisterInformation.................................... 240 ViewingInputInformation ........................................... 240 Time of Use (TOU) Program Management . . . . . . . . . . . . . . . . . . . . . . . . 241 AdvancedTOUScheduleConfiguration ................................ 241 Virtual Processor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 UsingtheVirtualProcessor........................................... 244 DistributedControl.................................................. 245 ModbusCommunications ............................................ 248 CommonVirtualProcessorApplications................................ 250 SettingGlobalParameters ............................................ 252
Chapter 8
Database Manager ................................................... 255

Database Manager Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Common Database Management Procedures . . . . . . . . . . . . . . . . . . . . . . 258 DetachingthenReattachingDatabases ................................. 258
AttachingaDatabaseUsingDatabaseManager .......................... 258 RestoringanIONDatabasefromaBackup .............................. 259
Manual Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 AlarmConfiguration ................................................. 260 Archive ............................................................ 261 Attach.............................................................. 262 Backup ............................................................. 262 Defragment ......................................................... 262 Detach ............................................................. 262 ExportRegistrySetting ............................................... 263 ModifyLogin ....................................................... 263 NewIONDatabases ................................................. 264 Restore ............................................................. 264 SQLEditor.......................................................... 265 Trim............................................................... 265 UpdateStatistics..................................................... 266 UpgradeDatabase................................................... 266 Scheduled Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 ScheduledArchive................................................... 268 ScheduledMaintenance .............................................. 270 ScheduledTrim ..................................................... 270 ScheduledBackup................................................... 271 Optimizing Database Query Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 Log Inserter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 Accessing the ION Database with 3rd-Party Applications . . . . . . . . . . . . . 275
Chapter 9
Modbus Device Importer ........................................... 277

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 ION Object Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 Managers ........................................................... 281 Modules............................................................ 281 Registers ........................................................... 281 Main Console Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 Main Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 FileMenu........................................................... 284 EditMenu.......................................................... 284 ViewMenu......................................................... 286 ToolsMenu ......................................................... 287 SettingsMenu ....................................................... 290 HelpMenu ......................................................... 290 ConfigureLoggingandCalculationButton.............................. 290 Editing a Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 RegisterPropertiesDefined........................................... 291
Shortcut Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 GeneralKeyShortcuts................................................ 296 RegisterQuickEditMode............................................. 296 IONMapInformationPane........................................... 297 ModbusRegisterInformationPane .................................... 298 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 DataFormats........................................................ 299 Configuring Logging and Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 ScreenOverview .................................................... 301 ConfiguringRegisterLogging ......................................... 302 ConfiguringLow,HighandMeanCalculationandLogging ............... 303 ConfiguringStaleDataSettings........................................ 303 ConfiguringDownstreamDeviceFunctionality .......................... 304 SavingandExiting ................................................... 305
Chapter 10
ION Alert Monitor ..................................................... 307

ION Alert Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308 SettingUptheIONAlertMonitor...................................... 309 StartingtheIONAlertMonitor ........................................ 312
Chapter 11
Downstream Device Assistant .................................... 313

Detecting Downstream Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 Downstream Device Assistant Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315 StartingtheDownstreamDeviceAssistant.............................. 315 BasicViewversusAdvancedView ..................................... 315 DisplayingPhysicalSources........................................... 318 SortingData ........................................................ 318 DownstreamDeviceAssistantOptions................................. 318 Downstream Device Assistant Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 321 RenamingtheAssignedSource ........................................ 321 CancellingChanges .................................................. 322 ChangingtheMeasurementMapping.................................. 322 AddingaNewDownstreamDeviceMapping........................... 322 UpdatingtheHistoricalDataataLaterTime............................ 323 ActivityLog ........................................................ 323 Downstream Device Assistant Commands . . . . . . . . . . . . . . . . . . . . . . . . 324
Appendix A
Reporter ................................................................... 325

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 Creating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 GeneratingaReport.................................................. 330 ModifyingtheFinishedReport........................................ 330
Types of Default Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331 CreatingaReportWithoutaTemplate.................................. 335 Automatic Report Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336 Using Reporter on Secondary Server or Client . . . . . . . . . . . . . . . . . . . . . 337 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Introduction
PowerLogicIONEnterprisesoftwareisacompletepowermanagement solutionforenergysuppliersandconsumers.Itallowsyoutomanageenergy informationfrommeteringandcontroldevicesinstalledinyourfacilityorother remotelocations.IONEnterpriseofferscontrolcapabilitiesandcomprehensive powerqualityandreliabilityanalysistohelpyoureduceenergyrelatedcosts. IONEnterprisesupportsmultiplecommunicationsstandardsandprotocols availableonvariousintelligentmeteringdevices.Youcanalsoconnecttoexisting powermonitoringsystemsthroughindustrystandardprotocolssuchasModbus, OPC,DNPandXML. IONEnterpriseusesMicrosoftSQLServerforefficientandsecuredata management.YoucaninstalltheSQLServer2005ExpressEditionthatcomeswith IONEnterprise(4GBmaximumdatabasesize)or,forlargerdatabaseneeds,you canuseanexistingSQLServerinstance(Standardeditionorbetter)tohostthe IONEnterprisedatabases.
In This Section
IONEnterpriseSoftwareComponentsonpage 14 IONEnterpriseServicesonpage 16 IONEnterpriseDatabasesonpage 18 StartingaComponentofIONEnterpriseonpage 19 LoggingintoaComponentofIONEnterpriseonpage 19 EndingaSessiononpage 19 AdditionalInformationonpage 21 CustomizingandNavigatingInterfaceDisplaysonpage 22
2009 Schneider Electric. All rights reserved.
Page 13
ION Enterprise Software Components
PowerLogic ION Enterprise User Guide
ION Enterprise Software Components

ThissectionoutlinestheIONEnterprisesoftwarecomponents,andhowtheyare usedtobuild,monitor,maintainandcustomizeyourIONEnterprisesystem.
Monitoring Applications
TheseIONEnterpriseprogramsaremostcommonlyusedindaytodaypower managementtasks:
Vista
TheVistacomponentofIONEnterprisedisplaysgraphicalrepresentationsof yourpowermonitoringsystem.Vistadisplaysrealtimeandhistorical information,visualobjectsthatindicatethecurrentstatusofyoursystem,and interactiveobjectsthatyoucanusetoperformcertainactionssuchas acknowledgingalarms.
NOTE
In this document, Vista refers to the Vista component of ION Enterprise. The Microsoft Windows Vista operating system is referred to as Windows Vista.
WebReach
TheWebReachcomponentofIONEnterprisedisplaysVistauserdiagramsina webbrowser.
Web Reporter
TheWebReportercomponentofIONEnterpriseisthetoolyouusetocreateand generatecommonenergy,demandorpowerqualityreports.
Management Applications
ThefollowingIONEnterpriseprogramshelpyousetupandmaintainyourpower managementsystem.
Management Console
UsetheManagementConsolecomponentofIONEnterprisetoaddand configurenetworkcomponentssuchasservers,sites(communicationlinks)and devices.ManagementConsolealsoprovidesaccesstosystemanddatabase applications,andutilitiestomanageitemssuchasuseraccountsandsoftware licenses.Thesearedescribedinthefollowingtopics: DatabaseManageronpage 255 UserManageronpage 55
Page 14
Programming Applications
LicenseManageronpage 60 ReportingConfigurationManageronpage 61 EventWatcherManageronpage 62 Designeronpage 195 DiagnosticsVieweronpage 66 DeviceUpgraderonpage 71 RemoteModemSetuponpage 74 VirtualProcessorSetuponpage 75 ModbusDeviceImporteronpage 277 TimeofUseEditoronpage 80
Optional Components
Thefollowingoptionalcomponentsarealsoavailableiftheyhavebeenordered andthenactivatedviaLicenseManager: OPC Server Assistant Thiscomponentchecksthenetworkfornewsourcesofcommonortypical measurementstobeexposedtotheOPCServer.Thisisonlyavailablewiththe optionalOPCServerlicense. PQDIF Exporter ThiscomponentletsyouexportdatatoPowerQualityDataInterchangeFormat (PQDIF)andsetscheduledexportswithnotification.Thisisonlyavailablewith theoptionalPQDIFExporterlicense.
Programming Applications
TheseIONEnterpriseapplicationshelpyoucustomizeelementsinyoursystem andconfigurethirdpartydevicessothesystemcanrecognizeandutilizethem:
Designer
UsetheDesignercomponentofIONEnterprisetoperformawiderangeof functions,fromconfiguringsetupregistersofIONdevicesonyournetworkto creatingcomplexframeworksusingacombinationofIONmodulesfrom hardwareorsoftwarenodes.
Modbus Device Importer

UsetheModbusDeviceImportercomponentofIONEnterprisetointegrate thirdpartyModbusdevicesintoyourIONEnterprisenetwork.
Large System Setup Using Management Console

UsetheDuplicateandConfiguredialogboxtosetuplargesystemsefficiently.See SettingUpLargeSystemsonpage 43formoreinformation.
Page 15
ION Enterprise Services

ManyofIONEnterprisescorecomponentsrunasWindowsServices.Thisallows yourserverstocontinuemonitoringyourpowermanagementsystemwhenno usersareloggedon.Intheeventofapoweroutage,yoursystemautomatically resumespowermonitoringwhenthepowerisrestored.Thetablebelowoutlines theIONEnterpriseServicesandwhethertheserviceisconfiguredtostart automaticallyormanually,bydefault.
NOTE
ION Network Router Service has many dependent ION Enterprise services. For example, the Virtual Processor, ION Log Inserter Service, ION Site Service, and DDE services cannot start and operate without it running.
Service Name
Description
Checks the ION Enterprise computers communications ports continuously for high priority events occurring at remote modem sites. When this happens, Alert Monitor initiates a communications connection to the remote modem site. Locates local and remote ION Enterprise components. Determines the connection status of sites and devices in the ION Enterprise system, and handles allocation of resources such as modems. This service manages the state of site and device connectivity for the ION Enterprise system. In order to establish the most appropriate state for the system, each connection and disconnection request is evaluated against the overall state of the system and availability of communications channels. Provides Dynamic Data Exchange (DDE) connectivity between devices and DDE compatible applications, such as Microsoft Excel. Monitors system events for conditions specified in Event Watcher Manager (see Event Watcher Manager on page 62). Provides historical data collection and storage for your power-monitoring system. See Log Inserter on page 274. Routes all information between ION Enterprise software components, such as client workstations and the Log Inserter. The service dynamically detects changes to the network configuration, including the addition of new servers; it can also recognize new software nodes, such as Vista, that are added to an existing server. Manages and is responsible for supplying OPC data to client applications. Periodically processes and aggregates new Power Quality event data. Translates data from ION Enterprise databases to PQDIF file format and manages scheduled PQDIF exports. Provides historical data retrieval for your power-monitoring system. See Linking a Data Log Viewer or Event Log Viewer on page 147 for more information regarding this service. Manages and provides access to real time data from the power management system. This service manages Web Reporter report subscriptions.
Manual/ Automatic
Manual
ION Alert Monitor ION Component Identifier Service
Manual
ION Connection Management Service
Automatic
ION DDE Service1 ION Event Watcher Service ION Log Inserter Service
Disabled Automatic Automatic
ION Network Router Service
Automatic
ION OPC Data Access Server ION Power Quality Aggregation Service ION PQDIF Exporter Service ION Query Service ION Real Time Data Service ION Report Subscription Service
Manual Automatic Manual Automatic Automatic Automatic
Page 16
Service Name
Description
Manages communication links to and from ION Enterprise. ION Site Service is responsible for handling packet communications to system devices and controlling direct device communications. The service reacts to changes in network configuration: for example, often changes to certain channels, gates, ports, or device parameters can interrupt a connection. You can add, delete, or change channels, gates, ports, and devices without restarting the ION Site Service, ION Network Router Service, and ION Connection Management Service. Provides coordinated data collection, data processing, and control functions for groups of meters. For more information on the Virtual Processor and its functionality, see Virtual Processor Setup on page 75. Manages subscriptions to XML data for Vista user diagrams. This service is used only by WebReach. When you open a Vista user diagram in a web browser, the ION XML Subscription Service creates a subscription and delivers the real-time data in XML format. Stores XML data subscriptions for the power monitoring devices on the network. This service is used only by WebReach.
1
Manual/ Automatic
ION Site Service
Automatic
ION Virtual Processor Service
Automatic
ION XML Subscription Service ION XML Subscription Store Service
Automatic
Automatic
This service may not be available on all operating systems.
Page 17
ION Enterprise Databases
ION Enterprise Databases

TheIONEnterprisedatabasesaretypicallyinstalledonthePrimaryServerand runinthebackgroundofyourIONEnterprisesystem.Toconnecttothese databases,IONEnterpriseusestheSQLServerinstanceyoucreatedwhenyou installedIONEnterpriseorconfiguredSQLServer. ForinformationonmanagingthesedatabasesinIONEnterprise,seeDatabase Manageronpage 255.
Microsoft SQL Server Database

MicrosoftSQLServer2005ExpressEdition(SQLServerExpress)comeswith IONEnterprisebydefault.SQLServeristhedatabaseenginethatmanagesthe IONEnterprisedatabases:theIONdatabase(ION_Data),theNetwork Configurationdatabase(ION_Network),andtheSystemEventsdatabase (ION_SystemLog).Toconnecttothedatabases,IONEnterpriseusesaSQLServer instancecalledION,whichiscreatedwhenIONEnterpriseisinstalled,unlessa preexistinginstanceisspecifiedwhenIONEnterpriseisinstalled.
The Network Configuration Database

TheNetworkConfigurationdatabase(ION_Network)storesinformationabout yournetworktopologythenetworkconnections,computersandeveryconnected device,includingdialoutmodems.Thisinformationisusedbythecommunications services(e.g.,IONNetworkRouterService,IONSiteService)andothersoftware componentstomanagedataandcontrolrequeststoandfromthedevicesandthe otherIONEnterprisecomponents(i.e.,Vista,Designer).
The System Events Database

TheSystemEventsdatabase(ION_SystemLog)storesdataabouteventsthat occurduringtheoperationofIONEnterprisecomponents.Forexample,theevent detailsaboutthecommunicationservicesinteractionswithdevices,detailsabout controlsinitiatedthroughVista,andgeneraloralarmleveleventsthatoccurinthe VirtualProcessorareallinsertedintotheSystemEventsdatabase.Thesecanthen beviewedwhenyouclicktheSystemLogEventsiconinManagementConsoleor throughaccesstotheION_DatadatabaseusingVista(EventLogViewer). ION_SystemLogisnotbackedup.SomecontentsoftheSystemLogSystem Eventswithapriorityof192orgreaterareautomaticallyinsertedintothe ION_DatadatabaseonaregularbasisandcanbeviewedinVista.
The ION Database

TheIONdatabase(ION_Data)containsalltheinformationcollectedfrom devicesthathavetheabilitytorecorddataandfromIONEnterprisecomponents. ThisdatabaseusestheIONLogInserterServicetogatherdatafromallofthe availablesources,andthenmakesthedataavailabletoIONEnterprise componentslikeVista(throughtheIONQueryService)orWebReporter(through directdatabasequeries).
Page 18
Getting Started
Getting Started
Thissectiondescribeshowtostart,logontoandexitmostcomponentsofION Enterprise.
Starting a Component of ION Enterprise

UseoneofthefollowingmethodstostartthemaincomponentsofIONEnterprise (i.e.,ManagementConsole,VistaorWebReporter): OpentheIONEnterpriseToolsfolderonyourdesktopanddoubleclicktheicon oftheprogramyouwanttostart. DoubleclicktheIONEnterpriseicontoopentheIONEnterpriseTaskpad,then clickononeofthelinks. ClickStart>Programs>SchneiderElectric>IONEnterpriseToolsandselect theprogramyouwanttostartorclickStart>Programs>IONEnterpriseto launchtheIONEnterpriseTaskpad.
Logging into a Component of ION Enterprise

MostIONEnterpriseprogramsrequireyoutologinbeforeyoucanaccessthem. Atthelogonprompt,typeyourusernameandpasswordintheappropriatebox, thenclickOK.Someactionsarerestrictedtocertainusersorgroups,dependingon howtheirloginpermissionsweresetup.SeeUserManageronpage 55for details.Ifyoudonothaveausernameandpassword,logoninViewOnlymode forlimitedaccess. Thedefaultusernameisguest.Thedefaultpasswordis0(zero).The passwordfieldiscasesensitive.Forinformationonsettingupuseraccountsand changingpasswords,seeUserManageronpage 55. Afteryoulogon,theprograminterfaceappears.
Ending a Session
TherearetwowaystoendasessioninacomponentofIONEnterprise: Logoffifyouwanttoendthecurrentusersessionbutkeeptheprogram running,or Exitifyouwanttoclosetheprogramcompletely. Somecomponentsofferbothoptions;someonlyoffertheExitoption.
Page 19
Ending a Session
Logging Off 1. SelectFile>Logoff. Amessageappears,promptingyoutoconfirmyourintentiontologoff. 2. ClickYestologofforNotoreturntotheprogram. Ifyouattempttologoffwithoutsavingyourwork,theprogrampromptsyouto saveyourchanges.ClickYestosaveyourchanges,Notodiscardthem,or Canceltoreturntotheprogram. Afteryoulogoff,theIONEnterpriseLogonscreenappears. Exiting 1. SelectFile>Exit. Amessageappears,promptingyoutoconfirmyourintentiontoexitthe application. 2. ClickYestoexitorNotoreturntotheprogram. Ifyouattempttoexitwithoutsavingyourwork,theprogrampromptsyouto saveyourchanges.ClickYestosaveyourchanges,Notodiscardthem,or Canceltoreturntotheprogram.
Page 20
Additional Information
FormoreinformationaboutIONEnterprisecomponents,usingdeviceswithION Enterprise,andIONarchitecture,seethefollowingdocuments: IONEnterprise6.0CommissioningGuide IONEnterprise6.0SystemRequirements AdditionalDeviceSupportinIONEnterprise6.0 OPCServerAssistant PQDIFExporter MultilingualSupportinIONEnterprise6.0 IONSystemSecurity TroubleshootingSerialCommunicationsinPowerLogicIONMeters TroubleshootingMeterWiring UpgradingIONDeviceFirmware IONReference Visitwww.powerlogic.comformoreinformationandtoobtaindocumentation.
Page 21
Customizing and Navigating Interface Displays
Customizing and Navigating Interface Displays

Thefollowingsectionsdescribewaystocustomizeandnavigatedisplaywindows, dialogboxesandtablesincomponentsofIONEnterprise.
Navigating Tree Structures

InformationinIONEnterpriseisoftendisplayedinatree.Click+toexpand itemsinthetreeortocollapsethem.
Selecting Multiple Items in Tables, Tree Structures, Diagrams and Folder Structures
Toselectadjacentitems,selectthefirstitem,holddowntheSHIFTkeythenclick thelastitem. Toselectnonadjacentitems,holddowntheCTRLkeythenclicktoselectthe items. ToselectadjacentitemsinVistaorDesignerdiagrams,dragaselectionboxaround theitems.Allitemsintheboxareselected.
Adjusting the Display of a Window or Dialog Box

Thefollowingsectionsdescribehowtoresizeandhideorrevealpanes.
Resizing Panes
Toresizepanesinawindow,pointthemouseattheborderwherethetwosections meet.Whentheresizehandleappears,dragtomovetheborder.
Dock (Pin) or Hide (Unpin) Pane

SomeinterfacesinIONEnterprisehavepanesthatcanbehidden(visible temporarily)ordocked(visibleallthetime). Tohideordockapane,clickthePin/Unpin buttononthepane.Whenapane ishidden,itisminimizedtoabuttonattheedgeoftheworkspace. Totemporarilyshowahiddenpane,hoverthemouseoverthebuttonforthat pane.Movethemouseawaytohidethepaneagain.
Page 22
Grid Table Controls
Grid Table Controls

CertainwindowsandutilitiesinIONEnterprisedisplayinformationingrid tables.Thesetableshaveuniquetableandinformationdisplaycommands.
Group By Box
Column Header
Sort Icon
Filter Icon
Column Selector
Dynamic Filter Area
Right-click menu options
Select Columns/Column Selector

Sometablesallowyoutoselectwhichcolumnstoincludeinthetable. 1. 2. InManagementConsole,hoveroverthecolumnselectortabontherightside ofthedisplaywindow.Inotherinterfaces,clicktheSelectColumnslink. Selecttheboxesforthecolumnsyouwanttoincludeinthetable.Cleartheboxes forthecolumnsyoudonotwanttoincludeinthetable.
Adjust Column Width

Tochangethewidthofacolumn,pointthemousetotherightedgeofthecolumn header.Whentheresizehandle(doublearrowpointer)appears,clickanddragto adjustthewidth.Toadjustthewidthforbestfit,pointtotherightedgeofthe columnheader,thendoubleclickwhentheresizehandleappears. Best Fit Toadjustacolumnwidthtothebestfitwiththeleastamountofwhitespace: Foronecolumn,rightclickacolumnheaderandselectBestFit. Forallcolumns,rightclickonthecolumntitleareaandselectBestFit(all columns).
Arrange Columns
Tochangetheorderofthecolumns,dragacolumnheadertotheleftorrightofits originalposition.
Page 23
Grid Table Controls
Group by Column
Togroupdataaccordingtothecontentsofaparticularcolumn,dragthecolumn headertotheareaaboveit(markedDragacolumnheaderheretogroupbythat column).Toexpandorcollapsethegroups,clickthe+orbutton.Toexpand orcollapseallgroups,rightclickthecolumnheaderinthegroupbyboxandselect FullExpandorFullCollapse,respectively. Youcanalsogroupbymultiplecolumnsinaspecificorder,withsortingand filteringapplied.
Toungroup,dragthecolumnheaderbacktoitsoriginalposition(orrightclickthe columnheaderandselectUngroup). ToshoworhidetheGroupBybox,rightclickthecolumnheaderandselector clearGroupByBox.
Sorting Data in a Column

Clickacolumnheadertosorttablerowsaccordingtodatainthatcolumn.Youcan sortinascendingordescendingorder(indicatedbyanupordownarrow, respectively).Tocancelsortingandreturnthecolumntoitsdefaultstate,right clickthecolumnandselectClearSorting.
Filtering Data in a Column

Thefollowingsectionsdescribetheavailablefilteringoptions. Using the Simple Column Filter Whenthemouseispositionedoveracolumnheader,theFiltericonappearsinthe toprightcorneroftheheader.Clickittoselectoneofthelistedfilterconditionsand applyittothedatainthatcolumn.Select(Custom)toapplyoneortwologic conditionstofilterthedata.Tocancelfilteringandreturnthecolumntoitsdefault state,rightclickthecolumnandselectClearFilter.
Page 24
Grid Table Controls
Using the Dynamic Column Filter Sometableshavearowbetweenthecolumnheaderandthetabledata.Thisisthe dynamicfilterarea. Tousethedynamicfilterarea,starttypingtheentryyouwanttofilteroninthe spaceabovetheapplicablecolumn.Youcanuseanasterisk(*)atthebeginningof thefilterasawildcard.Onceyouachievethefilterresultsyouwant,youcanstop typing.Forexample,tofilteroutDSTfromdisturbanceinSystemLogEvents, youonlyneedtotypedi. Using the Filter Builder TheFilterBuilderisanadvanceddatafilteringtool.Useittocreatefilterswith multipleconditionsacrossmultiplecolumns.TousetheFilterBuilder: 1. 2. RightclickacolumnheaderandselectFilterEditor.TheFilterBuilderdialog boxappears. Specifythefilterconditions. Theelementsofthefilterbuilderare:<ColumnHeader><Condition><Value> Clickanelementtodisplaytheoptionsavailable,thenselecttheoptionyou wanttouse.
3. 4. 5. 6. 7.
Selectthe<ColumnHeader>andthe<Condition>youwanttoapply.Typethe <Value>totestfor. Toaddanotherfilter,clickthe+buttononthetop. Selectalogictoapplytothisnewfilter(inrelationshiptothecurrentfilter). Repeatstep3. Toremoveafilter,clickthedelete(x)buttonbesideit.
Inthefollowingexample,thefilterfindsalldeviceswhosenamescontainFL1 andwhosetypesbeginwithION.
Page 25
Grid Table Controls
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
Click Edit Filter to configure the filter conditions
Page 26
Management Console
UseManagementConsoletoadd,removeorconfigurecomponents,suchas meteringdevices,inyourIONEnterprisepowermanagementsystem.Youcanset updifferenttypesofsites(communicationlinkssuchasEthernetorserial),andset upconnectionschedulesforthesesites. Inaddition,theManagementConsoleToolsmenuprovidesaccesstodeviceand systemconfiguration,maintenanceandprogrammingtools.SeeManagement ConsoleToolsonpage 53fordetails.
CAUTION
Unauthorized changes to network configuration can result in an unstable or unusable network, therefore only users with Operator- or Supervisor-level access can make changes in Management Console.
In This Section
TheManagementConsoleInterfaceonpage 28 ManagementConsoleNetworkComponentsonpage 31 SettingUpYourNetworkinManagementConsoleonpage 33 AccessingMeterswithAdvancedSecurityonpage 38 ConfiguringConnectionSchedulesonpage 39 SystemLogEventsonpage 41 SettingUpLargeSystemsonpage 43
Page 27
The Management Console Interface

Sort indicator Group By box Filter indicator Pin/Unpin Icon
Column Selector
System Setup pane and icons
Mouse hover text
Display window: This area displays the contents of the selected system setup icon
Current filter applied
Edit Filter button
Window Title
Thewindowtitledisplaysthenameofthesoftwareprogramandthecurrentuser.
System Setup Pane

TheiconsintheSystemSetuppanerepresentcategoriesofitemsyoucanadd, remove,setup,andview.Clickanicontogototheassociateddisplaywindow.
Display Window
TheDisplaywindowshowsthecontentsoftheitemcurrentlyselectedinthe SystemSetuppane.
Refresh
TomanuallyrefreshManagementConsoleandreloaditscontents,selectView> Refresh(orpressF5).
Page 28
Options
SelectTools>OptionstoopentheOptionsdialogbox.Usethisdialogboxto changedisplaysettingsfortheSystemLogEventsdisplaywindow. Highlighting HighlightingcontrolshowErroreventsaredisplayedintheSystemLogEvents displaywindow.SelectorcleartheEnableHighlightingcheckboxtoturn highlightingonoroff.ClickSetHighlightColortochangethehighlightcolorfor CriticalorErroreventsintheSystemLogEventsdisplaywindow. Events TheEventssectionofthedialogboxletsyoucontrolhowmanyrecordsappearin theSystemLogEventsdisplaywindowandhowdateandtimearedisplayed.
Customizing the Management Console Interface

YoucancustomizewhatisdisplayedintheManagementConsoleinterfaceandthe tableswithinthedisplaywindows: Selectwhichcolumnsappearintables. Filter,sortandgroupdataintables. Forinstructionsonusingthesefeatures,seeCustomizingandNavigating InterfaceDisplaysonpage 22.
Display Window Shortcut Menus

ToaccessshortcutmenusintheDisplayWindow,firstclicktheiconoftheSystem Setupitemyouareinterestedin.Thenrightclickinthedisplaywindowareaoron anetworkcomponenttodisplaytheshortcutmenu.Themenuitemsavailable varydependingonthenetworkcomponentselected. Newdisplaystheoptionsavailableforaddingnewnetworkitems. Duplicatecreatesoneormorecopiesofaselecteditem.
NOTE
For the Duplicate command, each one of the duplicates needs to be opened individually in order to configure them. Duplicate and Configure allows you to create and configure multiple devices at the same time.
DuplicateandConfigureletsyouperformbatchcloningofdevices.When multipledevicesareselected,thisrightclickshortcutbecomesConfigure SelectedDeviceswhichletsyouperformsetupfunctionssuchasbatch renamingofdevices. Deleteremovestheselecteditems. ConnectandDisconnectletyoumanuallyconnecttoordisconnectfromthe selectedsite.
Page 29
NOTE
You cannot connect or disconnect an individual serial device in a site; you can only connect or disconnect the site for that serial device.
ConnectEthernetandDisconnectEthernetletyoumanuallyconnecttoor disconnectfromtheselectedEthernetdevice. SecurityaccessestheMeterSecuritySettingsdialogbox.Thisisusedbythe softwaretogainaccesstosecurityenableddevices(e.g.,ION8600orION7650); itisonlyavailablefromtheshortcutmenufortheDevicesdisplaypane. Configure<NetworkComponent>opensthe<NetworkComponent> Configurationdialogbox(where<networkcomponent>isthecomponent selected).Usethisdialogboxtomakechangestothepropertiesfortheselected networkcomponent.
Page 30
Management Console Network Components

ThissectiondescribesthedifferentcomponentsinManagementConsole:Servers, Sites,Devices,DialOutModems,ConnectionSchedules,andSystemLogEvents. SeeSettingUpYourNetworkinManagementConsoleonpage 33for informationonaddingthesecomponentstoyournetwork.
Servers
AserverisacomputerintheIONEnterprisesystemthatrunsadministrative softwaretocontrolaccesstothenetworkanditsresources,suchasmetering devices.
Sites
AsiteisagroupofdevicesintheIONEnterprisesystemthatshareacommon communicationslink.Asitecanbeadirectsite,amodemsite,anEthernetgateway site,oranOPCsite. Direct Site Inadirectsite,serialcommunicationsoccurbetweenacomputerandoneormore meters.ThestandardsmostcommonlyusedoncomputersareRS232(for connectingonedevice)andRS485(forconnectingaloopofupto32devices). Whenconnectingtomorethanoneserialdevice,useanRS232toRS485 converter. Modem Site Inamodemsite,communicationsoccurbetweenaremotemodem(attheModem Site)andalocalmodem(ontheserver).
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,IONEnterpriseselectsthefirst availablemodemtoestablishcommunications(thisisreferredtoasmodem pooling). Ethernet Gateway Site AnEthernetgatewaysite(forexample,EtherGateorModbusgateway)consistsof anRS485chainofdevicesthatcommunicateswithanEthernetnetworkviaan Ethernetdevice.TheEthernetdeviceactsasagatewaythattransfersdatabetween anEthernetnetworkandthedevicesconnectedtoitviaRS485.Thegateway deviceconvertsRS232/RS485communicationstoandfromEthernet.
Page 31
OPC Site AnOPCsiteconsistsofanOPCserverthatcommunicateswithOPCcompliant devicesonthenetwork.
Devices
Adeviceisameterorothercomponentthatcommunicatesandgathersdata,and isinstalledonanetwork. Serial Devices Serialdevicesbelongtodirectsites,modemsites,orEthernetgatewaysitesthey communicatethroughamodem,RS232,RS485,orEthernettoSerialgateway connection.Youmusthavetheappropriatesitesconfiguredfirstbeforeyoucan addserialdevices. Ethernet Devices EthernetdevicesarethosethataredirectlyconnectedtothenetworkviaEthernet. YoucanmanuallyconnectordisconnectyourEthernetdevicethroughthe ManagementConsole. OPC Devices OPCdevicesprovidedatainOPCformat.YoumusthaveanOPCsiteconfigured toaddanOPCdevice.
Dial-Out Modems
Adialoutmodemisonethataservercomputerusestocommunicatewitha remotemodematamodemsite.Themodemimplementedcanbeatraditional hardwarebasedmodemoritcanbeasoftwarebasedmodemthatusesthe computersprocessortoemulateatraditionalhardwarebasedmodem. Whenamodemsiteneedstoestablishcommunications,itselectsamodemfrom thelistofmodemsconfiguredinthemodemsite.Youcanaddhardwaremodems orWinModemstothemodemlist.
NOTE
A WinModem is a modem that is directly controlled by the computers operating system.
Connection Schedules
Connectionschedulesareprogrammedroutinesforaservertoregularlyconnect toanddisconnectfromsites(andtheirassociateddevices)andEthernetdevices. SeeConfiguringConnectionSchedulesonpage 39formoreinformation.
System Log Events

SystemLogEventslistseventsforthenetwork.Youcanselectwhattimeframeand componentsyouwanttovieweventsfor.SeeSystemLogEventsonpage 41for moreinformation.
Page 32
Setting Up Your Network in Management Console
Setting Up Your Network in Management Console

ThePrimaryServercontainsalltheIONEnterpriseprogramsanditcontrolsthe overalloperationofyourenergymanagementsystem.Theprimaryserveris displayedontheServerscreenwhenyoufirststartManagementConsole. Tostartbuildingyoursystem,addandconfigureyoursitesanddevices.
Adding Network Components

Fordetailsonaddingvariouscomponents,seethefollowingsections. Followtheprocedurebelowtoaddanewnetworkcomponent: 1. 2. IntheSystemSetuppane,selecttheiconforthetypeofitemthatyouwantto add(i.e.,Site,Device,orDialOutModem). Rightclickinthedisplaywindow,selectNew,andthenselectthespecifictype ofnetworkcomponentfromtheshortcutmenu.Theoptionsdifferdepending onwhichsystemsetupiconyouselected. TheConfigurationdialogboxappears. 3. Usethefieldsanddropdownmenustoconfigureproperties.Mandatoryitems arehighlightedinred.Toconfigureadvancedproperties,rightclickinthe dialogboxandselectAdvancedProperties.Formoreshortcutmenuoptions, seeConfigurationDialogBoxShortcutMenus,below. ClickOKtoaddthecomponent.
4.
Configuration Dialog Box Shortcut Menus RightclicktheConfigurationdialogboxtoaccessthefollowingshortcutmenu options: PropertyDetails:Thisopensawindowthatcontainsinformationonthe selectedproperty,includingminimumandmaximumallowablevalues,if applicable. AdvancedProperties:Thisexposesallthepropertyfieldsthatarehiddeninthe default(basic)view. ResetAllToDefault:Resetsallpropertiestotheiroriginalvalues.
Adding a Server
ClicktheServersicon,rightclickinthedisplaywindowandselect New > Computer.FillinthemandatoryNamefield.
Page 33
Setting Up Devices for Direct Serial Communications
Setting Up Devices for Direct Serial Communications

TosetupdevicesforRS232orRS485communicationsonadirectserialloop,first addadirectsiteinManagementConsoleandspecifyaserialcommunicationsport onthecomputer. Step1: Adding a Direct Site ClicktheSitesicon.RightclickinthedisplaywindowandselectNew > Direct Site.FillintheNameandSerialPortfields.Configuretheotherfieldsasyou require. Step 2: Adding a Device to the Direct Site ClicktheDevicesicon.RightclickinthedisplaywindowandselectNew > Serial DeviceonDirectSite.Fillinthesefields: Group:Typeanameforthegrouporselectanexistinggroupfromthelist. Name:Typethenameyouwanttogivethedevice. DeviceType:Selectthetypeofthedevice. UnitID:TypetheUnitIDofthedevice;therangeis19999forIONdevicesor 1247forModbusRTUdevices. Site:Selectthedirectsiteyoupreviouslysetup. Configuretheotherfieldsasyourequire.
Setting Up Devices for Ethernet Gateway Communications

TosetupdevicesforEthernetgatewaycommunications,firstaddandconfigure anEthernetgatewaysite.Ethernetgatewaysthatcanbeusedincludethosethatare simpleEthernettoSerialconverters,oranygatewayordataconcentratorthat providesModbusTCPcommunications. Step 1: Adding an Ethernet Gateway Site ClicktheSitesicon.RightclickinthedisplaywindowandselectNew > Ethernet GatewaySite. FillintheName,TCP/IPAddressandTCP/IPPortfields.TheTCP/IPPort identifieswhichcommunicationsportisusedtoconnecttotheserialdevices.The portyouusedependsonthetypeofEthernetgatewayyouwanttosetup(i.e.,use 7801foranEtherGategatewayviaCOM1oruseport502foraModbusgateway). Configuretheotherfieldsasyourequire.
Page 34
Adding an Ethernet Device
Step 2: Adding a Device to the Ethernet Gateway Site ClicktheDevicesicon.RightclickinthedisplaywindowandselectNew > Serial DeviceonEthernetGatewaySite.Fillinthesefields: Group:Typeanameforthegrouporselectanexistinggroupfromthelist. Name:Typethenameyouwanttogivethedevice. DeviceType:Selectthetypeofdevice. UnitID:TypetheUnitIDofthedevice;therangeis19999forIONdevicesor 1247forModbusdevices. Site:SelecttheEthernetgatewaysiteyoupreviouslysetup. Configuretheotherfieldsasyourequire.
Adding an Ethernet Device

ClicktheDevicesicon.Rightclickinthedisplaywindowandselect New > EthernetDevice.FillintheGroup,Name,DeviceTypeandTCP/IP Addressfields.Configuretheotherfieldsasyourequire.
NOTE
When you configure 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

TosetupdevicesforOPCcommunications,firstaddanOPCsite. Step 1: Adding an OPC Site ClicktheSitesicon.RightclickinthedisplaywindowandselectNew > OPCSite. FillintheNameandAddressfields.Configuretheotherfieldsasyourequire. MakesureyoufollowthecorrectsyntaxwhentypingintheaddressfortheOPC site.SelecttheAddressfieldtoseeanexampleaddressinthePropertyDescription section(nearthebottomoftheOPCSiteConfigurationdialogbox). Step 2: Adding a Device to the OPC Site
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.
ClicktheDevicesicon.RightclickinthedisplaywindowandselectNew > OPC Device.FillintheGroup,Name,DeviceTypeandSite(selecttheOPCsite youpreviouslysetup).Configuretheotherfieldsasyourequire.
Page 35
Adding a Modem
Adding a Modem
1. ClicktheDialOutModemsicon,rightclickinthedisplaywindowandselect New,thenselecteitherSerialModem(hardwaremodem)orWinModem (Windowsmodem). Fillinthevaluesforthemandatoryfields: ForSerialmodem,selecttheModemTypefromthelist.Ifyourmodemis notinthislist,selectGenericIONModemOther.SelecttheSerialPort whereyourmodemisconnected. ForWinModems,selecttheModemNamefromthelist. Configuretheotherfieldsasyourequire. 3. ClickOK.
2.
WinModem Installation Notes BeforeyoucanuseaWinModem,youmustfirstinstallitonyourcomputer(follow theinstructionsthatcamewiththeWinModemproduct).Afteryourestartthe computer,setuptheWinModem: 1. 2. 3. 4. InMicrosoftWindows,clickStart>Settings>ControlPanel,thendouble clickPhoneandModemOptions. ClicktheModemstab,selectyourWinModem,thenclickProperties. ClicktheAdvancedtab,thenclickChangeDefaultPreference. SetPortspeedtomatchthebaudratethatisusedbetweenthemeterandthe modemontheremoteendoftheconnection(i.e.,bothmodemsmustbesetto thesamebaudrate). SetFlowControltoNone. ClickOKtosaveyourchanges.
5. 6.
NOTE
You may need to restart your computer for the settings to take effect.
Editing a Network Component

1. 2. ClicktheiconintheSystemSetuppaneforthetypeofcomponentyouwantto edit. Inthedisplaywindow,rightclickthenetworkcomponentyouwanttoeditand selectConfigure<NetworkComponent>(with<NetworkComponent>being thetypeofcomponentyouwanttoedit). Maketherequiredchanges.Todisplayallconfigurablefields,rightclickinthe ConfigurationdialogboxandselectAdvancedProperties. ClickOKwhenyouarefinishedtosaveyourchanges.
3.
4.
Page 36
Deleting a Network Component
NOTE
If you rename a group or device in Management Console, you will not be able to access the data that is already stored in the database using the previous group or device name. New data will be added to the database using the new name.
Deleting a Network Component

1. 2. 3. ClicktheSystemSetupiconforthetypeofcomponentyouwanttodelete. Inthedisplaywindow,rightclickthenetworkcomponentyouwanttodelete andselectDelete(orselecttheitemandpresstheDELETEkey). ClickYestoconfirmthedeletionorNotocancel.
NOTE
When you delete a Site or a Server, all devices associated with it are also deleted.
Page 37
Accessing Meters with Advanced Security
Accessing Meters with Advanced Security

IfyouhaveameterinyournetworkwithAdvancedSecurityenabled,use ManagementConsoletoallowIONEnterpriseServicestoaccessthemeter: 1. 2. RightclickthedevicethathasAdvancedSecurityenabledandselectSecurity. TheMeterSecuritySettingsdialogboxappears. FromtheSoftwareAccessdropdownlist,selecttheuser(configuredonthe meterusingDesignerorIONSetup)thathastheaccesssettingsthatyouwantto giveIONEnterpriseservicesandcomponentstothedevice. ClickMatchPasswordandtypethepasswordforthatuserinthePasswordfield thenretypeitintheConfirmPasswordfield. Selectthecheckboxifyouwanttoallowthesoftwaretosendsecuretime synchronizationsignalstothemeter.Clearthecheckboxifyoudonotwantto sendsecuretimesynchronizationsignalstothedevice. ClickOK.
3. 4.
5.
Page 38
Configuring Connection Schedules

YoucanschedulethetimeswhentheserverconnectstoasiteorEthernetdevice.
Adding a Connection Schedule

ClicktheConnectionSchedulesicon,rightclickinthedisplaywindow,thenselect New>ConnectionSchedule.TheScheduledSiteConnectiondialogboxappears. Thefollowingsectionsdescribetheavailabletabsandhowtoconfigurethem. General Settings Tab OntheGeneralSettingstab: Typethenameofyourconnectionschedule(forexampleDailyReading)in theNamefield. Typeadescriptionoftheconnectionschedule,ifrequired. MakesureEnabledisselectedifyouwanttoenabletheschedule. Selectthedatefromwhichthescheduleisvalid. Sites Tab OntheSitestab: Clicktheboxbesidethesitesanddevicestoselectthosethatyouwanttoinclude intheconnectionschedule.Acheckmarkappearsbesideanitemtoindicatethat itisincludedintheconnectionschedule. SetyourSiteConnectionSettings.Toentertheminimumandmaximumtimeto stayconnected,typethetimeinthefieldsorusethearrowstochangethetime. SettheConnectionPriority.Thehigherthenumber,thegreaterthepriority giventothatscheduleifthereareconcurrentconnectionrequests.
Page 39
Schedule Tab OntheScheduletab: Setupthedateschedulefortheconnection(thedefaultisDaily).Schedule optionsvarydependingonthetypeofscheduleselected. Daily:Occurseveryday. Weekly:Occursontheselecteddayatthespecifiedfrequency(innumberof weeks)andstaysactiveforthespecifiedduration.Forexample,ifyouset Frequencyto2,DayofweektoSundayandActiveDurationto2,the connectionoccurseverysecondSundayandstaysactivefortwodays. MonthlyDayofWeek:Occursatthespecifiedfrequency(inmonths),in theweekandonthedayspecifiedandforthespecifiedduration.For example,ifyousetFrequencyto3,DayofMonthto2ndandSunday,and Durationto1,theconnectionoccurseverythirdmonthonthesecond Sundayandstaysactivefor1day. MonthlyDayofMonth:Occursatthespecifiedfrequency(inmonths),on thespecifieddateofthemonth,andforthedurationspecified.Forexample, ifyousetFrequencyto2,DayofMonthto15thandDurationto2,the connectionoccursonthefifteenthdayofeverysecondmonthandstays activefor2days. Setupthetimeperiodfortheconnectiontooccurbysettingastartandanend time.IntheStartTimeandEndTimefields,typethetimeorusethearrowsto changethetime.
Ifyouconfigureafullday(i.e.,24hour)dailyschedule,makesureyouallow enoughtimebetweentheendtimeandthestartofthenextconnectiontoavoid connectionproblems.Forexample,toadda2minutegaptoa24hourschedule, settheStartTimeto0:00:00andtheEndTimeto23:58:00.
Page 40
System Log Events
System Log Events

SystemLogEventslistseventsforcomponentsinthesystem.Thisinformation comesfromtheION_SystemLogdatabase.
TIP
For instructions on filtering and sorting columns and customizing the display, see Customizing and Navigating Interface Displays on page 22.
Viewing System Log Events

ToviewSystemLogEvents: 1. 2. SelectSystemLogEventsfromtheSystemSetuppane. Selectthesystemcomponentsforwhichyouwanttoviewevents(i.e.,servers, sites,devices). Iftherearenoeventsforaparticularsystemcomponent,thatcheckboxis unavailable.
Page 41
System Log Events
3. 4. 5.
Selecttheminimumprioritylevelofeventstobedisplayed(seebelowformore informationonprioritylevels). ClickModifytochangethedate/timefilterappliedtotheSystemEventsLog display.SeeSystemLogFilterSetuponpage 42. Toviewdetailsofanevent,doubleclickontheentryintheeventlog.
Priority Priorityclassifieswhattypeofeventhasoccurred.Thevaluecorrespondstothe severityoftheevent:thehigherthenumber,themoreseveretheevent. ThepriorityiscontainedintheION_SystemLogdatabaseasanumber.Inthe SystemEventsLogdisplay,theprioritylevelsaredisplayedastextstrings.The prioritynumbersaremappedtothetextstringsasfollows:

Diagnostic 0-5 Information 6-20 Warning 21-63 Error 64-191 Critical 192-255
Bydefault,theCutoffsetupregisterofLogInsertersSystemLogController moduleissetto192.Thismeansthatsystemeventswithaprioritylessthan192 arenottransferredtotheION_Datadatabaseandthereforecannotbeviewedin VistausingtheGlobalEventLogViewer.Ifyouwanttoviewlowerpriorityevents inVista,usetheaboveprioritymappingasaguidetosettheCutoffsetupregister toalowervalue(usingDesigner).
System Log Filter Setup

TheSystemLogFilterSetupdialogboxletsyouchangethedateandtimefilter appliedtotheSystemEventsLogdisplay. 1. 2. ClickModifytodisplaytheSystemLogFilterSetupdialogbox. Selectthetimerangebywhichyouwanttofilterfromthedropdownlist.Toset upacustomfilter,selectCustomDateRangethenusethedropdownlistsand arrowsintheSelectaDateRangedialogboxtospecifythestartandendofthe range. ClickOK.
3.
Page 42
Setting Up Large Systems
Setting Up Large Systems

Toperformbatchnetworksetupofdevices,createthefirstdeviceinManagement Console(seeAddingNetworkComponentsonpage 33)usingalogicalnaming scheme.Afteryoucreatethisfirstdevice,youcanthenuseittocreatemultiple duplicatedevicesandconfiguretheirproperties.
The Duplicate and Configure Interface
Scroll left Start & End spin box Duplicate and Configure area Scroll right
Hide/Show Columns area Table Editing area
NOTE
When table rows are filtered in the Duplicate and Configure tool, 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.
The Duplicate and Configure Area

TheDuplicateandConfigureareahasdifferentsectionsdependingonthetypeof deviceyouareduplicating. Ethernetdeviceshavethefollowingsections: ConfigureNames:Usethissectiontocreatetheduplicates. ConfigureTCP/IPAddresses:UsethissectiontocreateasequenceofIP addressestoassigntotheduplicatesaftertheyhavebeencreated.
Page 43
The Duplicate and Configure Interface
ConfigureTCP/IPPorts:Theportnumberusedintheoriginaldeviceis automaticallyassignedtoalltheduplicates.Ifrequired,usethissectiontoselect adifferentportnumberforallthedisplayeddevicesintheTableEditingarea (changesmadeinthisareaareappliedtoalldevices,includingtheoriginal). ConfigureUnitIDs:Thissectionisdisabledbydefault,sinceunitIDsdonot applytotypicalEthernetdevices.(Toenablethissection,youmustfirstsetup theTableEditingareasothattheUnitIDcolumnisvisible). Serialdeviceshavethefollowingsections: ConfigureNames:Usethissectiontocreatetheduplicates. ConfigureUnitIDs:UsethissectiontocreateasequenceofunitIDstoassignto theduplicatesaftertheyhavebeencreated. ConfigureSerialSites:Theserialsiteusedintheoriginaldeviceis automaticallyassignedtoalltheduplicates.Ifrequired,usethissectiontoselect adifferentserialsiteforallthedisplayeddevicesintheTableEditingarea (changesmadeinthisareaareappliedtoalldevices,includingtheoriginal). OPCdeviceshavethefollowingsections: ConfigureNames:Usethissectiontocreatetheduplicates. ConfigureOPCAddress:Usethissectiontocreateasequenceofaddressesto assigntotheduplicatesaftertheyhavebeencreated. ConfigureOPCSites:TheOPCsiteusedintheoriginaldeviceisautomatically assignedtoalltheduplicates.Ifrequired,usethissectiontoselectadifferent OPCsiteforallthedisplayeddevicesintheTableEditingarea(changesmadein thisareaareappliedtoalldevices,includingtheoriginal).
The Table Editing Area

WhenmakingconfigurationchangesintheDuplicateandConfigureinterface, thesechangesareappliedonlytotherowsthatarevisibleintheTableEditingarea. SeeCustomizingandNavigatingInterfaceDisplaysonpage 22forinstructions onfilteringandsortingdatainthetable.
NOTE
To discard your changes since 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).
Page 44
Creating Multiple Copies of a Device

Thissectiondescribeshowtoduplicateandconfiguredevices.
Step 1: Configuring the First Device

1. Addthefirstdeviceusingyourlogicalnamingscheme. Forexample,youcanuseaschemelikeFL1_PNL1A.CCT01tonamea devicethatisinstalledonthe1stFloorofthebuilding,electricalpanel1A, andCircuitbreaker#1.TypeFL1_PNL1AasthegroupnameandCCT01 asthedevicenamewhenyouconfigurethefirstdevice. 2. RightclickthedeviceyouwanttoduplicateandselectDuplicateand Configure.TheDuplicateandConfigureinterfaceappears.
Step 2: Configuring Names

IntheConfigureNamesarea,thedevicenameisdisplayed.Eachletterand numberisselectable.Agroupofnumbersistreatedasasingleentity.Forexample, inthenameMY8600theentitiesyoucanselectareM,Yand8600.Leading zeroesarealsosupported,soyoucansetsequencessuchas01,02,03or001, 002,003.
1.
Selectaletterornumberinthedevicename.TheStartboxdisplaysthe selectednumber/letter,whichisthestartvalue.Usetheupordownarrowin thespinboxtochangethestartvalue,orsimplytypeitinthebox. ClicktheupordownarrowontheEndboxedittherange,ortypetheendvalue inthebox.Tocleartherangeandstartover,clickRemoveParameters. Forletters,selectUpperCaseorLowerCase,dependingonwhetheryourequire uppercaseorlowercaseletters. Setexceptionsforindividualvaluesorarangeofvalues,ifrequired.Exceptions reducethenumberofnamescreated(i.e.,totalgeneratednamesminusthe exceptions).SeeSettingExceptionstoGeneratedSequencesonpage 46.
2. 3. 4.
Onceyouhavefinishedconfiguringnames,youcanduplicatethedevice.See Step3:DuplicatingtheDevice,below,formoreinformation.
Page 45
Example Forexample,ifyouselectthefirst1fromtheexamplenamingschemeandset theEndspinboxto2,twonamesaregenerated(theoriginal,plusoneduplicate). IfyouselectaletterandsetitsStartvaluetoAandtheEndvaluetoC,three namesaregenerated(theoriginal,plustwoduplicates). Thetotalnumberofgeneratednamesistheproductofthefirstrangemultiplied bythenext,andsoonuntilthelastrange,asindicatedinthefollowinggraphic.
The total generated names is the product: [2 x 3 x 10] = 60
Setting Exceptions to Generated Sequences TheExceptionsoptionappliestotheConfigureNamesandConfigureTCP/IP Addressessectionsonly. 1. Tosetexceptionstotherangeofgeneratedvalues,clickEdit(thisbuttonis unavailableuntilyouchangethenameorIPvalue).

List of current exceptions
2.
UsetheAddnumberorAddcharacter(asapplicable)spinboxtosetavalueto excludefromtherangeyouhavespecified,thenclickAdd.Repeattoset additionalvaluestoexclude.Tosetarangeofvaluestoexclude,selectAdd numberrangeorAddcharacterrange,thenusetheStartandEndspinboxesto settherangetoexclude. ClickAdd.Repeattosetadditionalrangesofvaluestoexclude.
Page 46
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.
UsetheRemovenumberorRemovecharacterspinboxtoremovetheexception thatwassetforagivenvalue(i.e.,putitbackinasanacceptablevalue).Usethe RemovenumberrangeorRemovecharacterrangespinboxestoremovethe exceptionthatwassetforarangeofvalues.ClickRemove.
Step 3: Duplicating the Device

Onceyouhavefinishedconfiguringnames,youarereadytoduplicatethedevice. ClickDuplicate.TheduplicateddevicesappearintheTableEditingarea.
Original device
Asterisks indicate pending changes that have not yet been saved.
ClickApplytosaveyourchangesandcontinueeditingdevices,clickOKtosave yourchangesandreturntoManagementConsole,orclickReverttoundounsaved changes. Duplicated Devices in Management Console
Duplicated devices are always disabled when they are added to Management Console
Step 4: Configuring Duplicated Devices

Seethefollowingsection,ConfiguringMultipleDevices,forinstructionson configuringotherpropertiesformultipledevices.
Page 47
Configuring Multiple Devices

Afteryouhaveduplicatedthedevices,youcanselectandconfigureanyorallof them. 1. IfyouhaveclosedtheDuplicateandConfigureinterface,selectthedevices youwanttoconfigurefromtheDevicesdisplaywindowinManagement Console.RightclickandselectConfigureSelectedDevices(thisoptionis onlyavailableifmultipledevicesareselected). TheConfigureSelectedDevicesinterfaceappears.Thisinterfacehasthesame layoutandcontrolsastheDuplicateandConfigureinterface;seeTheDuplicate andConfigureInterfaceonpage 43forinformation.
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.
2.
ScrolltotherightintheDuplicateandConfigureareatoviewtheConfigure TCP/IPAddresses,UnitIDs,PortsandSitessectionsoftheinterface (dependingonthetypeofdevicebeingconfigured).Configurethese parametersasdescribedinConfiguringAddresses,Ports,UnitIDsandSites onpage 49thenclickConfigureatthebottomoftheapplicableinterfacesection.
NOTE
Configuration changes only affect the devices that are currently displayed in the Table Editing area. Use the column sorting and filtering features, described in Customizing and Navigating Interface Displays on page 22, to control which devices are displayed in the table. If you want to apply the changes to all devices, clear any filtering before making the changes.
3.
ClickApplytosaveyourchangesandcontinueworkingorclickOKtosave yourchangesandreturntoManagementConsole.
NOTE
If you changed the name of one or more devices, a warning displays with a list of devices that will be renamed. If data for those devices already exist in the ION_Data database and you still proceed with the renaming, then the existing data associated with the old device name is lost (orphaned).
ClickContinuetoproceedorCanceltogobackandeditthedevice configuration. 4. Whenyouhavefinished,clickOKtosaveyourchangesandreturnto ManagementConsoleorclickCanceltodiscardyourchanges. IfyouclickCancel,adialogboxpromptsyouiftherearepending(unsaved) changeswhenyouclickCancel.ClickYestodiscardthechangesandreturnto ManagementConsole,orNotoreturntotheconfigurationwindowand continueediting. Ifinappropriatevalues(suchasadevicethatisrenamedwiththesamenameas anotherexistingdevice)areencountered,amessagedisplayswitherrordetails. Youcannotsavetheconfigurationchangesuntilyouhavecorrectedtheerrors.
Page 48
Configuring Addresses, Ports, Unit IDs and Sites

Thefollowingsectionsdescribehowtoconfigureaddresses,ports,andunitIDs.
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.
Configuring TCP/IP Addresses 1. SelectthesectionoftheIPaddressthatyouwanttoconfigure.TheStartbox displaystheselectednumber/letter,whichisthestartvalue.Usetheupor downarrowinthespinboxtochangethestartvalue,orsimplytypeitinthe box. ClicktheupordownarrowontheEndboxedittherange,ortypetheendvalue inthebox.Tocleartherangeandstartover,clickRemoveParameters. Setexceptionsforindividualvaluesorarangeofvalues,ifrequired.Exceptions reducethenumberofaddressescreated(i.e.,totalgeneratedaddressesminus theexceptions).SeeSettingExceptionstoGeneratedSequencesonpage 46. ClickConfigureatthebottomoftheConfigureTCP/IPAddressessection.
2. 3.
4.
Configuring Unit IDs Thefollowinginstructionsapplytoserialdevices(andEthernetdevicesthat requireaunitID). 1. 2. 3. UsetheupordownarrowintheStartspinboxtochangethestartvalue,or simplytypeitinthebox. ClicktheupordownarrowontheEndboxedittherange,ortypetheendvalue inthebox. ClickConfigureatthebottomoftheConfigureUnitIDssection.
NOTE
To edit the unit ID of an Ethernet device, you must first add the Unit ID column to the table in the Table Editing area.
Configuring Sites 1. 2. Fromthedropdownlist,selectthesiteyouwanttousefortheselectedserial orOPCdevices. ClickConfigureatthebottomoftheConfigureSitessection.
Page 49
Editing Duplicated Device Information
Configuring Ports 1. 2. Fromthedropdownlist,selecttheportyouwanttousefortheselected Ethernetdevices. ClickConfigureatthebottomoftheConfigurePortssection.

Thefollowingsectionsdescribehowtoquicklyeditthepropertiesofduplicated devicesinthetableeditingarea.
Copying Device Information from a Spreadsheet

Sometimesdevicenamesdonotfollowanyparticularnamingpattern.Inthiscase, youcanusethecopy/pastefunctiontoapplyconfigurationchangesdirectlytothe TableEditingarea. First,youneedtoaddanewdeviceinManagementConsole,thencreateasmany duplicatesofthedeviceasthequantityofitemsyouarepasting. IfyouhaveaMicrosoftExcelspreadsheetthatcontainsalistofthesedevicesto addtoManagementConsole,youcanusetheConfigureNamesareatocreate duplicatesofthatdevicetype,thenusetheTableEditingareatocopyandpaste thedevicepropertiesfromtheExcelspreadsheet. Example: Copy and Paste 20 Ethernet Devices from Excel 1. 2. MakesurethenamesintheExcelspreadsheetconformtothenaming convention[Group].[DeviceName]. AddthefirstdeviceandsetupitspropertiesinManagementConsole.Youcan assignitasimpledevicenamesuchasA.B1sinceitwillbeoverwrittenwhen thevaluesarecopiedandpastedfromExcel.SettheEnabledpropertytoNo (thismakessurethatManagementConsoledoesnotattempttoconnecttothe device). ClickOKtoaddthedevice. RightclickthedeviceandselectDuplicateandConfigure. Selectthe1intheConfigureNamesbox,thenusetheEndspinboxtosetthe valueto20. IntheHide/ShowColumnsarea,clearthecheckboxofallnoneditablecolumns tohidethosethatcontaingrayedoutvalues.Alsohidethecolumnsyoudonot wanttopasteoverorthosethatarenotincludedintheExcelspreadsheet. OntheExcelspreadsheet,arrangethecolumnssotheymatchtheorderofthe columnsontheTableEditingarea.HideallcolumnsontheExcelspreadsheet exceptthosecorrespondingtocolumnsontheTableEditingarea. SelectthecellsinExcelandcopythem(CTRL+C).
3. 4. 5. 6.
7.
8.
Page 50
9.
OntheTableEditingarea,clickonthefirstcellundertheNamecolumntoselect it,thenpastethecontentsoftheclipboard(CTRL+V).
10. ClickApplytosaveyourchangesorclickOKsaveyourchangesandreturnto ManagementConsole.
Using Find and Replace to Edit Device Information

UsetheFindandReplacefeaturetomodifymatchingcharactersinthedevice namesorinanyothereditablecolumnsonthedevicetable.TheFindandReplace featuredoesnotworkonreadonlycolumns. 1. 2. 3. 4. RightclickthedevicetableandselectFindandReplace(orpressCTRL+H). TypethecharactersyouwanttosearchforintheFindbox.Donotusewildcard characters(*).Notethatthesearchiscasesensitive. Findincolumnlistsallavailablecolumns.Selectthecolumnyouwanttosearch in. IntheReplacebox,typethecharactersyouwanttousetoreplacethecharacters intheFindbox.Ifyouwanttodeletecharactersfromacolumnvalue,leavethe Replaceboxblank. ClickPreviewtolistthesearchresultsinthetable.TheReplacewithcolumn displaysthenewnameorvalueresultingfromtheFindandReplaceoperation. UsethecheckboxintheSelectcolumntoselecttherowsforwhichyouwantto changevalues.ClickSelectAlltoselectalltheitemsorClearSelectedtoclear all. ClickApplytosaveyourchangesorCanceltodiscardyourchanges ClickOKtosaveyourchangesandclosethedialogbox.
5. 6.
7. 8.
Page 51
Page 52
Management Console Tools

ManagementConsoletoolsareadditionalprogramsthathelpyoumanageand monitoryourIONEnterprisenetwork.
In This Section
Introductiononpage 54 UserManageronpage 55 LicenseManageronpage 60 ReportingConfigurationManageronpage 61 EventWatcherManageronpage 62 DiagnosticsVieweronpage 66 DeviceUpgraderonpage 71 RemoteModemSetuponpage 74 VirtualProcessorSetuponpage 75 TimeofUseEditoronpage 80
Page 53
Introduction
Introduction
ThefollowingprogramsareavailableinIONEnterprise,andcanbestarted throughtheManagementConsolesToolsmenu: UserManagerallowsyoutoconfigureIONEnterpriseuserloginnames,access levelsandpasswords. LicenseManagerallowsyoutoupgradeyoursoftwarelicensetoprovide additionaldevice,clientandsoftwaresupport. ReportingConfigurationManagerallowsyoutosetupoptionsforWeb Reporter. DatabaseManagerallowsyoutoperformandschedulemaintenancetaskson yourIONEnterprisedatabases.SeeDatabaseManageronpage 255. Designerallowsyoutoconfiguredevicesandaddcustomfunctionalityto them;seeDesigneronpage 195. DiagnosticsViewerprovidesdetailedrecordsofallsystemandnetworkevents aswellascommunicationstatesandproblems. DeviceUpgraderallowsyoutouploadnewfirmwaretonetworkmetersor devices. RemoteModemSetupallowsyoutoconfiguredialupmodemsthatwillbe usedatremotepowermanagementnetworks. IONVirtualProcessorSetupallowsyoutoconfiguretheIONVirtual ProcessorServiceforuserprogrammedfunctionality. ModbusDeviceImporterallowsyoutoaddModbusdevicestotheION Enterprisenetwork;seeModbusDeviceImporteronpage 277. EventWatcherManagerallowsyoutoseteventconditionstoreportonand linkthoseconditionstodevices. TimeofUseEditorallowsyoutodefineatimeofuseschedulethatisusedby selectedreportssuchasEnergyandDemand. Commands for Optional Components TheUpdateOPCServerandPQDIFExportercommandsappearintheTools menuiftheseoptionalcomponentswerepurchasedwithIONEnterprise(or activatedlaterusingtheappropriateupgradesoftwarelicense).SeetheOPC ServerAssistantandPQDIFExporterdocumentationformoreinformationon thesefeatures.
Page 54
User Manager
User Manager
UserManagerallowsyoutoaddusersandedituserinformation,suchas passwords,accesslevel,andorganizationalinformation.YoucanalsouseUser ManagertodefinegroupsofusersforuseinWebReportersubscriptions. YoumusthavesupervisorlevelaccesstouseUserManager,otherwisethemenu optionisunavailable.
Access Levels
Access Level Supervisor (5)
YES YES YES YES YES YES YES
Page 55
Observer\ View Only (1)
Controller (3)
YES YES YES YES
Type of Operation Allowed by Default

View Vista or Designer diagrams Acknowledge alarms1 Trigger events1 Connect/disconnect sites or devices Modify network configuration (using Management Console) Edit Vista or Designer diagrams Administer software security (i.e., add users)
1
YES
YES YES
YES YES YES YES YES
Supervisors can configure Vista objects (i.e., control objects or the global event log viewer) to allow different access levels to perform different actions (i.e., trigger events or acknowledge alarms). See Customizing a Diagram Object on page 133 for more information on configuring access levels for Vista objects.
Starting User Manager

1. 2. StartManagementConsole.Loginusinganaccountwithsupervisorlevel access. SelectTools>UserManager.
TIP
You can customize the User Manager display by filtering and sorting. For instructions on using these features, see Customizing and Navigating Interface Displays on page 22.
Operator (4)
User (2)
Users
Symbols Used in the Updated Column ThefollowingsymbolsareusedintheUpdatedcolumntodisplaythestatusof informationinarow:

* ! +
Information in the row has been modified since it was last saved. There is an error in the information in the row. The row is new since the user or group information was last saved.
Users
UsetheUserstabtoview,addandeditusersanduserinformation.Information thatisrequiredbutismissingorincorrectismarkedbyanexclamationmark .
List of users
Edit User Account section
Available access levels
Message area
Adding Users
1. 2. ClickNew.AnewrowappearsinthelistofusersandthefieldsintheEdit UserAccountsectionareempty. Entertheuserinformation(usernameandpasswordarerequired;other informationisoptional):
Page 56
Users
Username:Typeausernameforthenewuser(maximumlength:50 characters;nospacesallowed). Password:Typeapasswordforthenewuser(maximumlength:50 characters;nospacesallowed). ReenterPassword:Reenterthepasswordyoutypedinthepasswordfield. Anexclamationmarkappearsbesidethisfieldunlessthecontentofthetwo passwordfieldsmatches. AccessLevel:Selectanaccesslevelfortheuser.SeeAccessLevelson page 55foranoutlineofthedifferentaccesslevelsandtheirpermissions. FirstName:Typetheusersgivenname. LastName:Typetheusersfamilyname. Organization:Typetheusersorganization. BusinessEmail:Typeabusinessemailaddressfortheuser. MobileEmail:Typeamobileemailaddressfortheuser. 3. ClickApplytosavethechangesorclickOKtosavethechangesandexitUser Manager.
DuringtheIONEnterprisesoftwareinstallation,twodefaultusernames(guest andsupervisor)arecreated,bothwithadefaultpasswordof0(zero).Since boththeseusernameshavesupervisorlevelaccess,thedefaultpasswordshould bechangedortheaccountsremovedafteryouaddanewuserwithsupervisor levelaccess.
Changing User Information

1. 2. Selecttheusernameassociatedwiththeinformationyouwanttochange. TypethenewinformationintheEditUserAccountsectionoftheUserstab. Afteryoueditausersinformation,anasteriskappearsbesidethatuserinthelist ofusersuntilyouclickOKtosavetheinformation. ClickApplytosavethechangesorclickOKtosavethechangesandexitUser Manager.
3.
Deleting a User
1. SelecttheusernameoftheuseryouwanttodeletethenclickDelete.Therow disappearsfromthelistofusers.Youcannotdeletetheuseraccountyouare currentlyloggedinwiththeDeletebuttonbecomesunavailable.
NOTE
You cannot use the Revert button to undo a deletion. To undo a deletion, click Cancel to exit out of User Manager without saving your changes.
2.
ClickOKtosaveyourchangesandexitUserManager.
Page 57
Groups
Groups
UsetheGroupstabofUserManagertodefinegroupsofusers.Groupscanbeused todetermineaccesstoreportsinWebReporter.Informationthatisrequiredbutis missingismarkedbyanexclamationmark .
List of groups
Edit User Groups section
Defining Groups
1. 2. 3. 4. 5. OntheGroupstab,clickNew.Anewrowappearsinthelistsofgroups. IntheEditUserGroupsectionofthetab,enterthename(required)and descriptionofthegroup. Toaddausertotheselectedgroup,selecttheusernamefromtheUserslistand clicktherightarrowbutton . Toremoveauserfromtheselectedgroup,selecttheusernamefromthe MembersOflistandclicktheleftarrowbutton . ClickApplytosaveyourchangesorclickOKtosaveyourchangesandexitUser Manager.
Page 58
Groups
Changing Group Information

1. 2. Selectthegroupassociatedwiththeinformationyouwanttochange. TypethenewinformationintheEditUserGroupsectionoftheGroupstab.Use therightandleftarrowbuttonstoaddorremoveusersfromtheselectedgroup, asneeded.Afteryoueditagroupsnameordescription,anasteriskappears besidethatgroupinthelistofgroupsuntilyouclickOKtosavetheinformation. ClickApplytosaveyourchangesorclickOKtosavethechangesandexitUser Manager.
3.
Deleting Groups
Todeleteagroup,selectthegroupfromthelistandclickDelete.
NOTE
You cannot use the Revert button to undo a deletion. To undo a deletion, click Cancel to exit out of User Manager without saving your changes.
Page 59
License Manager
License Manager
Foradditionaldeviceorclientusersupport(e.g.,Vistaclients)foryourION Enterprisesystem,ortoaddOPCand/orPQDIFoptions,ordertheappropriate licensefromSchneiderElectric. Whenyoureceiveyournewlicense,useLicenseManagertoupgradethenumber ofsupporteddevicesandclientusersinyoursystem: 1. 2. LogintoManagementConsole. ClickTools>LicenseManager.TheLicenseManagerdialogboxappears. Thecurrentproductkeynumber,numberofdevicesinthesystem,and maximumnumberofdevicessupportedarelistedintheSystemInfosection. 3. TypethenewproductkeyintheProductKeyfield.ClickOK.
TheSystemInfosectionliststheupdatedsupportinformationfromthenewly activatedproductkey.Ifthenewkeysupportsadditionalfeaturesoroptions,these aremadeavailableimmediately,withoutrestartingManagementConsole.
Page 60
Reporting Configuration Manager
Reporting Configuration Manager

UsetheReportingConfigurationManageroptionintheToolsmenutoconfigure optionsforWebReportersuchasthedatabasetoreportonandsubscription deliveryoptions. 1. 2. OpenManagementConsoleandselectTools>ReportingConfiguration Manager.TheReportingConfigurationdialogboxappears. SelecttheReportstabtoconfiguregeneralreportingoptions: FromthedropdownlistintheReportsDatabasesection,selectthedatabase onwhichyouwanttorunreports.Onlythosedatabasescompatiblewith WebReporterarelisted. UsethesliderintheReportTimeoutsectiontosetthetime(inseconds)after whichWebReporterstopstryingtocompleteareportgenerationtask. 3. SelecttheSubscriptionstabtoconfiguresettingsrelatedtoreportsubscriptions: SMTPServer:Typethenetworkservernamefromwhichthereport subscriptionsareemailed. FromDisplayName:Typethenamethatyouwanttoappearinthe Fromfieldofanemailedreport. FromEmailAddress:Typetheemailaddressthatyouwanttoappearin theFromfieldoftheemailedreport. DefaultOverwriteExistingFileSetting:Selectthecheckboxtosetthe defaultsettingfortheOverwriteExistingFilecheckboxthatappearsin theSubscriptionsdialogboxwhenyouselectFileshareforthe subscriptionDeliveryMode.Ifyouselectthischeckbox,theexistingreport isoverwrittenbydefault.Ifyouclearthischeckbox,thenewreportisgiven auniquefilenameandtheexistingreportisnotoverwritten. 4. ClickOKtosaveyourchanges.
Page 61
Event Watcher Manager
Event Watcher Manager

TheEventWatcherManagerdefineseventsfortheOnEventselectioninreport subscriptions.SeeCreatingReportSubscriptionsonpage 188formore informationonreportsubscriptions. TheEventWatcherManagerinterfaceconsistsoftwotabs: EventWatchers:Aneventwatcherlinksadeviceorgroupofdevicestothe conditionsdefinedinatemplate. Templates:Atemplatedefinestheconditionsthatmakeupanevent.
TIP
For instructions on using filtering, sorting, and column selection to customize the Event Watcher Manager interface, see Customizing and Navigating Interface Displays on page 22.
Opening Event Watcher Manager ToaccessEventWatcherManager,selectTools>EventWatcherManagerin ManagementConsole. Symbols Used in the Updated Column ThefollowingsymbolsareusedintheUpdatedcolumntodisplaythestatusof informationinarow:
* ! +
Information in the row has been modified since it was last saved. There is an error in the information in the row. The row is new since the event watcher or template information was last saved.
Page 62
Creating a Template
Creating a Template
Beforeaddinganeventwatcher,youmusthaveatemplatethatdefinesthe conditionstobewatched.Youcanuseoneofthedefaulttemplatesorcreateyour own.UsetheTemplatestabtodefineandedittemplates.
List of templates
Template editing area
Template Conditions Area
EventWatcherManagercomeswithdefaulttemplatesthatcannotbemodified. Youcancreatecustomtemplatesifthedefaulttemplatesdonotprovidewhatyou need. Todefineacustomtemplate: 1. 2. 3. 4. ClickNewinthetoprightcornerofthetab.Anewrowappearsinthemain tableforthenewtemplate. Typeanameforthetemplate.Typeadescriptionforthetemplateifdesired. UsetheTemplateConditionssectiontosettheconditionstobewatched.See UsingtheTemplateConditionsSection,below. ClickApplytosaveyourchanges,clickOKtosaveyourchangesandexitEvent WatcherManager,orclicktheEventWatcherstabtosetupaneventwatcher.
Page 63
Adding an Event Watcher
Using the Template Conditions Section

Usethissectionoftheinterfacetoconfiguretheconditionthetemplatewatches for. 1. Addacondition: Toaddaconditionfromtheeventlog,clickSelectfromEventLog.The SelectEventLogLinesdialogboxappears.Toselectanevent,clickonthe boxesattheleftofthetabletoselectacheckbox.Clickonthecheckbox againtoclearthecheckmark.ClickOKtoreturntotheTemplatestab. Toaddaconditionwithoutselectingfromtheeventlog,clickNew.Anew rowappearsinthetableforthenewcondition.
NOTE
It is recommended that you use Select From Event Log to add conditions. This ensures that the syntax is correct. If the syntax is not correct, the event watcher will not work. Conditions only appear in the Select Event Log Lines dialog box after they have occurred in the system.
2.
Selecttheparametersyouwanttoincludeintheconditionbyselectingor clearingthecheckboxesbelowtheTemplateConditionstable.Theavailable parametersare:Priority,Cause,CauseValue,Effect,EffectValue.Youmust includeatleastoneparameter.Ifyouselectmultipleparameters,theevent watcheronlyactivateswhenallparametersaremet.
The Logic of the Template Conditions TheconditionswithinarowoftheTemplateConditionstablemustallbetruefor theconditiontobemet.Forexample,ifyouhavearowwithaPriorityofgreater than220andanEffectValueofDisturbance,bothofthesemustbemetforthe conditiontobetrue.Ifyouhavemultiplerowsinthetable,theconditionismetif anyoftherowsaretrue.ForexampleifyouhavearowwithPrioritygreaterthan 220andarowwithanEffectValueofDisturbance,theconditionismetifeitherof thesearetrue.
Deleting and Reverting

Todeleteatemplatecondition,selecttheconditionfromtheTemplateCondition tableandclicktheDeletebuttonintheEdit<Template>section.Todeletea template,selectthetemplatefromthemaintableandclicktheDeletebuttoninthe toprightcornerofthetab. Toundochanges,clickRevert.

Toaddaneventwatcher,youneedatemplate.Youcanuseoneofthedefault templatesordefineyourown(seeCreatingaTemplateonpage 63).
Page 64
List of Event Watchers
Event Watcher Editing Area
List of devices in the system
1.
ClickNewtoaddaneweventwatcher.Anewrowappearsinthemaintable forthenewevent.UsetheEventWatcherEditingAreatodefinetheevent watcher. Typeanamefortheeventwatcher. SelectthetemplateyouwanttousefromtheTemplatedropdownlist. Typeadescriptionoftheeventwatcherifdesired. FromtheDevicestable,selectthedevicesyouwanttoincludeintheevent watcher.Clickthecheckboxestotheleftsideofthedevicestoselectorcleara device.
2. 3. 4. 5.
NOTE
Checking Select All will include any Query Server, Log Inserter or Virtual Processor instances in the system. It also includes any devices or software nodes added in the future.
6.
ClickApplytosaveyourchanges,clickOKtosaveyourchangesandexitEvent WatcherManager,orclicktheTemplatestabtoeditthetemplates.
Deleting and Reverting

Todeleteaneventwatcher,selecttheeventwatcherfromthetableandclick Delete. Toundochanges,clickRevert.
Page 65
Diagnostics Viewer
Diagnostics Viewer
DiagnosticsVieweristheIONEnterprisetoolfortroubleshootingnetwork communicationsproblemsandrelatednetworkerrors.
Starting Diagnostics Viewer

1. 2. StartManagementConsoleandlogin. ClickTools>System>DiagnosticsViewer.
TIP
For instructions on using filtering, sorting, column selection and pin/unpin to customize the Diagnostics Viewer display, see Customizing and Navigating Interface Displays on page 22.
Pin/Unpin button
Diagnostics tabs Dynamic Filter field
Expand/collapse tree
Navigation pane
Diagnostics information pane
Refresh Tree View IfyouaddanewdeviceinManagementConsolewhileDiagnosticsVieweris open,youcanrefreshthetreeview(todisplaythenewdevice)bycollapsingthen expandingtherootnodeofthetree(i.e.,IONEnterpriseDiagnostics).
Navigation Pane
Diagnosticsinformationisgroupedasfollows: ServiceDiagnostics:ContainsdiagnosticsinformationforcertainION Enterpriseservices(IONNetworkRouterService,IONSiteServiceandIONLog InserterService). CommunicationDiagnostics:ContainsdiagnosticsinformationfortheION Enterprisesites,hardwaredevicesandsoftwarenodes. Selectaniteminthenavigationpanetodisplayitsdiagnosticsinformation.
Page 66
Service Diagnostics
Diagnostics Information Pane

Thediagnosticsinformationpanedisplaysdetaileddataaboutthestateofyour powermonitoringsystemanddevices.
Service Diagnostics
ServiceDiagnosticsrecordscommunicationproblemsandsimilarevents occurringwithIONEnterprisesoftwarecomponents.
Communication Server Diagnostics

Informationaboutthecommunicationsserverisarrangedinthesetabs: ConsoleMessageslistsallIONNetworkRouterServiceandIONSiteService consolemessagesforthecurrentsession.
TIP
The blank area below the Description column header is a dynamic filter field. Type the wildcard character (*) in front of the text you want to search (for example, *warning). The diagnostics information pane automatically displays only those records that match the text you typed in the box.
ConnectionStatusdisplaysthecurrentstatusofIONEnterprisesoftware componentsconnectedtoNetworkRouter. TreeStatesdisplaystheIONtreestatusofallnodes(hardwaredevicesand softwarenodes).
Log Inserter Diagnostics

TheLogInserterdiagnosticsinformationpaneissplitintotwosections.Thetop section(SelectNodespane)containstheavailablenodes,whilethebottomsection containsthenodedetails. Select Nodes to Display IntheSelectNodespane,selectthecheckboxbesideanodetodisplayits diagnosticsinformation.Clearthecheckboxtohidethatnodesdiagnostics information.
TIP
If there are many nodes and you want to display only a few of them, right-click the Select Nodes area then select Clear All. Select only the nodes you want to display. To display all the nodes again, right-click the Select Nodes area and select Select All.
Page 67
Communications Diagnostics
Node Details Thenodedetailsareorganizedinthesetabs: NodeInformationdisplaysLogInserterstatisticsfortheselectednode(s). NodePerformancedisplaysaggregatelogperformancestatisticsfortheselected node(s). LogPerformancedisplayslogperformancestatisticsforeachlogintheselected node(s).
CommunicationsDiagnosticsprovidesdiagnosticsinformationforsitesand devicesconnectedtotheworkstation.
Site Overview
Diagnosticsinformationforthesitesarecontainedinthesetabs: SiteSummarydisplayscommunicationsstatisticsforeachsite. NetUserStatusdisplaysthenumberofIONprogramscurrentlyintheION NetworkRouterServicequeue(awaitingprocessing)andthetotalnumberof IONprogramsalreadyprocessed.
NOTE
Requests and responses transmitted between the ION Enterprise components are referred to as ION programs.
Site/Device Diagnostics
Diagnosticsinformationforsitesanddevicesaresummarizedinthesetabs: CommunicationStatusdisplayserrorratesandconnectionstatisticsforthe selectedsiteordevice.Thefollowinginformationisavailablefromthe CommunicationsStatustab:
Column
Node Requests Responses Total Errors Total Error Rate Sliding Error Rate Average Response Time Last Response Time
Description
The device (or software node) name. The number of communications requests transmitted to the meter. The number of successful responses received. The total number of errors. The ratio of Total Errors to Requests. The error rate in the last 64 requests. This can indicate a trend in communications performance. Average time in seconds for the meter to respond. The last response time, in seconds.
Page 68
Column
Timeouts Bad Checksums Broken Connection Errors Incomplete Frames Bad Frames Hardware Errors Misc Errors
Description
The number of timeout errors. A timeout occurs when no data is received in response to a request. The number of bad packets received, i.e., those that failed the errordetection checksum. Number of times the connection was lost to the meters on a site. The number of incomplete packets received, i.e., those that did not have all the expected bytes. The number of received packets that had an internal error. Number of errors reported by the computers communication hardware. Number of other errors that do not fit any of the above descriptions.
SiteStatusdisplayssitestatisticssuchasconnectionstatusandtotals. PollingStatusdisplaysthenumberofprogramscurrentlyintheIONSite Servicequeue(awaitingprocessing)andthetotalnumberofprogramsalready processed.
Communication Status vs. Site Status

Thissectionexplainsthedifferencebetweenthestatisticsprovidedonthe CommunicationStatustabandthoseontheSiteStatustab. TotalErrorsintheCommunicationStatustabisanIONSiteServicederived statistic,whileBadResponsesintheSiteStatustabisaclientderivedstatistic. Toexplainthisdifference,considerasituationwhereadirectsiteisexperiencing timeouts.Communicationswiththedeviceisattemptedaccordingtotwo parameters:ConnectAttempts(anadvancedsitepropertyintheManagement Console)andMaximumAttemptsMultiple(anadvanceddevicepropertyinthe ManagementConsole).Multiplyingthevaluesofthesetwopropertiesdetermines thenumberofattemptsmadetoreestablishcommunicationswiththedevice. Forinstance,ifConnectAttemptsissetto1andMaximumAttemptsMultiple issetto3,thedevicewillgoofflineafter3attempts(i.e.,1x3). TheTotalErrorsstatisticincreasesbyoneeverytimeIONSiteServicedetectsa timeout.However,theBadResponsesstatisticonlyreportsaproblemifthe devicegoesoffline(i.e.,whenConnectAttemptsandMaximumAttempts Multipleareexceeded). Usingthepreviousexample,considerthecasewherefourtimeoutsoccurredand thedevicewentoffline.Inthiscase,TotalErrorsincreasesbyfour,whileBad Responsesonlyincreasesbyone.Ifonlytwotimeoutsoccurred,TotalErrors wouldincreasebytwo,whileBadResponseswouldnotchange.
Page 69
Additional Commands
Additional Commands
Thefollowingsectionsdescribeadditionaldisplayoptionsandshortcutmenus availableinDiagnosticsViewer.
Diagnostic Details
Inthetabsonthediagnosticsinformationpane,doubleclickarowtodisplayits DiagnosticDetailsscreen.Thisdisplaysthediagnosticinformationforthe selecteditemonly. UsethePreviousandNextbuttonstoviewthedetailsofotherrowsinthattabof thediagnosticsinformationpane. Tocopyinformationtotheclipboard,selecttherowsyouwanttocopy,thenpress CTRL+C.
Diagnostics Information Pane Shortcut Menu Options

Rightclickinthediagnosticsinformationpanetodisplayashortcutmenu.The followingtablelistsallthecommandsavailable(thoughnotalldisplaysprovide allthecommandslisted):
Right-click Option
Update Reset Copy All
Description
Refreshes the information in the diagnostic table. Resets the information in the diagnostic table (not available in the Communications Server Diagnostics display). Copies all selected information to the clipboard. Enabled by default, this option is only available in the Console Messages tab of the Communications Server Diagnostics display. This 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 Diagnostics Viewer refreshes). Displays the Options dialog box where you can change the diagnostics refresh rate. Note that changing this value can affect ION Enterprise performance.
Auto Scroll
Options
Page 70
Device Upgrader
Device Upgrader
UseDeviceUpgradertoupgradethefirmwareononeormoreIONmetersofthe sametypeinasinglesession.Supervisorlevelaccessisrequiredtoupgrade devices. Toreducetheriskofupgradeerrors,makesurethecomputerpoweroptionisset toalwaysstayonandscreensaversaredisabled.Ifyouareusingalaptop,plugit intoawalloutletandsetthepoweroptiontodonothingifthelidisclosed.
CAUTION
If you have data in the meter you want to keep, make sure you upload and/or save it before upgrading. Stored data in the meters memory is completely erased during a firmware upgrade. This data includes waveforms, data recorders, min and max values, and integrator values (e.g., kWh).
Using Device Upgrader

1. 2. 3. 4. 5. Obtaintheapplicableupgrade(.upg)filesforyourdevicefromthewebsiteor fromTechnicalSupport. Savethefilesinafolderaccessibleonthecomputer. StoptheIONLogInserterServiceandIONVirtualProcessorService. StartManagementConsole. ClickTools>System>DeviceUpgrader.Typeyourusernameandpasswordin theloginprompt.Adialogboxdisplayswithrecommendationsandwarnings regardingtheupgradeoperation.Afterreadingtherecommendationsand warnings,clickOK. Ifyouneedtoimplementanychangesbecauseoftherecommendationsand warning,closeDeviceUpgrader,makethechangesthenreopenDevice Upgraderandcontinue. TheDeviceUpgraderwindowappears.
Page 71
Using Device Upgrader
6. 7. 8. 9.
Selectthedevicetypeofthedevice(s)youwanttoupgradefromtheList DevicesofTypebox. Selectthename(s)ofthedevice(s)youwanttoupgradeintheSelectDevicesto Upgradebox. IntheSelectRevisionsection,clickSelectFile.Locateandselecttheupgrade (.upg)filethatyousavedinstep2,thenclickOpen. SelectorcleartheSave/Restoreframeworkcheckbox(selectedbydefault).If selected,thiskeepsacopyofyourcurrentframeworktemplateduringthe upgrade.Afterthefirmwareupgradeiscomplete,DeviceUpgraderrestores yourframeworktemplate.
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 that you have downloaded), clear Save/Restore framework.
10. Ifyouareupgradingmultipledevices,specifyintheFailureHandlingareahow theDeviceUpgraderrespondstoanunsuccessfulupgrade: SelectHaltAfter,thenenteranumberintheboxtospecifyhowmany attemptsDeviceUpgradershouldmakebeforestoppingduringafailed upgrade.Bydefault,theutilityissettostopafterthefirstfailedupgrade. SelectIgnoreAlltoattempttoupgradealloftheselecteddevicesregardless ofthenumberofdevicesthatfailtoupgrade. 11. ClickUpgradetoupgradetheselecteddevices. TheUpgradeStatusboxshowsthestagesoftheupgradeprocess.The completedprogressbarindicateswhatpercentageoftheupgradeiscomplete. EachcompletedupgradeislistedintheUpgradeStatusbox. 12. RestarttheIONLogInserterServiceandIONVirtualProcessorService.
Page 72
Firmware Upgrade Error Codes
Firmware Upgrade Error Codes

Thefollowingtabledescribesthevariouserrorcodesthatmayoccurwhenyou upgradeyourdevicesfirmware.
Error Code
0, 1, 2, 3, 4, 5, 6, 7, 8, or 9 100 101, 102, 103, 104, 105 106 107 108 109 110 150
Description
Indicates a negative acknowledgment to a request. Contact Technical Support for assistance. Device timed out while downloading firmware. Probable causes: a) poor communication or b) the device stopped functioning. Indicates a bad response to a request. Contact Technical Support for assistance. Device Upgrader was unable to prepare the device to accept new firmware. Try to upgrade the device again. Contact Technical Support for assistance if the problem persists. Device Upgrader was unable to verify the device's new firmware. Try to upgrade the device again. Contact Technical Support for assistance if the error persists. Device Upgrader was unable to download a firmware packet. Try to upgrade the device again. Contact Technical Support for assistance if the error persists. Device Upgrader was unable to retrieve the device framework. Probable causes: a) time out or b) device not functioning. 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. 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. 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. The information in the file <device_name>.conf is corrupted or unrecognizable by the Device Upgrader. Contact Technical Support for assistance. Device Upgrader was unable to restore the device setup. Probable causes: a) time out or b) device not functioning. 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.
151, 155
152 154 156
Page 73
Remote Modem Setup
Remote Modem Setup

UseRemoteModemSetuptopreconfiguredialupmodemsthatwillbeconnected tometersatremotelocations.Hardwarebasedandsoftwarebased(WinModems) modemsaresupported. RemoteModemSetupprovidesaccesstoadatabasethatcontainsconfiguration dataforavarietyofmodemsyoucanpickfrom.RemoteModemSetupalso providesdirectaccesstoyourmodemsoyoucancustomizesettingsand troubleshootitsoperation. Preliminary Setup Followtheinstructionsinyourmodemsdocumentationtosetupandconnectthe modemtooneofyourcomputersserialports.SelectaportthattheIONEnterprise CommunicationsServerisnotusing.
Using Remote Modem Setup

1. 2. 3. StartManagementConsole. ClickTools>System>RemoteModemSetup.TheRemoteModemSetup dialogboxappears. SetthePorttotheserialcommunicationsportthatthecomputerusesto communicatewith(andsetup)themodem.SettheBaudRatetomatchthe modemsbaudrate.
NOTE
To reduce possible communication issues, set the computer, modems and meters to the same baud rate.
4.
Setthefollowingpropertiesfortheremotemodem: SelectthetypeofmodemfromtheTypebox. SettheSiteBaudRate. Tosetthemodemtoanswerafteraspecifiednumberofrings,selectAuto Answer,thentypetheappropriatenumberintheNumberofRingsbox. Tosavethemodemconfigurationdatainthemodemsonboardmemory, selectStoreProfile.Thisfeatureallowsthemodemtoreverttothesaved settingsafterapowerfailure.ClearStoreProfiletodisablethisfeature. Toturnonthemodemsinternalspeaker,selectSpeakerOn,thenselecta settingfromtheVolumelist.ClearSpeakerOntodisablethisfeature.
5.
ClickSendtosavethesettingstothemodem. IfthereareDIPswitchsettingsrequiredforthemodemthatisbeingconfigured, amessagedisplayswithinstructionsonwhichswitchestoturnonoroff.Setthe DIPswitchesonthemodemasinstructed.
Themodemisnowreadytobeusedattheremotepowermonitoringsite.
Page 74
Virtual Processor Setup
Virtual Processor Setup

TheVirtualProcessor(VIP)istheIONEnterpriseservice(IONVirtualProcessor Service)thatprovidescoordinateddatacollectionandaggregation,control,and mathematicalanalysisofpowermonitoringsystemdatafromgroupsofmetering orsimilarintelligentdevices.UseVirtualProcessorSetuptoconfigureaVirtual ProcessorModbusServicefordefiningsitesanddevicesinaModbusnetwork,and tosetupthecommunicationsportforit.VirtualProcessorSetupcanalsobeused toimprovetheperformanceoftheIONVirtualProcessorServicebymodifyingits globaloperatingparameters. SeeVirtualProcessorServiceonpage 244forapplicationexamplesusingthe VirtualProcessor.
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 277. Modbus support in the Virtual Processor will be removed in a future version of ION Enterprise.
WhensettingupyourModbusnetwork,makesurethatyourModbusportis differentfromtheportthatconnectstoyourIONdevices.TheVirtualProcessor requiresacommunicationsportforModbusseparatefromanycommunications portdefinedasasiteintheManagementConsole.
Setting up a Virtual Processors Modbus Network

1. 2. StartManagementConsole. ClickTools>System>IONVirtualProcessorSetup.TheVirtualProcessor Setuputility(VIP.ComputerNamewhereComputerNameisthenameofthe workstation)isdisplayedasaniteminthetreeview.
Doubleclickanitemtoexpandorcollapseit. Thebuttonsavailablevarydependingontheitemselectedinthetree. 3. ExpandModbusNetworktoshowMasterSitesandSlavePorts.
Page 75
Adding a Modbus Master Ethernet Site 1. 2. SelectMasterSitesthenclickAddSite. SelectEthernet(RTU)thentypethefollowingintheappropriatefields: TCP/IPAddress:theTCP/IPaddressoftheMastersiteorgateway TCP/IPPort:theTCP/IPportnumberusedtoconnecttotheCOMportused bytheModbusnetwork(forexample,TCP/IPport7802connectstoan EtherGatedevicesCOM2port). 3. ClickOK.
NOTE
Do not 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. 2. SelectMasterSitesthenclickAddSite. SelectSerialSite,thensetCOMPorttotheserialportofyourcomputerthatyou wanttoassignasyourModbusMaster.TheVirtualProcessorsModbusImport andModbusExportmodulesthenusethisCOMporttocommunicatetothe Modbusslavedevices. ClickOK.
3.
NOTE
The COM port used to define a Master Site must be different from the COM port used for connecting to ION devices.
Configuring the Modbus Master Site Parameters

SelectthesiteandexpandthetreeuntiltheparametersunderSettingsare displayed.Selecttheparameteryouwanttochange,andthenclickModify <setting>(where<setting>isthesettingselected). TransmitDelay:TheamountoftimetheVirtualProcessorwaitsbetween sendingoutrequests.Thesupportedrangeisfrom10to60000milliseconds.
NOTE
For Ethernet sites, specifying too small a value for Transmit Delay may overload the network.
ReceiveTimeout:ThetimeperiodtheVirtualProcessorallowsforestablishing communications.Thesupportedrangeisfrom100to60000milliseconds.
NOTE
For Ethernet sites, the protocol used is Modbus RTU which does not identify packets. Therefore, specifying too small a value for Receive Timeout may cause timeout errors, which could result in packet mix-up. Specify a value that avoids timeouts.
Page 76
BaudRate(serialsitesonly):TheBaudrateusedforModbuscommunications toserialsites.Supportedvaluesare300,1200,2400,4800,9600,19200,38400, 57600,115200. Parity(serialsitesonly):Thissettingspecifieswhetherornotparityisactive (andifitisactive,thetypeofparity;i.e.,Odd,Even,Mark,orSpace).Parity referstoatechniqueofcheckingwhetherdatahasbeenlostoroverwritten whenitismovedfromoneplaceinstoragetoanother,orwhentransmitted betweendevicesand/orcomputers. StopBits(serialsitesonly):Thenumberofstopbitssupportedbythesite. Supportedvaluesareaminimumof1,1.5and2.Stopbitssignaltheendofa unitoftransmissiononaserialline. DataBits(serialsitesonly):Thenumberofdatabits(i.e.,bitsthatcontain informationordata)supportedbythesite.Supportedvaluesrangefroma minimumof4andamaximumof8. Adding Modbus Devices 1. SelecttheModbusMastersitetowhichyouwanttoaddaModbusdevice. ExpandthetreetodisplaySettingsandDevices.SelectDevices,thenclickAdd Device.TheAddModbusDevice(s)dialogboxappears. EntertheNameandUnitIDoftheModbusdeviceintheappropriatefields.For Ethernetdevices,setUnitIDto100.TheNamemustbeuniqueamongallthe sitesservicedbytheVirtualProcessor.TheUnitIDmustbeuniqueinsidea givensite.ClickAdd. RepeattheprevioussteptoaddmoreModbusdevicestothesamesite.When youhavefinishedconnectingalltheModbusdevicestothatsite,clickOK.
2.
3.
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 1 to 247. Do not use 0 (zero) as it is reserved for broadcast messages.
Renaming a Modbus Device 1. 2. SelecttheModbusdeviceyouwanttorename.ClickRenameDevice.The ModbusDeviceNamedialogboxappears. Typethenewname,thenclickOK.
NOTE
If you rename or delete Modbus devices, all Modbus Export or Modbus Import modules that previously referred to that renamed or deleted Modbus device are 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. 2. SelecttheModbusdeviceyouwanttodelete. ClickDeleteDevicethenclickOKtoconfirmthedeletion.
Page 77
Adding a Communications Port for the Modbus Slave

TIP
If you want to use ION data in your Modbus network, you 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.TheModbusPort/Sitedialogbox appears. SettheCOMPorttotheportyouwanttouseasaModbusSlaveport(thisisthe portthattheModbusMasterusestoreadModbusdatafromtheVirtual ProcessorsModbusSlavemodules).ClickOK.
2.
NOTE
The Modbus Slave port must not be set to the same port as any ION or Modbus Master ports.
3. 4. 5. 6. 7. 8.
ExpandtheCOMportyouhavejustaddedtodisplaySettings. ExpandSettingstoshowtheitemsbelowit. SelectUnitIDthenclickModifyUnitID.TheModbusSlaveUnitIDdialog boxappears. EntertheModbusSlavedeviceunitID.ClickOK. IfyouwanttomodifytheBaudRate,selectBaudRatethenclickModifyBaud Rate.Selectthenewbaudratefromthedropdownlist,thenclickOK. Ifnecessary,configuretheParity,StopBitsandDataBits.
Changing Port Assignment for a Modbus Master or Slave

1. 2. Selecttheportyouwanttoreassign,andthenclickRenamePort.TheModbus Port/Sitedialogboxappears. Fromthedropdownlist,selecttheportyouwanttoreassigntotheModbus masterorslave(seeAddingaModbusMasterEthernetSiteonpage 76or AddingaCommunicationsPortfortheModbusSlaveonpage 78).
Deleting a Modbus Master Site or Slave Port

NOTE
Deleting a Modbus Master Site also deletes all devices connected to it.
1. 2.
Clickonthesiteorportyouwanttodelete,andthenclickDeletePortor DeleteSite(dependingontheitemselected). ClickOKtoconfirmthedeletion.
Page 78
Modifying the Global Parameters
Final Steps After Saving and Exiting

WhenyouhavefinishedusingVirtualProcessorSetup,clickSavetosaveyour changes,thenclickExittoclosethewindow. Inorderforthechangestotakeeffect,youmuststopthenrestarttheIONVirtual ProcessorService.
Modifying the Global Parameters

TypicallyyoudonotneedtochangethedefaultVirtualProcessorsGlobal Parameters.However,thesettingsinthefollowingtablecanbemodifiedtotryto optimizesystemperformance.Toviewandselectthesettings,expandGlobal Parameters.
Global Parameter
Value Range
Description
The interval at which ION modules inside the Virtual Processor are updated.
Notes
Frequent module updates contribute to the workstation's processor load. By increasing the Module Update Period, you reduce the number of times a module executes in a given time period. Increasing the Configuration Saver Period significantly reduces the processor load if you have a large Virtual Processor configuration file. You can increase the period for less critical Virtual Processor applications and reduce the period for more critical applications. Reducing this value increases the rate at which these responses are sent; however, this can also increase network traffic.
Module Update Period
50 to 1000 ms
Configuration Saver Period
10 to 600 seconds
The interval at which the Virtual Processor writes its configuration data to the workstation's hard disk. The interval at which the Virtual Processor gets information from other nodes in the network (for example, another Virtual Processor or a device). The interval at which the Virtual Processor responds to requests for information from client nodes such as Vista or the Log Inserter.
Client Polling Period
500 to 300000 ms
Server Polling Period
200 to 1440000 ms
Page 79
Time of Use Editor
Time of Use Editor

TimeofUse(TOU)schedulescreatedwiththeTimeofUseEditoraredesignedto beusedwithWebReporter.WhenyouuseaTOUscheduleinareport,thereport dataispresentedaccordingtotheinformationyousetupintheschedule.See EnergyCostonpage 176forinformationontheEnergyCostReport. AtypicalTOUhasOnPeak,OffPeakandShoulderperiods.Sincerateschedules varynotonlybydayandweek,butalsobyseason,theTOUschedulescanbeset uptomatchyourpreciseneeds. ToconfigureTOUschedulesforusewithDesigner,seeTimeofUse(TOU) ProgramManagementonpage 241. Opening the Time of Use Editor ToaccesstheTimeofUseEditor,selectTools>System>TimeofUseEditorin ManagementConsole.
Time of Use Editor Interface

Schedule Name
Schedule Description
Navigation Pane
Tab Display Pane
Usethenavigationpanetonavigatethroughtheschedules,accesstherightclick menusforschedulesandsubschedules,andselectanitemtodisplayassociated tabsinthetabdisplaypane.
Overview: Creating a TOU Schedule

TocreateaTOUschedule,youneedto: 1. 2. 3. Addaschedule.SeeAddingorEditingaScheduleonpage 81. Addasubschedule,ifyouneedmorethanonesubschedule.SeeAddingor EditingaSubScheduleonpage 82. Addaseason,ifyouneedmorethanone.SeeConfiguringSeasonsonpage 83.
Page 80
Adding or Editing a Schedule
4. 5. 6. 7.
Configurespecialdays(i.e.,holidays)toincludeinyourTOUschedule.See AddingSpecialDaysonpage 85. Adddaygroups,ifyouneedgroupsotherthanthedefaultdaygroups.See ConfiguringDayGroupsonpage 86. AddTOUnames,ifyouneednamesotherthanthedefaultnames.SeeDefining TOUNamesonpage 87. AssignTOUperiodstoTOUnames.DefiningTOUPeriodsonpage 88.
Toviewasampleschedule,rightclickinthenavigationpaneandselectImport Schedule.SelectSampleSchedule.toufromthe..\IONEnterprise\system\etc folderandclickOpen.
Adding or Editing a Schedule

Thissectiondescribeshowtoaddablankschedule,andimportorcopyanexisting schedule.
Adding a Blank Schedule

1. 2. SelectFile>NewSchedule.TheAddaScheduledialogboxappears. Typeanameanddescriptionfortheschedule.Clickthearrowbesidethe effectivedatetobringupacalendarwhereyoucanselecttheeffectivedateofthe schedule. ClickOK.Thatschedulenameappearsinthelistinthenavigationpane.
3.
Copying an Existing Schedule

1. 2. 3. 4. Inthenavigationpane,rightclicktheschedulethatyouwanttocopy. SelectSaveasNewSchedule.TheSaveasNewScheduledialogboxappears. Enteranameanddescriptionforthenewschedule. ClickOK.Thenewscheduleappearsinthenavigationpanewiththeattributes ofthecopiedschedule.
Importing a Schedule
1. 2. 3. Placetheschedulethatyouwanttoimportintoafolderthatcanbeaccessed fromthecomputer. Inthenavigationpane,rightclickanemptyareaofthenavigationpanethen selectImportSchedule.TheOpendialogboxappears. Navigatetothefolderwhereyouplacedtheschedule.Selectthescheduleand clickOpen. Thescheduleisimportedwiththeextension_imported.Forexample,a schedulenamedScheduleAbecomesScheduleA_imported.
Page 81
Adding or Editing a Sub-Schedule
Exporting a Schedule
ToexportascheduletouseinanotherTOUinstallation: 1. 2. 3. 4. Rightclickonthescheduleyouwanttoexportinthenavigationpane.Click Export.TheSaveAsdialogboxappears. Selectthefolderwhereyouwanttosavetheschedule. EnteraschedulenameintheFilenamebox. ClickSave. Thescheduleissavedwiththeextension.tou.Forexample,ScheduleB becomesScheduleB.tou.
Editing an Existing Schedule

Toeditaschedulenameordescription: 1. 2. Fromthenavigationpane,rightclickaschedulenamethenclickEdit Schedule.TheEditaScheduledialogboxappears. Changetheschedulenameordescription. Tochangetheeffectivedate,youmustmakethechangetothesubschedule(s). SeeEditingaSubScheduleEffectiveDateonpage 83. 3. ClickOK.
Deleting a Schedule
Todeleteaschedule,rightclicktheschedulenameinthenavigationpanethen selectDeleteSchedule.Thisdeletestheentireschedule,includinganysub schedules.
Adding or Editing a Sub-Schedule

Whenyouaddthebasicschedule,itcontainsonesubschedule,withtheeffective date(startdate)youenteredfortheschedule.Toaddadditionalsubschedules withalternateeffectivedates,followtheinstructionsinthefollowingsections. Expandascheduletodisplayitssubschedule(s).Subschedulesarelistedinorder oftheireffectivedates.
TIP
If you want to have more than one sub-schedule with the same seasons, day groups, TOU periods, etc., configure the first sub-schedule then right-click on it and select Save as New SubSchedule.
Page 82
Configuring Seasons
Adding a Blank Sub-Schedule

1. 2. 3. RightclicktheschedulenameandselectNewSubSchedule.TheNew SubScheduledialogboxappears. Clickthearrowbesidetheeffectivedatetobringupacalendarwhereyoucan chooseaneffectivedateforthenewsubschedule. ClickOK. Thesubscheduledisplaysinthenavigationpane.Continueconfiguringthe subschedulebyaddingseasonsanddaygroups. Toaddanewsubschedulethathasthesamesettingsasanexistingsubschedule, seeCopyinganExistingSubSchedule,below.
Copying an Existing Sub-Schedule

1. 2. 3. RightclickthesubschedulethatyouwanttocopyandselectSaveasNew SubSchedule.TheNewSubScheduledialogboxappears. Clickthearrowbesidetheeffectivedatetobringupacalendarwhereyoucan chooseaneffectivedateforthenewsubschedule. ClickOK.Thenewsubscheduledisplaysinthenavigationpanewiththesame attributes(otherthaneffectivedate)ofthesubscheduleyoucopied.
Editing a Sub-Schedule Effective Date

1. Rightclickthesubscheduleforwhichyouwanttochangetheeffectivedate, thenselectEditEffectiveDate.TheEditSubScheduleEffectiveDatedialog boxappears. Clickthearrowbesidetheeffectivedatetobringupacalendarwhereyoucan chooseaneffectivedateforthenewsubschedule. ClickOK.
2. 3.
Deleting a Sub-Schedule
Todeleteasubschedule,rightclickthesubschedulenameinthenavigationpane andselectDelete.Thisalsodeletesallseasonsinthatsubschedule(andanyday groups,specialdays,etc.,thattheycontain).
Configuring Seasons
Useseasonstocreatetimeframesforpresentingdatainreports.Anewlycreated schedulehasasingleseason,calledAllYear.Expandasubscheduletoviewits seasons. Ifyouonlyneedoneseason(AllYear),youcanskipthestepsbelowandgoto configuringspecialdays.
Page 83
Configuring Seasons
Configuring Seasons
UsetheDefineaSeasontabtosetuporeditthetimespansforeachseason.
NOTE
A date can only belong to one season; you cannot overlap dates in one season with dates in another.
1. 2.
Fromthenavigationpane,selectthesubscheduletowhichtheseason belongs. Inthetabdisplaypane,selecttheDefineaSeasontab. Afteryouaddasubschedule,thetabdisplaysonlyoneseason(AllYear)that coverstheentireyear.Theseasonislistedatthetopofthetab,andthecalendar thatshowsthedaysandmonthsthatbelongtothatseasonisfull.Tomakeroom toaddotherseasons,youmustedittheAllYearseason.
3. 4. 5.
SelectAllYearfromtheDefineaSeasontabandclickEdit.TheEditaSeason dialogboxappears. IntheSeasonNamefield,typethenameofoneoftheseasonsyouwanttodefine (forexample,Summer). SettheStartDateandEndDatefortheseason.Youcanspecifyfixedstartand enddates(i.e.,12/31)orrelativestartandenddates(i.e.,thelastSaturdayof October). FixedDate:Clickonthemonthordayportionofthedatetheneithertypethe newdateorusetheupanddownarrowsbesidethedatetoeditit. RelativeDate:Selectthedayandmonthfromthedropdownlists. Fortheenddate,selecttheTimeofDaytheseasonends(StartofDayorEndof Day).IfyouselectStartofDay,theseasonendsat12:00:00AMontheselected day;ifyouselectEndofDay,theseasonendsat12:00:00AMonthenextdayso therearenogapsintheschedule.
NOTE
If you use relative dates, you can configure a schedule that may become invalid in future years. Be careful when you configure the schedule that there will be no missing or overlapping days in the schedule in future years. For example, rather than scheduling one season to end on the 1st Sunday in June and the next to start on the 1st Monday in June, it is better to schedule the first season to end at Start of Day on the 1st Sunday in June and the next season to start on the 1st Sunday in June.
6.
Ifthisisasplitseason(wherethereisagapbetweentwopartsoftheseason), selecttheSplitSeasoncheckboxandaddasecondsetsofdates.Forexample, winteristypicallyasplitseasonbecauseitoccursinthefirstandlastmonthsof theyear. ClickOK. ThecalendarontheDefineaSeasontabnowshowsoneseasonwiththerestof theyearunassigned.
7.
8.
ClickAddtocreateadditionalseasons.Repeatsteps4to6tonametheseason anddefinethestartandenddates.
Page 84
Adding Special Days
NOTE
Do not leave any dates unassigned: unassigned dates are not calculated in the reports.
Editing a Season
1. 2. OntheDefineaSeasontab,selecttheseasonyouwanttoeditthenclickEdit. TheEditaSeasondialogboxappears. MakethechangesyourequirethenclickOK.
Deleting a Season
Todeleteaseason,selecttheseasonintheDefineaSeasontabthenclickDelete. ThisalsodeletesthedaygroupsandTOUperiodsconfiguredforthatseason.
Adding Special Days

Afteryoudefineasubschedule,youneedtosetupholidaysandotherspecial days.Youcandefineholidaysthatoccuronthesamedateeveryyearoratsome otherregularinterval(suchasthethirdThursdayinNovember).Youcanalso definespecialdays,suchasinventorydays,thatmightoccurregularlyandrequire specialtreatmentinreports. UsetheDefineSpecialDaystabtosetupholidaysandotherspecialdays. 1. 2. 3. 4. 5. Inthenavigationpane,selectthesubscheduleforwhichyouwanttodefine specialdays. Inthetabdisplaypane,selecttheDefineSpecialDaystab. ClickAdd.TheAddaSpecialDaydialogboxappears. TypeanameforthespecialdayintheNamefield. Selectthefrequencyoftheday: Onetimeonly:Enterthedateforasingledaythatdoesnotrepeatinfuture years;forexample,aspecialdayforyourorganizationthatdoesnotrepeat everyyear. Repeatyearly:Enterthedate;forexample,aholidaythatoccursonthe samedateeveryyear. Repeaton:CompletethefieldsintheRepeatOnsectiontodefinehowthe dayrepeatsandinwhichmonthsitoccurs.Selectwhetherisoccursona particulardateoftheselectedmonth(s)(Day)orarelativeday(i.e.,Last Saturday)intheselectedmonth(s). 6. 7. Repeatsteps3to5toaddadditionalspecialdays. ClickOKtosaveyourchangesandreturntotheDefineSpecialDaystab.
SeeConfiguringDayGroupsonpage 86forinstructionsonhowtoapplyspecial daystoasubschedule.
Page 85
Configuring Day Groups
Deleting a Special Day

Todeleteaspecialday,selectthespecialdayintheDefineaSpecialDaytabthen clickDelete.
Configuring Day Groups

Daygroupsdefinehowdaysoftheweekaredividedintogroups. Daygroupscaninclude: daysoftheweek specialdays,suchasholidaysorotherspeciallydesignateddays(suchas inventorydays) Defaultsettingsareweekdays(MondaytoFriday)andweekends(Saturdayand Sunday)butyoucanaddadditionalgroups.Therecanbeamaximumof47day groupsinanyseason. Makesurethatalldayshavebeenaccountedforsinceunaccountedtimeisnot includedinanyreports.
Adding a Day Group

Beforeyouaddadaygroup,makesurethatyouhavedefinedseasonsandspecial daysforthesubschedule. 1. 2. Inthenavigationpane,selecttheseasonforwhichyouwanttodefineday groups.TheDefineDayGroupstabappearsinthetabdisplaypane. ClickAdd.TheAddaDayGroupdialogboxappears. IftheAddbuttonisunavailable,therearenofreedaystoaddtoadaygroup.A daycanonlybelongtoonedaygroup.Toaddanotherdaygroup,youmustfirst removedaysfromanexistingdaygroup. 3. 4. Typeanameforthedaygroup. Selectoneofthefollowingoptions: Dayofweek:Selectthecheckbox(es)fortheday(s)youwanttoinclude.A daycanbelongtoonlyonedaygroup;ifadayisunavailable,italready belongstoanexistinggroup.Ifalldaysareunavailable,youcanonly includespecialdaysinthisgroupunlessyouremovedaysfromanotherday group. SpecialDay(s)Only:SelectthespecialdayintheIncludeSpecialDayslist thenclicktoselectorcleartheday.Dayswithacheckmarkbesidethemare includedinthedaygroup.Youcanonlyincludeaspecialdayinoneday group. 5. ClickOK.Thenameisaddedtothedaygrouplist.
Page 86
Configuring TOU Names and TOU Periods
Editing a Day Group

1. 2. OntheDefineDayGroupstab,selectthedaygroupyouwanttochange,then clickEdit.TheEditaDayGroupdialogboxappears. MakethechangesyourequirethenclickOK.
Deleting a Day Group

Todeleteadaygroup,selectthedaygroupintheDefineDayGroupstabthen clickDelete.Whenyoudeleteadaygroup,youalsodeletetheTOUperiods configuredforthatdaygroup.Ifyouaddadaygroupagain,youwillneedto reconfiguretheTOUperiods.

Whenyourunreports,thereportscalculateanddisplaydataaccordingtothe informationyouenterintheDefineTOUPeriodsandDefineTOUNamestabs.
NOTE
You need to define TOU names and periods for each schedule that you create. Be sure to apply a TOU name to every square on the calendar. Unaccounted time causes your reports to display inaccurate information.
Defining TOU Names

ATOUnameisadesignationthatisusedtodifferentiatebillingrates.ThreeTOU Namesarealreadydefined:OnPeak,OffPeakandPartialPeak.Youcaneditor deletethesenames,oraddnewnames. Defining TOU Names 1. 2. 3. Inthenavigationpane,selectthedaygroupforwhichyouwanttodefineTOU namesthenselecttheDefineTOUNamestab. ClickAdd.TheAddaTOUNamedialogboxappears. TypetheTOUnameyouwanttoaddthenclickOK.TheTOUnameisaddedto thelistofTOUnames.
Editing an Existing TOU Name 1. 2. 3. SelecttheTOUNameinthelistontheDefineTOUNamestabandclickEdit. TheEditaTOUNamedialogboxappears. TypethenewnameintheTOUnamefield. ClickOK.
Deleting a TOU Name SelecttheTOUnameinthelistontheDefineTOUNamestabandclickDelete.
Page 87
NOTE
If you delete a TOU name, the TOU periods assigned to the name are replaced with Unaccounted. Deleting a TOU name in a particular schedule affects all sub-schedules in that schedule.
Defining TOU Periods

ATOUperiodisthetimespanwithinthe24hourperiodtowhichyouapplya TOUname(suchas8:00a.m.to5:00p.m.forOnPeak).YoumusthaveTOUnames definedbeforeyoucanassociateTOUperiodswiththosenames. TwoTOUnamesarealreadydefined:OnPeakandOffPeak.Youcaneditordelete thesenames,oraddnewnames. Adding TOU Periods SelectadaygroupstosetuptheTOUtimeperiods(onpeak,offpeak,etc.)forthat group. 1. 2. 3. 4. 5. 6. Inthenavigationpane,selectthedaygroupforwhichyouwanttodefinea TOUperiodthenselecttheDefineTOUPeriodstab. ClickAdd.TheAddaTimePerioddialogboxappears. IntheStartTimefield,typethetimethattheperiodbegins,orselectthehours andminutesandusetheupanddownarrowstosetthestarttime. IntheStopTimefield,typethetimethattheperiodbegins,orselectthehours andminutesandusetheupanddownarrowstosetthestoptime. FromtheTimeofUseNamedropdownlist,selecttheTOUnametoassociate withthetimeperiod. ClickOK.
Toaddasplittimeperiod(i.e.,atimeperiodthatspansfrom19:00to6:00),you mustaddtwoseparatetimeperiodsandassociatethemwiththesametimeofuse name. Ifyouwanttoexpandatimeperiodintotimethatalreadybelongstoanother period,youmustfirstedittheothertimeperiodtoclearthetime. Continueaddingtimeperiodsuntilthe24hourperiodisfilled.Unaccountedtime blockscauseyourreportstodisplayinaccurateinformation. Editing TOU Periods 1. 2. HighlighttheperiodyouwanttoeditandclickEdit.TheEditaTimePeriod dialogboxappears. MaketherequiredchangesthenclickOK.
Deleting TOU Periods Todeleteaperiod,highlighttheperiodandclickDelete.
Page 88
Vista
VistaistheIONEnterprisecomponentthatdisplaysandcontrolsyourpower monitoring/managementsystem. ForinformationonstartingandloggingontoVistaorendingyourVistasession, seeGettingStartedonpage 19.
In This Section
TheVistaInterfaceonpage 90 VistaUserDiagramsonpage 93 MonitoringYourSysteminVistaonpage 96 ViewingRealTimeDataonpage 98 ViewingLoggedDataonpage 100 AddingaGlobalEventLogVieweronpage 104 AcknowledgingAlarmsonpage 105 ControllingSystemFunctionsonpage 107 PlottingLoggedDataonpage 108 TheLogViewPlotterInterfaceonpage 109 CustomizingtheLogViewPlotterDisplayonpage 121 OverlayingCurvesintheLogViewPlotteronpage 125 CreatingandCustomizingaUserDiagramonpage 127 AddingaDiagramObjecttoaUserDiagramonpage 128 CustomizingaDiagramObjectonpage 133 LinkingaDiagramObjecttoaDataSourceonpage 146 QueryingtheDatabaseonpage 148 CustomizingaDiagramWindowonpage 155
Page 89
The Vista Interface
The Vista Interface

TheVistainterfaceconsistsofamainscreenwithatitlebar,amenubar,atoolbar, aworkspace,astatusbarand(inEditmode)atoolbox. ForinformationonopeningorgeneratingaVista,seeGenerating,Openingand ClosingaUserDiagramonpage 94. The Vista interface with a user diagram showing realtime values
Menu Bar
Toolbar
Click a tab to display its data
Click to return to the Network Diagram view
Workspace
Status Bar
Click this grouping object to open another window containing more data
Toolbox
Receive/Transmit Status Indicators
Toolbar
Thetoolbaroffersquickaccesstothecommandsthatareusedmostfrequently. Eachcommandonthetoolbarisalsoavailablefromthemenus.
Page 90
The Vista Interface
Open
Zoom
Restore to 100%
Cut
Paste
Up One Level
Save
Fit to Window
Plot Selected Data
Copy Layout
Help
Zoom SelectView>ZoomInorclicktheZoombuttontochangethemousepointertoa crosshair.Usethispointertodraganoutlinearoundtheareayouwanttoenlarge. Restore to 100% SelectView>Restoreto100%orclicktheRestoreto100%buttontoreturntothe normalview. Fit to Window SelectView>FittoWindoworclicktheFittoWindowbuttontoforcetheuser diagramtofitinthecurrentwindow. Up One Level SelectFile>UpOneLevelorclicktheUpOneLevelbuttontoreturntothe previouslydisplayedwindow.Notethatthisalsoclosesthecurrentwindow.If youwanttobepromptedwhenyoureachthetoplevelofadiagram,makesure Options>Browseclosesactivewindowisselected.
Workspace
ThemainareainthecenteroftheVistascreenistheworkspace.Theworkspaceis usedtodisplayinformationsuchasuserdiagramsanddataandeventviewers.
Status Bar
Thestatusbardisplays: thestatusline,whichdescribesanyactiveprocessesandprovidesabrief descriptionofthecurrentlyselectedcommandortoolbarbutton. thecurrenttimeontheworkstation. aprogressindicatorbar. twocommunicationstatuslights.
Toolbox
InEditmode,thetoolboxalsoappearsonthescreen.Youcanaddobjectstothe userdiagramusingthetoolbox.SeeCreatingandCustomizingaUserDiagram onpage 127formoreinformationonthetoolboxandEditmode.
Page 91
The Vista Interface
Other Display Features

Vistaoffersseveraldisplayfeaturestoassistyouwhenviewingauserdiagram. Someoftheseareaccessiblethroughthetoolbarandmenuoptions(seeToolbar onpage 90).Thoseonlyaccessiblethroughmenuoptionsare: Browse Closes Active Window SelectOptions>Browseclosesactivewindowtohaveeachwindowthatyou openreplacethepreviousone.Thisoptionisselectedbydefault.Withoutthis optionselected,anypreviouslyopenedwindowsremainopen. Arrange All SelectWindow>ArrangeAlltotileallopenwindowsintheworkspace.
Display Mode and Edit Mode

TherearetwodisplaymodesinVista,whichaffecthowyounavigateauser diagram.Whetherornotthetoolboxisshownindicatesthemodeyouarein:ifthe toolboxisopen,youareineditmode;ifitisclosed,youareindisplaymode. Displaymodeallowsyoutomonitoryoursystem,viewsystemdata,and controlsomeaspectsofyoursystem.InDisplaymode,singleclickobjectsto viewtheinformationtheycontainorperformtheirassociatedaction. Editmodeallowsyoutoconfiguretheappearanceandfunctionofuser diagramsanddiagramobjects.InEditmode,doubleclickobjectstoviewthe informationtheycontainorperformtheirassociatedaction.Rightclickon objectstoviewconfigurationoptions.SeeCreatingandCustomizingaUser Diagramonpage 127andCustomizingaDiagramObjectonpage 133for moreinformation. Wheninstructedtoclickadiagramobject,eithersingleclickordoubleclick, dependingonthemodeyouarein.
Page 92
Vista User Diagrams
Vista User Diagrams

ThissectionexplainshowtouseVistauserdiagramstoviewrealtimeandlogged datafromyourpowermonitoringsystem.Theinformationthatyouobtainfrom yourIONEnterprisenetworkisrepresentedgraphicallyinauserdiagram.
What is a User Diagram?

Auserdiagramisaconfigurabledisplaythatconsistsoftwomainelements: Diagramobjectsareconfigurablegraphiciconsthatdisplayyoursystem information.Eachdiagramobjectdisplaysasinglepieceofinformationfrom somewhereinyourpowermonitoringnetwork.Insomecases,diagramobjects arestoredwithingroupingwindows. Groupingobject:Insomecases,auserdiagramstoresrelatedinformation withinagroupingobject.Clickonagroupingobjecttoopenagroupingwindow anddisplayitscontents.
NOTE
To configure a grouping object to open a grouping window, see Specifying Action for Numeric, Status, or Grouping Objects on page 142.
Groupingwindowsareatypeoffolderorsubwindowthatcontaindiagram objects.Vistausesgroupingwindowstologicallyorganizediagramobjects withinauserdiagram.Whenclosed,agroupingwindowisusuallyrepresented byagroupingobjecticon.

User diagram (contains diagram objects and grouping objects) Diagram object
Click a grouping object to open its grouping window.
TIP
It is better to use grouping objects to open other user diagrams rather than to open grouping windows. Large numbers of grouping windows in a user diagram can slow the performance of Vista.
Page 93
Vista User Diagrams
Youcancreateasmanyuserdiagramsasyouwantandediteachonetosuityour needs.Youcanshareuserdiagramswithmultipleusersoveryournetwork,and userscanviewthemsimultaneouslyandsharethesameinformation.Formore informationoncreatinguserdiagrams,seeCreatingandCustomizingaUser Diagramonpage 127.
Default User Diagrams

Vistaprovidesasetofpreconfigureduserdiagramsthatyoucanusetodisplay data.Thesedefaultdiagramsprovideastandardsetofoptionsthatyoucanuseto accessyourdevicesmostcommonlyrequiredfunctions. Thedefaultdiagramdisplaysrealtimedata.Itincludesasimplepowersystem illustrationthatdisplaysthevariousrealtimeparametersmeasuredbythedevice.
Generating, Opening and Closing a User Diagram

Auserdiagramisidentifiedbyits.dgmextension.Youcangenerate,open,and closeuserdiagramsasneeded. Generating a Network Diagram Thenetworkdiagramdisplaysyourentirepowermonitoringsystembylinkingto individualdefaultuserdiagramsthatdisplaydatafromeachdeviceinyour system.Whenyougenerateanetworkdiagram,Vistaautomaticallylocatesall devicesinyoursystemanddisplaysthem.Thisdiagramissavedwiththedefault namenetwork.dgm. 1. SelectFile>GenerateNetworkDiagram. Thenetworkdiagramappearsintheworkspacecontainingiconsthatrepresent groupsofdevicesonyoursystem. 2. 3. 4. Clickononeofthegroupingobjectstoopenawindowanddisplaythenode iconscontainedwithin. Clickanodeicontodisplaytheuserdiagramfortheassociateddevice. Savethenetworkdiagram.
NOTE
Regenerating a network diagram and saving it overwrites the previously saved (network.dgm) file.
Opening a User Diagram Toopenauserdiagram: 1. 2. 3. SelectFile>Open. NavigatetotheuserdiagramyouwanttoopenandselectitfromtheOpen Diagramdialogbox. ClickOpentoopentheselecteduserdiagram.
Page 94
Vista User Diagrams
Specifying the User Diagram that Opens for a Given User TosetaspecificVistaworkspaceandsetofdiagramstoopeneverytimeagiven userlogson: 1. 2. 3. 4. 5. 6. LogontoVistausingtheparticularuserslogoncredentials. OrganizeVistatoappearasyouwantittoappearonstartup. ClickSave,thencloseVista. UseWindowsExplorertonavigatetothe...\IONEnterprise\config\cfg\ud folder. Locatethe.wsufilefortheuseryouaresettingup(i.e.,<username>.wsu).Right clickandselectProperties. 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 can still to modify and save user diagrams (if allowed by their access level).
Closing a User Diagram Tocloseauserdiagram: SelectFile>Closetoclosethecurrentdiagram. SelectFile>CloseAlltoclosealldiagrams.
Navigating a User Diagram

Afteryouopenauserdiagram,youcanuseittointeractwithyourpower monitoringsystem.Eachuserdiagramdisplayssysteminformationthrough diagramobjects,whichyoucanusetomonitorandcontrolvariousaspectsofyour system.
Page 95
Monitoring Your System in Vista

UseVistauserdiagramstodisplayrealtimeandloggeddata,monitoreventsand alarms,andcontrolavarietyofsystemfunctions.
How Data is Displayed

Informationinyouruserdiagramisdisplayedusingdiagramobjects.Each diagramobjectcommunicatesasinglepieceofinformationfromsomewherein yourpowermonitoringnetwork;forexample,asinglenumericobjectdisplays numericdatafromasinglesource. Thereareseventypesofdiagramobjects:grouping,text,numeric,status,datalog viewer,eventlogviewer,andcontrol.Eachtypeofobjectperformsaspecifictype offunction. Inmostcases,youcanidentifyanobjectsfunctionbyacaption,alabel,orboth(the textobjectdoesnotuseacaptionoralabel). Bydefault,thecaptionisusuallylocatedbelowthediagramobjectandidentifies thenodetowhichthediagramobjectisconnected.Thecaptioncanbemodified todisplayacustomdescription.SeeCaptionOptionsonpage 134formore information. Whenalabelisused,itisusuallydisplayedtoonesideofthediagramobject.By default,thelabelidentifiestheregister(onthenode)towhichthediagramobject isconnected.Thelabelcanbemodifiedtodisplayacustomlabelname.See TextOptionsonpage 134formoreinformation.
TIP
To toggle between default labels and custom labels, select or clear Options > Show Default Labels. You can identify the type of diagram object by pointing to it with the mouse. The object type appears on the status line.
Identifying Stale Data

Realtimedatathathasnotbeenrefreshedisreferredtoasstaledata.Vistadetects staledataasitoccursandidentifiesitwithacoloredborder.Bydefault,Vista identifiesdataasstaleafter30seconds(formeterdiagrams,thedefaultvalueis60 seconds).PositionthemousepointeroveranobjecttodisplayaToolTipthat explainswhythedatahasbecomestale. Thestaledatasettingsareuserconfigurableonaperdiagrambasis,andcanbe customizedbyanyonewiththenecessaryaccesslevel. Changing the Stale Data Settings Tochangetheamountoftime(inseconds)thatVistausestoidentifystaledata: 1. 2. 3. RightclickthebackgroundandclickProperties. ClicktheUpdatestabandchangethesettingsintheStaleDatasection. ClickOK.
Page 96
Changing the Flag Settings for Stale Data Tochangetheflagcolor: 1. 2. ClickOptions>FlagColors. ClicktheEditbuttonfortheflagcoloryouwanttochange,selectthenewcolor andclickOK.
Identifying Errors in Communication

Vistadetectserrors(suchasdisableddevices,securityaccessrestrictions,or configurationerrors)andidentifiesthesewithacoloredborderaroundanobject (orange,bydefault).Thebordercolorcanbecustomized(seeprevioussection, ChangingtheFlagSettingsforStaleData).Positionthemousepointeroveran objectthatVistaisindicatinghasanerrortodisplayaToolTipthatexplainsthe error.
Page 97
Viewing Real-Time Data
Viewing Real-Time Data

Vistausesnumericobjectsandstatusobjectstodisplayrealtimedata.Numeric objectsdisplayrealtimenumericvaluesandstatusobjectsdisplayrealtime Boolean(ON/OFF)information.
Viewing Data with Numeric Objects

Vistausesnumericobjectstodisplayrealtimenumericdatafromyourpower monitoringsystem.Numericobjectscandisplaymanytypesofdata,suchasline voltageorcurrent,powerorenergylevels,harmonics,ordemandparameters. Dependingontheirconfiguration,numericobjectscandisplaydataindifferent formats:alphanumeric,dial,horizontalorverticalbar,orscrollinggraph.
Display Styles for Numeric Objects
Alphanumeric
Partial Dial
Full Dial
Horizontal Bar Timestamped PC Timestamped
Vertical Bar
Scrolling Graph
Arc Meter
Timestamp Only
SeeCustomizingtheDisplayofaNumericObjectonpage 136formore informationonconfiguringnumericobjects.
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 136formoreinformationonconfiguringflags.
Page 98
Viewing Data with Status Objects
Viewing Data with Status Objects

VistausesstatusobjectstodisplayBoolean(ON/OFF)conditionsinyoursystem. Astatusobjectmaydisplaythestatusofadigitaloutput(suchasarelay),adigital input(statusinput),orasetpointinyoursystem. Thedefaultstatusobjectappearsasanindicatorlightthatchangescolortoindicate variousconditions.Grayindicatesthestatusobjectisnotlinkedornotreceiving data. Likemostdiagramobjects,statusobjectscanbemodifiedbyanyuserwithan appropriateaccesslevel.Dependingonhowastatusobjecthasbeenconfigured, itsappearanceandfunctioncandiffersignificantlyfromthedefaultsettings. Astatusobjectthathasbeencustomizedcanappearasanalphanumericdisplay (forexample,ONorOFF)oracustomimage(threeimagesrepresentingON, OFF,andUNCONNECTED).SeeCustomizingtheDisplayofaStatusObjecton page 139formoreinformation.
NOTE
In some cases, the active state of a status object may have been changed (inverted) so that an active state appears as inactive and vice versa. See Annunciation Options on page 144 for more information.
Page 99
Viewing Logged Data
Viewing Logged Data

Dataandeventsrecordedbythedevicesinyoursystemareregularlytransferred bytheLogInserterfromeachdevicetothedatabase.VistausestheIONQuery Servicetotransferthisinformationfromthedatabasetoyourworkstation.Vista providestwowaystoviewloggeddataandevents:theDataLogViewerandthe Event(andGlobalEvent)LogViewer. TheDataLogViewerdisplaysdatalogsfromalldevicesrepresentedinthe activeuserdiagram.YoucanusetheDataLogViewertodisplaywaveformand trenddataintabularformat.Youcanalsoselectarangeoflogsfromtheviewer anddisplaythedatagraphicallyinthelogviewplotter. TheEventLogViewertypicallydisplayseventsandalarmsfromeachdevice representedintheactiveuserdiagram.TheEventLogViewerisusedprimarily tomonitorlowpriorityeventsandalarmsassociatedwiththeactiveuser diagram.EachEventLogViewerisassociatedwithasingleuserdiagram. TheGlobalEventLogViewerisaspecialversionoftheEventLogViewerused primarilytodisplayhighpriorityeventsandalarmsforyourentiresystem.The GlobalEventLogViewerisnotassociatedwithanysingleuserdiagram;the eventinformationitdisplaysiscommon,orglobal,totheentiresystem.
Using a Data Log Viewer

UseaDataLogViewertoviewsystemdatastoredinthedatabase.DataLog Viewersdisplayhistoricaltrenddata(fromdatarecorders)andwaveformdata (fromwaveformrecorders). YoucanselectanydatadisplayedinaDataLogViewerandplotitasagraphor copyittoanotherapplication(forexample,MicrosoftExcel)whereyoucan performadvancedcalculationsorincludeitinareport.
NOTE
See Querying the Database on page 148 for information on log viewer configuration.
Displaying a Data Log Viewer

ClickonaDataLogViewerobjectinyouruserdiagram.TheDataLogViewer appears.
Page 100
Using a Data Log Viewer
EachDataLogViewerdisplaysdataasatableofcolumnsandrows.Eachlabeled columncontainsasingletypeofdataandeachnumberedrowrepresentsasingle datarecord.
Plotting a Range of Data from the Data Log Viewer

YoucanplotdatafromaDataLogViewerintheLogViewPlotter. 1. Highlightthecellscontainingthedatathatyouwanttoplot.Therangeofdata canbeselectedinoneofthreeways:
Tographtrendsforallparametersoveraparticulartimespan,selecta
groupofrows.
Tographthetrendforaspecificparameterusingallavailablerecords,select theentirecolumn. Tographmultipleparametersoveraspecifictimespan,clickonthefirstcell inthedesiredrangethendragtohighlightthelastcelloftherange.
2.
SelectEdit>PlotSelectedDataorclick
TheLogViewPlotterwindowappears,displayingagraphicalrepresentationof theselecteddata.SeePlottingLoggedDataonpage 108formore information.
TIP
To quickly plot a single waveform, double-click on its waveform symbol in the Data Log Viewer.
Copying a Selection to Another Application

1. 2. Highlightthecellscontainingthedatathatyouwanttocopy. SelectEdit>Copyorclick .ThiscopiestheselectiontotheWindows Clipboard.Switchtoanotherapplicationandpastetheselection.
Page 101
Using the Event and Global Event Log Viewers
Using the Event and Global Event Log Viewers

Eventsandalarmsthatoccurinyoursystemarerecordedbythemeterand transferredviaLogInsertertothedatabase. Vistaprovidestwowaystovieweventrecordsstoredinthedatabase: TheEventLogViewerdisplayseventsandalarmsfromthedevice(s) representedintheactiveuserdiagram.Useittomonitorlowpriorityeventsand alarmsassociatedwiththeactiveuserdiagram. TheGlobalEventLogViewerdisplayseventsandalarmsforyourentire system.Useittomonitorhighpriorityeventsandalarmsfortheentiresystem. TheGlobalEventLogVieweroperatesindependentlyofanyuserdiagram. ThedifferencebetweentheGlobalEventLogViewerandtheEventLogVieweris essentialwhensettingupalarming.TheEventLogViewerisassociatedwitha singleuserdiagram,soalarmsonlyupdatewhentheuserdiagramisopen.The GlobalEventLogViewerdoesnotrequireauserdiagramandupdatesassoonas youstartVista.
NOTE
See Using the Query Options on page 148 for information on log viewer configuration.
TIP
To quickly display the user diagram for any device represented in an Event or Global Event Log Viewer, double-click on the node name (in the node column) of a device to display its user diagram.
Displaying an Event Log Viewer

ClickanEventLogViewerobjectinyouruserdiagram.TheEventLogViewer appears.
Page 102
Displaying the Global Event Log Viewer
TheEventLogViewerdisplaysloggedeventsinatableofcolumnsandrows.Each labeledcolumncontainsasinglecategoryoreventdescriptionandeachnumbered rowrepresentsasingleeventrecord. Typically,EventLogViewersdisplaythefollowinginformation: Timestamp:Thisindicatestheeventsdateandtime. Priority:Thisdeterminestherelativesignificanceoftheevent.Eachtypeof eventhasanumericvalueassignedtoitthatrepresentsitsrelativeprioritylevel. SeeAlarmingOptionsonpage 144formoreinformation. Cause:Thisisthelabelandvaluedescribingthecauseoftheevent.Forexample, ifthelabelisSetpoint#1andthevalueisActive,thentheeventwascaused bysetpoint#1changingtoanactivestate. Effect:Thisisthelabelandvaluedescribingtheeffectoftheevent.Forexample, iflabelisRelay#1andthevalueisForcedOn,thentheeffectoftheevent wastoforcerelay#1on. Ack_time:Thisisthedateandtimethatanalarmwasacknowledged.Any eventwithaprioritylevelthatexceedsthealarmthresholdappearshighlighted inreduntilthealarmisacknowledged. Whenanalarmoccurs,Vistacannotifyyouinseveralways:abeepingsound,a flashingtitlebar,amessagebox,oracustomsound.Ifyouhavesufficientsecurity clearance,youcanacknowledgealarms.SeeAcknowledgingAlarmson page 105formoreinformation.
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.

TheGlobalEventLogViewerdisplayseventdatastoredinthedatabase.It includesrecordsretrievedfrommeterandVirtualProcessoreventlogs,aswellas recordstransferredfromthesystemlogdatabase.UsersshareasingleGlobal EventLogViewerand,generally,theinformationdisplayediscommon,orglobal, totheentiresystem.
NOTE
We recommend that you do not delete the Global Event Log Viewer. If the pre-configured Global Event Log Viewer is deleted, a new one must be created and configured. If one user deletes it, the Global Event Log Viewer is automatically deleted from all workstations. Only a user with Supervisor-level access can delete a Global Event Log Viewer.
YoucanaddmultipleGlobalEventLogViewers(ifyouhavesufficientauthority). Youcanchangeeachviewersfiltercriteriatoquerythedatabaseforeventsfrom aspecificnodeorgroupofnodesorforeventswithacertainprioritylevel.
Page 103
Adding a Global Event Log Viewer

SelectEdit>AddGlobalEventLogViewer.AGlobalEventLogViewerwindow appears. ThenewGlobalEventLogViewerispreconfiguredwithdefaultlinkandquery information.However,youcanlinktheviewertoanotherlogserverusingthe proceduredescribedinLinkingaDataLogViewerorEventLogVieweron page 147. IfyouwanttoreconfigureaGlobalEventLogViewer,rightclickintheviewer windowtodisplaytheEventLogViewerConfigurationdialogbox.Youcanedit theCaption,QueryServer,QueryorAlarmingoptionsinthesamewayyouedit theseoptionsonanindividualEventLogViewer.SeeCustomizingaDiagram Objectonpage 133forinformationonconfiguringtheseoptions.
NOTE
When you add a Global Event Log Viewer to your workstation, it is automatically added to all Vista workstations in your network.
Viewing the Global Event Log Viewer

ToviewtheGlobalEventLogViewer,selectWindow>GlobalEventViewer.The GlobalEventLogViewerappears.
TIP
To temporarily hide the Global Event Log Viewer, clear View > Show Global Event Viewer. You are not notified of any alarms while the Global Event Log Viewer is hidden. If you want to continue to be notified of alarms, you can minimize the Global Event Log Viewer rather than hiding it.
Page 104
Acknowledging Alarms
Everytypeofeventhasaprioritizedvaluethatidentifiesitsrelativesignificance onascaleof0(zero)to255.Bydefault,Vistaidentifiesanyeventwithapriorityof 128(default)orgreaterasanalarm. Theeventrecordishighlightedinred,andidentifiedundertheack_time columnasALARM.Thecause_valuecolumnliststhesourceofthealarmand theeffect_valuecolumndescribestheevent.
Bydefault,Vistaplaysabeeptoannunciateaneventwithaprioritybetween128 191,andabeepcombinedwithaflashingdisplaytoannunciateaneventwitha prioritybetween192255.Tocustomizetheseoptions,seeAlarmingOptionson page 144. Whenyouacknowledgeanalarm,Vistarecordsthetimethealarmwas acknowledged(intheack_timecolumn)andyouruserID(intheuser_name column).
NOTE
In some cases, your access level 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 144 for more information.
Acknowledging an Alarm
1. OpenanEventLogViewerortheGlobalEventLogViewer,thendooneofthe following: Toacknowledgeasinglealarm,clickonthewordALARMinthe ack_timecolumnorhighlighttherowcontainingthealarm. Toacknowledgeallalarmstodate,clickontheack_timecolumnheading. Aconfirmationboxappears,askingifyouwanttoacknowledgetheselected alarm(s). 2. SelectYestoacknowledgethealarm(s)orNotocancel.
Ifyouacknowledgethealarmbutdonothaveasufficientaccesslevel,thealarm remainsunacknowledgedandthemessageInsufficientAuthorizationappears inthestatusline.
Page 105
Silencing Alarms
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.
Page 106
Controlling System Functions
Controlling System Functions

YoucanusecontrolobjectstosendcommandsfromVistatoanode. Eachcontrolobjectinyouruserdiagramisconfiguredtoperformasingle function.Whenyouclickacontrolobject,itperformsthespecifiedfunction.For example,youcouldclickacontrolobjecttoclearanenergyaccumulator,togglea relay,resetacounter,oradjustthevalueofananalogoutputdevice. Thedefaultappearanceofacontrolobjectdependsonthefunctionithasbeen configuredtoperform:
Boolean
Pulse
Numeric
Regardlessoftheirappearance,allcontrolobjectsareusedthesamewaytouse acontrolobject,clickit.
NOTE
For information on configuring the message, appearance and access level of control objects, see Customizing the Action for a Control Object on page 143 and Customizing the Display of a Control Object on page 141.
Whenyouclickonacontrolobject,oneofthefollowinghappens,dependingon howthecontrolobjectisconfigured: Vistaperformsthespecifiedactionimmediately. Vistadisplaysaconfirmationmessage.ClickYestoproceedorNotocancelthe operation. Vistarequestsapassword.TypeyourlogonpasswordthenclickOKtoproceed. Dependingonthefunction,adialogboxrequestingthemeterpasswordmayalso appear.Ifso,typethemeterpasswordthenclickOKtoproceed.
Page 107
Plotting Logged Data

ThissectiondescribeshowtouseandcustomizetheLogViewPlottertoview loggeddatainagraphicalrepresentation.UsetheLogViewPlottertographically showtrendsinnumericdata,displayloggedwaveforms,displayphasor diagrams,andperformharmonicsanalysisonwaveformdata.Youcanalsoplot Sag/Swellvoltagedisturbancesandcomparethemtoindustrystandardvoltage tolerancecurves(suchastheCBEMA/ITICcurve).
NOTE
You can copy information displayed by Vista Log Viewers to the Windows Clipboard and paste it into other Windows applications.

1. Selectdatafromadatalogviewer: Tographtrendsforallparametersoveraparticulartimespan,selecta groupofrows. Tographatrendforaspecificparameterusingallavailablerecords,select anentirecolumn. Tographmultipleparametersoveraspecifictimespan,selectthefirstcellin thedesiredrangeanddragtohighlighttothelastcelloftherange. 2. SelectEdit>PlotSelectedDataorclick .
VistaplotsthedataanddisplaysitintheLogViewPlotterwindow.
Page 108
The Log View Plotter Interface

TheLogViewPlotterisaVistawindowthatgraphicallydisplaysselecteddata.
Legend
Calculations Window
ThedefaultdisplayisthePlotDisplaytab.Dependingonthetypeofdataselected, theLogViewPlottermayalsoofferaHarmonicsAnalysistabandaPhasor Diagramtab. Inallcases,theLogViewPlotteroffersadditionalinformationintwofloating boxes:theLegendandtheCalculationswindow.
The Legend
Eachlineorbarinthegraphisrepresentedbyapatternofthesamecolorinthe legend.
TIP
Click on the curve sample in the legend to select its equivalent in the graph.
Displaying the Legend 1. 2. 3. RightclickonthebackgroundoftheLogViewPlotterwindow. SelectGraphOptionsinthepopupmenu.TheGraphOptionsdialogbox appears. SelecttheShowlegendcheckboxthenclickOK.
Page 109
The Calculations Window

TheLogViewPlottercalculatesseveralvaluesforeverylineorbarinthegraph. YoucanviewtheresultsofthesecalculationsintheCalculationswindow. TheCalculationswindowupdatesautomatically,displayingarangeofcalculated valuesbasedonthecurrentlyselectedparameter.Bydefault,allvaluesdisplayed intheCalculationswindowarecalculatedfromthefirstparameter.Toviewthe calculationsforadifferentparameter,selectthelineorbaryouwant. Forexample,toviewthecalculationsforacurveonthePlotDisplaytab,clickon thecurvelineinthegraphoronitslinepatterninthelegend.Whenyouclicka differenttab,theCalculationswindowdisplaysthevaluesrelevanttothattab. Displaying the Calculations Window 1. 2. 3. RightclickonthebackgroundoftheLogViewPlotterwindow. SelectGraphOptionsfromthepopupmenu.TheGraphOptionsdialogbox appears. SelecttheShowcalculationscheckboxthenclickOK.
Changing Graph Options

WhenusingtheLogViewPlotter,youcanadjustthegraphoptionstochangethe titleofagraphorthewaydataisdisplayed. 1. RightclickonthegraphbackgroundthenselectGraphOptions.TheGraph Optionsboxappears. TypeanameforthegraphintheTitlebox.Thisnameappearsinthetitle baroftheLogViewPlotterwindow.ThedefaultisLogViewPlotter. SelectorcleartheShowlegendandShowcalculationscheckboxesto showorhidethelegendandCalculationswindow. SelecttheAligntriggerscheckboxtoalignthetriggertimesofall waveformsinthegraph.(Whenmultiplewaveformsareplotted,their triggertimesarenotalwayscorrelated.) SelectSeparatecurvesverticallytodisplayeachcurveseparately.
NOTE
See Calculating Harmonics Using More Than One Cycle on page 115 for more information on the System Frequency and # of cycles for harmonics options.
2.
ClickOKtosaveyourchanges.
Page 110
Displaying Curve Data in a Table

AfteryouplotdataintheLogViewPlotter,youcanselectacurveanddisplayits datapointsinatable.ThisoptionisonlyavailableonthePlotDisplayand HarmonicAnalysistabs. 1. RightclickonthecurvelineinthePlotDisplayorHarmonicAnalysistaband selectDatafromthepopupmenu.
PlotDisplaytab:Thedatapointsaredisplayed.TheXcolumnliststhex axiscoordinatesandtheYcolumnliststheyaxiscoordinates.Thefirst column(#)assignsanumbertoeachsetofpoints. HarmonicAnalysistab:Awindowappearslistingeachharmonicnumber andthemagnitudeofeachharmonicforeachparameter.Thefirstcolumn numberstherows.TheXcolumnliststheharmonicsnumberandtheY1, Y2,Y3,etc.,columnslisttheharmonicvaluesforeachbarintheharmonics histogram.RowswheretheXvalueisnotaninteger(i.e.,.5,1.5,2.25) containsubharmonicvalues. 2. ClickFormattochangethenumberofsignificantdigitsdisplayedintheXand Ycolumnsortochangethewidthofthesecolumns. Widthdefinesthenumberofcharactersthecolumncandisplay. Precisiondefinesthenumberofsignificantdigitsdisplayed. 3. ClickCopytocopycolumnstotheclipboard.Thisallowsyoupasteacopyofthe dataintoanotherapplication,suchasaspreadsheetprogramoratextfile.
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.
Page 111
Viewing the Plot Display Tab

ThePlotDisplaytabdepictsthespecifiedparametersascurvesagainstagraph.
Eachparameterisplottedinadifferentcolor.Thelegendidentifiesthecolorof eachcurveintheselectionandwhatitrepresents.Clickonacurvetoselectitor rightclickonittodisplayadditionaloptions.Thetimestampatthetopofthetab identifiesthefirstpointintheselectedcurve. Theverticalaxis(yaxis)representsthespecifiedrange;thehorizontalaxis(xaxis) representstime.Vistaautomaticallyadjuststhescaleoftheyaxisandxaxisto accommodatethelargestparameter(s)intheselection.Rightclickoneitheraxisto changethescaleofitsproperties;rightclickontheaxisnumberstochangetheir format. Thetimeunitindicatorinthelowerrightcorneridentifiesthetimescaleofthex axis(forexample,hindicatesanhourlyscale).Possibletimescaleunitsinclude months,days,hours,minutes,andseconds. Zooming in on the Plot Display Tab TozoominonthePlotDisplaytab,clickontheZoombutton thendraga selectionboxaroundtheareayouwanttoview.Toviewtheentireplot,clickthe Restoreto100%button .
Page 112
Calculations Window Parameters for the Plot Display Tab TheCalculationswindowupdatesautomatically,displayingthefollowingvalues forthecurrentlyselectedcurve:
Value Label
Cursor 1 Cursor 2 Delta C Min Max dpeak Avg
1
Description
The timestamp and the y-value of the selected curve at Cursor 1. The timestamp and the y-value of the selected curve at Cursor 2. The time difference between Cursor 1 and Cursor 2, and the difference between the y-values at Cursor 1 and at Cursor 2. The minimum value of the selected curve between the two cursors. The maximum value of the selected curve between the two cursors. The maximum peak-to-peak value of the selected curve between the two cursors (Max-Min). The average value of the selected curve between the two cursors. The root mean squared value of the selected curve between the two cursors. 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 is displayed in kWh.)
RMS 1 Int(H) 1
1
The last three values (Avg, RMS, Int(H)) on the Calculations 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.
Using the Cursor Lines

ThereareverticalcursorlinesateitherendofthecurvesintheLogViewPlotter. ThesecursorlinesdefinethestartandendpointsusedbytheCalculations window.Bydefault,Cursor1islocatedontheleftmostpointoftheselectedcurve andCursor2ontherightmostpoint.
Todefineanewstartpoint,dragCursor1alongthecurvetothenewstartpoint. RepeatthisprocedurewithCursor2todefineanewendpoint.Youcanalsouse thearrowkeystomovetheactivecursorleftorright.Theactivecursorisidentified byasmallboxthatappearswherethecursorlinemeetsthecurve.UsetheTABkey toswitchtheactivecursorbetweenCursor1andCursor2. Asthecursorlinemovesfrompointtopointalongthecurve,theinformationin theCalculationswindowisupdated.YoucannotdragCursor1pastCursor2or viceversa.
Page 113
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. Rightclickonthegraphbackgroundtodisplaythepopupmenu.Inthelast sectionofthepopupmenu,highlightthecurveyouwanttochange. Thecurvessubmenuappears.(Youcanalsoaccessthesubmenudirectlyby rightclickingontheparametercurveoronitscurvesampleinthelegend.) 2. 3. SelectOptionsfromthesubmenu.TheCurveOptiondialogboxappears. Chooseoneofthefouraxisoptionsfortheselectedparameter.Theaxisis indicatedbythelocationofthetickmarks. SpecifyaYoffsetifrequired.Thisshiftstheselectedparameteruptheyaxis(or downforanegativenumber)bytheamountyouspecify. 4. ClickOK.Anewaxisappearswithadefaulttitleandascaleappropriateforthe selectedparameter. Thescaleofthedefaultaxiscanalsobeadjustedtoaccommodatetheremaining curves.Aparameterhasanasteriskafteritinthelegendifithasbeenoffset. Repeatthesestepsforeachparameterthatyouwanttodeindexfromthedefault axis.Youcanassignmorethanoneparametertoanaxisandthescaleadjusts accordinglytoincorporateeachnewparameter.Forexample,ifyouhaveplotted threevoltageparametersandthreecurrentparameters,youcanselectthecurrent curvesandassigneachofthemtoanothercommonaxis,leavingthethreevoltage curvestosharethedefaultaxis.
Displaying Power Factor Data

Ifyouhaveplottedpowerfactordata(fromhistoricallogs)intheLogViewPlotter, youcanimprovethedisplaytoavoiddiscontinuitybysettingtheverticalaxisto PowerFactorDisplay(100,+100). Setting Any Vertical Axis for Power Factor Display 1. 2. Rightclickontheverticalaxisorrightclickonthegraphbackgroundand selecttheaxisafteryouhaveplottedthepowerfactordata. SelectPowerFactorDisplayfromthepopupmenu.Acheckmarkappears besidetheoptiontoindicatethatitisselected.
Youcanplotothernonpowerfactordataonthesamegraph;however,youshould notplotthenewdataonthesameaxisasthepowerfactordata.Deindexthenew dataonaseparateaxisasdescribedinDeindexingaParameterorOffsettinga ParameterontheYaxisonpage 114.
Page 114
Viewing the Harmonics Analysis Tab
Viewing the Harmonics Analysis Tab

Ifanyoftheparametersyouhaveplottedisawaveform,youcandisplaya histogramofthesignalsharmoniccontentbyselectingtheHarmonicstabonthe LogViewPlotterwindow.Theresultinghistogramshowstheharmonicsforall waveformsintheplot.
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. Calculating Harmonics Using More Than One Cycle Bydefault,theharmonicsarecalculatedusingonecycle.Youcanincreasethe numberofcyclesbyanypoweroftwocycles(i.e.,2,4,8,16,32or64)uptothe maximumnumberofcyclesavailableforthewaveform. 1. 2. 3. RightclickonthebackgroundofthegraphareathenselectGraphOptions. TheGraphOptionsdialogboxappears. Selectthenumberofcyclesoverwhichharmonicscalculationsaretobe performedfromthe#ofcyclesforharmonicslist. SelecttheappropriatefrequencyintheSystemFrequencybox,ifthe waveformyouareanalyzingcamefromasystemwithafrequencyotherthan 50Hzor60Hz.(Forexample,ifthewaveformwascapturedfroma400Hz systemusinga3710ACM,specify400Hzinthisbox.)
Page 115
Viewing the Phasor Diagram Tab
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.

Ifyouhaveplottedwaveformsforallthreevoltagesand/orcurrentsofyour system,youcanviewthisinformationasaphasordiagram.Thephasordiagram graphicallydisplaysthethreephases(voltagesand/orcurrents),showingtheir relativemagnitudesandangles. Youcanuseaphasordiagramtoevaluateimportantaspectsofyourpowersystem suchasvoltagebalance,perphaseloading,andtypeofload(orgenerator operatingmode).AphasordiagramalsoprovidesawaytoidentifyPTorCT wiringproblems.
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.
ThePhasorDiagramandcalculationsarederivedfromaonecyclewindow startingatCursor1onthePlotDisplaytab.Themagnitudeandangleofthe selectedphaseisdisplayedintheCalculationswindow.
Page 116
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.
Toeditaphasordisplayedonaphasordiagram,rightclickonaparameterinthe legendtodisplayapopupmenuwhereyoucanchangethephasorscoloror deletethephasorfromthediagram.
Symmetrical Components
TheLogViewPlottercalculatesthesymmetricalcomponentsofyourpower systemthepositive,negative,andzerosequencesrelativetothefirstphase forthecycleselected.Ifyouhaveplottedwaveformsforthreevoltagesand/or currents,youcanaccesstheirsymmetricalcomponentcalculations.Toproduce correctsymmetricalcomponents,thewaveformsmusthavebeenplottedinthe correctorder(forexample,V1,V2,V3notV1,V3,V2). Theanalysisofanunbalancedsystem,suchasdeterminingtheeffectsofasystem fault,ismadesimplerbyusingsymmetricalcomponents.Symmetrical componentsareamathematicaltoolthatallowsanysystemofthreeunbalanced phasorstoberepresentedbythreebalancedphasorsystems.Thetotalcurrentor voltageinanyphasewireisexpressedasthesumofthreebalanced,threephase components. PositiveSequenceComponents(1)theseconsistofthreephasorsthatareequalin magnitudeanddisplacedfromeachotherby120andhavethesamephase sequenceastheoriginalphasors. 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.
Page 117
Plotting Waveforms from Devices with High Sampling Rates
Viewing Symmetrical Components 1. 2. 3. 4. FromawaveformDataLogViewer(suchasWaveforms/SequenceofEvents), selectallthreephasesofafault(voltageorcurrent). SelectEdit>PlotSelectedData. DragtheCursorandmoveittothelocationofthefault. ClickonthePhasorDiagramtabtoviewtheSymmetricalComponentsinthe Calculationswindow.
Plotting Waveforms from Devices with High Sampling Rates

Waveformsfromdeviceswithhighsamplingratescanbequitelarge.Theselarge waveformsaresplitbyIONEnterpriseintoaseriesofsmallerwaveformswhen displayedinthedatalog.ToplotallthesectionsofthewaveforminVista,you mustselectalltherowsthatrelatetothewaveformbeforeyouclickthePlotbutton. Alltherowsrelatedtotheonewaveformhavethesametimestamp.Forexample, inthefollowingimage,youwouldselectrows28to34toplottheentirewaveform.
Whenthewaveformisdisplayed,youmayneedtozoomintoviewtheareaofthe waveformyouareinterestedin.Tozoomin,dragaselectionboxaroundthearea youareinterestedin.
Page 118
Adding Parameters to a Log View Plotter

AfteryouhavecreatedagraphandtheLogViewPlotterwindowisvisible,you canaddadditionalparameterstothegraphbycopyingandpastingthemintothe graph.Theseparameterscanbecopiedfromthesamedatalogviewer,adifferent datalogviewer,orfromadifferentWindowsapplicationsuchasMicrosoftExcel. Thexandyaxesareautomaticallyrescaledtoaccommodatethenewparameters. Whenaddingwaveformstothelogviewplotter,youcancorrelatealloftheir triggertimes.SeeCustomizingGraphandLegendOptionsonpage 124formore information.
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. 2. 3. Selecttherangeofcellsyouwanttoplot.Ensurethatitcontainsthesametype ofinformation(timestamps)asthedataalreadybeingplotted. SelectEdit>Copy. 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. 2. 3. Selecttherow(s)youwanttoaddintheEventLogViewer. SelectEdit>Copy. ClickonthetitlebaroftheexistingLogViewPlotterwindowthenselectEdit> Paste.Thecopiedeventrecordsareaddedtothegraph.
EacheventisrepresentedintheLogViewPlotterasadiamondsymbol.A diamondsymbolisaddedtothelegendanddiamondsymbolsappearatthe appropriateareasalongthetopofthediagram. Pointtoadiamondsymboltodisplayadescriptionoftheeventinthestatusbarat thebottomofthescreen.
Page 119
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. 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. 2. 3. Openthespreadsheetortextfile. Copytherangeofvaluesyouwanttoplot,includingthefirstcolumnandthe firstrow.Includeothercolumnsinyourselection,ifrequired. ClickonthetitlebaroftheLogViewPlotterwindowthenselectEdit>Paste. Theparametersyoucopiedandpastedareaddedtothegraph.Theaxisscales areadjustedautomaticallytoincludethenewdata. Youcandefineatriggerforwaveformrecordscontainingtimestampswhenyou copyrecordsfromotherapplications.Simplyaddanexclamationmarktotheend ofthetimestamptoindicatethatitisthetriggertime.Forexample,theexclamation markattheendof22/05/1998@02:00:41.035PM!indicatesthatthetriggeroccurred atthistime.
Page 120
Customizing the Log View Plotter Display

Manydisplayattributesforeachcurvecanbeadjusted.Inmostcases,ifyouright clickonanareaofthegraph,eitherapopupmenuoradialogboxappearswith configurationoptions.Unlessotherwisenoted,theoptionsyouspecifyfortheLog ViewPlotterwindowaresavedandrestoredeverytimeyouplotdatafromthe originaldatalogviewer.Ifyouplotdatafromadifferentdatalogviewer,itsgraph hasitsownoptionalsettings.
Customizing an Axis
AfteryouhaveplotteddataintheLogViewPlotter,usethefollowinginstructions customizetheaxisorgridlines,changeanaxislabelsformatoraddanaxistitle,or changethefontorcolorusedonallaxes.Youcanalsochangethescaleofanaxis. Configuring an Axis 1. Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight theaxisfromthemenutorevealthesubmenu.Youcanalsorightclickonthe axistoaccessthesubmenudirectly. SelectAxisPropertiesfromthesubmenu.Adialogboxappears.
2.
Range:MakechangesintheFromandToboxestoadjusttheaxisrange. Ticks:MakechangesintheMajoreveryandSubdividedbyboxesto adjustthefrequencyofmajorandminorticksrespectively. Grid:SelectorcleartheMajorandMinorcheckboxestoturngraph gridlinesonoroff.ClicktheStylebuttonstochangetothelinestyleor widthofmajorandminorgridlines. Logarithmicscale:Selectthischeckboxtoenablethelogarithmicscale option. Line:ClickthisbuttontodisplaytheLineParametersdialogboxand changethelinestyleorthewidthoftheaxis. 3. ClickOKtosaveyourchanges.
Page 121
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.Youcanalsorightclickonthe axistoaccessthesubmenudirectly. SelectAxisColor,MajorGridColor,orMinorGridColorfromthesubmenu. TheColordialogboxappears. SelectthecoloryouwantorclickDefineCustomColorsformoreoptions. ClickOKtosaveyourchanges. Theaxisorthemajororminorgridlineschangetothecoloryouselected. Changing the Format of the Axis Labels or Adding an Axis Title 1. Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight theaxisfromthemenutorevealthesubmenu.Youcanalsorightclickonthe axislabelstoaccessthesubmenudirectly. SelectAxisLabelsfromthesubmenu.TheAxisLabelsdialogboxappears. Selecttheformatinwhichyouwanttheaxislabelstoappear. Decimalisusedbydefault(forexample,.01,.02,.03)butifthelabelsaretoolarge ortoosmall,selectScientific(1.0x102,2.0x102,3.0x102...)orEngineering (1m,2m,3m...). 4. Determinetheaxistitle:selectNonetohavenoaxistitleorTexttoenteryour owntitle. Fortimebasedplots,thedefaultxaxistitleissifthetimestampsofthedata spansanumberofseconds,mnforminutes,hforhours,dfordays,m formonths.(ThisappliestothePlotDisplaytabonly.) Fornontimebasedplots(CBEMAorharmonics),youcanchangethetitle.Select Textandtypethetitleintheeditbox.Thetitlemustbeninecharactersorless. 5. ClickOKtosaveyourchanges.
2. 3. 4.
2. 3.
NOTE
If the first column of the source data includes a space or @ sign, 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. 2. 3. RightclickanywhereinthegraphbackgroundandselectGraphFont.The Fontdialogboxappears. Specifythefont,style,size,effectsandcoloroptionsthatyouwanttouseforthe axeslabels. ClickOKtosaveyourchanges.
Page 122
Customizing Curve Style

Whendisplayingmultipleparameters,Vistadistinguishesbetweenparameters usingcolor.Eachparameterislistedinthegraphlegendaccompaniedbyasample ofitsassociatedcurve.Thecolorofacurvecanbechangedafteryouhaveplotted dataintheLogViewPlotter. Ifcolorisnotenoughtodistinguishonecurvefromanotherforexample,ifyou plantoprintthegraphonablackandwhiteprinteryoucanchangethecurve styleafteryouhaveplotteddataintheLogViewPlotter. Bydefault: Eachcurveisshownbyathinlinethatconnectseachpointofdata.Youcan customizethestyleofeachcurveindependentlyandshoworhidethe coordinatesofeachdatapoint. Harmonicsaredisplayedinabargraph.Youcandistinguishbetween parametersbycustomizingthedisplaystyleofeachparameter.Displayoptions includebartype,hatching,widthandcolor. Usethefollowinginstructionstocustomizecurvestyles,barstyles,andcurve colors. Changing the Style of a Curve on the Plot Display Tab 1. Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight thecurvefromthemenutorevealthesubmenu.Youcanalsorightclickon theparametercurveinthediagramoritsentryinthelegendtoaccessthesub menudirectly. SelectCurvePropertiesfromthesubmenu.TheCurveStyledialogbox appears. SelectthetypeofcurveyouwantfromtheTypelist.Vistaofferssevencurve types:asimpleline,alinewithsymbols,ascatterplotofmarkers,horizontal orverticalbars,or3Dhorizontalorverticalbars. SelectSpline(availableforLineorLine+Symboltypes)ifyouwanttheline thatconnectseachpointtobeasmoothcurve.Ifyouleaveitcleared,each pairofpointsisconnectedbyastraightline. SelectFillArea(availableforLinetype)tofilltheareaunderthecurvewith thelinecolor.Clearthecheckboxtoleavetheareaunderthecurve transparent. TheMarkersectionisavailableforLine+SymbolandScatteredtypesof lines.Specifytheshape,size,andstyleofthemarkerusedforthepoints.The Styleoptionsapplyonlytogeometricshapes(e.g.,circles,boxes,diamonds, etc.). Foranylinetype,clickLinetochangethewidthandthestyle(e.g.,solid, dotted,dashed,etc.)oftheline.Forbargraphtypes,adialogboxappears whereyoucanspecifythehatchingpatternandthewidthofthebars. 3. ClickOKtosaveyourchanges.
2.
Page 123
Changing the Bar Style for the Harmonics Analysis Tab 1. 2. Rightclickonthebar(oronitscurvesampleinthelegend)andselectCurve Properties.TheBarGraphConfigurationdialogboxappears. SelectthetypeofbartousefromtheTypelist.Thisselectionisappliedtoallbars inthegraph.Threebarstylesareavailable: GroupBars:Showsbarssidebyside DeepBars:Showsbarsonebehindtheother StackedBars:Showsbarsstackedoneontopoftheothervertically 3. 4. SelectahatchingstylefortheselectedbarfromtheHatchinglist.Thisselection isappliedtothecurrentlyselectedbaronly. SethowwideyouwanteachbartobeintheWidthtextbox.Thespecifiedwidth isappliedtoallbarsinthegraph.Thedefaultdependsuponthenumberof parameters. ClickOKtosaveyourchanges.
5.
Changing the Color of a Curve 1. Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight thecurvefromthemenutorevealthesubmenu.Youcanalsorightclickthe curveinthediagramoritsentryinthelegendtoaccessthesubmenudirectly. SelectCurveColorfromthesubmenu.TheColordialogboxappears. SelectthecoloryouwantorclickDefineCustomColorsformoreoptions. ClickOK.Thecurvechangestothecoloryouselected.
2. 3. 4.
Customizing Graph and Legend Options

AfteryouhaveplotteddataintheLogViewPlotter,youcanchangethecolorof thegraphingarea(andthelegend)anddefineafontforthelegend. Changing the Color of the Graphing Area 1. 2. 3. RightclickanywhereinthegraphbackgroundandselectBackgroundColor. TheColordialogboxappears. SelectthecoloryouwantorclickDefineCustomColorsformoreoptions. ClickOK.Thegraphingareachangestothespecifiedcolor.
Changing the Font Used in the Legend 1. 2. 3. Rightclickonthebackgroundofthelegend.TheFontdialogboxappears. Specifythefont,style,size,effects,andcoloroptionsthatyouwanttouseforthe legendtext. ClickOKtosaveyourchanges.
Page 124
Overlaying Curves in the Log View Plotter
Removing Graph Parameters

AfteryouhaveplotteddataintheLogViewPlotter,youcanremoveaparameter fromthegraph. 1. Rightclickonthegraphbackgroundtodisplaythepopupmenu.Highlight thecurveyouwanttoremovefromthemenutorevealthesubmenu.Youcan alsorightclickthecurveinthediagramoritsentryinthelegendtoaccessthe submenudirectlybyrightclickingonthecurve. SelectDeleteCurvefromthesubmenu.Thecurveisdeletedwithoutfurther prompting.
2.

AfteryouplotdataintheLogViewPlotter,youcanoverlayacurveontoyour graphtohelpanalyzesag/swelldata.Thisappliestodevicesthatmeasure disturbancesinvoltageandstorethemagnitudeanddurationofthese disturbances.WhenthesevaluesareinsertedintotheION_Datadatabase,they provideaseriesofcoordinatesthatcanbeplottedonavoltagetolerancecurve.A voltagetolerancecurveisoftenusedtocategorizetheseverityofavoltage disturbance.
NOTE
Most Vista queries are plotted against timestamps (with the 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.
Vistaprovidescommoncurvesorvoltagetoleranceenvelopesthatcanbeusedas overlaysintheLogViewPlotter: CBEMA/ITIC:Thesecurves(describedbytheIEEE446standard)definean upperandalowerboundonthetypesofdisturbancesthatelectricalequipment islikelytotolerate.Itplotsdisturbancemagnitudeagainstdisturbanceduration andindicatesatwhatpointsavoltagedisturbanceislikelytodisruptordamage equipment.Pointsnearoroutsidethevoltagetoleranceenvelopeindicate eventsthatcouldinterruptordamageelectricalequipment.
Page 125
SEMIF470200:Thisspecificationdefinesthevoltagesagtolerancecapability requiredforsemiconductorprocessingequipment,thoughitisnowusedby otherindustries.Accordingtothespecification,equipmentmusttoleratesagsto 50%ofnominalvoltageforupto200milliseconds,sagsto70%ofnominal voltageforupto0.5seconds,andsagsto80%ofnominalvoltageforupto1 second.Pointsabovethevoltagetolerancecurveindicatedisturbancesthat exceedthesespecifications. Overlaying Curves on Plotted Data Tooverlayoneoftheprovidedcurves,youneedadatalogviewerthatcontains themagnitudeanddurationvaluesforthesag/swelldisturbances.TheDuration columnmustbesetastheXparameterfortheLogViewPlotteritappearsinblue inthedatalogviewertable(SeeXParameterforLogViewPlotteronpage 149 formoreinformationonsettingtheXparameterforDataLogViewers).The Magnitudevaluescanbeinanyoneoftheothercolumns. 1. 2. 3. 4. 5. IntheDataLogViewer,selectarangeofcellstobeplotted. SelectEdit>PlotSelectedData.TheLogViewPlotterwindowappearswith DurationasthexaxisandMagnitudeastheyaxis. RightclickonthegraphandselectOverlayCurvefromthepopupmenu.The OverlayCurvedialogboxappears. Selectthetextfilecontainingthecurvedatathatyouwanttooverlay(fromthe ...\IONEnterprise\config\lvpdirectory). ClickOpen.Theselectedcurveappearsinthegraph. Youcanrevieweachpointinyourdataandseewhereitfallsinrelationtothe curve.
NOTE
This process automatically changes your x-axis scale to logarithmic.
Page 126
Creating and Customizing a User Diagram
Creating and Customizing a User Diagram

Thefollowingsectionsdescribe: Howtocustomizeanexistinguserdiagrambycustomizingtheappearanceand functionofadiagramobjectordiagramwindow. Howtocreateanewuserdiagram. Thevarioustypesofdiagramobjectsandhowtouseeachtypetoaddfunction toyouruserdiagram.
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.
NOTE
Any changes you make to a default diagram affect all other devices using the same diagram.
Creating a New User Diagram

Tocreateanewuserdiagram,logintoVistaandselectFile>New.Anew(blank) userdiagramappears.Youcanonlycreateanewuserdiagramifyouhave Supervisorlevelaccess. Toautomaticallygenerateanetworkdiagrambasedondevicesaddedusing ManagementConsole,seeGeneratingaNetworkDiagramonpage 94.
Saving a User Diagram

Tosavechangesyoumadetoauserdiagram: 1. 2. SelectFile>SavetosaveaneworexistinguserdiagramorFile>SaveAsto saveauserdiagramunderanewname.TheSaveNewDiagramboxappears. TypeanameforthediagramintheFilenameboxthenclickSave.
Bydefault,Vistapointstotherootofthe\uddirectorywhenyouattempttosave anewdiagram.Ifrequired,youcancreateanewfolderwithinthatdirectoryto storeyourcustomizeddiagrams,ratherthanstoringtheminthe\udfolder.
NOTE
This \ud directory should be located on a networked drive where it can provide multiple users with access to saved user diagrams.
Page 127
Editing a User Diagram
Editing a User Diagram

Toeditauserdiagram,theDiagramObjectstoolboxmustbedisplayed.Toopen thetoolbox,selectOptions>ShowToolbox.IftheShowToolboxoptionisgrayed out,youruseraccountdoesnothavesufficientaccess;contactyoursystem administrator.
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.
Adding a Diagram Object to a User Diagram

Youcanaddanewdiagramobjecttoauserdiagrambydraggingitfromthe DiagramObjectstoolbox.
Types of Diagram Objects

DiagramobjectsprovidetheinterfacetoIONregistersinyournetwork.Each diagramobjectperformsasinglefunction.Forexample,asinglenumericobject placedinauserdiagramdisplaysnumericdatafromasinglesource.Thereare seventypesofdiagramobjectsavailableontheDiagramObjectstoolbox: GroupingObject:Groupanumberofrelatedobjectswithinaseparategrouping window.Clickonagroupingobjecttoopenthegroupingwindowanddisplayits contents. TextBox:Displayindependentheadings,titles,andcommentsinauserdiagram. NumericObject:DisplayrealtimenumericvaluessuchasVolts,AmpsorkW. StatusObject:DisplayBooleandata(On/Off,Yes/No,1/0,etc.)toindicatethe statusofadigitaloutput(relay),digitalinput(statusinput)orsetpoint.Theimage canbecustomizedanditcanbeconfiguredtouseanimation. DataLogViewer:DisplaydatalogsstoredintheION_Datadatabase(including archivesfrompreviousversionsofIONEnterprise),showwaveformdata (waveformcapture,waveformrecorder)andtrends(datarecorders)usingtables, andprovidedataforplotting.
Page 128
Cutting, Copying, and Pasting a Diagram Object
EventLogViewer:DisplayeventlogsstoredintheION_Datadatabase(including archivesfrompreviousversionsofIONEnterprise),showeventrecordsfrom devicesandothercomponents,anddisplayandacknowledgealarms. ControlObject:Sendcommandstoadeviceonyournetwork(forexample,clear anenergyaccumulator,togglearelay,resetacounter,oradjustthevalueofan analogoutputdevice). Toaddafunctiontoauserdiagram,choosethetypeofdiagramobjectyouwant, dragitintotheuserdiagramthenlinkittotheappropriateregisterinanode.The followingsectionsexplainhowtoaddandlinkadiagramobject. SeeMonitoringYourSysteminVistaonpage 96formoreinformationonthe functionandbasicuseofeachtypeofdiagramobject.
Adding a Diagram Object to a User Diagram

1. 2. SelectOptions>ShowToolboxifthetoolboxisnotdisplayed.Thetoolbox appearsintheworkspace. Clickonthediagramobjectyouwantanddragitfromthetoolboxtothe diagram. Inmostcases,theobjectappearsinthewindowastheiconfromthetoolbox. However,therearetwoexceptions: Atextboxappearsinthewindowasarectangularboxthatdisplaysthe defaultmessage:Yourtextgoeshere. Anumericobjectappearsinthewindowasarectangularboxwithaonly colon(:).Thisindicatesthattheobjectisnotyetlinkedtoanode. Theobjectisnowreadytobelinkedtoarealtimeorloggeddatasource.See LinkingaDiagramObjecttoaDataSourceonpage 146fordetailsonlinking anobjecttoasource.
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, either relink each diagram object or change the default window link before placing the objects.
Cutting, Copying, and Pasting a Diagram Object

UsetheCut,CopyandPastecommandsontheEditmenutomakeacopyofa diagramobjectandpasteitintoanotherwindoworuserdiagram. Youcanpastethecopyasmanytimesasyouliketocreatemultipleversionsofan object.Eachcopyretainsalloftheattributesandlinkageinformationofthe original.
Page 129
Copying a Group of Diagram Objects to a Framework
Cutting or Copying a Diagram Object 1. 2. Selecttheobject(s). Dooneofthefollowing: Toremovetheoriginal,selectEdit>CutthenclickYestoconfirmthe deletionorNotocancel. Toretaintheoriginal,selectEdit>Copy.TheselectioniscopiedtotheION Enterpriseclipboard.
NOTE
The ION Enterprise clipboard is a temporary storage area that holds any information cut or copied from Vista. It should not be confused with the Microsoft Windows Clipboard.
AftertheobjectiscopiedtotheIONEnterpriseclipboard,youcanpasteitintothe activewindow. Pasting a Diagram Object 1. 2. Selectthewindowyouwanttopasteto. SelectEdit>Paste.Theobjectappearsintheactivewindow.
Copying a Group of Diagram Objects to a Framework

AVistaframeworkisatemplatethatyoucanusetorecordthelayoutofagroup ofdiagramobjects. WhenyouselectEdit>Copytoframework,Vistasavestheselection(including thetypeandlocationofeachdiagramobject)asafile.YoucanthenusethePaste fromframeworkcommandtocopythegrouplayouttoanotherdiagramor groupingwindow.Thisisusefulforreplicatingasingleconfigurationonmultiple workstations.Youcanstoreasavedframeworkwithitsownfilenameandretrieve itanytime. Copying a Group of Diagram Objects to a Framework 1. 2. 3. Selectthegroupofobjectsyouwanttocopy. SelectEdit>Copytoframework.TheCopytoframeworkdialogboxappears. TypeanamefortheframeworkintheFilenameboxthenclickSave.The frameworkfileextension(.fwu)isaddedautomatically. Theselectionissavedasaframework. Afteryousaveagroupofobjectsasaframework,youcanpasteittoanother window.
Page 130
Adjusting Diagram Object Layout and Size
Pasting a Group of Diagram Objects from a Framework 1. 2. 3. Selectthewindowyouwanttopasteto. SelectEdit>Pastefromframework.ThePastefromframeworkdialogbox appears. NavigatetotheframeworkyouwanttopasteandclickOpen.Theframework selectionappearsintheactivewindow.

Thissectiondescribeshowtomove,alignandresizediagramobjects.
Moving Diagram Objects

Youcanmoveasinglediagramobjectoragroupofdiagramobjectswithinasingle windoworfromonewindowtoanother. 1. 2. Selecttheobject(s)youwanttomove. Dragtheselectedobject(s)tothenewlocation.
Youcanalsousethearrowkeysonthekeyboardtomovetheselecteddiagram object(s)onespaceatatime. Whendiagramobjectsoverlap,usetheSendtoBackcommandtoplaceoneobject beneaththeothers.SelecttheobjectthenselectEdit>SendtoBack(orpress CTRL+K).
Resizing a Single Diagram Object

Youcanadjustthesizeofadiagramobjecttomakeitlargerorsmalleroryoucan stretchithorizontallyorverticallytochangeitsshape. 1. 2. Clickonthediagramobjecttoselectit. Dooneofthefollowing: Tomaketheobjectlargerorsmaller,dragacornerhandle. Tostretchtheobjecthorizontallyorvertically,dragamiddlehandle.
Resizing a Diagram Object(s) to a Standard Size

TheSizetabintheLayoutdialogboxletsyouautomaticallyresizeadiagramobject orgroupofdiagramobjectstoasetofstandarddimensions. 1. 2. 3. Selectthediagramobjectsyouwanttoresize. SelectEdit>Layoutorclick SelecttheSizetab. .TheLayoutdialogboxappears.
Page 131
4.
Editthehorizontalandverticaldimensionsoftheobject(s)asrequired. SelectNochangetomakenochangestothatdimension. SelectShrinktosmallestorGrowtolargesttoadjustthewidthand/or heighttomatchthatofthesmallestorlargestobjectintheselectedgroup. SelectPixelstoentertheexactwidthorheightinpixels. Youcanalsocombinehorizontalandverticaloptionsonasingleselection.For example,ifyouselectShrinktoSmallestintheHorizontalsectionand30pixels intheVerticalsection,theentireselectionisresizedtothewidthoftheshortest objectandthespecifiedheightof30pixels.
5.
ClickOKtosaveyourchanges.
Aligning Diagram Objects Relative to Each Other

TheAligntaboftheLayoutdialogboxletsyouspecifythehorizontalandvertical arrangementoftheselectedobjects. 1. 2. 3. Selectthediagramobjectsthatyouwanttoalign. SelectEdit>Layoutorclick .TheLayoutdialogboxappears.
SelecttheAligntabtospecifythehorizontalandverticalalignmentofthe object(s). TheoptionsintheHorizontalandVerticalareasdeterminethecriteriabywhich youcanaligndiagramobjects.Forexample,ifyouselectLeftsidesunder HorizontalandSpaceevenlyunderVertical,Vistaalignsallobjectsinthe selectionbytheirleftsides(usingtheleftmostobjectforreference)and distributesthemevenlyalongaverticalaxis.
4.
SelecttheoptionsyouwantthenclickOK.
Aligning Diagram Objects on a Grid

TheGridtaboftheLayoutdialogboxletsyouactivateandconfigureaninvisible grid.Objectsplacedontothegridsnaptothenearestgridlinetohelpalignand spacethemevenly. Toactivateordeactivatethegrid: 1. 2. 3. SelectEdit>Layoutorclick SelecttheGridtab. Selectoneofthefollowingoptions: Nogridturnsthegridoff. Gridsizeinpixelsactivatesthegrid.TypeanumberintheGridsizein pixelsboxtospecifythesizeofthegrid(distancebetweengridlines). 4. ClickOKtosaveyourchanges. .TheLayoutdialogboxappears.
Page 132
Customizing a Diagram Object

Afteryouhaveplacedandlinkedadiagramobject,youcancustomizeit.Right clickonadiagramobjectineditmodetodisplaytheconfigurationoptions availableforthatobjecttype.

1. 2. 3. Rightclickthediagramobject.The<Object>Configurationdialogboxappears (where<Object>isthetypeofdiagramobjectselected). Selecttheappropriatetabandmakeyourchanges.Repeatthisstepfortheother tabsuntilyouhavemadeallyourdesiredchanges. ClickOKtosaveyourchangestothediagramobject.
Theoptionsavailablevarydependingonthetabandtheobjectselected.Seethe sectionsbelowfordetailsontheoptionsavailablefordifferenttabsandobjects.
The Preview Pane

UsethePreviewpanetoviewhowyourproposedchangeswillappearinthe diagram. Forsometabs,youaccessdialogboxesbyrightclickingontheimageinthe Previewpane(forexample,theDisplaytabofanumericobject).Moreinformation isgivenintherelevantsectionsthatfollow.
Available Configuration Options

Thefollowingtableliststhevariousconfigurationoptionsavailableforeachtype ofdiagramobject.
Available Option Tabs

Caption Grouping Object Text Box Object Numeric Object Status Object Data Log Viewer Event Log Viewer Control Object x x x x x x
1 2 3
Text
Edit Text
Link (or Node)1 x
Query Server2 x
Display x
Action x
Box
Annunciation
Query3
Alarming
x x x x x
x x x x x x x x x x x x x x x x x x 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 148 for information on configuring this option.
Page 133
Caption Options
Caption Options
Toviewcaptionoptions,rightclickontheobjectthenselecttheCaptiontab. UsetheCaptiontabtoaddcustom,userdefinedtexttoadiagramobject.The Captiontabisavailableforthefollowingdiagramobjects:Grouping,Numeric, Status,DataLogViewer,EventLogViewer,andControl. TheCaptiontabcontainsthreesections:Caption,Font,andPosition. TheCaptionsectiondetermineswhetheradiagramobjectdisplaysatextual commentalongwiththediagramobjectsicon.Thissectionhasthreeoptions: SelectNonetodisplaynocaption. SelectUsedefaulttodisplaythedefaultVistacaption(i.e.,thedevicenameor datasource). SelectUsecustomtodisplaythetextthatyoutypeintothefieldprovided. TheFontsectionallowsyoutochangethefontusedinacaption.Thissectionhas twooptions: SelectInheritfromparentwindowtousethedefaultfont. SelectCustomtospecifyacustomfont.ClickFonttodisplaytheFontdialogbox andchangethefont,size,styleorcolor. ThePositionsectionhastwooptions: SelectToptoplacethecaptionabovethediagramobject. SelectBottomtoplacethecaptionbelowthediagramobject.
Text Options
Somediagramobjectshaveatextlabelintegratedintothedisplay.Toeditthe appearanceofthislabel,usetheoptionsofferedontheTexttab.TheTexttabis availableforthefollowingdiagramobjects:Numeric,Status,Control,andText.
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.
ToviewtheTextoptions,rightclickontheobjectthenselecttheTexttab.TheText tabhastwosections:FontandPosition. TheFontsectionhastwooptions: SelectInheritfromparentwindowtousethedefaultfont SelectCustomtospecifyacustomfont.ClickFonttodisplaytheFontdialogbox andchangethefont,size,styleorcolor. ThePositionsectionhasthreeoptionsLeft,CenterandRighttodefinethe alignmentofthetextinrelationtothediagramobject.UsethePreviewarealocated besidetheTexttabtoviewyourproposedchanges.
Page 134
Edit Text Options
Edit Text Options

ToviewtheEditTextoptions,rightclickontheobjectthenselecttheEditTexttab. UsetheEditTexttabtospecifyatextmessageforthetextbox.TheEditTexttabis availableonthetextboxobjectonly. TheEditTexttabhastwooptions: Usedefaultdisplaysthewindowlinkinformation(i.e.,thenode). Usecustomdisplaysyourcustomtextmessage. Ifyouselectcustom,usethetextboxtoenteryourtext.Thetextboxsupports multiplelinesoftext.Ifyourmessageappearsincompleteortruncatedafteryou entertextandclickOK,youcanadjustthedimensionsofthetextboxobject.To resizeatextbox,selectitthendragitshandles. Thefontusedinthetextboxisbasedonthedefaultsettingspecifiedfortheactive window.UsetheTexttabtospecifyadifferentfontorpositionforthetextbox.Use theBoxtabtospecifyaborderstyleorchangethebackgroundcolor.
Link Options
Toviewthelinkoptions,rightclickontheobjectthenselecttheLinktab. UsetheLinktabtolinkadiagramobjecttoarealtimesource,andtospecifyanew textlabel.TheLinktabisavailableforthefollowingdiagramobjects:Numeric, Status,andControl.
NOTE
To set a real-time source for a grouping object, use the Node tab.
TheLinktabcontainstwosections:LinkandLabel. UsetheLinksectiontospecifyarealtimesourceforthediagramobject.See LinkingaNumeric,StatusorControlObjectonpage 146formoreinformation. UsetheLabelsectiontochangetheobjectstextlabel.TheLabelsectionhasthree options: SelectNonetodisplaynolabel. SelectUsenodelabeltodisplaythenodesregisterlabel.Thisisthedefault. SelectCustomtodisplaythelabelthatyoutypeintothetextfieldprovided.The customlabelsyoucreatearestoredintheuserdiagramandareonlyavailableto usersofyourdiagram.
Page 135
Query Server Options
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 LinkingaDataLogViewerorEventLogVieweronpage 147formore information. TheQueryServertabisalsoavailableongroupingobjectsandanyobject configuredtoopenagroupingwindoworuserdiagram.Inthiscase,usethe QueryServertabtospecifyadefaultQueryServerfortheassociatedgrouping windoworuserdiagram.SeeQueryServer:SettingaDefaultQueryServerfora Windowonpage 157formoreinformation.
Display Options
UsetheDisplaytabtocustomizetheappearanceofadiagramobject.TheDisplay tabisavailableforthefollowingdiagramobjects:Numeric,Status,Control,and Grouping. TheDisplaytaboffersauniquesetofoptionsforeachtypeofdiagramobject.To viewthedisplayoptions,rightclickonthediagramobjectthenselecttheDisplay tab.
Customizing the Display of a Numeric Object

Numericobjectsdisplayrealtimedatainyouruserdiagram.Thedefaultnumeric objectappearsasarectangularalphanumericdisplaywithasingledecimalplace ofresolutionandnounitsymbol.Youcancustomizethedisplaytochangeanyof thesedefaultelements.
NOTE
Vista supports a maximum of 59 non-alphanumeric numeric objects within a single window. To change the way numbers are displayed (thousands separator and decimal point), use 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.)
Setting Display Style TheDisplaystyleboxletsyouselectanewstylefromthelistofavailablechoices. Thefollowingstylesareavailable:
Page 136
Display Options
Alphanumeric
Partial Dial
Full Dial
Horizontal Bar Timestamp with value Timestamp only
Vertical Bar
Scrolling Bar
Arc Meter
PC Timestamp
Alphanumeric:Defaultstyle.Generalusetextdisplay. PartialDial:Generalusevoltage,current,harmonicdistortion,etc. FullDial:Powerfactor,bidirectionalpowerflow,etc. HorizontalBar:Generaluse. VerticalBar:Generaluse. ScrollingGraphDisplay:Generaluse.Displaysrecentreadingsonascrolling graph. ArcMeterDisplay:Generalusevoltage,current,harmonicdistortion,etc. TimestampedDisplay:Displaysthevalue,andthedateandtimethevaluewas measuredbythedevice.Usefulformin./max.values. TimestampOnly:Sameastimestamped,butdoesnotdisplayavalue.Canbe usedasaclock. PCTimestampedDisplay:Displaysthevalue,andthedateandtimethevalue wasreceivedbyVista. Setting Units and Resolution UsetheUnitsboxtotypetheunitnameforthemeasuredvalue(e.g.,Voltsor Amps).Thisnameisdisplayedonthenumericobject. Incertaincases,thevalueisscaled.Forexample,iftheunitnamebeginswithK, M,orG(e.g.,kVorMVolts),thedisplayedvalueisadjustedaccordingly. However,iftheunitcontainscertainletters(i.e.,kWorkVA),thescalingfactoris reducedby1,000(forexample,iftheunitbeginswithK,thevalueisnotscaledand Misscaledby1,000).Thereasonforthisisthatmostdevicesprovidethesevalues alreadyscaled. UsetheResolutionboxtospecifythenumberofdecimalplacestobedisplayedfor anumericobject.Thedefaultvalueis1,butthiscanbeincreasedtotakeadvantage ofanyextraresolutionavailablefromthedatasource.
NOTE
Specifying higher resolution does not result in higher accuracy than the specified accuracy of the device.
Page 137
Display Options
Setting the Font Options UsetheTicksLabelsFontsectiontodefinefontoptions(suchasstyle,size,and color)forthenumericobject.Thissectionhastwooptions: SelectInheritfromparentwindowtousethedefaultstyle. SelectCustomtospecifyacustomstyle,thenclickFonttodisplaytheFont dialogboxandmakeyourchanges. Setting Flags UsetheFlagsbuttontodisplaytheNormalOperatingRangedialogbox.Usethis dialogboxtosetaLowLimitandaHighLimitanddefineanormaloperating rangetobedisplayedonthenumericobject.Afterflagshavebeenset,youcanuse themtoquicklydeterminewhetherareadingiswithinthenormalrangeyou defined. Theeffectofsettingtheselimitsdependsonthedisplaystyleyouhavespecified. Forexample,onthePartialDial,FullDial,andArcMeterdisplays,flagsappearas coloredrangesonthedial.Onothertypesofnumericobjects,theflagfunction changestheobjectsbackgroundcolorwheneveralimitisexceeded. Bydefault,LowFlagcolorisblueandHighFlagcolorisred;however,youcan specifyanycolorsyouwant.SelectOptions>FlagColorstodisplayadialogbox whereyoucanedittheseoptions.
NOTE
The flags used in Vista are not linked to 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.
Other Display Options for Vertical or Horizontal Bar Graphs InthePreviewsectionofaverticalorhorizontalbargraphDisplaytab: RightclickontheaxislabelstodisplaytheAxisLabelsdialogbox.Selectthe Format(Decimal,Scientific,orEngineering)anddeterminetheAxisTitle(none orcustomtext). RightclicktheaxistickmarkstodisplaytheVerticalorHorizontalAxisdialog box.ConfiguretheRange,TicksandGridstyle.SelectLogarithmicscaleto enablethelogarithmicscaleoption. Other Display Options for Partial Dial, Full Dial and Arc Meter Displays Toconfiguremeterparametersonpartialdial,fulldialorarcmeterdisplays,right clickanywhereinthePreviewsectionoftheDisplaytab. SettheRange,ArcPosition,Ticks,anddialPosition.Forfullandpartialdial displays,setthelabelpositiontoinsideoroutside.ClickLineAttributestosetthe styleandwidthofthedial.
Page 138
Display Options
Other Display Options for Scrolling Graphs InthePreviewsectionoftheDisplaytab: RightclicktheverticalorhorizontalaxistickmarkstobringuptheVerticaland TimeAxisdialogboxes.SettheRangeandTicks,and(fortheverticalaxis)Grids Style. RightclickontheverticalaxislabelstodisplaytheAxisLabelsdialogbox.Select theFormat(Decimal,Scientific,orEngineering)anddeterminetheAxisTitle (noneorcustomtext). RightclickonthegraphbackgroundtodisplaytheScrollingGraphdialogbox whereyoucansettheSampleIntervalandRelativeReset. ThesampleintervaldeterminestheresolutionoftheXaxisinseconds.It shouldbesetbetweenonetenthandonehundredthoftheXaxisrange;for example,whenextendingtherangetoonehour(3600seconds),thesample intervalshouldbesettoapproximately60seconds. Therelativeresetisapercentagethatdeterminestheamountthescrolling graphshiftsbackuponfillingtheplottingarea.(Forexample,arelativeresetof 0.5shiftsback50%;arelativeresetof0.99scrollsthemostsmoothly.)
Customizing the Display of a Status Object

StatusobjectsdisplaythestatusofBooleanon/offconditionsinoneofthree ways:anindicatorlight,analphanumericfield,oracustomimage. Toviewthedisplayoptionsofastatusobject,rightclickontheobjectthenselect theDisplaytab.
NOTE
To invert the default color scheme, select Invert active state from the Annunciation tab.
TheDisplaytabhasthreeoptions: SelectDefaultimagetodisplaythedefaultindicatorlightimage,whichchanges colortoindicatevariousconditions:bydefault,greenindicatesanOFF condition,redindicatesanONconditionandgrayindicatesastatusobjectthat isnotconnectedorisnotreceivinginformation. SelectCustomimagestousecustomimagesforeachcondition.Customimages canshowanimation,customizedbuttons,alarmmessages,etc. Enterthefilenameoftheimageintheappropriatebox(ON,OFF,or Unconnected).Tohidethestatusobjectinagivenstate,leavetheappropriate boxblank. Currently,thecustomimageoptionsupportsthefollowinggraphicfile formats:BMP,WMF(WindowsMetafile),EMF,andAVI(withoutaudioand uncompressedorcompressedusingRLE8compression). Youcanusethreedifferentfilestorepresentthethreedisplaystates(ON,OFF, andUnconnected)ofastatusobject.Eachofthesefilescanalsobeofadifferent type(e.g.,BMP,AVI,andWMF).
Page 139
Display Options
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 still work. If the 6-frame bitmap check box is selected, 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. If no file name is provided in the entry box of a state, nothing is displayed when the status object is in that state.
SelectAlphanumerictodisplaytheBooleanstatelabelsstoredinthedeviceand choosecustomcolorstovisuallyindicatethecorrespondingstates. Forexample,supposeRunninghasbeenstoredinameterasthelabelforthe BooleanregisterthatstorestheONconditionofamotorrelayandStopped fortheOFFcondition.Youcanshowthisregisterlabeltogetherwiththestatus labelusingthealphanumericdisplaystyle.Youcanoverridethemeterlabels ontheLinktab. ClickONColorandOFFColortospecifythecolorsassociatedwitheach condition.
Customizing the Display of a Grouping Object

Thegroupingobjectcanbedisplayedasthedefaultimage,acustomimage,orno image.Youcancustomizethedisplaytochangeanyofthesedefaultelements. Toviewthedisplayoptionsofagroupingobject,rightclickontheobjectthen selecttheDisplaytab. TheDisplaytabhasthreeoptions: SelectDefaultimagetousethedefaultimageforagroupingobjectthatappears inthetoolbox. SelectCustomimagetodisplayacustomimage.Enterthefilenameoftheimage youwanttouse.Thefilenameshouldincludethefilesextension(forexample, .bmp,.wmf,.emf,or.avi). SelectNonetohidethegroupingobject.Withnoimagespecified,thegrouping objectistransparentunlessyouselectit(displayingthehandles).Ifyoumove themouseoveratransparentobject,thestatuslinedisplaysthesizeandobject type(forexample,30x30:GroupingObjectinthestatuslinemeansthehidden objectisagroupingobjectanditssizeis30pixelsby30pixels). Hidingagroupingobjectisespeciallyeffectivewhenusingacustom backgroundimage;youcanintegrateyourtransparentgroupingobjectsinto theimagebyplacingthemattheappropriatepointsonthedrawing.Userscan displaysitespecificinformationbydoubleclickingontheappropriatespotin thebackground.SeeImage:DisplayingaBackgroundImageonpage 156for informationonusingacustombackground.
Page 140
Display Options
Customizing the Display of a Control Object

Acontrolobjectappearsdifferentlydependingonthetypeofregistertowhichit islinked.Thissamecriteriaalsodeterminesthedisplayoptionsavailable. Toviewthedisplayoptionsofacontrolobject,rightclicktheobjectthenselectthe Displaytab. Theoptionsavailabledependonthetypeofcontrolobject. External Numeric AcontrolobjectthatislinkedtoanExternalNumericmoduleappearsasan alphanumericdisplaybox.TheDisplaytabhasthefollowingsections:Borderand BackgroundColor. IntheBordersection,selectHidetoshownoborderorselectShowtodisplaya border.IfyouselectShow,youcanspecifythewidthinpixelsandclickColorto chooseacolorfortheborder. IntheBackgroundColorsection,selectTransparentfornobackgroundorselect CustomthenclickColortodefineacolorforthebackground. External Pulse AcontrolobjectthatislinkedtoanExternalPulsemoduleappearsasabuttonicon, bydefault.TheDisplaytabhasthreeoptions:Defaultimage,Customimageand None. SelectDefaultimagetodisplaythebuttonicon.SelectCustomimageandclick Browsetoselectadifferentimage.SelectNonetoshownoimage(thecontrol objectishiddenbutstillfunctions). External Boolean AcontrolobjectthatislinkedtoanExternalBooleanmoduleappearsasaswitch icon,bydefault.TheDisplaytabhastwooptions:DefaultimageorCustom images. SelectDefaultimagetodisplaytheswitchicon.SelectCustomimagesthenclick BrowsetodefinecustomimagesforON,OFFandUnconnected.Tohidethe controlobjectforagivenstate,leavetheappropriateboxblank.Currently,the customimageoptionsupportsthefollowinggraphicfileformats:BMP,WMF (WindowsMetafile),EMF,andAVI(withoutaudioanduncompressedor compressedusingRLE8compression).
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 still work. If the 6-frame bitmap check box is selected, 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. 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 141
Action Options
Action Options
Toviewtheactionoptions,rightclickonthediagramobjectthenselecttheAction tab. UsetheActiontabtospecifytheresponseofadiagramobjectwhenitisclicked(in Displaymode)ordoubleclicked(inEditmode). TheActiontabisavailableforthefollowingdiagramobjects:Numeric,Status, Grouping,andControlobjects.Dependingonthetypeofdiagramobject,the Actiontabdisplaysoneoftwosetsofoptions: Specifyanactionforanumeric,status,orgroupingobject Customizetheactionforacontrolobject
Specifying Action for Numeric, Status, or Grouping Objects

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.
Whenyourightclickonanumeric,status,orgroupingobject,theActiontab displaystheavailableoptions: SelectNoneifyoudonotwanttheobjecttosupportanaction.Thisisthedefault fornumeric,status,andgroupingobjects. SelectOpenGroupingWindowtoopenagroupingwindowwhentheobjectis clicked.Youcanusethisgroupingwindowtodisplayadditionalinformation. Forexample,ifanumericobjectdisplaysatotalvalue(suchastotalkW),you candisplayspecificinformation(suchaskWreadingsforeachphase)inan associatedgroupingwindow. TheOpenDiagramforMeterTemplateoptionisusedbydefaulteachtimea networkdiagramisgenerated.Eachmetericoninthenetworkdiagramissetto openthedefaultdiagramsthatmatchthatmetersconfiguration. SelectOpenUserDiagramtoopenauserdiagramwhentheobjectisclicked. TypethefullpathandfilenameintothefieldprovidedorclickBrowsetolocate thediagramyouwant.Usingthisaction,youcanchooseadiagramobjectthat displaysarepresentativereadingfromanindependentdiagramanduseitto opentheotherdiagramwhenclicked. SelectOpenFiletoopenafilewhentheobjectisclicked.Typethefullpathand filenameintothefieldprovidedorclickBrowsetolocatethefileyouwant.The filecanbeathirdpartyprogramorsomeotherdocument;ifadocumentis specified,thentheprogramassociatedwiththefileextensionislaunchedand thespecifieddocumentisloadedintotheapplication. SelectOpenWebPagetoopenaspecifiedwebpageinyourdefaultwebbrowser whentheobjectisclicked.Typethecompleteaddressintothefieldprovided.
Page 142
Box Options
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 ..\ION Enterprise\config\diagrams\ud.
Customizing the Action for a Control Object

Toviewtheactionoptionsofacontrolobject,rightclickonthecontrolobjectand selecttheActiontab. TheActiontaboffersthreeoptionsthatyoucanusetodefinehowthecontrol objectrespondswhenclicked: SelectNoconfirmationtohavenoconfirmationmessagedisplayed. SelectMessageboxconfirmationtodisplayamessageboxwhentheobjectis clicked.ThemessageboxrequirestheusertoclickeitherOKorCancel. SelectPasswordconfirmationtorequesttheuserslogonpasswordwhenan objectisclicked. TheLeveltooperatelistallowsyoutospecifytheaccesslevelrequiredtoperform theaction.SeeUserManageronpage 55formoreinformationonaccesslevels andtheirpermissions.
Box Options
ToviewtheBoxoptions,rightclickontheobjectthenselecttheBoxtab. UsetheBoxtabtoaddaborderorbackgroundcolortoadiagramobject.TheBox tabisavailableforthefollowingdiagramobjects:Numeric,TextBox,andany statusobjectthathasbeenconfiguredasanalphanumericdisplay TheBoxtabhastwosections: Borderletsyouadjustaborderswidthandcoloraswellaswhetherornotitis displayed.SelectHidetoremovetheborderorShowtodisplayit.Ifyouselect Show,clickColortodefineabordercolorandtypeanumberintheWidthin pixelsfieldtochangethelinethickness. BackgroundColorletsyousetthebackgroundcolorofanobject.Select TransparenttousethebackgroundcoloroftheparentwindoworselectCustom andclickColortoselectanothercolor.
Page 143
Annunciation Options
Annunciation Options
Toviewtheannunciationoptions,rightclickonthestatusobjectthenselectthe Annunciationtab. UsetheAnnunciationtabtospecifyhowusersarenotifiedofachangeofstatus. TheAnnunciationtabisavailableontheStatusObjectonly.
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. TheAnnunciationtabhasthreeoptionsthatsettheactionthatVistaperforms whenastatusobjectbecomesactive: SelectCommandlinetoautomaticallylaunchanotherapplicationintheevent ofachangeinstatus.Typetheprogramsexecutable(.exe)commandintothe fieldprovidedorclickBrowsetolocatetheappropriatefile. SelectMessageboxtospecifyanannunciationmessage.Typeyourmessageinto thefieldprovided.Thefirstlineoftextappearsasthetitleofthemessagebox. SelectInvertactivestatetochangethewaythestatusobjectreactstoanactive state.Whenthisoptionisselected,thestatusobjecttreatsanactivestateas inactiveandviceversa.Thisisuseful,forexample,incaseswhenyouwanttobe notifiedifafunction(suchasacoolingfan)switchesoff.
NOTE
If you select the Invert active state check box, this also inverts the default colors of the status object.
Alarming Options
EverytypeofeventthatoccursinanIONEnterprisenetworkhasaprioritized valuethatidentifiesitsrelativesignificanceonascaleofzeroto255.Bydefault, Vistaidentifiesanyeventwithapriorityof128orgreaterasanalarm. ToviewtheAlarmingoptions,rightclickontheEventorGlobalEventLogViewer thenselecttheAlarmingtab. UsetheAlarmingtabtocreateordeleteapriorityrange,specifythesecuritylevel requiredtoacknowledgeanalarm,orcustomizethewayVistaannunciatesan alarm.
Page 144
Alarming Options
TheAlarmingtabhasthreemainsections: Priorityrangesliststhecurrentlyconfiguredalarmranges.Whenyouselecta rangeinthePriorityrangessection(forexampleRange192255),theother sections(LeveltoAcknowledgeandAnnunciation)displaythecurrentsettings forthatrange.Youcanproceedtomodifyanyofthesesettingsforthespecified range.(Yourchangesaffectonlythecurrentlyselectedpriorityrange.) ClickNewtoaddanewpriorityrange.InthePrioritydialogbox,typea numberrepresentingthelowerlimitofthenewrangethenclickOK.Theupper limitofthenewrangeisautomaticallydefinedbythelowerlimitoftheexisting range.Forexample,ifyouhaveanexistingrangeof128191,youcantype100 thenclickOKandtherange100127appears.Todeleteanexistingrange,select itandclickDelete. TheLeveltoacknowledgelistspecifiestheaccesslevelrequiredto acknowledgealarmsintheselectedrange. AnnunciationletsyoucustomizethewayVistaannunciatesanalarm: SelectBeeptoplayabeepingsound. SelectFlashtohaveaflashingdisplay. SelectCommandlinetohaveVistatoautomaticallylaunchanother applicationintheeventofanalarm.Typetheprogramsexecutable(.exe) commandintothefieldprovidedorclickBrowsetolocatetheappropriate file.Thisoptioncanbeusedtoautomaticallyalertotherusersofspecific eventsthroughpagingsystems,faxtransmissions,oranyothercommand linecapableapplication. SelectMessageboxtodisplayanannunciationmessage.Whenyouselect thisoption,typeyourmessageintothefieldprovided.Thefirstlineoftext appearsasthetitleofthemessageboxandtheremainingtextappearsasthe contentofthemessagebox. 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 ..\ION Enterprise\system\etc directory.
Page 145
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,orcontrolobjecttoanode. Numeric,status,andcontrolobjectsdisplayrealtimedata.Afteryouhaveplaced oneoftheseobjectsintoauserdiagram,youshouldlinkittoarealtimedata source.Anobjectcannotreceiveordisplayinformationuntilitislinked. Specifying a Real-Time Link to a Node 1. 2. Rightclickonthediagramobjectyouwanttolink.TheConfigurationdialog boxappears. SelecttheLinktab. TheLinktabcontainstwosections:LinkandLabel.UsetheLabelsectionto definealabelforthediagramobject(seeLinkOptionsonpage 135for informationontheLabelsection)andusetheLinksectiontochoosearealtime source. 3. Selectoneofthefollowing: Inheritfromparentwindow:Theselecteddiagramobjectdefaultstothe samenodeusedbytheparentwindow(thewindowinwhichtheobject resides).Youmustspecifyarealtimeregisterwithinthenode,butthenode itselfispreselected. Custom:Allowsyoutoselectanewnode.SelectIONtochooseadifferent devicethanthatusedbytheparentwindow. 4. 5. ClickEditLink.TheCreateLinkdialogboxappears. Specifyanode,manager,moduleandoutputregister. DoubleclickthenodeintheNodesboxthatcontainsthedatasourceyouwant. IfyouchoseInheritfromparentwindowinstep3,thenodeispreselected. Doubleclickthemanageryouwant(e.g.,PowerMetermodules)fromthe Managersbox. DoubleclickthemoduleyouwantfromtheModulesbox(e.g.,PowerMeter). DoubleclicktheoutputregisteryouwantfromtheOutputRegistersbox (e.g.,Vllavg).
Page 146
6.
ClickOKintheCreateLinkdialogboxtosaveyourchanges. TheCreateLinkdialogboxdisappearsandthenewlinkinformationis displayedalongtheloweredgeoftheConfigurationdialogbox.
7.
ClickOKontheConfigurationdialogboxtosaveyournewconfiguration.
Linking a Data Log Viewer or Event Log Viewer

TheEventLogViewerandDataLogViewerdisplayloggeddata.Afteryouhave placedanEventLogViewerorDataLogViewerobjectintoauserdiagram,you needtolinkittotheIONQueryService. Linking a Diagram Object to the ION Query Service 1. 2. RightclickontheEventorDataLogViewerobjectyouwanttolink. SelecttheQueryServertabintheConfigurationdialogbox. TheQueryServertabhastwooptions: SelectInheritfromparentwindowtohavetheselecteddiagramobject defaulttothesameQueryServerusedbytheparentwindow(thewindow inwhichtheobjectresides).Ifyouselectthisoption,clickOKtoexit,skip thefollowingsteps,andcontinuewithQueryingtheDatabaseon page 148. SelectCustomQueryServerandclickEditLinktodisplayadialogbox whereyoucanselectanewQueryServerlink. 3. SelectCustomQueryServerandclickEditLink.TheCreateLinkdialogbox appears. UsethisdialogboxtospecifytheQueryServer,QueryManager,Query module,andQueryregister. DoubleclickontheQueryServerthatyouwantfromtheNodesbox. DoubleclickQueryModulesfromtheManagersbox. DoubleclickontheQuerymodulethatyouwantfromtheModulesbox. DoubleclickontheQueryRegisterthatyouwantfromtheOutputRegisters box. 4. ClickOKontheCreateLinkdialogboxtosaveyourchanges. ThenameoftheselectedIONQueryServiceisdisplayedastheGroupNameon theQueryServertaboftheConfigurationdialogbox. 5. ClickOKontheConfigurationdialogboxtoacceptyournewconfiguration.
Afteryouhavelinkedadiagramobjecttoalogserver,youneedtodefineaquery tospecifythetype(s)ofloggeddatathatyouwanttheobjecttodisplay.See QueryingtheDatabaseonpage 148formoreinformation.
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 147
Querying the Database
Querying the Database

TheDataLogViewer,theEventLogViewerandtheGlobalEventLogViewer querythedatabase,extractloggeddata,anddisplaythatdatainVista. Aqueryisasetofinstructionsthatthelogviewerusestorequestparticulardata fromthedatabase.Eachlogviewerhasitsownindividualquery.Editingthis queryinformationchangeswhatdatathequeryretrievesandthewayalogviewer displaysthatdata. RightclickonthedataoreventlogviewerobjectandselecttheQuerytabtoview thequeryoptionsoraccesstheQueryWizard.Usethequeryoptionstodefinethe wayaviewerdisplaysdataandtheQueryWizardtoedittheactualquery.
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

Todefinethewayalogviewerdisplaysinformation,configureitsqueryoptions. ToviewthequeryoptionsforanEventLogViewer,DataLogViewer,orGlobal EventLogViewer,rightclickontheviewerobject.TheConfigurationdialogbox appears.SelecttheQuerytab. TheuppersectionoftheQuerytabofferstwobuttons: EditQuerystartstheQueryWizard,auserfriendlyinterfacethathelpsyouedit thequery. EditSQLaccessestheSQLstatementviaWindowsNotepadsoyoucaneditthe querydirectlyusingSQL,ifpreferred.
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:ThisoptionspecifiesthenumberofrecordsVista uploadsintoactivememory(RAM)whenyoufirstopenaDataorEventLog Viewer.Themaximumvalueis9999.Asyouscrolldownthelistofrecords,Vista uploadsadditionalrecordsasneeded.Youmaywanttochangethisdefault valueif,forexample,youwanttoselectalargenumberofrecordsforplotting, withoutscrollingdownrepeatedly.
Page 148
Using the Query Options
Updateautomatically:Thisoptionisdisabled(cleared)bydefault.TheDataor EventLogViewerdoesnotdisplayanynewrecords;rather,theLogViewer initiallyuploadsthespecifiednumberofrecords(forexample100)anddoesnot updateagainunlessitisclosed(anditsqueryresultsdeleted)thenreopened. Withthisoptionselected,theLogViewercontinuallyreceivesanddisplays newrecordsuptoamaximumof1000records;theLogViewerchecksfornew recordsevery20seconds.However,theupdatescanconsumeanoticeable amountofCPUpower,especiallyifseveralLogViewersremainopen simultaneouslyorifLogViewersareuploadingwaveformdata. TheGlobalEventLogViewerishardcodedtoupdateautomaticallyevery10 seconds.Thispreventsyoufrommissingalarms. Deletequeryonclose:Thisoptionisenabled(selected)bydefault.TheLog Viewerclearsitstemporaryrecordsfromactivememory(RAM)uponclosingso thateverytimeaLogViewerisopened,thedatabaseisqueriedagainandall availablerecordsaredisplayed.(Thisoptiondoesnotaffectanyoriginalrecords storedinthedatabase.) Ifthisoptionisdisabled,VistacachestherecordsetreturnedtotheLogViewer, meaningthatiftheLogViewerisclosedthenreopened,thetableispopulated frommemoryandnotfromthedatabase.Anynewrecordsinsertedintothe databaseduringthetimetheLogViewerwasinitiallyopendonotappear.
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,thelogviewerusesthesamenode linkageastheparentwindow.ThenodeisalsopreselectedintheQueryWizard youshouldnotselectthisoptionifyouintendtoquerymorethanonenodeor querytheglobaleventlog. X-Parameter for Log View Plotter ForaDataLogViewer,theXParameterforLogViewPlottersectionisofferedat thebottomoftheQuerytab.Usethissectiontospecifyacolumntobeusedonthe XaxisoftheLogViewPlotter.Thissectionofferstwooptions: TimestampisselectedastheXparameterbydefault.Insomecases,youmay needtospecifyadifferentXparameter.Forexample,whenyouareplotting disturbances,youneedtoplotyourdataagainsttheDurationcolumn. Usecolumn#letsyouspecifyanewxparameter.Inthefieldprovided,typethe columnnumberthatyouwanttouseastheXparameter(e.g.,3).Whenyou clickOKontheDataLogViewerConfigurationbox,thespecifiedcolumn changestoblue.
NOTE
In the Data Log Viewer, the column specified for the X-parameter is colored blue for easy identification.
Page 149
Using the Query Wizard

TheQueryWizardhelpsyoueditanexistingqueryorcreateanewqueryfora DataLogViewer,EventLogViewer,orGlobalEventLogViewer. 1. 2. 3. Rightclickonthelogviewerthatyouwanttoconfigure. SelecttheQuerytabintheConfigurationbox. ClickEditQuery.TheQueryWizardappears. TheQueryWizardconsistsoffourstepsdesignedtoguideyouthroughthe processofeditingaquery.Thesestepsaredescribedinmoredetailinthe followingsections. Selectingthenode(s)toquery. Specifyinglogswithinthespecifiednode(s). Specifyingcolumnsandspecifyingfilters. Choosingasortorder. Dependingonthetypeofquery(neworexisting),youmaynotneedtoperform allfoursteps.WhenyoustarttheQueryWizard,itautomaticallyopensonthe appropriatestepintheprocess. 4. UsethefourbuttonsatthebottomoftheQueryWizardtomovethroughorexit theQueryWizard: UsetheBackandNextbuttonstonavigatethroughthedialogboxes. ClickCanceltoquittheQueryWizardanddiscardyourchanges. ClickFinishtoquittheQueryWizardandsaveyourchanges. 5. Whenfinished,clickOKtosaveyourchangesandclosetheviewer configurationbox.
Thefollowingexampledescribeseachstepintheprocessofcreatingatypical query:configuringaDataLogViewertodisplaywaveformsforthreephases(V1, V2,V3).
Step 1: Selecting the node(s)

TheAvailablelistdisplaystheavailablenodes(deviceorsoftware)andthe Selectedlistdisplaysthecurrentlyselectednodes. Selectanode(ornodes)foryourquery.Ifanodehasalreadybeenspecifiedoryou selectUseParentNodeontheQuerytab,theQueryWizardproceedsdirectlyto Step2:Specifyinglogs. 1. 2. ClickEditQueryontheQuerytaboftheLogViewerConfigurationdialogbox tostarttheQueryWizard. HighlightthenameofthenodethatyouwantfromtheAvailablelistandclick Add.ThenodeappearsintheSelectedlist.Repeatthisproceduretoadd additionalnodesforthisquery,ifrequired. IfyouwanttoremoveanodefromtheSelectedlist,highlightthenodeandclick Remove.ThenodedisappearsfromtheSelectedlist. 3. ClickNexttocontinue.
Page 150
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.
Step 2: Specifying logs

Specifyoneormoredatalogstoquery.Ifavalidqueryhasalreadybeenspecified, theQueryWizardproceedsdirectlytoStep3:Specifyingcolumns. TheAvailablelistdisplaysthelogsavailableonthespecifiednode.TheSelected listdisplaysthecurrentlyselectedlogs. 1. Highlightthenameofthelog(s)thatyouwantfromtheAvailablelistandclick Add.Thelog(s)appearsintheSelectedlist.
NOTE
Check for additional tabs. If you selected more than one node in step 1, 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.
2.
ClickNexttocontinue.
Step 3: Specifying Columns and Filters

Choosecolumnsandspecifyfiltersettings.
UsetheSelectthecolumnstoappearintheLogViewersectiontoaddorremove acolumnfromyourlogviewerandtheFiltersectiontoestablisharangeforyour queryandtoscreenoutunwanteddata.
Page 151
Ifyouselectedmultiplelogsinstep2,thisboxcontainsatabforeachlog.Specify thecolumnandfilterinformationforeachtab. Specifying Columns to Appear in the Log Viewer TheAvailablelistdisplaystheavailablecolumnsandtheSelectedlistdisplaysthe currentlyselectedcolumns.TheSelectedlistdisplaysthecolumnsinthesame order(lefttoright)thattheywillappearinthelogviewer(toptobottom). TospecifythecolumnstoappearintheLogViewer: 1. Highlightthenameofthecolumn(s)youwantthenclickAdd.Thecolumn(s) appearsintheSelectedlist. Selecttheasterisk(*)atthetopoftheAvailablelisttoselectallavailable columns. Forexample,ifyouwanttoselectsomebasiccolumnsforthefirstwaveformlog youchoseinthelaststep,youcouldhighlighttimestamp,node,andV1inthe Availablelist.
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. 3.
Repeatthisprocedureforeachcolumnthatyouwant(andforeachtab). AdjusttheorderoftheitemsintheSelectedcolumnhighlightthecolumn nameyouwanttomoveintheSelected(inorder)listthenclicktheupordown arrowstomoveit.Thecolumnsarelistedfromtoptobottomintheorderthey willappearfromlefttoright. Forexample,ifyouwanttheTimestampcolumntobethefirst(leftmost)column inyourlogviewer,highlighttimestampintheSelected(inorder)sectionthen clicktheuparrowtomoveittothetopofthelist.
Afteryouhaveselectedthecolumnsyouwant,proceedtospecifyfiltersettings. Specifying a Filter UsetheFiltersectiontoconstructoneormorefilterstatementsforyourlogviewer. Filtersareusefulforrestrictingthescopeofyourqueryorspecifyingapriority rangeforalarms. Toeditanexistingfilterstatement,doubleclickonit.
Page 152
Select a column Click here to replace the selected filter statement with a new one Click here to insert the new filter statement into the box below Click here to delete the selected filter statement from the box below
Select an operator
Select a value Select an additional value Click here to add brackets to your filter statement Use the AND/OR/NOT buttons to string filter statements together
Forexample,ifyouwanttoinstructthelogviewertodisplaydataforthepast month(excludingtoday),youcouldusethefollowingprocedure: 1. 2. 3. 4. 5. Inthefirstbox,selecttimestamp. Inthesecondbox,selectBETWEEN. Inthethirdbox,selectlast_month_to_date(). Inthefourthbox,selecttoday_12AM(). ClickInsert. Thefollowingfilterappearsintheboxbelowthefiltercontrols: timestampBETWEENlast_month_to_date()andtoday_12AM()
NOTE
When setting priorities for a Global Event Log Viewer, specify high priorities to prevent the viewer from filling up with low-priority events.
IfyouwantedtoinstructanEventLogViewertodisplayonlyunacknowledged alarms,createafilterthatonlydisplaysalarmsthathavenoacknowledgement time(acktime). 1. 2. 3. Inthefirstbox,selectacktime Inthesecondbox,selectISNULL ClickInsert. Thefollowingfilterappearsintheboxbelowthefiltercontrols: ack_timeISNULL Asyouconstructafilterstatement,eachfieldoffersoptionsbasedonyour selectioninthepreviousfield(s).Forexample,ifyouselectpriorityinthefirst field,thethirdfieldbecomesatextfieldwhereyoucantypeanumericvalue;ifyou selecttimestampinthefirstfield,thethirdfielddisplaystimebasedoptions (i.e.,now,today12AM,yesterday,etc.).
Page 153
Time-related functions
now_() today_12AM() yesterday() last_week() this_month() last_month_to_date() last_month() last_quarter_to_date() The current time. Today at 00:00:00. Yesterday at 00:00:00. Seven days ago at 00:00:00. The first day of this month at 00:00:00. The same date of the month one calendar month ago at 00:00:00. The first day of the last calendar month at 00:00:00. The first day of the month three calendar months ago at 00:00:00.
Thesecondfieldoffersastandardsetofoperators.
Operator-Specific Data Ifyouselectanoperatorthatrequiresadditionalinformation,Vistadisplaysa dialogboxwhereyoucanspecifytherequireddata. Forexample,ifyouselectthenodecolumninthefirstfieldthenselecttheIN operatorfromthesecondfield,adialogboxappearsrequestingthatyouspecify thenodeyouwanttouse. IfyouspecifyanycolumnotherthannodethenselectIN,aboxappears requestingnumericvalues. Afteryouhavespecifiedafilter,clickNexttocontinue.
Step 4: Choosing a Sort Order

Specifyasortorder.Thesortorderistheorderinwhichrecordsappearinthe viewer. 1. HighlightthenameofthecolumntosortbyintheAvailableColumnslistthen clickAdd.ThecolumnappearsintheSortOrderlist. AvailableColumnsdisplaysthecolumnsyouchoseinstep3. 2. DoubleclickonthecolumnintheSortOrderlisttoselecteitheranascendingor descendingsortorder. TheSortOrderlistdisplaysthecolumn(s)thatdictatetheorderinwhichthe recordsaresorted. 3. 4. ClickFinishtosaveyourchangesandquittheQueryWizard. ClickOKintheConfigurationboxtosaveyourchanges.
Page 154
Customizing a Diagram Window
Customizing a Diagram Window

Youcancustomizetheappearanceandconfigurationofanywindowwithinauser diagram.Youcancustomizeawindowsfontorbackgroundcolor,orconfigure windowpropertiessuchasbackgroundimage,realtimeandloggeddatalinks, doubleclickaction,andstaledatasettings. Inmanycases,Vistausesthepropertiesspecifiedfortheparentwindowasthe defaultsettingsforanydiagramobjectsorgroupingwindowscontainedwithin. Bymodifyingasettingintheparentwindow,youautomaticallymodifythesame propertyonallobjectsinsidethewindowthatsharethissetting.(Forexample,any objectwithanoptionsettoInheritfromparentwindowsharesthisinformation.) Thiscanbeusefulwhenaddingmultiplediagramobjectsthatarealllinkedtothe samesource. 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
Thefontyouselectbecomesthedefaultsettingforallcaptionsandtextlabels withinthewindow. Changing the Default Font 1. 2. 3. RightclickinthebackgroundofauserdiagramandselectDefaultFont.The Fontdialogboxappears. Setthedefaultfont,style,size,effects,color,andformatthatyouwant. ClickOKtosaveyourchanges.
Background Color
Thedefaultbackgroundcolorisgray.However,youcandisplayanysolidcoloras abackgroundforanywindowinyouruserdiagram. Changing the Background Color 1. 2. 3. RightclickinthebackgroundofauserdiagramandselectBackgroundColor. TheColordialogboxappears SelectthecolorthatyouwantorclickDefineCustomColorsformoreoptions. ClickOKtosaveyourchanges.
Page 155
Configuring Window Properties

ToviewtheWindowPropertiesConfigurationoptions,rightclickinthe backgroundofanywindowinyouruserdiagramandselectProperties. TheWindowPropertiesConfigurationdialogboxappearswithfiveoptiontabs: Image,QueryServer,Node,ActionandUpdates.
Image: Displaying a Background Image

Toviewtheimageoptions,selecttheImagetabontheWindowProperties Configurationdialogbox.UsetheImagetabtospecifyabackgroundimageforthe activediagramorgroupingwindow. TheImagetabhastwooptions: SelectNoneifyoudonotwanttodisplayabackgroundimage,orifyouprefer todisplayasinglecolor. SelectCustomimagetodisplayabackgroundimage.Enterthepathand filenameoftheimageyouwanttodisplay.Vistasupportsimagessavedinthe followingformats:Windowsbitmap(.bmp),Windowsmetafile(.wmf),or WindowsEnhancedmetafile(.emf). Youcancreateyourownbackgroundimageusingascannedphotographora drawingcreatedwithinastandardgraphicsprogram.Someideasinclude: Anengineeringdrawingofyourinstallationdepictingthepowerdistribution systemandthelocationofcriticalelements. Asinglelinediagramillustratingthepowerdistributionnetworkorthe individualcomponentsofyourfacility. Anaerialphotographofyourfacilitydepictingtheapproximatelocationofyour monitoringequipment. Asatelliteimageorgeographicalmapdepictingyourtransmissionand distributionnetwork. ThefollowingillustrationdepictsasampleVistabackgroundwithhidden diagramobjects(heretheobjectisvisiblebythehandlesbecauseitisselectedin Editmode):
Page 156
Youcanintegrateyourdiagramobjectsintotheimagebyplacingthematthe appropriatepointsonthedrawing.Usersthendisplaysitespecificinformationby clickingontheappropriatespotinthebackground. Specifying a Custom Background Image 1. 2. 3. 4. 5. Rightclickinthebackgroundofthewindowyouwanttocustomizeandselect Properties.TheWindowPropertiesConfigurationdialogboxappears. SelecttheImagetab. SelectCustomimageandclickBrowse. SelecttheimagefileyouwanttouseandclickOpen. ClickOKtosetthisimageasthebackground.
Query Server: Setting a Default Query Server for a Window

UsetheQueryServertabtospecifyaloggeddatasourceforanywindowinauser diagram.TheQueryServerthatyouselectprovidesthedefaultsourceoflogged dataforallEventLogViewers,DataLogViewersandGroupingObjectswithinthe window. Setting a Default Query Server for a Window 1. 2. 3. RightclickinthebackgroundofthewindowandselectProperties. ClicktheQueryServertabintheWindowPropertiesConfigurationbox. SelecteitherInheritfromparenticonorCustomQueryServer. SelectInheritfromparenticonfortheactivewindowtodefaulttothesame QueryServerusedbytheparenticon.(Theparenticonisthediagramobject thatyouclickedtoopenthiswindow.) SelectCustomQueryServerthenclickEditLinktodisplayadialogbox whereyoucanselectanewQueryServerlink. WhenyouclicktheEditLinkbutton,theCreateLinkdialogboxappears.
Page 157
UsetheCreateLinkdialogboxtospecifyaquery: 1. 2. 3. 4. 5. DoubleclickontheQueryServerthatyouwantfromtheNodesbox. DoubleclickonQueryModulesfromtheManagersbox. DoubleclickontheQuerythatyouwantfromtheModulesbox. DoubleclickonthequeryregisterthatyouwantfromtheOutputRegistersbox. ClickOKtosaveyourchanges.
ThenameoftheselectedQueryServerandregisteraredisplayedastheGroup NameontheQueryServertaboftheWindowPropertiesConfigurationbox.
Node: Setting the Default Node for a Window

UsetheNodetabtospecifyarealtimesourceforanywindow(orgroupingobject) inauserdiagram.Thenodethatyouselectprovidesthedefaultsourceofrealtime dataforallnumeric,status,andcontrolobjectswithinthewindow.Italsoisthe parentnodeforanyDataLogViewerorEventLogViewerobjectsplacedinthe window. Setting a Default Node for a Window 1. RightclickanywhereinthebackgroundofthewindowandselectProperties fromthepopupmenu.TheWindowPropertiesConfigurationdialogbox appears. SelecttheNodetab. Dooneofthefollowing: SelectInheritfromparenticontousethesamenodeastheparenticon(the diagramobjectyoudoubleclickedtoopenthewindow). SelectCustomtoselectadifferentnode.SelectIONandclickSelectto displaytheSelectNodedialogbox.Selectadefaultrealtimesourceforthe windowfromthenodesavailable. 4. ClickOKtosaveyourchanges.
2. 3.
Action: Specifying an Action for a Window

YoucanspecifyanactionforVistatoperformuponopeningorclosingaparticular window.Forexample,ifyouwantVistatoautomaticallyengageamodemtool (suchastheConnectionManager)everytimeyouopenacertaingrouping window,youcanspecifythetoolasanaction. Specifying an Open or Close Action 1. 2. 3. Rightclickinthebackgroundoftheuserdiagramorgroupingwindowthen selectProperties.TheWindowPropertiesConfigurationdialogboxappears. OntheActiontab,selectCommandlineonopenorCommandlineonclose. ClickBrowse.IntheBrowsedialogbox,locatetheprogramyouwant,selectthe .exefileandclickOpen. Thespecifiedfileandpathnameappearsintheboxbelowtheselectedoption. 4. ClickOKtosaveyourchanges.
Page 158
NOTE
To remove an action, clear the check box beside the option.
Updates: Setting the Time Interval

Datathatisnotupdatedisconsideredstaledata.Vistadetectsstaledataasit occursandidentifiesitwithacoloredborderaroundthediagramobject(the defaultcolorisyellow). OntheUpdatestab,youcanspecifyhowoftenVistaupdatesthedatadisplayed theintervaloftimeVistausestodetectstaledataVista.TheUpdatestabhastwo sections: UpdatePeriodallowsyoutospecifyhowoftendatainthatwindowis refreshed. StaleDataallowsyoutospecifywhetherdataishighlightedandhowolddata mustbetobeconsideredstale.
NOTE
The Update Period and Stale Data settings also apply to WebReach.
Changing the Update and Stale Data Settings 1. 2. 3. 4. Rightclickinthebackgroundofthewindow,selectProperties.TheWindow PropertiesConfigurationdialogboxappears.SelecttheUpdatetab. EnteranumericvalueinsecondsintheUpdatedataperiodorStaledatatimeout fieldstosettheintervals. SelectorcleartheHighlightstaledatacheckboxtoenableordisablechecking forstaledata. ClickOKtosaveyourchanges.
Tochangethecolorofthestaledataborder,closetheWindowProperties Configurationbox,thenselectOptions>FlagColors.IntheFlagColorsbox,click EditbesideStaleFlagColortodisplayadialogboxwhereyoucanselecta differentcolor.
Page 159
Page 160
WebReach
WebReachenablesIONEnterprisetodisplayVistauserdiagramsinaweb browser.WithWebReach,multipleuserscanaccessanddisplaynetworkand otherdiagramscreatedinVista,withoutinstallingadditionalsoftware.
NOTE
Currently only Microsoft Internet Explorer (version 6.0 and later) is supported by ION Enterprise.
In This Section
WebReachSupportonpage 162 DisplayingVistaUserDiagramsOnlineonpage 163 AdvancedWebReachConfigurationonpage 168 CustomNetworkDiagramSetuponpage 168 Troubleshootingonpage 170
Page 161
WebReach Support
WebReach Support
TheWebReachcomponentofIONEnterpriseemploysathinclientdesign, allowinguserstoaccessanddisplayVistadiagramsinawebbrowser.WebReach managesallthenecessarydataprocessingandsystemfunctionsattheserverand usesXMLtoprocessVistaobjectsanddatafordisplayonthewebpages. UseawebbrowserfromanymachineonyournetworktoviewtheVistauser diagramsofdevicesinyourpowermanagementsystem.Objectsthatcanbe displayedinthewebbrowserincluderealtimenumericdata,fullorpartial gauges,backgroundgraphicsordiagrams,andbasicviewsofevent,dataand waveformlogs. AlthoughidenticalinmanywaystoVista,WebReachhascertaindifferencesand limitations: AVIobjectsarenotsupported;theyappearasgreyboxesonscreen. ThediagramdisplayedbyWebReacharereadonly;controlobjectssuchasOn/ OffandTriggerswitchesaredisabled. ThetimedisplayedbyWebReachisthelocaltimeatthewebserver,notatthe clientcomputer.
NOTE
To ensure the correct local time is displayed in WebReach, ensure that the following are configured correctly on the meter: TZ Offset, DST Start, DST End, and DST Offset.
WebReach Installation After ION Enterprise is Installed

WebReachisautomaticallyinstalledandenabledifIIS(InternetInformation Services)isdetectedduringtheIONEnterpriseprimaryserverinstallation. ToinstallWebReachafterIONEnterprisehasalreadybeeninstalledonthe primaryserver: 1. 2. 3. 4. 5. InstalltheIISWindowscomponent(consultWindowshelpformore information). OpenWindowsControlPanelanddoubleclickAddorRemovePrograms. SelectChangeorRemovePrograms.SelectIONEnterprise,thenclickChange. TheInstallShieldWizardstarts. SelectModifythenclickNext. FollowtheinstallerdirectionstoinstallWebReach.
Page 162
Preliminary Setup
Preliminary Setup
BeforeyoucanseetheWebReachpages,anetworkdiagram(network.dgm) mustexist.WebReachprocesseseachelementinthenetworkdiagramand convertsthemfordisplayinthewebbrowser.Theeasiestwaytocreateanetwork diagramistoautomaticallygenerateitinVista. Generating the Network Diagram Automatically 1. 2. 3. StartVista. ClickFile>Generatenetworkdiagram. ClickFile>Save.
WebReachdisplaysthisgeneratednetworkdiagramasitshomepage.
Displaying Vista User Diagrams Online

Useawebbrowsertoviewthewebversionofthenetworkdiagram. From any Internet Explorer Web Browser 1. 2. StartInternetExplorer. Intheaddressfield,enterhttp://ComputerName/WebwhereComputerName istheserverscomputernameoritsIPaddressandWebisthevirtualroot.If youchangedthedefaultvirtualroot,substitutetheappropriatevalueforWeb intheaddress.Forexample,iftheserverscomputernameisServer2,youwould typehttp://Workstation2/Web. TheIONEnterprisewebinterfaceloginappears. 3. 4. EnteryourusernameandpasswordthenclicktheWebReachtab. ThenetworkdiagramyoucreatedinVistaisdisplayed.Clickanicontodisplay itscontents(e.g.,metersbelongingtothatgroup).
From the Primary Server 1. 2. LaunchtheIONEnterprisetaskpadandclickWebReporter.Thewebinterface loginappears. EnteryourusernameandpasswordthenclicktheWebReachtab.
Page 163
Viewing Historical (Trend) Data

WebReachprovidesawebbasedgraphingutilityforviewinghistoricaldata.This utilityallowsyoutoselectthedaterangeandthedatathatyouwanttoview. Viewing Historical Data Graphically
Click Device Diagram to return to the main device diagram screen. Click Show Graph/Show Table to toggled between graph and table views Click Change Date Range to change the range of dates for which data is displayed
Select the data you want to appear in the graph
Click Edit Graph to change how the graph is displayed
1. 2. 3.
Clickthemetericontoopenitsdiagram,thenclickthelinkortabthatcontains thebuttonforthetrendinginformationyouwanttoview. ClicktheDataLogViewerbutton thatcorrespondstothedatalogyouwant toview.Thedateselectionscreendisplays. Selectthetimeframeforwhichyouwanttoviewdata.Tospecifyadaterange, selectBetweenthesedatesthenclickthecalendaricons tosetastartand enddate. ClickShowTable.Thedatalogscreendisplays. Selectthecheckboxesfortheparametersyouwanttograph. ClickShowGraph.
4. 5. 6.
Page 164
NOTE
The first time you click Show Graph, you may be prompted to install software from Steema Software SL. Click Install to install the software and view the graph.
7. 8.
Selectorclearthecheckboxesinthelegendtoshoworhidethecorresponding datainthegraph. Manipulateandcontrolthedisplayedscreenbydoingthefollowing: Tozoominonthegraph,dragthemousepointeraroundtheportionyou wanttozoominon. Tomoveacrossthegraph,rightclickanddragyourmouseinthedirection youwanttomove.
NOTE
To return to the original view of the graph, refresh your browser display. Click Show Table to return to the data table screen.
Editing the Graph Tochangetheappearanceofthegraph,clickEditGraph(nearthetoprightcorner ofthescreen).TheEditingdialogboxdisplays,whereyoucansetparametersthat changethegraphsappearance.Youcanalsoexportthegraphtovariousimage formatsandconfigureoptionsforprintingthegraph.
RMS Waveform Plotting

WebReachplotsthecalculatedRMSvaluesforwaveforms.Toshoworhidethese RMSvalues,selectorcleartheappropriatebox.
Page 165
Viewing Meter Events
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 1. 2. 3. Clickthemetericontoopenitsdiagram,thenclickthelinkortabthatcontains theMetereventsbutton. ClicktheMetereventsbutton .Thedateselectionscreendisplays.
Setthedaterange,thenclickShowTable.TheMetereventsscreendisplays:
Adding a Global Event Log Viewer

TodisplaytheVistaGlobalEventLogVieweronline,youneedtocreateanEvent LogViewerobjectintheVistadiagramandlinkittotheGlobalEventLog.Toadd thisobjecttothehomepageforWebReach: 1. Opennetwork.dgminVistaandmakesureyouareatthetoplevel(i.e.,title bardisplaysUserDiagram:network).SelectOptions>ShowToolboxto switchtoEditmode. DraganEventLogViewerobjectontothediagram. Rightclicktodisplayitsproperties. ClicktheQuerytab.ClickEditQuery. SelectGlobal,thenclickAdd.ClickNext. SelectGlobalEventLog,thenclickAdd.ClickNext. IntheAvailablesection,selectthecolumnsyouwanttodisplay,thenclickAdd. Ifyouwanttochangetoorderofselectedcolumns,selectthecolumninthe Selectedsectionthenusetheupordownarrowbuttonstomoveitaccordingly. ClickNext.
2. 3. 4. 5. 6. 7.
Page 166
Stale Data or Error Indicators
8.
Selectthecolumnyouwanttoassignasthefirstsortingcriteria,thenclickAdd. Repeatforthesecondsortingcriteria,andsoon.IntheSortOrdersection, doubleclickacolumntochangeitssortorder(e.g.,changefromascendingto descending). ClickFinish.
9.
10. ClickFile>Save.
Stale Data or Error Indicators

WebReachusestheVistastaledatasettingsforitsdiagrams.Staledataanderrors aredisplayedinthewebbrowserasfollows: Ayellowbordersurroundinganobjectindicatesstaledata. Anorangebordersurroundinganobjectindicatesanerrorincommunications, securityaccess,configuration,orothersystemerror.
NOTE
See Identifying Stale Data on page 96 for information on 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 Technical Support if you need to change the default WebReach flag colors.
Page 167
Advanced WebReach Configuration
Advanced WebReach Configuration

Thissectioncoverscustomizationandadvancedconfigurationinformationfor WebReachandisintendedforadvancedusersonly.
CAUTION
If you use Registry Editor incorrectly, you can cause serious problems that may require you to reinstall your operating system.
Custom Network Diagram Setup

ThissectiondescribeshowtochangethedefaulthomepagethatWebReach displays. Ifyouhaveacustomnetworkdiagramontheprimaryserverthatyouwanttouse insteadoftheautomaticallygeneratednetworkdiagram: 1. StartWindowsRegistryEditorandnavigateto: HKEY_LOCAL_MACHINE\SOFTWARE\SchneiderElectric\ION Enterprise\6.0\WebReach 2. 3. 4. RightclicktoaddanewstringvalueandnameitNetworkDiagram. RightclickNetworkDiagram,selectModify,thentypethepathandnameof yourcustomnetworkdiagramintheValuedatafield. ClickOK.
Formoreinformation,refertotheNetworkDiagramiteminthetableunderthe sectionWebReachRegistrySettingsonpage 169.IfthereisnoNetworkDiagram entryintheregistry,thenthedefaultvaluexpml:/diagrams/ud/network.dgmis used. TheNetworkDiagramnavigationbuttonlocatedonthedaterangepageandthe resultspageisautomaticallyupdatedtolinktothecustomnetworkdiagramyou specified.However,theNetworkDiagrambuttonthatexistsineachmeteruser diagramusesahardcodedlinktoxpml:/diagrams/ud/network.dgm.UseVista tomanuallyupdatetheNetworkDiagramlinkinthemeteruserdiagrams. Changing the link for the Network Diagram button 1. 2. 3. 4. 5. StartVistaandselectOptions>ShowToolboxtoswitchtoEditmode. RightclicktheBacktoNetworkbutton.TheGroupingObjectConfiguration dialogboxappears. SelecttheActiontabandselectOpenUserDiagram. ClickBrowsetolocateyourcustomnetworkdiagram.Selectthediagram filename,thenclickOpen. ClickOKtosaveyourchanges.
Page 168
WebReach Registry Settings
WebReach Registry Settings

TheregistrykeysforWebReacharelocatedin HKEY_LOCAL_MACHINE\SOFTWARE\SchneiderElectric\ION Enterprise\6.0\WebReach. ThistableliststhedefaultWebReachregistryentriesandsettings:
Default Registry Entries

AutoDiagramTimeout ExpireTimeLimit HTTPRefreshInterval SubscriptionObject VirtualDirectory XMLRefreshInterval
Default Setting
20000 milliseconds 600 seconds 10 seconds pmlitem:webreachstore: ION 3000 milliseconds
Description
Timeout period for the autodiagram components to communicate with the device and determine the appropriate template to open. 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. The webpage refresh rate. The name (tag) that the subscription service uses to find WebReach-related information. The part of the web address that points to the WebReach-generated Vista diagrams for displaying in the browser. The real time data update rate on the webpage.
Thistableliststheoptionalregistryentriesyoucansetforcustomfunctionality.
Optional Registry Entries

NetworkDiagram
Default Setting
x-pml:/diagrams/ud/ network.dgm
Description
This value specifies the network diagram to display as the homepage 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.
QueryTimeout
See description
Page 169
Troubleshooting
Troubleshooting
WebReachdependsontheIONXMLSubscriptionServiceandIONXML SubscriptionStoreServicetofunctionproperly.Ifyouareexperiencingdifficulties withWebReachpages(suchasgettinganerrormessagewhenyoutrytoopena devicediagram),checktomakesuretheseserviceshavebeenstarted. No Real-time Data is Displayed ThismaybecausedbysecuritysettingsbeingresetbyaMicrosoftWindows update.Ifthisisthecase,openInternetExplorer,selectTools>InternetOptions, thenclicktheSecuritytab.ClicktheTrustedsitesicon,thenclickSites.Addthe WebReachwebsite(i.e.,http://<computername>/Web)totheTrustedsiteszone. Page cannot be displayed Error Thismaybecausedbycomplexorlargequeries,suchthattheresultsdonotarrive withinthedefaultWebReachtimeoutsettingof60seconds.Ifyoususpectthisis thecase,addthecustomDWORDregistrykeyQueryTimeoutandsetittoa higherdecimalvalue(e.g.,120). Tick Labels for Gauges are Unreadable ThismayoccurifyouspecifyanunsupportedfontfortheTicksLabelFont.Tofix this,selectonlyTrueTypeorOpenTypefontsinVista.
Page 170
Web Reporter
YoucanusetheWebReporterofIONEnterprisetodefine,generateandmanage comprehensivereports,basedoninformationcontainedinyourdatabases.This sectiondiscussestheelementsofreportinginIONEnterprise,suchasthedefault reportdefinitions,generatingandviewingreports,exportformats,and subscriptions.
NOTE
SQL Server Reporting Services must be installed before you install ION Enterprise in order for Web Reporter to be installed. If you installed ION Enterprise with Reporting Services not present and would like to install Web Reporter, contact Technical Support.
YoucannotusereportsthatwerecreatedinearlierversionsofIONEnterprisein WebReporter.However,youcanstilluseReporter,thereportinginterfacefrom earlierversionsofIONEnterprise.Forinstructions,seeAppendixA:Reporter onpage 325.
In This Section
Introductiononpage 172 WebReporterInterfaceonpage 173 DefaultReportDefinitionsonpage 175 CreatingaNewDefinitionfromaDefaultReportDefinitiononpage 179 GeneratingandViewingaReportonpage 180 EnteringReportInputsonpage 180 PrintingaReportonpage 185 SavingaReportonpage 185 ExportingaReportonpage 186 ReportAdministrationonpage 187 ManagingaReportonpage 187 SharingaReportonpage 187 CreatingReportSubscriptionsonpage 188 InstallingaReportDefinitionoraReportPackonpage 191 CustomReportDefinitionsonpage 192 RunningtheIONPowerQualityAggregationServiceManuallyonpage 193
Page 171
Introduction
Introduction
TheWebReporterinterfaceallowsyoutodefineandgeneratereportsfrom historicaldata.Youcanmodify,saveandexportareport,andcreatesubscriptions tosavedreports.Userswithsupervisorlevelaccesscanalsoinstallnewreport definitions. SeeGeneratingandViewingaReportonpage 180forinformationongenerating andviewingreports.
NOTE
Currently only Microsoft Internet Explorer (version 6.0 and later) is supported by ION Enterprise.
Web Reporter Terminology

ReportDefinition:Thereportdefinitiondefinessuchthingsaslayout,which inputsneedtobecompletedtorunthereport,andwhatinformationinthe databaseisaccessedforthatreport. DefaultReports:ThereportdefinitionsincludedinWebReportertoaddress commonreportingneeds. ReportInputParameters(orInputs):Parametersthatmustbeenteredbeforea reportcanbegenerated.Defaultinputsareincludedformostofthedefault reportdefinitions. Report:Areportthathasbeensavedwithsomeorallofitsinputparameters. DefinedReport:Areportthathasbeensavedwithallofitsinputparameters completed. DataAccessLayer:Thisprovidesaconsistentwaytoaccessdatabaseresources foradvanceduserswhoarecreatingcustomreports.Ifyouareusingthedefault reportsdefinitionsthatcomewithWebReporter,thisapplicationlayeris transparent.
Starting Web Reporter

SeeGettingStartedonpage 19forinformationonstartingandloggingintoWeb Reporter.Onceyouhavestartedandloggedin,clicktheWebReportertab.
Reporting Configuration
UsetheReportingConfigurationManageroptionintheManagementConsole ToolsmenutoconfigureoptionsforWebReportersuchasthedatabasetoreport onandsubscriptiondeliveryoptions.SeeReportingConfigurationManageron page 61formoreinformation.
Page 172
Web Reporter Interface

TherearethreemainelementsoftheReportspageinterface:reportmenubar, reportselectionpaneandreportdisplaypane.
Menu Bar
Report Icon
Report Parameter Input Area
Report Options
Saved Report Icon Report Selection Pane Report Display Pane
Menu Bar
Thereportmenubarcontainsthefollowingoptions:FileandHelp. File TheFilemenuhasfouroptions: Newallowsyoutocreateanewreportdefinitionbycopyingoneofthedefault reportdefinition. ManagebringsuptheManageReportsdialogboxwhichallowsyoutodothe following: SelectManagetomove,delete,renameorcopyareport.SeeManaginga Reportonpage 187. SelectSharetomakeareportavailabletoindividualusersandgroups.See SharingaReportonpage 187. SelectSubscribetoscheduleareporttobegeneratedanddeliveredina prescribedmanneronadefinedschedule.SeeCreatingReport Subscriptionsonpage 188. Saveallowsyoutosavetheselectedreport.SeeSavingaReportonpage 185 formoreinformation. InstallReportDefinitionallowsyoutouploadorupdateasinglereport definition.SeeInstallingaReportDefinitionoraReportPackonpage 191for moreinformation.
Page 173
InstallReportPackallowsyoutouploadorupdateareportpack.See InstallingaReportDefinitionoraReportPackonpage 191formore information. Help TheHelpmenudisplaystheWebReporteronlinehelp.
Report Selection Pane

Thereportselectionpaneallowsyoutoselectareporttovieworgenerate.Select thereportyouwantfromthelistofavailablereportsandreportdefinitions.The reportappearsinthereportdisplaypane. Reportnamesareprecededbyareporticon .Reportswithawhitecircleinthe reporticonrequireyoutoenteratleastsomeoftheinputs.Reportswithagreen circleinthereporticonhavebeensavedwithalloftheirinputsdefined;youdonot completeanyoftheinputsbeforethereportisgenerated.
NOTE
If the report definition you are interested in does not appear in the report selection pane, select Install Report or Install Report Pack from the File menu to upload the definition.
Report Display Pane

Thereportdisplaypaneistheareawherethegeneratedreportdisplays.Ifthe reportrequiresthatyouenterinputs,thereportparameterinputareadisplaysat thetopofthepane. Report Options Thisbar,locatedaboveageneratedreport,allowsyouto: Createasubscriptiontothereport.SeeAddingaSubscriptiononpage 188for moreinformation. Navigatethroughpagesofthereport.SeeViewingaReportonpage 184. Printthereport.SeePrintingaReportonpage 185. ExportthereportinformatssuchasPDF,Excel,andTIFF.SeeExportinga Reportonpage 186. Report Parameter Input Area Thisareaofthereportdisplaypaneappearswhenyouselectareportthatrequires youtoenterinputs.Theinputsvarydependingonthereportselected.See EnteringReportInputsonpage 180forinformationontheinputsfordefault reports. Aftergeneratingthereport,youcanclicktheshowinputsorhideinputslinks inthetoprightcornerofthereportdisplaypanetoshoworhidethereport parameterinputarea.
Page 174
Report Definitions
Report Definitions
ThissectionoutlinesthedefaultreportdefinitionsincludedwithWebReporter, andhowtocreateanewdefinitionbycopyingoneoftheexistingdefaultreport definitions.
Default Report Definitions

Thedefaultreportdefinitionsarepreconfiguredforthemostcommonreporting needs.Thefollowingisalistofthedefaultreportdefinitionssupplied:
100 ms EN50160 EN50160 Mains Signaling Energy Cost Energy Period over Period Energy Usage by Shift Event History IEC61000-4-30 Load Profile Power Quality System Configuration Tabular Trend
100 ms
Usethe100msreportdefinitiontocreateareportofselected100ms measurements.Thereportdisplaystimestampedvaluesforeach100ms measurementselected.
EN50160
EN50160isasetofpowerqualitystandardsusedbycertainenergysuppliersand energyconsumers.Therearetwodefaultreportdefinitionsavailable:EN50160 andEN50160MainsSignaling. TheEN50160definitionsusethefollowingtypesofdatafromdevices:supply voltagedips;temporaryovervoltages;supplyvoltageunbalance;harmonic voltage;interharmonicvoltage;frequencyandmagnitude;flicker;andshortand longterminterruptions.
NOTE
To run EN50160 reports in Web Reporter, the ION Power Quality Aggregation Service must be started. This service is run by default only on new data. To run the service on pre-existing data, see Running the ION Power Quality Aggregation Service Manually on page 193.
EN50160 UsetheEN50160reportdefinitiontocreateareportcontainingcomprehensive analysisofallEN50160compliancedataloggedbymultiplemeters.The compliancesummaryisbasedontheEN50160limitsforeachobservationperiod: eachdefaultEN50160measurementindicatesapassorfailonthecompliancetest withaY(yes)orN(no)respectively.
Page 175
EN50160 Mains Signaling UsetheEN50160MainsSignalingreportdefinitiontocreateareportforsignalline frequencystatisticsformultiplesources,foreachobservationperiod.
Energy Cost
UsetheEnergyCostreportdefinitiontocreateareportonenergyconsumption andpeakdemandlevelsoveraperiodoftime,categorizedbytimeofuse.The EnergyCostreportdefinitionusesenergyanddemandmeasurements. WithanEnergyCostreport,youcanuseatimeofuse(TOU)schedulethatyou defineusingtheTimeofUseEditor(seeTimeofUseEditoronpage 80)oryou cansetaflatrateintheSetRatesdialogbox(seeEnteringReportInputson page 180).
NOTE
This report is intended to be used for positive power flow applications only (where kW and kVAR are both positive). Use with bi-directional flow will give incorrect results.
Energy Period over Period

UsetheEnergyPeriodoverPeriodreportdefinitiontocreateareportthatallows youtocompareameasurementfrommultipledevicesoverspecifiedtimeperiods (i.e.,thisweekvs.thesameweekfromthepreviousmonth).
Energy Usage by Shift

UsetheEnergyUsagebyShiftreportdefinitiontocreateareportthatallowsyou tocompareameasurementfrommultipledevicesforspecifiedtimeperiods(or shifts).Thisallowsyoutocompareenergyusagebetweenshifts(i.e.,6:001:00vs. 1:00to8:00).
Event History
UsetheEventHistoryreportdefinitiontocreateareportofeventsoralarmsthat haveoccurredinthesystem.Itincludesthefollowinginformationontheevents: timestamp;sourcename;eventdescription;andeventpriority. Ifnoeventhasoccurredthatmatchestheinputsenteredwhengeneratingthe report,nodataisreturned.
IEC61000-4-30
UsetheIEC61000430reportdefinitiontocreateareportonIEC61000430 complianceinformationbyobservationperiod(3second,10minute,or2hour)for oneormoresources. TheIEC61000430reportdefinitionprovidesthefollowingtypesofinformation: voltageprofile;THDprofile;unbalanceprofile;flickerprofile;frequencyprofile; andsummarytable.
Page 176
Load Profile
UsetheLoadProfilereportdefinitiontocreateagraphicalrepresentationof demandorloadlevelsoveraperiodoftime.Theprofileshowspeakloads pointsonthegraphwherepeakelectricitydemandishigh.Aloadtrendreportcan beusedtoanalyzetheelectricalloadsatthetimeofmaximumdemand.This informationcreatesopportunitiesfordevelopingstrategiestoimproveenergy management. TheLoadProfilereportdefinitionusessimilarmeasurementstotheEnergyCost reportdefinitionbutdoesnotuseaTOUschedule.
Power Quality
UsethePowerQualityreportdefinitiontocreateareportthatsummarizethe numberandseverityofvoltagesags,swellsandtransientsoveraperiodoftime. Thefinishedreportalsoincludesagraphicalrepresentationofthedisturbances. ThepowerqualityreportallowsyoutoviewhistoricalPQdata,aggregatedinto powerqualityincidents.Anincidentisasummary,oraggregatedevent,which representsanumberofindividualevents(sags,swells)thatwasregisteredbythe samedeviceinasmallwindowoftime.Throughoutthissection,disturbancerefers toasag,swell,ortransienteventintheEventLog,whileincidentreferstoagroup (1ormore)ofdisturbances.
NOTE
To run power quality reports in Web Reporter, the ION Power Quality Aggregation Service must be started. This service is run by default only on new data. To run the service on pre-existing data, see Running the ION Power Quality Aggregation Service Manually on page 193.
Thegeneratedreportdisplays: Asummaryofincidents,incidentinterval,andnumberofdisturbances. Thedetailsoftheworstdisturbancesforeachpowerqualityincidentinthe report. Statisticsforeachpowerqualityincidentinthereport(forexample,first timestamp,duration,andthenumberoftransients,sagsandswellswithinthe incident). Fromthereport,youcanvieweitherdetailsforanincidentorwaveformdetails. PQ Incident Detail Toviewdetailsofanincident,clicktheincidentintheFirstTimestampcolumnof theStatisticstable.
Page 177
Detailedinformationaboutasinglepowerqualityincidentisdisplayed,including: ACBEMAplotcontainingthepowerqualitydisturbancesfortheselected incident. Thetimestamps,types,durations,phasesandmagnitudesofdisturbancesinthe selectedincident,withtheworsteventintheselectedincidenthighlighted (worstevent=largestmagnitudexduration). Thepowerqualitysettingsofthedevicethatregisteredthedisturbance(i.e.,sag/ swelllimits,transientthreshold,etc.). ToreturntothePQSummaryreport,usethebrowsersbackbutton. PQ Waveform Detail Toviewthewaveformdetailsofanincident,clicktheincidentintheTimecolumn oftheWorstDisturbancestable. Thewaveformdetailspresentsallofthewaveformsthatwererecordedfora disturbance.Itdisplaysawaveformchartalongwithanoptionaltablewith waveformvalues. Thefollowingwaveformplotsanddataaredisplayed,basedonthetimestamp selected: Asummarywaveformplot,displayingaplotoftheV1,V2andV3waveforms. Anindividualwaveformplotforeachof: V1andI1 V2andI2 V3andI3 Ifthesourcequeriedhasdigitalinputloggingenabledoverthetimeintervalof thewaveforms,awaveformshowingthedigitalinputstatus. Thetimestampforthetimethewaveformsweretriggered. Thesamplingfrequencyofthewaveforms. ToreturntothePQSummaryreport,usethebrowsersbackbutton.
System Configuration
UsetheSystemConfigurationreportdefinitiontocreateareportcontainingdetails aboutdevicesinyournetwork,including:devicenamesandtypes; communicationsinformation(i.e.,IPaddress,unitID,protocol)fordevices;sites towhichdevicesbelong;statusofsites(offlineoronline);anddescriptionsofthe devicesinthesystem(ifadescriptionwasenteredinManagementConsole).
Page 178
Creating a New Definition from a Default Report Definition
Tabular
UsetheTabularreportdefinitiontocreateareportofdatainatabularformat.You cancreateareportwithmultiplemeasurementsfrommultiplesources.Thisdata canthenbeexportedforuseinanotherprogram,suchasMicrosoftExcel. Thegeneratedreportcontainsthefollowinginformation:source;measurement; timestamp;andvalue.
Trend Report
UsetheTrendreportdefinitiontocreateareportthatdisplaystrendinformation inaline,column,bar,orpiechart.Youselectdevicesandmeasurementsfora selectedperiodoftime. Youcanchoosetoreportoneither: oneormoremeasurementsforasinglesource,or asinglemeasurementformultiplesources.
Creating a New Definition from a Default Report Definition

Youcancreateanewreportdefinitionbycopyingoneoftheexistingdefault definitions. Tocreateanewreportdefinition: 1. 2. 3. ClickFile>New.TheNewReportfromDefinitiondialogboxappears.Click +toexpandthenavigationtreetoviewthedefaultreportdefinitions. SelectthereportdefinitionyouwanttocopyandclickNext. TypeanameforthenewreportdefinitionintheNamefield.Selectalocationfor thenewreportdefinitionfromthenavigationtree,orclickNewFoldertocreate anewfolder. ClickSave.Thenewreportdefinitionisaddedtothereportdefinitionsinthe reportselectionpane.
4.
Page 179
Generating and Viewing a Report
Generating and Viewing a Report

Thissectiondescribeshowtogenerateandviewreports.
Report Ownership and Access

Accesstoareportisuserspecificandcanbeassignedbyauserwithsupervisor levelaccessortheownerofthereport. Theownerofthereportistheuserwhosavedthereport(seeSavingaReporton page 185).
Entering Report Inputs

Somereportsrequirethatyouenterinputs,suchasthedaterangeofdatatobe includedinthereport.Whenthisisthecase,thereportparameterinputarea displayswhenyouselectareportfromthereportselectionpane.Youmust completethenecessaryinputsbeforeyoucangeneratethereport. Whenyoudisplayareportthatincludesinputs,youcandisplayorhidethereport parameterinputarea.Todothis,clicktheshowinputsorhideinputslinkin thetoprightcornerofthereportdisplayareaafterthereporthasgenerated.
Inputs for Default Report Definitions

Thefollowingsectionsoutlinetheinputsforthedefaultreportdefinitions.The inputsavailablevarydependingonthetypeofreport. Aggregation Interval Thisinputdetermineshowdataisaggregatedforthereport(i.e.,day,week,etc.). Fromthedropdownlist,selecttheaggregationintervalthatyouwanttouse. Chart Type Usethedropdownlisttoselectthetypeofchartyouwanttousetodisplaythe reportresults(i.e.,line,bar,etc.). Evaluation Limits ClickConfiguretoconfiguretheEN50160parametersusedinthereport.Default valuesareprovidedbasedontheEN50160standard. Clickthelinksinthedialogboxtoaccessconfigurationoptionsforvarious measurementsincludedinthereport: BasicConfiguration:Typethemaximumpercentageofintervalsinan observationperiodthatthecomponentcanfailtomeettheEN50160N1andN2 requirementsbeforethecomponentisconsiderednoncompliant. SupplyVoltageDips:Typethemaximumpercentageofintervalsinan observationperiodthattheRMSvaluecandropbelow90%ofthenominal
Page 180
voltageforeachdurationanddepthpresentedinthedialogboxbeforethe componentisconsiderednoncompliant. ShortandLongInterruptions:Typethemaximumpercentageofintervalsinan observationperiodthattheRMSvaluecanbelessthat1%ofthenominalvoltage forthegivendurationbeforethecomponentisconsiderednoncompliant. TemporaryOvervoltages:Typethemaximumpercentageofintervalsinan observationperiodthattheRMSvaluecanexceedthenominalvoltagebyeach magnitudeforeachdurationpresentedinthedialogboxbeforethecomponent isconsiderednoncompliant.
NOTE
The EN50160 standard defines the observation period for the above components as one week.
Event Priority Selecttheprioritylevel(s)ofthealarmsoreventsthatyouwantreporton. Flicker Baseline High TypetheFlickerBaselineHigh,ifthedefaultisnotappropriateforyourneeds. Flicker Baseline Low TypetheFlickerBaselineLow,ifthedefaultisnotappropriateforyourneeds. Frequency Baseline High TypetheFrequencyBaselineHigh,ifthedefaultisnotappropriateforyourneeds. Incident Interval Selecttheincidentintervalthatyouwanttouseinthereport(i.e.,20seconds,10 minutes,1week). Include Data Warnings Selectwhetherornottoshowdatawarningsinthegeneratedreport. Measurement(s) (Reports other than Load Profile) Usethisinputtoselectthemeasurementsyouwanttoincludeinthereport. ClickSelectMeasurementtodisplaytheSourceSelectordialogbox.Clickthe+ andtoexpandandcollapseitemsinthenavigationtree.ClickSelectAllor SelectNoneinthetoprightcornertoselectorclearallthecheckboxes.For reportswhereyoucanselectmultiplemeasurements,clickthecheckboxbesidea measurement(orgroupofmeasurements)toselectit.Forreportswhereyoucan onlyselectasinglemeasurement,clickonthemeasurementnametoselectit. Whenyouarefinishedselectingmeasurements,clickOK. Measurements (Load Profile Report) Thisinputdetermineswhetherthereportiscalculatedusingdemandorpower measurements.SelecteitherDemandorPowerfromthedropdownlist.
Page 181
Nominal Frequency Typethenominalfrequencyofthesystem(i.e.,60). Nominal Voltage Typethenominalvoltageofthesystem(i.e.,120). Period ThePeriodinputcontainsthefollowingfieldsanddropdownlists: Timezone:SelectwhetheryouwanttoviewtimestampsineitherServerLocal TimeorUTC(UniversalCoordinatedTime). AggregationPeriod:Selecttheblockoftimeforwhichyouwanttocompare data(i.e.,day,week). ComparisonType:Selectwhatperiodofdatayouwanttocomparetheselected AggregationPeriodto(i.e.,todayvs.thesamedayfromthepreviousmonthor currentmonthvs.thesamemonthfromthepreviousyear).Theoptionsvary dependingontheAggregationPeriodselected. NumberofComparisons:Enterthenumberofperiodsyouwanttocompare. AggregationInterval:ThisinputappearswhenyouselectMonthforthe AggregationPeriod.Selecthowyouwantdatagroupedforthereport:bydate (DayofMonth)orthedayoftheweek. SelectedDates:Thisboxdisplaysthedatesofthedatathatwillappearinthe reportbasedontheoptionsselected. Forexample,tocomparetheselectedmeasurementsforthesamedayofthemonth overthelast12months,setAggregationPeriodtoDay,setComparisonTypeto Todayvs.SameWeekdayFromPreviousMonth,andenter12intheNumberof Comparisonsfield. Rates Usethisinputtosetupparametersforenergycostreporting.ClickConfigure RatestoaccesstheEnergyRatesdialogbox. ClickEnergyandDemandtoconfigurebasicrateparametersforthereport. IntheSelectMeasurementssection,clickthecheckboxbesidea measurementtoincludeitinthereport. IntheSelectBillingCalculationsection,selectFlatRateorselectTOU Schedule.IfyouselectTOUSchedule,selectatimeofuseschedulefromthe dropdownlist(seeTimeofUseEditoronpage 80forinformationon configuringatimeofuseschedule). IntheSetRatessection,entertheratesfortheselectmeasurements. IntheSetDemandCalculationsection,selectthecalculationmethodusedto determinedemand:Independent(peakdemandiscalculatedindependently foreachsource)orCoincident(thedemandmeasurementsofthesources arecorrelatedwiththepeakdemandofthemainmeter).Ifyouselect Coincidentforthecalculationmethod,clickMainMetertoselectthesource towhichyouwanttocorrelatethedemandmeasurements. ClickWagestoincludeWAGES(Water,Air,Gas,Electricity,Steam) measurementsinthereport.Clickthe+/buttonstoaddorremove
Page 182
measurements.EnteranameforthemeasurementtheclickSelectSourceand SelectMeasurementtoselectasourceandmeasurement.Enterarateforthe measurementintheRatefield. ClickAdditionalFeestoaddadditionalrateinformationtothereport.Entera nameintheRateNamefieldandrateinformationintheAmountfield. Reporting Period Usethisinputtoselectthetimeframeforthedatayouwanttoviewinthereport. Selectthereportingperiodfromthedropdownlist.Mostoftheoptionsinthe timeframedropdownendonthedaythatyouarerunningthereport.Toruna reportthatstartsandendsinthepast,selectFixedDate.Typeastartandenddate inthedateboxesorclickthearrowsbesidethedatestodisplayapopupcalendar andselectadate.Typeatimeinthetimeboxesorclicktheupanddownarrows besidethetimetoadjustthehoursorminutesupordown. SelectwhetheryouwanttoviewtimestampsineitherServerLocalTimeorUTC (UniversalCoordinatedTime). Sampling Period SelectthesamplingperiodtousefortheIEC61000430report:2hour,10minute or3second. Shifts Usethe+/buttonstoaddadditionalshifts.Foreachshift,enteranameandsetthe startandendtimefortheshift. Toconfigureashiftthatspansmidnight,addtwoshiftsandgivethemthesame name.Forexample,tosetupadayshiftandanightshift,addthreeshifts:Day from8:00AMto8:00PM,Nightfrom8:00PMto12:00AM,andNightfrom12:00 AMto8:00AM. Signaling Voltage 1, 2 and 3 Eval Limit [%] Typethemaximumpercentageofintervalsinanobservationperiodinwhichthe meanvalueofthesignalingvoltagecanexceedthecurvedefinedintheEN50160 standardbeforethatmainssignalingvoltageisconsiderednoncompliant. Show EN50160 Configuration Parameters SelectwhetherornottoshowtheconfigurationinputsenteredintheConfigure EvaluationLimitsdialogboxinthereport. Source(s) Usethisinputtoselectthedevicesyouwanttoincludeinthereport. ClickSelectSourcestodisplaytheSourceSelectordialogbox.Fromthedropdown list,selectthewayinwhichyouwanttodisplaythesources(i.e.,devicetype, groupname,etc.).Clickthe+andtoexpandandcollapseitemsinthe navigationtree.Clickthecheckboxbesideadevice(orgroupofdevices)toselect it.ClickSelectAllorSelectNoneinthetoprightcornertoselectorclearall thecheckboxes.
Page 183
Saving a Report with its Inputs Defined
Whenyouarefinishedselectingdevices,clickOK. THD Baseline TypetheTHDBaseline,ifthedefaultisnotappropriateforyourneeds. Title Typeatitleforthereportinthetextbox. Unbalanced Baseline TypetheUnbalancedBaseline,ifthedefaultisnotappropriateforyourneeds. Voltage Baseline TypetheVoltageBaseline,ifthedefaultisnotappropriateforyourneeds.
Saving a Report with its Inputs Defined

Afteryoudisplayareport,youcansaveaversionofthereportwithsomeorallof theseinputsincluded.Forexample,youmaywanttoalwaysgenerateanEnergy Costreportforacertainnumberofdevicesforthepreviousmonth.Whenyousave thereport,youcansaveitwiththeinputsforthedevicesandtimeperiod predefined. SeeSavingaReportonpage 185formoreinformation.
Generating a Report
Togenerateadefinedreport(areportsavedwithallinputsdefinedandsaved), selectthereportfromthereportselectionpane.Thereportisgeneratedand displayedinthereportdisplaypane. Togenerateareportfromreportdefinitionorfromapartiallydefinedreport: 1. 2. 3. Selectthereportyouwanttogeneratefromthereportselectionpane. Completetherequiredinputs(seeEnteringReportInputsonpage 180). ClickGenerateReport.Thereportdisplaysinthereportdisplaypane.
NOTE
Each report icon has a small circle on its lower right corner. If the circle is green, it is a Defined Report it has all of its inputs completed. If the circle is white, you need to fill in inputs before you can generate it.
Viewing a Report
Afteryougenerateareport,youcandoanyofthefollowing: Click tosubscribetothereport.SeeCreatingReportSubscriptionson page 188.
Page 184
Printing a Report
Clicktheforwardandbackwardarrows navigatethroughthepagesofreport(iftherearemultiplepages). Printthereport .SeePrintingaReportonpage 185.
to
ExportthereportasaPDF,Excel,XML,HTMLorTIFFfile.SeeExportinga Reportonpage 186. Clickshowinputsorhideinputstoshowandhidethereportinputs.
Printing a Report
ClickthePrintbutton .ThePrintdialogboxappears.Selecttheprinterfrom thelistandconfigureotheroptionsasyourequirethenclickOK. Ifthereportyouwanttoprinthasmultiplecolumnsofdata(e.g.,ifithasmultiple measurementsormultiplesources)inatable,thecolumnsmaybeprintedon multiplepages.
NOTE
The first time you print a report, you may be prompted to install an ActiveX control. Click Install to accept this control.
Saving a Report
Tosaveareportwithsomeorallofitsinputsdefined: 1. 2. 3. 4. Displayareportthathasitsinputscompletelyfilledin(eitherselectadefined reportorentertherequiredinputsandclickGenerateReport). ClickFile>Save.TheSaveReportdialogboxappears. TypeanameforthereportintheNamefield. InthelocationboxbelowtheNamefield,selectthelocationforthesavedreport orclickNewFoldertocreateanewfolderforit(notethatyoucannotnestone folderinsideanother). Fromthesectionatthebottomofthedialogbox,selecttheinputsthatyouwant tosaveanddeselectthoseyoudonotwanttosavewiththereport. Youcansaveareportwithonlypartofitsinputscompleted.Whenyougenerate oneofthesereports,youneedtoenterinformationfortheinputsthatwerenot saved. 6. ClickOK.Thereportissavedwiththeinputsyouhaveselected.
5.
Page 185
Exporting a Report
Exporting a Report
Youareabletoexportgeneratedreportsinanumberofdifferentformats(the formatsavailablevarydependingontheversionofSQLServeryouareusing):
PDF Excel XML HTML TIFF
Creates a PDF of the report that you can view in Adobe Reader. Creates a version of the report in Excel format that you can view in Microsoft Excel. Creates an XML version of the report that you can view in your browser or other compatible program. Creates an HTML version of the report that you can view in your browser or other compatible program. Creates a TIFF image version of the report.
Toexportareport,selecttheformatyouwantfromtheSelectaformat dropdownlist.TheFileDownloaddialogboxappears,askingwhetheryouwant tosavethefileoropenit(ifacompatibleprogramexistsonthecomputer). IfyouexportareporttoPDForTIFFformatthathasmultiplecolumnsofdata(e.g., ifithasmultiplemeasurementsormultiplesources)inawidetable,thecolumns maybeappearonmultiplepagesintheexportedfile.
Page 186
Report Administration
Report Administration
ThefollowingsectionsdescribetheoptionsavailableintheManageReportsdialog box.
Managing a Report
UsetheManageoptionintheManageReportsdialogboxtocreateanewfolder, deleteorrenameafolderorreport,ormoveorcopyareportfromonefolderto another. 1. 2. 3. ClickFile>ManageandselecttheManageradiocontrol. Fromthelistbox,selectthereport(orfolder)thatyouwanttomanage. Selectoneoftheseoptions: NewFolder:WhentheCreateNewFolderdialogboxappears,typethe nameofthenewfolderandclickOK.Thenewfolderappearsinthelist. Delete:Apromptappearsaskingyoutoconfirmthedeletion(unlessyou haveselectedanemptyfolderinthiscasethefolderisdeletedwithout confirmation).ClickOKtodeletethereport.Ifthereareanysubscriptions forthereport,thepromptinformsyouofthesubscriptions. Rename:Typethenewnameinthefieldatthebottomofthescreen.Click Updatetosavethechange. Copy:Selectthelocationwhereyouwanttocopythereportandclick Update.Thereportiscopiedtothatlocation.Thenameofthecopiedreport isCopyof<report>,where<report>istheoriginalreportname. Move:SelectthenewlocationandclickUpdate.Thereportismovedtothe newlocation.
Sharing a Report
UsetheShareoptionontheManageReportsdialogboxtomakeareportavailable toauserorgroup.Userswithsupervisorlevelaccesscanshareanyreport;all otheruserscanonlysharereportsthattheyown. 1. 2. 3. ClickFile>ManageandselecttheShareradiocontrol. Selectthereportthatyouwanttosharefromthelistbox. Selecttheuser(s)orgroup(s)youwanttosharethereportwithfromthe AvailableUsers&Groupsbox,thenclicktherightarrowtomovetheuser(s)or group(s)totheShareList. Tounshareareport,selecttheusersorgroupsfromtheShareListandclickthe leftarrow. SelectOrderbytypetoorderthelistsalphabeticallybygroupthenbyuser. 4. ClickApply. ThereportisavailabletotheusersintheShareList.
Page 187
Creating Report Subscriptions

What is a Subscription? Asubscriptionisareportwhichisdeliveredinaspecifiedmanneratadefined interval.Forexample,asubscriptioncanbeconfiguredsoareportisgenerated monthlyandsentviaemailtoagroupofpeople. Subscription Configuration Beforeconfiguringcertaintypesofsubscriptions,youneedtoconfigurereporting subscriptionoptionssuchastheSMTPserverforemailsubscriptionsorhowto handlefileswhenreportsubscriptionsarewrittentoafileshare.SeeReporting Configurationonpage 172forinformationonconfiguringtheseoptions.
Adding a Subscription
Youcanonlycreatesubscriptionsforreportsyouhaveaccessto(seeSharinga Reportonpage 187).Thereportmustbeasavedreportthathasallofitsinputs defined(seeGeneratingandViewingaReportonpage 180andSavinga Reportonpage 185). 1. 2. ClickFile>ManageandselecttheSubscriberadiocontrol. Selectthereporttowhichyouwanttocreateasubscriptionfromthelist,then clickAddtoaddanewsubscription.TheAddNewSubscriptiondialogbox appears. TypeanameforthesubscriptionintheNamefield.Thisisthenamethat displaysinthelistofsubscriptions. Selecttheoutputformat. Selectadeliverymode: Email:ClickDistributionList.Entertheemailaddress(es)towhichyou wanttosendthereportandclickAddaftereachaddress(selectanaddress fromthelistandclickRemovetoremoveit).ClickOKwhenthelistis complete.IntheAddNewSubscriptiondialogbox,typethetextyouwant inthesubjectlineoftheemailintheSubjectfield. Fileshare:Typethelocationofthecomputerandfolderwhereyouwantthe reporttobesaved.Youmusttypetheabsolutepathnametothefolder (includingthedriveletter).TheWindowsuseraccountIONUsermustbe configuredwithvalidcredentialstoreadandwritetothatfileshare.Seeyou systemadministratorforassistance.Tooverwriteanexistingreport(ifone existsinthefolder),selectOverwriteexistingfile.Toleaveanexistingfile inthefolderandsavethenewreportwithanewname,clearOverwrite existingfile. Printer:Fromthedropdownlist,selecttheprintertowhichyouwantto sendthereport.
3. 4. 5.
NOTE
For printed subscriptions, the printer must be a local printer on the Primary Server. For information on setting a network printer as a local printer, consult Microsoft Windows documentation.
Page 188
6.
IntheSubscriptionSchedulesection,definethescheduleonwhichyouwantthe reporttobegeneratedanddelivered: OnAlarm:Selectthisoptiontoconfigurethesubscriptiontorunonan alarm.Selecttheeventyouwanttotriggerthesubscriptionfromthelist.To usethisoption,youmustfirstconfigureanEventWatcher.SeeEvent WatcherManageronpage 62forinformationoncreatinganEvent Watcher. Once:Selectthisoptiontorunthereportonceatthespecifieddayandtime. UsethearrowbesidetheDatefieldtobringupacalendarwhereyoucan selectthedate.TypethetimeintotheTimeofDayboxorusetheup/down arrowstochangethehoursandminutes. Hourly:Selectthisoptiontorunthereporteveryhour.Selectthetimefrom thedropdownlist(i.e.,onthehour,15minutesafterthehour,etc.). Daily:Selectthisoptiontorunthereportonceperdayatthespecifiedtime. TypethetimeintotheTimeofDayboxorusetheup/downarrowsto changethehoursandminutes. Weekly:Selectthisoptiontorunthereportonceperdayatthetimeandon thedayoftheweekthatyouspecify.Selectthedayfromthedropdownlist. TypethetimeintotheTimeofDayboxorusetheup/downarrowsto changethehoursandminutes. MonthlyMonthlybyDate:SelectMonthlythenselectMonthlybyDate torunthereportonselecteddatesinthecalendarmonthataspecifiedtime. TypethedatesintheOncalendarday(s)field.Separatemultipledateswith acomma.Toselectarangeofcontinguousdates,separatethefirstandlast dateintherangewithahyphen.Forexample,toschedulethereporttorun onthe1st,10thto15th,and20thdaysofthemonth,type1,1015,20.After youhaveenteredthedates,typethetimeintotheTimeofDayboxoruse theup/downarrowstochangethehoursandminutes. MonthlyMonthlybyDay:SelectMonthlythenselectMonthlybyDayto runthereportonaspecificdayoftheweekinaselectedweekofthemonth ataspecifiedtime.Forexample,tosetthesubscriptiontorunonthe Mondayofthelastweekofthemonth,selectLastandMondayfromthe dropdownlists.TypethetimeintotheTimeofDayboxorusetheup/down arrowstochangethehoursandminutes.
7. 8.
ClickTestNowtotestthatthereportsubscriptionconfigurationisfunctioning. ClickSavetosavethesubscription. Thesubscriptionappearsinthelistofsubscriptionsfortheselectedreport.
Subscription Errors and Solutions

Certainwarningsmayappearwhenyoutrytoaddsubscriptions.Dependingon thesituation,youmaynotbeabletoaddthesubscriptionoryoumaybeableto additbuttheoutputwillnotbedeliveredsuccessfully.
Page 189
Thefollowingisalistofpossiblewarnings,theircauseandsolutions.
Warning
SQL Agent service not started
Cause
The SQL Server Agent (ION) service is not running. Subscriptions cannot be delivered. The ION Report Subscription Service is not running. Subscriptions cannot be delivered. The e-mail from address is either not set or has the wrong configuration. The file share pathname entered is not correct.
Solution
On the Primary Server, click Start > Settings > Control Panel. Select Administrative Tools, then select Services. Right-click the SQL Server Agent (ION) service and select Start. On the Primary Server, click Start > Settings > Control Panel. select Administrative Tools, then select Services. Right-click the ION Report Subscription Service and select Start. On the Primary Server, open the Reporting Configuration dialog box in Management Console (Tools > Reporting Configuration). Enter a valid email address. For example, myemail@mycompany.com. Enter a valid UNC (Universal Naming Convention) pathname.
Report Subscription Service not started
From e-mail address incorrectly configured
Path syntax invalid
Page 190
Installing a Report Definition or a Report Pack
Installing a Report Definition or a Report Pack

ReportdefinitionscanbedevelopedbySchneiderElectricoranyother organizationskilledatdevelopingcontentforMicrosoftReportingServices. ReportpackscanonlybedevelopedbySchneiderElectric.Tocreatereport definitions,reportdevelopersuseMicrosoftBusinessIntelligenceStudio,which comeswithSQLServer. Afterareportdefinitionisdeveloped,youcaninstallit.Afterareportdefinitionis installedandaccesstoitisgranted,userscanbegincreatingandsavingreports fromthatdefinition. Report Definition Versus Report Pack Forthepurposeofinstallingreportdefinitionsandreportpacks,areport definitionisasingle.rdlfilewhereasareportpackincludesallfilesforacomplex reportorseriesofreports.
Installing or Updating a Report Definition

1. 2. ClickFile>InstallReportDefinition.TheInstallReportDefinitiondialog boxappears. ClickBrowsetonavigatetothelocationofthe.rdlfile.Selectthefileandclick OpenthenclickInstall. Foranewreportdefinition,useFile>Newtoaddittothereportselectionpane. Foranexistingreportdefinition,aconfirmationmessageappears,askingifyou wanttoupdateallreportsassociatedwiththedefinition.ClickOKtocontinue.
Installing or Updating a Report Pack

1. 2. 3. Tomakeareportpackavailableforupload,copyitintotheReportPack directory(../IONEnterprise/web/ReportPacks/). ClickFile>InstallReportPack.TheReportPackInstalldialogboxappears. Selectthereportpackthatyouwanttoinstall.ClickInstall.
Page 191
Custom Report Definitions
Custom Report Definitions

YoucanuseMicrosoftBusinessIntelligenceStudiotocreatecustomreport definitions. Customreportdefinitionsshouldonlybecreatedbyuserswithasolid understandingofthedatabaseaccesslayer,MicrosoftBusinessIntelligenceStudio andReportingServices. ContactSchneiderElectricifyourequirespecializedreportdefinitions.
Page 192
Running the ION Power Quality Aggregation Service Manually

TorunpowerqualityandEN50160reportsinWebReporter,theIONPower QualityAggregationServicemustbestarted.Thisserviceperformscalculations forthesereports. Bydefault,thisserviceisonlyrunonnewdata.Forpreexistingdata,youmust runthisservicemanually. Toruntheservicemanually: 1. 2. 3. SelectStart>Run(orpressSTART+R)todisplaytheWindowsRundialogbox. ClickBrowsetonavigatetotheEventCollector.Cli.exe(locatedinthe..\..\ION Enterprise\system\bin\folder)thentype/a. ClickOK. TheIONPowerQualityAggregationServicerunsinarchivemode.Thiscan takeasignificantamountoftime. Ifyoudonotwanttoruntheserviceonpreexistingdata,youcanstillgenerate powerqualityreportsonthatdatausingReporter(seeAppendixA:Reporteron page 325formoreinformation).
Page 193
Page 194
Designer
UseDesignertoconfigurenodesonyournetworkthatarebasedonION Architecture.Thenodecanbeasoftwarecomponentorahardwaredevice.
NOTE
Only nodes based on ION Architecture can be configured using Designer.
Designersgraphicaluserinterfacehelpsvisualizeanodesconfiguration.Youcan linkIONmodulestogethertocustomizeanodeforyourparticularapplication. Youcanalsocut,copyandpastefunctionalitywithinasinglenodeorbetween differentnodes. FormoreinformationonIONArchitecture,IONmodulesorIONregisters,seethe IONReference.
In This Section
GettingStartedwithDesigneronpage 196 NodeDiagramsandtheDesignerInterfaceonpage 197 IONModuleOverviewonpage 207 UsingIONModulesonpage 209 AddingaNewIONModuleonpage 210 DeletingorCuttinganIONModuleonpage 211 LinkingIONModulesonpage 217 ConfiguringIONModulesonpage 224 CopyingandPastingIONModulesonpage 230 ViewingOutputRegisters,SetupRegisters,andInputsonpage 239 TimeofUse(TOU)ProgramManagementonpage 241 VirtualProcessorServiceonpage 244
Page 195
Getting Started with Designer
Getting Started with Designer

Designerisaprogrammingtoolintendedforadvancedusersonly.Familiarity withIONarchitectureisessential,asDesignerisbasedonIONarchitecture. Thefunctionsusedintraditionalpowermonitoringaretreatedasdiscrete modularobjectsthatcanbeinterconnectedandcustomized.Theseobjects,known asIONmodules,arethebasicbuildingblocksthatcompriseanode. DesignerisusedtomakeanychangestotheoperationofanIONcompliantnode. IONdevices,theVirtualProcessorandLogInserterareallconfiguredusing Designer. ForthosealreadyfamiliarwithDesigner,seeDesignerShortcutsonpage 200for alistofthemostcommonlyusedcommands.
Starting, Logging into and Exiting Designer

TostartDesigner,useoneofthemethodsoutlinedinStartingaComponentof IONEnterpriseonpage 19oropenManagementConsoleandselectTools> System>Designer. ForinstructionsonloggingintoDesigner,seeLoggingintoaComponentofION Enterpriseonpage 19. ForinstructionsonexitingDesigner,seeEndingaSessiononpage 19.
Page 196
Node Diagrams and the Designer Interface
Node Diagrams and the Designer Interface

ThissectiondescribesthecomponentsoftheDesignerinterfaceandofnode diagrams.
Menu bar Toolbar
Workspace with open node diagram
Core module (indicated by double border)
Toolbox
Grouping object
Shortcut icon
Module link
Module icon
Status line
Time display
Progress indicator
Communication status lights
The Designer Interface

TheDesignerinterfaceconsistsofamainscreenwithatitlebar,amenubar,a toolbar,aworkspace,andastatusbar.WheninEditmode,theIONModules toolboxisalsodisplayed.
Title Bar
Thetitlebardisplaysthenameoftheprogram,theusername(forexample, guest)andthenameoftheactivenodediagram.
Menu Bar
Belowthetitlebaristhemenubar.Clickonamenunametodisplayalistof availablecommands.
Page 197
The Node Diagram
Toolbar
TheToolbaroffersquickaccesstothecommandsusedmostfrequently.Each commandofferedonthetoolbarisalsoavailablefromthemenubar.
Open Reset Module Cut Paste
Save
Create a Link
Copy
Help
Whenyoupointatatoolbarbutton,adescriptionofitappearsinthestatusbarat thebottomofthescreenandonasmallToolTipbesidethebutton.
Workspace
Themainareainthecenterofthescreenistheworkspace,whereyouviewandedit nodediagrams.
Status Bar
Thestatusbardisplaysstatusinformation.Thecomponents,fromlefttoright,are: Statusline:Describesanyactiveprocessesandprovidesbriefdescriptionsofthe currentlyselectedcommandortoolbarbutton.Forexample,whenyoumove thepointeroveratoolbarbuttonorclickonamenuname,abriefdescriptionof theitemappearsinthestatusline. Timedisplay:Displaysthecurrenttimeontheworkstation. Progressindicator:Depictstheprogressonanactionbeingperformed. Communicationstatuslights:IndicateifDesigneriscurrentlyreceivingand transmittingdataontheIONEnterprisenetwork.
The Node Diagram

AnodediagramisagraphicalrepresentationofanIONcompliantnode.Thenode diagramdisplaystheactualconfigurationofthenode.Moduleiconsrepresentthe IONmodulesinthenode,whilelinesdrawnbetweenthesemoduleiconsshow linksbetweentheIONmodules. Insomecases,groupsofmodulesareorganizedinsidegroupingwindows.When closed,agroupingwindowappearsasagroupingobject(aniconthatlookslikea folder).Clickagroupobjecttoopenthegroupingwindowthatcontainsthe moduleicons.
Using a Node Diagram

ThenodeisgraphicallydisplayedasanodediagraminDesigner.Thenode diagramcontainsanumberofIONmodules,whichrepresentthenodescurrent configuration.Youcanchangetheconfigurationofthenodesimplybyeditingits nodediagram.Forexample,whenyoudeleteamodulefromanodediagram,the moduleisremovedfromboththediagramandthenode.Youcanadd,configure,
Page 198
The Node Diagram
linkanddeletemodulesonthenodebymakingthecorrespondingchangestothe moduleiconsinthenodediagram.Amodulessetupregisterscanbeaccessedand changedthroughthemoduleicon. UseDesignertoconfigurehardwarenodes(e.g.,IONmeters)orsoftwarenodes (e.g.,VirtualProcessororLogInserter). Default Node Diagrams in Designer WhenameterisopenedinDesigner,thedefaultdiagramsfortheappropriate meteranddefaulttemplateareloadedautomatically.
Opening a Node Diagram

1. 2. SelectFile>Open.TheSelectNodedialogboxappears. SelectthenodeyouwanttoopenthenclickOK. 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.
Closing a Node Diagram

Toclosethenodediagram(s): SelectFile>Closetoclosetheactivediagram,or SelectFile>CloseAlltocloseallopendiagramsandwindows.
Page 199
Display Mode versus Edit Mode
Ifyouattempttocloseadiagramwithoutsavingyourchanges,Designerdisplays awarningwithalistofthemodulesaffected. Youcanthendooneofthefollowing: ClickOKtoreturntothediagramandsaveyourworkbeforeclosingthe diagram. ClickCloseAnywaytodiscardanyunsavedchangesandclosethediagram.
NOTE
If you reopen a diagram containing unsaved changes, Designer may list the unsaved changes as offline modules.
Display Mode versus Edit Mode

TherearetwodisplaymodesinDesigner,whichaffecthowyounavigateanode diagram.Whetherornotthetoolboxisshownindicatesthemodeyouarein:ifthe toolboxisopen,youareineditmode;ifitisclosed,youareindisplaymode. Displaymodeallowsyoutoviewthenodediagramwithoutmakingchanges.To preventaccidentallymovingordeletingmodulesorlinks,useDisplaymodewhen navigatingnodediagrams.InDisplaymode,singleclickgroupingobjectstoopen associatedgroupingwindows. Editmodeallowsyoutoconfigurethenodeandtheappearanceofthenode diagram.InEditmode,doubleclickgroupingobjectstoopenassociatedgrouping windows.Rightclickobjectsoriconstoviewconfigurationoptions FormoreinformationontheToolbox,seeUsingtheIONModulesToolboxon page 209.
Designer Shortcuts
Designerprovidesseveralshortcutstoassistinprogrammingthenodes.
Input Output
Thefollowingtableliststhedifferentmouseandkeyboardcombinationsyoucan performonamodulesinputoroutputsymbols,andtheircorresponding functions:
Action
Left-click on input SHIFT + left-click on input Right-click on input SHIFT + right-click on input Left-click on output SHIFT + left-click on output
Result
The list of inputs appears - you can select an input and link it to another module's output register The list of inputs appears with the current input values displayed in square brackets The Delete Links dialog appears - you can break links from this dialog. The Delete Links dialog appears, showing inputs and current input values in square brackets The list of output registers appears The list of output registers appears with the current register value displayed in square brackets
Page 200
Designer Icons
Action
CTRL + left-click on output SHIFT + CTRL + left-click on output Right-click on output CTRL + right-click on output
Result
The list of setup registers appears - these setup registers can be linked to inputs on other modules The list of setup registers appears with the current register settings displayed in square brackets The list of output register owners appears - you can break links from this dialog The list of setup register owners appears - you can break links from this dialog
NOTE
To create a shortcut to an ION module, see Creating a Shortcut to an ION Module on page 214.
Designer Icons
Ineachnodediagram,Designerusesiconstorepresenttheconfigurationofthe node.Therearetwobasictypesoficons:moduleiconsandgroupingicons. ModuleiconsrepresentIONmoduleslocatedonthenode.Groupingicons representagroupofmoduleicons.
NOTE
A module icon with a symbol in the lower corner is a shortcut.
Module Icons
Allmoduleiconssharefourcommonelements:alabel,agraphic,aninputsymbol andanoutputsymbol.
Label Input Symbol
Graphic Output Symbol
Thelabeldisplaysthenameofthemodule. Thegraphicshowsapicturetodistinguishonetypeofmodulefromanother. Theinputandoutputsymbolsprovideaccesstothemodulesinputandoutput registers.Clicktheleftsymboltodisplayalistofinputs;clicktherightsymbolto displayalistofoutputregisters.SeeLinkingIONModulesonpage 217for moreinformation. Moduleiconswithadoubleborderrepresentcoremodules;moduleiconswitha singleborderrepresentstandardmodules.Formoreinformationoncoreand standardmodules,seeCoreModulesandStandardModulesonpage 208.
Page 201
Designer Icons
Grouping Icons and Grouping Windows

Groupingiconsrepresentgroupingwindows.Clickagroupingicon(left)toopen itsassociatedgroupingwindow(right).
Agroupingwindowactsasafolderorsubwindowwhereyoucanstoreiconsthat youwanttokeeptogether.Forexample,youcanusegroupingwindowstogroup moduleiconsbyapplicationasinglegroupingwindowmaycontainallmodule iconsrequiredfordemandoradvancedsetuproutines. Youcanuseagroupingwindowmuchlikeastandardwindow.Youcancreate, renameordeleteagroupingwindow;youcanmoveagroupingwindowwithina diagram,andyoucanmoveamoduleintooroutofagroupingwindow. Whenyoufinisheditingthegroupingwindow,closeittominimizethewindowto itscorrespondinggroupingiconinthenodediagram. Opening a Grouping Window Clickonthegroupingicon. Closing a Grouping Window ClicktheClosebutton .
Moving Icons into a Grouping Window Tomoveanicon(orgroupoficons)toorfromanopengroupingwindow,selectit anddragittothenewlocation. 1. Clickonagroupingicontoopenthegroupingwindow. Dragthegroupingwindowbythetitlebarandpositionitsothatyoucanseethe icon(s)thatyouwanttomove. 2. Selecttheicon(s)youwanttomoveanddragtheselectionintothegrouping window.
Whenyoumovealinkedmoduleiconintoagroupingwindow,themodule remainslinkedbutanylinesthatrepresentlinkstomodulesoutsidethewindow disappear. Creating a New Grouping Window Tocreateanewgroupingwindow,dragthegroupingobject ontothenodediagram. fromthetoolbox
Page 202
Designer Icons
TheIONmodulestoolboxisacollectionofIONmodulesandgenerictoolsthat youcanaddtoanodediagram.IftheIONmodulestoolboxisnotdisplayed,select Options>ShowToolbox.SeeUsingtheIONModulesToolboxonpage 209for moreinformation. Whenyoupointtoanobjectinthetoolbox,thenameoftheobjectisdisplayedon aToolTip.YoucanuseToolTipstoidentifythegroupingobjectinthetoolbox. Renaming a Grouping Window Whenyoucreateanewgroupingwindow,thedefaultnameisthatofthenode diagram.Tochangethenameofagroupingwindow,renamethegroupingicon: 1. 2. 3. Rightclickonthegroupingicon.TheGroupingObjectConfigurationdialog boxappears. SelectUseCustomfromtheCaptionsectionandtypethenewnameintothetext box. ClickOK.
Changing the Font of a Grouping Window Tochangethefont,fontstyleandsizeofacaption: 1. 2. Rightclickonthegroupingicon.TheGroupingObjectConfigurationdialog boxappears. IntheFontsection,dooneofthefollowing: Tousethefontoftheparentwindow,selectInheritfromparentwindow. Touseadifferentfont,selectCustom,thenclickFont.TheFontdialogbox appears.SelectthefontoptionsyouwantthenclickOKtocontinue. 3. ClickOK.
Changing the Position of the Caption Tochangethelocationofthecaption: 1. 2. 3. Rightclickonthegroupingicon.TheGroupingObjectConfigurationdialog boxappears. SelecteitherToporBottominthePositionsectiontospecifyacaptionposition aboveorbelowthegroupingicon. 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 Deleting or Cutting an ION Module on page 211 for more information on deleting modules.
1. 2.
Selectthegroupingiconofthewindowyouwanttodelete. PresstheDeletekey.Ifthegroupingwindowcontainsmodules,Designer displaysalistofmodulesthatwillbedeleted.
Page 203
Designer Icons
Displaying Default or Custom Icon Labels

Moduleiconscandisplaytwotypesoflabels:Default(left)andCustom(right).
Defaultlabels:Allmoduleshaveadefaultlabel.Thedefaultlabelidentifiesthe modulebytypeand,ifapplicable,bynumber.Itappearsinnodediagrams,user diagramsandeventlogsunlessacustomlabelisavailable. Customlabels:Customlabelsareavailableonlyiftheyhavebeen preconfiguredbyauser.Acustomlabelusuallyidentifiesamodulebyits functionorpurpose.Customlabelsareusefulfordescribingmodules,setup registers,outputregisters,andBooleanON/OFFconditions.Forinformationon addingcustomlabels,seeCustomizingaModuleLabelonpage 227. Displaying Default Labels or Custom Labels SelectOptions>ShowDefaultLabelstotoggletheoptiononoroff. WhenShowDefaultLabelsisselected,defaultlabelsaredisplayed. WhenShowDefaultLabelsisnotselected,customlabelsaredisplayed. Thisisaglobalsettingthatappliestoallnodediagrams.
Moving Icons in a Node Diagram

Youcanmovemoduleandgroupingiconsanywhereinanodediagram.Thisis usefulfororganizingyourdiagram(forexample,byfunctionortype)sothatyou caneasilyfindaparticularmoduleorvisualizetheworkingsofyournodes configuration.Youcanmoveasingleiconorgroupoficonswithinasinglenode diagram,orintoanopengroupingwindow.
NOTE
Moving the icons in a node diagram does not affect the function of the modules or the node in any way.
Moving Icons 1. Selecttheicon(s)youwanttomove. Whenagroupingiconisselected,alliconswithinitsgroupingwindoware automaticallyselectedaswell. 2. Dragtheselectedicon(s)tothenewlocation.
NOTE
When selecting a group of icons, you can only choose icons from within the active window.
Page 204
Designer Icons
Arranging Icons in a Node Diagram

YoucanusetheAlignandGridoptionsintheLayoutdialogboxtoadjustthe spacingandlayoutofthemoduleandgroupingiconsinyournodediagram.Use theAlignoptiontospecifythehorizontalandverticalarrangementoftheselected iconsandtheGridoptiontoactivateandconfigureinvisibleguidelines.
NOTE
Arranging the icons in a node diagram does not affect the function of the modules or the node in any way.
Changing the Order of Layered or Stacked Icons Ifaniconappearsontopofanothericonthatyouwanttobringtothefront,select theiconthatissittingontop,thenclickCTRL+K(orclickEdit>SendtoBack). Aligning Icons TheAligntabintheLayoutdialogboxallowsyoutospecifythehorizontaland verticalalignmentofselectedobjects. Toalignobjects: 1. 2. 3. Selecttheiconsthatyouwanttoalign. SelectEdit>Layout.TheLayoutdialogboxappears. SelecttheAligntabandsetthehorizontalandverticalalignmentoftheicons. Theoptionsineachareadeterminethecriteriabywhichyoucanalignicons.For example,ifyouselectLeftsidesunderHorizontalandSpaceevenlyunder Vertical,Designeralignsallobjectsintheselectionbytheirleftsides(usingthe leftmostobjectforreference)anddistributesthemevenlyalongaverticalaxis. 4. ClickOK.
Using the Grid TheGridtabintheLayoutdialogboxactivatesandconfiguresaninvisiblegrid. Iconsplacedontothegridsnaptothenearestgridlinetohelpalignandspacethem evenly. Toactivateordeactivatethegrid: 1. 2. 3. SelectEdit>Layout.TheLayoutdialogboxappears. SelecttheGridtab. Selectoneofthefollowingoptions: NoGridturnsthegridoff. Gridsizeinpixelsactivatesthegrid.TypeanumberintheGridsizein pixelsboxtospecifythesizeofthegrid(distancebetweengridlines). 4. ClickOKtosaveyourchanges.
Page 205
Designer Windows
Designer Windows
Tocreatelinksbetweenseveralnodediagramsorgroupingwindows,youneedto positiontheopenwindowssoyoucanseeallthemodulesinvolved.Usethe Windowmenutoorganizeopenwindowsintheworkspace.
Arranging Windows in your Workspace

Toarrangewindows,dooneofthefollowing: Tolocateanopenwindowandmoveittotheforeground,selecttheWindow menuandselectthewindownamefromthelistofopenwindows. Toarrangeallopenwindowsintheworkspace,selectWindow>ArrangeAll.
Changing a Windows Background Color

Bydefault,thebackgroundcolorofallwindowsinanodediagramislightgray. Toselectanewbackgroundcolorforawindow: 1. 2. 3. RightclickonthebackgroundofthewindowandselectBackgroundColor. TheColordialogboxappears. SelectthecoloryouwantorclickDefineCustomColorsformoreoptions. ClickOK.
Whenchoosingabackgroundcolor,considerhowthecoloraffectsthevisibilityof iconsandlinks.Links,highlightsandshadoweffectsusedtodepictthevarious statesofanIONmodulemaynotappearagainstcertainbackgroundcolors.For thisreason,youshouldavoidusingcertaincolorsforyourbackground, particularlywhite,darkgrayandblack.
Changing a Windows Default Font

Youcanspecifyadefaultfonttobeusedforallmoduleicons,groupingiconsand textboxesinawindow. 1. 2. 3. RightclickonthebackgroundofthewindowandselectDefaultFont.The Fontdialogboxappears. Specifyanewdefaultfont,sizeandstyle. ClickOK.
Fontscanalsobespecifiedindividuallyforgroupingwindowsandtextboxes.See ChangingtheFontofaGroupingWindowonpage 203andChangingtheFont ofaTextBoxonpage 215formoreinformation.
Page 206
ION Module Overview
ION Module Overview

Afteryouhaveopenedanodediagram,youcanviewthenodesconfigurationor edititbyworkingwithitsIONmodules.Asdescribedearlier,eachmodule performsaspecificfunction.UsingDesigner,youcanadd,removeorlinkmodules togethertocustomizethefunctionofthenode. ThissectionexplainshowtoaddandremoveIONmodulesfromyournode diagram.Itdescribesthebasictypesofmodules,andexplainshowyoucan organizeyournodediagrambygroupingmodulestogether,arrangingthem,and labelingthem. FormoreinformationonIONmodulesandarchitecture,refertotheIONReference.
Working with ION Modules

Thefollowingsectionsoutlinesomeconsiderationstorememberwhenworking withIONmodules. Output and Setup Registers Aregisterisatypeofmemorybankthatstoresamoduleslinkingand configurationinformation.Eachmoduleusestwotypesofregisters:output registersandsetupregisters. Module Status: Online and Offline Thetermsonlineandofflinedescribewhetheramoduleiscurrentlyactiveor not.Amoduleisdescribedasonlinewhenitisfunctioningnormally(monitoring itsinputandupdatingitsoutputregisters).Anofflinemoduleisinactive. Anytimeyousendandsavechangestoanode,Designertemporarilytakesthe affectedmodulesofflineandprogramsthemwithyourchanges.Aftertheyhave beenprogrammed,themodulesarethenplacedbackonline. Normally,thisisaroutineprocedure.However,certaincircumstancesmay preventamodulefromreturningonline.Forexample,ifthenodelackssufficient processingpowertooperatethemodule,themoduleremainsoffline. Youcaneasilyidentifyanyofflinemodules:allofflinemodulesarehighlighted witharedoutline.Inaddition,wheneveryouopenanodediagram,Designer displaysalistofallofflinemodulesinthenode.
NOTE
If you have offline modules in your node, you may be able to put them back online by selecting File > Send & Save.
Page 207
ION Module Overview
Module Status: Programmed vs. Pending Thetermsprogrammedandpendingrefertowhetherornotamodules representationinthenodediagrammatchesthenodeitself.
Programmed
Pending
Programmed:Aprogrammedmoduleisonethatisthesamebothinthenode diagramandinthenode.Thelinks,labelsandsetupregistervaluesinthenode diagramexactlymatchthoseonthenode.Whenyoufirstopenanodediagram, allthemodulesappearprogrammedsincetheyarereaddirectlyfromthenode itselfandthendisplayedinthenodediagram. Pending:Apendingmoduleisonewherechangeshavebeenmadetothe moduleinthenodediagramandnotyetsenttothenode,sothenodediagram doesnotmatchthenode.Thebordersofpendingmoduleiconsappearasa dashedline. Ifyouchangeamoduleinthenodediagram(forexample,relinkitoredititssetup registers),itdoesnotmatchthenodeuntilyouselectFile>Send&Save.Untilit issaved,theeditedmoduleisdepictedaspendingtoindicatethatitdoesnot matchtheconfigurationonthenode.Whenyousendandsaveyourchangestothe node,themodulebecomesprogrammed. Core Modules and Standard Modules TherearetwobasictypesofIONmodules:core(left)andstandard(right).
CoremodulesarerequiredIONmodulesthatarefundamentaltotheoperation ofthenode.Youcannotaddordeletecoremodulesand,insomecases,you cannotconfigurethem.Coremoduleiconsareidentifiedbyadoubleborder aroundtheedge.ThePowerMetermoduleisanexampleofacoremodule. StandardmodulesarereusableIONmodules.Generally,mostmodulesina nodearestandardmodules.Youcanaddordeletestandardmodulesas required.Standardmodulesiconsareidentifiedbyasingleborder.TheSetpoint moduleisanexampleofastandardmodule. Persistent Modules Similartocoremodulesinthattheycannotbeaddedordeleted,persistent modulesarestandardmodulesthathavebeenconvertedtocoremodules.These modulesarecreatedatthefactory,andcanneverberemovedfromthemeter frameworks.Persistentmodulesarerepresentedbyiconswithsingleborders. AnexampleofapersistentmoduleisExternalPulsemodule#1ontheION8600 meter.ThismodulepulseswhentheDemandResetswitchispressedonthemeter.
Page 208
Using ION Modules
Using ION Modules

Youcanchangethefunctionofanodebyeditingtheappropriatemodule(s)inthe nodediagramandlinkingmodulestogether. Thissectiondescribeshowtolocateanexistingmodule,howtoaddanewmodule, andhowtodeleteamodule.Italsoexplainshowtocreateashortcuttoamodule andhowtoviewthecontentsofamoduleintextformat. Afteryouhavelocatedoraddedthemoduleyouwant,youcanconfigureitusing theproceduredescribedinLinkingIONModulesonpage 217.
Using the ION Modules Toolbox

TheIONModulestoolboxisacollectionofIONmodulesandgenerictoolsthat youcanaddtoanodediagram.TodisplaytheIONModulestoolbox,select Options>ShowToolbox.
Thetypeandquantityofmodulesofferedonthetoolboxvariesdependingonthe typeofnodeyouareconfiguring;however,thegenerictools(thegroupingand textobjects)areavailableforallnodes.
NOTE
To identify a module in the toolbox, point to it with the mousethe module type is displayed as a ToolTip and on the status line at the bottom of the screen.
Toaddamoduletoyournodediagram(andtothenodeitself),dragitsiconfrom thetoolboxintothediagramwindow. Opening the ION Modules Toolbox Toopenthetoolbox,selectOptions>ShowToolbox. Closing the ION Modules Toolbox ClicktheClosebutton orclearOptions>ShowToolbox.
Page 209
Adding a New ION Module
Locating an Existing ION Module

Beforeyoucaneditamodule,youmustfirstlocateitinthenodediagram.Tofind amoduleinanodediagram,youcanusethemoduletrayfeatureofthetoolbox. Locating an Existing Module from the Module Tray 1. Todisplaythemoduletray,rightclickthetoolboxiconforthetypeofmodule youwanttolocate.Themoduletrayappearsbesidethetoolbox.
Themoduletraydisplayslinkstoallmodulesofthattypethatarecurrentlyin useonthenodeforexample,intheimageabove,thereareeightDisplay modulesinusebythenode.Toidentifyalinkinthetray,pointtoitthe moduleslabelisdisplayedonthestatuslineatthebottomofthescreen. 2. Tolocateaparticularmodule,clickitslinkinthemoduletray.Designerlocates themoduleanddisplaysitinthecenteroftheworkspace.Ifthemoduleis locatedinsideagroupingwindow,Designeropensthewindowtodisplaythe module.
TIP
To close the module tray, click on any module icon in the toolbox.
Adding a New ION Module

Mostnodesarepreprogrammedatthefactorytoprovidethemostcommonly requiredfunctions.However,ifthefactorydefaultconfigurationisnot appropriateforyourapplication,youcanaddanewmodule. Adding a Module on a Node Dragtheiconofthemoduleyouwanttoaddfromthetoolboxontothenode diagram. Asyoudragtheicon,thecursorchangesshapetoindicateyouareplacingan object. Designeraddsthemoduleandplacesapendingmoduleiconintothediagram. Youcanthenlinkandconfigurethemodule. SeeLinkingIONModulesonpage 217formoreinformationonprogramming modules.
Page 210
Deleting or Cutting an ION Module

Toremoveastandardmodulefromanode,deleteitsiconfromthenodediagram. Byremovingunnecessarymodulesfromthenode,youcanfreeupresourcesfor useelsewhere.
NOTE
Each time a module is deleted, all of its output registers, setup registers and input links are deleted as well. Removing this information from the node affects the operation of any modules that depend on it. For this reason, you should be aware of all dependent modules (also known as owners) before you delete anything.
Checking for Dependent Modules

Whentwolinkedmodulesarelocatedinthesamewindow,Designerdepictsthe linkasalinethatrunsfromtheoutputregisterofonemoduletotheinputof another.Youcaneasilyidentifythedependentmodule(orowner)bytheline runningtoitsinput.However,ifoneofthelinkedmodulesislocatedinadifferent window,theconnectionisnotvisible.Amoreeffectivewaytolocateamodules ownersistoviewtheownersofitsregisters. Viewing the Owners of a Module's Setup and Output Registers Youcanviewaregistersownerstoquicklyidentifyalldependentmodulesonthe node.Youcandeterminewhatpurposethemodulesserve,andthendecide whethertodeletethemornot. 1. Dooneofthefollowing: Toviewtheownersofamodulesoutputregisters,rightclickontheoutput symbol. Toviewtheownersofamodulessetupregisters,holdtheCTRLkeyand thenrightclickontheoutputsymbol. TheOwnersdialogboxappears.Itlistsallofthemodulesregistersandany dependentmodulesonthenode(dependentmodulesonothernodesarenot displayed). 2. ClickaregisterintheRegisterslisttodisplaytheownersofthatregisterinthe Ownerslistontheright.Ownerinformationincludesthemodulenameorlabel anditsrelevantinput. Ifnecessary,deletethelinkbetweenaregisterandoneofitsowners.Selectthe ownerfromtheOwnerslistandclickUnlink.(SeeDeletingLinksonpage 222 formoreinformationondeletingmodulelinks.) Whenyouhavefinishedviewingtheregisterowners,clickOK.
3.
4.
Viewing Owners on Other Nodes Displayingamodulesregisterownersisaneffectivewaytolocatedependent modulesontheselectednodebutitdoesnotshowanydependentmoduleslocated onanothernode. Ifyouremoveamodulewithadependentmoduleonanothernode,thedependent modulesinputsarenotreset.Itcontinuestolookforthedeletedoutputregister.
Page 211
Ifyouarenotsurewhetheramodulehasdependentsonothernodes,checkwith thepersonwhoprogrammedthemtoensureyoudonotdisrupttheoperationof anymodulesonthatnode.Ifyoustillwanttoremovethemodule,youmaywant todirectlydeletethelinkontheothernodefirst.Thisensuresthatthemoduleis notinadvertentlylinkedtothenextmoduletooccupythelocationofthedeleted module.

AfteryouhavedeterminedthatyoucansafelyremoveanIONmodulewithout disruptingotherfunctions,therearetwowaystoremoveit:deleteanddiscardthe moduleorcutthemoduletopasteitinanotherlocation. Ineithercase,Designerimmediatelyremovestheiconfromthenodediagramand deletesthemodulefromthenode.Thedifferenceis,whenyoudeleteamodule,it isdiscarded;whenyoucutamodule,itcanberestored(byselectingEdit>Paste).
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. 2. Selecttheicon(s)ofthemodule(s)youwanttoremove. Dooneofthefollowing: Tocutthemodule(s)topasteitinanotherlocation,selectEdit>Cut. Todiscardthemodule(s),presstheDeletekey.
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.
Page 212
Viewing a Node or Module as Text
Thesummarylistsallselectedmodules,andidentifiesthoseintheselectionthat willbedeleted(includingthosewithdependentsonthatnode)andthosethat willnot.Selectamoduleinthislisttodisplayanyadditionalinformation availableinthefieldatthebottomofthedialogbox. 3. ClickOKtoremovetheselectedmodules(orCanceltoaborttheprocedure). Designerremovesthemoduleiconfromthenodediagramanddeletesthe modulefromthenodeitself.
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 a Node or Module as Text

YoucanusetheViewDiagramTextcommandtodisplayastextthecomplete contentsofoneormoremodulesorofanentirenode.Usethisoptiontoviewthe specifiedinformationonyourscreensoyoucansortit,performanalysis,createa detailedrecordofyournodesconfiguration,orprintacopyforyourrecords. 1. Selectthemodule(s)thatyouwanttodisplay.
TIP
To select all modules in the node, left-click on the background of the main node window, being careful not to click on a module icon, then select Edit > Select All.
2.
SelectOptions>ViewDiagramText.TheTextViewscreenappears.Thetextof anymodulesthatareofflineappearsinred.
Page 213
Creating a Shortcut to an ION Module
TheTextViewscreenoffersseveralwaystoview,sortandfindinformation: IntheViewdropdownlist,selectoneoftwoviewmodes: UseArchivetodisplayinformationusefulforarchivingthenodes configuration. UseDiagnostictodisplaydiagnosticinformationontheselectedmodule(s). IntheSortbydropdownlist,selectthecriteriabywhichyouwanttosortthe data:

Archive View
Default Module Class Module Name
Diagnostic View
Default Module Class Module Name Module State Module label Type of module Default label
Sorts by
Displays offline modules first followed by online modules. Sorts alphabetically within each group. Displays event driven 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
Module Update Period
IntheFindtextfield,typeatextstringandclickFindtofindthattextstringin thedata. Toresetthetextviewafteryouhavemadeaconfigurationchange,clickRefresh. Ifyouwanttoprintacopyofthetextviewinformation,clickPrint.Whenyouare finishedviewingthetextviewinformation,clickClose.
Creating a Shortcut to an ION Module

Tosavetimeswitchingbetweenmodulesindifferentwindows,createashortcut iconinonewindowthatrepresentstheoriginalmoduleintheotherwindow. Ashortcuticonisidentifiedbya icon. Creating a Shortcut Icon HolddownSHIFT+CTRLthendragthemoduleicon(s)tothewindowwhereyou wanttoplacetheshortcut(s). Afteryouhavecreatedashortcuticon,youcanuseitinthesamewayyouusethe originalmoduleicon.Bothiconssupportthesamefeatures.However,ifyoudelete theshortcuticon,theoriginalmoduleiconisnotdeleted;whereasifyoudeletethe moduleicon,itdeletesallshortcutstothatmodule. symbolinthelowerleftcornerofamodule
NOTE
You cannot create more than one shortcut icon per window for a single module.
Page 214
Adding a Text Box to a Node Diagram

Youcanplaceatextboxanywhereinanodediagram,andmoveitorresizeitas necessary.Youcanuseatextboxtodescribeanyprocessorfunctioninyour system;forexample,youcanlabelindividualcomponentsofyoursystemor displayablockofdescriptivetextorinstructions. Adding a Text Box 1. DragaTextBoxobject( )fromthetoolboxontothenodediagram. Atextboxappearsinthediagramwiththedefaultmessage:Yourtextgoes here. 2. 3. Rightclickonthetextboxtoreplacethedefaulttextwithyourowntext.The TextBoxConfigurationdialogboxappears. SelecttheEditTexttab,thendooneofthefollowing: Todisplaythenameofthenodeinthetextbox,selectUseDefault. Todisplayyourownmessage,selectUseCustomandtypeyourtextinto thefieldprovided. 4. ClickOK.Thetextboxdisplaysyourspecifiedtext.
Resizing a Text Box Toresizeatextbox: 1. 2. Selectthetextbox. Dooneofthefollowing: Tomaketheobjectlargerorsmaller,dragacornerhandle. Tostretchtheobjecthorizontallyorvertically,dragamiddlehandle. Changing the Font of a Text Box Thefont,sizeandstyleofthetextusedinthetextboxisbasedonthedefault settingspecifiedfortheactivewindow.Ifyouwanttouseadifferentfont,youcan specifyanewfontforthetextbox: 1. 2. 3. Rightclickonthetextbox.TheTextBoxConfigurationdialogboxappears. SelecttheTexttab. IntheFontsection,dooneofthefollowing. Tousethefontspecifiedfortheparentwindow,selectInheritfromparent window. Touseadifferentfont,selectCustom,thenclickFont.TheFontdialogbox appears.Specifyafont,style,andsize.ClickOKtocontinue. 4. ClickOK.
Page 215
Changing the Position of the Text Tochangethepositionofthetextinthetextbox: 1. 2. 3. 4. Rightclickonthetextbox.TheTextBoxConfigurationdialogboxappears. SelecttheTexttab. InthePositionsection,selectLeft,Center,orRight. ClickOK.
Adding a Border or Background Color to a Text Box Toaddabordertoatextboxorchangeitsbackgroundcolor: 1. 2. 3. Rightclickonthetextbox.TheTextBoxConfigurationdialogboxappears. SelecttheBoxtab. Dooneormoreofthefollowing: Toaddaborder,selectShowintheBordersectionandclickColortoselecta bordercolor. Tosetthewidthoftheborder,typeaborderwidthintheWidthinpixels fieldintheBordersection. Toaddabackgroundcolor,selectCustomintheBackgroundColorsection andclickColortoselectabackgroundcolor. 4. ClickOK.
Page 216
Linking ION Modules
Linking ION Modules

LinkingIONmodulestogetheristhefoundationofprogrammingIONcompliant nodesinIONEnterprise.AlthoughanIONmodulecanperformafunctionin isolation,thestrengthandflexibilityoftheIONarchitecturecomesfromtheability tointerconnectmodulestobuildmoresophisticatedfunctions.
Choosing which ION Modules to Link

Thefirststepinlinkingmodulesistodecidewhichmodulesyouwanttouse. Whenchoosingamoduletolink,youhavetwochoices:youcanaddandlinka newmoduleoryoucanrelinkanexistingmodule. Insomecases,youmaynotwanttoaddanewmodule.Forexample,ifallthe modulesofaparticulartypearealreadyused,youneedtorelinkoneofthemto performthenewfunction.Mostdevicesarepreconfiguredatthefactorytoprovide commonmeasurementsandcalculations.Ifanyofthesefactorydefaultsare unnecessaryinyourapplication,youcanunlinkthemodulesinvolvedandreuse them. Planaheadbeforeyouaddnewmodules.Unlinkedmodulesarewastedresources. 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 workingwithtoensureyoudonotinadvertentlycreateundesirablelinks.
Page 217
Linking ION Modules on the Same Node
Enabling Autolinking Toenableautolinking,selectOptions>EnableAutolinking.Acheckmarkbeside theoptionindicatesitisselected. Disabling autolinking Todisableautolinking,clearOptions>EnableAutolinking.
Linking ION Modules on the Same Node

IftheselectednodeisametersuchastheION7650,theprocessofconfiguringthe nodeprimarilyinvolvescreatinglinksbetweenmodulesonthatnode.
NOTE
To cancel a link-in-progress, click anywhere in the background of the window or press the ESC key.
Linking Modules Using the Point and Click Method 1. Tolistamodulesoutputregisters,clicktheoutputsymbolontherightsideof themoduleicon.Tolistthemodulessetupregisters,holdtheCTRLkeywhile clickingtheoutputsymbol. Eitherapopupmenuappearsor,ifthemodulehasmanyregisters,adialogbox appearslistingtheavailableregisters. 2. Selecttheregisteryouwanttolink: Inthemenu,clicktheregisteryouwanttoselect. Inthedialogbox,doubleclicktheregister(orclickitthenclickSelect). 3. Movethecursortowardsthemoduleyouwanttolinkto.Thecursorchanges andadottedlinefollowsitacrossthenodediagram.Thisindicatesyouarein theprocessofcreatingalinkanditshowswheretheconnectinglinewillappear inthenodediagram. Ifyoulinktoamodulethatisinadifferentwindowthantheoriginalmodule (eitherinadifferentnodediagramorgroupingwindow)thedottedline disappearsbutthecursorstillindicatesthatalinkisinprogress. Ifthemoduleyouwantisobscuredbyanotherwindow,clickonthetitlebarof thewindowcontainingthemodule.Thisbringsthewindowtotheforeground withoutcancelingthelink.(Ifyouclickonthebackgroundofthewindow,the linkiscancelled.) 4. Clicktheinputsymbolofthemodulethatyouwanttolinktodisplaythe modulesinputs.Eitherapopupmenuappearsor,ifthemodulehasmany registers,adialogboxappearslistingthemodulesinputs. Iftheinputisalreadylinked,thelabeloftheregisteritislinkedtoisdisplayed besidetheinput.Ifyouselecttheinput,theexistinglinkisoverwritten. Theinputsthatareofadifferentclassthantheselectedoutputregisterare grayedouttoindicateyoucannotselectthem.
Page 218
Linking ION Modules Across Different Nodes
5.
Selecttheinputyouwanttolinkto: Inthemenu,clicktheregisteryouwanttoselect. Inthedialogbox,doubleclicktheregister(orclickitthenclickSelect).
6.
SelectFile>Send&Savetosaveyourchangestothenode.
Theproceduredescribedabovecanalsobeperformedinreverseorder.Youcan selectamodulesinputfirstandthenlinkittoanothermodulesoutputregister.
Linking Modules with Variable Number of Inputs

Somemodules,suchasAND/ORmodules,DataRecordermodules,andLog Acquisitionmoduleshaveavariablenumberofinputs.Inthesecases,whenyou clickontheinputsymbol,thepopupmenuoffersoneinstanceofthevariable inputaswellasanyfixedinputsthemodulemayhave.Whenlinkingtooneof thesemodules,youcanselecttheNEWSourceitemtoaddanewlinkoryoucan selectanexistinglinkandoverwriteit. Ifthetwomodulesareinthesamewindow,thelineremainsonthescreentoshow thelinkbetweenthemoduleswhenyousavethischangetothenode,theline changesfromadottedlinetoathinblacklinetoindicatethatthelinkisnow programmedonthenode.
Linking ION Modules Across Different Nodes

Iftheselectednodeisasoftwarenode,suchastheVirtualProcessororLog Inserter,manyofthelinksyoucreatearetomodulesonothernodes.Whenyou createlinksacrossdifferentnodes,itisimportanttokeeptrackoftheselinksand notewhatmodulesaredependentonothers.Thishelpsyoudeterminewhatwill happenifyoueverwanttodeleteamodulethatislinkedtoamoduleonanother node.
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.
1. 2. 3. 4. 5.
Openthenodediagramsthatcontainthemodulesyouwanttolink. Positionthediagramswithintheworkspacesoyoucanseethetwomodulesyou wanttolink. Inthefirstnodediagram,clickontheoutputsymbolofthemoduleicon.Apop upmenuordialogboxappearslistingthemodulesoutputregisters. Inthelistofoutputregisters,clicktheregisteryouwant.(Inthecaseofthedialog box,clickaregisterandthenclickSelect.) Dragthecursorfromthefirstnodediagramtothemoduleyouwanttolinkto inthesecondnodediagram.Thedottedlineceasestofollowthecursorifit crossesthewindowboundarybutthecursorchangestoindicatealinkisin progress.
Page 219
Linking ION Modules Using the ION Tree
6.
Clickontheinputsymbolofthemoduleiconinthesecondnodediagram.A popupmenuordialogboxappearslistingthemodulesinputs.Thosethatare ofadifferentclassthantheselectedoutputregisteraregrayedouttoindicate youcannotselectthem. Clicktheinputyouwant,orinthecaseofthedialogbox,clicktheinputthen clickSelect.Designerdoesnotgraphicallyrepresentlinksbetweenmoduleson differentnodessoyouwillnotseealineconnectingthemodules. SelectFile>Send&Savetosaveyourchangestothenode.
7.
8.
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 is overwritten.
A Note About Performance Whilecreatinglinks,youmaynoticethecircleattheendofthearrowcursoris sometimesblack( ). ThisindicatesthatDesignerisintheprocessofretrievinginformationabouta module.Youcanstillclickontheinputsoroutputsofothermodules,butDesigner abortstheoriginalrequest.Tominimizetheamountofcommunicationsbetween Designerandtheconnectednodes,avoidunnecessaryclickingontheinputand outputsymbols. Ifyouclickonseveralitemsinarow,youonlyseethemenuforthelastitemyou click;however,Designerinitiatesmanyrequestsforinformation,whichmay impactitsperformance.

Insomecases,youmaywanttousetheIONtreetoselecttheregisterforlinking. TheIONtreeisahierarchicallistingofeverynode,manager,module,andregister intheIONEnterprisenetwork.Itallowsyoutoselectaregisteronanodewithout openingthenodediagram.Generally,youusetheIONtreetocreatelinksacross nodes. TheIONtreeisalsotheonlywaytoselectregistersfromdevicesthatarenotION compliant(andusetranslatorstomakedataavailable)suchas3000seriesmeters. Forexample,ifyouareprogrammingaVirtualProcessornodeandyouwantto sumdatafromseveral3720ACMs,youmustaccessthe3720ACMregisterviathe IONtree.
Page 220
UsingtheIONtreeisfasterthanopeninganodediagram.Itisusefulifyouwant tolinktoaregisteronanodewhosediagramhasnotyetbeenopened.Itisalso usefulifyouwanttolinktoaregister,butyouarenotacquaintedwiththe configurationofthenodeinwhichitresides.Youcangostraighttotheregister withouthavingtonavigatethroughanunfamiliarnodediagram.Also,sincea diagramcanonlybeaccessedbyoneuseratatime,youcanusetheIONtreeto linktoaregisteronanothernodewherethediagramisalreadyopen. Linking Modules Using the ION Tree 1. 2. 3. Clicktheinputsymbolofthemoduleicon.Alistofthemodulesinputsis displayed. Inthelistofinputs,selecttheinputyouwanttolink. Clickthe buttoninthetoolbar.(Tolinkamodulessetupregister,hold theCTRLkeywhileclickingthisbutton.) TheCreateLinkdialogboxappears,providingaccesstotheIONtree.
4.
Specifyanode,manager,moduleandoutputregister:Doubleclickthenode youwantintheNodesbox.Allmanagerswithintheselectednodeappearinthe Managersbox.Youcanthendoubleclickthemanageryouwant,andrepeatthis procedureforthemodulesandregisters. ClickOK.Themodulewhoseinputschangedappearsgrayedouttoindicateit isnowpending.Ifbothmodulesareinthesamewindowofthesamenode diagram,alineappearstorepresentthelink. SelectFile>Send&Save.Thenewlinkisestablishedandthemoduleappears programmed.
5.
6.
Theproceduredescribedabovecanalsobeperformedinthereverseorder.You canclickthe buttonfirst,selectanoutputregister,andthenclicktheinput symbolofamoduleicontoselectoneofitsinputs.
Page 221
Deleting Links
Deleting Links
Ifyouwanttodisassembleagroupoflinkedmodulesandusethemforanother function,youcandeletethelinksbetweenthemodulesratherthandeletingthe modules.Designerprovidesseveralwaystodeletelinks. Fixed Links Mostlinksbetweenstandardmodulescanbedeleted.However,somelinks betweencoremodulesarefixedandcannotbedeleted.Thesefixedlinksinclude: DataAcquisitionmoduleandallPowerMetermodules DataAcquisitionmoduleandallFFTmodules FFTmoduleandallHarmonicsAnalyzermodules FFTmoduleandallSymmetricalComponentsmodules Ifyouattempttodeleteafixedlink,Designerinformsyouthatthelinkcannotbe deleted.
Deleting Visible Links

Ifthelinkedmodulesareinthesamewindow,simplyclickonthelinklineand presstheDeletekey.Thisistheeasiestmethodaslongasyouknowwhichoutput registerandinputareinvolved.Forexample,intheimagebelow,theeasiestway todeletethelinkistoclickonthelinejoiningthePowerMeterandtheSliding WindowDemandmodule(itscolorreversestoindicateitisselected)andpress Delete.
Iftherearemultiplelinesbetweenthesamemodulesandyouonlywanttodelete oneofthelinks,youmaywanttousethemethoddescribedinDeletingLinksthat areNotVisibleonpage 222.
Deleting Links that are Not Visible

Ifyoucannotseealinethatlinksthemodules(forexample,iftheyareindifferent windows),oryouneedtoknowwhichoutputregistersandwhichinputsare involved,youmustuseadialogboxtodeletethelinkbetweenmodules.Youcan lookeitherattheoutputregisterownersofthefirstmoduleoryoucanlookatthe inputsofthesecondmoduletoseewhattheyarelinkedto,andthendeletethelink fromthere.
Page 222
Deleting Links
Deleting a Module's Input Links

Deletinglinksatamodulesinputsisgenerallyfasterthandeletingthematthe modulesoutputregistersbecauseDesignerdoesnotneedtochecktheentirenode. Ontheotherhand,thereislessinformationavailableifyouviewinputlinks.All youseeisthelabeloftheoutputregisterthatislinkedtotheinput.Ifthisis sufficientinformation,proceedwiththismethod;ifnot,gototheoutputregisters todeletethelink. Viewing a Module's Input Links 1. 2. Rightclickontheinputsymbolofthemoduleicon.TheDeleteLinksdialog boxappears. Eachinputandthelabeloftheoutputregisteritislinkedtoaredisplayedinthe dialogbox.Todeleteoneormoreoftheselinks,selecttheinputandclick Unlink.Theoutputregisterlabelisreplacedwithdashedlines. Whenyouhaveunlinkedalltheregistersyouneedto,clickOK. SelectSend&Savetounlinkthemodulesonthenode.
3. 4.
Deleting a Module's Output Links

YoucanalsodeletelinksfromtheRegisterOwnersdialogbox.Thismethodgives youthemostinformationaboutthelinkyouaredeleting(theoutputregisterlabel andtheinputandlabelofthemoduleitislinkedto). Viewing a Module's Output Links 1. Rightclickontheoutputsymbolsideofthemoduleicon.(Tolistthemodules setupregisters,holdtheCTRLkeywhilerightclickingonthesymbol.) TheRegisterOwnersdialogboxappears. 2. 3. 4. 5. SelecttheoutputregisteryouwantfromtheRegisterssection.TheOwners sectionlistsallthemoduleinputstowhichtheselectedregisterislinked. Todeleteoneormoreoftheselinks,selectthemoduleinputintheOwnerslist boxandclickUnlink.Theinputnameisreplacedwithadashedline. Whenyouhaveunlinkedallofthemoduleinputsyouwant,clickOK. SelectSend&Savetounlinkthemoduleinputsonthenode.
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 Deleting a Module's Input Links on page 223.
Page 223
Configuring ION Modules

Afteryouhaveplacedamoduleinanodediagram,youcanconfigurethevarious setupparametersofthemodule.Itisnotnecessarytodothisbeforeyoulinkthe modulesbutyoushouldensurethemoduleissetupcorrectlybeforesendingthe configurationtothenode. Modulesetupparametersincludethemoduleslabel;itssetupregisters,labelsand values;anditsoutputregisterlabels.Toaccessthese,rightclickonthesymbolin thecenterofthemoduleicon.
TheIONModuleSetupdialogboxappears.
TheSetupRegistersboxlistsallthesetupregistersofthemodulealongwiththeir currentvaluesorsettings.Tochangeanyofthesettingsorassignacustomlabelto asetupregister,selecttheregister,thenclickModify(ordoubleclickonthe register).TheModifyRegisterdialogboxappearswhereyoucanmake modifications. Inmostcases,configuringasetupregisterisasimplematterofenteringanumber, enteringtext,orchoosinganoptionfromalist.(Todeterminetheoptionsorranges availableforasetupregister,refertothemodulesdescriptionintheION Reference.) Whenyouhavecompletedallyourmodificationstothemodule,clickOKto returntothenodediagram.Themoduleiconappearspendinguntilyousendand saveyourchanges.
Page 224
Modifying Enumerated, Numeric Bounded, and String Setup Registers

Iftheregisteryouhaveselectedisanenumerated,numericboundedorstring register,oneofthefollowingdialogboxesappearwhenyouclickModify: Enumerated Registers Tomodifyanenumeratedregister,selectanoptionfromtheOptionslist. Numeric Bounded Registers Tomodifyanumericboundedregister,typeanumberintheValuebox.The allowablerangeisshownundertheValuebox;youarealertedifyoutypea numberoutsidethisrange. Toenteraformattednumericvalue,clickFormat.IntheTimeIntervalValue dialogbox,youcanenterthenumericvalueasadate(offsetfromJan1,1970)ora timeinterval. String Registers Tomodifyastringregister,typeyourtextintheStringbox. NotethatwhenyouclickModifyforastringregisterthatistheconnectionstring foraLogAcquisitionmoduleorQuerymodule,theModifyDatabaseConnection Propertiesdialogboxappears:
Modifying Calendar Setup Registers

TheIONSchedulermodulehasaspecialclassofsetupregistercalledacalendar register.Configuringacalendarregisterisonlynecessaryfornodesthathavea Schedulermodule.Fordetailedinformationonhowtoconfigureacalendar register,seethedescriptionoftheSchedulermoduleintheIONReference.
Page 225
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.
Modifying an Address Setup Register 1. 2. RightclickonaDistributedNumeric,DistributedBooleanorDistributed Pulse.TheIONModuleSetupdialogboxappears. IntheSetupRegisterssection,selectaregisterthenclickModify.TheModify AddressRegisterdialogboxappears.
3. 4.
IntheModifyAddressRegisterdialogbox,doubleclickonthenode,manager, moduleandoutputregisteryouwanttouse.ClickOKtocontinue. IntheIONModuleSetupdialogbox,clickOK.
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.
Page 226
Parent Module and Shared Setup Registers

Setupregistersthataresurroundedbyasterisks(e.g.,**PM1PTSec**)indicate thatthemodulesharesitssetupregisterswithanother(parent)module.An exampleofthisistheHighSpeedPowerMeterorMeterUnitsPowerMeter module(HSPowerMeter,MUPowerMeter).Theysharetheirsetupregisters withtheparentPowerMetermodule. Ifyoutrytomodifyasharedsetupregister,apromptidentifiestheregisteras sharedandgivesthenameoftheparentmodule. Navigatetotheparentmoduleandchangethesetupregisterthere.
Using Custom Labels

Youcanassigncustomlabelstomodules,setupregisters,outputregisters,and BooleanON/OFFconditions.Allmodulesandregistershaveadefaultlabeland thislabeliswhatyouseeinnodediagrams,userdiagramsandeventlogsunless youspecifyacustomlabel. 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 a Module Label TheIONModuleSetupdialogboxallowsyoutoeditthemodulelabel.The modulelabelisthetextthatappearsacrossthetopofthemoduleiconinthenode diagram.Itisalsothelabelthatisusedineventlogsandinthedialogboxforthe IONtree. 1. IntheIONModuleSetupdialogbox,dooneofthefollowing: Tocreateacustomlabel,selectUseCustomLabelandthentypeanamefor thelabelinthebox. Tousethedefaultlabel,selectUseDefaultLabel. 2. ClickOKtoreturntothenodediagram.
Page 227
Customizing an Output Register Label Byprovidingacustomlabelforanoutputregister,youcanclearlyindicatethe informationthatregistercontains.Forexample,ifyouhavelinkedtheVlnaoutput registerofaPowerMetermoduletoaThermalDemandmodule,andinturn linkedtheThrmDemandoutputregistertoaMaximummodule,youmaywantto labeltheMaximummodulesoutputregisterasVaTDMaximum(insteadof usingthedefaultnameofMaximum1). 1. 2. IntheIONModuleSetupdialogbox,selecttheoutputregisterintheOutput RegistersboxandthenclickModify.TheModifyLabeldialogboxappears. Dooneofthefollowing: Tocreateacustomlabel,selectUseCustomLabelandthentypeanamefor thelabelinthebox. Tousethedefaultlabel,selectUseDefaultLabel. 3. ClickOKtoreturntotheIONModuleSetupdialogbox.
Customizing Boolean ON/OFF Labels IftheoutputregistersofthemoduleareBoolean,youcancreatecustomlabelsto associatewiththeONandOFFconditionsoftheseregisters.Theselabelscan clarifyexactlywhattheONorOFFconditionsrepresent.Forexample,ifaBoolean outputregisterisusedtoswitchafanonandoff,youcouldcreateaBooleanON labelcalledFanRunningandanOFFlabelcalledFanNotRunning. 1. 2. IntheIONModuleSetupdialogbox,selecttheBooleanoutputregisterand thenclickModify.TheModifyBooleanRegisterdialogboxappears. Dooneofthefollowing: Tocreatecustomlabels,selectUseCustomLabelsandthentypenamesfor theRegisterLabel,ONLabelandOFFLabelintheappropriateboxes. Tousethedefaultlabels,selectUseDefaultLabels. 3. ClickOKtoreturntotheIONModuleSetupdialogbox.
Customizing a Setup Register Label 1. 2. IntheIONModuleSetupdialogbox,selectthesetupregisterandclick Modify. Dooneofthefollowing: Tocreateacustomlabel,selectUseCustomLabelandthentypeanamefor thelabelinthebox. Tousethedefaultlabel,selectUseDefaultLabel. 3. ClickOKtoreturntotheIONModuleSetupdialogbox.
Resetting ION Modules in a Node Diagram

Designerallowsyoutoundocertainchangesyouhavemadeinanodediagram sincethelasttimeyousavedandsentyourchangestothenode.Itrefreshesthe selectedmoduleiconssotheyreflectwhatisactuallyonthenode.Reversible changesinclude:
Page 228
Changingthevalueofasetupregister. Changingmoduleorregisterlabels. Changingthelinksbetweenmodules.
NOTE
Since adding and deleting modules happens immediately on a node, you cannot undo the deletion or the creation of a module.
ToresetIONModules: 1. 2. Selectthemodule(s)youwanttoreset. SelectEdit>Reset.
Allthechangesmadetotheselectedmodulessincethelasttimeyousentand savedthenodediagramarediscarded.Modulesnotincludedintheselectionare unaffected(thatis,iftheyhadpendingchanges,thechangesarestillpending.)
Fast-linking ION Modules in the Log Inserter

WhenlinkingmodulesintheLogInserter,youcansavetimebyusingtheFast Linkerutility.TheFastLinkerautomatesmuchofthelinkingprocess,enabling youtoquicklylinkanycombinationofevent,dataorwaveformrecorders.To accesstheFastLinkeroptions,presstheCTRLkeyandclickontheLogInserter inputs. FormoreinformationonusingtheFastLinkerutility,refertothedescriptionfor theLogAcquisitionmoduleintheIONReference.
Page 229
Copying and Pasting ION Modules

Youcaneasilycreateanewfunctioninanodediagrambycopyingandpasting modules.Youcancopyandpasteasinglemodule,agroupofmodules,grouping icons,textobjects,ortheentirenode. Youcancopymodulesfromonenodeandpastethemintoanother,aslongasthe nodeyouarepastingtosupportstheselectedmodulesandhassufficient resources.Whenpastingmodules,youcanreplaceexistingmodulesoraddnew ones. Youcanalsocopymodulesandsavethemasaframework.Youandotherusers canthenreusethisframeworkinothernodes.Savinganodesconfigurationasa frameworkprovidesafastandeasywaytoprogramalargenumberofnodesat once.
NOTE
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
Designerofferstwowaystocreatecopiesofmodules:copyandpasteusingthe IONEnterpriseclipboardorcopyorpasteusingaframework.
NOTE
The ION Enterprise 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.
WhenyoucopyaselectionofIONmodules,youcanuseCopy,Cut,orCopyto Framework: Copysavestheselectiontotheclipboardandleavestheoriginalmodule(s) intact. Cutsavestheselectiontotheclipboardandremovestheoriginalmodule(s). Copytoframeworksavestheselectionasafileandleavestheoriginalmodules intact. Additionalconsiderationsincludepastingwithshortcuts,modulesthatcannotbe pasted,andcloninganode(copyingandpastingacompletenodeconfiguration fromonenodediagramtoanother).
Page 230
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. 2.
Selectthemodule(s)youwanttocutorcopy. Dooneofthefollowing: Tocuttheselectiontotheclipboardandremovetheoriginal,selectEdit> Cut. Tocopytheselectiontotheclipboardandretaintheoriginal,selectEdit> Copy. Designercopiestherequestedinformationtotheclipboard.
Aftertheselectionhasbeencopiedtotheclipboard,youcanselectEdit>Pasteto pasteitintoanyuserdiagram. Copying ION Modules to a Framework YoucanusetheCopytoframeworkcommandtocreateaframeworkfromthe selectedmodules.Aframeworkisatemplatethatyoucanusetoreproducea groupofmodules.Unlikeregularcopyingandpasting,aframeworkisstoredasa filesoyoucanpasteitlater. WhenyouselectEdit>Copytoframework,Designercopiesthelayout,linking andconfigurationinformationofeachmoduleintheselectedgroup.Itsavesthe frameworkasan.fwnfile.YoucanthenusethePastefromframeworkcommand topastethegroupinanothernodediagram. Youcanuseframeworkstosimplifytheprocessofprogrammingmultipledevices withsimilarconfigurations.Forexample,ifyouwantedtoprogramasingle functionintoseveralnodes,youcouldprogramthefirstnodeandthencopythe configurationtoaframework.Youcouldthenquicklyprogramtheothernodesby simplyopeningtheirnodediagramsandpastingtheframeworkyoucreated.You canalsouseframeworkstoprogramanentirenodeatonce,considerablyreducing theamountoftimerequiredtosetupalargeinstallation. Beforeyousaveagroupofmodulesasaframework,considercarefullywhich modulesyouwanttoinclude.Ifyouincludecoremodulesinyourframework,you willnotbeabletopastethemunlessyouoverwritetheexistingcoremodulesthat correspondtothoseinyourframework.Anotherapproachistoselectthemodules downstreamofthecoremoduleandsavethemasaframework.Thenwhenyou pastetheframeworkintoanothernodediagram,youcanusetheMaintain ExternalInputsoptiontopreserveyourlinkstotheoriginalcoremodules.(See UsingthePasteSummaryDialogBoxonpage 233formoreinformation.)
Page 231
NOTE
After 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. 2. 3. Selectthegroupofmoduleiconsyouwanttocopy. SelectEdit>CopytoFramework.TheCopytoFrameworkdialogboxappears. IntheFileNamebox,typeanamefortheframework,thenclickSave.The frameworkfilenameextension(.fwn)isaddedautomaticallyandtheselectionis savedasaframeworkfile.
Afteryouhavecopiedagrouptoaframework,youcanselectEdit>Pastefrom frameworktopasteitintoanodediagram.
Pasting ION Modules

Youcanpasteasavedcopyofoneormoremodulesintoanynodediagram. Designerofferstwowaystopastemodules: PasteinsertsaselectionthathasbeenplacedontheclipboardusingtheCutor Copycommand Pastefromframeworkinsertsaselectionthathasbeensavedasafile. Pastingmodulesisalittlemorecomplicatedthancopyingthem,becausetheaction ofaddingmodulestothenodemayrequireyoutoreplaceexistingmodules. WhetheryouchoosePasteorPastefromframework,DesignerdisplaysaPaste Summarydialogboxthatexplainseachaspectoftheproposedchanges. YoucanusethePasteSummaryboxtodefinehowtointegratethesourcemodules intothedestinationmodules.Forexample,ifasourcemoduleisbeingpastedtoa destinationthatisalreadyoccupied,youcaneitherlockpastethenewmodule overtheexistingoneorfreepastethenewmoduleintothenextavailable destination. Ifyoupasteaselectionthatcontainsashortcut,Designermaypastetheshortcutas amodule.(SeePastingShortcutsonpage 236formoreinformation.) Insomecases,Designermaynotpasteeverymoduleinyourselection.(See ModulesthatCannotbePastedonpage 237formoreinformation.) Pasting ION Modules from the Clipboard or a Framework Whenpastingmodules,thefirstthingtodoisselectthenodediagramand windowwhereyouwantthemodulestogo.Ifyouhavemorethanonewindow open,youcanclickonthetitlebarofthewindowyouwanttomakeittheactive window.
Page 232
NOTE
You can paste modules into the same node diagram they were copied from or into a different one.
Youcanpastemodulesfromtwosources:theclipboardoraframework.Whenyou pasteaselectionfromeithersource,Designerdescribestheproposedchangesin thePasteSummarydialogbox.YoucanusethePasteSummaryboxtoreviewyour changesandmakemodificationsasnecessary.
NOTE
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 Dialog Box on page 233 for more information.)
Pasting ION Modules into a Node Diagram 1. 2. Openthewindowwhereyouwantthemodulestogo.Clickinthebackground ofthewindowtoclearanyselectedmodules. Dooneofthefollowing: Topasteaselectionfromtheclipboard,selectEdit>Paste. Topasteaselectionfromaframework,selectEdit>PastefromFramework. InthePastefromFrameworkbox,selectthefileyouwantandthenclick Open. 3. ThePasteSummarydialogboxappears.UsethePasteSummaryboxtoreview theproposedchanges(seeUsingthePasteSummaryDialogBox,below,for moreinformation).Whenyouaresatisfiedwiththesummary,clickOKto completetheprocedure.
Theselectionispastedintotheactivewindow.Theentireselectionisautomatically selectedsoyoucaneasilymoveittoaclearareainthewindow.Allmoduleicons intheselectionappearsaspendinguntilyouclickSend&Savetosavethechanges tothenode.
Using the Paste Summary Dialog Box

BeforeDesignerpastesaselection,itdisplaysthePasteSummarydialogbox.Use thePasteSummarydialogboxtoreviewandmodifytheproposedchangestothe nodediagram. ThePasteSummarydialogboxlistseachmoduletobepastedandindicatesits destinationinthenode.Foreachmodule,thisboxprovidesashortsummaryofthe proposedmodificationaswellasamoredetaileddescriptionofhowthemodule ispastedorwhyitcannotbepastedasrequested.
Page 233
ThefollowingsectionsdescribethevariousareasofthePasteSummarydialogbox. Source TheSourcecolumnlistseachmodulethatwascopiedtotheclipboardor framework.Eachsourcemoduleislistedbyitsdefaultlabelunlessacustomlabel hasbeenspecified(inwhichcasethedefaultnameappearsinbracketsafterthe label).SelectamoduleinthiscolumntoviewadditionalinformationintheDetails boxatthebottomofthedialogbox. Destination TheDestinationcolumnindicateswherethecopyofeachsourcemodulewillbe placedinthenodediagram.ThemodulelabellistedintheDestinationcolumn mayormaynotmatchthemodulelabellistedintheSourcecolumn.(Ifthe destinationmoduleistobeoverwritten,itisreused;otherwise,thenextavailable moduleisused.) Summary TheSummarycolumnindicateswhetherthesourcemoduleiscopiedintothe destinationasanewmoduleorifitreplaces(overwrite)anexistingmodule.This columnalsoindicatesifamodulewillnotbepasted.
NOTE
You can sort the paste summary information alphabetically by source or destination, or by importance of summary. Click on the Source, Destination, or Summary column headers to sort the list by the chosen criteria.
Details TheDetailsboxlocatedatthebottomofthedialogboxprovidesmoredetailthan thedescriptionintheSummarycolumn.WhenyouclickonamoduleintheSource column,youcanviewadescriptionoftheproposedtransactionintheDetailsbox. Thisdescriptionexplainshowamoduleispastedoroffersreasonswhyitwillnot bepasted.
Page 234
TIP
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, then select Copy. You can then paste this selection into a word-processing program.
Maintain External Inputs TheMaintainExternalInputscheckboxallowsyoutopastethemoduleselection withallexternallinksintact.Ifthischeckboxiscleared,allexternallinks(linksto modulesoutsidetheselection)arediscarded. ThefollowingexampledepictsanexternallinktoaPowerMetermodule.

external link
IfyoucopiedthetwomodulesontherightbutomittedthePowerMetermodule fromtheselection,thelinktothePowerMetermodulewouldbeexternal.Upon pastingtheselection,theexternallinktothismodulewouldbelostunlessyou selectedMaintainexternalinputsonthePasteSummarybox. Check Boxes (Free Paste/Lock Paste/No Paste) Thecheckboxestotheleftofeachmoduleindicatetheproposedaction(thatis, howthemodulewillbepasted): Agreencheckmark indicatesafreepaste. indicatesalockpaste.
Acheckmarkwithalocksymbol AredXsymbol
indicatesthemodulewillnotbepasted. identifiesamodulethathasnopossible
AnXsymbolwithoutacheckbox destinationandcannotbepasted.
Youcanclickonacheckboxtochangetheproposedaction.Forexample,ifyou clickonafreepaste orawillnotbepasted symbol,itchangestoalock paste symbol.Whenyouchangethetypeofpaste,thedescriptionsinthe SummarycolumnandtheDetailsboxalsochangetodescribethenewaction.(See FreePasteorLockPaste?,below,formoreinformation.)
Free Paste or Lock Paste?

YoucanusethefreepasteandlockpasteoptionstoinstructDesignerhowto respondtopotentialconflicts.Forexample,ifyouwanttopastethemodule Setpoint1intoadiagramthatalreadyhasaSetpoint1module,youhavetwo options.Youcaneitheraddthenewmoduleunderanewname(forexample, Setpoint2)oryoucanoverwritetheexistingmodulewiththenewoneandreuse theoldname.
Page 235
Thefirstoptionintheaboveexampleisafreepaste.Itcanbeusedtopastenew modulesintoadiagramwithoutdeletinganyexistingmodules.Thisisusefulfor integratingnewfunctionsintoanodewithoutdisruptingthenodesexisting functionality.Althoughthismayseemdesirable,itisnotalwaysthebestoption. Byleavingexistingmodulesintact,afreepastecanresultinneedlessduplication offunctions.Inaddition,somegroupsofmodulesareinterdependentandmay requirealockpastetooperatecorrectly. Thesecondoptionintheaboveexampleisalockpaste.ItinstructsDesignerto recreatethesourcemodulesexactly,evenifthisrequiresDesignertooverwrite existingmodulesinthediagram.Whenusedtoquicklyreplaceoldmoduleswith newones,lockpastingisanefficientalternativetothetimeconsumingprocessof deletingamodule,addinganewoneandthenconfiguringit. Youcanuseacombinationofbothfreepasteandlockpastewithinasinglepaste operation.
NOTE
You can pre-select modules for Designer to reuse when free pasting. In the actual diagram where you paste the selection, press the SHIFT key 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 do not exist after the replacement module is pasted.
Pasting Shortcuts
Identifiedbythesymbol ,ashortcuticonisarepresentationofamoduleicon thatislocatedinanotherwindow. Youcancopyashortcutinthesamewayyoucopytheoriginalmodule,butwhen youpasteashortcut,oneoftwothingshappens:Itiseitherpastedasashortcutto anexistingmodule(ifoneisavailable)orasanewmodule.Ineithercase,it continuestoperformitsfunctionasbefore. Thereisabasicreasonforreplacingashortcutwithamodule:ashortcutcannot existinanodewithoutthemoduleitrepresents.Whenyoupasteaselection containingashortcut,Designersearchesboththeselectiontobepastedandthe destinationtolocatethemoduletheshortcutrepresents.Ifitfindsthemodule,it pastestheshortcutasashortcut.Ifitdoesntfindthemodule,itreplacesthe shortcutwithacopyofthemodule.Inthisway,Designerensuresthatthepasted selectioniscompleteandnotdependentonamodulethatisunavailableinthe destinationnode. Designerperformsthisprocessautomatically;itrequiresnoinputfromyou.
Page 236
Modules that Cannot be Pasted

Somemodulescannotbepastedbecausetheirsettingsarenontransferable betweennodes.AllFactory,Communications,andDiagnosticsmodulesmustbe individuallyconfiguredforeachnode. WhenpastingaselectionthatcontainsaFactory,CommunicationsorDiagnostics module,Designerpastesthelocationoftheiconsonly.
Cloning a Node
Youcanquicklyconfiguremultiplenodesbycloninganode.Essentially,cloning anodeinvolvescopyinganodescompleteconfigurationtoaframeworkthen pastingitontoanothernode.Thiseffectivelyreprogramsthenodereceivingthe frameworkasanexactcopyoftheoriginal.
NOTE
When you paste an entire node's configuration, the Factory, Communications, and Diagnostics modules are not 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. 2. 3. 4. Openthenodediagramofthenodeyouwanttocopy.Ensurethatyouarein themainorrootwindowofthediagram. SelectEdit>SelectAll.Allcoremodules,standardmodules,grouping windowsandtexticonsareselected. SelectEdit>Copytoframework.TheCopytoframeworkdialogboxappears. IntheFilenamebox,typeanamefortheframeworkandthenclickSave.The frameworkfilenameextension(.fwn)isaddedautomaticallyandthecomplete nodeconfigurationissavedinthisframeworkfile.
Afteryouhavesavedthesourcenodesconfigurationasaframework,youcan pasteittoothernodesofthesametype.Thisfilecanalsoserveasabackupincase youwanttorestoretheconfigurationofthesourcenode. Pasting a Node's Complete Configuration into Another Node 1. 2. Openthenodediagramofthenodetowhichyouwanttopastethe configuration.Ensurethatyouareinthemainorrootwindowofthediagram. SelectEdit>SelectAll.PresstheDeletekeytoremovethenodesexisting configuration.Adialogboxappearslistingthestandardmodulesthatwillbe deletedandthecoremodulesthatcannotbedeleted.ClickOKtocontinue. Thestandardmodulesandtexticonsaredeleted,andthecoremodules(andany groupingwindowscontainingcoremodules)remain. 3. SelectEdit>SelectAlltoselecttheremainingmodule(andgrouping)icons.
Page 237
4.
SelectEdit>Pastefromframework.InthePastefromframeworkdialogbox, selecttheframeworkfilethatcontainsthenodeconfigurationyouwanttopaste andthenclickOpen. ThePasteSummarydialogboxappears.(SeeUsingthePasteSummaryDialog Boxonpage 233forinformationonusingthePasteSummarybox.)
5. 6. 7.
Selectallmodulesinthelist(clicklastitem,holdtheSHIFTkey,andthenclick firstlistitemtheentirelistappearshighlighted). Changethepastetypetolockpaste(holdtheSHIFTkeyandthenclickthepaste typecheckboxuntilallmodulesaresettolockpaste ). ClickOKtocompletetheprocedure.
Theselectedframeworkispastedintothenodediagram.Allmoduleiconsinthe selectionappearaspendinguntilyouselectSend&Savetosavethechangesto thenode.
Page 238
Viewing Output Registers, Setup Registers, and Inputs
Viewing Output Registers, Setup Registers, and Inputs

Eachmoduleiconhasaninputsymbolandanoutputsymbol.Theinputsymbol (ontheleft)providesaccesstothemodulesinputsandtheoutputsymbol(onthe right)providesaccesstothemodulesoutputandsetupregisters.
Input
Output
Aregisterisatypeofmemorybankthatstoresamoduleslinkingand configurationinformation.Eachmoduleusestwotypesofregisters: Outputregistersstoredatathathasbeenprocessedbythemodule(suchas numericvalues,eventlogentries,andwaveformdata). Setupregistersstorethemodulesconfigurationinformation. Bothtypesofregistersserveasstoragelocationsforthemodule.
Viewing Output Register Information

Outputregisterinformationincludesthemodulesavailableoutputregisters,the realtimevaluesoftheoutputregistersandtheownersoftheoutputregisters. Eachofthesecanbeaccessedfromtheoutputsymbollocatedontherightsideof themoduleicon.
Viewing Available Output Registers Clicktheoutputsymbol. Viewing the Real-time Values of Output Registers PresstheSHIFTkeyandclicktheoutputsymbol. Viewing the Owners of Output Registers Rightclicktheoutputsymbol.Thisdisplaysanoutputregistersownerssoyou canidentifyalldependentmodulesonthenodeanddeterminethepurposeofeach dependentmodule.Thisisusefulwhendeterminingtheeffectsandconsequences ofdeletingamodule.
Page 239
Viewing Setup Register Information
Viewing Setup Register Information

Amodulessetupregisterscontainitsconfigurationinformation.Whenamodule processesdata,itmanipulatesthedataaccordingtotheguidelinesstoredinits setupregisters.Setupregisterinformationincludesthemodulesavailablesetup registers,thesetupregistersettings,andthesetupregisterowners.Eachofthese canbeaccessedfromtheoutputsymbollocatedontherightsideofthemodule icon.
Viewing Setup Registers PresstheCTRLkeyandclicktheoutputsymbolorrightclickthegraphicinthe centerofthemoduletodisplaytheIONModuleSetupdialogbox. Viewing Setup Register Settings PressCTRL+SHIFTandclicktheoutputsymbolorrightclickthegraphicinthe centerofthemoduletodisplaytheIONModuleSetupdialogbox. Viewing Setup Register Owners PresstheCTRLkeyandrightclicktheoutputsymbol.
Viewing Input Information

Inputinformationincludesthemodulesinputsandasampleofitsrealtimeinput values.Eachofthesecanbeaccessedfromthemodulesinputsymbol.
Viewing Inputs Clicktheinputsymbol. Viewing Real-time Input Values PresstheSHIFTkeyandclicktheinputsymbol.
Page 240
Time of Use (TOU) Program Management
Time of Use (TOU) Program Management

Tariffschedules,orTimeofUseprograms,areeasilycreated.Afteryouhave createdatariffschedule,youcanmanagethesefilesusingtheTOUProgram Manager. Creating a Time of Use Schedule 1. 2. InDesigner,selectOptions>EditTOUPrograms. ClickMakeaNewTOUProgram. ANewProgramappearsintheleftwindowofthedisplay.Clickonthisto renameit. 3. 4. ClickEdit(LaunchProgramEditor). FollowtheinstructionsonscreenandclickFinishwhenyouaredoneandClose.
Downloading a Time of Use Schedule into an ION meter 1. 2. StartDesignerandconnecttoyourmeter. FromtheFactoryConfigurationscreen(rootwindowofthenodediagram), rightclicktheSampleTOUmoduleunderTimeOfUseSetup.TheION ModuleSetupdialogboxappears. ClicktheQuickTOUbutton. SelecttheTOUscheduleyouwantandclickOK.
3. 4.
Advanced TOU Schedule Configuration

TheTOUprogrameditorprovidesanadvancedmodethatletsyoumake configurationssupportedbythemeterbutthatarenotprovidedintheTOUEditor describedabove.TheadvancedTOUisusefulinthefollowingcases: WhenTOUseasonsdonotuseafixedstartorenddatethatisthesameinevery calendaryear. Alternatedaysdefinedasaspecificdateandarenotaparticulardayofthe week. Accessing Advanced TOU Mode 1. 2. InDesigner,selectOptions>EditTOUPrograms.SelectaTOUProgramor createanewoneandclickEdit(LaunchProgramEditor). HoldtheCTRLkeyandrightclickonthetextintheSeasonssectionofthe SeasonsandRateDefinitionsscreen. Adialogappearsthatletsyouaddasetupregisteroverrideordeleteormodify anexistingsetupregisteroverride.
Page 241
3.
Toaddanewsetupregisteroverride,clickAdd.
4.
Selectasetupregisterfromthedropdownlistthentypeintheregistervalue (availableregistersare:Seasons1,2,3,and4,andAlt1,and2Days).
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 DeletethenOK. Tomodifyaregister,selectitfromthelistandclickModify.Makeyour changesandclickOK.
Page 242
5. 6.
ClickOKtoreturntotheTOUProgramEditor. ClicktheSummarytabintheTOUProgramEditor.Thiscompilestheschedule toincludethesetupregisteroverridesyoujustdefined. TheDeviceSetupRegisterValuessectionofthesummarydisplaystheregister valuesthatwillbesenttothemeterandincludestheconfiguredvalues.The TOUProgramLogOutputsectionofthesummarydisplaystheloggenerated whiletheTOUscheduleiscompiled.Anysetupregisteroverridesthatare definedappearasentriesinthislogfile.
Page 243
Virtual Processor Service
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,usingDesigner.RefertotheIONReferencefor informationonIONmodules.
Configuring the Virtual Processor with Designer

UseDesignertoperformallVirtualProcessorconfiguration,includingadding newmodules,configuringmodulesetupregisters,andlinkingmoduleinputsand outputregisterstoothermodules.
Creating a Second Virtual Processor

CreateasecondIONVirtualProcessorServiceandstartitusingthefollowing steps: 1. 2. 3. Openacommandpromptwindow. RegistertheVirtualProcessorasaservicefromtheIONEnterprise\system\bin folderbytyping:vip.exeServiceN<customVirtualProcessorname> OpenControlPanel>AdministrativeTools>Servicesandstartthenew registeredVirtualProcessor.
Page 244
Distributed Control
Viewing Virtual Processor Data with Vista

AfteryouhaveusedDesignertoaddandlinkmodulesintheVirtualProcessor, youcancreateauserdiagraminVistaandlinkittothemodulesintheVirtual Processor.Youcanthenuseyouruserdiagramtodisplaysystemdata,monitor alarms,andcontrolbasicfunctionsinyourVirtualProcessorframework. Configuring the Virtual Processor to Interact with the Desktop 1. 2. 3. 4. 5. OpenControlPanel>AdministrativeTools>Services. RightclicktheIONVirtualProcessorServiceandselectProperties. SelecttheLogOntab. SelecttheAllowservicetointeractwithdesktopcheckboxandclickOK. StopandrestarttheIONVirtualProcessorService.
Distributed Control
VirtualProcessorDistributedControlmodulesareameansoftransferring informationbetweenthedifferentdevicesinyournetwork.Thesemodulescanbe usedtobuildframeworksforcontrolprocessessuchasalarmannunciation,plant widedemandcontrol,powerfactorcontrol,loadshedding,paging,andgenerator switching. BeforeyoudecidetouseaVirtualProcessortoimplementacontrolsystem,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 variousIONmodulesandtheirfunctions.RefertotheIONReferencefordetailson DistributedControlandothermodules.
Distributed Control Modules

TheVirtualProcessorusesfourmodulestoimplementDistributedControl frameworks.ThreetypesofDistributedControlmodules(DistributedBoolean, Numeric,andPulsemodules)receivedatafromdevicesorotherVirtual Processorswithinyournetworkandtransferthisdatatothenodeaddress specifiedinthemodulessetupregisters.TheDataMonitoringmoduleisusedas ameansofdisablingacontrolmodule,ifthedataatthesourceinput(whichisused tomakethecontroldecision)becomesstale.
Page 245
Distributed Control
Distributed Control Module Setup Registers AllDistributedControlmodules(DistributedBoolean,DistributedNumeric,and DistributedPulsemodules)haveaSourceinputandanActivateinput.TheActivate inputmustbelinkedtoanothermodule,anditmustbeonforaDistributed Controlmoduletofunction.ThesemodulesalsocontainaDestinationsetup registerthatspecifiesthenodereceivingthedata. Distributed Boolean Module AllDistributedBooleanmoduleshaveoneinputthatmustlinkedtoanExternal Booleanoutputregister.WheneverthisregistersBooleanvaluechangesstate,the newvalueissenttothenodedefinedintheDestinationsetupregister. Distributed Numeric Module ADistributedNumericmodulesinputmustbelinkedtoanExternalNumeric module.ThisinputsvalueissenttothenodespecifiedintheDestinationsetup register.Thismodulehastwoadditionalsetupregistersthatareusedtodetermine whenandhowoftennewdataissenttotheDestinationnode. 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 need to provide a device password in Management Console for these applications to use. See Accessing Meters with Advanced Security on page 38 for information on configuring Advanced Security.
Distributed Control Network Performance

ItisimportanttomaximizethespeedatwhichtheVirtualProcessorreceivesthe datausedtomakecontroldecisions.TheperformanceofaVirtualProcessorusing DistributedControlissensitivetofactorssuchasnetworktraffic,theVirtual Processorsglobalparameters,andtheworkstationsCPUusage. Thefollowingsectionsprovidesomeguidelinesforimprovingadistributed controlnetworksperformance.
Page 246
Distributed Control
System Configuration Minimizethenumberofdevicespersiteforsitesincludingdevicesusedfor distributedcontrol. Minimizethenumberofapplications(suchasVistadiagrams)thatare requestingdatafromthecontrolsite. DecreasetheVirtualProcessorsClientPollingPeriod. Maximizethesitesbaudrate. CPU Performance DedicateasingleVirtualProcessorforcontrolpurposes;anadditionalVirtual Processorcanberunforlesscriticalfunctions. DonotrunCPUintensivefunctionsonthesameworkstationasyourdistributed controlVirtualProcessor.
Distributed Control Applications

TheVirtualProcessorsDistributedControlframeworkscanperformvarious controlprocesses;twoexamplesarepresentedbelow.Ensurethatyouarefamiliar withthesectionsabovebeforeusinganyofthesemoduleframeworksinacontrol system. Example: Passing a Value Between Devices ThefollowingexampleshowshowthenumericoutputoftheIntegratormodules inmeterAissenttoanExternalNumericmoduleinmeterB.
Virtual Processor Meter A

Integrator Module Output Distributed Numeric Module Source Activate Destination: ION meter B
Meter B
External Numeric Output Module
Data Monitor Module Source
Status
NotethattheDistributedNumericmoduleisdisablediftheDataMonitormodule detectsacommunicationproblembetweenthemeterAandtheVirtual Processor(e.g.,timeoutsorslownetworkconnections).Thishelpstoensurethat controlactionsareonlyperformedbasedonuptodatedata.
Page 247
Modbus Communications
Example: Device Control Thisexampleframeworkmonitorstotalharmonicdistortion(THD),whichcould causeapieceofequipment(likeapowertransformer)tooverheat.Whenasetpoint isreached,thesystemsendsanetworkmessagetoaworkstationandturnsona fan.
Meter
Harmonics Analyzer Module Setpoint Module Source Status
Virtual Processor
Distributed Boolean Module Source Activate Data Monitor Module Status Trigger Source Destination: ION meter, External Boolean module, Switch register
Total HD
External Boolean Module
State
Digital Output Module #1 Source
State
Launching Module Digital Outputs Fan Switch Launch
RunCommand = net send Workstation1 Current THD is high! Signal to turn on cooling fan has been sent
ModiconModbusRTUisanindustrystandardcommunicationsprotocolusedin controlandpowermonitoringindustries.ThedevicesinaModbusnetworkhave aMaster/Slaverelationshipwithcommunicationtransactionsoccurringbetween theMasterandoneormanyslaves(upto247slavedevicescanexistinonesite). TheVirtualProcessorcanactasaModbusSlavebyrespondingtorequestsfroma ModbusMasterandprovidingitwithpowermonitoringsystemdata.
Providing Data for a Modbus Master

ThefollowingdiagramillustrateshowtheVirtualProcessorcanmakevaluesin IONmoduleregistersavailabletoaModbusMasterdevice.AssumetheModbus SlavemodulessourceinputsarelinkedtonumericorBooleanoutputregisters fromotherIONmodules.Inthisexample,thevaluesobtainedfromthoseregisters areconvertedtotheproperModbusformat(accordingtohowtheModbusSlave modulessetupregistersareconfigured).TheModbusSlavemodulerespondstoa readrequestfromtheremoteModbusMasterdeviceandsendstheModbusdata tothespecifiedModbusregisters(again,accordingtohowtheModbusSlave modulessetupregistersareconfigured).
Page 248
Virtual Processor
1. Read request by remote Modbus Master.
READ Modbus Slave Module

Source 1 Source 2 Modbus Value 1 Modbus Value 2
Remote Modbus Device

Modbus Register Map
. . .
Source 16
Modbus Value 32 Modbus Base Modbus Link Event
2. Requested data is sent from the Slave Module to the specific Modbus registers.
The Virtual Processor's Modbus Slave Module

AstandardModbusSlavemodulecantakeupto16IONregistervaluesandmake themavailabletoaModbusmaster.IntheVirtualProcessor,theModbusSlave modulecanalsobeusedtobringModbusdataintoyourpowermonitoringsystem (itpermitsaModbusmastertopushdataintotheVirtualProcessor).
NOTE
Refer to the ION Reference for more information on the Modbus Slave module.
WhenaModbusSlavemoduleintheVirtualProcessorhasnolinkstoitsinputs, theoutputregistersofthemoduleshowthecontentsoftheModbusregistermap. Currently,onlytheModbusSlavemodulesintheVirtualProcessorhavethis additionalcapability(theModbusSlavemodulesinIONmeterscannotdothis). UsetheModbusSlavemoduletobringModbusdataintoyourpowermonitoring systemasfollows: 1. 2. 3. StarttheVirtualProcessorandopenitinDesigner. DragaModbusSlavemodulefromthetoolbox. LeavetheinputsoftheModbusSlavemoduleunlinked.TheModbusSlave modulewillnotreadtheModbusregistermapifanyofitsinputsarelinked(the moduleprovidesthelinkeddatatotheModbusregistermap). ConfiguretheModbusSlavemodulessetupregisters. TheModbusSlavemodulereadstheregistermapstartingattheaddress specifiedinBaseAddrsetupregisteruntileachoutputregisterisfilled. IftheFormatsetupregisterisa 16bitformat,16bitdataisputintoeachoftheModValoutputregisters. 32bitformat,twopiecesof16bitdataarecombinedintoone32bitModVal outputregister. PackedBoolean,thenthedataisputintotheModVal1outputregisterin PackedBooleanform. IgnoretheScaling,InZero,InFull,andOutZero,OutFullsetupregisters;there isnoscalingappliedtoanyoftheModbusregistermapvalues. 5. LinktheoutputsoftheModbusSlavemoduletotheinputsofothermodulesin theVirtualProcessor.
4.
Page 249
Common Virtual Processor Applications
Threeexamplesofmodulestolinktoare: DataRecordermodulesfordatalogging SetpointandRelativeSetpointmodulesforalarming DistributedNumericmoduleforredistributiontoIONmeters(for automatedplantwidedemandorpowerfactorcontrol)

TheVirtualProcessorcanbeusedtocreatenumerousanalysis,recording,and controlfunctions.ThissectiondescribesthreecommonVirtualProcessor applications: EventDrivenReportGenerationusingReporter DataAggregation LoggingDatafromMeters Theexamplesshownonthefollowingpagesassumethatyouunderstandthe functionsandoptionsofthevariousmodulesused.RefertotheIONReferencefor moduledetails.SeetheprevioussectionsforcommonModbusandDistributed Controlapplications.
Page 250
Example: Event Driven Report Generation using Reporter

TheVirtualProcessorcanbeusedinconjunctionwithadeviceandtheLog Insertertogeneratereportsinresponsetosystemevents.Inthefollowingexample, aPowerQualityreportisautomaticallygeneratedintheeventofasystem disturbance.
Meter Log Inserter
Log Acquisition Module Transient Module
V1 V2 V3 V Nom Trans Max Trans Dur
Data Recorder Module

Data Log 1 Source 1 Source 2
Source
Log Monitor Module

Source
Records Processed
Virtual Processor
Arithmetic Module
Source Formula: IF(S1-P1(1)>0,1,0)
Result
Setpoint Module
Source High Limit: 0 Low Limit: 1 Eval Mode: Greater Than
Trigger
One-Shot Timer Module

Start Duration: 300 sec
Trigger
Launching Module
Launch RunCommand: %PML_ROOT1%\bin\Repgen.exe -r Power_Quality
Astransientsoftenoccuringroups,thefiveminutedelaysetupwiththeOneShot 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.
Page 251
Setting Global Parameters
Example: Data Aggregation

Inthefollowingexample,metersmonitoraveragecurrentvalues(Iavg).Every dayataspecifiedtime(determinedbythePeriodicTimermodule),theData RecorderModulestoresthemaximumaveragecurrentvalueforeachmeter.
Meter A
Power Meter Module
l avg
Virtual Processor
Maximum Module
Source Reset
Maximum
Maximum Module
Maximum
Meter B
Power Meter Module
l avg
Source Reset
Source
Maximum Module
Maximum
Meter C
Power Meter Module
l avg
One-Shot Timer Module Start
Reset Trigger
Data Recorder Module External Control Module

Switch 1 Source 1 Source 2 Source 3 Enable Record
Rec Log
Periodic Timer Module
Trigger
Example: Logging Data from Meters

TheVirtualProcessorcanbeusedtologdatafrommetersthatdonothaveData Recorders.Inthefollowingexample,thetotalkWhfromametersIntegrator moduleisrecordedevery15minutesbyaVirtualProcessorsDataRecorder module.
Meter
Power Meter Module
kW tot
Virtual Processor
Integrator Module
Integrand kW tot
Data Recorder Module

Source Record
Data Log
Periodic Timer Module Period: 900 sec
Trigger

TheVirtualProcessorglobaloperatingparametersandModbusnetworksetupare configuredusingVirtualProcessorSetup. Theglobalparametersdonotneedtobechangedfornormaloperation.The VirtualProcessoroperatesproperlyinmostapplicationswiththedefaultsettings. SeeModifyingtheGlobalParametersonpage 79fordetails.
Page 252
TosetuptheVirtualProcessorsModbusnetwork,seeConfiguringtheVirtual ProcessorsModbusServiceonpage 75.
NOTE
The ION 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 ION Virtual Processor Service can be restarted, like any other service, using the Services window found via the Control Panel service applet.
Page 253
Page 254
Database Manager
DatabaseManagerhelpsyoumaintaintheinformationcontainedinyour databasesthroughperiodicbackupsandarchives.
In This Section
DatabaseManagerInterfaceonpage 256 CommonDatabaseManagementProceduresonpage 258 ManualTasksonpage 260 ScheduledJobsonpage 267 OptimizingDatabaseQueryTimeonpage 273 LogInserteronpage 274 AccessingtheIONDatabasewith3rdPartyApplicationsonpage 275
Page 255
Database Manager Interface

UseDatabaseManagertomanuallyperformmaintenanceoperationsontheION Enterprisedatabasesortoconfigurescheduledtaskstoperformtheseoperations. ToaccessDatabaseManager: StartManagementConsolethenclickTools > DatabaseManager,or OpentheIONEnterpriseToolsfolderonthedesktopanddoubleclickthe DatabaseManagericon. ExpandtheitemsinthenavigationtreetodisplaytheDatabasesandScheduled Jobsitemsforeachinstance.
SQL Instance Databases Scheduled Jobs
SQL Server Instance

ThedefaultSQLServerinstancethatIONEnterpriseusesforitsdatabasesis namedCOMPUTERNAME\ION,whereCOMPUTERNAMEisthenameofthe serverwherethedatabaseresides.
Databases
UsetheDatabasessectionofthetreetoviewinformationaboutthedatabasesor toperformmanualtasks. Forinformationonthemanualtasksyoucanperform,seeManualTaskson page 260.
Page 256
Viewing Database Properties Toviewthepropertiesofaparticulardatabase,rightclickonthatdatabaseand selectProperties.Thepropertieslistedare: Size:Thecurrentsizeofthedatabase. PrimaryFileLocation:Thefilepathfortheprimarydatabase(.mdf)file. TransactionLogLocation:Thefilepathforthetransactionlog(.ldf)file. CreationDate:Thedateandtimewhenthedatabasewascreated. LastBackupDate:Thedatewhenthelastbackupwasperformed. DiskSpaceAvailable:Theamountoffreespaceavailableonthediskwherethe databaseresides. ServerVersion:ThetypeandversionoftheSQLServerinstancethatishosting thedatabase.
Scheduled Jobs
UsetheScheduledJobssectionofthetreetoconfigurescheduledtasksorview informationaboutthescheduledtasks. Formoreinformationonscheduledtasks,seeScheduledJobsonpage 267.
Show Archives
Selectthischeckbox(lowerlefthandcorner)ifyouwanttheDatabaseslistto includeallarchiveddatabasesalongwiththelivedatabases.AfterShowArchives isselected,youhavetheoptiontoperformanyofthetasksavailableforthelive IONdatabasesonyourarchiveddatabases(archive,backup,restore,detach, attach,andtrim,dependingonthetypeofdatabase). CleartheShowArchivescheckboxtohidethearchiveddatabasesfromviewand topreventthetasksmentionedabovebeingperformedondatabasearchives.
Page 257
Common Database Management Procedures
Common Database Management Procedures

Thefollowingsectionsoutlinecommonproceduresthatyoucanperformusingthe manualtasks.Formoredetailsonindividualmanualtasks,seeManualTaskson page 260.
Detaching then Re-attaching Databases

Thefollowingprocedureexplainshowtodetachaconnecteddatabaseandthenre attachanewdatabaseinitsplace. Detaching and re-attaching a database 1. 2. 3. StopallIONEnterpriseservicesthatarerunning. RightclickDatabasesthenselectDetach.TheDetachDatabasedialogbox appears. Selectthedatabaseyouwanttodetach.ClickCleartoensurethereareno connectionstothedatabase.IntheDetachoptionssection,selectwhetheror notyouwanttoupdatestatisticspriortodetach.ClickOK. RightclickDatabasesthenselectAttach.TheAttachDatabasedialogbox appears. Clickthebrowsebutton andnavigatetothedatabaseyouwanttoattach. EdittheAttachasfieldorleavethedefaultname.ClickOK. RestartIONEnterpriseservices.
4. 5. 6.
Attaching a Database Using Database Manager

IfyouattachadatabasetotheIONEnterprisesystemviaDatabaseManager,you mustkeepallIONEnterpriseservicesrunning.ThisdiffersfromtheDetach/ AttachproceduredescribedinDetachingthenReattachingDatabases,above. Attaching a Database Using Database Manager 1. 2. 3. RightclickDatabasesthenselectAttach.TheAttachDatabasedialogbox appears. Clickthebrowsebutton andnavigatetothedatabaseyouwanttoattach. EdittheAttachasfieldorleavethedefaultname. ClickOK.
Page 258
Restoring an ION Database from a Backup
Restoring an ION Database from a Backup

Torecoveradatabaseafterafullbackup,replacethelostorcorrupteddatabase withthebackupdatabasefile.
Restoring a Database Using Database Manager

1. 2. 3. StopallIONEnterpriseservices. RightclickDatabasesthenselectRestore.TheRestoreDatabasedialogbox appears. SelecttheappropriatedatabasetorestorefromthelistintheSelectthebackup torestoresection.Toseethepropertiesoftheselecteddatabase,click Properties. ClickCleartoensuretherearenoconnectionstothedatabase. EdittheRestoreddatabasenamefieldorselectfromthedropdownlist. IntheDatabasefilelocationfield,clickthebrowsebutton thelocationwhereyouwanttostoretherestoreddatabase. RestartIONEnterpriseservices. andnavigateto
4. 5. 6. 7.
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 259
Manual Tasks
Manual Tasks
Thefollowingsectionsprovideinformationonthemanualtasksthatcanbeused tomanageyourdatabases. Toperformamanualtask,dooneofthefollowing: RightclickDatabasesandselectthetaskfromthepopupmenu,or Rightclickthedatabaseonwhichyouwanttoperformthetaskandselectthe taskfromthepopupmenu. WhenyourightclickonDatabasestoselectatask,ataskdialogboxappears.You canselectthedatabaseonwhichyouwanttoperformthetask.Ifthetaskcanonly beperformedononedatabase,thedatabaseispreselected. Whenyourightclickonadatabase,onlythetasksthatapplytothatdatabase appearinthepopupmenuandthedatabaseispreselectedinthetaskdialogbox.
Alarm Configuration
RightclickDatabasesandselectAlarmConfigurationtodisplaytheAlarm Configurationdialogbox.
Select Events to Monitor DatabaseSize:Thissectionletsyouenableordisablelocalalarmsthatmonitor thesizeoftheION_DataandION_SystemLogdatabases.Youcanalsosetthe sizethresholdthattheION_DataortheION_SystemLogdatabasemustexceed beforeyoureceiveanalarmnotification.TheION_Networkdatabaseisnot monitored.
Page 260
Archive
HardDriveSpace:Thissectionletsyouenableordisablethealarmthat monitorsyourharddrive(s).Youcanmonitorallharddrivesorjustthehard drivesthatcontaintheIONEnterprisedatabases.Youcanalsoadjustthe thresholdfortheminimumamountofspaceremainingbeforeyoureceivean alarmnotification. Configure Alarming Method ThissectionletsyouspecifythenameoftheSMTPserveraswellastheemail addressesoftherecipientsyouwanttosendalarmnotificationsto.
Archive
Usethistasktocreateanarchiveoftheselecteddatabase.
NOTE
The Database to archive list only shows your live ION_Data database unless Show Archives is selected.
1.
RightclickonDatabasesorION_DataandselectArchivetodisplaythe DatabaseArchivedialogbox.Ifnecessary,selectthedatabasethatyouwant toarchive. Clickthebrowsebutton toselectalocationtosavethearchiveto.
2.
Thedirectory...\IONEnterprise\config\cfg\Archives\Dataisthedefault locationwherethearchiveissaved,butyoucanspecifyanotherlocaldirectory (youcanonlysaveanarchivetodirectoryonthelocalmachine,nottoalocation onthenetwork). 3. Typeanameforthearchive. Afteryouselectthelocation,thearchiveisgivenadefaultfilename,butyoucan renamethearchivetofollowyourconventions. 4. 5. Selectthedatatypesyouwanttoarchive. Specifythedaterangeofthedatathatyouwanttoarchive.FortheStartDate, selectThebeginningofthedatabaseorselectDateandenteradateand time.EnteradateandtimefortheEndDate. Selectwhetherornotyouwanttotrimthedatabaseafterthearchive. Whenyouselectastartdateforthearchiveprocedureinsteadofusingthe beginningofthedatabase,theoptiontotrimthelivedatabaseisdisabled,even ifyouselectedthetrimoptionbeforeyousetthedaterange. 7. ClickOK.
6.
TheProgressfielddisplaysthecurrentprogressofthearchivetask.Ifamanual archivefails,amessageappearsandtheDatabaseArchivedialogremainsopen withtheOKbuttongrayedoutyoucanexaminetheProgressfieldtodiscover wherethetaskfailed.Ifthearchiveissuccessful,thedialogboxcloses automatically.
Page 261
Attach
Attach
Usethistasktoreattachadetacheddatabase. 1. 2. 3. 4. 5. StopallIONEnterpriseservices. RightclickDatabasesthenselectAttach.TheAttachDatabasedialogbox appears. Clickthebrowsebutton tonavigatetothedatabasethatyouwanttoattach. SpecifyanameintheAttachasfield. ClickOK. RestartIONEnterpriseservices.
Backup
UsethistasktocreatecompletebackupsfortheION_Data,ION_Network,and ION_SystemLogdatabases. 1. RightclickonDatabases,ION_DataorION_NetworkandselectBackup. TheBackupDatabasedialogboxappears.Ifnecessary,selectthedatabasethat youwanttobackup. IfyouhaveShowArchivesselected,youcanalsobackupyourarchives. 2. Clickthebrowsebutton backup. tospecifyalocationtowhichyouwanttosavethe
Backupsarestoredinthedirectory...\config\cfg\DBBackups\Data\by default.Youcansavethebackuptoyourlocalcomputerortoyournetwork usingaUniversalNamingConvention(UNC)pathoramappeddrive. 3. 4. TypeadescriptionintheDescriptionofbackuptextfield,ifyouwantto provideinformationaboutthenatureofthemanualbackup. ClickOK.
Defragment
RightclickonDatabasesandselectDefragmenttodisplaytheDefragment Databasedialogbox.SelectthedatabaseyouwanttodefragmentandclickOK. YoucandefragmenttheION_Data,ION_Network,orION_SystemLogdatabase. Thesedatabasesaredefragmentedaspartofthescheduledmaintenanceif10%or moreofthedatabaseisfragmented.SeeScheduledJobsonpage 267formore information.
Detach
ThistaskletsyoudetachadatabasefromSQLServersothattheexistingdatabase filescanbecopied,allowingtheoptiontoreattachalternateordefaultcopiesof thesefilesifnecessary.
Page 262
Export Registry Setting
Todetachadatabase: 1. 2. StopallIONEnterpriseservices. RightclickonDatabases,ION_Data,ION_NetworkorION_SystemLogand selectDetach.TheDetachDatabasedialogboxappears.Ifnecessary,selectthe databasethatyouwanttodetach. ClickCleartoclearanyexistingconnectionstothedatabase.IntheDetach optionssection,selectwhetherornotyouwanttoupdatestatisticspriorto detach. ClickOKtodetachthedatabase. RestartIONEnterpriseservices.
3.
4. 5.
NOTE
Do not move the ION_Network or ION_SystemLog databases unless absolutely necessary.
Export Registry Setting

Thistaskletsyouexportsettingstoaregistry(.reg)file.Thistaskisusefulifyou needtosetupIONEnterpriseclientsinasystemwheretheprimaryION Enterpriseserversdatabasesettings(serverinstancename,databasename,or password)arecustomized.Afteryouexportthesettingstotheregistry(.reg)file, youcanrunthatregistryfileontheclientmachine. 1. 2. RightclickonDatabasesandselectExportRegistrySetting.TheDatabase RegistryKeyExportdialogboxappears. Typethepathandfilenameforthefileorclickthebrowsebutton thelocationtowhichyouwanttosavethedatabaseregistrykey. tospecify
Thedirectory...\IONEnterprise\config\cfg\isthedefaultsavelocationforthe exporteddatabaseregistrykey. 3. ClickOK.
Modify Login
UsethistasktochangethepasswordfortheSQLServerinstanceusedfortheION Enterprisedatabases. 1. 2. 3. 4. StopallIONEnterpriseservices. RightclickDatabasesthenselectModifyLogin.TheModifyLogindialogbox appears. TypeyourpasswordinthePasswordfield(thismustbeaSQLadministrative password).ClickOK. FromtheLoginNamedropdownlist,selecttheinstanceforwhichyouwantto modifythelogin.TypethenewpasswordintheNewPasswordandConfirm NewPasswordfields.ClickOK. RestartIONEnterpriseservices.
5.
Page 263
New ION Databases
New ION Databases

Usethistasktocreateanew,blankversionoftheION_Datadatabase. 1. 2. RightclickonDatabasesandselectNewIONDatabases.TheNewHistorical IONEnterpriseDatabasedialogboxappears. Typeanameforyournewdatabase.
NOTE
Do not name it ION_Data as this is the default name for the existing ION database.
3. 4.
Clickthebrowsebutton ClickOK.
tospecifyalocationforthedatabase.
Restore
RightclickonDatabases,ION_DataorION_NetworkandselectRestoreto displaytheRestoreDatabasedialogbox. Dependingonthedatabaseyouarerestoring,thisprocedurereplacestheexisting ION_Networkdatabase,ION_SystemLogdatabase,orION_Datadatabasewith thedatabasefromtheappropriatebackupfile.Bydefault,thesebackupfilesare locatedinthedirectory...\IONEnterprise\config\cfg\DBBackups\.
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.
TheRestoreDatabasedialogboxhasthefollowingsectionsandfields: Selectthebackuptorestore:Thissectionofthedialogboxliststheavailable databasebackups.Clickonabackuptoselectit.Theselecteddatabasebackup hasanarrownexttoitinthelist. ClickPropertiestodisplaythename,size,startdate,finishdate,location,and descriptionoftheselectedbackup. Restoreddatabasename:Selectortypeanamefortherestoreddatabase. Databasefilelocation:Selectthelocationwhereyouwanttosavetherestored database.
Page 264
SQL Editor
SQL Editor
RightclickonDatabasesandselectSQLEditortodisplaytheSQLEditordialog box.
CAUTION
When you select this task, the following warning appears: Any alterations made using the SQL Query Editor may be irreversible. Click OK to continue or Cancel to cancel. The SQL Editor is intended only for advanced users who have a solid understanding of SQL and ION Enterprise databases changes made through the SQL Editor are, in some cases, irreversible.
TheSQLEditortaskisincludedwithinDatabaseManagerforanumberofreasons: TheSQLEditorletsyouexportdatabaseinformationfortroubleshooting purposes. WiththeSQLEditor,youcanwritecustomqueriesthatletyouviewwhatever datayouwant. TheSQLEditorprovidesamethodforimplementingcustomchangestothe databases.Forexample,thisallowsyoutoexecuteacustomSQLscript providedbySchneiderElectric.
NOTE
Ensure that you select the appropriate database before you execute your SQL statement.
Trim
Usethistasktoremovedatafromadatabase.IfShowArchivesisselected,youcan alsoperformatrimonarchiveddatabases.
CAUTION
Trimming data from the database is permanent. It is recommended that you backup or archive data before trimming.
Page 265
Update Statistics
1. 2. 3.
RightclickonDatabases,ION_DataorION_SystemLogandselectTrim.The TrimDatabasedialogboxappears. SelectthedatabaseyouwanttotrimfromtheDatabasetotrimlist. IntheTrimRangesection,specifythedaterangeofdatayouwanttotrim(for theION_Datadatabase)orsetthemaximumdataageindays(forthe ION_SystemLogdatabase). FortheION_Datadatabase(oranarchive),selectthedatatypesyouwanttotrim (DataRecords,Waveforms,Events)intheDataTypessection.Youcanselectany combinationofdatatypestotrim. ClickOK.Awarningappearstonotifyyouthattheselecteddatawillbe permanentlyremoved.ClickYestocontinueorNotocancel.
4.
5.
Update Statistics
RightclickonDatabasesandselectUpdateStatisticstodisplaytheUpdate Statisticsdialogbox. Statisticsonnumbersofrowsandrangesofkeyvaluesinthedataprovidedcanbe usedbySQLServertodeterminethemostefficientwaytoaccessthebasetables, thusimprovingtheperformanceofdistributedqueries.UpdateStatistics recalculatesthesevaluesforbetterperformance. Toupdatestatistics,selectthedatabaseyouwanttoupdateandclickOK.
Upgrade Database
RightclickonDatabasesandselectUpgradeDatabasestodisplaytheION DatabaseUpgradedialogbox. Thistaskupgradestheselecteddatabasewiththelatestdatabaseschema. TheIONEnterpriseinstallerautomaticallyupgradesyourdatabaseswiththenew databaseschemaswhenyouinstallIONEnterpriseonanexistingIONEnterprise server.IfyouinstallthelatestversionofIONEnterpriseonadifferentserverso thatyoucanmanuallycopyolderdatabasefilestothenewcomputer,youcanrun thistaskontheolderdatabases(i.e.,theION_Data,ION_SystemLog,and ION_Networkdatabases,andarchives)toupgradethemwiththenewschema. Toupgradeadatabase,selectthedatabaseyouwanttoupgradeandclickOK.
Page 266
Scheduled Jobs
Scheduled Jobs
DatabaseManagerhasanumberofpreconfiguredscheduledtasks,mostofwhich areconfigurableandenabledbydefault.Seethefollowingtablefordetails:
Database
Scheduled Task
Enabled by Default?
No Yes Yes Yes Yes Yes Yes
Default Time
12:00 am, 1st Saturday of every third month or of every quarter (depending on the version of SQL Server ION Enterprise is using) 12:00 am, Friday 2:00 am, daily 1:00 am, daily 7:30 am, daily 1:30 am, daily 7:05 am, daily
Configurable
Archive ION database (ION_Data) Backup Maintenance Network Configuration database (ION_Network) System Events database (ION_SystemLog) Backup Maintenance Trim Maintenance
Yes Yes No Yes No Yes No
Viewing Schedule Information Toviewscheduleinformation: Foralldatabases,rightclickonScheduledJobsandselectSchedule Information,or Foraspecificdatabase,rightclickonthedatabaseforwhichyouwanttoview informationandselectScheduleInformation. TheScheduledJobswindowappears.Thiswindowliststhefollowinginformation forscheduledjobs:databasename,jobtype,whetherornotthejobisenabled,the lastrundateandthenextrundate. Editing Scheduled Tasks Toeditascheduledtask: DoubleclickascheduledtaskintheScheduledJobswindow, Rightclickonadatabaseandselectthetaskyouwanttoedit,or RightclickonScheduledJobsandselectthetaskyouwanttoedit. Thescheduledtasksdialogboxappears.SeeScheduledArchiveonpage 268, ScheduledTrimonpage 270andScheduledBackuponpage 271for informationoneditingthesescheduledtasks.
NOTE
You cannot configure scheduled Maintenance tasks.
Page 267
Scheduled Archive
Viewing History for a Scheduled Task Toviewthehistoryofascheduledtask,rightclickadatabase,selectJobHistory thenselectthetaskforwhichyouwanttoviewthehistory.TheScheduledJob Historywindowappears.
Therundate,status(successorfailed),anddurationareavailableforallscheduled tasks. SelectataskfromthelisttoviewfurtherinformationintheErrorsormessages fromselectedtasksteptextfield. SelectShowonlyfailedtaskstofilteroutcompletedtasksfromthelist. ClickClearAlltoclearthejobhistoryfortheselectedscheduledtask.
Scheduled Archive
RightclickScheduledJobsorION_DataandselectArchivetodisplaythe Scheduledarchivedialogbox.
NOTE
When ION Enterprise is first installed, Scheduled Archive is disabled by default. You must open the Scheduled archive dialog box and select the Schedule Enabled check box to enable it.
Page 268
Scheduled Archive
You must select this check box to enable the scheduled archive.
Data Types Ascheduledarchiveispreconfiguredtoarchivealldatatypesandtotrimeachof thedatatypesafterthearchiveiscomplete.CleartheTrimafterarchivecheckbox foradatatypeifyouonlywanttoperformanarchivewithoutsubsequently deletingthatdata.
CAUTION
Trimming data permanently removes it from the database. Trimming without archiving is not recommended for data records.
Amount of Live Data Thissettingdeterminesthenumberofcompletemonthsoflivedatathatyouwant tokeepintheION_Datadatabase. Archive Interval ForSQLServer2005Express,clickSelectMonths,thenspecifythemonthsfor whichyouwantthearchivetooccur. ForSQLServer2005(StandardEdition),selectoneofthefollowingoptions: Monthly,Bimonthly(every2months),Quarterly,Semiannually,Annually,Every 2years,Every3years,Every4years,andEvery5years.
NOTE
The Database Manager scheduled jobs use the 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.
Page 269
Scheduled Maintenance
Schedule Youcanselectanydayoftheweekforyourscheduledarchive(thedefaultis Saturday).Thearchiveisperformedatthespecifiedtimeonthefirstoccurrenceof thatdayinthemonth.Forexample,ifyouconfigurethescheduledarchivetooccur monthlyonSundayat5:30:00AM,thenDatabaseManagerarchivestheION_Data databaseat5:30AMonthefirstSundayofeverymonth.
Scheduled Maintenance
Thescheduleforthemaintenancetasksispreconfiguredandcannotbechanged. Toviewthehistoryforamaintenancetask,rightclickthedatabase,selectJob History>Maintenance.SeeViewingHistoryforaScheduledTaskonpage 268 formoreinformation. Thereareanumberoftasksthatareperformedonthedatabasewhena maintenancejobisexecuted.Thefollowingisanorderedbreakdownofa scheduledmaintenance: 1. 2. 3. 4. Checkdatabasefragmentationanddefragmentifthefragmentationlevelis morethan10%. Updatestatisticsforallthetablesinthedatabase. Checkandtrackthedatabasesize. Sendanemailalertifanymaintenancestepfails.
Themaintenancescheduleforeachdatabaseisasfollows: ION_Datamaintenancejoboccursdailyat2:00AM. ION_SystemLogmaintenancejoboccursdailyat7:05AM. ION_Networkmaintenancejoboccursdailyat7:30AM. (Notethatthediskusagemonitorstartsat7:00AMandtakesonlyafewseconds tocomplete.)
Scheduled Trim
RightclickScheduledJobsorION_SystemLogandselectTrimtodisplaythe ScheduledTrimdialogbox. EnsurethatScheduleenabledisselectedifyouwanttoenablethescheduledtrim. TheSystemEventsdatabasehasthescheduledtrimtaskconfiguredandenabled bydefault. Changing the Schedule ClicktheChangebuttonintheSchedulesection.TheEditScheduledialogbox appearswhereyoucanreconfigurethefrequencyandtimeofthescheduledtrim. TheEditScheduledialogboxdiffersdependingonwhatyouselectintheOccurs section.
Page 270
Scheduled Backup
Daily:Setthefrequencyindays.Forexample,tosetthetrimtooccurevery sevendays,setthefrequencyto7. Weekly:Setthefrequencyinweeksandselectthedaysoftheweekonwhich youwantthetrimtooccur.Youcanselectmultipledaysoftheweek.For example,tosetthetrimtooccureverytwoweeksonMondayandThursday,set thefrequencyto2andselectMondayandThursdayfromthelistofdays. Monthly:SetthefrequencythenselectFixedDayorRelativeDaytosettheday ofthemonthonwhichthetrimoccurs. Frequency:DependingonyourversionofSQLServer,clickSelectMonths toselectthemonthsinwhichyouwantthetrimtooccurorsetthe Frequencyinnumberofmonths. FixedDay:Thetrimoccursonthespecifieddateatthefrequencyspecified (inmonths).Forexample,tosetthetrimtooccuronthe15thdayofevery month,selecteverymonth(orsetFrequencyto1)thensetFixedDayto15. RelativeDay:Thetrimoccursonthespecifieddayofthemonthatthe specifiedfrequency(inmonths).Forexample,tosetthetrimtooccuronthe secondSundayofeverythirdmonth,setFrequencyto3(orselectwhich monthsyouwanttotrimtooccurin)andselect2ndandSundayfromthe Relativedaydropdownlists.
Scheduled Backup
RightclickScheduledJobs,ION_DataorION_NetworkandselectBackupto displaytheScheduledBackupdialogbox. BoththeION_DataandtheION_Networkdatabaseshavescheduledbackuptasks configuredandenabledbydefault.Thesavelocationisadifferentfolderforeach database,althoughbothdatabasessharethesameparentdirectory:\ION Enterprise\config\cfg\DBBackups\. FromtheDatabasetobackuplist,selectthedatabaseforwhichyouwantto configurethescheduledbackup. IntheSavebackuptofield,enterthelocationwhereyouwanttosavethe backups. IntheNumberofbackupstokeepsection,specifythenumberofbackups1 to4thatDatabaseManagerkeepsavailable. EnsurethatScheduleenabledisselectedifyouwanttoenablethescheduled backup. Changing the Schedule ClicktheChangebuttonintheSchedulesection.TheEditScheduledialog appearswhereyoucanreconfigurethefrequencyandtimeofthescheduled backup.
NOTE
Do not schedule scheduled backups to begin at the same time (i.e., do not schedule a backup of the ION_Data and a backup of the ION_Network at the same time). This can cause problems with the task.
Page 271
Scheduled Backup
TheEditScheduledialogboxdiffersdependingonwhatyouselectintheOccurs section. Daily:Setthefrequencyindays.Forexample,tosetthebackuptooccurevery sevendays,setthefrequencyto7. Weekly:Setthefrequencyinweeksandselectthedaysoftheweekonwhich youwantthebackuptooccur.Youcanselectmultipledaysoftheweek.For example,tosetthebackuptooccureverytwoweeksonMondayandThursday, setthefrequencyto2andselectMondayandThursdayfromthelistofdays. Monthly:SetthefrequencythenselectFixedDayorRelativeDaytosettheday ofthemonthonwhichthetrimoccurs. Frequency:DependingonyourversionofSQLServer,clickSelectMonths toselectthemonthsinwhichyouwantthebackuptooccurorsetthe Frequencyinnumberofmonths. FixedDay:Thebackupoccursonthespecifieddateatthefrequency specified(inmonths).Forexample,tosetthebackuptooccuronthe15th dayofeverymonth,selecteverymonth(orsetFrequencyto1)andFixed Dayto15. RelativeDay:Thebackupoccursonthespecifieddayofthemonthatthe specifiedfrequency(inmonths).Forexample,tosetthebackuptooccuron thesecondSundayofeverythirdmonth,setFrequencyto3(orselectwhich monthsyouwanttothebackuptooccurin)andselect2ndandSundayfrom theRelativedaydropdownlists.
Page 272
Optimizing Database Query Time
Optimizing Database Query Time

Therearestepsyoucantaketooptimizethedatabasequerytime: UseDatabaseManagertodefragmenttheappropriatedatabase. UseDatabaseManagertoUpdateStatisticsontheappropriatedatabase. RunonlyoneinstanceofSQLServer2005. RunSQLServer2005StandardEditioninsteadofSQLServer2005Express Edition.
NOTE
Instructions on how to perform the Defragment and Update Statistics operations can be found in the section Manual Tasks on page 260.
Limiting SQL Server Memory Usage

Bydefault,SQLServer2005StandardEditionandSQLServer2005ExpressEdition areconfiguredtodynamicallyadjusttheamountofmemoryusedbasedon demand. Undersomecircumstances,itispossibleforSQLServertouseupmemorytoa pointwheretheoverallsystemperformanceisaffected.Youcanadjusttheamount ofmemoryreservedbyusingaconfigurationtoolsuchasMicrosoftSQLServer ManagementStudio. Using SQL Server 2005 Management Studio to Limit Memory Usage 1. OntheObjectExplorerpane,rightclicktheSQLServerinstancethat correspondstotheIONEnterprisedatabase(i.e.,thedatabaseiconattheroot levelofthetreeview),thenselectProperties. IntheSelectapagesection,selectMemory. UsethecontrolsontheMemorypagetoadjustthememoryallocation. ClickOK.
2. 3. 4.
Page 273
Log Inserter
Log Inserter
TheLogInsertercomponentofIONEnterpriseautomaticallyconfiguresitselfto collectdatafromeveryavailablerecorderineverydeviceorIONEnterprise softwarecomponentandinputsthisdataintothedatabase.LogInserteris typicallyrunonlyonthePrimaryworkstation. MostsystemsuseonlyasingleLogInserterwhichisautomaticallyconfiguredto performallrequiredloggingfunctions.Thedefaultconfigurationwillworkfor mostsystems.Situationswherechangesmayberequiredincludesystemswith largenumbersofdeviceswithlogs,systemswithprimaryandsecondaryservers orcaseswhereonlyspecificdevicesand/orlogsneedtobemonitoredfornew records.Ifanyofthesesituationsapplytoyoursystem,contactTechnicalSupport formoreinformationontheoperationofLogInserter,itsdifferentmodesof operationandthefunctionsofitsinternalcomponents.
Page 274
Accessing the ION Database with 3rd-Party Applications

ThefollowingexampleusesMicrosoftExcel2007toretrievedatafromthe ION_Datadatabase.
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. 2. 3.
TocreateadatabasequeryinExcel,clickData>FromOtherSources>From MicrosoftQuery. Tocreateanewdatasource,select<NewDataSource>fromthelistandclick OK. Typethenameyouwanttogivethedatasource.Onceyoutypeaname,thelist ofdriversforthedatabasetypebecomesavailable.Select<SQLServer>fromthe list.ClickConnect. Chooseyourserverfromthelist.ProvideyourLoginIDandPasswordandclick OK.Selectadefaulttableforyourdatasource(optional).ClickOKtocontinue. SelectthesourcenameyoucreatedandclickOK. Afteryouhaveselectedthedatayouwanttoview,theQueryWizardappears. Usethistofilterandsortthedata. FollowthestepsintheQueryWizardtoadddatatotheSpreadsheet.
4. 5. 6. 7.
Page 275
Page 276
Modbus Device Importer

TheModbusDeviceImporterutilityenablesIONEnterprisesoftwaretorecognize andeasilyintegratethirdpartyModbusdevicesintotheIONEnterprisenetwork.
In This Section
Introductiononpage 278 IONObjectDescriptionsonpage 281 MainConsoleScreenonpage 283 MainToolbaronpage 284 EditingaRegisteronpage 291 RegisterPropertiesDefinedonpage 291 ShortcutKeysonpage 296 DataFormatsonpage 299 ConfiguringLoggingandCalculationonpage 301
Page 277
Introduction
Introduction
TheModbusDeviceImporterisatoolforadvancedusersthatcreatesthefilesand softwaresupportnecessarytodisplaydatafromanyModbusdeviceusingthe VistacomponentofIONEnterprise.TheModbusDeviceImporteruserinterface setsupusefulcommonModbusparametersbydefault,butalsoallowsyouto configureallModbusspecificanddevicerelatedparameters.TheModbusDevice Importeralsohasbuiltinerrorcheckingtovalidatethefilesyoucreated,orthose fromothersources.
Process Overview
CreatinganewModbusdevicetypeinvolvesthefollowingsteps: 1. 2. Identifythenewdevicetype(devicename,filename,etc.) CreateaModbusmapfileforthedevicetype: IdentifyaModbusregistertobeadded. FindanappropriateregistertomaptointheIONtree. Selectappropriatedataformat,scalingfactors,etc. 3. 4. 5. ConfigureadditionalModbusdevicefunctionality(ifrequired). Validateandcheckthedevicetype. AddthenewModbusdevicetypetotheION_Networkdatabase.
AfteritisdefinedintheION_Networkdatabase,thenewModbusdeviceis availableinIONEnterprisejustlikeanyotherdevice.SimplyselecttheModbus devicetypefromthedropdownlist.
Default Modbus Device Types

IONEnterpriseisshippedwithnumerouspreconfiguredModbusdevicetypes. Foracompletelist,navigatetoTools>ViewcurrentDeviceTypesfromthe ModbusDeviceImportermainconsole.Thesepreconfigureddevicetypescan alsobemodifiedasrequired,usingtheModbusDeviceImporter.
The ION Tree File

TheModbusDeviceImportercreatesandeditsIONtreefiles(.ion)forthedevice, whicharethensavedandenteredintotheION_Network,allowingIONEnterprise torecognizeandusethedevice.ThetreefiledefinestheorganizationoftheION managers,modulesandregisters.
The Modbus Map File

TheModbusDeviceImportercreatesandeditsmappingfilesforthedevice, linkingModbusregisterswithIONregisters.AModbusmapfileisanXMLfile thatmustrefertotheXMLschemadefinedin/.../config/translators/modbus schema.xml.
Page 278
Introduction
Italsodefineshowtoconvertthemoduleregistervalueintothevalueshownin theIONregister. Map File Format EachdistinctModbusdevicetypehasitsownspecialaddressrangesandrequires itsownModbusmapfile.Vlnavg,onanION6200,forexample,islocatedat40103. Itcouldbeinadifferentlocationonanyotherdevice.Ineithercase,itwouldbe mostlogicallymappedtothePowerMeterModulesVlnavgoutputregister (0x5803)inthedefaulttree. Theexamplemapfileshownbelowillustratesthemapfileformat: <?xmlversion=1.0encoding=UTF8?> <!CreatedbyModbusDeviceImporterv3.21.0at:3/22/200710:41:56AM> <ModbusMapxmlns=xschema:modbusschema.xml> <DeviceInfoType=ExampleDeviceMultiplePresetSupported=0 GlobalNotAvailable=NotSpecifiedMaxRequestRegisters=125 LowSpeedUpdateRate=30HighSpeedUpdateRate=5/> <ModbusInfoIONHandle=134217729Name=BaudRate ModbusAddress=40001RequestType=RWFormat=UINT16Scale=1 Offset=0Multiplier=1DefaultEnumValue=InvalidData> <EnumerationValue=300Baud/> <EnumerationValue=2400Baud/> <EnumerationValue=9600Baud/> <EnumerationValue=115200Baud/> </ModbusInfo> <ModbusInfoIONHandle=134217985Name=VoltsA@!!DeviceName!!Meter01 ModbusAddress=40002RequestType=RFormat=UINT16Scale=1Offset=0 Multiplier=1/> <ModbusInfoIONHandle=134217986Name=VoltsB@Meter01 ModbusAddress=40003RequestType=RFormat=UINT16Scale=1Offset=0 Multiplier=1/> <ModbusInfoIONHandle=134217987Name=VoltsC@Meter01 ModbusAddress=40004RequestType=RFormat=UINT16Scale=1Offset=0 Multiplier=1/> <CalcInfoIONHandle=135266304Name=Averaging1 Function=Averaging_Module/> <CalcInfoIONHandle=136314880Name=Minimum1 Function=Minimum_Module/>
Page 279
Introduction
<CalcInfoIONHandle=137363456Name=Maximum1 Function=Maximum_Module/> <CalcInfoIONHandle=138412032Name=DataRec1 Function=DataRecorder_Module/> <CalcInfoIONHandle=139460608Name=Feedback1 Function=Feedback_Module/> <CalcInfoIONHandle=140509184Name=PeriodicTmr1 Function=PeriodicTimer_Module/> <CalcInfoIONHandle=131072000Name=Diagnostics1 Function=Diagnostics_Module/> </ModbusMap>
Page 280
ION Object Descriptions
ION Object Descriptions

IONobjectsaresoftwareitemsthatarerecognizedbyIONEnterprisesoftware. IONobjectsconsistofdevicemanagers,modules,andregisters.Managers separatedifferentmoduletypesandgroupstogethermodulesofthesametype. Modulesgroupregistersintoconvenientorlogicalgroups.Registersarethe objectsthatactuallyholdtheModbusregisterinformation. FormoreinformationonIONarchitecture,refertotheIONReference.
Managers
ManagersorganizetheModbusmapfileintoaformattedstructure.Therearethree differenttypesofmanagerssupportedintheModbusDeviceImporter: ExternalBooleanManager:holdsBooleantyperegisters ExternalNumericManager:holdsNumerictyperegisters ExternalPulseManager:holdsPulsetyperegisters Youcancreateupto127managers.Afteryoucreateamanager,youcannotchange itsmanagertype.
Modules
Similartomanagers,modulesalsohelporganizethemapfilestructure.Youcan createupto4095modulesinsideagivenmanager.Usemodulestoarrange registersintologicalgroupingsorsimilarregistertypes.Whennamingamodule, chooseanamethatisrelevanttothetypeofregistersitcontains.Modulesinherit theclasstypeoftheirparentmanager,soyoucannotchangeamoduletypeafter ishasbeencreated.
Registers
AregisterisanobjectthatcanbelinkedtoaphysicalregisteronaModbusdevice, wheredataisreadfromorwrittento.YoucanmapregisterstoaModbusaddress, thenuseVistatoreadandwritedatatothisModbusdevice. Whenyoucreatearegister,itinheritsthetypeofitsparentmodule.Youcancreate upto255registerspermodule. Therearethreedifferentregistertypes: Boolean Registers BooleanregistersholdBooleandata,i.e.,alogicalTrueorFalse(1or0).Youcan attachalabeltotheregistertoindicateanONorOFFstate.Ifanumericregisteris mappedtoaBooleanregister,avalueof0(zero)putstheBooleanregisterinan OFFstate,whileanyothervalueturnstheBooleanregisterON(unlessamaskis applied).
Page 281
Registers
Ifanyofthebitsexposedbythemaskareset,thevalueisinterpretedasaTrue. OtherwiseitisinterpretedasFalse.MaskedBoolcanbeusedtosiftoutindividual BooleansthatarestoredasarraysofbitsinModbus.Ifnomaskisspecified,allbits arerelevant.Booleanregisterscanbe16or32bitslong. Numeric Registers Numericregistersholdnumericdata. Pulse Registers PulseregistersareusedinVistatosendapulsetothespecifiedaddress.Theyare usedspecificallytowritevaluestoadevice.Theusercanspecifytheexactvalueto sendoutasapulseforeachregister.Pulseregisterscanonlywrite16bitsworthof data. Factory Registers YoucannotaddorremoveFactoryobjectsbutyoucaneditthem.AllFactory registersareinitiallysettoadefaultconstantvalue.Youcanchangetheseconstant values,ormaptheregisterstoavalidModbusaddress(seeEditingaRegisteron page 291).Therearefouruserdefinedfactoryregistersthatyoucanchangeifthe requiredregistersarenotalreadypresentinthedefaultlist.
Page 282
Main Console Screen
Main Console Screen

ToopenModbusDeviceImporter,startManagementConsolethenselect Tools > System > ModbusDeviceImporter. Themainconsolescreenappears:
Configure Logging and Calculation button
ION Map Information Pane
Modbus Register Information Pane
ThemainconsoleiswheremostactionsareperformedandIONobjectsare managed.Thedevicemanagers,modules,andregistersaredisplayedintheION MapInformationPaneonthelefthandsideofthescreen.Informationspecificto registersisdisplayedontherighthandsideofthescreenintheModbusRegister InformationPane.Ifyouselectanobjectinthetree,allregistersbelowithavetheir informationdisplayed. Navigatethroughthetreeviewbyclickingonthespecificobjectsorbyusingthe arrowkeysonthekeyboard. WhentheapplicationisstartedortheFile>Newmenuisselected,adefault configurationisloaded.Theonlyobjectincludedinthedefaultconfigurationisthe factorymanagerandassociatedregisters.Bydefaultyoucannotspecificallysee thefactoryobjectssoablanktemplateisdisplayed.
Page 283
Main Toolbar
Main Toolbar
File Menu
SelectFileonthemaintoolbartoaccessthefollowingmenuitems: New:Createsanew,blankmapfile. Open:Opensanexistingmapfile. Save:SavesthecurrentmapfiletemplateandthecorrespondingIONtreefile template. SaveAs:Letsyousavethecurrentmaptemplatetoadifferentlocation. Exit:Closestheprogram. TheFilemenualsoliststhemostrecentlyopeneddevicetemplates.
Edit Menu
YoucanaddnewobjectsbyeitherrightclickingintheIONMapInformationpane orselectingtheappropriateoptionfromtheEditmenu. Objectsareplacedeitheraschildrenorsiblings.Forexample,youmayaddanew managertothedevice(siblingofanexistingmanager)oranewmoduletoan existingmanager(childofamanager).Thesamerelationshipappliestomodules andregisters. NewManager:Addsanewmanager. Adding a New Manager 1. 2. 3. ClickEdit>NewManager.TheAddNewManagerdialogboxappears. Typeanameforthemanager. Selectamanagertypefromthedropdownlist:ExternalBooleanManager, ExternalNumericManager,orExternalPulseManager.
NOTE
The manager type you choose determines parameters in the modules and registers under it.
4.
ClickOK.
Page 284
Edit Menu
NewModule:Addsanewmodule. Adding a New Module 1. 2. ClickEdit>NewModule.TheAddNewModuledialogboxappears. Typeanameforthemodule. Thedefaultisthenextavailablenumberofthatmoduletypewithinthecurrent manager(e.g.,ExtNum3).Thenameofthemoduledeterminesthedefault namesoftheregistersunderit.Notethatthemodulenamecanbechangedlater, ifrequired. 3. ClickOK.
NOTE
Duplicate names are permitted but not recommended.
NewRegister:Addsanewregister.SeeEditingaRegisteronpage 291for moreinformationonusingthisdialogbox. NewRegister(Quick):Addsanewregister,usingalldefaultsettings.Nodialog boxisassociatedwiththiscommandunlessnoregisterscurrentlyexistinthe targetmodule(inthatcase,itistreatedascreatinganewregisterwithadialog box). TheModbusaddressisautomaticallyincrementedasappropriatebasedonthe registertypeandsize. Copying and Pasting Objects Youcancopyandpastemodulesandregisters.Afteryoucopyanobject,youcan pasteitintoadifferentlocationinthetree.Youcannotpasteregistersormodules fromoneclasstypetoanother(i.e.,youcannotcopyaBooleanregisterandpaste itintoanumericmodule). Copy:Copiesyourselection(s)totheclipboard. Therearethreedifferentpasteoptions:Paste,PasteCloneandPasteMultiple. Paste:PastingregisterswillnormallyautomaticallyincrementstheModbus addressbasedontheregisterdatatype.InthecaseofMaskedBool,itincrements thebitmaskbyoneuntilitreaches0x8000,whentheModbusaddress incrementsbyoneandthemaskresetsto0x0001. ThenewregisterlabelisresettoadefaultlabelsuchasPowerMeter Module.0004. PasteClone:PastingaCloneisthesameaspastingnormallywiththeexception thattheModbusaddressoftheregisterisnotincreased.Thisisausefulfeature forpastingmultipleregisterswiththesameModbusaddressbutapplying differentmasks. ThenewregisterlabelisresettoadefaultlabelsuchasPowerMeter Module.0004.
Page 285
View Menu
PasteMultiple:Pastingmultiplecopiessimplyperformsanormalpastea determinednumberoftimes,eachcopyincrementingtheaddressthe appropriatenumberofaddresses. Moving Objects Youcanmovebothmodulesandregisters.Thisisdonebyselectingthedesired object(s)ineithertheIONMapInformationpaneorModbusRegisterInformation paneandthenholdingdowntheALTkey.Youcanmovethemoduleorregister toanyotherholdingobject,butitmustbemovedtothesamedatatype. Editing Objects ToeditobjectsintheModbusDeviceImporter,rightclickonthemandselect AdvancedProperties.SeeEditingaRegisteronpage 291formoreinformation. Deleting Selected <type of object> TodeleteobjectsintheModbusDeviceImporter,rightclickonthemandselect Deleteselected<typeofobject>.Ifyoudeleteanobject,allchildren(objects beneathit)arealsodeleted.Todeletemultipleregistersatonce,selecttheminthe ModbusRegisterInformationpaneandthenclickDeleteselectedRegisters. Advanced Properties SelectthismenuitemtoopentheDevicePropertiesdialogbox.Youcanalsoopen thisdialogboxusingView>DeviceProperties.Formoreinformationregarding deviceproperties,seeViewMenuonpage 286.
View Menu
ThefollowingmenuitemsareaccessedbyclickingViewonthemaintoolbar. Refresh:Refreshesthemainconsolescreen. CollapseAll:Collapsesthetreeview. DeviceProperties:ClickView>DeviceProperties(orrightclickonthetree viewrootandselectProperties).TheDevicePropertiesdialogboxappears: DevicePropertiesTab DeviceType:TypethenameoftheDeviceType. DefaultDiagramTemplateLabelfield:Thisisusedifthedevicehasa defaultVistadiagram.Thestringenteredinthisfieldisaninternalidentifier andisonlyusediftheAddGenerateNetworkDiagramSupportfeatureis used;seeToolsMenuonpage 287formoreinformation.
NOTE
Changes made here are not be reflected in ION Enterprise until you add or update the device type.
FactoryInformationTab
Page 286
Tools Menu
Thesefieldsareusedtoidentifythedevicetype.Bydefault,allvaluesare constantvalues,butyoucanmapthemtoModbusregistersifrequired. AdvancedTab Maximumnumberofregistersforasinglerequestsetting:Themaximum numberofregistersrequestedforthedevicecanbesetanywherefrom1to 125.Itisrecommendedthatyoudonotchangethissettingunlessthe specificdevicehasspecialrequirements. MultiplePresetWritecheckbox:Besurethatyoumatchthischeckbox withthedevicetype.Selectthecheckboxifthedevicetypesupports MultiplePresetWriteforregistersandcoils;clearthecheckboxifthedevice typeonlysupportsSinglePresetWrite. Disable1checkbox:ThisisaspecialfeatureforIONmeters.IONmeters returna1ifaspecifiedregisterisnotavailableandthesysteminterprets thatvalueasacontrolsignal.Mostdevicesusethevalueof1asavaliddata value,soitisrecommendedthatthisfeatureisturnedoffforallnonION meters. Requestedupdateperiodforanycalculatedregisterssetting:Entera number(inseconds)tospecifyhowoftenthephysicalModbusdeviceis polledtoupdatetheregistersusedforcalculations.
Tools Menu
SelecttheToolsmenuonthemaintoolbartoaccessthefollowingmenuitems: AddDeviceType:Afteryoucorrectlyconfigureandsaveadevice,youcanadd ittotheION_Networkdatabase. ByaddingadevicetotheION_Networkdatabase,youcannowcreatenew devicesofthedevicetypeinManagementConsole.Beforeyoucanaddthe devicetype,youmustgototheDevicePropertiesandconfigurethedevice(See ViewMenuonpage 286).
Page 287
Tools Menu
ToaddthedevicetypeclickTools>AddDeviceType.Afterthedevicetypeis added,anewscreenappearsthatshowsthedevicetypescurrentlyinthe ION_Networkdatabase(SeeViewCurrentDeviceTypes).Ensurethatthe devicetypeyouaddedispresentandtheconfigurationiscorrect. UpdateDeviceType:IfyouaddadevicetypetotheION_Networkdatabase butchangesweremadetothetemplate,thenyoucanupdatetheION_Network databasetoreflectthesechanges. Youarenotifiediftheupdateissuccessfulornot.Ifitfails,youmustremove anydevicesofthespecifieddevicetypefromManagementConsoleandthen updatetotheION_Networkdatabaseagain.
NOTE
The ION_Network database update may fail if the device type you are updating is currently being used in 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. Thisenablesalldeviceswhichareofthenewdevicetypetohavedefault diagramsinVistawhentheGenerateNetworkDiagramfeatureisutilized.It isrecommendedthatthedefaultVistadiagramiscreatedbeforerunningthis 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. Thisfeaturecreatesthenecessaryregistrykeysandsetuptherequired directorystructureforgeneratinganetworkdiagram.
Page 288
Tools Menu
NOTE
By default, the diagram is a blank diagram. You must modify this diagram to actually correspond to the specified device.
SaveIONHandleList:Thiscommandsavesalistoftheregistersalongwith theircorrespondingIONhandles.YoucanusethislisttocreateaVistadiagram withoutanactivedeviceconnected. ThelistissavedasatextfileinthecurrentModbusDeviceImporterinstallation folder.Thenameofthetextfileisintheformat<currentDeviceName>.csv. ValidateTemplate:Thiscommandletsyouvalidatethecurrentconfiguration. Doingthisperformsvariousvalidationandintegritytestsonthecurrent configurationoftheIONandModbusobjects.Itlistspotentialerrorssuchas registersthatsharethesameModbusregisteraddressorregistersthathave conflictingmasks.Theerrorchecksthatareperformedcanbetoggledonoroff, usingthecheckboxesinthedialogbox:generalissues,addressconflicts, handleconflicts,labelconflicts,andnameconflicts.
NOTE
You must manually fix any errors or else you cannot add or update the device type.
ViewcurrentDeviceTypes:Thiscommandallowsyoutoviewthedevicetypes currentlyintheION_Networkdatabase.
Fromhereyoucandeleteolddevicetypesthatarenotbeingused. Notethatyoumayseemultipleentriesforthesamephysicaldeviceinthe devicetypelistings(forexample,6200RTUand6200ModTCP).TheModbus DeviceImporterclassifieseachdifferentprotocolasaseparatedevicetype.
Page 289
Settings Menu
NOTE
You cannot delete a device type that is currently being used by Management Console.
Calculator:ThisloadsthedefaultWindowscalculator.
Settings Menu
SelectSettingsonthemaintoolbartoaccessthefollowingmenuitems: ChangeDefaultTemplatePath:Thedefaulttemplatepathisusedforloadinga newtemplate.Usethiscommandtochangethepathifrequired. EnableAutoValidation:Thisisselectedbydefault. StartApplicationMaximized:ThissetstheModbusDeviceImporterwindow toopeninamaximizedstate. ShowPropertiesWindowonDoubleClick:Allowsanobjectsproperty windowtoopeniftheobjectisdoubleclickedintheIONMapInformation pane. AutoSelectTextonEditinRegisterInformation:Allowsafieldthatisclicked onintheModbusRegisterInformationpanebefullyselectedwhentheedit screenopens.Thisisusefulifyouneedtochangetheentirefield. Advanced:Youcanaccesstwofeaturesfromthissubmenu: ShowFactoryObjects:MakesthefactoryobjectsvisibleintheIONMap Informationpane.Withthisfeatureenabled,youcaneditthepropertiesof theFactoryobjects. ShowModbusAddressesOffsetinHex:Withthisfeatureenabled,all ModbusaddressesintheModbusRegisterInformationpanearedisplayed inhexadecimalformat.
NOTE
If this setting is enabled, registers cannot be edited in the Modbus Register Information pane.
Help Menu
SelectHelponthemaintoolbartoaccessthefollowingmenuitems: About:Providesversioninformationfortheprogram. ModbusDeviceImporterHelp:OpenstheHelpfilefortheprogram.
Configure Logging and Calculation Button

ClickthisbuttontoentertheConfigureLoggingandCalculationutility.This screenallowsyoutoconfigureadvancedfunctionsforModbusdevices,suchas enablinglogging,andshouldonlybeusedbyadvancedusers.Seethe ConfiguringLoggingandCalculationonpage 301formoreinformation.
Page 290
Editing a Register
Editing a Register
Toeditaregister,rightclickontheregisterintheIONMapInformationpaneand selectAdvancedProperties.Thefollowingdialogboxdisplaystheregister information.Dependingonthetypeofregisterbeingedited,differentdatafields mayappear.
YoucanalsodoubleclicktheregisterintheModbusRegisterInformationpaneto editit.Thisisafasterwaytoeditbasicregisterproperties.WhentheEditModeis initiatedintheModbusRegisterInformationpane,theselectedregisteropensup intoaneditmode:
ToscrollthroughthelistinEditmode,usethePAGEUPandPAGEDOWNkeys. Aftereditingthevalues,pressENTERtosavethechanges.
NOTE
If you use the PAGE UP and PAGE DOWN keys, the changes made are saved as if ENTER was pressed.
Tocancelanychanges,presstheESCkey.
Register Properties Defined

Thefollowingregisterpropertiescanbeconfigured: Register Label Thelabelisadescriptionattachedtotheregister.Youcanchangethisvalueatany time;itisonlyanidentifierfortheregister.
Page 291
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 Ifthischeckboxiscleared,thentheIONregisterismappedtoaModbusregister and,whenviewingitinVista,youseetherealvaluesfromthemeter.Ifthischeck boxisselected,thenitissettoaconstantvalue.Youcanuseaconstantvalueto holddynamicconstantvalues,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 supporteddatatypeisexplainedinAdditionalInformationonpage 299. 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.
Page 292
Register Mask Thismaskisappliedtotherawdatareceivedfromtheregister.Themaskis appliedinanANDfashion. Forexample,ifthemask0x4isapplied,thentheregistervaluedisplayedisonly nonzeroifthe3rdleastsignificantbitintheregisterisa1. YoucanapplymaskstobothnumericandBooleandatatypes.Toapplycustom masks,scrolldownthelistandselectCustom.Whenprompted,enterthevaluein Decimal,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 and Register Multiplier Thisspecifieswhatthescalefactorofthedatabeingrequestedshouldbe.Thescale canbesettoanyconstantdecimalvaluewithintherangeof3.402823466E+38to 3.402823466E+38.Ifyoucanobtainthescaleforaspecificregisterfromthedevice, thenyoucanmapthescalevaluetoanotherregister.Youcanonlymapthescale factortoregistersalreadycreatedintheModbusDeviceImporter. ThemappedregisterusedcanbeavalidModbusmappedregisteroraregister withaconstantvalue.Mappingthescaletoaconstantregisterisaconvenient feature;youcanchangethescaleformanyregistersbychangingtheconstant valueinonelocation. Mapping the Scale Factor to Another Register 1. SelecttheReferenceanotherregisterforthescalecheckbox.TheSelect RegisterforReferencedialogboxappears.
2.
Usethedropdownliststonavigatetotherequiredregister.ClickOK. ThescaletobeusednowappearsintheRegisterScalefield.
Page 293
Register Offset Theregisteroffsetisusediftheregistervaluereturnedmustbeoffsetbyavalue. Thescalecanbesettoanyconstantdecimalvaluewithintherangeof3.402823466 E+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 multiplier
(1)
OR
ION value
(Modbus value - offset) * multiplier scale
(2)
Iftheoffsetforaspecificregistercanbeobtainedfromthedevicethenyoucanmap theoffsetvaluetoanotherregister.Youcanonlymaptheoffsetfactortoregisters alreadycreatedintheModbusDeviceImporter. ThemappedregisterusedcanbeavalidModbusmappedregisteroraregister withaconstantvalue. Mappingtheoffsettoaconstantregisterisaconvenientfeature;youcanchange theoffsetformanyregistersbychangingtheconstantvalueinonelocation. Mapping the Offset Factor to Another Register 1. 2. SelecttheReferenceanotherregisterforOffsetcheckbox. Usethedropdownmenustonavigatetotherequiredregister.ClickOK. TheoffsettobeusednowappearsintheRegisterOffsetfield. Register Not Available Value Iftheregisterhasacontrolsignalvaluetoindicatethattheregisteriscurrentlynot available,thenyoucansetthevaluehere.Thevaluemustmatchthedatathatis receivedfromtheregisteronthedevice.Ifavalueisreceivedthatmatchesthis propertyvalue,thestringNotAvailableisdisplayedwhenviewingtheregister inVista. Boolean Labels ThisoptionisonlyavailableforBooleanregisters.Itallowsyoutosetdefaultlabels forStatusObjectsinVista.
Page 294
Value to Send Out as a Pulse Thisoptionisonlyavailableforpulseregisters.Itallowsyoutospecifytheexact ModbusvaluesenttothedevicewhenapulseregisterisactivatedinVista. Constant String Value Aconstantformanipulatingdataretrievedfromthedevice. Number of Registers to Request ThisoptionisonlyavailableifthedatatypeissettoASCII,ASCIIReverseor PackedBCD.Itallowsyoutospecifythenumberofregisterstoretrievefromthe deviceonarequest. 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,usean enumeratedordinalof2through+2withenumeratedlabels0.01through100. Youcanaccessenumerationforaregisterfromtheregisterpropertieswindow,the EditModewindowandalsofromthetoolbar. Whenselected,thefollowingscreenappears:
Toaddorremoveenumerationvalues,selectthemandclickAddNeworRemove. Whennewenumerationsareadded,theyareappendedtothebottomofthelist andaregiventhenextsequentialordinalvalue.Youcanrelocatevaluesupand downwiththeupanddownarrowandbuttons. Tochangetheordinalvaluefortheenumerations,doubleclickintheOrdinal Valueslist.Thechangepropagatesdowntothebottomofthelist,ensuringthatthe listgoesfromsmallestnumbertolargestnumber.
Page 295
Shortcut Keys
Shortcut Keys
General Key Shortcuts
Keystrokes
CTRL-N CTRL-O CTRL-S CTRL-A CTRL-D CTRL-U CTRL-G CTRL-P F5 F6 F11 F12
Action
Opens a new template (after a save prompt). Opens an existing template (after a save prompt). Quick saves the current template. Saves the current template in a new location. Adds the device to the ION_Network database. Updates the device in the ION_Network database. Adds Network diagram support for the device to the system. Opens the device properties window. Refreshes the ION Map Information pane, collapsing all nodes except the currently selected node. Collapses all nodes in the tree-view. Saves the current ION Handle list. Views the current device types in the ION_Network database.
Register Quick Edit Mode

Keystrokes
TAB Enter Page Up Page Down Escape or MouseWheel Click Cycles through the data fields. Saves the changes to the current register and exits edit mode. Saves the changes to the current register and displays the edit mode for the register above the current register. Saves the changes to the current register and displays the edit mode for the register below the current register. Cancels the changes to the current register and exits edit mode.
Action
Page 296

Keystrokes
Right Arrow Left Arrow Up Arrow Down Arrow Mouse RightClick Enter, Space Bar or CTRL-X F1 F2 F3 F4 Insert
Action
Expands a node or selects a child if children are already expanded. Collapses a node or selects a parent node if no children are expanded. Scrolls up through the list of nodes. Scrolls down through the list of nodes. Brings up the pop-up edit menu. Opens the properties window for the selected object. If the root device type is selected, a new manager is created and the manager properties window is displayed. If a manager is selected, a new module is created and the module properties window is displayed. If a module is selected, a new register is created and the register properties window is displayed. If a module is selected, a new register is created but the register properties window is not displayed. - 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. - 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. - 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. - If a module is selected, then the module is copied. - If a register is selected, then the register is copied. - 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. If a module is selected and one or more registers have been copied, then the registers are clone pasted. If a module is selected and one or more registers have been copied, then a prompt comes up asking how many copies to paste.
Delete
ALT + dragging an object
CTRL-C
CTRL-V
CTRL-B CTRL-Z
Page 297

Keystrokes
Up Arrow Down Arrow Mouse RightClick Enter, Space Bar or CTRL-X Insert or F3 F4 Delete ALT + dragging one or more objects Insert
Action
Scrolls up through the list of registers. Scrolls down through the list of registers. Brings up the pop-up edit menu. Opens the quick edit window for the selected register. A new register is created in the module of the currently selected register and the register properties window is displayed. A new register is created in the module of the currently selected register but the register properties window is not displayed. A prompt is displayed asking to confirm the delete of the selected registers. The selected registers can be dragged and dropped over to a new module of similar class in the tree-view. 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. - 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. - 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. The selected registers are copied. The registers that have been copied are pasted into the current module. The registers that have been copied are clone pasted into the current module. The registers that have been copied are pasted multiple times into the current module. A prompt comes up asking how many copies to paste.
Delete
Holding ALT while dragging an object CTRL-C CTRL-V CTRL-B CTRL-Z
Page 298
Data Formats
Typically,ModbusdataistransmittedinbigENDIAN(bigendin)formatbut alternatesinwhichtheindividual16bitwordsareswappedarenotuncommon. TheformatssupportedbyIONEnterprise6.0are:
Format Type
SINT16 UINT16 SINT32 or S32-4321 UINT32 or U32-4321 S32-2143 U32-2143 S32-MFP or S32-M10k-4321 U32-MFP or U32-M10k-4321 S32-M10k-2143 U32-M10k-2143 S48-M10k-21-65 U48-M10k-21-65 S64-M10k-21-87 U64-M10k-21-87
Description
A 16-bit signed value in 2-1 (or big ENDIAN) format. The high order byte is first, the low-order byte second. A 16-bit unsigned value in 2-1 (or big ENDIAN) format. The high order byte is first, the low-order byte second. 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. 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. 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. 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. 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. 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 or mod-10K. 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. 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. 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 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 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 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 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. 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. 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.
S64-87-21
U64-87-21
S64-21-87
Page 299
Data Formats
Format Type
U64-21-87
Description
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. 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. 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. 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. A 16-bit value that is interpreted according to the bit pattern described by the Mask attribute. 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. A 16 bit unsigned value, range 0 to 3999, representing 3 decimal places of accuracy. 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 is encoded as 00001001 00000010.
S16-1-15 IEEEFloat or F32-4321 SwappedFloat or F32-2143
MaskedBool or PackedBool
PF-Nexus BCD (Binary Coded Decimal)
The following data types can have their length specified by the Number of Registers to Request setting. Packed BCD ASCII ASCII-Reverse 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 is encoded as 1001 0010. A sequence of bytes representing the ASCII character set. Each word stores two ASCII characters. Trailing spaces are removed. Same as ASCII except every second character is in the reverse order.
Page 300
Configuring Logging and Calculation
Configuring Logging and Calculation

UsetheConfigureLoggingandCalculationutilitytoperformadditionalModbus 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) do not appear on the Configure Logging and Calculation screen.
Screen Overview
ClicktheConfigureLoggingandCalculationbuttonfromthemainModbus DeviceImporterscreentoopentheapplication. Thefollowingscreenappears:
Select this check box 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
Page 301
Configuring Register Logging
AlltheregisterinformationfromthemainMDIscreenisprepopulatedinthis tablewhenyouopentheapplication. Showdownstreamdevicecolumns:Selectthistoshowallthecolumnsfor selectingandsettingthedownstreamdevicepropertiesforregisters. Perregisterarea:Usethisareatoindividuallyconfigureregisters. Lowarea:Usethisareatoenablecalculationandsetloggingoflowvalues. Higharea:Usethisareatoenablecalculationandsetloggingofhighvalues. Meanarea:Usethisareatoenablecalculationandsetloggingofmeanvalues. Globalregistereditarea:Usethebottomhalfofthescreentoeditindividual registersormultipleregisters,afterselectingtheminthelist. Helplink:ClickthislinktoopentheModbusDeviceImporteronlinehelp. Staledatalink(All):ClickthislinktoopentheConfigureStaleDataSettings dialog.
Filtering and sorting columns

SeeSortingDatainaColumnonpage 24andFilteringDatainaColumnon page 24forinstructionsonfilteringandsorting.
Configuring Register Logging

Toeditregistersonanindividualbasis,selecttherowoftheregisterandeditthe cellsintheroworusetheeditingtoolsintheGlobalarea. Toeditmorethanoneregister,selecttherowsyouwanttoconfiguresimilarlyand usetheeditingtoolsintheGlobalarea. Log:Selecttoenableloggingoftheregister. Interval:Thisvaluedeterminestheloggingfrequencyfortheregister.Notethat thisvaluealsocontrolstheresetintervalforthemin,maxandaveragingmodules, evenifthesecalculationsarenotbeinglogged.Thevalidrangeis1to4,000,000 seconds.
Page 302
Configuring Low, High and Mean Calculation and Logging
Configuring Low, High and Mean Calculation and Logging

ToeditthesuffixusedforLow,HighandMean,clickontheapplicablelink.For example,ifyouchangethesuffixtoMaximum,VoltsAHighbecomesVoltsA Maximum. 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

Thestalenessofdataismeasuredfromtimedatawaslastreadfromaphysical deviceuntilthecurrenttime. ClicktheAll(StaleData)linktoopentheConfigureStaleDataSettingsdialog box. Markdatastaleafter:Enterthetimeyouwanttoelapsebeforedatafromthis registerismarkedstaleinthedatarecorder.Thevalidrangeis0to7200seconds. Whendataisstale:Selecthowyouwantstaledatavalueslogged.Thesettinglog anemptyrowlogsanemptyrowinthedatarecorder,whileuselastknown valuelogsthelastnonstalevalueinthedatarecorderuntiltheendofthecurrent interval.
NOTE
Stale data settings are global (they apply to all registers).
Page 303
Configuring Downstream Device Functionality
Configuring Downstream Device Functionality

YoumustselecttheShowdownstreamdevicecolumnscheckboxbeforeyoucan editdownstreamdevicefunctionality. Thescreenappearsasfollows:
Select this check box to make the downstream device columns appear
Is Downstream Device
Downstream Device
Include Name of Device
IsDownstreamDevice:Selectthistoindicatetheregisterbelongstoa downstreamdevice. DownstreamDeviceName:Enterthenameofthedownstreamdeviceinthisfield. Theregisterlabelisappendedwiththisname.Forexample,ifthedevicenameis Meter01,theregisterlabelbecomesVoltsA@Meter01.
NOTE
Using this option without also using the Include Name of Device Instance option causes 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.
IncludeNameofDeviceInstance:Selectthistoappendtheactualdeviceinstance nametotheregisterlabel.Theplaceholder!!DeviceName!!isthenaddedtothe labelthenameoftheactualdeviceinstancegetsinsertedwhenitiscreatedin ManagementConsole.
Page 304
Saving and Exiting
Forexample,ifthedeviceinstanceisnamedDevice01: VoltsA@!!DeviceName!!Meter01 isreplacedwith VoltsA@Device01Meter01 ThisallowseasycreationofuniquenameswithinIONEnterprise,aswellas enablingeachdeviceinstancetoappearinIONEnterpriseasmultiplevirtual devices. Formoreinformationondownstreamdevicesandnamingconventions,see DownstreamDeviceAssistantonpage 313.
Saving and Exiting

ToexittheConfigureLoggingandCalculationscreen: ClickOKtosaveyoursettings. ClickCanceltoexitwithoutsaving. YouarereturnedtothemainModbusDeviceImporterconsolescreen. 1. 2. ClickFile>Savetosavethetemplatefiles. ClickTools>UpdateDeviceTypetosendthetemplatefilechangestothe ION_Networkdatabase.
Page 305
Saving and Exiting
Page 306
10
ION Alert Monitor

TheIONAlertMonitorreceivesandprocessesalarmnotificationscomingfrom modemconnectedmetersonremotepowermonitoringlocations.
In This Section
IONAlertMonitoronpage 308 HowItWorksonpage 308 SettingUptheIONAlertMonitoronpage 309 StartingtheIONAlertMonitoronpage 312
Page 307
ION Alert Monitor
ION Alert Monitor

IONAlertMonitorisaWindowsservice(IONAlertMonitor)thatreplacedthe AlarmServerprogramthatwasavailableinIONEnterprise5.5andearlier(the legacyalarmsrv.exeprogramisstillfunctionalandavailableinthe...\system\bin folder). AlertMonitorresidesontheIONEnterpriseworkstation,whereitreceivesand processesincomingalarmsfromaremoteIONmetersAlertmodule. WiththeimplementationoftheIONAlertMonitor,alarmnotificationisimproved andsimplified: SinceAlertMonitorrunsasaWindowsservice,auserisnolongerrequiredto logintoIONEnterpriseinordertostartmonitoringthesystemforalarm conditions. AlertMonitorcanhandleincomingcallsfrommultiplecommunicationsports. Whenalarmsarereceived,AlertMonitorusestheIONConnectionManagement Servicetoestablishamodemconnection,ratherthanusingthelegacycommand lineexecutableconman.exe. IONConnectionManagementServiceallowsyoutosetupspecificmodem connectionrequestproperties,suchasMinimum/MaximumConnectionTime, DisconnectonCaughtup,etc.ThesepropertiesaresetupintheAlertMonitors configurationfileseeSettingUptheIONAlertMonitoronpage 309.
NOTE
Alert Monitor does not support TAPI modem drivers for Windows (WinModems).
How It Works
TheIONAlertMonitorrespondstoalarmmessagesoriginatingfromtheAlert moduleinanIONmeter.Forexample,analarmmessageisinitiatedasaresultof apowerqualityevent: 1. AnalarmconditionpromptstheIONmodule(e.g.,Setpointmodule)tosend apulsesignaltotheTriggerinputoftheIONmetersAlertmodule.Referto thedescriptionoftheAlertModuleintheIONReferenceformoreinformation. TheAlertmoduleinitiatesmodemcommunication,andcallsthephonenumber specifiedintheAlertmodulesDestinationsetupregister. TheIONEnterpriseworkstationanswersthemodemcallfromtheIONmeter andcompletesthecommunicationconnection.Themeterthensendsthe followinginformationtoIONEnterprise:atimestampindicatingwhenthe alarmconditionoccurred,thenodename,andthemessage(i.e.,contentsofthe AlertmodulesMessagesetupregister). AlertMonitorreceivesthealarmdataandplacesitinthequeueforprocessing. Whenthealarmisprocessed,thecommandsspecifiedintheCOMport configurationsettingsareexecuted.Atthesametime,aconnectionrequestis senttothenodespecifiedinthealarmdata.
2. 3.
4.
Page 308
Setting Up the ION Alert Monitor
5.
Thenewconnectionrequestisreceivedandplacedinthequeue.Ifother connectionrequeststothesamesitealreadyexist,thenewrequestismerged withtheothers. IONConnectionManagementServiceestablishesaconnectiontothemeterthat originatedthealarm,thenLogInserterdownloadsalloutstandingeventand datalogs.
6.
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.

NOTE
This section is intended for advanced users. Contact Technical Support if you need assistance.
TheconfigurationsettingsforAlertMonitorarestoredinaconfigfilethatfollows thefilenamingconvention{MachineName}.AlertMonitor.config.Anexample configfilewiththisnameisprovidedinthe...\ION Enterprise\config\AlertMonitorfolder.AnXMLschemafilenamed AlertMonitorSchema.xmlisalsoprovidedinthesamefolder,foryour reference.YoucanusethisschematovalidatetheconfigfileusingavailableXML validationtools. UseatexteditororXMLauthoringtooltocreateandedittheconfigurationfile. Remembertorenametheconfigfiletomatchthemachinename(e.g.,ifthe primaryserverisnamedComputerOne,renametheconfigfileto ComputerOne.AlertMonitor.config).
Configuration File Components

ChannelsdefinethecommunicationportandmodemthattheAlertMonitoruses, whileActionsdefinethecommandstobecarriedoutinresponsetoanalarm. AChannelcontainsthemodemdefinitionandconfigurationsettingsfortheport.
Page 309
ThefollowingtableliststheattributesyoucanassignforaChannel:
Channel attribute
Name
Description
Name of the communications port the modem is connected to. The default value is COM1. 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. The modems baud rate. The default value is 9600. 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). The default value is AlertMonitor.[ComputerName] This controls whether all alarms are logged to the ION Enterprise system log. The default value is YES (log all alarms). A value of NO disables all alarm logging. This specifies how many times a connection attempt should be retried if there are communication errors.
ModemType BaudRate AlertMonitorNodeName
NoLog
NumTries
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.YoucanspecifyattributesforActionSets: 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,theother specifyingLocationattribute),thentheonethatspecifiestheLocationattribute takespriority.
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.
Page 310
Commands(i.e.,commandlinesthatrunseparateapplicationssuchasnetsend) containedintheActionSetcanincludeparametersthatreturndatavalues,as describedinthefollowingtable:
Command Parameter
%U %u %T %t %n %g %p %P %m %M %a
Description
Universal time: seconds since January 1, 1970 Universal time: YYYY-MM-DD HH:MM:SS.FFF Local time: seconds since January 1, 1970 Local time: YYYY-MM-DD HH:MM:SS.FFF Node name (e.g., device name) Gate name (e.g., site name) Priority name Priority number Alarm message without delimiters Alarm message with delimiters The value of the AlertMonitorNodeName attribute. If this attribute is not used, the default value is AlertMonitor.[ComputerName].
TheConnectionRequestelementcontainedintheActionSethasattributesthat youcandefine,asdescribedinthefollowingtable:
ConnectionRequest Attribute
MaxConnectTimeSeconds MinConnectTimeSeconds
Description
Maximum time (in seconds) a connection to the site is maintained. The default value is 300 seconds. Minimum time (in seconds) a connection to the site is maintained. The default value is 60 seconds. Defines how many hours a connection request remains valid before it is discarded (even if attempts to connect to the site fail). The default value is 0. Priority of the connection request, which ranges from 0 to 2000. The highest priority is 2000. The default value is 1999. This specifies to automatically disconnect from the site after Log Inserter has finished downloading all outstanding logs, including event and data logs. The default value is No. This explicitly defines which specific device to connect to in the site. This attribute overrides data contained in the alarm message. This explicitly defines which site to connect to. This attribute overrides data contained in the alarm message.
RequestLifetimeHours
RequestPriority
DisconnectOnCaughtUp
Device Site
Multi-Station Setup
ItispossibletoruntheIONAlertMonitoronmorethanonemachineintheION Enterprisesystem.However,theconfigurationfilesmustbestoredintheprimary server,followingtheconventionComputerName.AlertMonitor.config.
Page 311
Starting the ION Alert Monitor
Forexample,theAlertMonitorrunningonasecondaryservernamed ComputerTwousestheconfigurationfilenamed ComputerTwo.AlertMonitor.configlocatedintheprimaryserver.
Diagnostics
DiagnosticanderrormessagesareloggedintheIONEnterprisesystemlog,with thesourceAlertMonitor.
Starting the ION Alert Monitor

Bydefault,theIONAlertMonitorisstopped,andsettoManualstartuptype.To automaticallystartAlertMonitoronWindowsstartup,changethestartup propertiesofthisWindowsservicetoAutomatic,thenstarttheservice.Referto yourWindowsdocumentationfordetails.
Page 312
11
Downstream Device Assistant

DownstreamDeviceAssistantletsyoumanagedownstreamdevices.Withthis tool,youcanrenamedownstreamsources,changewhichmeasurementis associatedwithspecificdatafromasource,andapplythesechangestopreviously recordeddatainION_Data(historicaldatabase).Youcanalsodisplayandmanage allthephysicalsources(devices)inyournetwork. DownstreamDeviceAssistantisanadvancedapplicationandshouldonlybeused byuserswithadvancedtechnicalskillsandaclearunderstandingofhowdatais interpretedandstoredintheIONEnterprisedatabases.
In This Section
DetectingDownstreamDevicesonpage 314 DownstreamDeviceAssistantBasicsonpage 315 BasicViewversusAdvancedViewonpage 315 ColumnsDescriptionsonpage 316 DisplayingPhysicalSourcesonpage 318 DownstreamDeviceAssistantOptionsonpage 318 DownstreamDeviceAssistantFunctionsonpage 321 RenamingtheAssignedSourceonpage 321 ChangingtheMeasurementMappingonpage 322 AddingaNewDownstreamDeviceMappingonpage 322 UpdatingtheHistoricalDataataLaterTimeonpage 323 DownstreamDeviceAssistantCommandsonpage 324
Page 313
Detecting Downstream Devices
Detecting Downstream Devices

Adownstreamdeviceisonewhosedataisloggedbyaremotedatarecorder,for example: AModbusslavedevicewhoseoutputregistersareloggedbyadevicewith ModbusMasteringcapability(seeillustrationbelow). AModbusdevicewhoseoutputsareloggedbytheVirtualProcessor. Anyofvariousmultiplesourcesinwhichthesamemeasurementisbeing loggedonasingledevice,e.g.,anRTUthatiscollectingkWhpulsesfrom multiplesourcesorasinglebranchcircuitmonitorthatiscollectingcurrent readingsonmultiplecircuits.
Data Recorder kW
Etherne t
kW Physical Source (Modbus Master)

RS - 4 85
ION Enterprise server
kW
RS -485
Downstream Devices (Modbus Slaves)
IONEnterpriseautomaticallydetectsdownstreamdevices.TheLogInserter componentdoesthisbylookingfordevices(calledphysicalsources)thatrecord orhostdatacomingfromvariousdownstreamdevices(forexample,anIONmeter thatutilizesaModbusImportmoduletopassthroughdataoriginatingfroma downstreamModbusdevice). LogInserterresolvesthedatafromeachofthesedownstreamdevicestothe appropriatemeasurement(forexample,thelabelVllabresolvestothe measurementVoltagePhasesAB).Fordatathatcannotberesolved,LogInserter createsmeasurementswhosenamesarebasedontheIONregisterlabels. LogInserterusesalogicalnamingschemetoassignnamestothedownstream devices.Forexample,Modbus.34isthenameassignedtothedownstream Modbusdevicewithaslaveaddress34.
Page 314
Downstream Device Assistant Basics
Downstream Device Assistant Basics

UseDownstreamDeviceAssistanttoeditthenamesassignedtodownstream devicesortoassignthecorrectmeasurementlabelforaregisterthathasan incorrectmeasurementmapping. IMPORTANT:BeforeusingtheDownstreamDeviceAssistant,makesureyou saveacopyoftheION_NetworkandION_Datadatabases,incaseyouneedto reverttotheoriginalconfigurationofthesedatabases.
Starting the Downstream Device Assistant

1. 2. RuntheprogramnamedDownstreamDevices.DownstreamAssistant.exein the...\IONEnterprise\system\binfolder. LoginusingyourIONEnterprisecredentials. AmessagedisplaystoremindyoutobackupyourION_Networkand ION_Datadatabases.ClickOKtocontinue. 3. DownstreamDeviceAssistantopensinBasicvieworAdvancedview, dependingonthelastviewitwasinbeforeitwasclosed.Thefirsttime DownstreamDeviceAssistantisstarted,itopensinBasicview.
Basic View versus Advanced View

Theviewdetermineswhatcolumnsareavailableaswellaswhetheranactionis global(appliedtoallrowscontainingaparameter)orspecifictoarow.
Page 315
Columns Descriptions
Columns in Both Basic and Advanced View Column Name Description
The IsDownstream column identifies which devices in the Assigned Source column are downstream devices. If IsDownstream is selected, it means that the device identified in the Assigned Source column is downstream to a physical device, whose name is indicated in the Physical Source column. If IsDownstream is cleared, this indicates that the device is a physical source. Note also that a physical source has the same Assigned Source name and Physical Source name, by default. This is the default name that Log Inserter assigned to a downstream or physical device. For example, Modbus.109:MainFeed.PM7650 is the default name assigned for the downstream Modbus device with unit ID 109, whose measurements are being logged to a data recorder on a Modbus Master device named PM7650 that is part of the MainFeed site (group). This text field allows you change the current name under Assigned Source. In Basic view, all rows that contain the same Assigned Source name are automatically updated to the new name when you enter it in the Updated Assigned Source column. In Advanced view, you can select one or more rows and rename the source using the Updated Assigned Source column, while leaving the other rows unchanged. See Renaming the Assigned Source on page 321 for more details. This identifies the name of the physical device (e.g., a Modbus Master device or the Virtual Processor) that is performing the data logging for a downstream device. This column displays either the ION label (e.g., Vln avg) or the descriptive name of the measurement (e.g., Average Voltage Line-to-Neutral), depending on the setting in the Options dialog box; see Downstream Device Assistant Options on page 318.
IsDownstream1
Assigned Source
Updated Assigned Source
Physical Source2 Measurement
Additional Columns in Advanced View Only

This lets you redefine what is currently assigned in the Measurement column. Click the cell to display the list of measurements to choose from. Depending on the setting in the Options dialog box, you can select from a list containing only the most common measurement definitions or from a complete list of all available measurements; see Downstream Device Assistant Options on page 318. This column displays a measurements register handle either in hexadecimal format or decimal format, depending on the setting in the Options dialog box; see Downstream Device Assistant Options on page 318. This identifies which user made a change to the source-measurement definition. The Update Historical Database check box is automatically selected after entering changes in the Updated Assigned Source or Updated Measurement cell. This means that all historical database entries that contain the old Assigned Source name or Measurement will be updated with the new name or measurement. If you want to leave the existing data in the database unchanged, clear the Update Historical Database check box before saving the changes. By default, Log Inserter automatically associates the proper measurement to the appropriate piece of data in the data log. Normally, the Manual check box should remain cleared. However, if you want to specifically change the measurement or register handle associated with a particular address definition, select the Manual check box for that measurement. This manually overrides Log Inserter so that it uses this new address mapping from now on (i.e., Log Inserter does not attempt to resolve that address ever again).
1 2
Updated Measurement
Handle Entered By
Update Historical Database
Manual (see Caution below)
Do not change the value of IsDownstream when making changes to source/measurement definitions, as it is automatically set by the Downstream Device Assistant. 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.
Page 316
NOTE
It is not recommended that you select the Manual check box. This reserves the ION register for which Manual is checked for the selected measurement. 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.
Basic View
ToswitchtoBasicview,clickView>Options.IntheAdvancedsectionofthe Optionsdialogbox,cleartheenableadvancedfeaturescheckbox.ClickOK. InBasicview,whenyouenteranewnameintheUpdatedAssignedSource column,allrowsthatcontainthesameAssignedSourcenameareautomatically filledinwiththenewname.Existingdatainthehistoricaldatabase(ION_Data)is alsoautomaticallyupdatedtoreflectthechange.
Advanced View
ToswitchtoAdvancedview,clickView>Options.IntheAdvancedsectionofthe Optionsdialogbox,selecttheenableadvancedfeaturescheckbox.ClickOK. InadditiontothecolumnsdisplayedinBasicview,Advancedviewdisplaysallthe othercolumnsforeditingindividualsourcemeasurementdefinitions(i.e., UpdatedMeasurement,Handle,EnteredBy,UpdateHistoricalDatabase,and Manual).InAdvancedview,youcan: Selectandmakechangestoaspecificrowwithoutaffectingtheotherrows.For example,youmaywanttochangethesourcenameforoneparticular measurementwhileleavingtheoriginalsourcenameunchangedforallthe othermeasurements. Selectadifferentmeasurementforonethatisincorrectlymappedtoaparticular registerhandle. Selectwhetherornottoupdatehistoricaldataforachangedsourcenameor measurementdefinition,byselectingorclearingtheUpdateHistoricalData checkbox,respectively.Changinganameordefinitionautomaticallyselectsthis checkbox. SelectwhetherornottoallowLogInsertertoresolvetheregisterhandletoa particularsourcemeasurement,byclearingorselectingtheManualcheckbox, respectively.Thedefaultsettingiscleared(i.e.,LogInserterautomatically resolvestheregisterhandletothesourcemeasurementdefinition).Ifyouwant toforcethechangesoLogInserterdoesnotresolvethehandletothenew measurement,selecttheManualcheckbox.
Page 317
Displaying Physical Sources
Displaying Physical Sources

ThedefaultviewforDownstreamDeviceAssistantdisplaysonlythedownstream devices.Todisplaythephysicalsourcesaswell: 1. 2. ClickView>SelectPhysicalSources. Selectthecheckboxbesidethephysicalsourcesyouwanttodisplay.Selectthe Select/ClearAllcheckboxtoselectallphysicalsourcesorclearittoselectnone. ClickOK.
NOTE
The Physical Sources are not 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.
Downstream Device Assistant Options

ClickView>OptionstodisplaytheOptionsdialogbox:
CertainoptionssuchasshowallmeasurementsandtheHandlesdisplay optionsaredisabledinBasicView.Toenablethem,switchtoAdvancedViewfirst (seeAdvancedonpage 320).
Page 318
Measurements
ThissectionallowsyoutoselectwhethertodisplaythedefaultIONlabel(e.g., Vlnavg)intheMeasurementcolumnortodisplaythefulldescriptivenameof themeasurement(e.g.,AverageVoltageLinetoNeutral). InAdvancedviewonly,youcanalsoselectwhethertodisplayallavailable measurementsoronlythemostcommonmeasurementsinthelistwhenpickinga measurementintheUpdatedMeasurementcolumn. Displaying ION labels versus measurement names Tochangethesetting: 1. 2. ClickView>Options. IntheMeasurementssection,selectdisplayIONlabelstodisplaytheIONlabel ordisplaymeasurementnamestodisplaythefullnameofthemeasurement.
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 displays the known default label for that particular measurement.
Updated Measurement Column display Tochangethesetting: 1. 2. ClickView>OptionsandensureAdvancedisselected. IntheMeasurementssection,selecttheshowallmeasurementscheckboxto displayallavailablemeasurementsintheUpdatedMeasurementcolumn.To displayonlythemostcommonmeasurements,cleartheshowall measurementscheckbox.
Historical Data
Iftheshowconnectiondialogcheckboxiscleared,theION_Datadatabaseis automaticallysetastheDefaultConnection(forhistoricaldata). Ifyouwanttoselectadifferentdatabase,selecttheshowconnectiondialogbox. Withthissettingenabled,thedatabaseconnectiondialogboxisdisplayedevery timeyousaveyourchanges.Whenthedialogboxdisplays,selectCustom Connectionandspecifyyourdatabaseconnectiondetails.
Page 319
Advanced
TheenableadvancedfeaturescheckboxsetstheviewtoBasicViewifitiscleared orAdvancedViewifitisselected. Handle AvailableinAdvancedViewonly,thisoptionspecifieswhetherregisterhandles aredisplayedasthehexadecimalvalue(withthe0xprefix)orasthedecimal value. Tochangethesetting: 1. 2. ClickView>OptionsandensuretheAdvancedisselected. IntheHandlessection,selectdisplayhextodisplaytheregisterhandlein hexadecimalformatordisplaydecimaltodisplayitindecimalformat.
Ifyouwanttomanuallyresolvearegisterhandletoaspecificmeasurement,edit thevalueintheHandlecell,thenselecttheManualcheckboxbeforesavingthe changes.
Page 320
Downstream Device Assistant Functions
Downstream Device Assistant Functions

ThissectiondescribesdifferentfunctionsyoucanperformusingtheDownstream DeviceAssistant.
Renaming the Assigned Source

OneoftheprimaryreasonsforusingtheDownstreamDeviceAssistantisto changethedefaultnameassignedtoadownstreamdevicebytheLogInserter.For instance,insteadofModbus.34,youmaywanttorenamethatdeviceto somethingmoremeaningfulsuchasSM_Bldg2_Boiler7. RenaminganAssignedSourcetypicallyonlyappliestodownstreamdevices. Renaming the Assigned Source for ALL its Measurements 1. 2. SwitchtoBasicView. Findthesourceyouwanttorename.EnterthenewnameintheUpdated AssignedSourcecolumn.Allrowswithmeasurementsassociatedwiththe renamedsourceareautomaticallyupdated.
NOTE
If you do not want to assign the existing data in the database to the new source name, switch to Advanced View first, then clear the Update Historical Database check box for all appropriate rows.
3. 4. 5.
ClickFile>Save. Adialogboxpromptsyouwithasummaryofthechanges.ClickYestocontinue. orNotocancel. Whentheoperationhascompleted,clickOK,thenClose.
Renaming the Assigned Source for one or more Measurements 1. 2. 3. 4. SwitchtoAdvancedView. Selecttherow(s)youwanttorename.Toselectarow,clicktheareajusttothe leftofthefirstcolumn.Therowishighlightedtoindicatethatitisselected. ClickEdit>RenameSource. IntheSourceRenamebox,typethenewnameforthedownstreamsource.Click OK.
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. 6. 7.
ClickFile>Save.Adialogboxpromptsyouwithasummaryofthechanges. ClickYestocontinueorNotocancel. Whentheoperationhascompleted,clickOK,thenclickClose.
Page 321
Cancelling Changes
Cancelling Changes
1. Toundoallunsavedchanges: ClickEdit>Reset,or ClickView>Refresh. 2. ClickYestoconfirm.
Changing the Measurement Mapping

LogInserterautomaticallyassociatesloggeddatawithameasurementby searchingforamappingbetweenthelabelandthemeasurement.However,in caseswherenomappingexists,LogInsertercreatesameasurementthatisbased ontheregisterlabel.Tomanuallychangethismeasurementmapping: 1. 2. 3. 4. SwitchtoAdvancedView. ClicktheUpdatedMeasurementcellthatyouwanttochange,thenselectthe newmeasurementyouwanttomapfromthelist. SelecttheManualcheckbox. Bydefault,theUpdateHistoricalDatabasecheckboxisselectedthisapplies thechangetoexistingdatainthedatabase(if,forexample,thesourceand measurementmappingyouareaddingalreadyexists).Tomakethechangeonly todatagoingintothedatabasefromthispointforward,cleartheUpdate HistoricalDatabasecheckbox. ClickFile>Save.Adialogboxpromptsyouwiththechanges.ClickYes. Ifprompted,selectwhichdatabasetoupdate.ClickOK.
5. 6.
Adding a New Downstream Device Mapping

Toaddanewaddressmappingthatassociatesthesourceandmeasurementtoa specificloggedquantityinthedatabase: 1. 2. Scrolldowntotheendofthetableandclickthelastrow(theonewiththe asteriskbesideit). FillintheUpdatedAssignedSourceandPhysicalSourcecolumns.Ifthesource isaphysicaldevice(i.e.,notdownstream),thesamenamemustbeentered exactlyinbothcolumns. ClicktheUpdatedMeasurementcell,thenselectthemeasurementfromthelist. IntheHandlecell,typetheregisterhandleforthismeasurement. Bydefault,theUpdateHistoricalDatabasecheckboxisselectedthisapplies thechangetoexistingdatainthedatabase(if,forexamplethesourceand measurementmappingyouareaddingalreadyexists).Tomakethechangeonly todatagoingintothedatabasefromthispointforward,cleartheUpdate HistoricalDatabasecheckbox. ClickFile>Save.Adialogboxpromptsyouwiththechanges.ClickYes. Ifprompted,selectwhichdatabasetoupdate.ClickOK.
3. 4. 5.
6. 7.
Page 322
Updating the Historical Data at a Later Time
Updating the Historical Data at a Later Time

WhenyousaveyourchangesusingtheDownstreamDeviceAssistant,arecordof changestothesourcemeasurementdefinitionsissavedinthefolder: ...\IONEnterprise\config\Diagnostic\DownstreamDeviceAssistant\ withthefollowingfilename: DownstreamDeviceDefinitionsYYYYMMDD_hh.mm.ss.csv whereYYYYMMDD_hh.mm.ssmeanscurrentYEARMONTH DAY_hour.minute.second. IfyouclearedtheUpdateHistoricalDatabasecheckboxwhenyousavedyour changesthefirsttime,youcanupdatetheexistingdatainthedatabaseatalater time,throughtheuseofthiscsvfile. How to use the Downstream Device Assistant .csv file Toupdatetheexistingdatainthedatabasewiththesourcemeasurementchanges containedinthecsvfile: 1. 2. 3. 4. 5. 6. 7. ClickEdit>HistoricalData.TheUpdateHistoricalDatawindowappears. ClickFile>ImportCSV. DownstreamDeviceAssistantopensthefolderthatcontainsthecsvfiles.Select theDownstreamDeviceDefinitionsfileyouwanttouse,thenclickOpen. ClickFile>UpdateHistoricalData. TheHistoricalDataUpdatepromptdisplayshowmanysourcemeasurement pairswillbeupdated.ClickYes. ClickYesattheHistoricalDataUpdateprompt. Aftertheoperationhascompleted,clickOK,thenClose.
YoucanupdateonlyoneIONdatabaseatatime.Toselectadifferentdatabase, firstmakesuretheshowconnectiondialogcheckboxisselectedunder View > Options.Youcanthenusethedatabaseconnectiondialogboxtospecify whichdatabaseyouwanttoupdate.
NOTE
If you update address definitions that affect multiple historical databases, only the first historical database you select is 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.
Page 323
Downstream Device Assistant Commands
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 RenamingtheAssignedSourceonpage 321. Edit>UpdateHistoricalData:OpenstheUpdateHistoricalDatawindow thatallowsyoutoopenapreviouslysavedsourcemeasurementdefinitiondata file(witha.csvfileextension),forthepurposeofupdatingexistingdatainthe database.Youcanalsomanuallyadd,editordeletedataentries.SeeUpdating theHistoricalDataataLaterTimeonpage 323. View>Refresh:Loadsthecurrentdownstreamdefinitionsfromthedatabase. FunctionallythesameasEdit>Reset,asthiscommandclearsallmodifications madesincethelastsave. View>Options:DisplaystheOptionsdialogboxwhereyoucanchangethe settingsthatcontrolwhatlevelofdetailisdisplayedforthesource measurementdefinitions. View>SelectPhysicalSources:DisplaystheSelectPhysicalSourcesdialog boxwhereyoucanselectwhichphysicaldevicesyouwantdisplayedinthe DownstreamDeviceAssistant.
Page 324
Appendix A: Reporter
ReporteristhelegacyprogramfromIONEnterpriseversion5.6andearlierthat defined,generatedandmanagedcomprehensivereports,basedoninformation containedinyourdatabase.Reporterprocessesselecteddataandgeneratesa finishedreportinMicrosoftExcelformat.
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.
ForinformationonusingWebReporter(thereplacementforReporter),seeWeb Reporteronpage 171.
In This Section
Introductiononpage 326 CreatingaReportonpage 327 GeneratingaReportonpage 330 ModifyingtheFinishedReportonpage 330 TypesofDefaultReportsonpage 331 CreatingaReportWithoutaTemplateonpage 335 AutomaticReportGenerationonpage 336 UsingReporteronSecondaryServerorClientonpage 337 Troubleshootingonpage 338
Introduction
Introduction
Reporterfeaturesawizardthatguidesyouthroughthereportcreationprocess. Thisinvolvesselectingareporttemplateanddatabase,whichthenallowsthe wizardtodisplaythosesourcesintheIONEnterprisenetworkthatcontainthe typeofdatarequiredtocreatethereport. Whenthereportisgenerated,ReporterretrievesdatafromtheION_Data database,usesthereporttemplatetoprocessthedata,thencreatesafinished reportinMicrosoftExcelformat. Reporttemplatesarepreconfiguredforthemostcommonreportingneeds.The followingreporttemplatesaresuppliedwithIONEnterprise5.6: EnergyandDemand LoadProfile PowerQuality EN50160_General EN50160_Summary EN50160_Mains_Signal IEC61000430_10Min IEC61000430_2Hr IEC61000430_3Sec
Starting Reporter
TostartReporter,navigatetothe../IONEnterprise/system/bin/folderanddouble clickonRepGen.exe.
TIP
If you plan to use this program frequently, create a shortcut to the .exe file on your desktop.
ReporteropenswitheitherManageReportsorGenerateReportspreselected, dependingonwhetherornotanyreportshavealreadybeencreated.Youcannot generatereportsuntilyouhavecreatedatleastone.
Page 326
Creating a Report
Creating a Report
1. 2. StartReporter. SelectManageReports,thenclickNew.Thisstartsthenewreportwizard.
Step 1: Select Template

1. 2. 3. TypethenameofthereportintheReportNamebox. SelectthetemplateyouwanttouseintheReportTemplatelist. ClickNext.
Step 2: Select Database and Sources

1. Specifyyourdatabase(ION_Dataisselectedbydefault).Toconnecttoa differentdatabase(e.g.,anarchiveddatabase),selectitfromtheDatabase dropdownlist,orclickMore. Selecttheboxbesideeachsourcename(device)thatyouwanttoincludein yourreport.SelecttheShowDetailsboxifyouwanttoseeadditional informationforthedevices.
2.
NOTE
Show Details is only available when "Show only sources applicable to the template" is selected.
3.
IfthereporttemplateyouareusingrequiresaTOUschedule(suchasEnergy andDemand),theTOUSchedulesectionappearsonthedialogbox.Selecta TOUschedulefromthelistorclickManagetocreateanewone.
TOU Schedules AtypicalTOUschedulehasOnPeak,OffPeakandShoulderPeakperiods.The EnergyandDemandreporttemplaterequiresaTOUschedule.Ifyoudonotwant touseaTOUschedule,simplycreateaTOUschedulewithasingleTariffperiod. TocreateanewTOUschedule: 1. 2. ClickManageintheTOUSchedulesectionofStep2.TheTOUSchedules dialogboxappears. ClickNew.TheTOUSchedulePropertiesdialogboxappearswithablankTOU schedulewithasingletariff. Usethelefthandpanetoselecttheitemyouwanttoedit,thenusetherighthand panetoenter,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 328.
3.
SelectNewTOUSchedule,thenusetheTOUScheduleNameboxtorename it(forexample,2007TOUSchedule).
Page 327
Creating a Report
4.
SelectTariff1todisplaytheTariffDetailsontherightpane,thenusetheName boxtotypeanameforit(forexample,OffPeak). Usetherateboxes($/kWh,$/kW,etc.)toenterthetariffrates.
5.
Ontheleftpane,clickthe+besidethetarifftoexpandit.Selectthetext underneathit(AllDay,EveryDay...)todisplaytheTariffPeriodfields.Usethe FromandToboxestosetatimerangeandadaterangeforthetariffperiod. Tocreateanothertariffperiod,selectthetariffperiodyoujustconfigured,then clickNewtoaddanewtariff.Setthetimerangeanddaterangeforthisnew tariffperiod.
6.
Tocreateanewtariff(forexample,OffPeak),selectthetariffname,thenclick New.Repeattheabovestepstorenamethetariff,settherates,andsetthetariff periods.
Holidays 1. 2. SelectoneoftheOffPeakperiods,thenclickNew. Renamethetariff(forexample,Holidays)andclickonthedayandtimes underneathtoconfigurethetariffperiod.
3. 4.
Selecttheappropriatecountryholidaysfromthelist. Addorremoveindividualholidaysasrequired.
NOTE
Make sure there are no gaps or overlapping date or time ranges in the TOU Schedule.
Copying an Existing TOU Schedule TocreateaTOUScheduleusinganexistingoneasatemplate,selectitthenclick Copy.Renamethecopyandmodifyitspropertiesasneeded.
Step 3: Set Up the Report Options

Thereportoptionsareorganizedinthedifferenttabsofthewindow,namedas follows:DateRange,Distribution,Validation,Display,andNotes.
Page 328
Creating a Report
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.
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:thenselectValuesfromthepreviousrow, Anemptyrow,orAzerovalue. Display SelectoneoftheoptionstocontrolhowReporterhandlesrawdatasheetsinthe report(Show,Hide,orDelete).
Page 329
Generating a Report
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.
Previewing the Report

Toseewhatthereportwilllooklike,withoutsavingordistributingit,click Preview.ClickBackToReportGeneratorbuttontoreturntothemainReporter window.Modifythesettings,ifnecessary.Otherwise,clickFinishtosaveyour reportandreturntothemainReporterscreen.
Generating a Report
1. 2. 3. 4. OnthemainReporterscreen,selectGenerateReports. Selectthenameofthereportyouwanttorun.Ifyouwanttoviewitsoption settings,clickSummary.ClickOKtoclosethesummarywindow. ClickGenerate.Awindowdisplaystheprogressofthereportgeneration. ClickClosetoviewthereport.
Modifying the Finished Report

ThisdescribeshowtoedittheMicrosoftExcelpresentationsheetforyourreport: 1. 2. OnthemainReporterwindow,selectthereportyouwanttomodify,thenclick Preview. 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. 4.
Layoutandformattheelementsasyouwantthemtoappearinthereport. Saveyourchanges.
Page 330
Types of Default Reports

ThissectionshowsbasiccharacteristicsoftheMicrosoftExcelreportsgenerated fromtheReportertemplates.Thefirsttabintheworkbookiscreatedfromthe Presentationsheetofthereporttemplate.Youcanmodifythelookand functionalityofareportbyeditingitspresentationsheet.SeeModifyingthe FinishedReportonpage 330fordetails.
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 availableonmostIONdevices. TOU Schedule ReporterrequiresaTOUschedulewhencreatingareportusingtheEnergyand Demandtemplate.AsampleTOUscheduleisincludedthisallowsyoutodefine timeperiodsthatcoincidewithtimeperiodsinyourenergyproviderstariff schedule,suchasOnPeakandOffPeaktimes.IfyoudonotneedtouseaTOU schedule,simplycreateanewTOUschedulewithonlyonetimeperioddefined. TheAggregateEnergy&Demandtabcontainsasummaryofthecombinedenergy anddemandvalues.Energyanddemandinformationfromdifferentsourcesare storedinseparatetabsintheworkbook.
Load Profile
UsetheLoadProfiletemplatetocreateagraphicalrepresentationofdemandor loadlevelsoveraperiodoftime.Theprofileshowspeakloadspointsonthe graphwherepeakelectricitydemandishigh.Aloadprofilereportcanbeusedto analyzetheelectricalloadsatthetimeofmaximumdemand.Thisinformation createsopportunitiesfordevelopingstrategiestoimproveenergymanagement. SimilartotheEnergyandDemandtemplate,theLoadProfiletemplateusesdata fromtheEnergyandDemandlog(kWDemand,kVARDemand,kVADemand), exceptitdoesnotuseaTOUschedule. TheLoadtabcontainsagraphicalrepresentationofthepowerusageofyour systemovertime(totalloadprofile).Loadprofilesfromdifferentsourcesare storedinseparatetabsintheworkbook.
Page 331
Power Quality
UsethePowerQualitytemplatetocreateareportthatsummarizesthenumber andseverityofvoltagesags,swellsandtransientsoveraperiodoftime.The finishedreportalsoincludesagraphicalrepresentationofthedisturbances,andan interactiveselectionofgroupevents. ThePowerQualitytemplateusesdatafromallthreePowerQualitylogfilesthat arefoundondeviceswithsag/swellandtransientdetectioncapabilities: Sag/SwellLog TransientLog WaveformLog 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.
Page 332
Click Show Complete to display individual waveforms. Click the magnify buttons to zoom in or out.
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.
Page 333
Anobservationsheetisgeneratedforeveryobservationperiod;however,itis hiddenbydefault.Youcanaccessspecificobservationsheetsbyunhidingthe specificsheetforthegeneratedreportinMicrosoftExcel(Format>Sheet>Unhide >observationsheet). EN50160_Mains_Signal UsetheEN50160_Mains_Signaltemplatetocreateareportforsignalline frequencystatisticsforasinglemeter,foreachobservationperiod. TheEN50160_Mains_SignaltemplateusesdatafromtheEN50160MSignallog.
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).
Waveforms
Togenerateareportfromlogsthatcontainvoltageandcurrentwaveformdata, select<notemplate>andsettheLogtoWaveforms.SeeCreatingaReport WithoutaTemplateonpage 335fordetails.
Afterthereportisgenerated,clickthetabnamedforthewaveformquerytoview. Theleftpanecontainstimestampsthatlinktothewaveformchartontheright pane.Clickatimestamptoviewthewaveform. Toviewthewaveformsforeachcurrentandvoltagephase,clickShowComplete ontheWaveformstoolbar.Usethemagnifyingglassiconstozoominorzoomout.
Page 334
Creating a Report Without a Template
Custom Templates
ContactTechnicalSupportifyourequireotherspecializedreporttemplates.
Creating a Report Without a Template

YoucanuseReportertocopyrawdatafromadatabaseandpasteitintoMicrosoft Excel: 1. 2. 3. InthemainReporterwindow,selectManageReports,thenclickNew. FillintheReportNamebox,select<NoTemplate>,thenclickNext. ClickNewtocreateasource/logqueryforthereport.SettheQueryProperties: Name:Newqueriesareautomaticallynamedinasequentialmanner,but youcanalsorenamethemasrequired. Source:Selectthesourceofthequery(e.g.,powermeter). Log:Choosethedatalogthatyouwanttocopyrawdatafrom. Database:ION_Data<SQL>isthedefaultsetting.Tochangethedatabase source,selectonefromthelist,orclickMore. IfaTOUscheduleisrequired,selectApplyTOUScheduletodatabasequeries, thenselectonefromthelist,orclickManagetocreateone. 4. 5. 6. Toaddanotherquery,clickNew,thensetthequerypropertiesasdescribed above. Whenyouhaveaddedandconfiguredallyourqueries,clickNext. Configurethereportoptionsasdescribedinthesection,Step3:SetUpthe ReportOptionsonpage 328.
Page 335
Automatic Report Generation
Automatic Report Generation

YoucanusetheWindowsScheduledTasksutilitytogeneratereportsonaset schedule: 1. 2. 3. 4. 5. 6. 7. ClickStart>Settings>ControlPanel.DoubleclickScheduledTasks. DoubleclickAddScheduledTask.UsethewizardtoselectReporterfromthe listofprograms. Assignanameforthisnewscheduledtaskandspecifyhowoftenthistask shouldbeperformed. Setthestarttimeandotherrelevantdataforyourschedule.ClickNext. Whenprompted,enteryourusernameandpassword(andconfirmthe password).ClickNext. Asummaryscreenofyourscheduleappears.SelectOpenadvancedproperties forthistaskwhenIclickFinish,thenclickFinish. 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. ClickOK.
9.
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.
Page 336
Using Reporter on Secondary Server or Client
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. DoubleclickthefilenamedION_DsnKeys.regtoimportitintoyourregistry.
2.
Page 337
Troubleshooting
Troubleshooting
Excel file does not open when you double-click its icon ThismightoccurwhenaMicrosoftExcelprocesshangs.Tofixthis,startExceland openafile(orcreateanewone).ClickTools>Options,thenintheGeneraltab, clearIgnoreotherapplications.CloseandexitExcel. Ifthisdoesnotwork,tryrebootingthecomputer.
Page 338
A
add connectionschedule39 Ethernetdevice35 modem36 networkcomponent33 OPCdevice35 serialdevice34 server33 advancedsecurity(accessmeterswith)38 alarm acknowledge(Vista)105 silence(Vista)106 alarmoptions144 alertmonitor308 configurationfile309 setup309 annunciationoptions144
C
CBEMA125 configuringmultipledevices48 connectionschedule39 controlobject actionoptions143 displayoptions141 controlobject(Vista)129
D
data copydatatoanotherapplication101 filterdata24 plot101,108 realtime98 sort24 staledatasettings(Vista)96,159 viewloggeddata100 datalogviewer100 diagramobject128 linktodatasource147 database18 accessvia3rdpartyapplication275 ION(ION_Data)18 networkconfiguration (ION_Network)18 systemevents(ION_SystemLog)18 databasemanagement alarmconfiguration260 archive261,268 attach262 backup262,271
createnewdatabase264 defragment262 detach262 exportregistrysetting263 manual260 modifylogin263 optimizequerytime273 restore264 scheduled267 scheduledmaintenance270 SQLeditor265 trim265,270 updatestatistics266 upgradedatabase266 Designer cloneanode237 IONmodulestoolbox209 nodediagram198 windowconfiguration206 Designer.See ION modules, see node dia gram207 device Ethernet32 serial32 diagnostics communications68 server67 diagramobject93 captionoptions134 previewpane133 directsite addserialdevice34 display adjustcolumnwidth23 arrangecolumns23 customizeinterface22 dock(pin)pane22 filterdataincolumn24 gridtables23 grouptabledatabycolumn24 hide(unpin)pane22 resizingpanes22 selectcolumnstodisplay23 sortdataincolumn24 downstreamdevice314 downstreamdeviceassistant addnewdevicemapping322 basicversusadvancedview315 changemeasurementmapping322 columns316 displayphysicalsources318 options318 renameassignedsource321 update historical data after changes
323 duplicatingadevice45
E
Ethernetdevice32 add35 Ethernetgateway adddevice34 eventlogviewer100,102 diagramobject129 display103 linktodatasource147 eventwatcher62 addeventwatcher64 createtemplate63 exitacomponent19
addevents119 calculationswindow110 customize121 deindexparameters114 displaycurvedataintable111 graphoptions110 harmonicsanalysistab115 legend109 overlaycurves125 phasordiagramtab116 plotdisplaytab112 removeparameters125 specifyyoffsets114 symmetricalcomponents117 Xparameter149
M
managementapplications14 ManagementConsole customizethedisplay29 manager281 Modbus adddevicetype278 configure advanced device functions 301 configureadvancedfunctions290 defaultdevicetypes278 editregister291 mapfile278 Modbusgateway adddevice34 modem add36 dialout32 remotemodemsetup74 WinModem36 monitoringapplications14
G
globaleventlogviewer100,102 add104 display103 groupingobject(Vista)93,128 displayoptions140 groupingwindow(Vista)93 groups(ofusers) add/edit58
H
harmonicsanalysis115 calculate using more than one cycle 115
I
IONmodule207,281 configure224 coreversusstandardmodule208 onlineversusofflinemodule207 outputregister207 parentmodule227 persistentmodule208 programmedversuspending208 setupregister207 viewastext213 IONtree220,278
N
navigating treestructures22 networkcomponent31 add33 delete37 edit36 networkdiagram generate94 nodediagram198 addmodule210 addtextbox215 configuremodule224 copymodule230 toframework231 createshortcuttomodule236 customlabels227 defaultversuscustomlabels204 deletelinksbetweenmodules222
L
largesystemsetup43 loginserter fastlinkoption229 logintoacomponent19 logofffromacomponent19 logviewplotter108 adddatafromanotherapplication120 adddatafromdatalogviewer119
display/editmode200 finddependentmodules211 icons201 linkmodules217,220 linkmodulesacrossnodes219 linkingmodules217 locateexistingIONmodule210 pastemodule232 freepasteorlockpaste235 fromframework232 resetmodule228 shortcuttomodule214 viewastext213 viewinputinformation240 viewoutputregisterinformation239 viewsetupregisterinformation240 numericobject98,128 displayoptions136 numericobject(Vista) flags98,138
inputs180 loadprofilereport177 powerqualityreport177 print185 save185 share187 subscription188 subscriptionconfiguration61,172 systemconfigurationreport178 tabularreport179 trendreport179 uploadreports/reportpacks191
S
selectingmultipleitems22 serialdevice32 add34 server31 addserver33 services,Windows16 site directsite31 Ethernetgatewaysite31 modemsite31 OPCsite32 SQLServer18 SQLServerinstance256 startacomponent19 statusobject99,128 displayoptions139 subscription eventwatcher62 WebReporter188 symmetricalcomponents117 systemlogevents41
O
OPCdevice32 OPCServer15 OPCsite adddevice35
P
phasordiagram116 powerfactor,displayinVista114 PQDIFExporter15 programmingapplications15
Q
querydatabase,Vista148 queryserver148 queryingdatabase querywizard150
T
textboxobject(Vista)128 TimeofUse(Designer) advancedconfiguration241 timeofuse(Designer)241 timeofuse(WebReporter)80
R
register281 Reporter325 reports 100msreport175 administration187 defaultdefinitions175 EN50160report175 energycostreport176 energyperiodoverperiod comparisonreport176 energyusagebyshiftreport176 eventlogreport176 export186 generate180 IEC61000430report176
U
upgradedevice71 userdiagram93 adddiagramobject128,129 backgroundcolor155 backgroundimage156 communicationerrors97 copy/pastediagramobjects129 createnew127 customize127 customizediagramobject133 default94 defaultactionforwindow158
defaultnode158 defaultqueryserver157 diagramobjects,types128 edit/displaymode92 enableundooption128 font155 layout131 navigate95 save127 specifyforparticularuser95 staledata96,159 users add/edit56 usergroups58
V
virtualprocessor(VIP) commonapplications250 Modbuscommunications248 modifyglobalparameters79 setglobalparameters252 setup75 Vista customizingdiagramwindow155 framework130 generatenetworkdiagram94 navigate95 plotdata101 querywizard150 viewdiagramsonline(WebReach)163 viewloggeddata100 viewrealtimedata98 Vistadiagramobject actionoptions142 alarmingoptions144 annunciationoptions144 boxoptions143 displayoptions136 edittextoptions135 linkoptions135 linktodatasource146 queryserveroptions136 textoptions134
savereport185 sharereport187 subscriptionconfiguration61,172 uploadreports/reportpacks191 WebReach accessWebReach163 advancedconfiguration168 communicationerrors167 networkdiagram163 RMSwaveformplotting165 staledata167 troubleshooting170 viewevents166 viewglobalevents166 viewhistoricaldata164 WinModem36
W
waveforms plot118 WebReporter defaultreportdefinitions175 display174 exportreport186 generatereport180 inputs174,180 navigation174 printreport185 reportadministration187 reportsubscription188
PowerLogic ION Enterprise

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 Getting technical support: Contact your local Schneider Electric sales representative for assistance or go to the www.powerlogic.com website. ION, ION Enterprise, Modbus, Modicon, Power Measurement, PowerLogic and Schneider Electric are either trademarks or registered trademarks of Schneider Electric in France, the USA and other countries. All other trademarks are property of their respective owners. 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. 70002-0298-00 2009 Schneider Electric. All rights reserved. 06/2009

ION Enterprise 6.0 User Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

ION Enterprise 6.0 User Guide

Hochgeladen von

Copyright:

Verfügbare Formate

70002-0298-00 06/2009

PowerLogic ION Enterprise 6.0

Management Console ................................................. 27

Management Console Tools ......................................... 53

UsingtheEventandGlobalEventLogViewers .......................... 102 DisplayingtheGlobalEventLogViewer................................ 103 AcknowledgingAlarms .............................................. 105

WebReach ................................................................ 161

Web Reporter ........................................................... 171

Designer .................................................................. 195

Database Manager ................................................... 255

AttachingaDatabaseUsingDatabaseManager .......................... 258 RestoringanIONDatabasefromaBackup .............................. 259

Modbus Device Importer ........................................... 277

ION Alert Monitor ..................................................... 307

Downstream Device Assistant .................................... 313

Reporter ................................................................... 325

2009 Schneider Electric. All rights reserved.

ION Enterprise Software Components

PowerLogic ION Enterprise User Guide

ION Enterprise Software Components

2009 Schneider Electric. All rights reserved.

PowerLogic ION Enterprise User Guide

Modbus Device Importer

Large System Setup Using Management Console

2009 Schneider Electric. All rights reserved.

ION Enterprise Services

PowerLogic ION Enterprise User Guide

ION Enterprise Services

ION Alert Monitor ION Component Identifier Service

ION Connection Management Service

Disabled Automatic Automatic

ION Network Router Service

Manual Automatic Manual Automatic Automatic Automatic

2009 Schneider Electric. All rights reserved.

PowerLogic ION Enterprise User Guide

ION Enterprise Services

ION Site Service

ION Virtual Processor Service

ION XML Subscription Service ION XML Subscription Store Service

This service may not be available on all operating systems.

2009 Schneider Electric. All rights reserved.

ION Enterprise Databases

PowerLogic ION Enterprise User Guide

ION Enterprise Databases

Microsoft SQL Server Database

The Network Configuration Database

The System Events Database

The ION Database

2009 Schneider Electric. All rights reserved.

PowerLogic ION Enterprise User Guide

Starting a Component of ION Enterprise

Logging into a Component of ION Enterprise

2009 Schneider Electric. All rights reserved.

PowerLogic ION Enterprise User Guide

2009 Schneider Electric. All rights reserved.

PowerLogic ION Enterprise User Guide

2009 Schneider Electric. All rights reserved.

Customizing and Navigating Interface Displays

PowerLogic ION Enterprise User Guide

Customizing and Navigating Interface Displays

Navigating Tree Structures

Adjusting the Display of a Window or Dialog Box

Dock (Pin) or Hide (Unpin) Pane

2009 Schneider Electric. All rights reserved.

PowerLogic ION Enterprise User Guide

Grid Table Controls