Anda di halaman 1dari 412

Visual Integrator 3

Integrator Guide

No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical for any purpose, without the express written permission of Circon Systems Corporation. Companies, names, and data used in examples in this user guide are fictitious unless otherwise noted. All specifications, dimensions and illustrations comply with product design and materials used as of the date of publication. The right to make changes to product design and material used, without notice, is reserved. Circon and the Circon logo are trademarks of Circon Systems Corporation. Windows is a registered trademark of Microsoft Corporation in the United States and other countries. Echelon, LNS and i.LON are registered trademarks of Echelon Corporation. LONMARK and the LONMARK logo are managed, granted and used by LONMARK International under a license granted by Echelon Corporation. Document 800263 Revision 3.7 October 2006. 2006 Circon Systems Corporation. All rights reserved. Printed in Canada

Contents
Chapter 1 Getting Started................................................................................1
Package contents and system requirements Registering the Visual Integrator 3 license Starting Visual Integrator 3 Changing the administrative password 1 1 3 3

Chapter 2 A Quick Tour of Visual Integrator 3 ................................................5


Introducing Visual Integrator 3 Introducing license options Recommended computer requirements Introducing network connectivity options Introducing the Visual Integrator 3 user interface Main steps to create a fully functional operator workstation 5 7 8 9 21 25

Chapter 3 Working with Customers and Sites ...............................................27


Main steps in creating a customer and site Using the Site Management utility Creating a new customer Creating a new site Configuring a site introduction Configuring the sites network interface Configuring the sites network database Configuring the site management mode Configuring the dialup SLTA or SMC300 network interface Configuring the i.LON 10/100 network interface Configuring the dialup iLON network interface Configuring administrator permissions Configuring data logging Configuring the time synchronization service Opening and connecting to a site Installing plugin software 27 28 28 30 31 32 34 35 36 40 43 44 45 45 46 48

Chapter 4 Working with Visual Integrator Documents ..................................49


What documents are Adding documents to a site 49 53

Document Number 800263 Revision 3.7

Contents

Chapter 5 Working with Graphics Editor and Control Objects.......................67


Working with Graphics Editor Understanding the Graphics Editor window Working with control objects 67 68 73

Chapter 6 Control Objects Reference ............................................................81


Working with object properties Control object reference Using Visual BASIC MiniEditor and Script Wizard Displaying units of measure 81 84 157 159

Chapter 7 Creating a HMI a Tutorial.........................................................161


Main steps in creating an HMI with Visual Integrator 3 Determining an operators needs Designing the interface structure Implementing the interface structure Creating the site home document Creating a Subsystem document with floor plan Adding a device document Adding hyperlinks to enhance navigation Conclusion 161 161 162 162 164 173 178 185 190

Chapter 8 Creating a Custom Device Document..........................................191


Creating a custom device document Creating a custom device document template Adding a device document from a custom device document template 191 199 202

Chapter 9 Using Document Wizard .............................................................205


Verifying and adding device templates Reviewing, editing and adding document templates Associating documents with a device or functional block template Running Document Wizard 206 207 208 209

Chapter 10 Logging and Viewing Data........................................................211


Configuring devices for data logging Configuring Visual Integrator 3 for data logging Viewing logged data Viewing trend plots Viewing events Viewing runtime and startup count data Archiving logged data and managing hard drive space 212 213 221 222 232 236 240

ii

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Chapter 11 Logging and Viewing Alarms ....................................................243


Network connectivity options for alarming Setting up alarm logging Viewing and managing alarms using Alarm Log Viewer Acknowledging and clearing alarms Configuring mandatory comments when managing alarms Viewing alarms using the CirconAlarm object Alerting the operator with Alarm Notifier Using email to send alarm messages Logging alarms to a line printer Customizing builtin alarm translations Creating alarm codes Using alarm reports Archiving alarms and managing hard drive space 244 250 266 272 275 276 276 279 286 288 293 293 294

Chapter 12 Using Network Scheduler ..........................................................295


Scheduling concepts Network Scheduler concepts The steps in configuring a schedule Creating a new schedule Importing a new schedule Configuring schedule properties Adding a schedule event to a schedule Prioritizing overlapping events Exporting a schedule Synchronizing devices with a schedule Verifying device synchronization with the activity log Deploying a PCresident schedule Schedules report Schedule document 295 297 299 300 301 303 306 311 313 313 317 317 318 318

Chapter 13 Using Reports ...........................................................................319


Generating a report using Site Management Generating a report using Documents Activity report Alarm report Operator groups report Runtime report Schedules report Operators report Exporting data from a report 319 319 320 321 322 322 322 322 323

Document Number 800263 Revision 3.7

iii

Contents

Chapter 14 Securing Access to a Site ...........................................................325


Managing operators Managing operator groups Setting site permissions for an operator group 326 332 336

Chapter 15 Using Network Editor................................................................339 Chapter 16 Testing and Verifying Devices...................................................341


What needs to be tested? Verifying and testing router operation Verifying and testing device operation 341 342 346

Chapter 17 Maintaining a Site and Network................................................353


Resynchronizing device configuration properties Replacing a device Updating a device Resynchronizing a device with its device template Moving a device Renaming a device Deleting a device Commissioning a device Decommissioning a device Backing up a network database Restoring a network database from LonMaker backup Backing up a site Restoring a site from back up Maintaining the SQL database Backing up the SQL database Restoring the SQL database from backup Archiving the SQL database Purging logged data from the SQL database Managing and troubleshooting scheduled tasks Copying the SQL database to another computer 354 355 358 360 360 362 362 362 363 363 366 369 372 374 374 375 376 377 377 378

Chapter 18 Setting up Visual Integrator 3 as server and workstations .........379


Main steps in setting up Visual Integrator 3 workstation Configuring the server computer Configuring the workstation computer 380 381 389

Index ...........................................................................................................395 Document History .......................................................................................405

iv

Document Number 800263 Revision 3.7

Chapter 1 Getting Started

elcome to Visual Integrator 3 the complete operator workstation system for LonWorks technology and LNS serverbased facility automation systems.

Visual Integrator 3 is a HumanMachine Interface (HMI) designer, a Graphical User Interface (GUI) editor, scheduler, alarm monitor and notifier, trend data logger and trend plotter, network and device maintainer, and report generator rolled into one package. You can use this versatile application to design simple user interfaces for building operators or to implement a central monitoring station for multiple local and remote sites or anything in between. And its secured by passwordprotected operator accounts.

Package contents and system requirements


The Circon Visual Integrator 3 software package consists of the Visual Integrator 3 CD and this user guide. The Visual Integrator 3 CD contains everything you need to install and run the Visual Integrator 3 application including the Visual Integrator 3 installer, Microsoft SQL Server 2005 Express Edition installer, LNS Server Turbo Edition installer, LonWorks drivers and Adobe Acrobat installer. For information about the software and hardware you need to use Visual Integrator 3, see the release notes file on the CD.

Installing Visual Integrator 3


You must install the application from the Circon Visual Integrator 3 CD onto your hard disk; you cant run the application from the CD. Installation instructions are available in the release notes file on the CD.

Registering the Visual Integrator 3 license


To activate Visual Integrator 3 after it is installed, it must be registered with an appropriate license. Visual Integrator 3 supports the following licensing options:
Single site, 10 devices Single site, 64 devices Single site, 128 devices Multiple sites, unlimited devices Network Editor addon Alarming and Trending (data logging) addon

Document Number 800263 Revision 3.7

Chapter 1 Getting Started To register a license for Visual Integrator 3: 1 Choose Start > Programs > Circon > Visual Integrator > License Registration. 2 The License Registration dialog is displayed:

3 Read and follow the instructions on the License Registration dialog to complete the registration process. 4 Display the license registration dialog again to confirm that Visual Integrator 3 is registered appropriately for its intended application. The example below shows Visual Integrator 3 as licensed for single site, 10 devices.

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Starting Visual Integrator 3


You can start Visual Integrator 3 just as you would any application. Visual Integrator 3 must have a registered licensed before it will start. Visual Integrator 3 indicates that it is not licensed by displaying this dialog:

To start Visual Integrator 3: 1 Choose Start > Programs > Circon > Visual Integrator > Visual Integrator. 2 After the application starts, the Login dialog is displayed:

3 Enter Administrator for the username and circon for the password, and then click OK.

Changing the administrative password


It is recommended that you change the Administrator password after you log in for the first time.
To change the administrative password: 1 Choose Tools > Change Password. The Change Password dialog is displayed:

2 Type the current administrative password in the Old password box.

A password can consist of numbers, letters, oddball characters such as @, #, $, or a combination thereof. The minimum password length is one character, and the maximum is 25 characters. A password is case sensitive.
3 Type the new administrative password in the New password box. 4 Type the new password in the Confirm Password box.

Document Number 800263 Revision 3.7

Chapter 1 Getting Started 5 Click Ok. The next time you log in as the administrator, use the new password.

IMPORTANT: To help you remember the new password, write it down and store it in a secure place.

Document Number 800263 Revision 3.7

Chapter 2 A Quick Tour of Visual Integrator 3

his introduction to Visual Integrator 3 provides a quickread overview of the key features of the application. To find complete information about any feature, see the index at the end of this user guide.

Introducing Visual Integrator 3


HumanMachine Interface designer
Visual Integrator 3 allows you to create custom HMIs crafted to meet the exact needs of your customers. As a Windows 2000 and Windows XPbased application it leverages user experience with the standard Windowsbased presentation format and navigation with the familiar Windows Explorer tree view. You can combine graphics, text, animation, hyperlinks, Web pages with alarm logs and trend plots all on one screen.

Graphical User Interface (GUI) editor


Visual Integrator 3 includes Graphics Editor which allows complete freedom to create custom equipment views based on an existing set of graphics. A builtin Document Wizard generates graphics for any device quickly and automatically. The builtin graphics library reduces development time and its ActiveX controls with configurable properties enhance graphics usability. Graphics Editor allows you to create graphics for Circon and other manufacturers LonWorks based devices.

Scheduler
Visual Integrator 3 includes Network Scheduler which provides an intuitive enduser interface to create and maintain schedules for all devices on the network. Multiple devices can be combined into arbitrary and logical groups, allowing the same schedule to be assigned and synchronized in one operation with no limit to the number of groups or schedules which can be created.

Alarm monitor and notifier


Visual Integrator 3 includes comprehensive and reliable alarm monitoring and notification features. Alarms are annunciated immediately by Alarm Log Viewer when received and can be forwarded immediately by email if required. Alarms may be acknowledged and cleared by an authorized operator. Custom alarm views can be designed based on customer, site, priority and alarm state.

Document Number 800263 Revision 3.7

Chapter 2 A Quick Tour of Visual Integrator 3

Trend data logger and trend plotter


Visual Integrator 3 can log trend data continuously from Circon devices and store that data providing historical trend information. Use Log Viewer to configure profiles of filtered data and display data plots with multiple I/O points per chart. The charts can be customized with colors, title, and legend. Information is stored in SQL database for easy access and enterprise level information export. Visual Integrator 3 can also log events and runtime data.

Network and device maintainer


Visual Integrator 3 can launch LNS plugins associated with devices, and perform many network maintenance tasks such as loading device applications, replacing devices that fail, and moving devices to other network channels. Use Network Editor to create and edit LNS networks/databases, commission devices, make connections between network variables, create channels Network Editor is a full function network management tool. Network Editor is a separatelypurchased and licensed feature of Visual Integrator 3. Use the Inspector document to view and change network variables and configuration properties when an LNS plugin is not available for a device.

Report generator
Visual Integrator 3 includes standard reports that present data in tabular format. You can tailor report content with flexible filtering options and print reports on any networked Windows supported printer.

Passwordsecured operator access


Visual Integrator 3 allows you to create operators and assign sitelevel permissions which restrict access to functions. Access by unauthorized operator is prevented by username and password security check. Operator actions are logged in audit trail SQL database.

LNSserver based
Visual Integrator 3 is the complete operator workstation system for LonWorkstechnology and is fully integrated with Echelon Corporations LNS Turbo Server. This allows you to launch LNS device plugins for Circon and other manufacturers devices to allow configuration and detailed device diagnostics, perform networklevel diagnostics, restore database backup created in Echelons LonMaker for Windows file format.

LonWorks network connection alternatives


Visual Integrator 3 leverages the multiplicity of connectivity options of the LNS system for connecting to the LonWorks network. Visual Integrator 3 connects to a network using the services of LNS. Connections can be persistent or temporary over a range of media: twisted pair,

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Ethernet, LAN, WAN, the Internet or public standard telephone networks to a site in the same building or around the world. Connectivity options are described in detail later in this section.

Introducing license options


Circon provides the Visual Integrator 3 licensed product in three devicelimited tiers, an unlimited devices tier and with optional addon features. The devicelimited tiers allow access to one site only through a persistent connection; the unlimited devices tier allows access to multiple sites through persistent or temporary connections. Device in this sense means the number of commissioned and uncommissioned controllers, made by any manufacturer, in the sites LNS network database. Routers, LNS network interfaces and network service devices are not included. The two licensed addon features are Network Editor and Alarming and Data Logging. The Alarming and Data Logging feature must be licensed to Visual Integrator 3 that resides on the same computer as the LNS Server.
To determine the current licensing of a Visual Integrator 3 installation: Open the License registration dialog as follows: Choose Start > Programs > Circon > Visual Integrator > License Registration. Licensed options are listed on the dialog.

Additional product options include the number of LNS Server device credits included. This choice depends on how you plan to deploy the network. If you create the database elsewhere using device credits included in another software package, you should select the Visual Integrator 3 product with the one device credit LNS Server and import the database. Alternatively, should you plan to use Network Editor to implement the database, then the 64 credit LNS Server is recommended. In either case, device credits can always be added after installation of Visual Integrator 3. When access to the site by more than one computer running Visual Integrator 3 is required, only one computer, the Visual Integrator 3 server, holds the SQL database and LNS Server with the site databases. The other computers act as remote workstations and require Visual Integrator 3 with the one device credit LNS Server, accessing the SQL database and LNS Server on the Visual Integrator 3 server, over a TCP/IP network. See Chapter 18 for detailed information about this server and workstation architecture. The illustration below shows a typical usage of Visual Integrator 3:

Document Number 800263 Revision 3.7

Chapter 2 A Quick Tour of Visual Integrator 3

Relationship of Visual Integrator 3 with SQL database and LNS Server and optional addons

Recommended computer requirements


Operating System: Windows XP or Windows 2000 LNS Server Turbo Edition Microsoft SQL Server 2005 (Express Edition is included; Enterprise, Standard, or Workgroup Edition recommended when saved logged data is expected to be greater than 4GB) Processor: Intel Pentium IV, 1 GHz or higher Memory: 256 MB RAM minimum, 512 MB recommended Hard drive: 7200 rpm minimum, 2 GB minimum free disk space Disk controller interface: ATA100 minimum, UltraWide SCSI or Ultra2Wide SCSI recommended for large, busier networks Display: video card and monitor capable of displaying 1024 X 768 pixel resolution Writable DVD for backups is recommended

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

LonWorks network interface Network interface card (NIC): Ethernet

Recommended platform requirements for Visual Integrator 3 as remote workstation


Operating System: Windows XP or Windows 2000 LNS Server 3 1 device credit Processor: Intel Pentium III, 500 MHz or higher Memory: 256 MB RAM recommended Hard drive: 300 MB minimum free disk space Display: video card and monitor capable of displaying 1024 X 768 pixel resolution Network interface card (NIC): Ethernet

Introducing network connectivity options


Using Visual Integrator 3, the operator opens a site and connects to its LonWorks network. When Visual Integrator 3 opens a site it establishes a link or connection as a client to the LNS server and opens the network database associated with the sites LonWorks network. When Visual Integrator 3 connects to the sites LonWorks network it requests the LNS server to attach or establish a connection via a network interface to the sites LonWorks network. A network interface is defined technically as the software driver and hardware that provide the PC to LonWorks network interface. It includes an adapter with transceivers that are compatible to the type of physical LonWorks network to which it is attached. There is a variety of network interfaces to choose from, shown in the illustrations later in this section. Establishing the connection to the sites LonWorks network is the responsibility of the LNS server; Visual Integrator 3 leverages the richness of the LNS server connectivity options to allow you the maximum flexibility in determining where to locate the Visual Integrator 3 computer in relation to the sites LonWorks network and in selecting the appropriate network interface. Visual Integrator 3 supports two types of connections, persistent and temporary, which correspond to two types of site topologies: local and remote. It is important to understand these concepts before deciding how you will employ Visual Integrator 3 to connect to your networks. The next sections of this chapter describe and illustrate these concepts.

Local and remote site defined


Typically, the connection to the sites LonWorks network is established once and remains established for as long as the operator has the site open or for as long as alarm logging and data logging services are running. This type of connection is called a persistent connection and the site is referred to as a local site. A local site is characterized by the use of a persistent connection to the site although the site can be physically located anywhere. With a persistent connection, the LNS server automatically and silently attempts to reestablishes the connection should it inadvertently malfunction. Alarm logging and data logging are performed by services that establish and

Document Number 800263 Revision 3.7

Chapter 2 A Quick Tour of Visual Integrator 3

maintain persistent connections to the site. A Visual Integrator 3 service is a Windows program that runs independently of any application and continues to run regardless if Visual Integrator 3 is running and if any operators are logged in. Alarm and data logging is a separatelylicensed option of Visual Integrator 3. Alternatively, Visual Integrator 3 and the LNS server support a temporary type of connection when licensed as multisite, unlimited devices. An operator opens a site and establishes the connection, performs monitoring and other site management tasks and then closes the site to disconnect, or alarm logging and data logging applications establish a connection, perform logging functions and then disconnect. This type of connection is called a temporary connection and the site is referred to as a remote site. Remote sites are characterized by the use of a temporary connection to the site. The site can be physically located anywhere but is typically physically remote and is accessible over public standard telephone networks or over a LAN, WAN or the Internet. In the case of data logging the temporary connection is initiated by the remote data logger service and application; in the case of alarm logging, a device such as the SMC300 on the sites LonWorks network initiates a temporary connection with the remote alarm log service. Alarm and data logging is a separatelylicensed option of Visual Integrator 3. The local site and remote site connectivity options available via the LNS server are described briefly below. Detailed descriptions of data and alarm logging connectivity can be found in Chapters 10 and 11 respectively.

Connecting to multiple sites


Visual Integrator 3 can be used to implement a central monitoring and control operator workstation for multiple sites when licensed as multisite, unlimited devices. Each site is an autonomous LonWorks network represented by its own network database stored in the LNS Server. Either a local site persistent connectiontype topology or a remote site temporary connectiontype topology can be implemented, or a combination of both. You should consult Circon Technical Support about any limitations to the number of sites to ensure it meets your needs, prior to selecting you multisite topology.

Local sites and persistent connections


The options for local sites using persistent connections are as many as the network interfaces available. Persistent connections can be used to connect to networks that are in the same location as the computer running Visual Integrator 3, or to networks that are physically remote, located anywhere in the world. Common network interfaces, manufactured by Echelon Corporation, that can be used with local sites are:
U10 USB interface PCLTA20, 21 personal computer LonTalk adapter card for PCI slots PCC10 personal computer LonTalk adapter card for laptop computers i.LON 10/100 or equivalent remote network interface used with computers Ethernet card

10

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

i.LON 600 or equivalent virtual network interface used with computers Ethernet card

Similar products are available from other manufacturers. The illustrations below show several typical persistent network connection options.
Local site using a PCLTA20, 21 or PCC10 network interface In this example the network interface is a PC card and driver software installed in the Visual

Integrator 3 computer. The LonWorks network is attached directly to the network interface PC card.

Local site using a PCLTA20, 21 or PCC10 network interface

Local site using an i.LON 10, i.LON 100 or equivalent network interface In this example the network interface is in the i.LON 10 or i.LON 100. The Visual Integrator 3 computer uses its Ethernet card and Remote Network Interface(RNI) software to communicate

with the i.LON 10/100 over a LAN, WAN or the Internet.

Local site using an i.LON 10, i.LON 100 or equivalent network interface

Document Number 800263 Revision 3.7

11

Chapter 2 A Quick Tour of Visual Integrator 3

Typical campus or multistory facility using the i.LON 600 or equivalent network interface In this example the network interface is in the i.LON 600. The Visual Integrator 3 computer uses

its Ethernet card and Virtual Network Interface(VNI) software to communicate with the i.LON 600 over a LAN, WAN or the Internet. The LonWorks network is attached directly to the i.LON 600. An i.LON 1000 can also be used. Unlike the i.LON 10/100, the i.LON 600 has the additional capability of being a LonTalk over IP router. This allows you to integrate multiple, physically separated LonWorks channels into a single network by connecting the channels over a TCP/IP backbone, as illustrated below.

Typical campus or multistory facility using the i.LON 600 or equivalent network interface

12

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Multiple sites using local site persistent connectiontype topology In the example below, the network interface could be any of the i.LON or equivalent products;

however the i.LON 10 as illustrated is the least expensive. Unlike the i.LON 600, the i.LON 10/100 is not a LonTalk over IP router, so each LonWorks network connects as a separate site. Visual Integrator 3 alarm and data logging services can sustain multiple persistent connections to i.LON10/100s up to a maximum number of sites determined by LNS performance limitations. Consult Circon technical support for assistance when considering this multisite topology. This same topology can also be used as a remote site topology with an increase in the total number of sites supported. Multiple sites using remote site topology are described later in this section.

Multiple sites using an i.LON 10, i.LON 100 or equivalent network interface. The connections are persistent; the alarm logger and data logger services are used.

Remote sites and temporary connections


Visual Integrator 3 supports several options for remote sites using temporary connections. Temporary connections are used to connect to networks that are physically remote from the computer running Visual Integrator 3. Common network interfaces used with remote sites are:
modem and SMC300 network interface modem and SLTA10 network interface i.LON 10/100 or equivalent remote network interface used with computers Ethernet card modem and i.LON 10/100 or equivalent remote network interface

Remote network connection options are illustrated below:

Document Number 800263 Revision 3.7

13

Chapter 2 A Quick Tour of Visual Integrator 3

Remote site using SMC300 network interface In this example the network interface is in the Circon SMC300. The Visual Integrator 3

computer uses its COM port, the modem and the SLTALink Manager software to communicate with the builtin modem in the SMC300 over a public standard telephone network. The LonWorks network is attached directly to the SMC300. In addition to its remote connection capability, the SMC300 provides a rich set of features to support site monitoring, alarm logging and automatic dialin to the Visual Integrator 3, making it an ideal choice for remote networks.

Remote site using SMC300 network interface

Remote site using SLTA10 network interface In this example the network interface is in the Echelon SLTA10 or equivalent. The Visual Integrator 3 computer uses its COM port, the modem and the SLTALink Manager software to

communicate with the external modem connected to the SLTA10 over a public standard telephone network. The LonWorks network is attached directly to the SLTA10.

Remote site using SLTA10 network interface

14

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Remote site using an i.LON 10, i.LON 100 or equivalent network interface In this example the network interface is in the i.LON 10 or i.LON 100. The Visual Integrator 3

computer uses a modem and TCP/IP via PPP to communicate with the i.LON 10/100 over a public standard telephone network. IMPORTANT: The connectivity option illustrated below does not support automated remote data logging or remote site alarm dialin. It is recommended that you use a WAN or the Internet rather than the public standard telephone network if you require these capabilities.

Remote site over PPP using an i.LON 10, i.LON 100 or equivalent network interface

In the following example the network interface is in the i.LON 10 or i.LON 100. The Visual Integrator 3 computer uses its Ethernet card and Remote Network Interface(RNI) software to communicate with the i.LON 10/100 over a WAN or the Internet. IMPORTANT: The connectivity option illustrated below fully supports automated remote data logging or remote site alarm dialin.

Remote site using an i.LON 10, i.LON 100 or equivalent network interface

Document Number 800263 Revision 3.7

15

Chapter 2 A Quick Tour of Visual Integrator 3

Multiple sites using remote site temporary connectiontype topology In this example, the network interface must be an RNItype network interface as found in the

i.LON 10 and i.LON 100. Each LonWorks network connects as a separate site. Alarm and data logging capabilities for this topology are described later in this chapter.

Multiple sites using an i.LON 10, i.LON 100 or equivalent network interface. The connections are temporary.

16

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Multiple sites using remote site temporary connectiontype topology In this example, when an alarm occurs on any site, the SMC300 resident at the site dialsin to

the Visual Integrator 3, establishes a temporary connection, delivers the alarm and disconnects. To support data logging, Visual Integrator 3 is configured to connect to each site at its scheduled day and time, upload the data and disconnect.

Multiple sites using SMC300 network interface. The connections are temporary; the SMC300 is used to buffer and forward alarms. Visual Integrator 3 remote data logger connects periodically to log trend data.

Alarm logging and data logging options


In addition to a custom HMI for an operator to use when accessing a site, Visual Integrator 3 provides fully featured alarm logging and data logging capabilities as a licensed addon. Alarms are generated by devices to report an important problem that you would like your site operator to be notified of immediately. Data is logged over time so that you can do historical trending for ongoing site monitoring and maintenance. Alarm logging and data logging can occur whether or not an operator is logged on the Visual Integrator 3 and has the site open. As well, when multiple sites are being monitored, alarms and data are logged for all sites. With Visual Integrator 3, alarm logging and data logging meet all of the above requirements, albeit differently for local sites with persistent connections and remote sites with temporary connections. Alarm logging and data logging capabilities are described briefly below. Refer to Chapters 10 and 11 for complete information about data logging and alarm logging capabilities.

Document Number 800263 Revision 3.7

17

Chapter 2 A Quick Tour of Visual Integrator 3

IMPORTANT: the alarming and data logging addon must reside with Visual Integrator 3 on the same computer as the LNS Server.
Local site alarm logging and data logging For local sites with persistent connections, Visual Integrator 3 provides Windows services.

Services are software applications that run unattended without a user interface whether or not Visual Integrator 3 is running. These services connect silently through the LNS server to local sites to receive alarms and to log trend and event data from devices on the LonWorks networks. Because the connection is persistent, the services are always connected to a site; alarms are received immediately and data is logged at configurable timer intervals.
Remote site alarm logging and data logging For remote sites with temporary connections, Visual Integrator 3 provides two software applications that run periodically when a connection with the site is established. To implement

alarm logging, a SMC300 is required on the sites LonWorks network. The SMC300 gathers alarms from other devices and initiates a temporary connection to the Visual Integrator 3 to report the alarms. Remote data logger software provided with Visual Integrator 3 is scheduled to periodically establish a temporary connection to a site and transfer the data that has accumulated in the devices trend and event logs to the Visual Integrator 3 SQL database.

Circon Services
A Circon service is a Windows program that runs independently of any application and continues to run regardless if Visual Integrator 3 is running and if any operators are logged in. Visual Integrator 3 provides eight services that it uses to implement capabilities such as alarm and data logging in the background while the operator is either logged out or is working with other features. These services run on the server when you are implementing Visual Integrator 3 on workstations as well. The Circon Service Manager is provided to assist in managing Circon services. By way of introduction, here is a list and brief description of the Visual Integrator 3 services: Local Synchronization service: maintains consistency between the local LNS network database and the other services. It also provides time synchronization service and PCresident scheduling service for devices on the LonWorks network. The Local Synchronization service is started automatically whenever any of the other Circon services are started. When this service is stopped, all other Circon services are stopped. When this service is stopped, a highpitched confirmation beep is sounded by the PCs builtin speaker. Email Notification service: interfaces between the alarm log and the SMTP email server to enable alarms to be emailed to any emailenabled device. See Chapter 11 Logging and Viewing Alarms for details. Alarm Printer service: interfaces between the alarm log and a local or networked line printer to enable alarms to be printed. See Chapter 11 Logging and Viewing Alarms for details.

18

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Local Alarm Log service: receives alarms from devices over a local, persistent connection and transfer them to the alarm log database. See Chapter 11 Logging and Viewing Alarms for details. Local Data Logger service: uploads trend and event data on a scheduled basis from designated Circon devices over a local, persistent connection and transfer that data to the data log database. See Chapter 10 Logging and Viewing Data for details. RAS Dialup service: used in conjunction with remote services when connecting to sites via a modem. Remote Alarm Log service: receives alarms from devices over a remote, temporary connection and transfer them to the alarm log database. See Chapter 11 Logging and Viewing Alarms for details. Remote Data Logger service: establishes a remote, temporary connection to a site on a scheduled basis, uploads trend and event data from designated Circon devices, transfers that data to the data log database and then disconnects from the site. See Chapter 10 Logging and Viewing Data for details.
Time synchronization service The time synchronization capability of Visual Integrator 3 allows you to synchronize the date and time of any LonWorks device with the local time of the server computer running Visual integrator

3. That computer, in turn, can be synchronized over its LAN, WAN, or the Internet to a reliable, accurate time source. To ensure the devices on the LonWorks network continue to maintain synchronization when the computer is not running or is disconnected from the LonWorks network, it is recommended that a single device is assigned the master time keeper role, and it alone is timesynchronized with the computer. That device, in turn through network variable connections, performs the task of synchronizing the other devices. Ideally, the master time keeper device has a hardware clock chip with battery backup to sustain the clock through power interruptions (the Circon UHC320 is such a device). A network variable of type SNVT_time_stamp on the LNS network interface is used to connect the Visual Integrator 3 local synchronization service to the date and time override input network variable on the master time keeper device. The service updates the network variable every 30 seconds. IMPORTANT: The computers local time is used to synchronize the devices. The local time is the time displayed by the Settings>Control Panel>Date/Time Properties dialog. When that time is adjusted manually or by external synchronization or due to daylight savings switchover, the time sent to the devices also changes.
To configure time synchronization: 1 Create the time synchronization network variable on the LonWorks network interface 2 Create the connection from the computer to the master time keeper device 3 Create the connections from the master time keeper device to other devices 4 Restart the Local Synchronization service, using Circon Service Manager

Document Number 800263 Revision 3.7

19

Chapter 2 A Quick Tour of Visual Integrator 3 5 Set up time synchronization of the computer (optional)

Steps 1, 2 and 3 require a network management tool to be used. See the network management tool documentation for a description of how to perform these operations.
Circon Service Manager The Circon Service Manager provides a convenient interface for managing Circon services. It allows you to start and stop Circon services and to determine their status. It also allows you to

configure the service to start automatically when Windows starts. Doing so ensures the service is always running when it is needed without the operator having to remember to start it.
To open the Circon Service Manager, click the button on the Visual Integrator 3 tool bar.

To start a Circon service: 1 Check the box adjacent to the service to allow Windows to start the service automatically when it restarts. 2 Click on the service name to select it. 3 Click Start to start the service now. Wait until the Status for the service changes to Started.

20

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Introducing the Visual Integrator 3 user interface


Leveraging the standard windows presentation format and navigation with the familiar Windows Explorer tree view, the Visual Integrator 3 user interface combines graphics, text, hyperlinks, Web pages with alarm logs and trend plots all on one screen. Visual Integrator 3s interface window consists of several window components: TreeView, Document View, Alarm Log Viewer the tool/menu bar and the status bar. A typical custom interface is shown below:

C TreeView
TreeView displays a hierarchical treelike structure of the customer and sites, subsystems and devices that allows navigation similar to the familiar Windows Explorer.

D DocumentView
DocumentView displays a custom GUI, referred to as a document in Visual Integrator 3, selected in the TreeView.

Document Number 800263 Revision 3.7

21

Chapter 2 A Quick Tour of Visual Integrator 3

E Alarm Log Viewer


Alarm Log Viewer displays alarms received by Visual Integrator 3 and allows authorized operators to acknowledge and clear alarms. Alarm Log Viewer can be hidden from view if this capability is not required.

A Toolbar
The toolbar provides quick singleclick access to the important functions of Visual Integrator 3. The function of each button is outlined below.

Button
Back Forward Refresh New Document Print Graphics Editor Cut Copy Paste Delete Properties Close Site Network Editor Network Scheduler Manage Sites Log Viewer Access Integrator Service Manager

Description
Moves back to the previously selected document If you just used Back, you may use Forward to move to the document you had selected before you used Back. Refreshes DocumentView. Opens the Add Document dialog to add a document to site. Prints selected document Launches Graphics Editor Cuts the selected object(s) and places on clipboard Copies the selected object(s) and places on clipboard Pastes object on clipboard into a document Deletes the selected object(s) Displays document properties Closes the selected site and selects My Customers in TreeView Launches Network Editor to view or change the LNS database Launches Network Scheduler to set schedules and apply device(s) to a schedule Launches Site Management which enables you to set up Operators, Operator Groups, Site Properties, Permissions Launches Log Viewer Launches Access Integrator ( visible only if Access Integrator is installed and licensed) Launches Circon Service Manager to display the status of Circon services. Use Service Manager to start and stop Circon services.

22

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

B Menu
The menu bar provides alternative access to all functions of Visual Integrator 3. The function access by each button is outlined below.
File Use the File menu to apply these functions to site you are viewing Graphics Editor New Document Delete Rename Properties Print Document Wizard Exit Ctrl+P Ctrl+N Del Opens Graphics Editor to edit displayed document Opens the Add Document dialog to add a document to site Delete displayed document Rename displayed document in TreeView Displays properties of displayed document Print portion of document displayed in DocumentView Opens the Document Wizard tool. See Chapter 9 Using Document Wizard Disconnect from site and LNS server, and close Visual Integrator 3

Edit

Use the Edit menu to manipulate displayed document Cut Copy Paste Ctrl+X Ctrl+C Ctrl+V Removes displayed document from TreeView to clipboard Copies displayed document from TreeView to clipboard Pastes document from clipboard to TreeView

View

Adjust the components displayed in Visual Integrator 3 window Toolbar Status Bar Alarms Filter Alarms Refresh Alarms Refresh Document F5 Adds and removes Toolbar Adds and removes Status bar Adds and removes Alarm Log view When Alarm Log is displayed, Filter Alarms opens the Alarm Log properties dialog. Refresh the Alarm Log view. Refresh displayed document

Tools

Provides access to important tools Documents Dialup Options Opens the Document Templates dialog Visible only if SLTALink Manager software is installed.

Document Number 800263 Revision 3.7

23

Chapter 2 A Quick Tour of Visual Integrator 3

Tools

Provides access to important tools Manage Sites Network Opens the Site Management utility. Only operators who are members of the administrators group have access. Provides access to several tools related to the network: Properties network properties Editor opens Network Editor ( visible only if Network Editor is licensed) Scheduler opens Network Scheduler Configure Logging select the devices data is logged from Local Translations view / edit local event code translations Options Log Viewer Access Integrator Service Manager Scheduled Tasks Change Password Opens the Options dialog Launches Log Viewer Launches Access Integrator ( visible only if Access Integrator is installed and licensed) Launches the Circon Service Manager Launches the Circon Task Scheduler. Visible only if operators Windows account is a member of the administrators group Opens the Change Password dialog

Help

Gain access to user guide and information about software versions Contents License Registration About LNS Server About Visual Integrator Opens this user guide and Adobe Acrobat viewer Displays Circon software license registration dialog Displays version number of LNS server Displays version number of Visual Integrator 3 and the Microsoft SQL Server

F Status Bar
The status bar displays operator and network connectivity status as described below.

24

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

A = Operators username B, C = PCs date and time, displayed in the format determined by Windows Regional Settings D = Management Mode, Management mode determines how the LNS server interacts with the
devices on the LonWorks network when an operator makes changes to device configuration properties. When management mode is set to OffNet, the operators changes are stored in the LNS network database as they are made, but they are not propagated across the network to the device. When management mode is set to OnNet, the operators changes are stored in the LNS network database and they are propagated immediately to the devices, as the changes are made.

E = Network connection as connected (shown) or disconnected F = LNS Server attachment

Main steps to create a fully functional operator workstation


The following steps outline the typical approach to creating a fully functional operator workstation using Visual Integrator 3. Normally, the LNS network database already exists, having been created by a network management tool such as Circons Network Integrator 3 or Echelons LonMaker. Alternatively, you can create the network database using Visual Integrator 3s Network Editor. Main steps to create a fully functional operator workstation:
1 2 3 4 5 6 Configure the customer and site see Chapter 3 Working with Customers and Sites Create the HMI see Chapter 7 Creating an HMI a Tutorial Create schedules see Chapter 12 Using Network Scheduler Set up data logging and trending see Chapter 10 Logging and Viewing Data Set up alarming see Chapter 11 Logging and Viewing Alarms Secure access to the site see Chapter 14 Securing access to a site

Document Number 800263 Revision 3.7

25

Chapter 2 A Quick Tour of Visual Integrator 3

This page is left blank intentionally.

26

Document Number 800263 Revision 3.7

Chapter 3 Working with Customers and Sites

he first step in creating a functional operator workstation is to create a customer and a site. Customer and site are Visual Integrator 3 concepts that allow hierarchical approach to managing multiple sites with one interface.

A customer represents the owner of one or more facility automation systems. Visual Integrator 3 allows you to create multiple customers with names you choose, each with multiple facility automation systems. A site represents the facility automation system the LonWorks network and devices that reside in the facility to implement the facility automation system. Visual Integrator 3 allows you to create multiple sites for each customer with names you choose. The site as represented by the HMI is typically based on the underlying LNS network database. You must create one customer and one site as the first step to creating the HMI. In this guide an example customer named ABC Company and example site named Facility A is used. Visual Integrator 3 uses this customer/site hierarchical structure to manage the various sites and provide an intuitive windowslike navigation structure for the end user.

Main steps in creating a customer and site


This chapter describes all of the following steps.
1 2 3 4 5 6 7 8 9 10 Create a customer Create a site for the customer Configure the sites units of measure Configure the sites network interface Configure the sites LNS network database Set the sites management mode Configure the sites remote connectivity if site is remote Configure administrator permissions for site Opening the site for the first time Installing plugin software (optional)

Document Number 800263 Revision 3.7

27

Chapter 3 Working with Customers and Sites

Using the Site Management utility


The Site Management utility is used to add, delete and modify the customers, sites, operator groups, and operators. Only operators who are members of the Administrator group are granted access to this utility. The default operator, created when Visual Integrator 3 is installed, is a member of the Administrator group.
To open the Site Management utility 1 Log in to Visual Integrator 3 as a member of the Administrator group. 2 Choose Tools > Manage Sites or click the Site Management button on the toolbar. The Site Management window is displayed:

The left pane provides a treeview navigation structure that lists all the capabilities of Visual Integrator 3 that are the purview of operators who are members of the Administrator group. The right pane expands a selected item. By right clicking in the white space of the right pane you choose the view that suits you best.

Creating a new customer


To add a new customer: 1 Open the Customers folder in the right pane of the Site Management window. 2 Rightclick in the blank area of the right pane, and select New Customer from the popup menu. The New Customer dialog is displayed.

28

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 In the Name field, enter a name for the customer that owns the sites you will be creating.

4 The textbox labelled Store files in: specifies the location for where the customer folder will be located. The customer folder is used to store information about the HMIs for this customer, or project, and any site folders belonging to it. Visual Integrator 3 automatically creates a new folder in the default folder C:\NI\FILES using the name provided in the Name field. The NI folder indicated in this default folder location refers to Circons Network Integrator 3 network management software tool which in this example was used to create the LNS network database for the sites. If you are using an alternative network management tool you may want to store Visual Integrator 3 files in the default folder for that tool. For example, Echelons LonMaker network management tool stores its files using the path C:\Lm\. 5 The Description field is used for a brief description of the customer. This field is optional and has no effect on the sites. 6 Click OK when done.

You can always modify the description for the customer by rightclicking on the customer icon and selecting Properties from the popup menu.

Renaming a customer
To rename a customer: 1 Rightclick the customer icon and select Rename from the popup menu. 2 Modify the name of the customer by entering a new name in the highlighted field. 3 Press the Enter key on your keyboard to complete the renaming.

Deleting a customer
If you want to delete the customer, you must first delete all sites belonging to the customer. Then you can click on Customers within Site Management, rightclick the specific customer in the right pane and select Delete from the popup menu.

Document Number 800263 Revision 3.7

29

Chapter 3 Working with Customers and Sites

Creating a new site


After defining the customer who owns the site, you now define the site. A site is a named facility automation system control network that belongs to the customer. For example, the Facility A building is a site belonging to customer ABC Company.
To create a new site: 1 Click the plus sign in front of the Customers folder in the Site Management window tree view pane to view the customers that have been created. 2 Click the plus sign in front of the specific customer. The Sites folder is displayed. This is where the customers sites are organized. 3 Select the Sites folder in treeview, rightclick in the blank area of the right pane, and select New Site from the popup menu. The New Site dialog is displayed. 4 Enter the name of the site. The location where the HMI files associated with this site are stored is indicated in the Store files in: text box. Visual Integrator 3 automatically creates a new folder under the customer folder using the site name provided in the Name field. See Creating a new customer earlier in this chapter for a description of how the path name to the customer folder is determined.

5 The Description field is used for a brief description of the network or site. This field is optional and has no effect on the site. 6 Click OK when done.

You can always modify the description for the site by rightclicking on the site icon and selecting Properties.

Renaming a site
To rename a site: 1 Rightclick the site icon or name in the right pane and select Rename from the popup menu. 2 Modify the name of the site by entering a new name in the highlighted field. 3 Press the Enter key on your keyboard to complete the renaming.

30

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Deleting a site
1 Rightclick the site icon or name in the right pane and select Delete from the popup menu. 2 An Are you sure? dialog is displayed. Click OK to delete the site. IMPORTANT: deleting the site in Visual Integrator 3 does not affect the site in the LNS database. It remains intact.

Configuring a site introduction


Configuring a site involves setting many properties for the site. Initially, the objective of configuring the site is to provide Visual Integrator 3 with sufficient information that it can open the site LNS database. The physical network and a connection via the network interface to the network are not immediately required. Once you can open the site LNS database, you can proceed to create its HMI. In cases of remote networks, there may be costs associated with connecting to the network which can be avoided during HMI development by working offline. You should familiarize yourself with the definitions of local and remote networks which described in Chapter 2 A Quick Tour of Visual Integrator 3. Opening a site and connecting or working offline are described later in this chapter.

Opening the site properties


After creating the site, you specify its properties using the site properties dialog.
To open site properties: Rightclick the site icon or name in the right pane and choose Properties from the popup menu. The site properties dialog is displayed:

Document Number 800263 Revision 3.7

31

Chapter 3 Working with Customers and Sites

Selecting site for single site license


When VI 3 is licensed for a single site, you select the site you want to access in the sites property General tab. When you check the site property described below for a particular site, access to all other sites is denied. This property is not displayed if VI3 is licensed for multiple sites and unlimited devices.
To select a site for single site access: Click the Access this site check box in the area titled Single Site License on the General tab.

Configuring the site units of measure


Typically, the HMI graphics display point data from devices controlling equipment and you often want the units of measure of the data displayed with it. The units of measure for a site are configured by selecting either United States or Metric on the General tab of the site properties. This setting superceded the Windows Control Panel regional options for units of measure. For a detailed description about tailoring the units of measure displayed on a HMI graphic, see Chapter 6 Control Object Reference.
To configure site measurement units: Choose the unit system in the area titled Unit System on the General tab. United States displays data in the traditional Imperial or InchPound units. Metric displays data based on the System International (SI) units.

Configuring the sites network interface


Visual Integrator 3 and the LNS server require a network interface and driver to connect to the sites LonWorks network. Network connectivity options are described in Chapter 2 A Quick Tour. This section describes how to configure the LNS server and network connectivity for Visual Integrator 3. For a description of how to configure the network connectivity for a second Visual Integrator 3 computer, see Chapter 18 Setting up Visual Integrator 3 as server and workstations.

32

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To configure site LNS server access and network interface for Visual Integrator 3: 1 Select the LNS tab in the site Properties dialog:

LNS tab in versions 3.5 and earlier

LNS tab in versions 3.6 and later

2 In the area titled LNS Server Access, select Local because Visual Integrator 3 and the LNS server holding the sites network database reside on the same computer. 3 In the area titled Network Interface, select the option that reflects the way the computer running Visual Integrator 3 and the LNS server is physically connected to the sites LonWorks network, as follows:

Driver specifies the network interface driver to be used when using a persistent connection to a local network. This field displays all the LonWorks network interface drivers that have been installed and configured on the computer. Typically, the Driver option is used when the network interface is installed in the computer and the network is connected to it via twisted pair, or when an i.LON 1000 and the Virtual Network Interface (VNI) are used. The network interface and its driver are installed and configured separately from Visual Integrator 3. Commonly used network interfaces are: PCLTA20/21: Personal Computer LonTalk Adapter card for PCI slots PCC10: Personal Computer LonTalk Adapter card for laptop computers U10: USB Network Interface SLTA10: Serial LonTalk Adapter for external interface. Used with the computers communication (COM) port. i.LON 1000: LonWorks Internet Server, Used with the computers Ethernet adapter card and LonTalk over IP to the i.LON 1000. IMPORTANT: when using the PCLTA20/21 or PCC10 network interface, be sure to set the drivers NI Application setting to PCL10VNI, using its configuration software.

Document Number 800263 Revision 3.7

33

Chapter 3 Working with Customers and Sites

Dialup SLTA or SMC300 specifies that a dialup connection from the computer to the network is to be used to provide a temporary connection to a remote network. Visual Integrator 3 supports two ways to set up this connection: using a modem connected to the COM port of the computer and either a SMC300 at the site, or a modem and SLTA10 at the site. See Configuring the dialup SLTA or SMC300 network interface, later in this chapter, for more information. iLON 10/100 Specifies that a TCP/IP connection from the computer to the remote network to be used when connecting with the network interface residing on the remote site. This type of interface provides either a persistent or a temporary connection to the network. An i.LON 10 Ethernet Adapter or an i.LON 100 Internet Server provides the network interface. See Configuring the i.LON 10/100 network interface, later in this chapter, for more information. Dialup iLON specifies that a dialup PointtoPoint Protocol (PPP) connection from the computer to the network is to be used to provide a temporary connection to a remote network. The i.LON 100 with the integrated modem option or an i.LON 10 with an external modem provides an alternative for dialing into sites over public standard telephone networks. This connection uses PPP, the current industry standard for remote connections. PPP supports several authentication methods, as well as data compression and encryption. This type of connection does not support alarm or data logging. See Configuring the dialup iLON network interface, later in this chapter, for more information

Configuring the sites network database


For a particular customer and site, you must configure the network database for the site. The LNS server maintains a global collection of network databases, one for each site that you may want to connect to from the computer running Visual Integrator 3. You can choose to configure the network database in any one of the following ways: Select from one or more existing network databases that were previously created by a separate network management tool; or Create a new network database you would then use Visual Integrator 3s Network Editor to add devices to the network; or Restore a network database from a LonMakercompatible backup file. You should also determine and select the preferred management mode that is to be used when Visual Integrator 3 is connected to the network.
To select an existing network database: In the area titled Network Name, select the name of the network database for the site. The dropdown list box allows you to select from all the network databases known to the LNS server.

34

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To create a new network database: 1 To create a new database using Network Editor, in the area titled Network Name click Add and the Add local network dialog is displayed.

2 Type the name of the network in the Local LNS Network Name field. This name is added to and used by the LNS global database. The network name is limited to 16 characters. 3 In the Location field, indicate the network database folder. You can use either the default location that is displayed or enter the location and name of the network database folder in the Location field. The name and location of the network database folder is limited to a total of 23 characters. Visual Integrator 3 automatically creates the folder(s) specified in the Location field. For example, if the location C:\MYDB\PROJECT1 is entered in the Location field, and Create Database is checked, then Visual Integrator 3 creates the MYDB folder and the PROJECT1 folder automatically. If the network database folder is already located on a hard disk, or on a network drive, click Browse and navigate to the network database folder. For example, if the name of the network database folder is PROJECT1, and is located in the following directory C:\NI\DB, click Browse and navigate to the PROJECT1 folder. If you want to create the network database folder system manually, click the Browse button and navigate to the new folder location. Click the New Folder button to add a new folder. Rightclick the new folder, and select the Rename option from the popup menu, and enter a new name for the folder. You can repeat this process for each new subfolder until the final network database folder is created. Click Ok when complete. 4 Select the Create Database check box. 5 Click OK when complete. Visual Integrator 3 creates the new LNS network database in the location you specified and adds it to the LNS server global database. To restore a network database from backup:

See the procedure described in Chapter 17 Maintaining a site and network, section Restoring a network database from LonMaker backup.

Configuring the site management mode


Management mode determines how the LNS server interacts with the devices on the LonWorks network when an operator makes changes to device configuration properties. When management mode is set to OffNet, the operators changes are stored in the LNS network database as they are made, but they are not propagated across the network to the device. When management mode is set to OnNet, the operators changes are stored in the LNS network database and they are propagated immediately to the devices, as the changes are made. When the management mode

Document Number 800263 Revision 3.7

35

Chapter 3 Working with Customers and Sites

transitions from OffNet to OnNet, any changes stored in the LNS network database that were made while OffNet are also propagated across the network at that time. It is recommended that management mode be set to OnNet. This allows changes to setpoints for example to be sent to the device immediately when they are changed by the operator. The management mode can be changed by the operator with the appropriate permissions using the Tools/Network/Properties command. The site Management Mode property determines the management mode when the operator opens and connects to the site. If the operator chooses to open the site but work offline then the management mode is set to OffNet regardless of the sites Management Mode property.
To configure the management mode: 1 In the area titled Management Mode, select the mode to be used when an operator opens and connects to the site. The management mode selections are: OnNet set management mode to OnNet when operator opens and connects to the site OffNet set management mode to OffNet when operator opens and connects to the site Dont Change set management mode to the mode most recently used for this site when an operator opens and connects to the site. That is, when an operator disconnected from the site the then current setting of management mode was stored in the LNS network database. When you select Dont Change it is this management mode setting stored in the LNS network database that is used the next time an operator opens and connects to the site. The Dont Change setting allows you to preserve the handling of management mode to be as it was in versions of Visual Integrator 3 prior to version 3.3.

Configuring the dialup SLTA or SMC300 network interface


The dialup network interface is used to implement a temporary connection from the computer running Visual Integrator 3 to a remote site over a public standard analog telephone network. See Chapter 2 A quick tour of Visual Integrator 3 for a description and illustration of a typical network using dialup connectivity. There are three main steps to configure a dialup network interface which must be done in order:
1 2 3 Configure the SLTALink Manager software Configure the Visual Integrator 3 site dialup SLTA or SMC300 properties Configure the cached monitor points setting

Configuring SLTALink Manager software


The modem must be connected and configured before you can configure SLTALink Manager. To configure the modem, first connect it to the PC, apply power and then use Settings > Control Panel > Phone and Modem Options from the Windows Start menu. IMPORTANT: If you plan to implement remote alarm logging using an SMC300 then you must configure the SLTALink Manager according to the procedure in Chapter 11 Logging and Viewing Alarms rather than using the procedure below.

36

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To configure SLTALink Manager: Start the SLTALink Manager from the Start menu as Programs > Echelon SLTA10 Network Adapter > SLTALink Manager. 1 Choose Link > New. In the Link Description dialog, enter an arbitrary unique name for this link, such as Remote Link. Click the Remote button to set the Link type. Enter a single question mark, as shown, in the Remote Identifier field. Do not check the Update identifier box. Click Next.

2 In the Dialling Address dialog, enter a single lowercase x character in the Telephone Number field. Uncheck Use Country Code and Area Code. In the Connect Using section, use the dropdown list to select the modem to be used for the remote link.

Document Number 800263 Revision 3.7

37

Chapter 3 Working with Customers and Sites 3 Click Configure Line to display the Connection Preferences dialog. In the Connection Preferences dialog, set the Call preferences as desired. Set Data Connection Preferences so that Port speed is 9600, Data Protocol and Compression are disabled; and Hardware Flow Control may be left at the default. Click OK to return to the Dialling Address dialog and click Next.

4 In the Link Properties dialog, In Device Assignment, select LON2, or whatever numeric base value you specified during the SLTALink Manager installation. Leave all other settings blank or unchecked. The password setting in this dialog is not the place to configure the password option.

5 Click Finish.

IMPORTANT: You may minimize or hide the SLTALink Manager application, but it must be running in order for remote communications to work.

38

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring site dialup SLTA or SMC300 properties


To configure the dialup SLTA or SMC300 properties 1 Open the Site Properties dialog and select the LNS tab. In the area titled Network Interface click the Dialup SLTA or SMC300 radio button. 2 Select the Dialup SLTA tab which is displayed as:

.
3 From the dropdown list labelled Link, select the modem link you created using SLTALinkManager . 4 Type the phone number to be used by Visual Integrator 3 to dialup the site, in the field labelled Phone Number. The phone number has several options that you may need to use depending on the situation: For example, the following phone number uses a 9 to access an outside line, and the area code as required: 9,16045555656. The comma indicates a pause when dialling the phone number. 5 If you have already configured the SLTA or SMC300 device with a password then enter the same password, in the field labelled Password. Visual Integrator 3 when dialling up the site uses the password. The SLTA or SMC300 refuses the connection if the password is not correct. Otherwise leave this field blank if you are not using a password. 6 Leave the field labelled Identifier unchanged as 000000000000000000000000.

Configuring the cache monitored points setting


IMPORTANT: The cache monitored points setting was removed in version 3.6 because the underlying problem that this setting was a workaround for, was corrected, with the advent of LNS Turbo Edition. The following information applies to Visual Integrator version 3.5 and earlier. The cache monitored points setting improves performance and robustness when connecting to a site using dialup SLTA10 (or i.LON10s). The cache monitored points setting alleviates potential problems related to delays or even possibly errors while connecting using these types of

Document Number 800263 Revision 3.7

39

Chapter 3 Working with Customers and Sites

connections. When you use this setting, there is an increase in computer memory usage that you may or may not notice, so the cache monitored points setting only for connections using dialup SLTA10 (or i.LON10s). Use the cache monitored points setting if you encounter difficulty while scanning to update a document, sometimes resulting in this message: The following error occurred when loading objects. The network variable does not exist (Subsystem: Data Server, #29).
To configure the cache monitor points setting: 1 Open the Site Properties dialog and choose the LNS tab. 2 Select the Cache Monitored Points check box.

Configuring the i.LON 10/100 network interface


The i.LON 10/100 network interface is used to implement a connection from the computer running Visual Integrator 3 to the site over a TCP/IP network. This type of interface supports either a persistent or a temporary connection. This section provides a description of how to configure the Visual Integrator 3 site properties for an i.LON 10/100 network interface. It is not intended to describe how to configure the i.LON 10/100 or the computer TCP/IP networking. Refer to the appropriate manufacturers user guide for that information. See Chapter 2 A quick tour of Visual Integrator 3 for a description and illustration of a typical network using i.LON 10/100 network interface connectivity.
The main steps to configure an i.LON 10/100 network interface, which must be done in order: 1 2 3 Configure the i.LON 10/100. Refer to Echelon documentation for assistance. Configure the Visual Integrator 3 site i.LON 10/100 properties, described below; Configure the cache monitored points setting (Visual Integrator 3 version 3.5 or earlier)

Configuring the i.LON 10/100 and the computer TCP/IP networking


Configuring the i.LON 10/100 and the computer TCP/IP networking is not done using Visual Integrator 3 and is outside the scope of this user guide. Refer to the appropriate manufacturers user guide for that information.

40

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring the site i.LON 10/100 properties


To configure the site i.LON 10/100 properties 1 Open the Site Properties dialog and select the LNS tab. In the area titled Network Interface, click the iLON 10/100 radio button. 2 Select the Site Properties iLON 10/100 tab which is displayed as:

3 Type the host name in the field labelled Host Name. This specifies the TCP/IP host name of the i.LON 10/100. When the i.LON10/100 establishes a connection with an LNS server it provides its fully qualified host/domain name to the LNS server so that it knows which LonWorks database to open. The i.LON 10/100 must be reset for name/domain name to take effect. The maximum number of characters for this field is 63 characters. 4 Type the DNS suffix in the field labelled DNS Suffix. This specifies the IP domain name in which the i.LON10/100 is installed. This field is optional and may be left blank, however it must be used if you plan to resolve the IP address from the host name rather than using a static IP address. The maximum number of characters for DNS suffix field is 63 characters. 5 In the bounded area labelled Address, indicate how the IP address of the i.LON 10/100 is to be determined. If Static IP Address is selected then type the IP address in the adjacent field. If Resolve from Host Name is selected then you are specifying that the i.LON 10/100 obtains its IP address from the local networks DHCP server. If this option is selected, the Host Name and DNS Suffix fields on this tab must be set, and these values must be registered with the Network/DNS administrator. 6 In the bounded area labelled Address, type the port number in the field labelled iLON listens on Port. This specifies the TCP port number the i.LON 10/100 uses to listen for incoming connections from the LNS server. The default value is 1628. 7 In the bounded area labelled Authentication, indicate the method to be used to authenticate connection requests to the i.LON 10/100. Using authentication prevents the LNS Server and the i.LON 10/100 from responding to unauthorized messages.

Document Number 800263 Revision 3.7

41

Chapter 3 Working with Customers and Sites If Raw MD5 Key is selected then type the authentication key as a 32character hexadecimal string representing a 128bit MD5 key. The key must be entered as colonseparated pairs. For example: AE:6B:5A:44:51:6D:EE:59:BF:BA:7B:EB:7D:F2:A9:FB. This key must match the MD5 authentication key configured into the i.LON 10/100. Setting the authentication key to all zeros causes the predefined, default factory authentication key for the i.LON 10/100 to be used. If Secret phrase is selected then type the text secret phrase. This phrase is a string 1663 characters long, and must exactly match the text secret phrase configured into the i.LON 10/100. 8 Select the Circon services persist connection check box when you are using the Circon persistent connection services: Local Alarm Log, Local Data Logger and Local Synchronization Service and you want to connect to a site using an i.LON 10/100 and treat it as a local site. In this case, the services open the connection to the i.LON 10/100 and hold it for as long as the service is running and allows alarm and data logging to occur. Consult Circon Tech Support before using this feature with more than five sites. If the Circon services persist connection check box is not selected, then the interface can be used for temporary connections only. In this case, the Circon remote connection services: Remote Alarm Log and Remote Data Logger are supported

Configuring the cache monitored points setting


IMPORTANT: The cache monitored points setting was removed in version 3.6 because the underlying problem that this setting was a workaround for, was corrected, with the advent of LNS Turbo Edition. The following information applies to Visual Integrator version 3.5 and earlier. The cache monitored points setting improves performance and robustness when connecting to a site using i.LON10s (or dialup SLTA10). The cache monitored points setting alleviates potential problems related to delays or even possibly errors while connecting using these types of connections. When you use this setting, there is an increase in computer memory usage that you may or may not notice, so the cache monitored points setting only for connections using i.LON10s (or dialup SLTA10). Use the cache monitored points setting if you encounter difficulty while scanning to update a document, sometimes resulting in this message: The following error occurred when loading objects. The network variable does not exist (Subsystem: Data Server, #29).
To configure the cache monitor points setting: 1 Open the Site Properties dialog and choose the LNS tab. 2 Select the Cache Monitored Points check box.

42

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring the dialup iLON network interface


The i.LON 100 with the integrated modem option or an i.LON 10 with an external modem and v2.0 firmware provide an alternative for dialing into sites over public standard telephone networks. This connection uses PointtoPoint Protocol (PPP), the current industry standard for remote connections. PPP supports several authentication methods, as well as data compression and encryption.. This type of connection supports a temporary connection only.
The main steps in configuring a dialup PPP connection: 1 2 3 4 Configure the modem into Windows. Refer to Windows documentation for assistance. Configure the i.LON 10/100 and modem. Refer to Echelon documentation for assistance. Configure the Visual Integrator 3 site Dialup iLON properties, described below. Configure the cache monitored points setting, as described in previous section. (Visual Integrator 3 version 3.5 or earlier)

To configure the Dialup iLON connection: 1 Open the Site Properties dialog and select the LNS tab. In the area titled Network Interface, click the Dialup i.LON radio button. 2 Select the Site Properties Dialup iLON tab which is displayed as:

3 Type the phone number to be used by Visual Integrator 3 to dialup the site, in the field labelled Phone Number. The phone number has several options that you may need to use depending on the situation: For example, the following phone number uses a 9 to access an outside line, and the area code as required: 9,16045555656. The comma indicates a pause when dialling the phone number.

Document Number 800263 Revision 3.7

43

Chapter 3 Working with Customers and Sites 4 Type the user name that matches exactly the configuration of the i.LON 10/100 at the site, in the field labelled User. 5 Type the password that matches exactly the configuration of the i.LON 10/100 at the site, in the field labelled Password.

Configuring administrator permissions


This section describes how to assign the members of the Administrators operator group to a site and how to assign the site permissions to that operator group. See Chapter 14 Securing access to a Site where a complete description of how to implement secure access to a site by defining operator groups and operators and assigning passwords is provided. Permissions are used to restrict an operators ability to perform certain Visual Integrator 3 functions when working with a particular site. Permissions are assigned to groups of operators. All operators who are members of the operator group inherit the same permissions. An operator group can be assigned the same or different permissions for different sites. Typically administrative operators are assigned all permissions.
To configure permissions for a specific site to the administrative operators: 1 Open the Site Properties dialog and select the Permissions tab.

2 The area titled Operator groups that can NOT access this site lists all the operator groups you have defined. To grant the Administrators group access to this site, select that operator group and click Add. The operator group disappears from this section and appears in the area titled Operator groups that can access this site. Members of this operator group are now able to open and connect to this site.

44

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Now you must set the site permissions for the Administrators group you have assigned site access to. Click the plus sign adjacent to the Administrators group to expand and display the permissions list:

4 Select all permissions check boxes. Permissions are described in Chapter 14 Securing access to a site.

Configuring data logging


Circon 300Series devices have the capability to trend and store point data and event data. The data is stored in the device memory. Due to memory constraints within the device, the data is overwritten over the course of time. Visual Integrator 3 can be configured to upload trend and event data from the devices periodically. For complete information about the trending capabilities of VI3 including how to configure the site properties for data logging, See Chapter 10 Logging and viewing data.

Configuring the time synchronization service


The Circon Local Synchronization Service can be used to synchronize the date and time of devices on the LonWorks network to that of the computer running the service. The computer, in turn, can be set up to synchronize its date and time with an external synchronization service, typically over the Internet or facility LAN/WAN. Time synchronization service is available for networks with a network interface that provides a persistent connection.

Document Number 800263 Revision 3.7

45

Chapter 3 Working with Customers and Sites To configure time synchronization: 1 Use a network management tool or Network Editor to create an output network variable of type SNVT_time_stamp on the LNS network interface. 2 With this network variable, create a connection to a corresponding input network variable of type SNVT_time_stamp on the device or devices you want to synchronize. Typically, this input network variable is on the devices NodeObject functional block. 3 Use Visual Integrator 3 to open the Site Properties dialog. 4 Select the Services tab and select the Enable synchronization check box. 5 Start the Circon Services Manager and start the Local Synchronization Service. If it is already started, stop it and restart it.

Opening and connecting to a site


Opening a site is a process by which Visual Integrator 3 attaches to the LNS server and gains access the sites network database. Visual Integrator 3 must be able to access the network database to create the HMI for that site. When you open a site on Visual Integrator 3 you can choose to connect to the physical site LonWorks network or to work offline or disconnected from the physical site LonWorks network. Connecting requires that the network interface be fully operational and that the physical connection from the network interface to the LonWorks network is in place. For remote networks in particular you may want to work offline to avoid unnecessary cost of maintaining the connection. For Visual Integrator 3 to connect to a site, the number of devices in the sites network database must not exceed the licenselimited maximum number of devices unless Visual Integrator 3 is licensed for unlimited devices.
To open a site: 1 Log in to Visual Integrator 3 as a member of the Administrator group. 2 In the TreeView pane, click the plus sign next to the customer name to display the sites for that customer.

46

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Click the site you want to open. The open site dialog is displayed:

4 Click Yes. The connection dialog is displayed:

5 Click Connect to work connected or click Work Offline to work disconnected. If the number of devices in the sites network database exceeds the licenselimited maximum number of devices, then the dialog below is displayed. To connect to this site you must upgrade your Visual Integrator 3 license or remove devices from the site.

6 Observe the status bar in the lower right corner of the Visual Integrator 3 window. The type of connection and management mode is displayed.

B C

A Management Mode
OnNet or OffNet, described earlier in this chapter.

B Connection
Connected to network Working Offline

C LNS Server attachment


Attached to server

Document Number 800263 Revision 3.7

47

Chapter 3 Working with Customers and Sites

Installing plugin software


If you want to allow operators to launch LNS device plugins then you must install the plugin software on the Server computer. Plugin software is supplied by the device manufacturer, typically with the device; it is not included with Visual Integrator 3. Plugin software can be installed at any time. Plugins must be registered separately for each network in the network database.
To install and register LNS plugins 1 Install the plugin software on the computer following the installation instructions provided by the manufacturer. 2 Start Visual Integrator 3, logon as Administrator and open the site. 3 Choose Tools > Network > Properties. Select the Plugins tab of the Network Properties dialog. 4 The plugins you installed should be listed in the Not registered frame. Select the plugin name you want to register from the Not registered frame and click Add. The plugin name moves to the To be registered frame. 5 Click Apply to start the plugin registration. When it is complete click OK to close.

48

Document Number 800263 Revision 3.7

Chapter 4 Working with Visual Integrator Documents

ocument is the name used in Visual Integrator 3 for the custom information displays that make up the graphical user interface or HMI you create.

What documents are


Documents are displayed in the right pane or DocumentView area of the Visual Integrator 3 window. The operator selects a document for viewing from the list in the left pane or TreeView area of the Visual Integrator 3 window. Typically, a document is based on a template document and consists of a static background image and a number of control objects arranged to make an intuitive user interface to a facility, a piece of equipment or a link to important documentation. The template document can be selected from those provided with Visual Integrator 3 or it can be a template you have created or modified from those provided. The image is created outside of Visual Integrator 3 by a drawing or image editing application such as CorelDraw, AutoCAD, or Photoshop and imported into Visual Integrator 3. The controls come with Visual Integrator 3 and are placed into the document along with the image using the Visual Integrator 3 Graphics Editor. This chapter describes the categories of documents and their intended use, and the document templates. The basics of using Graphics Editor are described in Chapter 5 Introduction to Graphics Editor and Control Objects. How to use Graphics Editor to create complete site HMI is described in Chapter 7 Creating an HMI a Tutorial.

Document categories
Documents are organized into four categories although the Other category is a catchall for a number of dissimilar documents. Although each category of document is intended a specific purpose, there is some overlap in their applicability. Document categories are distinguished by their target property. The target property defines the path to the specific entity in the LNS database that is the main focus of the document and its images and controls. Choosing the correct document category when adding a document to a site is an important first step in creating a document that is easier to maintain and is more portable among sites. The document categories and their intended use are described below:

Document Number 800263 Revision 3.7

49

Chapter 4 Working with Visual Integrator Documents

Device document Use a device document when you want the document to display data and other relevant

information from a single device on the sites network. The target property is set to a specific device on the site network. Visual Integrator 3 includes a full suite of device document templates for Circon devices. Alternatively, use a Device Inspector document to provide a view of all the devices network variables and configuration properties in a preformatted tabular format.
Subsystem document Use a subsystem document when you want the document to display data and other relevant

information from an arbitrary collection of devices on the sites network. The target property can be set to a subsystem as defined in the LNS database for the sites network. Visual Integrator 3 includes a subsystem status document template that provides an effective approach to accessing device status information for all subsystems or for a single subsystem, and launching plugins for devices in the subsystem(s).
Functional Block document Use a functional block document when you want a custom document to display data and other

relevant information from a specific device functional block. For example, a functional block might be a PID functional block, an alarm functional block, or an input point functional block. The target property can be set to a specific functional block of a specific device on the site network. Alternatively, use a Functional Block Inspector document to provide a view of all the targeted functional blocks network variables and configuration properties in a preformatted tabular format.
Other document The Other document category includes documents that are used to display schedules, reports,

images and controls not intended to display data or other relevant information from the sites network, or that display information from a different source outside of Visual Integrator 3. Most Other documents do not have a target property although some do have a link property. Visual Integrator 3 includes the following other document templates: Notepad document use this template to create a text document that the operator can edit and add information to, and save the changes for later viewing by other operators. Blank Graphic document use this template you want the document to display data and other relevant information from a multiple devices on the sites network. For example, the home page for a site or a site map that allows the operator to follow links to other site documents, or a floor plan that displays the room temperature of each room. Link document use this template when the document displays information from an external source outside of Visual Integrator 3. The target property can be set to a specific document on the

50

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

computer or any accessible network drive or to a Web page. The external document must conform to the Microsoft ActiveX document standard to be displayed by a Link document. One unfortunate exception that does not conform is Adobe PDF format documents. To display a PDF document it should be wrapped in a HTML page. Circon Web Site document use this template when the document displays information from a Web site. The target property can be set to any specific Web page. Alarm Report document use this template when you want the alarm report to be viewed by operators who do not have site management permissions. Schedule Report document use this template when you want the schedule report to be viewed by operators who do not have site management permissions. Schedule document use this template when you want a particular schedule to be displayed in DocumentView rather than forcing the operator to open Network Scheduler. The schedule editing capabilities of the operator are governed by the operators permissions in the same way that permissions affect the use of Network Scheduler. See Chapter 12 Using Network Scheduler for a description of its permissions.

Document types
There are two types of Visual Integrator 3 documents which can be found in some or all of the categories described above. Graphic document a graphic document can be changed by Graphics Editor and can be renamed or deleted from the list of document templates. It is used to create a custom view of its designated target. Builtin document a builtin document provides a fixed format that cant be changed by Graphics Editor. It cant be renamed or deleted from the list of document templates; however its target can be changed. Visual Integrator 3 includes the following builtin documents:
Device Inspector Subsystem Status Functional Block Inspector Note Pad Link Circon Web Site Alarm Report Schedule Report Schedule

Document Number 800263 Revision 3.7

51

Chapter 4 Working with Visual Integrator Documents

Document templates
Sample documents or templates are provided with Visual Integrator 3 for each category. By using the templates as the basis for your operator interface, you can build a complete, functional HMI much faster than by creating your own documents. When you add a document to a site, Visual Integrator 3 makes a copy of the template and moves it to the sites folders. If you then decide to customize the added document for that site you are not affecting the original template. Some templates such as the device, subsystem and functional block document templates are meant to be used with specific instances or targets of a device, subsystem or functional block. When you add one of these types of templates to a sites HMI, you need to set the target as a path through the hierarchy of the LNS network database to the particular device, subsystem or functional block that the document is associated with. When objects are added to the document, they inherit the path from the template. In the template, the path placeholder is represented as quotation mark.
To view document templates: Choose Tools > Documents. When the Document Templates dialog is displayed, ignore the Document Wizard tab for now. Document Wizard is described in Chapter 9 Using Document Wizard. Select the various Documents tabs to display a list of templates for that category:

Note: Device document templates shown on your computer depend on the plugins you have installed on your PC and registered within a network. Therefore your screen may not show the same device templates as above. To edit a document template: 1 Choose Tools > Documents. Select the appropriate Documents tabs to display a list of templates for that category. 2 Select any template of type Graphic and click Edit. The graphics editor is opened. 3 Make the changes as required and save the document template. Exit the graphics editor to return to the Documents Templates dialog. IMPORTANT: Editing a template affects only the template and any future sites it is used for. Sites that already use the template are not affected by the changes.

52

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

To change the default font for a document template: 1 Follow the procedure described above to edit a document template. 2 Rightclick to display the properties of TheFrame/TheView object. 3 Change the Font property as required to set the default font, and then save the document template. Exit the graphics editor to return to the Documents Templates dialog. To create a new document template: 1 Choose Tools > Documents. Select the appropriate Documents tabs to display a list of templates for that category. 2 Click Add to create a copy of the Blank template for that category. Select then click the new template named New Document 1 to rename it. 3 Select the new template and click Edit. The graphics editor is opened. 4 Make the changes as required and save the document template. Exit the graphics editor to return to the Documents Templates dialog. Even if the original Blank template is renamed or removed, the Add function will continue to work correctly and add a new document based on the original blank document for that category.

Adding documents to a site


In Visual Integrator 3, a site is managed through a list of customized documents and nested documents among which the operator navigates using TreeView. The list of documents for a particular site can be assembled in an automated way using the Document Wizard or manually by adding each document separately, or a combination of both. In either case the source of the documents is the document templates. This section describes how to add documents to a site manually. For a description of the Document Wizard, see Chapter 9, Using Document Wizard.

Adding a device document


A device document is used to display data and other relevant information from a single device on the sites network, typically including a graphic image of the equipment being controlled. Alternatively, a device inspector document can be used to provide a view of all network variables and configuration properties for a device, in a preformatted tabular format.
To add a device document to a site: 1 Open the site you want to add a document to and select the site home document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site.

Document Number 800263 Revision 3.7

53

Chapter 4 Working with Visual Integrator Documents 2 Choose File > New Document. The Add Document dialog is displayed. Click the Details button to select the list view:

Details button

3 Select the device document template to be added to the site and click OK. 4 The device document appears in the TreeView with a name composed of the prefix New followed by the name of the device document template, in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Select the new document and as Visual Integrator 3 attempts to display the document in the right pane, an error dialog is displayed. This is entirely normal and expected the first time a new document is selected. This dialog appeared because the device document is not yet associated with its target device. Click OK.

54

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Choose File > Properties. The new documents properties are displayed:

7 Click Browse and select the device you want to associate with this document as the target device. Notice that the name of the tab on the Properties dialog indicates the document is a Device document.

8 Click OK to select the target device 9 Click OK to set the target device and close the Properties dialog. Visual Integrator 3 automatically refreshes the document with values from the device.

Document Number 800263 Revision 3.7

55

Chapter 4 Working with Visual Integrator Documents To add a Device inspector document to a site: 1 Open the site you want to add a document to and select the site document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. Click the Details button to select the list view:

Details button

3 Select the Device Inspector document and click OK. 4 The device document appears in the TreeView named New Device Inspector in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Select the new document and wait as Visual Integrator 3 displays the document in the right pane. The device browser column heading are displayed but the document is otherwise blank. This is entirely normal and expected the first time a new document is selected. 6 Choose File > Properties. The new documents properties are displayed:

7 Click Browse and select the device you want to associate with this document as the target device. 8 Click OK to select the target device

56

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 Click OK to set the target device and close the Properties dialog. Visual Integrator 3 automatically refreshes the document columns with values from the device.

Adding a Subsystem Status document


Visual Integrator 3 includes a builtin subsystem document called subsystem status that should be used for all sites. This document provides access to diagnostic information on how the devices are running on the network and allows an operator with appropriate permission to access the device plugins.
To add a subsystem status document to a site: 1 Open the site you want to add a document to and select the site document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. Click Details and select the Subsystem Documents tab:

Details button

3 Select the Subsystem Status document template to be added to the site and click OK. 4 The subsystem status document appears in the TreeView named New Subsystem Status in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Rightclick on New Document and select Rename from the popup menu. Enter an appropriate name for this document. 6 Select the new document and Visual Integrator 3 displays all subsystems and their devices in the right pane, including device status. 7 To change the time interval between updates to device status in the subsystem document, adjust the Poll Interval setting on the Timing tab of the networks properties dialog. 8 If you want to make this document specific to a particular subsystem then select Properties from the File menu to display the subsystem properties dialog. Click Browse and select a subsystem. You can add more Subsystem Status documents for other subsystems in the site. 9 When you rightclick on a device in the subsystem document displayed in the right pane, a popup menu is displayed to provide access to network maintenance functions for that device.

Document Number 800263 Revision 3.7

57

Chapter 4 Working with Visual Integrator Documents

Adding a link document


Visual Integrator 3 includes a link document template that is intended to be used when you want to be able to display material from an external source to the end user. The target property can be set to a specific document on the computer or any accessible network drive or to a Web page. The external document must conform to the Microsoft ActiveX document standard to be displayed by a Link document.
To add a link document to a site: 1 Open the site you want to add a document to and select the site document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. Select the Other Documents tab: 3 Select the Link document template and click OK.

4 The link document appears in the TreeView named New Link Document in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Select the new document, at this point the DocumentView displays nothing in the right pane.

58

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Choose File > Properties. The link document properties dialog is displayed. Enter the location of the document to be linked directly or click the Browse button to locate it. The dialog example below shows a wellknown website as the link.

NOTE: The link document template allows you to display text documents such as Microsoft Word and Microsoft Notepad documents but it does not allow the operator to change them. Use the notepad document template if you want to provide the ability for the operator to edit and save text.

Adding a notepad document


Visual Integrator 3 includes a notepad document template that is intended to be used when you want to allow the operator to maintain a text file that can be edited and saved.
To add a notepad document to a site: 1 Open the site you want to add a document to and select the site document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. Select the Other Documents tab. 3 Select the Notepad document template and click OK.

Document Number 800263 Revision 3.7

59

Chapter 4 Working with Visual Integrator Documents 4 The notepad document appears in the TreeView named New Note Pad in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Select the new document, at this point the DocumentView displays a blank right pane. 6 There are no properties to configure for a Notepad document. Simply click in the right pane and enter text information as required. When another document is selected from the TreeView, a dialog is displayed that asks the operator whether or not to save.

Adding a blank graphic document


Visual Integrator 3 includes a blank graphic document template that is intended to be used when you want to display network variables and configuration information/data from one or more target devices over an image background such as a floor plan with room temperatures for each room. A blank graphic document template is added to a site in a manner similar to the Notepad document template. A blank graphic document has no properties to configure. To change the time interval between updates to network variable information displayed on the graphic document, adjust the Poll Interval setting on the Timing tab of the network properties dialog.

Adding a schedule report document


Visual Integrator 3 includes a schedule report document template that is intended to be used when you want to display this report in the DocumentView without using Site Management. The schedule report document template is added to a site in a manner similar to the Notepad document template. The schedule report document has no properties to configure.

60

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Adding an alarm report document


Visual Integrator 3 includes an alarm report document template that is intended to be used when you want to display this report in the DocumentView without using Site Management. The alarm report document template is added to a site in a manner similar to the Notepad document template. You can configure the alarm report document properties as follows:
To configure the alarm report filter properties: 1 Display the alarm report in the DocumentView. 2 Click on Properties on the tool bar. The alarm report filter configuration dialog is displayed:

Time specifies the period of time from which the alarms are taken State select alarm state(s) to generate a report containing only alarms in that state. Priority select alarm priorities to generate a report containing only alarms in those priorities. Category select a category of alarms or all categories to generate a report containing only alarms in that category. Code select an alarm code or all codes to generate a report containing only alarms with that alarm code. Description enter a fragment of text of a specific alarm description to generate a report containing only those alarms. Use % as wildcard. For example, to view all alarms with temperature in the description, type %temperature%. The SQL LIKE clause is used here. You may want to research its other wildcard options.

Document Number 800263 Revision 3.7

61

Chapter 4 Working with Visual Integrator Documents

Customer specify a single customer or all customers to generate a report containing alarms for sites owned by those customers Site specify a single site or all sites to generate a report containing alarms for those sites
3 Click OK to close the Alarm filter and the report is automatically generated again showing the information according to the filter settings.

Adding a schedule document


Visual Integrator 3 includes schedule document template that are intended to be used when you want to display a schedule in the DocumentView without using Network Scheduler. Depending on the operators permissions, the schedule document also allows the schedule to be edited and synchronized to its associated device schedules. If the operator has permission to synchronize the schedule to associated device schedules then when the operator goes away from the schedule document by selecting another document in TreeView, the Synchronization dialog is displayed.
To add a schedule document to a site: 1 Open the site you want to add a schedule document to and select the site home document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. 3 Select the Other document tab and select the Schedule document then click OK:

4 The schedule document appears in the TreeView named New Schedule in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use.

62

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 Select the new document and as Visual Integrator 3 attempts to display the document in the right pane, an error dialog is displayed. This is entirely normal and expected the first time a new document is selected. This dialog appeared because the schedule document is not yet associated with its target schedule. Click OK.

6 Choose File > Properties. The new documents properties are displayed:

7 Click Browse and select the schedule you want to associate with this document as the target schedule.

8 Click OK to select the target schedule. 9 Click OK to set the target schedule and close the Properties dialog. Visual Integrator 3 automatically refreshes the document with the schedule.

Adding a functional block document


Visual Integrator 3 includes a functional block document template that is intended to be used when you want the document to display data and other relevant information from a specific functional block of a single device. A functional block document can be used in place of the device plugin when you do not want to grant plugin permission to the operator. For example, a functional block might be a PID functional block, an alarm functional block, an input point

Document Number 800263 Revision 3.7

63

Chapter 4 Working with Visual Integrator Documents

functional block, etc. The target property can be set to a specific functional block of a specific device on the site network. Alternatively, a functional block inspector document can be added to provide a view of all network variables and configuration properties in a preformatted tabular format.
To add a functional block document to a site: 1 Open the site you want to add a document to and select the site document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. Select the Functional Block Documents tab. 3 Select the Blank Functional Block document template and click OK.

4 The functional block document appears in the TreeView named New Blank Functional Block in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Select the new document, at this point the DocumentView displays a blank right pane. 6 Choose File > Properties. The functional block document properties dialog is displayed.

64

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 7 Click Browse and select the device and functional block.

8 Use Graphics Editor to customize this document. To add a functional block inspector document to a site: 1 Open the site you want to add a document to and select the site document to ensure the added document appears in the highest level nesting below. Later on you can reposition the document anywhere in the TreeView for that site. 2 Choose File > New Document. The Add Document dialog is displayed. Select the Functional Block Documents tab. 3 Select the Blank Functional Inspector document template and click OK.

4 The Functional Block Inspector document appears in the TreeView named New Functional Block Inspector in alphabetical position in the highest level nesting. The name is selected, so you can immediately type in or edit the name you want to use. 5 Select the new document and wait as Visual Integrator 3 displays the document in the right pane. The functional block browser column heading are displayed but the document is otherwise blank. This is entirely normal and expected the first time a new document is selected.

Document Number 800263 Revision 3.7

65

Chapter 4 Working with Visual Integrator Documents 6 Choose File > Properties. The Functional Block document properties dialog is displayed.

7 Click Browse and select the device and functional block. 8 Click OK to save and close 9 Click OK. VI 3 automatically refreshes the document columns with values from the functional block

66

Document Number 800263 Revision 3.7

Chapter 5 Working with Graphics Editor and Control Objects

raphics Editor allows you to modify and customize the appearance and function of a document to create an HMI that meets the needs of the site operators or other end users. Using Graphics Editor you can import background images and add control objects and hyperlinks to the document. Graphics Editor is not however a graphical drawing application; you cant create or alter images. To alter an image you must use the original application in which it was created then import the changed image into the document using Graphics Editor. Youll need to know the basic procedures that apply to customizing Visual Integrator 3 documents using Graphics Editor. This chapter covers these basics and describes how to use the capabilities of Graphics Editor and its control objects.

Working with Graphics Editor


This section introduces the basics of Graphics Editor and explains how to use the tools it provides to place and manipulate control objects on a document. See Chapter 7 Creating an HMI a Tutorial for a stepbystep tutorial on how to use Graphics Editor to create a HMI. Chapter 4 Working with Visual Integrator Documents describes the types of documents available in Visual Integrator 3. Access to Graphics Editor is controlled by permission. Operators without the appropriate permission cant run Graphics Editor and alter documents. Chapter 3 Configuring a Site describes the permissions available in Visual Integrator 3.

Opening a document
To open a document for changing by Graphics Editor: 1 Select the document you want to open in the Visual Integrator 3 TreeView pane. 2 Choose File > Graphics Editor or click Graphics Editor on the toolbar. Graphics Editor is launched and opens the selected document. The menu command and the button are disabled if the document selected is of the type that cant be changed by Graphics Editor.

Document Number 800263 Revision 3.7

67

Chapter 5 Working with Graphics Editor and Control Objects

Understanding the Graphics Editor window


Graphics Editor runs in its own window that contains its menus and toolbars to help you work more efficiently. Toolbars can be repositioned or detached to suit your preferred location.

A Menu
File Use the File menu to save and print the document Save Make Template Ctrl+S Saves document Sets target paths on all objects to so document can be used as a template. Only AppDevice, Subsystem or Functional Block documents can utilize the (") substitution on the ActiveX controls See Chapter 4 Working with Visual Integrator Documents for a description of template target paths. Exit Closes Graphics Editor and returns to Visual Integrator 3

Edit

Use the Edit menu to manipulate selected objects Undo Redo Ctrl+Z Ctrl+A Reverses the last action Performs a reversed action again

68

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Edit

Use the Edit menu to manipulate selected objects Cut Copy Paste Delete Ctrl+X Ctrl+C Ctrl+V Del Removes selected object from document to clipboard Copies selected object from document to clipboard Pastes object from clipboard to document Deletes selected object from document

View

Use the View menu to personalize the appearance of Graphic Editors window. The Object bar, Toolbar and the Layout bar can be moved anywhere on your desktop, or they can be docked on any edge of the Graphic Editor window by clicking and dragging. Toolbar Status Bar Object Bar Layout Bar Hidden Properties F2 Shift+F2 Shows/hides Toolbar Shows/hides Status bar Shows/hides Object bar Shows/hides Layout bar Shows/hides additional object properties on object property sheet. The additional properties are normally hidden because none of them should be modified by the operator. Often setting other properties affects the settings of these properties.

Layout

Use the Layout menu items to arrange objects in the document in relation to the view and to each other, to edit property and object sheets, to set the tab order, and to toggle the grid on and off. Dominant object refers to the object on which resizing and alignment of a group of selected objects are based. See Selecting the dominant object for more information. Align Objects > Left Align Objects > Right Align Objects > Top Align Objects > Bottom Align Objects > Vert. Center Align Objects > Horz. Center Space Evenly > Across Align left edges of selected objects with dominant object Align right edges of selected objects with dominant object Align top edges of selected objects with dominant object Align bottom edges of selected objects with dominant object Align centers of selected objects vertically with center of dominant object Align centers of selected objects horizontally with center of dominant object Evenly space selected objects horizontally

Document Number 800263 Revision 3.7

69

Chapter 5 Working with Graphics Editor and Control Objects

Layout

Use the Layout menu items to arrange objects in the document in relation to the view and to each other, to edit property and object sheets, to set the tab order, and to toggle the grid on and off. Dominant object refers to the object on which resizing and alignment of a group of selected objects are based. See Selecting the dominant object for more information. Space Evenly > Down Center in View > Vertical Center in View > horizontal Make Same Size > Width Make Same Size > Height Make Same Size > Both Properties Set Tab Order Inspector Grid Settings Enter Shift+ Enter Ctrl+I Ctrl+G Evenly space selected objects vertically Center objects vertically within the view Center objects horizontally within the view Resize selected objects to have the same height as dominant object Resize selected objects to have the same width as dominant object Resize selected objects to have the same size as dominant object Opens the property sheet for the selected object Determine the order in which Tab key selects objects Opens the object sheet to allow the drawing order or tab order to be adjusted. Opens the grid settings dialog allowing you to adjust grid settings, including snap to grid, grid spacing in pixels and turning grid on and off. Ctrl+G toggles grid on and off.

Run

Use the Run menu to test the document without leaving the Editor Start End Starts running the document Stops running the document

B Toolbar
Save Cut Copy Paste Start End Print Ctrl+P Ctrl+S Ctrl+X Ctrl+C Ctrl+V Saves document Removes selected object from document to clipboard Copies selected object from document to clipboard Pastes object from clipboard to document Starts running the document Stops running the document Prints document

70

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

C Object bar The Object bar contains the tools you use to add control objects to the document. A control

object performs a function within the document. A control object is characterized by its properties. Properties are the most powerful tool available to you for controlling the objects appearance and behavior. Properties define how the control object looks (backcolor, font, height, width, etc), where it is located (left coordinates, right coordinates, etc), how it responds to events (MouseClick, KeyboardPress, etc) and much more. Most control objects possess properties that are categorized as: Normal properties, Event properties, and ActiveX properties. This section identifies the control objects and their purpose. See Chapter 6 Control Objects Reference for a complete description of the control objects and their properties.
Object Button Object Name
Button CirconAlarm CheckButton DataPoint DeviceStatus EditBox EnumPoint Frame Image Inspector Label Line NVAnimated

Description
Adds a button that can be used with Visual BASIC script. Displays alarm description of alarms from target device. Adds a check box that can be used with Visual BASIC script. Check boxes work as on and off switches. Displays the value of a network variable and its units of measure. Displays the status of a device. An area to display text or allow the operator to enter text. Displays the translation of an enumerated network variable value in meaningful text or images. Adds a visual border for other objects. Displays bitmaps, buttons or metafiles; provides an area in which to display text; acts as a container for other controls. Displays, monitors ad allows override of network variables and configuration properties. Displays fixed text an operator cant interact with or change. Adds a straightline segment. Displays and runs an animated GIF based on the value, or range of values of a network variable.

Document Number 800263 Revision 3.7

71

Chapter 5 Working with Graphics Editor and Control Objects

Object Button

Object Name
NVDigital NVGauge

Description
Sets and displays the value of a network variable or configuration property of type SNVT_lev_disc. Displays the value of a network variable or configuration property as a gauge. Displays and allows modification of network variables and configuration properties. Used with data variables assigned as SNVT_setpoint. Sets and displays the value of a network variable as a slider bar. Displays the full path to an LNS object including network, device, functional block, network variable and field. This control object is dynamic; if the device is renamed in the LNS database, the ObjectLabel changes in the document. Displays realtime dynamic trend of a network variable. Launches a registered plugin. Allows a customizable appearance. Launches a registered plugin. Provides a button appearance. Adds a set of radio buttons that can be used with Visual BASIC script. Radio buttons allow a oneofmany selection from an operator. Used to select, move and resize other control objects. Sets and displays the value of a network variable assigned as a SNVT_switch. Displays and allows modification of the time on a device. Used with data variables assigned as SNVT_time_stamp. Generates a periodic event used in conjunction with Visual BASIC script. Displays historical trend plot.

NVSetpoint

NVSlider

ObjectLabel

PenPlot PlugIn PlugIn Button RadioButtons Select SwitchPoint TimePoint Timer TrendLog

D TheFrame/TheView The TheFrame/TheView is the canvas for creating the graphics interface. It represents the

document you are editing. You arrange control objects to meet the operators needs on the TheFrame/TheView. When you save, everything on TheFrame/TheView is saved for the document. TheFrame/TheView is an object with properties that you can change. It is not a control object and it cant be replicated.

72

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

E Layout bar The Layout bar provides tools to arrange control objects on the document in relation to the

overall document and to each other, to edit properties and object sheets, to set the tab order and to toggle the grid view. See layout menu description, above, for a definition of each button.
F Status bar The Status bar displays abbreviated description of the tool or control object you have selected. G Location of control object Displays the x, y coordinates of the selected control objects upper left corner, in units of pixels. H Dimensions of TheFrame/TheView Displays the dimensions of the TheFrame/TheView as height x width, in units of pixels.

Working with control objects


Control objects referred to now as objects are embedded in a document to perform a function related to the desired design of the HMI. An object is characterized by its properties. Properties are the most powerful tool available to you for controlling the objects appearance and behavior. Properties define how the control object behaves, its target device and variable, where it is located on the document, how it responds to mouse and keyboard events and much more. This section describes how to add objects to a document and edit their properties. See Chapter 6 Control Objects Reference for a complete description of the objects and their properties.

Adding an object
To add an object using pointandclick 1 On the Object bar, click to choose a control object 2 Position the cursor in TheFrame/TheView in the position you want the object to be 3 Click at that position. The control object appears with the default size defined for that object. To add an object by dragging 1 On the Object bar, click to choose a control object 2 Position the cursor in TheFrame/TheView in the position you want the object to be 3 Click at that position and drag down and to the right a dotted outline of the control object appears. 4 Release the mouse button when the control object is the desired size.

Selecting an object
To select an object using pointandclick On TheFrame/TheView, point to the control object you want to select and click. Sizing handles appear around the objects edges indicating that it is selected.

Document Number 800263 Revision 3.7

73

Chapter 5 Working with Graphics Editor and Control Objects To select an object using Tab key 1 Press the Tab key. Sizing handles appear around an objects edges indicating that it is selected. 2 Continue pressing the Tab key until the control object you want is selected. To select multiple objects by dragging 1 On TheFrame/TheView, drag to draw a temporary selection box around the control object you want to select. Objects partially outside the selection box are not selected. 2 Release the mouse button; all objects completely inside the selection box are selected. Sizing handles appear around the object edges indicating that it is selected. To select multiple objects by holding down shift key 1 On TheFrame/TheView, point to one of the control objects you want to select and click. Sizing handles appear around the objects edges indicating that it is selected. 2 Hold down the Shift key and continue to click other objects you want to select. 3 Release Shift key when all objects are selected. 4 To remove or add objects to an existing selection group, hold down the Shift key and click the object you want to remove or add.

Moving an object within a document


To move an object within the document by dragging Drag the object to the new position. When Snap to Grid is on the object snaps into alignment with the grid. To move an object within the document using arrow keys 1 Select the objects you want to move. 2 Use the arrow keys to move the objects to the new position one pixel at a time. 3 Hold down the Ctrl key and use the arrow keys to move the objects to the new position one grid unit at a time.

Moving an object to another document


Follow the procedure below to copy an object to another document, then go back to the original document and follow the procedure to delete the object.

Copying an object
To copy an object within the document 1 Select the object or objects you want to copy. 2 Use Copy function to place a copy of the object on the clipboard: toolbar Copy button, Edit menu Copy command or keys Ctrl+C. 3 Use Paste function to place a copy of the object on the document: toolbar Paste button, Edit menu Paste command or keys Ctrl+V. The copied object is pasted directly over the object that was copied. Click and drag to position the object wherever.

74

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To copy an object to another document 1 Select the object or objects you want to copy. 2 Use Copy function to place a copy of the object on the clipboard: toolbar Copy button, Edit menu Copy command or keys Ctrl+C. 3 Save the document and exit Graphics Editor. 4 Select the document that you want to paste the copied objects into and start Graphics Editor. 5 Use Paste function to place a copy of the object on the document: Toolbar Paste button, Edit menu Paste command or keys Ctrl+V. The copied object is pasted in exactly the same position as in the source document. Click and drag to position the object wherever.

Deleting an object
To delete an object 1 Select the object or objects you want to delete. 2 Use cut function to delete the object: toolbar Cut button, Edit menu Cut command or keys Ctrl+X. 3 Use delete function to delete the object: toolbar Delete button, Edit menu Del command or keys Delete or Del.

Selecting the dominant object


When you are resizing or aligning multiple objects, the dominant object is used as the model to determine how to size or align the other selected objects. When multiple objects are selected, the dominant object has whitefilled sizing handles; all other selected objects have blackfilled sizing handles.
To select the dominant object Select the first object to be the dominant object. To change the dominant object when multiple objects are selected, hold down the Ctrl key and select the object that you want to be the dominant object.

Sizing an object
When you change the size of an object, its final shape may be affected by whether you have Snap to Grid on.
To change the size of an object 1 Select the object you want to resize. 2 Use the sizing handles to change the size of the object: Sizing handles at the top and sides change the horizontal or vertical size. When the cursor is positioned over a sizing handle, it changes shape to indicate the direction in which the object can be sized using that handle. Active sizing handles are solid; if a sizing handle is hollow, the object cant be resized along that axis. Sizing handles at the corners change both horizontal and vertical size. Some objects height cant be changed; in that case corner handles change horizontal size only.

Document Number 800263 Revision 3.7

75

Chapter 5 Working with Graphics Editor and Control Objects 3 Alternatively, use the Shift+arrow keys to resize the object one pixel at a time. Use the Ctrl+Shift+arrow keys to resize the object one grid unit at a time.

Sizing multiple objects


To change the size of multiple objects 1 Select one of the objects you want to resize and resize it following the procedure for sizing an object. 2 Select all the objects you want to be the same size as the first object which must remain selected as the dominant object. 3 On the Layout menu or Layout bar choose one of the Same Size commands to resize all selected objects to be the same size as the dominant object.

Aligning objects
Objects can be arranged as a group to align to a similar position to each other or with respect to the document or view of the document determined by the overall size of the Visual Integrator 3 window.
To align objects to a common side Select the dominant object and ensure it is in the position you want to align the other objects to.

2 Select the objects you want to align to the dominant object. 3 On the Layout menu or Layout bar choose one of the AlignObjects: Left, Right, Top, Bottom commands to align all selected objects to be the same side as the dominant object. To align objects to a common center point Select the dominant object and ensure it is in the position you want to align the other objects to.

2 Select the objects you want to align to the dominant object. 3 On the Layout menu choose one of the AlignObjects: Vert.Center, Horz.Center commands to align all selected objects to be the same center point as the dominant object. To align objects with the document border 1 Select the objects you want to align to the document 2 On the Layout menu or Layout bar choose one of the Center in View: Vertical, Horizontal commands to align all selected objects to be the centered in the document. To space objects evenly in the document border 1 Select the objects you want to space out in the document 2 On the Layout menu or Layout bar choose one of the Space Evenly: Across, Down commands to space all selected objects in the document.

76

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Changing tab order


Tab order is the order in which the operator can move the input focus from one control object to another in the document using the Tab key. A control can be included or excluded from the tab order through their properties. To include an object in the tab order, set its Tabstop property to 1Yes. Objects which do not have the Tabstop property cant be included in the tab order.
To change the tab order for an object 1 Select the object you want to change the tab order of. 2 Choose Layout > Set Tab Order. A number at the upper left of the object indicates its place in the tab order. 3 Click inside the object or use the Tab or Shift+tab keys to change the tab order. 4 Click outside the object or use the Enter key to complete the change to the tab order. 5 Alternatively, you can change the tab order through the Object Sheet. See Using Inspector for more information. If the document contains overlapping objects, changing the tab order may change the way they are displayed. Objects that are first in the tab order are always displayed on top of any overlapping objects that follow in the tab order.

Changing drawing order


For objects that overlap, the drawing order determines which object is displayed on top. To change the drawing order for overlapping objects, click repeatedly over the overlapped portion of the objects. Alternatively, select one of the objects and use the Bring to Front of Drawing Order button or Send to Back of Drawing Order on the Layout toolbar. You can also change the drawing order using the Object Sheet, as described below.

Document Number 800263 Revision 3.7

77

Chapter 5 Working with Graphics Editor and Control Objects

Using Inspector
The Inspector provides a dialog box list view of all objects in the document. The drawing order/tab order of the objects can be changed and the Object Code can be changed. Drawn objects, like lines and frames, are displayed in blue text; control objects are displayed in black text. The tab order is displayed by the corresponding tab order number to the left.
To change the tab order for an object 1 Choose Layout > Inspector or use the Ctrl+I keys. The Object Sheet dialog is displayed:

2 To change the drawing order, select an object and click Up and Down. 3 To change the tab order, select an object with a boxed number adjacent to it and click Up and Down. 4 To change the object code for an object, select an object and enter the new name in the Object Code box.

Adding accelerator keys


An accelerator key allows the operator to choose an object by a single key stroke. When an object has a caption, an underlined character appears in the caption to indicate the accelerator key.
To define an accelerator key for a pushbutton, check box or radio button control: 1 Select the control and open its property sheet 2 In the property that sets the caption, enter an ampersand (&) in front of the letter you want as the accelerator key. The caption property for the controls are as follows: Pushbutton Text property Check box Text property Radio button ListItems property Control without visible caption Accelerator property

Viewing and editing object properties


See Chapter 6 Control Objects Reference for a complete description of the control objects and the procedures for viewing and editing object properties.

78

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Adding ActiveX controls from other manufacturers


You may want to add controls from an outside source to Graphics Editor to the Object Bar so they can be incorporated into a document and optionally integrated using Visual BASIC script.
To add an ActiveX control from other manufacturers 1 Install the control onto the computer running Visual Integrator 3 using the installation procedure provided by the manufacturer. If the control does not come with an install set then it should not be used with Visual Integrator 3 because there is likely to be dependent components missing. 2 In Graphics Editor, add the new control to the Object bar by rightclicking on the Object bar and choosing add object. The Insert ActiveX Control dialog is displayed. Select the control from the list and click OK. The new control appears on the Object bar. You can enter another name for the control. Select the control on the Object bar, rightclick and choose Customize from the popup menu. Graphics Editor uses the name when you are creating new instances of a control; it prepends the name to a number as the identifier for a new instance of a control

Document Number 800263 Revision 3.7

79

Chapter 5 Working with Graphics Editor and Control Objects

This page is left blank intentionally.

80

Document Number 800263 Revision 3.7

Chapter 6 Control Objects Reference

ontrol objects, often referred to as ActiveX objects or simply as objects, provide the basic tools for creating a custom HMI that is tailored to the customers needs. Chapter 5 Working with Graphics Editor and Control Objects describes how to use Graphics Editor to place objects on the document and position them as required. This chapter provides, in reference format, detailed information about each objects properties. Properties are the most powerful tool available to you for controlling object appearance and behavior. Only by fully understanding the effect of the properties on an object you can unleash its full power to the HMI.

Working with object properties


This section introduces the basics of object properties and describes the three types of properties that most objects have.

Viewing object properties


To view an objects properties: 1 Select the document you want to work with in the Visual Integrator 3 TreeView pane. 2 Choose File > Graphics Editor or click Graphics Editor on the toolbar. Graphics Editor is launched and opens the selected document that typically consists of several objects. 3 Select an object you want to view the properties of. 4 Use one of the methods below to open the objects property sheets:

Choose Layout > Properties Use the Properties button in the Layout bar Press the Enter key Rightclick or doubleclick on the object
5 The property sheet is displayed, typically as follows:

Document Number 800263 Revision 3.7

81

Chapter 6 Control Objects Reference

The component parts of the typical property sheet are described in the next section.

Components of object properties


The components of a typical object property sheet are common to all objects. For the exact layout and description of a specific objects property sheet, see the reference section later in this chapter.
A B D

C E

A Object identifier This list box shows the object identifiers for all objects in the document. An objects identifier is a

unique name assigned by Graphics Editor when the object is added to the document. It is a programmatic name that can be used in Visual BASIC script programs. Click on any object identifier in the list to view its properties. The object identifier for a particular object is also displayed in the (ObjectCode) property.
B Tabs All objects property sheets contain the Normal and the Events tabs. Most objects property sheets also have the ActiveX tab. These property tabs are described later in this section. C Property names The left column on a property tab lists the names of the properties supported by the object. D Shortcut menu button Click the shortcut button to display the menu:
OK Cancel Drill Multi Enter Esc Saves property values and close property sheet Close property sheet without saving property values This command is enabled when multiple objects are selected. If objects within the selection have different values for the same property, the MultiDrill command makes all properties the same as those of the dominant object. Set these properties as the default properties when adding new objects of the same type to a document.

Save as Default

82

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Clear Default Delete Sort

Revert to original defaults for the object. Delete the object from the document Sort the property list in AZ order.

E Property values The right column on a property tab displays the property values corresponding to the property name in the left column and provides the capability to edit the property values. When you select a

property name on the left side, a button may appear on the right side in the property value field:
A list button to display a list of options for the property A goto button [] to open a dialog or property sheet for the property A dropdown list button to display a list of options for the property

Normal properties
Normal properties specify the objects appearance and tab order. Most objects share the same normal properties. Normal properties for each object are described in detail in the reference section.

Event properties
The Events property tab is typically displayed as follows:

By clicking the goto button to the right of the selected event, you can display the Visual BASIC Script (VBS) MiniEditor. The VBS MiniEditor allows you to create a subroutine in Visual BASIC script to implement a custom action when the corresponding event occurs. See Using Visual BASIC MiniEditor and Script Wizard section later in this chapter for a description of how to use events in Visual BASIC script.

Document Number 800263 Revision 3.7

83

Chapter 6 Control Objects Reference

ActiveX properties
The ActiveX property tab is typically displayed as follows:

By clicking the goto button to the right of (OCXProperties), you can display a dialog pertaining to the main ActiveX properties of the object.

Control object reference


This reference provides the detailed description of each object and its properties, in alphabetical order.

Button
The Button object is used to provide a graphical representation of a Windows dialog button on the document. Typically the button is used in combination with an overlaid image object and its hyperlink property to allow the operator to jump to another document when the button is clicked. It can also be used to cause an event that will run a script in Visual BASIC.
Normal properties Button

Button Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Color of the object. Click and choose color from dropdown list

BackColor

84

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Button Property
Bitmap

Description
Specifies the image to use as the button shape to replace or supplement the default button image. Click to open the Bitmap dialog:

1 Click Load and navigate to location of image you want to use then select the image. 2 Check Link to store the link to the loaded file, the file path and the document will load it from there, When Link is unchecked entire contents of the bitmap is stored in the document. 3 Click OK to add image to button. Bottom ButtonShape Coordinate position of the bottom edge of the object Choose a button shape from: 0Normal 1Property Tab (Inactive) 2Property Tab (Active) ButtonType Choose a button type from: 0EventClick 1Help CursorPointer Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Default Enable 4UpArrow 5NoDrop 6Help 99HotSpot

This property has no effect. Choose from: 0No button has no effect 1Yes button triggers event

Font Group HelpContextID Left

Choose the font style for the text label on the object. Click to open the Font dialog. Use the Text property to set the text. This property has no effect. Not used Coordinate position of the left edge of the object

Document Number 800263 Revision 3.7

85

Chapter 6 Control Objects Reference

Button Property
Right Tabstop

Description
Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Text TextColor Top Visible

The text label on the object. Use the Font property to set the font for this text. Use the TextColor property to set the color for this text. Choose the color for the text label on the object. Click to open the dropdown list. Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties Button See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


Button Property
EventClick EventInitialize

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

CheckButton
The CheckButton object adds a checkbox that can be used with Visual BASIC script. Check boxes work as on and off switches.
Normal properties CheckButton CheckButton Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Choose whether the text is to the right of the checkbox or to the left, from: 0No text is to the right of the checkbox 1Yes text is to the left of the checkbox BackColor Color of the object. Click and choose color from dropdown list

AlignTextLeft

86

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

CheckButton Property
Bitmap

Description
Image to use as the button shape to replace the default checkbox image, when checkbox is checked. Click to open the Bitmap Dialog. Refer to Bitmap property for the Button object for more information about this dialog. See also OwnerDrawn property.

BitmapOffState

Image to use as the button shape to replace the default checkbox image, when checkbox is unchecked. Click to open the Bitmap Dialog. Refer to Bitmap property for the Button object for more information about this dialog. See also OwnerDrawn property.

Bottom CursorPointer

Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable

Choose from: 0No checkbox has no effect 1Yes checkbox triggers event

Font Group HelpContextID HelpHotButton Left OwnerDrawn

Choose the font style for the text label on the object. Click to open the Font dialog. Use the Text property to set the text. This property has no effect. Not used Not used Coordinate position of the left edge of the object Choose whether to enable the use of bitmaps specified by the Bitmap and BitmapOffState properties, from: 0No do not enable the use of bitmaps, use standard Windows checkbox 1Yes enable the use of bitmaps When OwnerDrawn property is set to Yes, TriState property has no effect.

Right Tabstop

Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Text TextColor Top

The text label on the object. Use the Font property to set the font for this text. Use the TextColor property to set the color for this text. Choose the color for the text label on the object. Click to open the dropdown list. Coordinate position of the top edge of the object

Document Number 800263 Revision 3.7

87

Chapter 6 Control Objects Reference

CheckButton Property
TriState

Description
Choose whether the checkbox has three states: check, uncheck and ambiguous. Ambiguous displays a grey check mark while check displays a black check mark and uncheck displays no check mark, from 0No do not include the ambiguous state 1Yes include the ambiguous state When OwnerDrawn property is set to Yes, TriState property has no effect.

ValueID Visible

Not used Choose whether the object is visible, from: 0No not visible 1Yes visible

Events properties CheckButton See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


CheckButton Property
EventChange

Description
Specifies the script in Visual BASIC to execute when the check box changes. Click to open the VBS MiniEditor. See Appendix for a description of the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. See Appendix for a description of the VBS MiniEditor.

EventInitialize

CirconAlarm
The CirconAlarm object displays the alarm description text of the most recent alarm received from the target device. CirconAlarm can be used with Circon devices that use UNVTAlarm to report the alarm or with any devices that use SNVT_alarm to report the alarm. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties CirconAlarm CirconAlarm Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object

BackColor Bottom

88

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

CirconAlarm Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible, from: 0No not visible 1Yes visible

Events properties CirconAlarm See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


CirconAlarm Property
EventClick EventDblClick EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

Document Number 800263 Revision 3.7

89

Chapter 6 Control Objects Reference

ActiveX properties CirconAlarm CirconAlarm Property Description


OCXProperties Specifies the source of the alarm to be displayed on the object. To specify the source of the alarm: 1. Click to open the CirconAlarm Control Properties dialog:

2. Click Browse to open the Select Object dialog. Navigate to locate the device you want to be the source of the alarm. Select its NodeObject and network variable nvoAlarmOut and click OK:

3. Set the Hyperlink target as described below for the Hyperlink property. Alignment Choose the alignment of the data displayed on the object, from: 0Left justified 1Right justified 2Centered BackColor BackColorAdvisory BackColorMajor Color of the background area when the object has no alarm to display or when the ErrorCaption is displayed. Click and choose color from Color dialog. Color of the background area when an Advisory priority alarm is displayed. Click and choose color from Color dialog. Color of the background area when a Major priority alarm is displayed. Click and choose color from Color dialog.

90

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

CirconAlarm Property
BackColorMinor BackColorNormal BackColorWarning BackStyle

Description
Color of the background area when a Minor priority alarm is displayed. Click and choose color from Color dialog. Color of the background area when a Normal priority alarm is displayed. Click and choose color from Color dialog. Color of the background area when a Warning priority alarm is displayed. Click and choose color from Color dialog. Choose the style of the background, from: 0Transparent. the background disappears 1Opaque.the background is displayed according to the BackColor setting.

BorderStyle

Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line

ErrorCaption Font ForeColor ForeColorAdvisory ForeColorMajor ForeColorMinor ForeColorNormal ForeColorWarning

Type the text to display when the alarm network variable value is not available. Choose the font style for the path text displayed on the object. Click to open the Font dialog. Color of the text when the object has no alarm to display or when the ErrorCaption is displayed. Click and choose color from Color dialog. Color of the text when an Advisory priority alarm is displayed. Click and choose color from Color dialog. Color of the text when a Major priority alarm is displayed. Click and choose color from Color dialog. Color of the text when a Minor priority alarm is displayed. Click and choose color from Color dialog. Color of the text when a Normal priority alarm is displayed. Click and choose color from Color dialog. Color of the text when a Warning priority alarm is displayed. Click and choose color from Color dialog.

Document Number 800263 Revision 3.7

91

Chapter 6 Control Objects Reference

CirconAlarm Property
Hyperlink

Description
Enter the path of another Visual Integrator 3 document that will be displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog.

Path ShowToolTip

A readonly field that displays the path to the source of the alarm. Choose whether to display the tool tip text, from: 0No do not display the tool tip 1Yes display tool tip text or path to source

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source of the alarm is displayed.

DataLabel
The DataLabel object was obsoleted in version 3.6 and replaced with the ObjectLabel object, when the BackStyle property was added. Support for DataLabel objects in existing graphics remains in the product.

DataObject
The DataObject object was obsoleted in version 3.6 and replaced with the DataPoint object, when the BackStyle property was added. Support for DataObject objects in existing graphics remains in the product.

DataPoint
Use the DataPoint object with a network variable or configuration property that contains analog values, such as network variables of type SNVT_temp_p or SNVT_press. DataPoint can be used to perform the following functions: Display value of network variable or configuration property as text; or Set value of configuration property; or

92

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Override value of network variable of a Circon device only.

To set a configuration property or override a network variable the operator must have the corresponding permission. See the NVDigital object for network variables that contain digital values, or the EnumPoint object for network variables that contain enumerated values. DataPoint displays the data from a target network variable source specified by a full path to a LNS object including network, subsystem, device, functional block, network variable and field. DataPoint tracks the full path; if the source is renamed in the LNS database, the path will change in the object.
Overriding using DataPoint DataPoint allows the operator to override the target network variable: by rightclicking the object

to display the Set Value dialog:

Set value dialog when AutoValue property not set

Set value dialog when AutoValue property is set

If the operator does not have permissions to override, the Apply and Auto buttons are disabled. Overriding can be accomplished using either of two mechanisms: via another separate network variable or via the LonMark standard configuration property SCPTovrValue. Using SCPTovrValue has a higher priority than the network variable override. Not all functional blocks provide SCPTovrValue. Some functional blocks provide a separate override network variable. For example, the I/O functional blocks in the Circon UHC300 device have both a network variable and a SCPTovrValue. The Circon plugins use SCPTovrValue to override; if DataPoint uses the network variable then an override by the plugin will prevail. To override network variables, an operator must be a member of an operator group with Override Network Variables permission. Similarly, to override configuration properties, an operator must be a member of an operator group with Override Configuration Properties permission. See Chapter 14 Securing access to a site for a description of these and other permissions. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.

Document Number 800263 Revision 3.7

93

Chapter 6 Control Objects Reference

Normal properties DataPoint DataPoint Property Description


ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible, from: 0No not visible 1Yes visible

Events properties DataPoint See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


DataPoint Property
EventChange EventClick EventDblClick

Description
Specifies the script in Visual BASIC to execute when the data value displayed by the object changes. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor.

94

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

DataPoint Property
EventError

Description
Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved. while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

EventInitialize EventMouseDown EventMouseMove EventMouseUp

ActiveX properties DataPoint DataPoint Property Description


OCXProperties Allows you to set the objects properties: path to network variable or configuration of data to display path to override network variable if different or override SCPT hyperlink color of data displayed font used to display data Choose the alignment of the data displayed on the object, from: 0Left justified 1Right justified 2Centered

Alignment

Document Number 800263 Revision 3.7

95

Chapter 6 Control Objects Reference

DataPoint Property
AutoValue

Description
Network variable override and AutoValue apply to Circon devices only. Enter the auto value for this network variable as a raw unitsindependent decimal number. When network variable is set to the auto value it is no longer considered to be overridden. The auto value for a network variable depends on its associated SNVT and is typically the invalid value for that SVNT as specified in the SVNT Master documentation provided by the LonMark Association. Typically, only SNVTs that are one and two byte are overridden, not floating point or structured SNVTS. The table below provides some examples: Data type 2 byte signed 2 byte unsigned enumerated Auto value 32767 66535 xx_NUL Example SVNTs SNVT_temp_p, SNVT_flow SNVT_lev_desc, SNVT_Occupancy

When this property is set, the Set Value dialog includes an Auto button which applies this value to the target. BackColor Color of the object. Click and choose color from Color dialog. Alternatively, you can set the color using the Color tab of the OCXProperties properties dialog. Choose the style of the background, from: 0Transparent. the background disappears 1Opaque.the background is displayed according to the BackColor setting. BorderStyle Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line DataSourceOptions Choose how the object reads data from the target, from: 0Normal: the value is read directly from the device if the source configuration property is devicespecific. If the source configuration property is not device specific, the value is read from the database, as long as it is stored there. If its value does not exist in the database, then the value is read directly from the device, as long as the network management mode is set to OnNet. Writing a configuration property value would write to the device and the LNS database 1FromDevice: The value is always read directly from the device. 2DatabaseOnly: The value is always read directly from the LNS database. ErrorCaption Font Type the text to display when the network variable value is not available. Choose the font style for the data displayed on the object. Click to open the Font dialog. Alternatively, you can set the font using the Font tab of the OCXProperties properties dialog.

BackStyle

96

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

DataPoint Property
ForeColor

Description
Font color of the text used to display the data. Click and choose color from Color dialog. Alternatively, you can set the color using the Color tab of the OCXProperties properties dialog. Use this property when you want to change the format specification of the network variable or configuration property target of the object so that the units displayed are appropriate to the application. Enter the network variable type that has the format you require, in the form SNVT_xxxx where SNVT_xxxx is the name of the network variable type as specificed in the LonMark SNVT Master. Example: you are using a shared EEPROM variables in a UHC302PRG as a temperature setpoint in your BASIC program. The path to the EEPROM variable would be: "SharedVars/UCPTsharedEEPROMVal[0]". In your BASIC program, you are treating this value as a SNVT_temp_p. You want the operator to be able to modify this variable from a document using a dataobject so that they can change this setpoint. When the dataobject is put on a document and displays this variable the raw units are used: 32 deg F is displayed as "0". To have this formatted in a way that makes sense to the operator, set the FormatType property to "SNVT_temp_p" the variable is now displayed as "32 deg F"

FormatType

Hyperlink

Enter the path of another Visual Integrator 3 document that will be displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog.

OvrCaption

Enter the text that is displayed in front of the override value when a network variable is overridden. The default text is Ovr. Network variable override applies to Circon devices only.

OvrColor

Choose the color of the text used to display the override caption and the override data. Click and choose color from Color dialog. Alternatively, you can set the color using the Color tab of the OCXProperties properties dialog. Network variable override applies to Circon devices only. Displays the path set using the OCXProperties property Enter the number of numerals that will be displayed in conjunction with the PrecisionFixed property

Path Precision

Document Number 800263 Revision 3.7

97

Chapter 6 Control Objects Reference

DataPoint Property
PrecisionFixed

Description
Choose precision displayed, from: 0No display value using total number of numerals specified by Precision property 1Yes display value with number of numerals to right of decimal point specified by Precision property

ReadOnly

Choose whether to allow this network variable to be overridden or configuration property to be set, from: 0No rightclicking does not display the override dialog 1Yes rightclicking displays the override dialog

ShowToolTip

Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source

ShowUnits

Choose whether the units of measure are displayed, from: 0No units not displayed 1Yes units are displayed See also the Units property below. See section Displaying units of measure later in this chapter for a description of how units text is determined.

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed. Enter the text you want displayed as the units of measure when ShowUnits property is set to Yes. The Units property supercedes all other mechanisms for determining the displayed units of measure for this object. If this property is blank then the units of measure are determined by the LonMark default units text defined for this SNVT. See section Displaying units of measure later in this chapter for a description of how units text is determined.

Units

DeviceStatus
Use the DeviceStatus object displays the status of a device, in text or images.
Normal properties DeviceStatus DeviceStatus Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object

BackColor Bottom

98

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

DeviceStatus Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties DeviceStatus SeeUsing Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


DeviceStatus Property
EventClick EventDblClick EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

Document Number 800263 Revision 3.7

99

Chapter 6 Control Objects Reference

ActiveX properties DeviceStatus

DeviceStatus Property Description


OCXProperties Alignment Allows you to specify the target device, hyperlink, font and image to display for the various device status states. Choose the alignment of the text displayed on the object, from: 0Left justified 1Right justified 2Centered BackColor BackStyle Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the background, from: 0Transparent the background disappears 1Opaque the background is displayed according to the BackColor setting. ErrorCaption Font Type the text to display when the device is not available. Choose the font style for the caption text displayed on the object. Click to open the Font dialog. Use the Text properties to set the text. Alternatively, you can set the font using the Font tab of the OCXProperties properties dialog. Color of the caption text displayed on the object. Click and choose color from Color dialog. Type the path of another Visual Integrator 3 document that is displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog. PollInterval The elapsed time, in seconds, between device status updates. When PollInterval is set to zero, the status is updated only when the document is opened or refreshed.

ForeColor Hyperlink

100

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

DeviceStatus Property Description


ShowToolTip Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source StateCnfgBypassCaption StateCnfgOfflineCaption StateCnfgOnlineCaption StateNoApplUncnfgCaption StateSoftOfflineCaption StateUncnfgCaption Stretch Type the text to display when the device is configured and in bypass. Type the text to display when the device is configured and offline. Type the text to display when the device is configured and online. Type the text to display when the device has no application and is unconfigured. Type the text to display when the device is configured and soft offline. Type the text to display when the device is unconfigured. Choose whether or not to stretch the images associated with the device states, to fit the size of the object area, from: 0No image retains its default size. Resizing the image area does not resize the image. 1Yes image is sized to fit the image area. Resizing the image area also resizes the image. ToolTipText Type the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

EditBox
The EditBox object provides an area to display text or allow the operator to enter text.
Normal properties EditBox EditBox Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Accelerator key for the object. Click and choose key from dropdown list. When accelerator key is pressed, the cursor goes to this edit box. Choose the alignment of the text displayed on the object, from: 0Left justified 1Centered 2Right justified BackColor BorderDrawn Bottom Color of the object. Click and choose color from dropdown list This property has no effect. Coordinate position of the bottom edge of the object

Accelerator Alignment

Document Number 800263 Revision 3.7

101

Chapter 6 Control Objects Reference

EditBox Property
CaseOrPassword

Description
Choose how the text is displayed when entered by the operator, from: 0none upper and lower case as entered 1Lower Case always upper case 2Upper Case always lower case 3Password always as asterisks

CursorPointer

Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable

Choose from: 0No Enter key has no effect 1Yes Enter key triggers event

Font Group HelpContextID HelpHotButton Left ReadOnly

Choose the font style for the text on the object. Click to open the Font dialog. This property has no effect. Not used Not used Coordinate position of the left edge of the object Choose whether to allow the operator to enter text, from: 0No text Is for display only 1Yes operator can enter text, VB Script needed to support

Right Tabstop

Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

TextColor Top UseColors

Choose the color for the text on the object. Click to open the dropdown list. Coordinate position of the top edge of the object Choose to use the colors specified by the BackColor and TextColor properties, from: 0No revert to black and white 1Yes use the colors as set by properties

ValueID Visible

This property has no effect. Choose whether the object is visible from: 0No not visible 1Yes visible

102

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Events properties EditBox See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


EditBox Property
EventChange EventInitialize

Description
Specifies the script in Visual BASIC to execute when operator changes object by entering text and pressing Enter key. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

EnumObject
The EnumObject object was obsoleted in version 3.6 and replaced with the EnumPoint object, when the BackStyle property was added. Support for EnumObject objects in existing graphics remains in the product.

EnumPoint
Use the EnumPoint object with a network variable or configuration property that contains enumerated values such as network variables of type SNVT_occupancy. EnumPoint can be used to perform the following functions: Display value of network variable or configuration property as text; or Set value of configuration property; or Override value of network variable of a Circon device only.

Overriding using EnumPoint EnumPoint allows the operator to override the target network variable by rightclicking the object

to display the Set Value dialog:

Set value dialog when AutoValue property not set

Set value dialog when AutoValue property is set

If the operator does not have permissions to override, the Apply and Auto buttons are disabled. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.

Document Number 800263 Revision 3.7

103

Chapter 6 Control Objects Reference

Normal properties EnumPoint EnumPoint Property Description


ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties EnumPoint See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


EnumPoint Property
EventChange EventClick EventDblClick EventError

Description
Specifies the script in Visual BASIC to execute when the data value displayed by the object changes. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor.

104

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

EnumPoint Property
EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties EnumPoint EnumPoint Property Description


OCXProperties Allows you to set multiple properties of the object: path to network variable or configuration property of data to display path to override network variable if different translation text for each enumeration translation image for each enumeration hyperlink color of text displayed for each enumeration (back color) color background to text displayed for each enumeration (fore color) font used to display text Choose the alignment of the data displayed on the object, from: 0Left justified 1Right justified 2Centered AutoValue Network variable override and AutoValue apply to Circon devices only. Enter the auto value for this network variable. This is the text associated with the invalid value enumeration. For example, for SNVT_occupancy it is OC_NUL. When network variable is set to the auto value it is no longer considered to be overridden. The auto value for a network variable depends on its associated SNVT and is typically the invalid value for that SVNT as specified in the SVNT Master documentation provided by the LonMark Association. When this property is set, the Set Value dialog includes an Auto button which applies this value to the target. BackColor BackStyle Color of the object. Click and choose color from Color dialog. Alternatively, you can set the color using the Color tab of the OCXProperties properties dialog. Choose the style of the background, from: 0Transparent. the background disappears 1Opaque.the background is displayed according to the BackColor setting.

Alignment

Document Number 800263 Revision 3.7

105

Chapter 6 Control Objects Reference

EnumPoint Property
BorderStyle

Description
Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line

DataSourceOptions

Choose how the object reads data from the target, from: 0Normal: the value is read directly from the device if the source configuration property is devicespecific. If the source configuration property is not device specific, the value is read from the database, as long as it is stored there. If its value does not exist in the database, then the value is read directly from the device, as long as the network management mode is set to OnNet. Writing a configuration property value would write to the device and the LNS database 1FromDevice: The value is always read directly from the device. 2DatabaseOnly: The value is always read directly from the LNS database.

ErrorCaption Font

Type the text to display when the network variable value is not available. Choose the font style for the text displayed on the object. Click to open the Font dialog. Alternatively, you can set the font using the Font tab of the OCXProperties properties dialog. Enter the path of another Visual Integrator 3 document that will be displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog.

Hyperlink

OvrCaption

Enter the text that is displayed in front of the value when a network variable is overridden. The default text is Ovr. Network variable override applies to Circon devices only. Displays the path set using the OCXProperties property Choose whether to allow this network variable to be overridden or configuration property to be set, from: 0No rightclicking does not display the override dialog 1Yes rightclicking displays the override dialog

Path ReadOnly

106

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

EnumPoint Property
ShowToolTip

Description
Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source

Stretch

Choose whether or not to stretch the images associated with the enumerations to fit the size of the object area, from: 0No image retains its default size. Resizing the image area does not resize the image. 1Yes image is sized to fit the image area. Resizing the image area also resizes the image.

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

Frame
The frame object provides a labeled border to enclose other objects.
Normal properties Frame

Frame Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Choose the alignment of the text displayed on the top border of the object, from: 0Left justified 1Centered 2Right justified

Alignment

BackColor BorderStyle

Color of the object. Click and choose color from dropdown list. Use ForeColor property to set the color of the frame border. Choose the appearance of the border, from: 0Normal 13D 2Sunken

BorderWidth Bottom

Enter the line width of the frame, in pixels. 0 is invisible, 94 is the thickest. BorderWidth of zero applies only when BorderStyle is set to Normal or Sunken. Coordinate position of the bottom edge of the object

Document Number 800263 Revision 3.7

107

Chapter 6 Control Objects Reference

Frame Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable Font

This property has no effect. Choose the font style for the label that appears in the top border of the frame on the object. Click to open the Font dialog. Use the Text property to set the text. Choose the color for the frame border. Click to open the color dialog. ForeColor applies only when BorderStyle is set to Normal or Sunken. Not used This property has no effect. Coordinate position of the left edge of the object Coordinate position of the right edge of the object Enter the text for the label that appears in the top border of the frame. Use Alignment property to position the text. Choose the color for the text on the object. Click to open the dropdown list. Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

ForeColor HelpContextID HiliteColor Left Right Text TextColor Top Visible

Events properties Frame See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


Frame Property
EventClick EventInitialize

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor..

Image
The Image object provides an area to hold an image that has been created by an external drawing tool. The image must be available as a file of type bmp, gif or jpg.

108

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Normal properties Image

Image Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties Image See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


Image Property
EventClick EventDblClick EventInitialize EventMouseDown EventMouseMove

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor.

Document Number 800263 Revision 3.7

109

Chapter 6 Control Objects Reference

Image Property
EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties Image

Image Property
OCXProperties

Description
Allows you to preview and import the image you want to display in the image area. Also allows you to set the hyperlink. Click to open the Properties dialog:

BackColor BackStyle

Color of the object, displayed in parts of the image area not covered by the image. Click and choose color from Color dialog. Choose the style of the background around the image, from: 0Transparent does not block view of objects behind it. 1Opaque background set to color specified by BackColor property. Image is doublebuffered to minimize flickering.

BorderStyle

Choose the style of the border around the object, from: 0None no visible border line 1Single line 2Sunken 3Raised

110

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Image Property
Hyperlink

Description
Enter the path of another Visual Integrator 3 document that is displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog.

Stretch

Choose whether or not to stretch the image to fit the size of the image area, from: 0No image retains its default size. Resizing the image area does not resize the image. 1Yes image is sized to fit the image area. Resizing the image area also resizes the image.

Inspector
The Inspector object displays current values of network variables and configuration properties for up to four functional blocks. Operators with Override permissions can also override or change network variable values or configuration property values. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties Inspector Inspector Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect.

Document Number 800263 Revision 3.7

111

Chapter 6 Control Objects Reference

Inspector Property
Group HelpContextID Left Right Tabstop

Description
This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties Inspector See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


Inspector Property
EventClick EventInitialize

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

ActiveX properties Inspector Inspector Property Description


OCXProperties BackColor BackColorConfig Property1 BackColorConfig Property2 BackColorConfig Property3 BackColorConfig Property4 Allows you to set the path to the target functional blocks. Color of the object, displayed in parts of the image area not covered by the image. Click and choose color from Color dialog. Color of the background for the configuration properties of functional block 1. Click and choose color from Color dialog. Color of the background for the configuration properties of functional block 2. Click and choose color from Color dialog. Color of the background for the configuration properties of functional block 3. Click and choose color from Color dialog. Color of the background for the configuration properties of functional block 4. Click and choose color from Color dialog.

112

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Inspector Property
BackColorNetwork Variable1 BackColorNetwork Variable2 BackColorNetwork Variable3 BackColorNetwork Variable4 ColumnWidthApp Device ColumnWidthAuto

Description
Color of the background for the network variables of functional block 1. Click and choose color from Color dialog. Color of the background for the network variables of functional block 2. Click and choose color from Color dialog. Color of the background for the network variables of functional block 3. Click and choose color from Color dialog. Color of the background for the network variables of functional block 4. Click and choose color from Color dialog. Enter the width in pixels of the Device column. This determines the column width when ColumnWidthAuto property is set to No. Setting width to zero hides column. Choose whether all columns are automatically sized to the same width such that all columns fit in the boundaries of the object without needing a horizontal scroll bar, from: 0No use the ColumnWidth properties to determine the column widths and display a horizontal scroll bar if necessary. 1Yes automatically size the columns.

ColumnWidth ConfigProperty ColumnWidth FunctionalBlock ColumnWidth NetworkVariable ColumnWidth Subsystem ColumnWidth Value Font

Enter the width in pixels of the Config Property column. This determines the column width when ColumnWidthAuto property is set to No. Setting width to zero hides column. Enter the width in pixels of the Functional Block column. This determines the column width when ColumnWidthAuto property is set to No. Setting width to zero hides column. Enter the width in pixels of the Network Variable column. This determines the column width when ColumnWidthAuto property is set to No. Setting width to zero hides column. Enter the width in pixels of the Subsystem column. This determines the column width when ColumnWidthAuto property is set to No. Setting width to zero hides column. Enter the width in pixels of the Value column. This determines the column width when ColumnWidthAuto property is set to No. Setting width to zero hides column. Choose the font style for the text of both the column headings and the displayed data. Click to open the Font dialog. Use the ForeColor properties to set the color of the text. Color of the text of the data for the configuration properties of functional block 1. Click and choose color from Color dialog. Color of the text of the data for the configuration properties of functional block 2. Click and choose color from Color dialog. Color of the text of the data for the configuration properties of functional block 3. Click and choose color from Color dialog.

ForeColorConfig Property1 ForeColorConfig Property2 ForeColorConfig Property3

Document Number 800263 Revision 3.7

113

Chapter 6 Control Objects Reference

Inspector Property
ForeColorConfig Property4 ForeColorNetwork Variable1 ForeColorNetwork Variable2 ForeColorNetwork Variable3 ForeColorNetwork Variable4 Path1 Path2 Path3 Path4 ShowConfig Properties

Description
Color of the text of the data for the configuration properties of functional block 4. Click and choose color from Color dialog. Color of the text of the data for the network variables of functional block 1. Click and choose color from Color dialog. Color of the text of the data for the network variables of functional block 2. Click and choose color from Color dialog. Color of the text of the data for the network variables of functional block 3. Click and choose color from Color dialog. Color of the text of the data for the network variables of functional block 4. Click and choose color from Color dialog. Displays the path to functional block 1 set using the OCXProperties dialog. Displays the path to functional block 2 set using the OCXProperties dialog. Displays the path to functional block 3 set using the OCXProperties dialog. Displays the path to functional block 4 set using the OCXProperties dialog. Choose whether to display configuration properties for target functional blocks, from: 0No do not display configuration properties 1Yes display configuration properties.

ShowNetwork Variables

Choose whether to display network variables for target functional blocks, from: 0No do not display network variables 1Yes display network variables.

Label
The Label object displays fixed text that does not change.
Normal properties Label

Label Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

Enable

This property has no effect.

114

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Label Property
Group HelpContextID Left Right Tabstop

Description
This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties Label See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


Label Property
EventClick EventDblClick EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties Label

Label Property
OCXProperties Alignment

Description
Allows you to set the hyperlink. Click to open the General dialog. Choose the alignment of the text displayed on the object, from: 0Left justified 1Right justified 2Centered.

Document Number 800263 Revision 3.7

115

Chapter 6 Control Objects Reference

Label Property
BackColor BackStyle

Description
Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the background around the text, from: 0Transparent does not block view of objects behind it. 1Opaque background set to color specified by BackColor property.

BorderStyle

Choose the style of the border around the object, from: 0None no visible border line 1FixedSingle line

Caption Enabled

Enter the text that is displayed as the label. Choose from: 0No, label is not displayed 1Yes, label is displayed

Font ForeColor Hyperlink

Choose the font style for the text. Click to open the Font dialog. Use the Caption property to set the text. Choose the color for the text. Click to open the color dialog. Enter the path of another Visual Integrator 3 document that will be displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog.

ShowToolTip

Choose whether to display the tool tip text, from: 0No do not display the tool tip 1Yes display tool tip text

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes If this property is left blank then no tool tip text is displayed

116

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Line
The Line object displays a straight line.
Normal properties Line

Line Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Choose the position of the line within the object, from 0\ diagonal from upper left corner to lower right corner 1center horizontal 2/ diagonal from lower left corner to upper right corner

Alignment

Bottom Color CursorPointer

Coordinate position of the bottom edge of the object Choose the color for the line. Click to open the color dialog. Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable

Choose from: 0No, events are not triggered 1Yes, events for this object are triggered.

HelpContextID Left PenStyle

Not used Coordinate position of the left edge of the object Choose the style of the line, from 0solid 1dash 2dot 3dashdot 4dashdotdot

Right Top Visible

Coordinate position of the right edge of the object Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Document Number 800263 Revision 3.7

117

Chapter 6 Control Objects Reference

Events properties Line See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


Line Property
EventClick EventInitialize

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

NVAnimated
Use the NVAnimated object to add animation to a document. For example, an animated fan and damper that moves to reflect the speed and position indicated by network variable values. NVAnimated relies on a sequence of drawings or frames contained in an animated Graphical Interchange Format (GIF) file. Several animated GIF files are supplied with Visual Integrator 3, located at C:\Program Files\Circon\BIN\Images. To determine if a .gif file contains animation, drag it onto Internet Explorer; the animation animates if present. It is outside the scope of this document to describe how to create animated GIF files. Animated GIF files cant be created using Visual Integrator 3. IMPORTANT: Variations in the speed of the animation may occur when more than four or five NVanimated objects are added to the same document. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties NVAnimated NVAnimated Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect.

118

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

NVAnimated Property
HelpContextID Left Right Tabstop

Description
Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties NVAnimated See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


NVAnimated Property
EventClick EventDblClick EventInitialize EventKeyPress EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when a key is pressed. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties NVAnimated NVAnimated Property Description


OCXProperties Allows you to specify the network variable, the GIF file and how it is animated by the network variable, and translations from network variable text to numeric values suitable for sequencing the animated GIF. Click to open the threetab dialog.

Document Number 800263 Revision 3.7

119

Chapter 6 Control Objects Reference

NVAnimated Property
BackColor BackStyle

Description
Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the background around the text, from: 0Transparent does not block view of objects behind it. 1Opaque background set to color specified by BackColor property.

BorderStyle

Choose the style of the border around the object, from: 0None no visible border line 1FixedSingle line

GifFile Path Sequence

Use the OCXProperties dialog to specify the GIF file Use the OCXProperties dialog to specify the path to the network variable. Choose how the GIF frames are sequenced, from MapRangeToFrames the frames are sequenced according to the network variable value. Eg a damper MapRangeToSpeed the rate at which the frames are sequenced is determined by the network variable value. Eg a fan Use the OCXProperties dialog to specify the type of sequencing.

ShowToolTip

Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source

SpeedHigh

Maximum speed of animation in frames per minute when the Sequence property is set to MapRangeToSpeed. Can also be set using sliders on the OCXProperties dialog. Minimum speed of animation in frames per minute when the Sequence property is set to MapRangeToSpeed. Can also be set using sliders on the OCXProperties dialog. Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed. Use the OCXProperties dialog to specify the maximum network variable value. Values greater than ValueMax are treated as if they were ValueMax. Use the OCXProperties dialog to specify the minimum network variable value. Values less than ValueMin are treated as if they were ValueMin.

SpeedLow

ToolTipText

ValueMax ValueMin

NVDigital
Use the NVDigital object with a network variable or configuration property that contains discrete digital on, off values such as network variables of type SNVT_lev_disc or SNVT_state. NVDigital can be used to perform the following functions: Display value of network variable or configuration property as text or image; or

120

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Set value of configuration property; or Override value of network variable of a Circon device only.

Overriding using NVDigital NVDigital allows the operator to override the target network variable by rightclicking the object

to display the Set Value dialog similar to following:

Set value dialog when AutoValue property not set

Set value dialog when AutoValue property is set

To set a configuration property or override a network variable the operator must have the corresponding permission. See the SwitchPoint object for network variables of type SNVT_switch. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties NVDigital NVDigital Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Document Number 800263 Revision 3.7

121

Chapter 6 Control Objects Reference

NVDigital Property
Top Visible

Description
Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties NVDigital See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


NVDigital Property
EventChange EventClick EventDblClick EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when the value of target network variable changes. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties NVDigital NVDigital Property Description


OCXProperties Alignment Allows you to specify the target network variable or CP, hyperlink, font and image to display for the various value states. Choose the alignment of the text displayed on the object, from: 0Left justified 1Right justified 2Centered

122

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

NVDigital Property
AutoValue

Description
Network variable override and AutoValue apply to Circon devices only. When a network variable is set to its auto value it is no longer considered to be overridden. The auto value for a network variable depends on its associated SNVT and is typically the invalid value for that SVNT as specified in the SVNT Master documentation provided by the LonMark Association. For SNVT_lev_desc use ST_NUL; for other network variable types, auto value depends on implementation. When this property is set, the Set Value dialog includes an Auto button which applies this value to the target.

BackColor BorderStyle

Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the border around the object, from: 0None no visible border line 1FixedSingle visible border line displayed

DifferentOvrVar

Choose whether the network variable used to override is different than the network variable that supplies the data, from: 0No the same network variable is used 1Yes a different network variable is used Alternatively, you can set the DifferentOvrVar property using the Different Override Variable checkbox on the Locate Object tab of the OCXProperties properties dialog. Network variable override applies to Circon devices only.

Font

Choose the font style for the network variable data displayed on the object. Click to open the Font dialog. Use the Text properties to set the text. Alternatively, you can set the font using the Font tab of the OCXProperties properties dialog. Color of the network variable data displayed on the object. Click and choose color from Color dialog.

ForeColor

Document Number 800263 Revision 3.7

123

Chapter 6 Control Objects Reference

NVDigital Property
Hyperlink

Description
Enter the path of another Visual Integrator 3 document that will be displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, you can set the full path hyperlink by browsing using the Hyperlink tab of the OCXProperties properties dialog.

OvrCaption

Enter the text that is displayed in front of the override value when the network variable is overridden. The default text is Ovr. Network variable override applies to Circon devices only.

OvrColor

Choose the color of the text used to display the override caption and the override data. Click and choose color from Color dialog. Network variable override applies to Circon devices only.

Path PictureError PictureInvalid

Use the OCXProperties dialog Locate Object tab to specify the path to the network variable. Use the OCXProperties dialog Picture tab to specify the image to display when the network variable or configuration property could not be read. Use the OCXProperties dialog Picture tab to specify the image to display when an invalid value is read from the network variable or configuration property; i.e. when value is not ValueOff or ValueOn. Use the OCXProperties dialog Picture tab to specify the image to display when the network variable or configuration property value is the value specified by ValueOff property. Use the OCXProperties dialog Picture tab to specify the image to display when the network variable or configuration property value is the value specified by ValueOn property. Choose whether to allow this network variable to be overridden, from: 0No rightclicking does not display the override dialog 1Yes rightclicking displays the override dialog Network variable override applies to Circon devices only.

PictureOff

PictureOn

ReadOnly

124

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

NVDigital Property
ShowText

Description
Choose whether the text specified in the TextOn and TextOff properties below is displayed: 0No not displayed 1Yes displayed

ShowToolTip

Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source

TextError TextInvalid

Enter the text to display when the network variable or configuration property could not be read. See also ShowText property. Enter the text to display when an invalid value is read from the network variable or configuration property; i.e. when value is not ValueOff or ValueOn. See also ShowText property. Enter the text to display when the network variable or configuration property value is the value specified by ValueOff property. See also ShowText property. Enter the text to display when the network variable or configuration property value is the value specified by ValueOn property. See also ShowText property. Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed. Enter the value that the object should recognize as indicating the off state. For network variable or CP of type SNVT_lev_desc that use enumerated values, use the text ST_OFF. For network variable or CP of type SNVT_state that use bit fields, use 0, a numeric zero. (when choosing the target of a network variable or CP of type SNVT_state, a particular bit field is also chosen, NVDigital displays one bit only.) For network variable or CP that use Boolean types for a field, use the text BOOL_FALSE.

TextOff TextOn ToolTipText

ValueOff

ValueOn

Enter the value that the object should recognize as indicating the on state. For network variable or CP of type SNVT_lev_desc that use enumerated values, use the text ST_ON. For network variable or CP of type SNVT_state that use bit fields, use 1, a numeric one. (when choosing the target of a network variable or CP of type SNVT_state, a particular bit field is also chosen, NVDigital displays one bit only.) For network variable or CP that use Boolean types for a field, use the text BOOL_TRUE.

Document Number 800263 Revision 3.7

125

Chapter 6 Control Objects Reference

NVGauge
Use the NVGauge object to display values in the form of a gauge, from a network variable that contains an analog value. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties NVGauge NVGauge Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

126

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Events properties NVGauge See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


NVGauge Property
EventChange EventClick EventDblClick EventError

Description
This property has no effect. The NVGauge object does not generate this event. Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

EventInitialize EventMouseDown EventMouseMove EventMouseUp

ActiveX properties NVGauge NVGauge Property Description


OCXProperties BackColor ForeColor Max Allows you to specify the target network variable, and colors used in the gauge. Color of the object, displayed as background for the text. Click and choose color from Color dialog. Color of the network variable data displayed on the object. Click and choose color from Color dialog. Enter the value that sets the upper end of the range of values displayed by the object. This value is in the units of measure, for example if displaying temperature in Fahrenheit the Max value could be 80. Enter the value that sets the lower end of the range of values displayed by the object. This value is in the units of measure, for example if displaying temperature in Fahrenheit the Min value could be 32. Choose orientation of the gauge, from: 0Horizontal 1Vertical

Min

Orientation

Document Number 800263 Revision 3.7

127

Chapter 6 Control Objects Reference

NVGauge Property
Path ShowToolTip

Description
Use the OCXProperties dialog Locate Object tab to specify the path to the network variable. Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed. Not used.

Value

NVSetpoint
Use the NVSetpoint object to open a dialog (shown below) that displays the heating and cooling setpoints and allows operators with permission to change them. It is strongly recommended that you target NVSetpoint to a configuration property of type SCPTsetPnts rather than a nci network variable because the configuration property value is preserved in the LNS database and can be used for device replacements, copy/paste, backup and so on.

Normal properties NVSetpoint NVSetpoint Property Description


ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Color of the object, displayed as background. Click and choose color from Color dialog. Alternatively, set this property on the ActiveX tab Coordinate position of the bottom edge of the object

BackColor Bottom

128

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

NVSetpoint Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties NVSetpoint See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


NVSetpoint Property
EventClick EventError

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

EventInitialize EventMouseDown EventMouseMove EventMouseUp

Document Number 800263 Revision 3.7

129

Chapter 6 Control Objects Reference

ActiveX properties NVSetpoint NVSetpoint Property Description


OCXProperties Allows you to specify the target configuration property, and colors and font used in the button label. It is strongly recommended that you target NVSetpoint to a configuration property of type SCPTsetPnts rather than a nci network variable because the configuration property value is preserved in the LNS database and can be used for device replacements, copy/paste, backup and so on. Choose whether the setpoints for Standby state are displayed from: 0No not displayed 1Yes displayed BackColor Caption Font Path ShowToolTip Color of the object, displayed as background for the text. Click and choose color from Color dialog. Enter the text that is displayed on the button Enter the that is used for the text that is displayed on the button Use the OCXProperties dialog Locate Object tab to specify the path to a configuration property of type SCPTsetPnts. Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source ShowUnits Choose whether the units of measure are displayed from: 0No not displayed 1Yes displayed See section Displaying units of measure later in this chapter for a description of how units text is determined. ToolTipText Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

AllowStandbyMode

130

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

NVSlider
Use the NVSlider object to provide a convenient and intuitive way control an analog variable, for example a temperature setpoint. The operator positions the sliders pointer by clicking and dragging, the network variable is set to the value representing the position of the slider when the mouse button is released. NVSlider can be used to monitor an output network variable, but typically the NVGauge object is used for that.
Normal properties NVSlider

NVSlider Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Document Number 800263 Revision 3.7

131

Chapter 6 Control Objects Reference

Events properties NVSlider See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


NVSlider Property
EventClick EventError

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

EventInitialize EventMouseDown EventMouseMove EventMouseUp

ActiveX properties NVSlider

NVSlider Property
OCXProperties BackColor

Description
Allows you to specify the target network variable, and colors used in the gauge. Color of the object, displayed as background for the slider. Click and choose color from Color dialog. Alternatively, you can set the BackColor property using the Color tab of the OCXProperties properties dialog. Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line

BorderStyle

DifferentOvrVar

Choose whether the network variable used to override is different than the network variable, from: 0No the same network variable is used 1Yes a different network variable is used Alternatively, you can set the DifferentOvrVar property using the Different Override Variable checkbox on the Locate Object tab of the OCXProperties properties dialog.

Font

Enter the font that is used for the max and min values displayed on the slider. Alternatively, you can set the Font property using the Font tab of the OCXProperties properties dialog.

132

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

NVSlider Property
Format

Description
Enter a format string composed of one or more of the following to set the number format for the scale: Blank Display the number with no formatting 0 Digit placeholder. Display a digit or a zero. If the number has a digit in the position where the 0 appears in the format string, display it; otherwise, display a zero in that position. If the number has fewer digits than there are zeros (on either side of the decimal) in the format string, display leading or trailing zeros. If the number has more digits to the right of the decimal separator than there are zeros to the right of the decimal separator in the format string, round the number to as many decimal places as there are zeros. If the number has more digits to the left of the decimal separator than there are zeros to the left of the decimal separator in the format string, display the extra digits without modification. # Digit placeholder. Display a digit or nothing. If the number has a digit in the position where the # appears in the format string, display it; otherwise, display nothing in that position. This symbol works like the 0 digit placeholder, except that leading and trailing zeros aren't displayed if the number has the same or fewer digits than there are # characters on either side of the decimal separator in the format string. . Decimal placeholder. The decimal placeholder determines how many digits are displayed to the left and right of the decimal separator. If the format string contains only number signs to the left of this symbol, numbers smaller than 1 begin with a decimal separator. To display a leading zero displayed with fractional numbers, use 0 as the first digit placeholder to the left of the decimal separator. The actual character used as a decimal placeholder depends on the Number Format recognized by your system. % Percentage placeholder. The number is multiplied by 100. The percent character (%) is inserted in the position where it appears in the format string. ABC Display the string inside the double quotation marks.

Max Min Orientation

Enter the value for the high end of the scale Enter the value for the low end of the scale Choose orientation of the slider, from: 0Horizontal 1Vertical

Path ShowToolTip

Use the OCXProperties dialog Locate Object tab to specify the path to the network variable. Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source

ThumbColor

Color of the slider pointer. Click and choose color from Color dialog. Alternatively, you can set the ThumbColor property using the Color tab of the OCXProperties properties dialog. Enter the value to be represented between tick marks on the sliders scale.

TickFrequency

Document Number 800263 Revision 3.7

133

Chapter 6 Control Objects Reference

NVSlider Property
TickStyle

Description
Choose the orientation of the scale with respect to the slider, from: 0BottomRight: scale and tick displayed to right of scale if vertically oriented or below scale if horizontally oriented. 1TopLeft: scale and tick displayed to left of scale if vertically oriented or above scale if horizontally oriented. 2Both: ticks displayed on both sides of slider, scale displayed to right or below 3None: no ticks are displayed, scale displayed to right or below

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

NVSwitch
The NVSwitch object was obsoleted in version 3.6 and replaced with the SwitchPoint object, when additional properties were added. Support for NVSwitch objects in existing graphics remains in the product.

NVTime
The NVTime object was obsoleted in version 3.6 and replaced with the TimePoint object, when the BackStyle property was added. Support for NVTime objects in existing graphics remains in the product.

ObjectLabel
The ObjectLabel object displays the full path to a specified LNS object including network, subsystem, device, functional block, network variable and field. The ObjectLabel object tracks the full path; if the source is renamed in the LNS database, the label changes in the document. To display the actual data from the source, use one of the xxxxPoint control objects. The ObjectLabel object superseded the DataLabel object in version 3.6, to add the BackStyle property.
Normal properties ObjectLabel ObjectLabel Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object

BackColor Bottom

134

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

ObjectLabel Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible, from: 0No not visible 1Yes visible

Events properties ObjectLabel See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use

events in Visual BASIC script.


ObjectLabel Property
EventClick EventDblClick EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

Document Number 800263 Revision 3.7

135

Chapter 6 Control Objects Reference

ActiveX properties ObjectLabel ObjectLabel Property Description


OCXProperties Alignment Specifies the end point path to be displayed on the object. Click to open the ObjectLabel Control dialog. Choose the alignment of the data displayed on the object, from: 0Left justified 1Right justified 2Centered BackColor BackStyle Color of the object. Click and choose color from Color dialog. Choose the style of the object background, from: 0Transparent no visible background 1Opaque visible background of color set by BackColor property BorderStyle Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line Font ForeColor Hyperlink Path Type Choose the font style for the path text displayed on the object. Click to open the Font dialog. Color of the text. Click and choose color from Color dialog. Displays the hyperlink specified using the OCXProperties property Displays the full path specified using the OCXProperties property Choose the information about the path to display in the object, from: 0Path display the full path 1Name hide the full path and show only the name of the end point 2Description hide the full path and show only the description included in the end point properties. *??? is displayed when the description is blank. ShowToolTip Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source ToolTipText Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

136

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

PenPlot
Use the PenPlot object to display up to four realtime trend plots, from network variables on the same or different devices. The trend data is obtained directly from the data point and not, in the case of Circon devices, from the device trend logs. The trend data is used for display only; it is not recorded. To record trend data in Visual Integrator 3s SQL database, use the device trend logs and the Trend Logger utility. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties PenPlot PenPlot Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Document Number 800263 Revision 3.7

137

Chapter 6 Control Objects Reference

Events properties PenPlot See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


PenPlot Property
EventInitialize

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

ActiveX properties PenPlot

PenPlot Property
OCXProperties BackColor ForeColor Path1 Path2 Path3 Path4 PenWidth PlotColor1 PlotColor2 PlotColor3 PlotColor4 PlotColor4 SampleHistory SampleInterval XLabel YLabel YMax

Description
Allows you to specify the target network variable, hyperlink, font. Color of the object, displayed as background for the plots and the grid outline. Click and choose color from Color dialog. Color of the grid outline and scale displayed on the object. Click and choose color from Color dialog. Use the OCXProperties dialog Plot Object 1 to specify the path to the device and network variable for trend plot 1. Use the OCXProperties dialog Plot Object 2 to specify the path to the device and network variable for trend plot 2. Use the OCXProperties dialog Plot Object 3 to specify the path to the device and network variable for trend plot 3 Use the OCXProperties dialog Plot Object 4 to specify the path to the device and network variable for trend plot 4. Enter the width of the plot lines, in pixels. Color of the Path1 plot displayed on the object. Click and choose color from Color dialog. Color of the Path2 plot displayed on the object. Click and choose color from Color dialog. Color of the Path3 plot displayed on the object. Click and choose color from Color dialog. Color of the Path4 plot displayed on the object. Click and choose color from Color dialog. Color of the Path4 plot displayed on the object. Click and choose color from Color dialog. Enter the number of samples displayed on the plot Enter the elapsed time in seconds between samples being taken and displayed Enter the text for the label displayed for the X axis Enter the text for the label displayed for the Y axis Enter the value for the high end of the scale

138

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

PenPlot Property
YMin

Description
Enter the value for the low end of the scale

PlugIn
Use the PlugIn object to launch a LNS plugin. PlugIn allows you to customize the appearance of the object. Alternatively you can use the PlugInButton object which has a fixed appearance as a button. If you want to allow operators to launch LNS device plugins then you must install the plugin software. The device manufacturer supplies plugin software, typically with the device; it is not included with Visual Integrator 3. See Chapter 3 Working with Customers and Sites for a description of installing LNS plugins.
Normal properties PlugIn

PlugIn Property
ObjectCode

Description
Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Document Number 800263 Revision 3.7

139

Chapter 6 Control Objects Reference

Events properties PlugIn See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


PlugIn Property
EventInitialize

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

ActiveX properties PlugIn

PlugIn Property
OCXProperties Alignment

Description
Allows you to specify the target device, functional block and plugin. Choose the alignment of the text displayed on the object, from: 0Left justified 1Right justified 2Centered

BackColor BackStyle

Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the object, from: 0Transparent does not block view of objects behind it. 1Opaque background set to color specified by BackColor property.

BorderStyle

Choose the style of the border around the object, from: 0None no visible border line 1FixedSingle line

Caption Font ForeColor PlugInName PlugInScope ShowToolTip

Enter the text to be displayed on the object. Choose the font style for the text displayed on the object. Click to open the Font dialog. Use the Caption property to set the text. Color of the caption text displayed on the object. Click and choose color from Color dialog. Use the OCXProperties dialog to select the target device, functional block and plugin. The selected plugin name is displayed here, Readonly field that displays scope of plugin Choose whether to display the tool tip text, from: 0No do not display the tool tip 1Yes display tool tip text or path to source

ToolTipText

Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

140

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

PlugInButton
Use the PlugInButton object to launch a LNS plugin. the PlugInButton object which has a fixed appearance as a button. Alternatively, the PlugIn object allows you to customize the appearance of the object. If you want to allow operators to launch LNS device plugins then you must install the plugin software. The device manufacturer supplies plugin software, typically with the device; it is not included with Visual Integrator 3. See Chapter 3 Working with Customers and Sites for a description of installing LNS plugins.
Normal properties PlugInButton PlugInButton Description Property
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Document Number 800263 Revision 3.7

141

Chapter 6 Control Objects Reference

Events properties PlugInButton See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


PlugInButton Property
EventInitialize

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

ActiveX properties PlugInButton PlugInButton Description Property


OCXProperties Caption Font PlugInName PlugInScope ShowToolTip Allows you to specify the target device, functional block and plugin Enter the text to be displayed on the object. Choose the font style for the text displayed on the object. Click to open the Font dialog. Use the Caption property to set the text. Use the OCXProperties dialog to select the target device, functional block and plugin. The selected plugin name is displayed here, Readonly field that displays scope of plugin Choose whether to display the tool tip text, from: 0No do not display the tool tip 1Yes display tool tip text or path to source ToolTipText Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

RadioButton
The RadioButton object adds a set of two or more radio buttons that can be used with Visual BASIC script. RadioButton provides oneofmany selection.
Normal properties RadioButton RadioButton Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Choose whether the text is to the right of the radio buttons or to the left, from: 0No text is to the right of the radio buttons 1Yes text is to the left of the radio buttons BackColor Color of the object. Click and choose color from dropdown list

AlignTextLeft

142

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

RadioButton Property
Bitmap

Description
Image to use as the radiobutton shape to replace the default radiobutton image, when button is selected. Click to open the Bitmap Dialog. Refer to Bitmap property for the Button object for more information about this dialog. BitmapOffState property must also be set for this property to have an affect.

BitmapOffState

Image to use as the radiobutton shape to replace the default radiobutton image, when button is not selected. Click to open the Bitmap Dialog. Refer to Bitmap property for the Button object for more information about this dialog. Bitmap property must also be set for this property to have an affect.

Bottom CursorPointer

Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable

Choose from: 0No, do not trigger events for this object 1Yes, trigger events

Font Group HelpContextID Left ListItems

Choose the font style for the text label on the object. Click to open the Font dialog. Use the ListItems property to set the text. This property has no effect. Not used Coordinate position of the left edge of the object Click to open the List Choices dialog and add, modify and delete radio buttons from the object:

Use the Add button to add another radio button Use the Delete button to delete the selected radio button Use the Up and Down buttons to set the order of the radio buttons Use the Name field to edit the text displayed next to the radio button Use the value field to set the numeric value passed to the Visual BASIC script when the radio button is selected.

Document Number 800263 Revision 3.7

143

Chapter 6 Control Objects Reference

RadioButton Property
Right Tabstop

Description
Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

TextColor Top ValueID Visible

Choose the color for the text label on the object. Click to open the dropdown list. Coordinate position of the top edge of the object This property has no effect. Choose whether the object is visible, from: 0No not visible 1Yes visible

Events properties RadioButton See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


RadioButton Property
EventChange EventInitialize

Description
Specifies the script in Visual BASIC to execute when the radio button is clicked. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

SwitchPoint
Use the SwitchPoint object, with a network variable or configuration property of type SNVT_switch, to perform the following functions: Display the LonMark twostate interpretation of network variable or configuration property as text or image Display the value field of network variable or configuration property Set state and value fields of network variable or configuration property Override a network variable of a Circon device only.

See the NVDigital object for other discrete digital network variables such as SNVT_lev_desc.

144

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

About SNVT_switch SNVT_switch is a structure with two fields: value and state. The value field contains a percentage

level or load value in the range 0 to 100%. The state field contains a discrete true/false state where 1 is true and 0 is false. The value field controls the load's value, that is, position, speed, or intensity; the state field controls whether the load is on or off (enabled or disabled). When a network variable of type SNVT_switch is used as the output of a twostate discrete sensor or the input to a twostate discrete actuator, the twostate interpretation rules, as tabulated below, determine the on or off status.
Output network variable

value (raw)
0 200 (0xC8) (100%) 0 .. 200 (0 .. 0xC8) (any valid value)

state
0 (False) 1 (True) 1 (0xFF)

twostate interpretation
off on invalid (Null)

Input network variable

value (raw)
any valid value 0 >0 any valid value

state
0 (False) 1 (True) 1 (True) 1 (0xFF)

twostate interpretation
off off on invalid (no action)

Overriding using SwitchPoint You can use SwitchPoint to set the target variable. The target variable must be writable. Output network variables are not writable. To set a configuration property or network variable the

operator must have override permission.


To set the variables state and value fields: 1 Rightclick the object to display the Set Value dialog:

2 To set the State field of the variable, choose On (true) or Off (false) from the dropdown list. 3 To set the Value field of the variable, type a number in the range 0 to 100 in the Value box. 4 Click Apply to set the variable. The object displays the resulting twostate interpretation of these settings.

Document Number 800263 Revision 3.7

145

Chapter 6 Control Objects Reference

Normal properties SwitchPoint SwitchPoint Property Description


ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties SwitchPoint SeeUsing Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


SwitchPoint Property
EventChange EventClick EventDblClick EventError

Description
Specifies the script in Visual BASIC to execute when value of target variable changes. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor.

146

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

SwitchPoint Property
EventInitialize EventMouseDown EventMouseMove EventMouseUp

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties SwitchPoint SwitchPoint Property Description


OCXProperties Allows you to specify the target network variable or configuration property of type SNVT_switch, hyperlink, font and image to display for the various variable values and states. Choose the alignment of the text displayed on the object, from: 0Left justified 1Right justified 2Centered Auto Choose whether or not to display the Auto button on the Set Value dialog, from: 0No button is not displayed 1Yes button is displayed Use the ReadyOnly property to display the Set Value dialog. Clicking Auto sets the target variable to value=100, state = 1 (0xFF). When the target variable is a Circon override network variable, the auto value is recognized and the override is removed. BackColor BackStyle Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the background, from: 0Transparent. the background disappears 1Opaque.the background is displayed according to the BackColor setting. BorderStyle Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line ErrorCaption Font Type the text to display when the variable value could not be read. See also the ShowStateText property. Choose the font style for text displayed on the object. Click to open the Font dialog. Alternatively, you can set the font using the Font tab of the OCXProperties properties dialog.

Alignment

Document Number 800263 Revision 3.7

147

Chapter 6 Control Objects Reference

SwitchPoint Property
ForeColor Hyperlink

Description
Color of the text displayed on the object. Click and choose color from Color dialog. See also the OvrColor property. Enter the path of another Visual Integrator 3 document that is displayed when the operator clicks on the object. The form of the path can be one of the following: a full path in the form: \\customer\site \\document; or a path relative to current document to a child document below, in the form: .\...\document; or a path relative to document one level higher in tree to a child document below in the form: ..\...\document; or a sitespecific path that assumes current customer and site: \...\document. If you use the full path format and specify a different customer /site, the current site will be closed and the different site opened. Alternatively, use the Hyperlink tab of the OCXProperties properties dialog to set the full path of the hyperlink.

InvalidCaption

Type the text to display when the information in the variable is invalid, according to the LonMark twostate interpretation rule for SNVT_switch. See also the ShowStateText property. Type the text to display when the information in the variable indicates the Off state, according to the LonMark twostate interpretation rule for SNVT_switch. See also the ShowStateText property. Type the text to display when the information in the variable indicates the On state, according to the LonMark twostate interpretation rule for SNVT_switch. See also the ShowStateText property. Type the text to display in front of the displayed values when the variable is set using the Set Value dialog. The default text is Ovr. Network variable override applies to Circon devices only. Use the ReadyOnly property to display the Set Value dialog. Choose the color of the text used to display the override text (OvrCaption) and values when the variable is set using the Set Value dialog. Click and choose color from Color dialog. Network variable override applies to Circon devices only. Use the OCXProperties dialog Locate Object tab to specify the path to the variable of type SNVT_switch. This property displays the path. Choose whether or not to allow the Set Value dialog to be displayed. The Set Value dialog allows an operator with Override permission to set the state and value of the network variable or configuration property, from: 0No rightclicking does not display the Set Value dialog 1Yes rightclicking displays the Set Value dialog

OffCaption

OnCaption

OvrCaption

OvrColor

Path ReadOnly

148

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

SwitchPoint Property
ShowStateText

Description
Choose whether or not the text specified by the properties: ErrorCaption, InvalidCaption, OffCaption, and OnCaption is displayed, from: 0No not displayed 1Yes displayed

ShowToolTip

Choose whether or not to display tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source The tool tip text is specified by the ToolTIpText property.

ShowValueText

Choose whether or not the information in the value field is displayed, in percent, from 0No not displayed 1Yes displayed

Stretch

Choose whether or not to stretch the images associated with the variable, to fit the size of the object area, from: 0No image retains its default size. Resizing the image area does not resize the image. 1Yes image is sized to fit the image area. Resizing the image area also resizes the image. The images are specified in the OCXProperties Images tab.

ToolTipText

Type the text you want displayed when mouse cursor hovers over the object, when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

TheFrame/TheView
TheFrame/TheView is the canvas on which you create a customized document. Although TheFrame/TheView is not an object you add to a document Graphics Editor adds it automatically when a blank document is created it does have Normal properties. The Font property for TheFrame/TheView is used as the default font for all objects added to the document.
Normal properties TheFrame/TheView TheFrame/TheView Property Description
FormCode AutoRecord Color Not used. This property has no effect. Background color for the document. Click and choose color from dropdown list

Document Number 800263 Revision 3.7

149

Chapter 6 Control Objects Reference

TheFrame/TheView Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the TheFrame/TheView: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Font Height HelpContextID LocalDecls LocalVariables PrintScale ReportLock ScrollBars

Choose the font style used as default for any object added to the document . Click to open the Font dialog. Sets the height dimension of TheFrame/TheView Not used Click to open the VBS MiniEditor, Local Declarations Click to open the VBS MiniEditor, Local Variables Enter a number to set the size of the printout of the document, 1 = full scale, 2 = double sized, 0.5 = halfsize This property has no effect. Choose whether the scroll bars are visible, from: 0No not visible 1Yes visible Displaying scroll bars allows the operator to access the complete DocumentView by scrolling, when the Visual Integrator 3 window is resized or when the Alarm Log Viewer is displayed, reducing the size of DocumentView. By default, ScrollBars is set to Yes when a new document is created. See also ScrollHeight and ScrollWidth properties below.

ScrollHeight

Enter the height in pixels of TheFrame/TheView at which the vertical scroll bar appears, when ScrollBars property is set to yes. Graphics Editor does not allow objects to be located outside the dimensions set by ScrollHeight or ScrollWidth, when ScrollBars property is set to yes.

ScrollWidth

Enter the width in pixels of TheFrame/TheView at which the horizontal scroll bar appears, when ScrollBars property is set to yes. Graphics Editor does not allow objects to be located outside the dimensions set by ScrollHeight or ScrollWidth, when ScrollBars property is set to yes.

Width

Sets the width dimension of TheFrame/TheView

150

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Events properties TheFrame/TheView See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


TheFrame/TheView Property
EventClick EventInitialize EventTerminate

Description
Specifies the script in Visual BASIC to execute when click on TheFrame/TheView. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when TheFrame/TheView is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when TheFrame/TheView is closed as the document is closed. Click to open the VBS MiniEditor.

TimePoint
Use the TimePoint object to display and change the date and time on a device. Used with a network variable of type SNVT_time_stamp. For Circon devices, the time and date is monitored via network variable nvoTimeDate from the Realtimekeeper functional block and changed via network variable nviTimeSet on the NodeObject functional block TimePoint allows the operator to change the target network variable: by rightclicking the object to display the Set Value dialog:

If the operator does not have permissions to override, the Apply button is disabled. To adjust the update interval for the network variable information displayed by this object, change the Poll Interval setting on the network properties Timing tab.
Normal properties TimePoint TimePoint Description Property
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. This property has no effect. Use BackColor property on ActiveX tab. Coordinate position of the bottom edge of the object

BackColor Bottom

Document Number 800263 Revision 3.7

151

Chapter 6 Control Objects Reference

TimePoint Property
CursorPointer

Description
Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam 4UpArrow 5NoDrop 6Help 99HotSpot

Enable Group HelpContextID Left Right Tabstop

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible from: 0No not visible 1Yes visible

Events properties TimePoint See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


TimePoint Property
EventChange EventClick EventDblClick EventError

Description
This property has no effect. The TimePoint object does not generate this event. Specifies the script in Visual BASIC to execute when mouse is clicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse is doubleclicked on object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when LNS can no longer communicate with the device. This event is triggered for every missed poll to the device. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is pressed while over the object. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute when mouse button is moved while over the object. Click to open the VBS MiniEditor.

EventInitialize EventMouseDown EventMouseMove

152

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

TimePoint Property
EventMouseUp

Description
Specifies the script in Visual BASIC to execute when mouse button is released while over the object. Click to open the VBS MiniEditor.

ActiveX properties TimePoint TimePoint Description Property


OCXProperties Alignment Allows you to specify the target network variable, override network variable, and font. Choose the alignment of the text displayed on the object, from: 0Left justified 1Right justified 2Centered BackColor BackStyle Color of the object, displayed as background for the text. Click and choose color from Color dialog. Choose the style of the background, from: 0Transparent. the background disappears 1Opaque.the background is displayed according to the BackColor setting. BorderStyle Choose the style of the border around the object, from: 0None no visible border line 1Fixed_Single single recessed line ErrorCaption Font Type the text to display when the network variable value is not available. Choose the font style for the network variable data displayed on the object. Click to open the Font dialog. Alternatively, you can set the font using the Font tab of the OCXProperties properties dialog. Color of the network variable data displayed on the object. Click and choose color from Color dialog. Use the OCXProperties dialog Locate Object tab to specify the path to the network variable of type SNVT_time_stamp. Choose whether to allow the operator to change the date and time, from: 0No rightclicking does not display the set value dialog 1Yes rightclicking displays the set value dialog ShowToolTip Choose whether to display the tool tip text, from: 0No do not display tool tip text 1Yes display tool tip text or path to source ToolTipText Enter the text you want displayed when mouse cursor hovers over the object when ShowToolTip property is set to Yes. If ShowToolTip property is set to Yes but the ToolTipText property is blank then the path to the source is displayed.

ForeColor Path ReadOnly

Document Number 800263 Revision 3.7

153

Chapter 6 Control Objects Reference

Timer
The Timer object can be used in conjunction with VBScript code when you want to evaluate the state of several controls and then perform some custom action, for example, dynamically update the text of a button or label. Without the Timer object this would be difficult because there is no easy way to centralize this code; the same code would have to be used for the EventChange event for all the controls that you want to evaluate in the VBScript code. IMPORTANT: In Graphics Editor, the Timer object is represented by a stop watch image, however the image is hidden when not in Graphics Editor and is not visible to the operator.
Normal properties Timer Timer Property Description
ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor with the object is added to a document. Do not change this property. This property has no effect. Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible, from: 0No not visible 1Yes visible

154

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Events properties Timer See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


Timer Property
EventInitialize EventTimer

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor. Specifies the script in Visual BASIC to execute periodically as specified by the objects interval property. Click to open the VBS MiniEditor.

ActiveX properties Timer

Timer Property
OCXProperties Enabled

Description
No properties available Choose whether the TImer events are generated, from: 0No, not triggered 1Yes , at interval specified.

Interval

Enter the time interval in milliseconds that the object triggers an EventTImer event. Setting Interval to zero disables the object and no EventTImer events are triggered. Maximum interval is 65535 milliseconds which is just over one minute.

TrendLog
The TrendLog object allows you to display a trend plot in a Visual Integrator 3 document as an alternative to using Log Viewer. The operator does not need to use Log Viewer and navigate its menu structure to display historical trend data. By using the TrendLog object, you can create a document that allows the operator to display a trend with one click. TrendLog object uses as its property the name of a trend profile you have created using Log Viewer, allowing you to present the same exact trend plot as if using Log Viewer. And the standard Log Viewer navigation tools are provided with the TrendLog object to allow the operator to zoom in and out and traverse the trend plot timeline. IMPORTANT: In Visual Integrator 3 version 3.5 and earlier, the Trendlog object displays trend plots only for operators logged into the Visual Integrator 3 installed on the same computer as the LNS Server, because TrendLog object relies on being able to access the historical trend data in the Visual Integrator 3 SQL database which resides on that computer. TrendLog object cant display trend plots on Visual Integrator 3 installed on an additional computer acting as a remote client to the LNS Server. In version 3.6 and later, the Trendlog object works on both the server and the workstation, when they are set up as described in Chapter 18.

Document Number 800263 Revision 3.7

155

Chapter 6 Control Objects Reference

Normal properties TrendLog TrendLog Property Description


ObjectCode Programmatic name of an instance of the object within a document, assigned by Graphics Editor when the object is added to a document. Do not change this property. Color of the object. Click and choose color from dropdown list Coordinate position of the bottom edge of the object Choose the cursor pointer style to be displayed while mouse is over the object: 0Default 1Arrow 2Ibeam Enable Group HelpContextID Left Right Tabstop 4UpArrow 5NoDrop 6Help 99HotSpot

BackColor Bottom CursorPointer

This property has no effect. This property has no effect. Not used Coordinate position of the left edge of the object Coordinate position of the right edge of the object Choose whether the object is included in the tab order from: 0No object not included in tab order 1Yes object is included in tab order

Top Visible

Coordinate position of the top edge of the object Choose whether the object is visible, from: 0No not visible 1Yes visible

Events properties TrendLog See Using Visual BASIC MiniEditor and Script Wizard section for a description of how to use events

in Visual BASIC script.


TrendLog Property
EventInitialize

Description
Specifies the script in Visual BASIC to execute when object is initialized as the document is opened. Click to open the VBS MiniEditor.

156

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

ActiveX properties TrendLog TrendLog Property Description


OCXProperties Profile Show ToolBar Allows you to specify the target trend profile name which defines the trend plot that will be displayed by the TrendLog object Displays the name of the TrendLog profile selected by the OCXProperties dialog. Choose whether the trend log toolbar is visible when the trend log plot is displayed, from: 0No not visible 1Yes visible.

Using Visual BASIC MiniEditor and Script Wizard


Eventbased programming using Visual BASIC scripting is builtin to all objects. Each object has one or more event properties that can be used to trigger the execution of a custom Visual BASIC script. Describing the Visual BASIC scripting language is outside the scope of this user guide. However, complete online help for the Visual BASIC scripting language is provided on the Visual Integrator 3 distribution CD. VI3 includes builtin Visual BASIC MiniEditor to allow you to enter and edit script quickly and easily, and a Script Wizard. Script Wizard can be used to select objects and their properties from dropdown lists and include them in your script, rather than enter the names of the objects and properties by keyboard.
To open the Visual BASIC Scripting (VBS) MiniEditor: 1 Select an object and display the Events tab of its property sheet. 2 Click the goto button to the right of the event for which you want to add VB script. The VBS MiniEditor is displayed:

3 Enter VB script directly.

Document Number 800263 Revision 3.7

157

Chapter 6 Control Objects Reference 4 Rightclick in the white space to display the popup menu with following commands:

Cut delete selected text and copy to clipboard Copy copy selected text to clipboard Paste paste selected text from clipboard Goto Line enter line number to set cursor position to and press Enter. Check Syntax check the syntax of the script for errors Font select the font and size for the script you enter. Recolorization redraw the syntax color highlighting. Objects display a list of objects in document. Highlight an object name then click in the VBS MiniEditor white space to add to your script, or press Enter to display list of objects properties. Wizard Open the Script Wizard, described below.
5 Click OK to exit and save the script. The VBS MiniEditor checks the syntax before saving. If errors are found then you are prompted. To open the Script Wizard: 1 From the VBS MiniEditor click Wizard>> or rightclick and choose Wizard from the popup menu. The Script Wizard is displayed:

2 In the bounded area titled Objects, select from the dropdown list of objects in the document, and then select from the dropdown list of its properties and methods to the right. Click Insert to add to the script. 3 In the bounded area titled ActiveX & OLE, select from the dropdown list of objects in the document, and then select from the dropdown list of its properties to the right. Click Insert to add to the script. 4 Click Editor>> to switch to the VBS MiniEditor.

158

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Displaying units of measure


Several objects display data from network variables or configuration properties and you typically would like to display the units of measure associated with the data. Visual Integrator 3 determines the units of measure to display based on the configuration and property selections you make. You can also alter the default text associated with the units of measure to further customize the display of data.

Configuring units of measure


The units of measure for a site are configured in the site properties, as described in Chapter 3 Working with Customers and Sites, by selecting either United States or Metric on the General tab of the site properties. Visual Integrator 3 does not obey Windows Control Panel regional options for units of measure.

Configuring text associated with units of measure


Object that display data and associated units all have a ShowUnits property, which determines whether the units are displayed. When ShowUnits is set to Yes the default units texts as defined in a LonMark file named standard.fmt are displayed. Standard.fmt defines the default units text for all SNVTs. To change this default units text, there are two options: 1. When using a DataPoint object, use its Units property where you can enter text that overrides the default units text and becomes the displayed units for that object. 2. Change the default units text globally (for all objects and all sites on a computer) for a particular SNVT using the standards.uni file provided by Visual Integrator 3, as described below.
To change default units text: 1 Close the site and exit Visual Integrator 3. 2 Determine the string resource indicator associated with the SNVT whose units text you want to change. To do this, use Windows Notebook and open the text file standards.fmt typically found in the folder C:\LonWorks\types. Scroll down until you find the SNVT entry. The example below shows the entry for SNVT_temp_p:

SNVT_temp_p#SI: SNVT_temp_p#US:

text("%f", *1+0(0:854));

! degrees C

text("%f", *1.8+32(0:855)); ! degrees F

This shows that when working in US units, the units text is degrees F. The string resource indicator for SNVT_temp_p in US units is (0:855). Here is another example: (0:954) is the string resource indicator for SNVT_press in US units with units text specified as: in. of H2O. 3 Record the string resource indicator for the SNVT you are interested in and close standards.fmt without saving, as you should not have made any changes!

Document Number 800263 Revision 3.7

159

Chapter 6 Control Objects Reference 4 Use Windows Notebook and open the text file standards.uni also found in the folder C:\LonWorks\types. As installed with Visual Integrator 3 its contents are: [Units] 0:854=C 0:855=F 0:1012=C/min 0:1011=F/min indicating four units texts that are different that the default found in standards.fmt. The format of entries in this file is: string resource indicator =units text 5 Enter the string resource indicator and units text you want displayed. For example, to change the default text for SNVT_press enter: 0:954=H2O 6 Save and close the file. 7 Start Visual Integrator 3 for the changes to take effect.

160

Document Number 800263 Revision 3.7

Chapter 7 Creating a HMI a Tutorial

his chapter provides a stepbystep tutorial which describes how to use Graphics Editor and its documents and control objects to create a typical Human Machine Interface (HMI). This chapter assumes you are familiar with the basic capabilities of Graphics Editor as described in Chapter 5 Introduction to Graphics Editor and control objects and that you have reviewed Chapter 6 Control objects reference and Chapter 4 Working with Visual Integrator documents.

Main steps in creating an HMI with Visual Integrator 3


1 2 3 4 5 6 7 8 Identify the operators and their needs for the HMI Design the structure of the interface and plan how you want operators to navigate Implement the interface structure Create the site home document Create the zone or subsystem floor plan document Add graphical device / equipment documents Add inspector and trend log documents Add hyperlinks to enhance navigation

This chapter assumes you have created a site following the procedures described in Chapter 3 Working with Customers and Sites. The tutorial uses a fictitious customer named ABC Company and their site named Facility A.

Determining an operators needs


Before you can apply the concepts presented in chapters 4, 5 and 6 you should think about how you want the interface to be structured, what information you want to present; what graphical representations/pictures you want to use for pieces of equipment and how to enhance the usability to make the operators daily tasks easier to perform and simpler to train a new operator on. This preliminary and vital step of the design phase is often overlooked. Not only will time (and money) be saved with some thoughtful planning, but also customer satisfaction will be assured.

Document Number 800263 Revision 3.7

161

Chapter 7 Creating an HMI a Tutorial

Designing the interface structure


Visual Integrator 3 provides two approaches to navigation: Windowslike TreeView and Web like hyperlinks. Typically, a hierarchical approach for the interface provides an intuitive structure that allows the operator to navigate easily from a high level view of the facility and drill down to views of individual equipment. Hyperlinks are then added to minimize the number of navigation steps or mouse clicks involved in oftenrepeated operations. Typically the structure mirrors the underlying structure of the network in the LNS database, although this is not always necessary. This tutorial chapter describes how to implement a HMI based on the hierarchical structure outlined below: Site home Functional divisions such as HVAC or lighting Zones or subsystems within the Functional division Equipment or DDC devices within a zone or subsystem Monitoring and troubleshooting aids for devices

Implementing the interface structure


The site home document is the toplevel document in the TreeView navigation structure for a site. Other documents are added below to create the desired structured navigation tree for the site. Documents of type Blank Graphic document are typically used because they may display some graphical information such as a floor plan and hyperlinks but do not typically link to a target device. This section simply describes how to add the blank documents to the site to create the interface structure. Later sections describe how to add graphics to these documents.

Adding the site home document


The site home document is displayed when the operator clicks the site in TreeView. Visual Integrator 3 adds the site home document automatically when the site is created.

Adding documents to delineate the functional divisions


The functional divisions are indicated by the documents nested below the site home document. In this example there are two functional divisions: HVAC and lighting.
To add the functional divisions documents: 1 In TreeView click the Facility A site document. The open site dialog is displayed. 2 Click Yes to open the site then click Work Offline.

162

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Facility A site document should still be selected. Choose File > New Document. The Add Document dialog is displayed. Select the Other Documents tab:

4 Select Blank Graphic and click OK. A document titled New Blank Graphic appears below the Facility A site document. It is selected, so type HVAC system for its name. 5 Repeat steps 3 and 4 but rename the new document Lighting system. 6 TreeView should appear as follows:

Adding the zone or subsystem documents


The zones or subsystems within a functional division are indicated by the documents nested below the functional division document. In this example the HVAC functional division is divided into subsystems representing the two floors of the facility.
To add the zone or subsystem documents: In TreeView, click the HVAC system document. 1 Choose File > New Document. The Add Document dialog is displayed. Select the Subsystems Documents tab. 2 Select Blank Subsystem and click OK. Click the plus sign beside HVAC system. A document titled New Blank Subsystem appears below the HVAC system document.

Document Number 800263 Revision 3.7

163

Chapter 7 Creating an HMI a Tutorial 3 The new document name is selected so type the name First Floor HVAC subsystem for the document. 4 Repeat steps 1 through 3 but rename the document Second Floor HVAC subsystem. 5 Repeat steps 1 through 3 but add a Subsystem Status document and rename it _Subsystem Status. The underscore prefix ensures this document is always at the top of the list of HVAC subsystems. 6 When complete, select the _Subsystem Status document; your site should appear similar to the following. Unless you explicitly provide a target subsystem, the Subsystem Status document displays all subsystems in the LNS database. To adjust the update interval for the State column displayed on this document, change the Poll Interval setting on the network properties Timing tab.

Creating the site home document


The site home document typically displays an image or drawing of the exterior of the facility. In addition to the image, labels and other relevant information can be included to make the document more dynamic.
To create a site home document 1 In TreeView click the Facility A site document. This document is the site home document. 2 Choose File > Graphics Editor to start Graphics Editor. The procedures below describe how to use Graphics Editor to add the individual objects to create the site home document.

164

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Adding an Image object


To add an image to a document: 1 In Graphics Editor, select Image object from the Object bar. 2 Using the mouse, place the image object on the document by clicking and dragging a large square on the blank area. Ensure that the upper left corner of the image object is close to the upper left corner of the blank area:

3 Rightclick the Image object to view its properties. 4 Select the ActiveX tab and click on the OCX Properties Open button to display the control properties dialog.

Document Number 800263 Revision 3.7

165

Chapter 7 Creating an HMI a Tutorial The control properties dialog is displayed:

5 Click Browse Image and locate and select the image file you want to be displayed on the site home document. Locate and select the following image file: C:\Program Files\Circon\BIN\Images\Zirconbuilding.bmp The image file displayed in the Image object can be any one of the following file types: bmp, gif or jpg. Visual Integrator 3 cant draw an image for your application; the image must be acquired from an outside source. 6 Click Open. You should see the image in the image preview area of the properties dialog. 7 Click OK. You should see the image in the image area. 8 Close the CirconImage Control Properties dialog 9 Set the Stretch property in the ActiveX tab to Yes to stretch the picture to the limits of the image object. Alternatively you can leave the Stretch property at No and manually resize the object boundary to fit the actual image size. 10 Close the property sheet. Graphics Editor should be similar to following:

166

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Adding a Label object


To add a Label object to a document: 1 Click the Label object button from the Object bar. 2 Drag a square on the blank area of the document below the image:

3 Rightclick (or doubleclick) this Label object to display its properties. 4 Select the Caption property from the ActiveX tab. 5 Enter the following caption property value: Outdoor Air Temperature

6 Click the Font property from the ActiveX property tab and select bold font style. Then click OK. The bold caption appears in the label object. 7 Close the property sheet.

Document Number 800263 Revision 3.7

167

Chapter 7 Creating an HMI a Tutorial

Adding a DataPoint object


To add a DataPoint object to a document: 1 Click the DataPoint object button from the Object bar. 2 Using the mouse, drag a square to the right of the Label object:

3 Rightclick (or doubleclick) the DataPoint object to display its properties. 4 Select the ActiveX property tab and click the open button of the (OCX Properties) property. 5 To set the target device and network variable that supplies the outdoor air temperature value, select the Locate Object tab and click the upper Browse button to browse the LNS database. 6 Click the plus sign next to Second Floor subsystem. 7 Click the plus sign next to UHC AC2 device. 8 Click the plus sign next to UI[0] functional block.

168

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 Click the nvoValueUI_00 network variable.

10 Click OK to complete your path selection.

11 Click OK to save and close. 12 Click the ShowUnits property from the ActiveX property tab and select Yes. 13 Change the Precision property to 2 and the PrecisionFixed property to Yes (see below) to indicate that 2 decimal places are always displayed for the outdoor air temperature.

Document Number 800263 Revision 3.7

169

Chapter 7 Creating an HMI a Tutorial 14 Close the properties and click Save on the Graphics Editor toolbar. 15 Choose File > Exit to close Graphics Editor. The document is displayed similar to the following:

If there is no sensor connected to UI 0, the reading shows a value of 32 F (0 C). To display a more typical value, you can override this input in the UHC300 Device Viewer.
o o

Adding a TimePoint object


To add a TimePoint object 1 Choose File > Graphics Editor to start Graphics Editor. 2 Click the TimePoint object button from the Object bar. 3 Using the mouse, drag a square in the lower right corner of the document, to display the time and date. Since the UHC AC2 device has a batterybacked clock, it is considered the master time keeper for all other devices on this system. Use this device to display the time and date information. 4 Select the ActiveX property tab and click the open button of the OCX Properties property. 5 To set the target device and network variable that supplies the time value, select the Locate Object tab and click the upper Browse button to browse the LNS database. 6 Click the plus sign next to Second Floor subsystem. 7 Click the plus sign next to UHC AC2. 8 Click the plus sign next to the RealTimeKeeper functional block.

170

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 Click the nvoTimeDate network variable.

If the time/date is incorrect, you will have to set it using the plugin for the UHC300s RealTimeKeeper functional block. 10 Add a Label object, as described earlier in this chapter, with the caption Control Network Time, to the left of the TimePoint object.

Document Number 800263 Revision 3.7

171

Chapter 7 Creating an HMI a Tutorial

Adding a Button object


The Button object is added here and used later in this chapter to provide an example of the hyperlink method of navigation, as an alternative to TreeView.
To add a Button object 1 Click the Button object button from the Object bar. 2 Using the mouse, drag a square in the upper right corner of the document. 3 Open the objects properties, select the Normal tab and set the Text property to First Floor HVAC Subsystem, set Font to MS Sans Serif, Bold, size=8. 4 Use the Graphic Editor copy/paste feature to add a second button control object below the first one with the Text property: Second Floor HVAC Subsystem These Button objects are used later to show how to hyperlink to another document. 5 Close the properties dialog and use Save on the toolbar to save the document. 6 Exit Graphics Editor. The final site home document should now appear similar to:

172

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Adding scroll bars


Scroll bars allow the operator to be able to gain access to the complete document by scrolling, when the Visual Integrator 3 window is resized or when the Alarm Log Viewer is displayed, thus reducing the size of DocumentView.
To add scroll bars: 1 Open the document using Graphics Editor. 2 Click anywhere there is no object to select TheFrame/TheView. Scroll bars are a property of TheFrame/TheView. 3 Display the Normal properties tab of TheFrame/TheView. 4 Set Scrollbars property to Yes. 5 Set ScrollHeight and ScrollWidth properties to set the height and width of DocumentView (its extent) when the scroll bars appear. See Chapter 6 Control Objects Reference about TheFrame/TheView for a description of the properties. 6 Save document and exit Graphic Editor.

Creating a Subsystem document with floor plan


Floor plans are used frequently in HMIs for facility automation systems to provide alternative navigation and oversight for monitoring. In this example, a floor plan image of the second floor of the Facility A building is added to the Second Floor HVAC subsystem document. The image can be any one of the following types: *.bmp, *.gif, or *.jpg. Since Visual Integrator 3 cant draw an image for your application, it must be acquired from an outside source.

Adding an Image object


To add an image to a document: 1 Select the Second Floor HVAC subsystem document. 2 Start Graphics Editor and select the Image object from the Object bar. 3 Using the mouse drag a large square on the Second Floor HVAC subsystem document area of the document. Ensure that the upper left hand corner of the image object is adjacent to the upper left hand corner of the viewing area: 4 Rightclick the object to view the properties; select the ActiveX property tab. 5 Click the OCX Properties open button and click Browse Image on the properties dialog that is displayed. 6 Locate and select the following image file: C:\Program Files\Circon\BIN\Images\2ndhvac.gif 7 Click Open.

Document Number 800263 Revision 3.7

173

Chapter 7 Creating an HMI a Tutorial 8 Click OK. You should see a layout of the second floor. This screen capture has the Stretch property set to Yes. The image is actually much larger. In this case the Stretch property reduces the image size while still allowing all of it to be viewed.

9 Close the object property sheet.

174

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Adding a DataPoint object


The next step in adding a floor plan is to use data objects to populate the document with information from various devices. This allows the floor plan document to provide the operator with all room temperatures at a glance.
To add a DataPoint to a document: 1 Click the DataPoint object from the Object bar. 2 Using the mouse, drag a square DataPoint object on the image object, over the boardroom area. The DataPoint object is used to display the space temperature in the boardroom.

3 Rightclick the DataPoint object to view the properties and select the ActiveX property tab 4 Click the open button of the OCX Properties then click the upper Browse button. 5 Click the plus sign next to Second Floor Subsystem. 6 Click the plus sign next to VAV21. 7 Click the plus sign next to the VAV functional block.

Document Number 800263 Revision 3.7

175

Chapter 7 Creating an HMI a Tutorial 8 Click the nvoSpaceTemp network variable.

9 Click OK to complete your Path selection:

10 Click OK to complete the ActiveX property selection. 11 Click the ShowUnits property from the ActiveX tab and set it to Yes. 12 Click the BackColor property from the ActiveX tab and select the white background color. 13 Click the Font property from the ActiveX tab and select the Bold font style from the Font window. 14 Enter 2 in the Precision property of the ActiveX tab. 15 Click the PrecisionFixed property of the ActiveX tab and set it to Yes. 16 Close the property sheet. 17 You may want to use a Label object to add a title to the document as shown below.

176

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 18 Use Save on the toolbar to save the document. Exit Graphics Editor. The document with the live value will appear similar to the following:

More DataPoint objects can be added to the Second Floor HVAC subsystem document to display the space temperature of other rooms.

Adding scroll bars


Scroll bars allow the operator to be able to gain access to the complete document by scrolling, when the Visual Integrator 3 window is resized or when the Alarm Log Viewer is displayed, reducing the size of DocumentView.
To add scroll bars: 1 Open the document using Graphics Editor. 2 Click anywhere there is no object to select TheFrame/TheView. Scroll bars are a property of TheFrame/TheView. 3 Display the Normal properties tab of TheFrame/TheView. 4 Set Scrollbars property to Yes. 5 Set ScrollHeight and ScrollWidth properties to set the height and width when the scroll bars appear. See Chapter 6 Control Objects Reference about TheFrame/TheView for a description of the properties. 6 Save document and exit Graphic Editor.

Document Number 800263 Revision 3.7

177

Chapter 7 Creating an HMI a Tutorial

Adding a device document


The individual device or equipment graphic documents are typically added directly below the corresponding zone or subsystem document. Recall that the Visual Integrator 3 includes many device template documents for typical Circon devices, as described in Chapter 4 Working with Visual Integrator Documents. You may also want to add an inspector document and a document displaying a trend log below the device document as aids to trouble shooting and monitoring.

Adding a device document


Device documents typically provide a graphics representation of the equipment and display its most important device data.
To add a device document: 1 In TreeView, click the Second Floor HVAC subsystem document. 2 Choose File > New Document. The Add Document dialog is displayed. Select the Device Documents tab. 3 In the Device Documents tab, select the device document named UHC302m04PMRH. Clicking the Details button makes it easier to see the name of the documents.

Details button

4 Click OK to complete the selection. The device document appears under the Second Floor HVAC subsystem document as New UHC302m04PMRH. 5 The document name is selected, so type a name that best fits how you want to present the equipment name to the operator. In this example, VAV21 is used for the document name.

178

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Click the New Document. The equipment image in the device document is displayed. The expected error dialog as below is also displayed to indicate that the device document is not associated with a target device. Click OK.

7 Choose File > Properties. The device document properties dialog is displayed:

8 Click Browse to choose the target device from the LNS network database. The Select Device dialog is displayed. 9 Click the plus sign in front of the Second Floor Subsystem. 10 Select the VAV21 device as the target device.

11 Click OK to select the target device. 12 Click OK to close the Properties dialog and wait while Visual Integrator 3 scans and updated the equipment data.

Document Number 800263 Revision 3.7

179

Chapter 7 Creating an HMI a Tutorial 13 The device document should look similar to the screen capture below:

To adjust the update interval for the network variable information displayed on this document, change the Poll Interval setting on the network properties Timing tab. You repeat the procedure above to add more device documents. Target each device document to a different device.

Adding a Functional Block Inspector document


An Inspector document provides visibility into the device for troubleshooting problems. This example adds a Functional Block Inspector below the device document.
To add a Functional Block Inspector document: 1 Click the VAV21 document below the Second Floor HVAC subsystem document. 2 Choose File > New Document.

180

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 In the Functional Blocks Documents tab, select Functional Block Inspector.

4 Click OK to complete the selection. The inspector document appears under the VAV21 document as New Functional Block Inspector. 5 The document name is selected, so type a name that best fits how you want to present the functional block view to the operator. In this example, VAV Inspector is used for the document name. 6 Click VAV Inspector. The inspector document is displayed with no data. This indicates that the document is not associated with a target functional block. 7 Choose File > Properties. The functional block inspector document properties dialog is displayed. 8 Click Browse to choose the target functional block. The Select Functional Block dialog is displayed. 9 Click the plus sign in front of Second Floor Subsystem. 10 Click the plus sign in front of VAV21 device. 11 Select the VAV functional block as the target.

12 Click OK to select the target. 13 Click OK to close the Properties dialog and wait while Visual Integrator 3 scans and updated the functional block data.

Document Number 800263 Revision 3.7

181

Chapter 7 Creating an HMI a Tutorial 14 The Inspector document should look similar to the screen capture below:

Adding a document to display a trend plot


A document that displays a trend plot is useful for monitoring the ongoing long term behavior of a zone or unit. By creating a document below the VAV21 document and adding a Trendlog object, you can provide the operator with a view of the historical trend logs without the need to use Log Viewer. See Chapter 10 Logging and Viewing Data for a full description of the data logging capabilities of Visual Integrator 3 and a description of how to create a trend log profile required by the Trendlog object.
To add a document to display a trend: 1 Click the VAV21 document below the Second Floor HVAC subsystem document. 2 Choose File > New Document. 3 In the Other Documents tab, select Blank Graphic and click OK. 4 The document name is selected, so type a name that best fits how you want to present the trend to the operator. In this example, Temp Trend is used for the document name. 5 Select the document named Temp Trend and start Graphics Editor. Click the Trendlog object from the Object bar. 6 Using the mouse, drag a large rectangle from corner to corner. 7 Open the Trendlog object properties, select the ActiveX property tab and click the open button of the (OCX Properties) property.

182

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 8 To set the target Trendlog profile, click Browse. The Open Profile dialog is displayed.

If there are no profiles listed then you must first define the profiles using Log Viewer, as described in Chapter 10 Logging and viewing data. 9 Select the trend profile you want to view and click OK. 10 The selected profile name is displayed:

11 Click OK to accept and close the Trendlog properties. 12 Save the document and exit Graphics Editor.

Document Number 800263 Revision 3.7

183

Chapter 7 Creating an HMI a Tutorial 13 The document displays the trend log according to the profile settings, similar to following:

Deleting documents and restoring deleted documents


During the process of creating the hierarchical structure in TreeView, you may want to delete a document and then having deleted it, wish you hadnt. Visual Integrator 3 allows you to set an option for the effect of the delete operation on a document: permanent deletion or sent to the Windows Recycle Bin from which the document can be restored.
To set the document deletion option: 1 Choose Tools > Options:

2 Check the checkbox to cause deleted documents to be sent to the Windows Recycle Bin. When the checkbox is unchecked, documents are permanently deleted. To delete a document: 1 Click the document 2 From the toolbar choose the X to delete the document, or rightclick on the document and choose Delete from the popup menu.

184

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To restore a deleted document from the Recycle Bin: 1 Open the Recycle Bin. From the Recycle Bin toolbar choose View and set the view to Details. Locate the document you want to restore; the Original Location column indicates the folder on your computer where the document needs to be moved back to. 2 Choose File > Restore from the Recycle Bin menu to move the file back to its original location. 3 Exit Visual Integrator 3. When you restart Visual Integrator 3 the deleted document is restored to its original location in TreeView.

Adding hyperlinks to enhance navigation


Although Visual Integrator 3 provides a hierarchical structure in TreeView, it is convenient to also use hyperlinks to jump between documents. A hyperlink allows you to provide the operator with a jump to another specific document anywhere within the Visual Integrator 3 TreeView just by clicking on a control object.

Adding a hyperlink to an image object


This example describes how to add an invisible hyperlink such that when the operator moves the mouse cursor over the second floor area in the building image of the site home document and clicks, the view jumps to the Second Floor Subsystem document.
To add a hyperlink to an Image object: 1 Click the Facility A site home document. 2 Start Graphics Editor and click the image object from the Object bar.

Document Number 800263 Revision 3.7

185

Chapter 7 Creating an HMI a Tutorial 3 Using the mouse drag a rectangular area on the building image that closely covers the second floor:

4 Rightclick this image object to display the properties and select the ActiveX tab 5 Click the open button of the OCX Properties to display the control properties dialog:

6 Click Browse. The Select Link dialog is displayed to allow you to select the destination for the hyperlink. 7 Click the plus sign in front of ABC Company customer. 8 Click the plus sign in front of Facility A site. 9 Click the plus sign in front of HVAC system.

186

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 10 Select the Second Floor HVAC subsystem as shown below. Do not click the plus sign.

11 Click OK to complete your hyperlink selection. 12 Click OK to return to the property sheet. 13 Set the BackStyle property to 0 Transparent and close the property sheet. 14 Click Save on the Graphics Editor toolbar and exit Graphics Editor. 15 Move your mouse over the second floor of the building image. The mouse pointer changes to a hand indicating the presence of a hyperlink. Click on the hyperlink to jump to the Second Floor HVAC Subsystem document.

Adding a hyperlink to a DataPoint object


This example describes how to add a hyperlink to a DataPoint object such that when the operator moves the mouse cursor over the space temperature of a particular room in the second floor plan image and clicks, the view jumps to the equipment document for the VAV terminal unit conditioning that room.
To add a hyperlink to a DataPoint object: 1 Click the Second Floor HVAC subsystem document. 2 Start Graphics Editor. 3 Leftclick then rightclick the DataPoint object that displays the room temperature of the board room to view its properties. 4 Click the ActiveX tab 5 Click the open button of OCX Properties. 6 Select the Hyperlink tab. 7 Click Browse to display the Select Link dialog. 8 Click the plus sign in front of ABC Company customer. 9 Click the plus sign in front of Facility A site. 10 Click the plus sign in front of HVAC system. 11 Click the plus sign in front of Second Floor HVAC subsystem.

Document Number 800263 Revision 3.7

187

Chapter 7 Creating an HMI a Tutorial 12 Click the plus sign in front of VAV21 13 Select the VAV21 device. 14 Click OK to complete the hyperlink selection. 15 Click OK to return to the property sheet. 16 Close the property sheet. 17 Click Save on the Graphics Editor toolbar and exit Graphics Editor. 18 Move your mouse over the space temperature in the boardroom of the floor plan image. The mouse pointer changes to a hand indicating the presence of a hyperlink. 19 Click on the hyperlink to jump to the VAV21 document. 20 Click the back arrow button on the upper left corner of the toolbar to return to the Second Floor HVAC Subsystem document.

Adding a hyperlink to a Button object


This example describes how to overlay an Image object on a Button object such that when the operator clicks on the button, the Image object hyperlink jumps the view to the floor plan document for that floor. This approach provides a clearly labeled hyperlink in contrast to the stealth hyperlink described in examples 1 and 2. Recall that the buttons were created as described earlier in this chapter.
To add a hyperlink to a Button object: 1 Click the Facility A site home document. 2 Start Graphics Editor and click the Image object from the Object bar.

188

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Using the mouse drag a rectangular area directly over the Button object labelled Second Floor HVAC Subsystem.

4 Rightclick this Image object to display its properties and select the ActiveX tab 5 Click the open button of OCX Properties. 6 Click Browse. The Select Link dialog is displayed. 7 Click the plus sign in front of ABC Company customer. 8 Click the plus sign in front of Facility A site. 9 Click the plus sign in front of HVAC System. 10 Select the Second Floor HVAC subsystem. Do not click the plus sign. 11 Click OK to complete your hyperlink selection. 12 Click OK to return to the property sheet. 13 Set the BackStyle property to 0 Transparent and close the property sheet. 14 Click Save on the Graphics Editor toolbar and exit Graphics Editor. 15 Move your mouse over the button. The mouse pointer changes to a hand indicating the presence of a hyperlink. Clicking takes you to the second floor subsystem document.

Document Number 800263 Revision 3.7

189

Chapter 7 Creating an HMI a Tutorial

Conclusion
This tutorial describes how to create a typical human machine interface using Visual Integrator 3. The approach to the layout shown here has been proven over many installations to be intuitive and usable for a wide range of operators. However, every situation has its unique requirements and may challenge you to extent this layout in new and innovative ways.

190

Document Number 800263 Revision 3.7

Chapter 8 Creating a Custom Device Document


hapters 5 and 6 introduce Graphics Editor and the control objects. Chapter 7 provides a tutorial describing an approach to creating a human machine interface using the device templates provided with Visual Integrator 3. This chapter describes how to create a device document and a device template tailored to your exact needs, from Visual Integrator 3s basic building blocks or your own images.

Creating a custom device document


In the case where the device templates provided with Visual Integrator 3 do not represent exactly what you are need you must create your own custom graphical device document. This procedure describes how to create a custom device document representing a series flow VAV terminal unit with no reheat.
To create a custom device document: 1 Click the plus sign next to ABC Company site. 2 Click the plus sign next to HVAC System. 3 Select the Second Floor HVAC Subsystem document. 4 Choose File > New Document 5 Select the Device Documents tab. Select the Blank Device template and click OK to complete your selection.

6 The device document appears as New Blank Device in TreeView. 7 The name is selected, so type a new name, such as SeriesFanNoReheat.

Document Number 800263 Revision 3.7

191

Chapter 8 Creating a Custom Device Document 8 Select the SeriesFan NoReheat document and start Graphics Editor. 9 Add a 3 x 5 rectangular Image object starting from the upper left hand corner of the document. 10 Open the properties dialog for the Image object and click on the (OCX Properties) property from the ActiveX tab. 11 Click Browse Image. 12 Locate and select the following image file supplied with Visual Integrator 3: C: \ PROGRAM FILES \ CIRCON \ BIN \ IMAGES \ UHC302SSFLeft.gif. 13 Click Open and then Apply to select this image. 14 Click OK to close the properties dialog. Align the right edge of the image object to the right edge of the image. The image which is a component of a VAV terminal unit is displayed:

192

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 15 Add another Image object as a square immediately to the right of the first Image object.

16 Right click on the new Image object to bring up its Properties. 17 Click the (OCX Properties) property from the ActiveX tab. 18 Click Browse Image. 19 Locate and select the following image file supplied with Visual Integrator 3: C: \ PROGRAM FILES \ CIRCON \ BIN \ IMAGES \ UHC302S0H.gif. 20 Click Open and then Apply to select this image. 21 Click OK to close the properties dialog. You should see a partial picture of a VAV box:

Document Number 800263 Revision 3.7

193

Chapter 8 Creating a Custom Device Document 22 Select this second Image object and move it so that is fits with the first image object. You may want to turn off the Snap to Grid function of Graphics Editor by choosing Grid Settings from the Layout menu and clearing the Snap to Grid check box. 23 Click Save on the toolbar. 24 To add the fan, select the NVAnimated object from the Object Bar. 25 Using the mouse, drag a 2 x 2 square underneath the partial VAV box image object:

26 Right click on the NVAnimated object to bring up its Properties. 27 Click the (OCX Properties) property from the ActiveX tab. 28 Click Browse on the Locate Object tab. 29 Click the plus sign next to Second Floor Subsystem. 30 Click the plus sign next to VAV21 device. 31 Click the plus sign next to DO_0 object. 32 Click the plus sign next to nvoValueDO_0 network variable.

194

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 33 Select the value property of nvoValueDO_0 network variable:

34 Click OK to complete your object selection. 35 Select the GIF Selection tab and select the Link to file check box. 36 Click the file browse button to the right of the Link to file text box. 37 Locate the following file on your computers hard drive: C:\Program Files\Circon\BIN\Images\UHCSFAN.gif 38 Click Open. The first frame of the UHCSFAN.gif file is displayed on the Preview area of the property dialog. 39 Next, click the Map range of NV values to animation speed radio button. 40 Enter a minimum speed of 0 and a maximum speed value of 100:

41 Click OK to close. 42 Remove the lightgrey area around the fan image by dragging the sizing handles inward. Again, this works best with snap to grid turned off.

Document Number 800263 Revision 3.7

195

Chapter 8 Creating a Custom Device Document 43 Move the new fan image object over the fan rails of the first partial VAV box image object:

44 Click Save on the toolbar. 45 To add the damper, click the NVAnimated object from the Object Bar. 46 Using the mouse, drag a small square underneath the VAV box image object. 47 Right click on the new NVAnimated object to bring up its Properties. 48 Click the (OCX Properties) property from the ActiveX tab. 49 Click Browse on the Locate Object tab. 50 Click the plus sign next to Second Floor Subsystem. 51 Click the plus sign next to VAV21 device. 52 Click the plus sign next to Damper object. 53 Click the nvoDamper network variable: 54 Click OK to complete your object selection. 55 Select the GIF Selection tab and click the Link to file checkbox. 56 Click the file browse button to the right of the Link to file text box. 57 Locate the following file on your computers hard drive: C:\Program Files\Circon\BIN\Images\uhcSDAMPER.gif 58 Click Open. The first frame of the uhcSDAMPER.gif file is displayed on the Preview area of the property dialog. 59 Next, click the Map range of NV values to frames radio button.

196

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 60 Enter a minimum NV value of 0 and a maximum NV value of 100:

61 Click OK to close. 62 Remove the lightgrey area around the damper image by dragging the sizing handles inward. Again, this works best with snap to grid turned off. 63 Move the new damper image object over the duct of the first partial VAV box image object:

64 Click Save on the toolbar. 65 Click the Label object from the Object Bar. 66 Using the mouse, drag a rectangle directly underneath the VAV box image object. 67 Right click and enter the text for the ActiveX Caption property: Space Temperature: 68 Set the Font property to bold. 69 Click the DataPoint object from the Object Bar. 70 Using the mouse, drag a rectangle directly right of the previous label object. 71 Right click on the new DataPoint object to bring up its Properties dialog. 72 Click the (OCX Properties) property from the ActiveX tab.

Document Number 800263 Revision 3.7

197

Chapter 8 Creating a Custom Device Document 73 Click Browse under the Target Object text box. 74 Click the plus sign next to Second Floor Subsystem. 75 Click the plus sign next to VAV21 device. 76 Click the plus sign next to VAV object. 77 Select the nvoSpaceTemp network variable.

78 Click OK to complete your object selection. 79 Click OK, then close the properties dialog. 80 Add a Label object below Space Temperature, specifying Damper Position: as the caption with the font bold. 81 Add a DataPoint object to the right of Damper Position label and set the path to: Second Floor Subsystem/VAV21/Damper/nvoDamper 82 Set the Precision to 2, PrecisionFixed to Yes and ShowUnits to Yes. 83 Add a Label object below Damper Position, specifying Fan State: as the caption with the font bold. 84 Add an EnumPoint object to the right of fan state label and set the path to: Second Floor Subsystem/VAV21/DO_0/nvoValueDO_0.state 85 Make the font bold and specify the following in the Translations tab for this EnumPoint object:

86 Close the properties dialog and use the Layout menu to align the left side of the labels. 87 Align the left side of the corresponding data objects. 88 Click Save on the toolbar.

198

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 89 Choose File > Exit. 90 The document should look similar to the following:

You have now added a Custom Device document to the site!

Creating a custom device document template


Now that we have created a custom device document, we can create a template from it. If you intend to reuse the custom device document it is be more efficient to create a template from it. Templates are documents that can be reused as the basis for custom documents without having to start from basic building blocks.
To create a custom device document template: 1 Choose Tools > Documents 2 Select the Device Documents tab. 3 Click Add. A document named New Document 1 appears in the list.

Document Number 800263 Revision 3.7

199

Chapter 8 Creating a Custom Device Document

4 Select New Document 1 and click Rename. 5 Type a new name for this document, for example ParallelFanModReheat. 6 You have now created a new document template. The next step is to customize its appearance using Graphics Editor to add control objects that represent the images and information you want. This procedure is similar to the procedure Creating a Custom Device Document earlier in this chapter. To start, select the newlynamed device document template and click Edit to open Graphics Editor.

IMPORTANT: Because the intended use of a template is to reuse it for many devices, an additional step must be taken upon completion of the custom document to decouple the association of objects in the template from a specific subsystem and device. For any object on the custom document template such as a DataPoint object where the OCX Properties dialog required you to set a Path, you must remove that association following the procedure below:
To decouple the association of objects to a specific subsystem and device 1 Choose View > Hidden Properties so that it is checked. 2 Rightclick an object on the document and select the ActiveX tab. 3 Select the AppDevice property and replace its value with a quotation mark

200

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 4 Select the SubsystemPath property and replace its value with a quotation mark

5 Close Graphics Editor and close the Document Templates dialog.

Document Number 800263 Revision 3.7

201

Chapter 8 Creating a Custom Device Document

Adding a device document from a custom device document template


After creating a new device document template, you can use it as many times as you like for as many sites as you like for the same type of device and the same model of device application software.
To add a device document from a custom device document template to a site 1 Click the Second Floor HVAC Subsystem document. 2 Choose File > New Document. 3 On the Device Documents tab, select the document titled as: ParallelFanModReheat:

4 Click OK to complete your selection. The device document appears as named New Document. 5 Select New Document. The following error dialog is displayed because the document is not associated with a subsystem or device yet. Click OK.

6 Choose File > Properties. The target device dialog is displayed. 7 Click Browse. The Select Device dialog is displayed. Use this dialog to associate a subsystem and device of the type for which the customer document template was intended, with the document objects that require a path, for example the following steps select a UHC302 VAV terminal unit controller 8 Click the plussign in front of Second Floor Subsystem.

202

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 Select the VAV21 device.

10 Click OK. The Target Device has now been selected. 11 Click OK from the Properties window. 12 Rightclick New Document and choose Rename. 13 Enter a new name for this document. 14 From the View menu choose Refresh to refresh the document view.

Document Number 800263 Revision 3.7

203

Chapter 8 Creating a Custom Device Document

This page is left blank intentionally.

204

Document Number 800263 Revision 3.7

Chapter 9 Using Document Wizard

hapter 7 Creating a HMI describes the procedure for adding documents to a site individually from a list of document templates and the procedure to associate each document with a device or functional block. Document Wizard is builtin to Visual Integrator 3 and enables you to greatly reducing the amount of manual labor to create an HMI, especially when a site has many devices controlling similar pieces of equipment.

Document Wizard automates the process of adding documents and associating them with the appropriate devices or functional blocks. The document that is added for each device is configured by you from the list of device templates included with Visual Integrator 3 or created by you for the site. You can also configure Document Wizard to add functional block documents for specific device functional blocks. This chapter assumes you have read Chapter 4 Working with Visual Integrator Documents and Chapter 7 Creating an HMI a Tutorial. IMPORTANT: Document Wizard creates a structure of documents and subdocuments in the Visual Integrator 3 TreeView based on the subsystem and device hierarchy and names used in the sites LNS database. This may be different than the TreeView structure you want to present to the Visual Integrator 3 operators. After Document Wizard has been run, some work may be required to reorganize TreeView.

Main steps in using Document Wizard:


1 2 3 4 Ensure that Document Wizard lists a device template for each device application being used Ensure that Document Wizard lists all the document templates you plan to use Associate one or more documents with each device template Run Document Wizard and verifying the results

Document Number 800263 Revision 3.7

205

Chapter 9 Using Document Wizard

Verifying and adding device templates


Document Wizard must have a complete list of all the types of device applications being used on the devices. The type of application is represented by the device template which can be determined easily using the Subsystem Status document. If the Subsystem Status document lists a device template that is not on the Document Wizard list then it must be added to that list.
To verify and add device templates to Document Wizard: 1 Within the HVAC System document, click on the Subsystem Status document. 2 The Subsystem Status document displays a list of all the devices included in the LNS database for that subsystem as well as the device type or device template name for each device. For example, the device type for a UHC302 VAV controller may be Circon UHC302 m04. 3 Choose Tools > Documents. The Document Templates dialog is displayed:

4 On the Document Wizard tab, in the list labelled Device Template, verify that the device type is listed for each of the device types listed in the subsystem status document. When one is missing, it must be added. Click Add to display the Select Device Template dialog. You must be connected to the network to add device templates; otherwise the Add button is disabled.

5 Scroll down the list until you find the template name for the device. 6 Select the template name and click OK to complete your selection. The device template is added to the list.

206

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 7 Repeat above steps for any other device template/device type that you need on the Document Wizards Device Templates list.

Reviewing, editing and adding document templates


Document Wizard must have a complete list of all the document templates that you want to use for your HMI design.
To review document templates for Document Wizard: 1 Choose Tools > Documents. The Document Templates dialog is displayed. Select the Device Documents tab to display the available device document templates:

Sample document templates are provided with Visual Integrator 3 for most Circon devices. By using the templates as the basis for your user interface, you can built a complete, functional HMI much faster than by creating your own documents 2 To view a device document template, select the template and click Edit. This starts the Graphics Editor and allows you to view the layout of the template. If the device document templates are not suitable or they do not exist for your application, a new template should be created. See Chapter 4 Working with Visual Integrator Documents for a description about how to create and edit document templates. To add or edit document templates for Document Wizard: See Chapter 4 Working with Visual Integrator Documents for a description about how to create and edit document templates.

Document Number 800263 Revision 3.7

207

Chapter 9 Using Document Wizard

Associating documents with a device or functional block template


Once the devices program type has been determined and added to the device template list, associations to documents can be specified. The device itself can be associated with a document and each functional block in the device can be associated with a document. Document Wizard uses this program/document association to automatically assign that document to each device/functional block in the LNS network database with the corresponding program type.
To associate a document with a device template: 1 Choose Tools > Documents. The Document Templates dialog is displayed. Select the Document Wizard tab:

2 Select the device template from the list of device templates. Observe the name of the associated document template in the dropdown list box titled Use Document. If it displays <unassigned> then there is no associated document template for the selected device template. 3 Activate the Use Document dropdown list to display the list of available document templates. This is the same list displayed on the Device Documents tab. Click the document template you want to associate with the selected device template. This association causes Document Wizard to add that document template to any device with the selected device template/program type. 4 Click OK.

208

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To associate a document with a device functional block: 1 Choose Tools > Documents. The Document Templates dialog is displayed. Select the Document Wizard tab. 2 Select the device template from the list of device templates and click the plus sign to expand the view to display the functional blocks included in that device template. Select the functional block with which you want to associate a document.

Observe the name of the associated document template in the dropdown list box titled Use Document. If it displays <unassigned> then there is no associated document template for the selected functional block and Document Wizard will not create a document for this functional block. 3 Activate the Use Document dropdown list to display the list of available functional block document templates. This is the same list displayed on the Functional Block Documents tab. Click the document template you want to associate with the selected functional block. This association causes Document Wizard to add that functional block template as a subdocument to any device with the selected device template/program type. 4 Click OK.

Running Document Wizard


Once the associations between device templates and document templates have been reviewed and adjusted, as described in the earlier sections of this chapter, you can run Document Wizard to good effect. Document Wizard can be run any time in the future when you make further changes to the associations between device templates and document templates. Document Wizard creates in the Visual Integrator 3 TreeView for the site, a structure of documents and subdocuments based on the subsystem and device hierarchy and names used in the LNS database. This may be different than the TreeView structure you want to present to the Visual Integrator 3 operators. After Document Wizard is run, some work may be required to re organize TreeView.

Document Number 800263 Revision 3.7

209

Chapter 9 Using Document Wizard To run Document Wizard: 1 Select the position in TreeView where you want Document Wizard to insert the document structure it generates. In the example shown below, the Second Floor HVAC Subsystem was selected. 2 Choose File > Document Wizard. You are asked to confirm the operation:

3 Click Yes to run Document Wizard. The documents created by Document Wizard are found in TreeView under Subsystems. You may want to move the documents within TreeView to provide the exact navigation you intended for the site operator. Using the example below, to move the individual device documents, click on each document separately and drag it up until Second Floor HVAC Subsystem becomes highlighted. Release the mouse and the document is repositioned under Second Floor HVAC Subsystem. Typically, the LNS Network Interface is not exposed to a Visual Integrator 3 operator and can be deleted. After moving the device documents, you can delete the Subsystems document and its subdocuments.

Advanced topic
Often a building control system includes different equipment configurations that are controlled by the same make and model of device. For example, a site may have both VAV terminal units with reheat and some without reheat. You can use Document Wizard in this type of situation to generate the device documents for the various configuration of equipment, even though Document Wizard assigns the same device graphic to all devices of the same type. The procedure is outlined below:
To use Document Wizard to generate device documents for different equipment configurations: 1 Create a temporary blank graphic document below which Document Wizard will generate the device documents. 2 Select this document. 3 Choose Tools > Documents to open the Document Templates dialog and select the Document Wizard tab. 4 Select the Device Template for the common device being used for the different equipment configurations. 5 Set its associated document in the Used Document dropdown to an equipment configuration used in the site. 6 Click OK to close the Document Templates dialog. 7 Run Document Wizard. 8 From the documents generated under the temporary blank graphic document, move (drag and drop) the device documents for the equipment with the configuration selected in step 4, to another location in the site TreeView. 9 Delete all the documents below the temporary blank graphic document. 10 Repeat steps 3 through 9 for each different equipment type. 11 As a test, click the plussign in front of a VAV device. The device document should be displayed in the righthand pane with live information from the VAV device.

210

Document Number 800263 Revision 3.7

Chapter 10 Logging and Viewing Data

ircon 300Series devices can be configured to trend and store point data and event data, locally in data logs which reside in device memory. UHC300 and UHC320 devices can also store runtime and startup count data. Point data from other manufacturers devices can also be trended by binding the data points to a Circon MAC300STA device and configuring its trend logs. Because device data logs hold a limited amount of data and because the oldest data is overwritten by newer data over the course of time, the trend data must be transferred to the Visual Integrator Server computer.

Visual Integrator 3 provides the solution to the retention of longterm historical data. Visual Integrator 3 records or logs data from Circon devices into its SQL database, for longterm historical retention and analysis. Three types of data can be recorded: trend data, event data including alarms and runtime/startup count data. Log Viewer is a tool included with Visual Integrator 3 to allow you to view the recorded data as charts or tables. You can create profiles that set the parameters of specific views of the data allowing operators to recall the view quickly, in the same way each time. As an alternative to using Log Viewer to view trend plots, you can embed a trend plot in a document using the Trendlog object. Using this approach, the operator does not have to learn the Log Viewer tool to view important trends. The Trendlog object is described in Chapter 6 Control objects reference. You can also use Log Viewer to export trend data to another software tool or to print the trend chart. In addition, events and runtime/startup count data can be printed in report format or exported to another software tool. This chapter provides stepbystep procedures to set up Visual Integrator 3 to log data from devices on the local network and from devices on a remote network. It also describes the many features of Log Viewer for viewing and printing trend, event and runtime/startup count data. Recall from Chapter 2 A Quick Tour that a local network is a network that is characterized by a topology using a persistent connection from Visual Integrator 3 to the site whereas a remote network is characterized by a topology using a temporary connection from Visual Integrator 3 to the site. In either case the site can be located in close proximity to the Visual Integrator 3 or at a distance.

Document Number 800263 Revision 3.7

211

Chapter 10 Logging and Viewing Data

Main steps in setting up data logging:


1 2 3 4 Configuring the Trendlog functional blocks in the devices for the data points you want to record data from; Configuring the event logging in the devices you want to record them from; Setting up the Visual Integrator 3 logging properties for each site to identify the devices and data you want to retain in Visual Integrator 3s SQL database; For a local site, start Visual Integrator 3s Local Data Logger service; for remote sites set up the schedule of days and times you want Visual Integrator 3s Remote Data Logger to connect to the site and record the data from the devices;

See the illustrations in Chapter 2 A Quick Tour for conceptual views of local data logging and remote data logging system configurations. IMPORTANT Visual Integrator 3 support for data logging and plotting is limited to network variable types that meet the following criteria:
SNVT must be one or two bytes in length Enumerated SNVTs are logged and are plotted as numbers (i.e. the numeric equivalent of the enumerated value) SNVT_switch is logged and plotted as 0 or 1 based on the twostate interpretation rule defined by LonMark SNVT_lev_disc is logged and plotted as 0 or 1 based on the following rules: ST_OFF is logged as 0 ST_NUL is ignored all other enumerations are logged and plotted as 1 Other structured SNVTs are not supported

Configuring devices for data logging


This section provides an overview of the procedure for setting up trending in the Circon devices. See the Help for the Trendlog functional block plugin for detailed information.

Configuring a devices trend logs:


Although all Circon devices can be configured to trend and store point data and event data locally in data logs in their device memory, you may only be interested in recording specific points on specific devices. You enable the device to collect data from a point by configuring one of the devices Trendlog functional blocks, using its configuration plugin this plugin includes a plot viewer of the data it has logged. This procedure uses the ABC Company Facility A site as an example. This site is developed in Chapter 7 Creating an HMI a Tutorial.

212

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To configure a Trendlog functional block: 1 In the HVAC System document, select the Subsystem Status document. 2 Rightclick the Second Floor subsystem/UHC AC2 device from the device list and select Properties from the popup menu. The device properties dialog is displayed. 3 Select the Func. Blocks tab to view the list of functional blocks for this device. 4 Scroll down the list until you find the functional block named Supply Air Temp trend.

5 Select Supply Air Temp trend and rightclick to select the PlugIns > Circon Trend Log Configuration option. 6 The Trendlog configuration plugIn opens. Configure the trend as required. The plugin online help describes how to configure a trendlog. 7 Repeat this procedure for all devices and points you want to record data from.

Configuring Visual Integrator 3 for data logging


This step contains several substeps, depending on the approach being used to connect to the site: 1. Select the devices you want to log data from 2. Set up the data logging interval (how often you want to transfer data from the devices to the Visual Integrator 3 SQL database). This procedure is different for version 3.5 and earlier, and version 3.6 and later. 3. Set up for local site or set up for remote site. Choose only the procedure that pertains to the site connectivity used. 4. Starting the Circon data logging service.

Document Number 800263 Revision 3.7

213

Chapter 10 Logging and Viewing Data

Selecting the devices to log data from:


The second step in setting up the devices to log data from is to configure Visual Integrator 3 to log specific data from the specific devices. If you intend to log data from multiple sites then each site must be configured. If you intend to log data from single site then only that site must be configured. For each site that you intend to log data from, configure Visual Integrator 3 as described below.
To configure logging in Visual Integrator 3: 1 Choose Tools > Network > Configure Logging. The Configure Logging dialog is displayed. 2 Click the plussign in front of Second Floor Subsystem folder. 3 Click the plussign in front of the devices you want to log data from. 4 Select the appropriate check boxes of the data logs you want to log from a device. If you do not select a data log then that data remains in the device and is not logged into the Visual Integrator 3 SQL database.

Event Logging specifies that event data stored in the devices event log and alarms generated by the device are logged to the Visual Integrator 3 SQL database. Trend Logging specifies that trend data stored in all the devices enabled trend logs are logged to the Visual Integrator 3 SQL database. Runtime Logging specifies that runtime and startup count data for all digital output points on the device are logged to the Visual Integrator 3 SQL database. Runtime logs accumulate the number of hours that a digital output has been in the on state and the number of times that the digital output has turned on or started up. Only the UHC300 and the UHC320 support runtime and startup count logging.

214

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Setting up the data logging interval version 3.5 and earlier


If you are using Visual Integrator 3, version 3.6 or later, skip this section and see the following section. Visual Integrator 3 periodically contacts each device for which logging is configured and uploads the data. Depending whether the site is local (persistent connection) or remote (temporary connection), you set up the interval for the uploads differently but on the same dialog, as described below. The network interface must be selected and configured before you can set up the data logging intervals.
To set up the data logging interval version 3.5 and earlier 1 Choose Tools > Manage Sites 2 Navigate to the site Properties dialog and select the Logging tab. For a remote site (temporary connection), skip to step 5. 3 Select the Enable Data Logging check box. This check box can be used to turn logging on and off without changing other settings. 4 For a local site only, in the bounded area titled Local Alarm and Data Logging set the scan intervals:

Scan for trends specifies the interval in seconds between scanning the trend logs on the devices on the local network. Scan for events specifies the interval in seconds between scanning the event logs on the devices on the local network. Scan for runtime specifies the interval in minutes between scanning for runtime and startup count data on the devices on the local network.
The Launch LNS Server check box has no effect on data logging. Its purpose is to enable Visual Integrator 3 to launch the LNS Server at the same time that the local alarm or data logging services are started. To learn about the intended purpose of the Launch LNS Server check box, see Chapter 18 Setting up Visual Integrator 3 as server and workstations. 5 For a remote site, in the bounded area titled Remote data logging, set the day and time when you want Visual Integrator 3 to connect to the site and scan devices for trend, event and runtime/startup count data. Use Add to add a day and time; use Delete to remove a day and time. If you set the same day and time for multiple remote sites then Visual Integrator 3 connects to each site sequentially, starting at that day and time.

Document Number 800263 Revision 3.7

215

Chapter 10 Logging and Viewing Data

Site properties, Logging tab. For version3.5 and earlier

Setting up the data logging interval version 3.6 and later


If you are using Visual Integrator 3, version 3.5 or earlier, and see the preceding section. The network interface must be selected and configured before you can set up the data logging intervals.
To set up the data logging interval version 3.6 and later 1 Choose Tools > Manage Sites. 2 Navigate to the site Properties dialog and select the Services tab. For a remote site (temporary connection), skip to step 5. 3 For a local site (persistent connection), in the bounded area titled Services that require a Local LNS Server and a persistent connection, select the Enable Data Logging check box. This check box can be used to turn logging on and off without changing other settings. 4 For a local site (persistent connection), set the scan intervals:

Scan for trends specifies the interval in seconds between scanning the trend logs on the devices on the local network. Scan for events specifies the interval in seconds between scanning the event logs on the devices on the local network. Scan for runtime specifies the interval in minutes between scanning for runtime and startup count data on the devices on the local network.
The Launch LNS Server check box has no effect on data logging. Its purpose is to enable Visual Integrator 3 to launch the LNS Server at the same time that the local alarm or data logging services are started. To

216

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide learn about the intended purpose of the Launch LNS Server check box, see Chapter 18 Setting up Visual Integrator 3 as server and workstations. 5 For a remote site (temporary connection), in the bounded area titled Services that require a Local LNS Server and a temporary connection, select the Enable Data Logging check box. This check box can be used to turn logging on and off without changing other settings. 6 For a remote site (temporary connection), set the day and time when you want Visual Integrator 3 to connect to the site and scan devices for trend, event and runtime/startup count data. Use Add to add a day and time; use Delete to remove a day and time. If you set the same day and time for multiple remote sites then Visual Integrator 3 connects to each site sequentially, starting at that day and time.

Site properties, Services tab. For version3.6 and later Local site (persistent connection) Remote site (temporary connection)

Local site: using an i.LON 10/100 to connect to the site


Skip to next section if you are working with a remote site (temporary connection).

Enabling persistent connection to i.LON10/100 If you are using an i.LON 10 or i.LON 100 as the network interface at one or more sites and you

want to log data using the local network, persistent connection approach, then you must enable the services to maintain a persistent connection. The configuration option on the i.LON 10/100 tab of site properties labeled Circon services persist connection allows the Circon Local Data Logger and Local Synchronization services to treat a site connected using an i.LON 10/100 as a persistent connection. The service opens the connection to i.LON 10/100 and holds the connection for as long as the service is running. This allows Visual Integrator 3 to perform data logging when an iLON 10/100 is involved. Consult Circon technical support for advice on the limitations of this approach; LNS limits the number of connections to i.LON 10/100s.

Document Number 800263 Revision 3.7

217

Chapter 10 Logging and Viewing Data To enable persistent connection to i.LON10/100 for a site: 1 From the toolbar, choose Site Management 2 Navigate to the site properties dialog and select the i.LON 10/100 tab. 3 Select the Circon services persist connection check box, as below:

Local site: starting the Local Data Logger service


Skip to next section if you are working with a remote site (temporary connection).

The Local Data Logger service performs the work of periodically scanning the devices on the local network and logging the data into the Visual Integrator 3 SQL database. Local Data Logger is a Windows service, a task that runs independently and indefinitely in the background even when Visual Integrator 3 is not running and when no operators are logged into Windows. Local Data Logger must be started after all of the previous steps are completed. If you later add or remove devices for data logging you must stop and restart Local Data Logger.
To start the Local Data Logger service: 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar, choose Circon Service Manager. The Circon Service Manager is displayed. 3 Select the box adjacent to Circon Local Synchronization service and Circon Local Data Logger service to allow the Windows operating system to start these services automatically when it restarts. 4 Click on the text Circon Local Data Logger to select it.

218

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 Click Start to start the service now. Wait until the Status for both Circon Local Synchronization service and Circon Local Data Logger service change to Started.

6 Close the Circon Service Manager dialog. The Local Data Logger Service is now setup and immediately performs an initial scan to log data from the devices selected. 7 You can verify that the services have started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility.

Remote site over PSTN: starting SLTALink Manager and Remote Data Logger
Use this procedure to set up data logging from remote sites that are accessed over temporary connections via a public standard telephone network.
Go to previous section if you are working with a local site. Go to next section if you are working with remote sites connected over TCP/IP.

Unlike local data logging, you must remain logged in to Visual Integrator 3 in order for remote data logging connections over public standard telephone networks to occur as scheduled. You do not need to start Local Data Logger service if you are using remote data logging only. The service is used only when logging from a local site. IMPORTANT: the procedure below assumes you have previously configured the modem and SLTALink Manager. See Chapter 3 Working with Customers and Sites for a description of how to set up the SLTALink Manager.
To start applications for remote data logging over PSTN 1 Start Visual Integrator 3 and log in. Do not open any of the remote sites. 2 Start SLTALink Manager from the Start menu: Start > Programs > Echelon SLTA10 Network Adapter > SLTALink Manager. On the Link menu choose Hide Link Manager.

Document Number 800263 Revision 3.7

219

Chapter 10 Logging and Viewing Data 3 Start Remote Data Logger from the Start menu: Start > Programs > Circon > Visual Integrator > Remote Data Logger. The Remote Data Logger dialog is displayed.

4 You can minimize the Remote Data Logger dialog but it must remain running. Remain logged in. Visual Integrator 3, SLTALink Manager and Remote Data Logger applications need to be running to perform remote data logging.

Remote site over TCP/IP: starting Remote Data Logger service


Use this procedure to set up data logging from remote sites that are accessed over temporary connections via a TCP/IP network such as a WAN or the Internet. This procedure below assumes you have previously configured the i.LON10, I.LON 100 or equivalent Remote Network Interface device at the remote site and have installed the Echelon Xdriver software on the Visual Integrator 3 computer.
Go to earlier section if you are working with a local site. Go to previous section if you are working with a remote site connected over a telephone network.

The Remote Data Logger service performs the work of periodically scanning the devices on the remote network and logging the data into the Visual Integrator 3 SQL database. Remote Data Logger is a Windows service, a task that runs independently and indefinitely in the background even when Visual Integrator 3 is not running and when no operators are logged into Windows. Remote Data Logger must be started after all of the previous steps are completed. If you later add or remove devices for data logging you do not need to stop and restart Remote Data Logger as it automatically checks for this.
To start the Remote Data Logger service: 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar choose, Circon Service Manager. The Circon Service Manager is displayed. 3 Select the box adjacent to Circon Local Synchronization service and Circon Remote Data Logger service to allow the Windows operating system to start these services automatically when it restarts. 4 Click on the text Circon Remote Data Logger to select it.

220

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 Click Start to start the service now. Wait until the Status for both Circon Local Synchronization service and Circon Remote Data Logger service change to Started.

6 Close the Circon Service Manager dialog. The Remote Data Logger service is now setup. It will connect to the remote sites scan to log data on the next scheduled day and time. 7 You can verify that the services have started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility. The Remote Data Logger service also updates the Application log each time it connects to a site.

Viewing logged data


Log Viewer is a tool to allow you to view recorded data from the working SQL database or an archive database. This data can be viewed as line plots for trends or as tables for events and runtime/startup count data. You can also use Log Viewer to print the trend plot or to export trend data to another software tool such as Excel. In addition, the event and runtime/startup count data can be printed in report format or exported to another software tool. You can display multiple views of the data in separate windows. You can create profiles that set the parameters of specific views of the data allowing operators to quickly recall the view in the same way each time. A profile must be configured before the data can be viewed. Profiles are easily changed at any time. There are three types of profiles: trend profiles, event profiles and runtime profiles.

Starting Log Viewer from the Start menu


To start Log Viewer from the Windows Start menu: 1 Click Start from the Windows Task bar. 2 Choose Programs > Circon > Visual Integrator > Log Viewer. The login dialog is displayed:

3 Enter a User Name and Password as already defined in Visual Integrator 3.

Document Number 800263 Revision 3.7

221

Chapter 10 Logging and Viewing Data

Starting Log Viewer from the Visual Integrator 3 tool bar


To start Log Viewer from the Visual Integrator 3 tool bar: 1 Log in to Visual Integrator 3 2 Click the Log Viewer button from the tool bar.

Viewing data from an archive


To view logged data from an archive: 1 Start Log Viewer 2 click File > Open Archive 3 Select the archive you want to view. The file name indicates the date and time the archive was created.

Viewing trend plots


This section describes how to use Log Viewer to view trend data as line plots. As an alternative to using Log Viewer to view trend plots, you can embed a trend plot in a document using the Trendlog object. Using this approach, the operator does not have to learn the Log Viewer tool to view important trends. The Trendlog object uses a trend profile for the data you want to display. The Trendlog object is described in Chapter 6 Control objects reference. Review the introduction to this chapter for information about limitations on plotting data of certain network variable types.

Creating a trend profile


This procedure uses the tutorial ABC Company Facility A site as an example.
To create a trend profile: 1 From the Log Viewer File menu choose New > Trend Profile, or click the New Trend Profile button on the Log Viewer tool bar. The trend profile properties dialog is displayed:

222

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

2 Click the plus sign in front of customer and site. 3 Click the plus sign in front of Second Floor subsystem. The Select Devices area displays a tree view of the Circon devices that have recorded data in the SQL database; this may be a different view than the treeview you developed in the Visual Integrator TreeView. You must have already configured devices for logging, as described earlier in this chapter. IMPORTANT: A device is not displayed in the treeview until the Circon data logging service that collects the data is running and has uploaded some data from the device and stored it in the SQL database. Treeview gets device information from the SQL database, not the LNS database. The solution is to allow the devices trend log to record one trend record and to wait until the scan interval for the data logging service has elapsed so that the trend data is logged in the SQL database; then use Log Viewer to configure the trend, the device and trend log should appear in the treeview. 4 Click the plus sign in front of the UHC AC2 and VAV21 devices. A list of enabled trendlog functional blocks is displayed. Trendlog functional blocks that are not enabled do not appear in the list. 5 Click Supply Air Temp, the trendlog for the UHC AC2 device. 6 Click Add to add it to the profile. Information about the trendlog is displayed in the Selected Devices area.

Document Number 800263 Revision 3.7

223

Chapter 10 Logging and Viewing Data

7 Click TrendLog_0, the space temperature trendlog for the VAV21 device. 8 Click Add to add it to the profile. A trend plot can contain up to four trend log plots. The added trendlogs are indicated by boldface in the treeview.

224

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 Click OK to display the trend plot.

10 Typically the initial plot does not present the data in the most readable format. If you want to change the appearance or the range of the data displayed, see Customizing the appearance of a trend log plot. 11 Choose File > Save or click Save. You are prompted for a name for this profile:

12 Enter a name for the profile and click OK to save the profile. The next time you want to display the plot configured in this profile, select it by name from the File menu by choosing Open > Trend profile.

Document Number 800263 Revision 3.7

225

Chapter 10 Logging and Viewing Data

Customizing the appearance of a trend log plot


You can modify the appearance of the plot when you first create the trend log profile or at any time in the future as your needs change.
To open a profile for modification: 1 Click Open Trend Profile on the tool bar and select the profile to be modified. 2 Once the trend plot is displayed, choose Profile Properties from the File menu or click Properties on the tool bar. To change the color used for the plots data points and lines: 1 With the profile properties open, select an entry in the Selected Devices area and click Properties to display the Plot Settings dialog:

2 Choose a color from the dropdown list labelled Color. Click OK to close. To change the text used for the plots legend: 1 With the profile properties open, select an entry in the Selected Devices area and click Properties to display the Plot Settings dialog, as shown above. 2 Enter the text to be displayed in the legend in the box labelled Title. Click OK to close. To change the style of the symbol representing the data points on the plot: 1 With the profile properties open, select an entry in the Selected Devices area and click Properties to display the Plot Settings dialog, as shown above. 2 Choose a point style from the dropdown list labelled Style. Click OK to close.

226

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To change the range in time of the units used for the plots Xaxis scale: 1 With the profile properties open, select the View tab.

2 In the bounded area titled Scale XAxis, set the Xaxis scale range:

Full Scale the Xaxis scale is set to the entire time range for the data range as selected on the Filter tab. Range set the Xaxis to display a reduced time range view for the data range as selected on the Filter tab. The view must be scrolled left and right to view the all the data for the data range as selected.
To change the range in the engineering units used for the plots Yaxis scale: 1 With the profile properties open, select the View tab. 2 In the bounded area titled Scale YAxis, set the Yaxis scale range:

Full Scale the Yaxis scale is set to the entire value range of the engineering units for the data type. Range set the Yaxis to display a reduced value range view for the data type as entered in the Minimum and Maximum fields. The highest value on the Y axis is set to the Maximum value and the lowest value on the Yaxis is set to the Minimum value. The view may have to be scrolled up and down to view the all the data for the full scale value range.
To change the label displayed for the plots Xaxis and Yaxis: 1 With the profile properties open, select the View tab. 2 In the bounded area titled Axis Label , enter the text for the Xaxis and Yaxis labels

Document Number 800263 Revision 3.7

227

Chapter 10 Logging and Viewing Data To change the title text, font or color displayed for the trend plot: 1 With the profile properties open, select the View tab. 2 In the bounded area titled Title, enter the text for the title in the Name box. The title can be terse or quite verbose and can consist of more than one line of text. 3 Click Change Font to select the font and its color. To change the background color displayed for the trend plot: 1 With the profile properties open, select the View tab. 2 In the bounded area titled Background and click the dropdown list to select a solid background color or check the Gradient Background checkbox and select the Start Color and End Color from the corresponding dropdown list.

After adjusting the view properties, the initial plot now becomes:

228

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Filtering the range of data in a trend log plot


You can modify the range in time of the data that is plotted when you first create the trend log profile or at any time in the future as your needs change or the amount of data increases. This allows you to select a subset of all trend data in the SQL database.
To change the range of data in a trend log plot: 1 File > Open > Trend profile and select the profile to be modified. 2 Select the Filters tab where you can set the period of time from which the plotted data is taken. You will likely have experiment with the impact of using various filters to help you choose the right ones.

Show all plots the full range of data, that is all data stored in the Visual Integrator 3 SQL database from selected devices trend log. Show most recent plots data that go back in time by the time period that you select from the dropdown list, up to the present. Show from/to plots data in the time period you select from the dropdown lists

Document Number 800263 Revision 3.7

229

Chapter 10 Logging and Viewing Data

Viewing a trend log plot


Log Viewer provides many features to allow you to explore the trend plot to better analyze the data presented. You can:
Use the tool bar buttons to zoom in and out Use the tool bar buttons to scroll the view around the data set. Use the mouse to scroll and zoom View the data values associated with a single point Print the trend plot as it is displayed

Each of these is described below:


To scroll and zoom using tool bar buttons:

The function of each of the tool bar buttons is described below:


Button Function
Scroll left Scroll right Scroll up Scroll down Zoom in Zoom out Horizontal zoom in Horizontal zoom out Full view Refresh

Description
Scrolls view to left to display earlier time values Scrolls view to right to display more recent time values Scrolls view upwards to display higher Yaxis values Scrolls view down to display lower Yaxis values Expands both the Xaxis and Yaxis scales about their midpoints to increase resolution Reduces both the Xaxis and Yaxis scales about their midpoints to decrease resolution Expands the Xaxis scale about its midpoint to increase resolution Reduces the Xaxis scale about its midpoint to decrease resolution Plot is displayed according to profile canceling scaling done by zoom functions Updates the plot from the SQL database. Depending on the filter settings, new data that may have been added by a scan by the Local or Remote Data Logger are displayed. Plot is displayed according to profile, canceling scaling done by zoom functions.

To scroll using the mouse: Right click on the trend plot view and drag the mouse. The plot moves to follow the mouse in any direction.

230

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To zoom using the mouse: Left click on the trend plot view and drag the mouse. An outline is displayed; adjust its size by dragging until it bounds the area of the plot that you want enlarged. Release the mouse and Log Viewer redraws the plot to display the selected area enlarged. Repeat as required to gain the resolution required. Click the Full Screen button to return to the scale specified by the profile. To view the coordinate data of a single point: 1 Position the mouse cursor over the point. If the points are close together you may want to zoom in. 2 When the mouse cursor changes to a pointing hand, left click and the data are displayed:

Printing a trend log plot


Use this procedure to print a trend log plot on any networked Windowssupported printer.
To print a trend plot: 1 Display the trend plot on your monitor as you want it to be printed. 2 Choose File > Print. The standard Windows Print dialog for your printer is displayed. You will likely want to use landscape paper orientation.

Exporting trend log data


Log Viewer provides an Export function which allows you to save trend data in a file formatted as CSV or comma separated values. Files of this type can be easily read by analytic and charting tools such as Microsoft Excel. Exporting is also an alternative method for backing up historical trend data. The Export function saves the data set for the time interval that is specified by the filter setting of the profile.
To export trend log data: 1 Configure the profile to define the data set you want to export 2 Display the trend plot 3 Choose File > Export. The Windows Save dialog is displayed. Name the file and save it.

Document Number 800263 Revision 3.7

231

Chapter 10 Logging and Viewing Data

Viewing events
Log Viewer is a tool to allow you to view recorded event log data as tables. You can also use Log Viewer to print the event log data. You can display multiple views of the data in separate windows. You can create profiles that set the parameters of specific views of the data allowing operators to quickly recall the view in the same way each time. A profile must be configured before the data can be viewed. Profiles are easily changed at any time.

Creating an event profile


This procedure uses the tutorial ABC Company Facility A site as an example.
To create an event profile: 1 From the Log Viewer menu choose File >New > Event Profile, or click New Event Profile on the Log Viewer tool bar. The event profile properties dialog is displayed: 2 Click the plus sign in front of the customer ABC Company and site. 3 Click the plus sign in front of Second Floor subsystem. . The Select Devices area displays a tree view of the Circon devices that have recorded events in the SQL database; this may be a different view than the treeview you developed in the Visual Integrator TreeView. You must have already configured devices for event logging, as described earlier in this chapter. IMPORTANT: A device is not displayed in the treeview until the service that collects the data from that device is running and has uploaded some data from it to the SQL database. Treeview gets device information from the SQL database, not the LNS database. 4 Select the UHC AC2 device.

232

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 Click Add to add it to the profile. Information about the devices selected is displayed in the Selected Devices area.

6 Select the VAV21 device. 7 Click Add to add it to the profile. A trend plot can contain up to four trend log plots. 8 Click OK to display the event table.

Document Number 800263 Revision 3.7

233

Chapter 10 Logging and Viewing Data 9 If you want to change the sorting order or the range of the events displayed, see following sections. 10 Choose File > Save or click Save. You are prompted for a name for this profile: 11 Enter a name for the profile and click OK to save the profile. The next time you want to display the events configured in this profile, select it by name by choosing File > Open > Event Profile.

Filtering the range of events


You can modify the default range of events displayed when you first create the event profile or at any time in the future as your needs change or the amount of data increases. Events for the devices selected can be filtered in these ways:
Time Priority Event category and code Text in the event description
To modify the filters for an event profile: 1 Choose File > Open > Event profile and select the profile to be modified. 2 Select the Filters tab where you can set the period of time from which the event data is taken. You will likely have to experiment with the impact of using various filters to choose the right one.

3 In the bounded area titled Time, select one of the three radio buttons, as follows:

Show all displays all events in the SQL database. Show most recent displays events that go back in time by the time period that you select from the dropdown list, up to the present. Show from/to displays events in the time period you select from the dropdown lists.
4 In the bounded area titled Priority, select one or more of the check boxes to include events of those priorities in the view. If none is selected, then no events are displayed.

234

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 In the bounded area titled Event Code, select <all> to include events in all categories of event code in the view. Otherwise, select a specific category and, if desired, select a specific event code from the Code dropdown list. 6 To view only those events with a specific text fragment in their description, type that text fragment in the Description box and use the wildcard character % to indicate that it is a fragment. For example, to display only events with the word "actuator" in the description, type %actuator% in the description box. The SQL LIKE clause is used when filtering on descriptions; you may want to investigate this clause to understand its other wildcard capabilities 7 Click OK to display events.

Sorting events
You can modify the order in which the events are displayed when you first create the event profile or at any time in the future as your needs change or the amount of data increases. Events for the devices selected by the filtering can be sorted in four ways according to the following data items: Timestamp of the event Site Priority Event code Category Device Functional block Text in the event description

Document Number 800263 Revision 3.7

235

Chapter 10 Logging and Viewing Data To modify the sorting for an event profile: 1 Choose File > Open > Event profile and select the profile to be modified. 2 Select the Sorting tab and use one to four of the dropdown list boxes to set the sorting order.

3 Click OK to display events.

Viewing runtime and startup count data


Runtime data provides information about the number of hours that a digital output has been in the on state. Startup count data provides information about the number of time that a digital output has transitioned from the off state to the on state. The Local and Remote Data Logger obtain this data directly from the functional block associated with the digital output point; it is not necessary to configure a Trendlog functional block. Only the programmable controllers: UHC300 and UHC320 digital outputs support runtime and startup count data logging. Runtime and startup data continue to accumulate in the device until reset using the Device Viewer plugin. You can create profiles that set the parameters of specific views of the data allowing operators to quickly recall the view in the same way each time. A profile must be configured before the data can be viewed. Profiles are easily changed at any time.

236

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Creating a runtime and startup count profile


This procedure uses the tutorial Facility A site as an example.
To create a runtime and startup count profile: 1 From the Log Viewer menu choose File > New > Runtime Profile, or click New Runtime Profile on the Log Viewer tool bar. The runtime profile properties dialog is displayed: 2 Click the plus sign in front of the customer and site. 3 Click the plus sign in front of Second Floor subsystem. The Select Devices area displays a tree view of all Circon devices that have recorded data in the SQL database; this may be a different view than the treeview you developed in the Visual Integrator TreeView. Not all Circon devices support runtime/startup data logging. You must have already configured devices for runtime logging, as described earlier in this chapter. IMPORTANT: A device is not displayed in the treeview until the service that collects the data from that device is running and has uploaded some data from it to the SQL database. Treeview gets device information from the SQL database, not the LNS database. 4 Click the plus sign in front of the UHC AC2 device which is a UHC300. The I/O point functional blocks only are displayed. 5 Select one of the output points that are configured as a digital output. 6 Click Add to add it to the profile. Information about the devices selected is displayed in the Selected Devices area.

7 Select additional digital outputs from the same device or select another device and its digital output. Click Add to add it to the profile. A runtime profile can contain up to ten digital output points. 8 Click OK to display the runtime table.

Document Number 800263 Revision 3.7

237

Chapter 10 Logging and Viewing Data 9 If you want to change the sorting order or the range of the runtime data displayed, see Filtering the range of runtime data and Sorting runtime data. 10 Choose File > Save or click Save. You are prompted for a name for this profile: 11 Enter a name for the profile and click OK to save the profile. The next time you want to display the runtime data configured in this profile, select it by name from the File menu by choosing Open > Runtime profile.

Filtering the range of runtime data


You can modify the default range of runtime data displayed when you first create the runtime profile or at any time in the future as your needs change or the amount of data increases. Runtime data for the devices selected can be filtered in three ways: Time Runtime hours Startup count

To modify the filters for a runtime profile: 1 Choose File > Open > Runtime profile and select the profile to be modified. 2 Select the Filters tab where you can set the period of time from which the runtime data is taken. You will likely have experiment with the impact of using various filters to choose the right one.

238

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 In the bounded area titled Time, uncheck the Enabled checkbox to go back in time to the first event stored in the Visual Integrator 3 SQL database for the devices selected in the profile up to the present, otherwise check the Enabled checkbox and then select one of the two radio buttons as follows:

Show most recent displays runtime and startup data that go back in time by the time period that you select from the dropdown list, up to the present. Show from/to displays runtime and startup data in the time period you select from the drop down lists.
4 In the bounded area titled Runtime Hours, uncheck the Enabled checkbox to include all digital output points regardless of the accumulated runtime hours, otherwise check the Enabled checkbox and then set the greater than and less than values as follows:

Greater than specifies the threshold for the minimum number of runtime hours a digital output point must have accumulated to be included in the view of runtime data. Only points with more than this number of runtime hours are included. Less than specifies the threshold for the maximum number of runtime hours a digital output point must have accumulated to be included in the view of runtime data. Only points with less than this number of runtime hours are included. Setting the Greater than value to be lower than the Less than value means the included points have runtime hours in the range between the two thresholds. Setting the Greater than value to be higher than the Less than value means the included points have runtime hours outside the range between the two thresholds.
5 In the bounded area titled Startups, uncheck the Enabled checkbox to include all digital output point regardless of the accumulated startup counts, otherwise check the Enabled checkbox and then set the greater than and less than values as follows:

Greater than specifies the threshold for the minimum number of startup counts a digital output point must have accumulated to be included in the view. Only points with more than this number of startup counts are included. Less than specifies the threshold for the maximum number of startup counts a digital output point must have accumulated to be included in the view. Only points with less than this number of startup counts are included.

Sorting runtime data


You can modify the order in which the runtime data are displayed when you first create the runtime profile or at any time in the future as your needs change or the amount of data increases. Runtime data for the devices selected by the filtering can be sorted in four ways according to the following data items: Timestamp when the runtime data was logged in the SQL database Site Device Functional block

Document Number 800263 Revision 3.7

239

Chapter 10 Logging and Viewing Data

Runtime Hours Startup Count

To modify the sorting for a runtime profile: 1 Choose File > Open > Runtime profile and select the profile to be modified. 2 Select the Sorting tab and use one to four of the dropdown list boxes to set the sorting order.

3 Click OK to display runtime data.

Archiving logged data and managing hard drive space


You archive logged data to remove older records from the working SQL database and save that data for later review and analysis. By archiving logged data on a regular basis, you ensure the working database runs with optimum performance and you save valuable logged data for longer term review. Alternatively, if you would rather simply delete old logged data and not keep a copy, you purge the SQL database on a regular basis. See Chapter 17 Maintaining a Site and Network for detailed information about archiving, purging and backing up the SQL database. Trend and event logs can use a large amount of hard drive space. If too little drive space remains your computer will not work properly. Therefore its important to know how much drive space you have and how much drive space your Trend and Event logs require. Visual Integrator 3 keeps all of its data including the trend and event logs in two database files.

240

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To view the size of the Visual Integrator 3 database files: 1 Using Windows Explorer, find and open the following folder: C:\ Program Files \ Circon \ Data \ DB 2 Inside the DB folder there are two files. These two files make up the database. To see the combined size of the files, select both, right click and select Properties.

It is strongly recommended that you do not attempt to change either of these files in any way. This would cause Visual Integrator 3 to operate unpredictably.
To view the amount of free space on your hard drive: 1 Using Windows Explorer, select the C:\ drive. 2 Rightclick the C:\ drive and select Properties.

Document Number 800263 Revision 3.7

241

Chapter 10 Logging and Viewing Data

This page left blank intentionally.

242

Document Number 800263 Revision 3.7

Chapter 11 Logging and Viewing Alarms


larms are events of significant importance in the daytoday operation of a facility automation system. Typically alarms are meant to notify the operators and facility managers of unusual and often critically dangerous operation of a piece of equipment. Visual Integrator 3 provides a comprehensive set of capabilities for implementing and managing the retention of longterm historical alarms. Visual Integrator 3 records or logs alarms from Circon devices and SNVT_alarmcompatible devices from other manufacturers into its SQL database. This recorded data can be used for longterm historical retention and analysis. Typically an alarm is generated by the device controlling the equipment. It detects the anomalous condition and generates an alarm notification. Circons devices all contain multiple alarm generator functional blocks for this purpose. Circons programmable devices and Circons MAC300STA can act as alarm generators for devices from other manufacturers that do not generate alarms. In a Circon BASIC program, an alarm is generated using the alarm_send() and falarm_send()functions. Points on other manufacturers devices can be bound to and monitored by the MAC300STA which will generate an alarm when detected. Further, alarms generated by any device that reports the alarm using a network variable of LonMark standard network variable type SNVT_alarm can be logged using Visual Integrator 3. For local sites, Visual Integrator 3 can be configured to monitor devices and generate an alarm notification when any device it is monitoring stops functioning or goes offline. For remote sites, Circons SMC300 site management controller provides additional alarm generation capabilities: it generates an alarm notification when other devices it is monitoring on the network stop functioning or go offline, and it collects alarms and buffers them until a connection to Visual Integrator 3 can be established. Visual Integrator 3 includes many features for notifying operators about alarm conditions and viewing alarm information logged into the Visual Integrator 3 SQL database, including: Alarm Log Viewer Pagers Email Line printer Audible and visual alerts Alarm reports

Document Number 800263 Revision 3.7

243

Chapter 11 Logging and Viewing Alarms

Network connectivity options for alarming


Several architectural approaches are supported by Visual Integrator 3 to log alarms from devices on the network into the Visual Integrator 3 SQL database. These approaches encompass both local and remote site topologies. Recall from Chapter 2 that a local network is a network that is characterized by a topology that uses a persistent connection from Visual Integrator 3 to the site whereas a remote network is characterized by a topology that uses a temporary telephone network or WAN/Internet connection from Visual Integrator 3 to the site. In either case the site can be located in close proximity to the Visual Integrator 3 or at a distance. See Chapter 2 A Quick Tour for a detailed description of connectivity options. The following sections provide descriptions of the alternative architectural approaches supported by Visual Integrator 3 to log alarms from devices.

Local sites and persistent connections


The options for local sites using persistent connections are as many as the network interfaces available. Persistent connections can be used to connect to networks that are in the same location as the computer running Visual Integrator 3 or to connect to networks that are physically remote located anywhere in the world.
Local site using a PCLTA20, 21 or PCC10 network interface In this example the network interface is a PC card and driver software installed in the Visual

Integrator 3 computer. The LonWorks network is attached directly to the network interface PC card.

Local site using a PCLTA20, 21 or PCC10 or equivalent network interface; alarm logging with email

244

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Local site using an i.LON 10, i.LON 100 or equivalent network interface In this example the network interface is in the i.LON 10 or i.LON 100. The Visual Integrator 3

computer uses its Ethernet card and Remote Network Interface(RNI) software to communicate with the i.LON 10/100 over a LAN, WAN or the Internet.

Local site using an i.LON 10 or equivalent network interface; alarm logging with email

Document Number 800263 Revision 3.7

245

Chapter 11 Logging and Viewing Alarms

Local site using a PCLTA20, 21 or PCC10 network interface and SMC300 for paging Similar to an example above, the LonWorks network is attached directly to the network interface

PC card An SMC300 is added to the network. The SMC300 provides a rich set of features to support site monitoring and automatic dialout to pagers.

Local site using a PCLTA20, 21 or PCC10 or equivalent network interface; alarm logging with pagers and email

246

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Multiple sites using local site persistent connectiontype topology In the example below, the network interface can be either an i.LON 10, i.LON 100 or equivalent

device with an RNI interface. Visual Integrator 3 alarm logging services can sustain multiple persistent connections to i.LON10/100s up to a maximum number of sites determined by LNS performance limitations. Consult Circon technical support for assistance when considering this multisite topology. This same topology can also be used as a remote site topology with an increase in the total number of sites supported. Multiple sites using remote site topology are described later in this section.

Multiple local sites using an i.LON 10 or equivalent network interface; alarm logging with email

Remote sites and temporary connections


Visual Integrator 3 supports two options for alarm logging from remote sites using temporary connections. Temporary connections are used to connect periodically to networks that are physically remote from the computer running Visual Integrator 3. The network interfaces used with remote sites are:
modem and SMC300 network interface over public standard telephone network i.LON 10/100 or equivalent remote network interface over WAN or the Internet

Remote sites using SMC300 network interface In this example the network interface is in the Circon SMC300. The Visual Integrator 3

computer uses its COM port, the modem and the SLTALink Manager software to communicate with the builtin modem in the SMC300 over a public standard telephone network. The

Document Number 800263 Revision 3.7

247

Chapter 11 Logging and Viewing Alarms

LonWorks network is attached directly to the SMC300. In addition to its remote connection capability, the SMC300 provides a rich set of features to support site monitoring, alarm logging and automatic dialin to the Visual Integrator 3, making it an ideal choice for remote networks. Although the illustration below shows multiple sites, the same approach can be used for a single site.

Multiple remote site alarm logging with pagers and email

248

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Remote site using an i.LON 10, i.LON 100 or equivalent network interface In this example, the network interface is in the i.LON 10 or i.LON 100. The Visual Integrator 3

computer uses its Ethernet card and Remote Network Interface(RNI) software to communicate with the i.LON 10/100 over a WAN or the Internet. The SMC300 is a required component in this architecture to ensure reliable delivery of alarms to the Visual Integrator 3 computer. As well, the SMC300 provides additional alarming capabilities including site monitoring and alarm logging. Although the illustration below shows multiple sites, the same approach can be used for a single site.

Multiple remote site alarm logging with email

Document Number 800263 Revision 3.7

249

Chapter 11 Logging and Viewing Alarms

Setting up alarm logging


The following sections provide a stepbystep procedure for setting up alarm logging.

Main steps in setting up alarm logging


1 2 3 4 5 6 7 Select the alarm logging and notification architecture for the site; Configure the alarm generator functional blocks in the Circon devices you want to generate alarms; Configure alarm notification connections and alarm routing, depending on architecture selected; Set up Alarm Log Viewer and other operator notification features; Configure the site according to the alarm architecture selected; Enable device and network integrity monitoring where required; and For a local site, start the Circon Local Alarm Logger service; For a remote site over a telephone network, start the Circon Remote Alarm Logger application; or for a remote site over TCP/IP, start the Circon Remote Alarm Logger service.

Selecting the alarm logging architecture


The Network connectivity options for alarming section provides a description of the alternative architectural approaches supported by Visual Integrator 3 to log alarms from devices into the Visual Integrator 3 SQL database. After assessing the needs of the site and the personnel responsible for operations and maintenance, select one of these alternative approaches.
Using the SMC300 When using the SMC300 you must implement one of the three alarm logging scenarios defined below; no other scenario is supported as the LNS architecture dictates that only one LNS Server

shall be connected to a LonWorks network at any time. Using the SMC300 over PSTN with remote site alarm logging the SMC300 initiates a temporary dialin connection to a computer running Visual Integrator 3 and the LNS server via the telephone network; pagers are also reached by the SMC300 via the telephone network; or Using the SMC300 with local site alarm logging the SMC300 uses the persistent connection to a computer running Visual Integrator 3 and the LNS server via the LonWorks network; the SMC300 initiates dialup connections to one or more pagers via the telephone network; or Using the SMC300 and WAN or the Internet with remote site alarm logging the SMC 300 initiates a temporary TCP/IP connection via a remote network interface (eg. i.LON10/100) to a computer running Visual Integrator 3 and the LNS server via the WAN or the Internet;

250

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring the alarm generator functional blocks


Circon devices generate alarms based on the configuration of alarm generator functional blocks that reside in the device firmware. Use the alarm generator functional block plugin to configure the alarms. The plugin online help describes in detail how to configure alarms. When using a MAC300STA to generate alarms for devices that cant do so on their own, the points being monitored are bound to the MAC300STA and alarm generator functional blocks that reside in MAC300STA are used to generate alarms. LonWorks devices from other manufacturers that support the standard LonMark alarm network variable of type SNVT_alarm may also need to be configured. Consult the manufacturers documentation for this procedure. The procedure for generating alarms based on the Circon BASIC alarm_send(), and falarm_send() functions is described in the Circon BASIC Language Reference.

Configuring alarm notification connections and alarm routing


When an alarm condition is detected by an alarm generator functional block in a Circon device or by a Circon BASIC program, an alarm notification is generated and transmitted using a network variable of type UNVT_alarm. Other manufacturers devices may generate alarm notifications using a network variable of type SNVT_alarm. A network management tool such as Circons Network Integrator 3 or Echelons LonMaker must be used to connect these network variables to a destination. . The connections required depend on the alarm logging architecture you are using. The following sections describe the connections for each architectural option.
Local site alarm notification connections without SMC300 In an alarm logging architecture that is a local site without a SMC300, the alarm network variable from the Node Object functional block of each device is connected in a manytoone

fashion to a single input network variable in the LNS network interface. The LNS network interface resides on the same computer as the LNS server and Visual Integrator 3 reside. Circon devices which use a network variable of type UNVT_alarm and other manufacturers devices which use a network variable of type SNVT_alarm are connected to separate and distinct input network variables. The illustration below shows the two manytoone connections; the input network variable names shown are arbitrary; you can create any name that is meaningful when you create these input network variables on the LNS network interface.

Document Number 800263 Revision 3.7

251

Chapter 11 Logging and Viewing Alarms

LonMark Devices Node Object

Local Computer LNS Network Interface nviSNVTAlarm nviCirconAlarm

nvoAlarm

Node Object

nvoAlarmOut

Circon Devices

Local site alarm notification connections

Local site alarm notification connections with an SMC300 The SMC300 can be used in conjunction with local alarm logging to automate remote alarm

notification via pager and to implement device monitoring. The SMC300 captures, buffers, and prioritizes alarms from devices on a local LonWorks network and then routes the alarms over the local network to the local computer running Visual Integrator 3 and LNS server and to one or more pagers, based on configurable priority, alarm type and schedule. To allow alarm notifications to reach the local computer two sets of connections must be made: Manytoone network variable connections from the devices to the SMC300; and A single message tag connection from the SMC300 to the LNS network interface on the local computer.

Connections from the devices to the SMC300 local In order for the SMC300 to capture alarms generated by devices on the network, a network variable connection must exist from each device to the SMC300s Alarm Queue functional block.

The SMC300 provides two input network variables for this purpose: nviCirconAlarm for connections from Circon devices and nviSNVTAlarm for connections from devices using LonMark standard SNVT_alarm. Use a network management tool such as Circons Network Integrator 3, the Network Editor feature of Visual Integrator 3 or Echelons LonMaker to make these manytoone connections. The diagram below shows the two connections:

252

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

LonMark Devices Node Object

SMC-300 Alarm Queue nviSNVTAlarm nviCirconAlarm

nvoAlarm

Node Object

nvoAlarmOut

Circon Devices

Connections from devices to SMC300 local

Connections from the SMC300 to the local computer Alarms are delivered to Visual Integrator 3 using an alarm delivery protocol developed by Circon.

The alarm delivery protocol allows a network device to deliver an alarm reliably by using a stop andwait algorithm based on LonTalk requestresponse explicit messages. This approach allows the application software, in this case Visual Integrator 3, to acknowledge the alarm to the SMC 300 before the SMC300 considers the alarm to be delivered. If the SMC300 does not receive the acknowledge then it retains the alarm and tries again. To specify the connection from the SMC300 to a local computer a message tag bindings is used. The SMC300 supports a message tag for each of its Destination functional blocks. Choose the correct destination message tag named mtoAlarmDest_n and connect it to the msg_in message tag on the network interface. The diagram below shows the connection:
Network Interface SMC-300 Alarm Destination_n

msg_in

mtoAlarmDest_n

Connections from SMC300 to local computer

Remote site alarm notification connections with SMC300s and telephone network Remote alarm logging allows you to use an SMC300 in conjunction with Visual Integrator 3 to

automate remote site alarm monitoring over a public standard telephone network. The SMC300 captures, buffers, and prioritizes alarms from devices on a local LonWorks network and then

Document Number 800263 Revision 3.7

253

Chapter 11 Logging and Viewing Alarms

automatically dialsin and routes the alarms one or more remote computers running Visual Integrator 3 and the LNS server, based on configurable priority, alarm type and schedule. Alarms can also be routed to pagers. Once the temporary connection is established the SMC300 delivers alarms destined for that connection that it has collected from devices on the local network, and then disconnects from Visual Integrator 3. A single instance of a Visual Integrator 3 can be configured to accept dialin from multiple remote sites. To allow alarm notifications to reach the remote computer two main steps are required:
1 2 Make manytoone network variable connections from the devices to the SMC300; and Configure the Destination functional block for the remote computer.

Connections from the devices to the SMC300 In order for the SMC300 to capture alarms generated by devices on the network, a network

variable connection must exist from each device to the SMC300s Alarm Queue functional block. The SMC300 provides two input network variables for this purpose: nviCirconAlarm for connections from Circon devices and nviSNVTAlarm for connections from devices using LonMark standard SNVT_alarm. Use a network management tool such as Circons Network Integrator 3, the Network Editor feature of Visual Integrator 3 or Echelons LonMaker to make these manytoone connections. The diagram below shows the two connections:
LonMark Devices Node Object

SMC-300 Alarm Queue nviSNVTAlarm nviCirconAlarm

nvoAlarm

Node Object

nvoAlarmOut

Circon Devices

Connections from devices to SMC300 remote

Connecting from the SMC300 to the Visual Integrator 3 computer over telephone network Alarms are delivered to Visual Integrator 3 using an alarm delivery protocol developed by Circon, over the modem link. The alarm delivery protocol allows a network device to deliver an alarm

reliably by using a stopandwait algorithm based on LonTalk requestresponse explicit messages. This approach allows the application software, in this case Visual Integrator 3, to

254

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

acknowledge the alarm to the SMC300 before the SMC300 considers the alarm to be delivered. If the SMC300 does not receive the acknowledge then it retains the alarm and tries again. The connection and destination from the SMC300 to a computer running Visual Integrator 3 are specified when you configure the destination using the SMC300 Destination functional block plugin. Message tag or network variable bindings are not required.
Remote site alarm notification connections with SMC300s over TCP/IP network The SMC300 can be used in conjunction with remote alarm logging to automate remote alarm notification and to implement device monitoring. The SMC300 captures, buffers, and prioritizes

alarms from devices on a local LonWorks network and then routes the alarms by establishing a connection over the TCP/IP network to the computer running Visual Integrator 3 and LNS server based on configurable priority, alarm type and schedule. To allow alarm notifications to reach the remote computer two sets of connections must be made: Manytoone network variable connections from the devices to the SMC300; and A single message tag connection from the SMC300 to the LNS network interface on the remote network interface, typically an i.LON10/100.

Connections from the devices to the SMC300 local In order for the SMC300 to capture alarms generated by devices on the network, a network variable connection must exist from each device to the SMC300s Alarm Queue functional block.

The SMC300 provides two input network variables for this purpose: nviCirconAlarm for connections from Circon devices and nviSNVTAlarm for connections from devices using LonMark standard SNVT_alarm. Use a network management tool such as Circons Network Integrator 3, the Network Editor feature of Visual Integrator 3 or Echelons LonMaker to make these manytoone connections. The diagram below shows the two connections:
LonMark Devices Node Object

SMC-300 Alarm Queue nviSNVTAlarm nviCirconAlarm

nvoAlarm

Node Object

nvoAlarmOut

Circon Devices

Document Number 800263 Revision 3.7

255

Chapter 11 Logging and Viewing Alarms Connections from devices to SMC300 local

Connections from the SMC300 to the network interface Alarms are delivered to Visual Integrator 3 using an alarm delivery protocol developed by Circon.

The alarm delivery protocol allows a network device to deliver an alarm reliably by using a stop andwait algorithm based on LonTalk requestresponse explicit messages. This approach allows the application software, in this case Visual Integrator 3, to acknowledge the alarm to the SMC 300 before the SMC300 considers the alarm to be delivered. If the SMC300 does not receive the acknowledge then it retains the alarm and tries again. To specify the connection from the SMC300 to the network interface a message tag bindings is used. The SMC300 supports a message tag for each of its Destination functional blocks. Choose the correct destination message tag named mtoAlarmDest_n and connect it to the msg_in message tag on the network interface. Ensure the destination type is configured as Local, using the Alarm Destination functional block plugin. The diagram below shows the connection:
Network Interface SMC-300 Alarm Destination_n

msg_in

mtoAlarmDest_n

Connections from SMC300 to network interface (i.LON 10/100)

Setting up Alarm Log Viewer


Alarm Log Viewer allows operators to view in realtime, alarms received by Visual Integrator 3 and stored in its SQL database. Alarm Log Viewer has many properties that allow you to tailor the appearance of displayed alarms. See Viewing and managing alarms using Alarm Log Viewer later in this chapter for a description of the Alarm Log Viewer and its properties.

Configure the site according to the alarm architecture


Enabling alarm logging for a site with persistent connection Alarm logging can be enabled and disabled independently for each site when you are managing

multiple sites with Visual Integrator 3. Even if you are only managing a single site you must enable alarm logging for the site.

256

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To enable local alarm logging for a site: 1 From the toolbar, choose Site Management 2 Navigate to the site properties dialog and select the Logging tab (version 3.5 or earlier) or the Services tab (version 3.6 or later). 3 Select the Enable Alarm Logging check box, as shown below:

Version 3.5

Version 3.6 and later

IMPORTANT: when the site is a local network, the Local Alarm Log service must be started or restarted after enabling alarm logging for the site; when the site is a remote network connecting over TCP/IP, the Remote Alarm Log service must be started or restarted after enabling alarm logging for the site.

Configuring SLTALInk Manager software for remote site dialin When the alarm architecture is remote site alarm logging using an SMC300 to dialin to report

alarms, you must be using the SLTALink Manager software. The configuration of the SLTALink Manager software is described in Chapter 3 Working with Customers and Sites. To complete the configuration for the alarm dialin, an additional configuration step is required for the SLTALink Manager software in the Link Properties dialog, and the Monitor Line for Dialin dialog. The complete configuration procedure is described below some of which duplicates the procedure described in Chapter 3 Working with Customers and Sites. The modem must be connected and configured before you can configure SLTALink Manager. To configure the modem, first connect it to the PC, apply power and then use Settings/Control Panel/Phone and Modem Options from the Windows Start menu. IMPORTANT: If you plan to implement both remote data logging and remote alarm logging then you must configure the SLTALink Manager according to the procedure below rather than using the procedure in Chapter 2.

Document Number 800263 Revision 3.7

257

Chapter 11 Logging and Viewing Alarms To configure SLTALink Manager: 1 Start the SLTALink Manager from the Start menu as Programs > Echelon SLTA10 Network Adapter > SLTALink Manager. 2 From the Link menu choose New. In the Link Description dialog, enter an arbitrary unique name for this link, such as Remote Link. Click Remote to set the Link type. Enter a single question mark, as shown, in the Remote Identifier field. Do not check the Update identifier box. Click Next.

3 In the Dialing Address dialog, enter a single lowercase x character in the Telephone Number field. Uncheck Use Country Code and Area Code. In the Connect Using section, use the dropdown list to select the modem to be used for the remote link.

258

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 4 Click Configure Line to display the Connection Preferences dialog. Set the Call preferences as shown. Set Data Connection Preferences so that Port speed is 9600, Data Protocol and Compression are disabled; and Flow Control is set to Hardware. Click OK to return to the Dialing Address dialog and click Next.

5 In the Link Properties dialog, in the Startup Application section, enter the Command Line exactly as: C:\Program Files\Circon\BIN\SmcAlarm.exe %ID% %NSSNAME% %LINKNAME% (assuming that you installed Visual Integrator 3 in C:\Program Files\Circon). In Device Assignment, select LON2, or whatever numeric base value you specified during the SLTALink Manager installation. Leave all other settings blank or unchecked. Click Finish.

Document Number 800263 Revision 3.7

259

Chapter 11 Logging and Viewing Alarms 6 Choose Line > Monitor for SLTA dialin .In the Monitor Line for DialIn dialog, set the Device Assignment to match the Device Assignment setting mentioned above. Click Configure Line and configure the line to match the settings mentioned above. Click Monitor. The SLTALink Manager will now monitor for and respond to incoming calls.

IMPORTANT: You may minimize or hide the SLTALink Manager application, but it must be running in order for remote communications to work.
Enabling persistent connection to i.LON10/100 If you are using an i.LON 10 or i.LON 100 as the network interface at one or more sites and you want to log alarms using the local network, persistent connection approach, then you must enable

the services to maintain a persistent connection. The configuration option on the i.LON 10/100 tab of site properties labeled Circon services persist connection allows the Circon Alarm Logger, Local Data Logger, and Synchronization services to treat a site connected using an i.LON 10/100 as a persistent connection. The service opens the connection to i.LON 10/100 and holds the connection for as long as the service is running. This allows Visual Integrator 3 to do alarm/data logging when an iLON 10/100 is involved. Consult Circon technical support for advice on the limitations of this approach; LNS limits the number of connections to i.LON 10/100s.

260

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To enable persistent connection to i.LON10/100 for a site: 1 From the toolbar, choose Site Management 2 Navigate to the site properties dialog and select the i.LON 10/100 tab. 3 Select the Circon services persist connection check box, as below:

Disabling persistent connection to i.LON10/100 If you are using an i.LON 10 or i.LON 100 as the remote network interface at one or more sites

and you want to log alarms using the remote network, temporary connection approach, then you must disable the services to maintain a persistent connection. The configuration option on the i.LON 10/100 tab of site properties labeled Circon services persist connection is described in an earlier section. To allow alarm logging over a remote network, temporary connection this checkbox must be unchecked.
To disable persistent connection and enable temporary connection to i.LON10/100 for a site: 1 From the toolbar, choose Site Management 2 Navigate to the site properties dialog and select the i.LON 10/100 tab.

Document Number 800263 Revision 3.7

261

Chapter 11 Logging and Viewing Alarms 3 Clear the Circon services persist connection check box, as below:

Monitoring device and network integrity


Monitoring for device and network integrity involves periodic checking that devices are online and responding to status requests. By monitoring devices at the topologically far end of a network channel, the integrity of the network is also monitored. Visual Integrator 3 supports two approaches to monitoring for integrity: using the LNS server to monitor devices on a local network, and using a SMC300 to monitor devices on a local or remote network. Using the SMC300 is the recommended approach because of enhanced reliability and independence from the server computer. However, using the LNS server to perform the monitoring is also a viable approach when an SMC300 is not part of the site. This section describes how to use Visual Integrator 3 to configure the LNS server for monitoring. To learn how to configure a SMC300 for monitoring, refer to the online help documentation that accompanies its LNS plugin software. When the LNS server detects a device that does not respond to monitoring, an alarm notification is generated. When the device is detected as returning online, another alarm notification is generated. The properties of these two alarms are: Device not responding: Priority: major, Category: diagnostic, Code: 3 Device online: Priority: normal, Category: diagnostic, Code: 1

262

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To configure the LNS server to monitor devices on a local network: 1 Choose Tools>Network>Properties to display the networks properties dialog. 2 Select the Ping Intervals tab, as below:

3 Select one or more of the Enabled check boxes to select the ping interval ranges to be used for the network. Be aware that lower ping intervals may cause increased network ping traffic. Each named ping interval has a different ping interval range as shown below. Set the ping interval to a value greater or equal to the minimum ping interval. Permanent Stationary Temporary Mobile 4 Click OK to save and close. 5 Choose the _Subsystem Status document to display all the devices in the subsystem. 900 65534 seconds 300 65534 seconds 60 65534 seconds 30 65534 seconds

Document Number 800263 Revision 3.7

263

Chapter 11 Logging and Viewing Alarms 6 Select a device you want to monitor rightclick and choose Properties from the popup menu. Select the Advanced tab, as below:

Version 3.5

Version 3.6 and later

7 From the dropdown list labelled Ping Interval, select the name for the ping interval you want to use for this device (in version 3.6 and later, the time interval is displayed rather than the name of the interval). The device is checked for status approximately once per the interval you configured for this ping interval in the network properties Ping Intervals tab. 8 Repeat the previous two steps for each device you want to monitor for integrity. IMPORTANT: the Local Alarm Log or Remote Alarm Log service must be running in order for alarm notifications to reach the Visual Integrator 3 SQL database and Alarm Log Viewer.

Starting the Circon Local Alarm Log service


The Circon Local Alarm Log service is a Windows service that runs independently of any application and continues to run regardless if Visual Integrator 3 is running and if any operators are logged in. The Circon Local Alarm Log service continuously monitors the manytoone network variable connections from devices and the message tag connections from a SMC300 for new alarm notifications and records them in the Visual Integrator 3 SQL database alarm log. The Circon Local Alarm Log service must be running in order for alarms from a local site, persistent connection to reach the operator, to be sent by email or to be printed on the alarm printer. The Circon Local Alarm Log service is not used for remote sites. Skip this step if you are using remote site architecture.

264

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To start the Circon Local Alarm Log service: 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar, choose Circon Service Manager. The Circon Service Manager is displayed. 3 Select the box adjacent to Circon Local Synchronization service and Circon Local Alarm Log service to allow the Windows operating system to start these services automatically when it restarts. 4 Click on the text Circon Local Alarm Log to select it. 5 Click Start to start the service now. Wait until the Status for both Circon Local Synchronization service and Circon Local Alarm Log service change to Started.

6 Close the Circon Service Manager dialog. 7 You can verify that the services have started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility.

Starting the Circon Remote Alarm Log service


The Circon Remote Alarm Log service is a Windows service that runs independently of any application and continues to run regardless if Visual Integrator 3 is running and if any operators are logged in. The Circon Remote Alarm Log service waits for connections from remote temporary sites over TCP/IP using the i.LON 10/100 RNI and a SMC300, for new alarm notifications and records them in the Visual Integrator 3 SQL database alarm log. The Circon Remote Alarm Log service must be running in order for alarms from a remote site, temporary connection to reach the operator, to be sent by email or to be printed on the alarm printer. The Circon Remote Alarm Log service is not used for local sites. Skip this step if you are using local site architecture.
To start the Circon Remote Alarm Log service: 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar, choose Circon Service Manager. The Circon Service Manager is displayed. 3 Select the box adjacent to Circon Local Synchronization service and Circon Remote Alarm Log service to allow the Windows operating system to start these services automatically when it restarts. 4 Click on the text Circon Remote Alarm Log to select it.

Document Number 800263 Revision 3.7

265

Chapter 11 Logging and Viewing Alarms 5 Click Start to start the service now. Wait until the Status for both Circon Local Synchronization service and Circon Remote Alarm Log service change to Started.

6 Close the Circon Service Manager dialog. 7 You can verify that the services have started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility.

Viewing and managing alarms using Alarm Log Viewer


Alarm Log Viewer allows operators to view in realtime, alarms received by Visual Integrator 3 and stored in its SQL database. Operators with alarm management permission can also to acknowledge and clear alarms. Alarm Log Viewer displays alarms in a dedicated pane that can be hidden when not needed. Alarm Log Viewer has many properties that allow you to tailor the appearance of displayed alarms. All alarms received by Visual Integrator 3 are stored in the SQL database. Alarm Log Viewer provides the capability to view all or portions of these alarms. Alarms are not deleted when they are acknowledged or cleared although they may disappear from the Alarm Log Viewer if so configured. Alarms can be deleted from the SQL database according to the purge settings described later in this chapter.

Viewing alarms with Alarm Log Viewer


To view alarms with Alarm Log Viewer: 1 Choose View > Alarms 2 The Alarm Log Viewer pane is displayed:

266

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Alarm Log Viewer

The columns display information about the alarm, including the payload information from the alarm network variable: Timestamp date and time the alarm was generated by device. This is not the time the alarm was received by Visual Integrator 3. Site site where alarm the alarm was generated. Site is not included in the payload information from the alarm network variable but is added by Visual Integrator 3 State current state of the alarm as determined by Visual Integrator 3. State is not included in the payload information from the alarm network variable but is managed by Visual Integrator 3 as follows: New an alarm that has not yet come to an operators attention. Acknowledged the alarm has come to an operators attention and is currently being addressed. Cleared the alarm is no longer considered an alarm condition to the operator. By clearing an alarm the operator is indicating that the alarm has been acknowledged and the alarm condition has been rectified. Ideally it is the time when the monitored point has returned to normal operating limits. Operators may however, clear alarms regardless

Document Number 800263 Revision 3.7

267

Chapter 11 Logging and Viewing Alarms

of the state of the monitored variable. This allows operators to clear alarms when their repetition could become meaningless. Priority priority of alarm as set by the device. If the alarm is generated by a Circon device then the priority can be one of: Major, Minor, Warning, Normal, or Advisory. These are arbitrary priorities which are configured using the alarm generator functional block. If the alarm is generated by a LonMark device using SNVT_alarm then the LonMark priority is converted to an equivalent Circon priority according to the table below:
LonMark priority value and identifier
0 1 2 3 4 5 6 7 8 9 10 11 PR_LEVEL_0 PR_LEVEL_1 PR_LEVEL_2 PR_LEVEL_3 PR_1 PR_2 PR_3 PR_4 PR_6 PR_8 PR_10 PR_16

Equivalent Circon priority identifier


Normal Warning Minor Major Major Major Major Major Major Major Major Major

Category the category of the alarm code. Category is not included in the payload information from the alarm network variable but is determined by Visual Integrator 3. Code code as set by the device. If the alarm is generated by a Circon device the alarm code is configured using the alarm generator functional block. Device device that generated the alarm. Functional Block If the alarm is generated by a Circon device, alarm generator functional block that generated the alarm. Description descriptive text associated with the alarm code. Description is not included in the payload information from the alarm network variable but is determined by Visual Integrator 3.

268

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To view alarm details: Double click on a specific alarm. The alarm properties dialog is displayed:

Document Number 800263 Revision 3.7

269

Chapter 11 Logging and Viewing Alarms

Configuring Alarm Log Viewer properties


You can select which alarms are displayed and the color and order they are displayed by configuring the Alarm Log Viewer sorting, filtering and colors properties.
To configure Alarm Log Viewer properties: 1 Choose View > Filter Alarms 2 The Alarm Log properties dialog is displayed:

3 Select the Filter tab to set the criteria for the alarms you want to have displayed:

Time specifies alarms with a timestamp in the time interval range specified State specifies alarms with the states checked. The setting shown above causes alarms to disappear from the view when they are cleared. Priority specifies alarms with the priorities checked. Category select a category of alarms or all categories you want to view. Code select an alarm code or all codes you want to view. Description To view only those alarms with a specific text fragment in their description, type that text fragment in the Description box and use the wildcard character % to indicate that it is a fragment. For example, to display only alarms with the word "temperature" in the description, type %temperature% in the description box. The SQL LIKE clause is used when filtering on descriptions; you may want to investigate this clause to understand its other wildcard capabilities. Customer specify a single customer or all customers you want to view Site specify alarms from a single site or all sites for those sites for specified customer.

270

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 4 Select the Sort tab to set the order in which the alarms are displayed. You can sort alarms by four criteria from: Timestamp, Site, State, Priority, Category, Code, Device, Functional Block, and Description, ascending and descending.

5 Select the Color tab to set the color in which the alarms are displayed. Color provides an easy way to find important alarms in a list. To change the setting, select the priority and state then click Colors.

Document Number 800263 Revision 3.7

271

Chapter 11 Logging and Viewing Alarms You can select the color of the text and the background color of the alarm as it will be displayed in Alarm Log Viewer. A typical color setting is shown below:

Acknowledging and clearing alarms


To allow operators and facility managers to implement a procedure for managing alarms, Visual Integrator 3 tracks alarms it receives through three states: new, acknowledged and cleared. Visual Integrator 3 provides a mechanism to allow an operator to acknowledge and clear alarms, and it records those actions in the Visual Integrator 3 audit log. These actions do not affect the device originating the alarm but rather update the alarm state in the Visual Integrator 3 SQL database. Typically, the three states are defined as: New an alarm that has not yet come to an operators attention. Acknowledged the alarm has come to an operators attention and is currently being addressed. Cleared the alarm is no longer considered an alarm condition to the operator. By clearing an alarm the operator is indicating that the alarm has been acknowledged and the alarm condition has been rectified. Ideally it is the time when the monitored point has returned to normal operating limits. Operators may however, clear alarms regardless of the state of the monitored variable. This allows operators to clear alarms when their repetition could become meaningless.

272

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To acknowledge a new alarm: 1 With Alarm Log Viewer open, right click a new alarm from the alarm list and select Acknowledge from the popup menu. 2 The Acknowledge Alarm comment dialog is displayed:

3 Type comments pertaining to the alarm for the acknowledge action then click OK to save the comment and complete the acknowledgement of the alarm. A comment cant be changed. However, when you clear the alarm, there is a further opportunity to enter a comment. If you click Cancel, no acknowledge comment is saved but the acknowledgement of the alarm is completed. Operators who are members of an operator group for which mandatory comments are required, are forced to type a comment. 4 The alarm display changes to the color property for an acknowledged alarm of that priority. If you have configured the filter property to not display acknowledged alarms then the alarm disappears from the list. To acknowledge all new alarms: 1 Right click any new alarm from the alarm list and select Acknowledge All from the popup menu. 2 The Acknowledge Alarm comment dialog is displayed as shown above. 3 Type comments pertaining to all the alarms for the acknowledge action then click OK to save the comment and complete the acknowledgement of all alarm. A comment cant be changed. However, when you clear the alarm, there is a further opportunity to enter a comment. If you click Cancel, no acknowledge comment is saved but the acknowledgement of all alarms is completed. Operators who are members of an operator group for which mandatory comments are required, are forced to type a comment. 4 The alarm display for all new alarms change to the color property for an acknowledged alarm of that priority. If you have configured the filter property to not display acknowledged alarms then all the acknowledged alarms disappear from the list.

Document Number 800263 Revision 3.7

273

Chapter 11 Logging and Viewing Alarms To clear an acknowledged alarm: 1 With Alarm Log Viewer open, right click an acknowledged alarm from the alarm list and select Clear from the popup menu. 2 The Clear Alarm comment dialog is displayed:

3 Type comments pertaining to the alarm for the clear action then click OK to save the comment and complete the clearing of the alarm. A comment cant be changed. If you click Cancel, no clear comment is saved but the clearing of the alarm is completed. Operators who are members of an operator group for which mandatory comments are required, are forced to type a comment. 4 The alarm display changes to the color property for a cleared alarm of that priority. If you have configured the filter property to not display cleared alarms then the alarm disappears from the list. To clear all acknowledged alarms: 1 With Alarm Log Viewer open, rightclick any acknowledged alarm from the alarm list and select Clear All from the popup menu. 2 The Clear Alarm comment dialog is displayed as shown above. 3 Type comments pertaining to all the alarms for the clear action then click OK to save the comment and complete the clearing of all alarm. A comment cant be changed. If you click Cancel, no clear comment is saved but the clearing of all alarms is completed. Operators who are members of an operator group for which mandatory comments are required, are forced to type a comment. 4 The alarm display for all acknowledged alarms change to the color property for a cleared alarm of that priority. If you have configured the filter property to not display cleared alarms then all the cleared alarms disappear from the list.

274

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To view the acknowledge and clear comments: 1 With Alarm Log Viewer open, double click any acknowledged or cleared alarm. The alarm properties dialog is displayed:

2 The Acknowledged tab displays the acknowledge information and comment; the Cleared tab displays the clear information and comment. The Acknowledged and Cleared tab are present only of that operation has been completed. To view the record of operator actions: 1 From the tool bar, choose Site Management 2 Open the System Logs folder 3 Select Audit Log. Information about each acknowledged and cleared alarm is displayed in the right pane.

Alternatively, you can generate an activity report which can be filtered and sorted. See Chapter 13 Using Reports for a description of the activity report.

Configuring mandatory comments when managing alarms


When operators acknowledge or clear an alarm, they have the opportunity to type a comment pertaining to their actions or the alarm. By default, typing a comment is optional; no comment is required or enforced by Visual Integrator 3. To ensure operators type a comment, the operator group properties are configured for the specific alarm codes that require mandatory comments by members of the operator group.
To make acknowledge and clear comments mandatory 1 From the toolbar, choose Site Management 2 Open the Operator Groups folder and rightclick to add a new operator group, or open an existing group.

Document Number 800263 Revision 3.7

275

Chapter 11 Logging and Viewing Alarms 3 Double click on the operator group and select the Alarm Acknowledgement tab. 4 In the lower pane, select the alarms you want this operator group to type mandatory comments for. Use Windows standard selection methods to quickly select multiple alarms: to select several contiguous alarms, hold down Shift and select the first and last in the group. to select several nonadjacent alarms, hold down Ctrl and select the individual alarms.

5 When you have selected all the alarms, click Add. The alarms appear in the top pane of the dialog. All members of this group are forced to type a comment when acknowledging and clearing any of these alarms. 6 Select the Operators tab and add the operators to the operator group.

Viewing alarms using the CirconAlarm object


Using one or more CirconAlarm objects on a document allows operators to view in realtime, alarms received by Visual Integrator 3 from specific devices. The CirconAlarm object is added to a document using Graphics Editor and its properties set to the device that is the source of the alarms. See Chapter 6 Control Object Reference for a description of the properties for CirconAlarm object.

Alerting the operator with Alarm Notifier


Alarm Notifier provides audible and visual indicators to alert the operator when a new alarm has been received. Use sound to alert an operator who is away from the computer but within hearing range, or who is using another application on the computer or has minimized the Visual Integrator 3 application. The sound is replayed periodically until the alarm is acknowledged. A unique sound can be assigned to important alarm codes and you can create your own sound bites

276

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

and have them played. If there is more than one unacknowledged alarm then the sound associated with each alarm is played in sequence. Similarly, a popup notification bubble can be used to alert an operator who is using another application on the computer or has minimized the Visual Integrator 3 application. The popup appears once, when the new alarm is received by Visual Integrator 3, for approximately 5 seconds. An example is shown below:

Alarm Notifier must be running in order for the sound and popup alerts to occur. Alarm Notifier is an application not a service. To start Alarm Notifier automatically when you log in to Windows, it is recommended to include a shortcut to Alarm Notifier in the Windows startup folder (C:\Documents and Settings\User name\Start Menu\Programs\Startup). This ensures that Alarm Notifier is launched whenever that user logs in to Windows. To create the shortcut, locate Alarm Notifier in C:\Program Files\Circon\BIN\AlarmNotify.exe, rightclick on it and select Create Shortcut. Then move the shortcut to the users startup folder.
To configure Alarm Notifier 1 From the Windows Start button choose Programs > Circon > Visual Integrator > Alarm Notifier. Alarm Notifier is launched and a red exclamation mark icon is displayed in the computers system tray. 2 Rightclick the Alarm Notifier red exclamation mark to display the Alarm Notify Options dialog:

3 Check Popup Notification to specify that a popup be displayed when a new alarm is received. 4 Set the time interval in seconds to specify how often the Alarm Notifier checks for new alarms and plays the sounds for existing new alarms. It is recommended that you set a time interval of greater than 15 seconds to allow for the case when multiple alarms need to be annunciated. 5 Click OK when complete.

Document Number 800263 Revision 3.7

277

Chapter 11 Logging and Viewing Alarms To associate a sound with an alarm code 1 From the toolbar choose Site Management 2 Open the Alarm Codes folder

3 Double click on the alarm with which you want to associate a sound, to open the alarm code property dialog. 4 Select the General tab and click Browse. Navigate to the location of a .wav file and select it. The full path of the file is shown in the Play sound field:

IMPORTANT: Alarm Notifier plays a sound for every unacknowledged alarm even if you have not specified a particular .wav file for all alarm codes. The sound played for alarm codes that do not have a specified .wav file is the Windows Default Beep (ding.wav). Refer to Windows Settings>Control Panel>Sounds and Multimedia Properties to view the selection of .wav files on your computer. 5 Click OK when complete.

278

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To configure the text displayed in the popup notification

The text displayed in the popup consists of two lines as shown in the example below:

The first line indicates the source of the alarm including subsystem, device and functional block; this text cant be modified. The second line displays the alarm translation text which you can customize uniquely for each alarm code as required. To learn how to customize alarm translation text, see Customizing alarm translations later in this chapter.

Using email to send alarm messages


Visual Integrator 3 includes a flexible, configurable mechanism for using email to send alarm messages. The email message subject and message body contain the alarm description and the point data at the time of alarm. The email recipient and the alarm description are configurable for each alarm.
Prerequisite for using email Email notification depends on access to and use of an industrystandard always available mail server that conforms to industrystandard Simple Mail Transport Protocol (SMTP RFC 2821).

This server can be on the same computer as Visual Integrator 3 but is typically on a dedicated email server reachable over the facility TCP/IP backbone or over the Internet to an ISP. Visual Integrator 3 requires access to the email server through a single email account. The following sections provide a stepbystep procedure for setting up email.

Main steps in setting up email for alarms


The configuration steps outlined below are described in detail in the following sections.
1 2 Identify the email recipients and type an email address into their Visual Integrator 3 operator properties. Each recipient can have two email addresses. Create an operator group for email recipients and configure which alarms the members of the group will receive by email. Add the email recipients to the group. Create as many groups as required based on the set of alarms you want the members of the group to receive. You should create at least one group for email recipients or you can use an existing group in a simple situation. Assign the operator groups to the site from which the alarms are generated. Configure the Circon Email Service properties with information about the SMTP mail server. Start the Circon Email Service Send a test email

3 4 5 6

Document Number 800263 Revision 3.7

279

Chapter 11 Logging and Viewing Alarms

Step 1 Adding an operators email address


To add an email address to the operator properties 1 From the toolbar choose Site Management. 2 Open the Operators folder and double click on the operator whose email address you want to add. 3 Select the Notifications tab and type one or two email addresses in the form x@y. If two addresses are entered, all alarms are sent to both addresses.

Note: the reminder feature shown on this dialog is not implemented.


Step 2 Creating an operator group and configuring the alarms its members receive
To create an operator group and configure which alarms its members receive 1 From the toolbar, choose Site Management 2 Open the Operator Groups folder and rightclick to add a new operator group or open an existing group. 3 Double click on the operator group and select the Alarm Notifications tab.

280

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 4 In the lower pane, select the alarms you want this operator group to receive by email. Use Windows standard selection methods to quickly select multiple alarms: to select several contiguous alarms, hold down Shift and select the first and last in the group. to select several nonadjacent alarms, hold down Ctrl and select the individual alarms.

5 When you have selected all the alarms, click Add. The alarms appear in the top pane of the dialog. All members of this group receive email notification when any of these alarms occur. 6 Select the Operators tab and add the operators who are the email recipients, to the operator group.

Step 3 Assign the operator group to the site


To assign the operator group to the site 1 From the toolbar, choose Site Management 2 Open the Customers folder and then the Site. 3 Double click on the site to open the site properties and select the Permissions tab. 4 Add the operator group to receive the email to the site. None of the permissions need to be checked.

Document Number 800263 Revision 3.7

281

Chapter 11 Logging and Viewing Alarms

Step 4 Configuring the Circon Email Service properties


To configure the Circon Email Service properties: 1 From the toolbar, choose Site Management 2 Open the Services folder and double click on Email Service. The Circon Email Service properties are displayed.

3 Complete each mandatory field as described below. You may need to consult with IT personnel familiar with the email server for some of the required information.

SMTP Server The hostname of the SMTP server used to send email in TCP/IP format. Eg. D1.circon.com SMTP Port The port number of the SMTP server used to send email; the standard SMTP port is 25. Do not change this unless instructed to by IT personnel. Sender (xxx@yyy.com) sender information that will appear in the From field of the email message header. This must be entered in the format shown.
4 If your SMTP server requires login authentication then check the SMTP server requires authentication checkbox and complete the additional fields as described below:

SMTP Authentication select the desired method of authentication that matches the requirements of the SMTP server, from the following options: Automatic allows the most secure method supported by the SMTP server to be selected by the Visual Integrator 3 email software. Automatic is the recommended setting for this property. Visual Integrator 3 email software will by default choose the most secure login method available to prevent unencrypted username and passwords from being transmitted if possible. However, some SMTP servers may not advertise the authorization methods it accepts to some or all clients, and therefore Visual Integrator 3 email software cant determine which authorization method to use.

282

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

To force a particular method to be used or to prevent any authorization from being used select one of the other methods listed below. LOGIN PLAIN CRAMMD5 NTLM Windows NT LAN Manager challenge/response SMTP User Login the login for logging into the SMTP server. SMTP Password the password for logging into the SMTP server. NTLM Login Domain the Windows domain for logging into the SMTP server. Use this only if your SMTP server requires NTLM authentication, which means your SMTP server uses Integrated Windows Authentication. If there is no domain, this can be left empty.
5 Set the scan interval in seconds used by the Circon Email service to check for new alarms to report via email. 6 Check the Generate Email from Alarms checkbox to enable the sending of email. 7 If you want to log email activity to the local hard disk, select the Logging tab to configure the logging options:

8 Check the Log Sent Email to a file checkbox to enable the logging of every email message sent, to a text file. Configure the location and name of the log file. Logging is meant to be used as a diagnostic aid rather than permanently logging sent email. The log file will continue to get larger until manually deleted. A example of the contents of the log file is shown below: --BEGIN SENT CHILKAT EMAIL-MIME-Version: 1.0 Date: Thu, 24 Jul 2003 20:30:38 -0700 X-Mailer: Chilkat Software Inc (http://www.chilkatsoft.com) X-Priority: 3 (Normal) From: alarms@circon.com

Document Number 800263 Revision 3.7

283

Chapter 11 Logging and Viewing Alarms Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Subject: Test To: tas2@circon.com Message-ID: <CHILKAT-MID-4dc5a82a-8b67-4497-8541-c1d6d2fa172b@tas> --END SENT CHILKAT EMAIL--

Check the Log Errors to a folder checkbox to enable the logging of errors encountered while attempting to send email, to a folder. Configure the location and name of the log folder. Each error is logged in a separate text file using the date and time as the file name, Eg. 200306 19+18#05#57#0109.xml.
9 The log folder will continue to get larger until error files are manually deleted. The contents of the file are in XML: <?xml version="1.0" encoding="utf-8" standalone="yes" ?> - <ChilkatLog> - <VerifySmtpLogin> - <SMTP_Connect> <info>Connecting to SMTP server a3.circon.com:25</info> <smtp_host>a3.circon.com</smtp_host> <smtp_port>25</smtp_port> <smtp_user /> <trying_auth_method>NONE</trying_auth_method> <error>socket is not ready for writing</error> <error>WSAEWOULDBLOCK The socket would block.</error> <error>Unknown socket error</error> <socketErrorNum>0</socketErrorNum> <socketError>00 00 00 00</socketError> <error>Connect function failed.</error> <error>Failed to connect (1)</error> </SMTP_Connect> <error>Failed to connect to SMTP server.</error> </VerifySmtpLogin> <SaveXmlLog /> </ChilkatLog> 10 Click OK to save the properties. IMPORTANT: the Circon Email Notification service must be stopped and restarted for changes to properties to take effect.

Step 5 Starting the Circon Email Notification service The email notification service must be started in order for alarm notifications to be emailed.
To start the Circon Email Notification service: 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar choose Circon Service Manager. The Circon Service Manager is displayed:

284

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Check the box adjacent to Circon Email Notification service to allow the Windows operating system to start this service automatically when it restarts. 4 Click on the text Circon Email Notification to select it. 5 Click Start to start the service now. Wait until the Status for the service changes to Started.

IMPORTANT: the Circon Email Notification service, if already running, must be stopped and restarted for changes to properties to take effect. 6 Close the Circon Service Manager dialog. 7 You can verify that the service has started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility.

Step 6 Sending a test email Using the procedure in this step you can create and send a test email message using the same Visual Integrator 3 email software used to send alarm notifications. If the test message is received

by the intended recipient then it confirms the email configuration. If the Visual Integrator 3 email software is unable to send the message, a diagnostic error message is provided to assist in troubleshooting the problem.
To send a test email message: 1 From the toolbar choose Site Management 2 Open the Services folder, right click on Email Service and choose Send Test Email from the popup menu. The Send Test Email dialog is displayed. Enter the appropriate address, subject and message as shown in the example below:

Document Number 800263 Revision 3.7

285

Chapter 11 Logging and Viewing Alarms 3 Click Send to cause Visual Integrator 3 email software to attempt to send the message. If the message is sent successfully, the following confirmation is displayed. You should also check with the recipient that the message was indeed received.

If the message cant be sent, a diagnostic error message is provided:

Logging alarms to a line printer


As another alternative to alert operators about new alarms or to provide an immediate indelible record of new alarms, a line printer can be used to print new incoming alarms. Visual Integrator 3 can be configured to print to any windowssupported networked or local printer that allows line byline printing. Because this capability is implemented as a Windows service, alarms are printed even when Visual Integrator 3 is not running. IMPORTANT: The Alarm Print service only prints each new alarm once when it is first received by Visual Integrator 3.

Main steps in setting up a line printer to log alarms


The configuration steps outlined below are described in detail in the following sections.
1 2 3 Install the line printer. Configure the Circon Alarm Print service properties with information about the printer. Start the Circon Alarm Print service.

Step 1 Installing the line printer The printer is installed using Windowsstandard printer installation procedure. Use the Add

Printer utility found at Start > Settings > Printers. You may need to consult with IT personnel familiar with printer installation for some of the required information.

286

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Step 2 Configuring the Circon Alarm Print service properties


To configure the Circon Alarm Print service properties 1 From the toolbar choose Site Management 2 Open the Services folder and double click on Alarm Print service. The Circon Alarm Print service properties are displayed.

3 Complete each field as described below.

Print incoming alarms check this checkbox to enable the printing of alarms Scan print queue every set the scan interval in seconds at which the service checks for new alarms to print. Print alarms using printer select the printer from the dropdown list. If the printer you want to use does not appear on this list then its installation has not been completed.
IMPORTANT: the Circon Alarm Printer service, if already running, must be stopped and restarted for changes to properties to take effect.

Document Number 800263 Revision 3.7

287

Chapter 11 Logging and Viewing Alarms

Step 3 Starting the Circon Alarm Printer service


To start the Circon Alarm Printer service: 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar choose Circon Service Manager. The Circon Service Manager is displayed:

3 Check the box adjacent to Circon Alarm Printer service to allow the Windows operating system to start this service automatically when it restarts. 4 Click on the text Circon Alarm Printer to select it. 5 Click Start to start the service now. Wait until the Status for the service changes to Started.

6 Close the Circon Service Manager dialog. 7 You can verify that the service has started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility.

Customizing builtin alarm translations


When a device detects an alarm condition it generates an alarm notification and transmits that notification using a network variable. Visual Integrator 3 supports alarm notifications in network variables of type UNVT_alarm as generated by Circon devices or in network variables of type LonMark standard SNVT_alarm generated by devices from other manufacturers. These two network variable types are similar; both contain an information payload consisting of: Alarm code a unique code assigned to this alarm. Builtin alarms are assigned codes in the range 0 to 511. Only Circon can define new builtin alarms. Operatordefined alarms are assigned codes in the range 512 to 1023. The alarm code is assigned a unique translation text message.

288

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Functional block identifier specifies the functional block within the device that generated the alarm notification. This is the object index of the functional block within the device; it is not the object type. Monitored value the value that was found to exceed the alarm limit, thereby triggering the alarm. In some situations alarms are generated for other reasons than a simple alarm limit comparison. In these cases, monitored value may be used to carry some other applicationspecific data value. Alarm limit value the value that was exceeded by the monitored value, thereby triggering the alarm. In some situations alarms are generated for other reasons than a simple alarm limit comparison. In these cases, alarm limit may be used to carry some other applicationspecific data value. Data type of value and limit specifies the network variable type of the data contained in the monitored value and alarm limit fields Visual Integrator 3 uses the alarm code to translate the alarm into a meaningful and descriptive message that is displayed in Alarm Log Viewer, included in the message sent by email, printed on the alarm log printer and displayed in the Alarm Notifier popup bubble. This message typically contains the monitored and alarm limit values as well. Visual Integrator 3 includes a wide range of builtin alarm translations for both Circon and LonMark alarm codes that you can use effectively as is or you can customize these translations into messages that are tailored to meet the requirements of a particular site or the operator. You can also create new alarm translations when the alarm code does not exist as a builtin alarm, for example when generated by a Circon BASIC program. See Creating alarm codes later in this chapter to learn how to create new alarm codes and their translations. If you decide to customize an alarm translation, you further have to decide whether this customization applies globally to all sites from which Visual Integrator 3 may receive alarms or locally to one specific site only. The procedures for customizing global and local alarm translations are described below.

Customizing global alarm translations


Customized global alarm translations apply to alarms received from all sites. If you want the customization to apply to a specific individual site then use the procedure for customizing local alarm translations described later in this section.
To customize the global translation for an alarm code 1 From the toolbar choose Site Management 2 Open the Alarm Codes folder to view the current alarm translations. This list of alarms is the same list that is displayed by the Alarm Generator functional block plugin when you are configuring the alarming in a Circon device. A blue exclamation mark denotes a builtin alarm translation. A red exclamation mark denotes an operatordefined alarm translation. 3 Double click on the alarm that you want to customize. The properties dialog for that alarm is displayed.

Document Number 800263 Revision 3.7

289

Chapter 11 Logging and Viewing Alarms 4 Select the Global Translation tab. The text of the message is displayed. The location in the message where the network variable payload information will be displayed is indicated by the identifiers: %o name of functional block %v monitored value %l alarm limit value When Visual Integrator 3 translates the alarm into the meaningful and descriptive message for human interpretation, functional block identifier is translated to the name of the functional block, and monitored value and alarm limit value are translated according to the data type contained in the network variable payload information.

5 To customize the translation while retaining the data values interpretation according to the data type contained in the payload information, make your changes in the box labelled Text. The identifiers can be in any position or order in the text or they can be removed. 6 Decide whether you want the units of measure for the monitored and limit values displayed with the data and check or uncheck the Show Value Units and Show Limit Units checkboxes accordingly. 7 Leave the box labelled Arguments empty. Do not click Add Data Type >>. This area of the properties pertains to advanced translation construction that requires detailed knowledge of the alarm network variable data structure. 8 If you want to revert to the original translation, click Reset. IMPORTANT: when the site is a local network, the Local Alarm Log service must be stopped and restarted for customizations to take effect.

290

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Customizing local alarm translations


As an alternative to customizing an alarm globally for every site managed by Visual Integrator 3 you can customize a local translation for a specific site. The local translation only applies to the site to which Visual Integrator 3 is connected when customization is made. Visual Integrator 3 remembers and selects the correct local translations for each site. If you want the customization to apply to all sites then use the procedure for customizing global alarm translations described earlier in this section.
To customize the local translation for an alarm code Connect to the specific site to which you want the local customization to apply. 1 Choose Tools > Network > Local Translations The Translations dialog is displayed. Initially a site has no local translations therefore the list displayed by this dialog is empty:

2 Rightclick in the blank area of the Translations dialog and select New Translation from the popup menu to display the New Translation dialog.

3 From the dropdown list select the alarm code that you want to customize for this site then click OK. The alarm is displayed in the Translations dialog:

Document Number 800263 Revision 3.7

291

Chapter 11 Logging and Viewing Alarms 4 Double click on the alarm name to display the properties. Select the Local Translation tab. The text of the message is blank. Enter the custom message for this alarm. The location in the message where the network variable payload information will be displayed as indicated by the identifiers: %o name of functional block %v monitored value %l alarm limit value When Visual Integrator 3 translates the alarm into the meaningful and descriptive message for human interpretation, functional block identifier is translated to the name of the functional block, and monitored value and alarm limit value are translated according to the data type contained in the network variable payload information.

5 Leave the box labelled Arguments empty. Do not click Add Data Type >>. This area of the properties pertains to advanced translation construction that requires detailed knowledge of the alarm network variable data structure. 6 Click OK to save and close. IMPORTANT: when the site is a local network, the Local Alarm Log service must be stopped and restarted for customizations to take effect.

292

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Creating alarm codes


You can create new alarm codes for alarms generated by Circon devices when the alarm code does not exist as a builtin alarm, for example when the alarm is generated by a Circon BASIC program. New alarms for LonMark standard devices cant be created.
To add an alarm code 1 From the toolbar choose Site Management 2 Open the Alarm Codes folder to view the current alarm translations. A blue exclamation mark icon denotes a builtin alarm translation. A red exclamation mark icon denotes an operatordefined or created alarm translation. 3 Rightclick in the white space in the right pane and choose New Alarm Code from the popup menu. The New Alarm Code dialog is displayed.

4 Enter a meaningful name in the Name field. 5 Select a category from the Category dropdown list. Category LonMark is not available as alarm codes in that category are assigned only by LonMark. 6 Select the alarm code in the range 512 to 1023 and click OK. The new alarm appears in the list with a red icon. 7 Follow the procedure described in Customizing global alarm translations and Customizing local alarm translations earlier in this chapter to configure how Visual Integrator 3 should translate the new alarm code for the operator. IMPORTANT: when the site is a local network, the Local Alarm Log service must be stopped and restarted for new alarm codes to take effect.

Using alarm reports


The two reports most useful when managing alarms are the activities report, which contains the information recorded in the audit log including the acknowledge and clear alarms activities and identifies the operator who performed the task, and the alarms report which lists all the alarms that occurred based on filter criteria you can set.
To generate a report: 1 From the toolbar choose Site Management 2 Open the Reports folder; the six reports are displayed. 3 Open a report by double clicking; for some reports a filter dialog is displayed, for others the report is generated directly.

Document Number 800263 Revision 3.7

293

Chapter 11 Logging and Viewing Alarms 4 If a filter dialog is displayed, select the filter options then click OK to generate the report. 5 After the report is generated you can choose to print the report or to export the data as a comma separatedvalue file.

For more information about using the report filters, See Chapter 13 Using Reports.

Archiving alarms and managing hard drive space


You archive logged alarms to remove older records from the working SQL database and save that data for later review and analysis. By archiving alarms on a regular basis, you ensure the working database runs with optimum performance and you save valuable alarms for longer term review. Alternatively, if you would rather simply delete old alarms and not keep a copy, you purge the SQL database on a regular basis. See Chapter 17 Maintaining a Site and Network for detailed information about archiving, purging and backing up the SQL database. The alarm log may consume a large amount of hard drive space over time. If too little drive space remains your computer will not work properly. Therefore its important to know how much drive space you have and how much drive space your alarm log requires. Visual Integrator 3 keeps all of its data including the alarm log in two database files.
To view the size of the Visual Integrator 3 database files: 1 Using Windows Explorer, find and open the following folder: C:\Program Files\Circon\Data\DB 2 Inside the DB folder there are two files. These two files make up the database. To see the combined size of the files, select both, right click and select Properties.

It is strongly recommended that you do not attempt to change either of these files in any way. This would cause Visual Integrator 3 to operate unpredictably.
To view the amount of free space on your hard drive: 1 Using Windows Explorer, select the C:\ drive. 2 Rightclick the C:\ drive and select Properties.

294

Document Number 800263 Revision 3.7

Chapter 12 Using Network Scheduler

etwork Scheduler provides an intuitive operator interface to create and maintain schedules that control the sequence of operation of LonWorks devices, on a timeofday basis. With Network Scheduler, multiple devices can be combined into arbitrary groups and assigned the same schedule. And there is no limit to the number of groups or schedules that can be created.

Network Schedulerdeveloped schedules can be deployed in two ways: Deviceresident for Circon devices only, the schedule is downloaded to and runs in the device. Circon devices store their schedules locally in the device memory in the scheduler functional block. Most Circon devices can store two or more schedules. Once the schedule is downloaded, the PC running Network Scheduler is not required. This approach can also be used to schedule devices from other manufacturers, by connecting the schedule output network variable from a Circon device to the other manufacturers devices schedule input network variable. PCresident for any LonWorks device, the schedule runs in the same PC as Network Scheduler and communicates to the devices through a connection over the LonWorks network. IMPORTANT PCresident scheduling is available in Visual Integrator 3 version 3.6 and later.

Scheduling concepts
What is a schedule?
A schedule adapts device operation on a timeofday basis, to meet the facilitys or zones sequence of operation requirements. A schedule is a collection of prioritized timeofdaybased events that provide the devices application with the scheduled state, for example, occupancy.

What is a schedule event?


A schedule is a collection of one or more prioritized timeofday events called schedule events, created by the operator using Network Scheduler. A schedule event persists until another scheduled event begins. For example, a weekday schedule could consist of three events: from 7:00am to 5:30pm, from 5:30pm to 10:00pm and from 10:00pm to 7:00am. A schedule event is characterized by its properties which together determine when to initiate the associated schedule state, as below:

Document Number 800263 Revision 3.7

295

Chapter 12 Using Network Scheduler Schedule event properties

Property name
Start time End time Recurrence Day/date range

Description
The hour and minute when the event starts The hour and minute when the event ends How often is the event scheduled? daily, monthly, yearly ? The calendar dates within which the event is constrained. The event will not be active outside of this range. For example, schedule an event only during the months of September through June. An optional additional constraint on the schedule event, for example, to have it occur only on the first Monday of the month. The sequence of operation in effect for the duration of the event Priority of event compared to other events with overlapping time periods

Day filter State Priority

What is the default schedule event?


Each schedule includes one schedule event designated as the default schedule event. When you create a new schedule, its default schedule event with the default state is created automatically. The default schedule event is activated when none of the other schedule events in the devices schedule match the current date and time. Essentially, the default schedule event is always implicitly the lowest priority event for the schedule. The state for the default event can be configured.

What is schedule event priority?


Network Scheduler allows you to create schedule events that overlap, that is two or more schedule events can occur on the same day and for all or a portion of the same time period. For example, all weekdays may be scheduled as occupied from 7:00am to 5:30pm, however on December 25th, when it occurs on a weekday, the schedule includes an overlapping event that sets occupancy state to unoccupied for the entire day. Which schedule event has priority and will be activated? In this case, to be activated, the December 25th event must be set to higher priority than the normal weekday schedule event. Network Scheduler allows you to raise and lower the priority of overlapping events; the event with the highest priority on a given calendar day and time period is the schedule event that is activated.

What is a schedule state?


A schedule state determines the sequence of operation of the device and the equipment it controls, for the duration of a schedule event. .

296

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

How is a schedule deployed?


A schedule can be deployed to the device(s) in two ways, and the same schedule can be deployed in both ways simultaneously: Deviceresident for Circon devices only, the schedule is downloaded to and runs in the device. A Circon device stores its schedule locally in its device memory in the scheduler functional block. Most Circon devices can store two or more schedules. Once the schedule is downloaded, the PC running Network Scheduler is not required. This approach can also be used to schedule devices from other manufacturers, by connecting the schedule output network variable from a Circon device to the other manufacturers devices schedule input network variable. PCresident for any LonWorks device, the schedule runs in the same PC as Network Scheduler and communicates to the devices through a connection over the LonWorks network that is updated by the Circon Synchronization service.

Network Scheduler concepts


Network Scheduler extends Visual Integrator 3 operators capabilities by allowing them to create, maintain and deploy schedules to devices on a LonWorks network. This section describes important aspects of Network Scheduler.

Where does Network Scheduler store its schedules and schedule events?
Network Scheduler stores schedule information in Visual Integrators SQL database that resides on the same computer as Network Scheduler. It is important therefore, in the situation where Visual Integrator is running on multiple computers, to always create and maintain schedules on the same computer. Schedules are associated with a site. Each site maintains its own unique and separate schedules.

How does Network Scheduler download schedules to the devices?


To deploy a schedule to a Circon device to be deviceresident, Network Scheduler includes a function called Synchronize. This function downloads or synchronizes the schedules in the Visual Integrator 3s SQL database with the schedule functional blocks in the LNS database and the Circon devices. Using synchronize, the operator follows a stepwise procedure to transfer the schedules to the device schedules inside the Circon devices. This procedure ensures the schedules reach the intended devices. If Network Scheduler is unsuccessful, the operator is informed by a warning message. As well, every schedule synchronization activity, whether successful or not, is recorded in Visual Integrator 3s activity log. The operator can then verify the results of the synchronization at a later date.

Document Number 800263 Revision 3.7

297

Chapter 12 Using Network Scheduler

Network Schedulers synchronization process consists of two main steps: updating the Scheduler functional block configuration properties in the LNS database for the intended devices, and monitoring the download progress of the configuration properties to the devices as performed by LNS. In all cases the Scheduler functional block configuration properties in the LNS database will be successfully updated but only devices that are commissioned and online receive the downloaded schedule.

How does Network Scheduler communicate schedules to devices from the PC?
To deploy a schedule as PCresident, Network Scheduler allows you to create or select a network variable, of the appropriate type, on the LNS network interface. Then, using a network management tool, you connect this network variable to the corresponding input network variable on the LonWorks device(s) you want to schedule. Finally, the Circon Synchronization service is started to update the network variable as required.

How do operator access permissions affect Network Scheduler?


Two permissions govern the operators access to Network Scheduler functions: schedule configuration permission and schedule management permission. In summary, the permissions allow the operator to access the following functions:
Permission
management configuration neither of above

Summary
all functions: view, create, modify, delete schedules and events, synchronize with devices maintenance functions: view, modify existing schedule events in existing schedules, synchronize with devices view existing schedules only

Network Scheduler permissions are assigned to operator groups on a per site basis, in the same manner as other Visual Integrator permissions. The table below shows the detailed capabilities of each permission. A complete description about how to use permissions to secure a site is provided in Chapter 14 Securing access to a site.
Network Scheduler permissions defined

Permission Function
View schedule properties View schedule events View event properties Create new schedule Edit schedule properties

None
Y Y Y N N

Management
Y Y Y N N

Configuration
Y Y Y Y Y

298

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Permission Function
Rename schedule Delete schedule Create new event Edit event properties Rename event Delete event Synchronize

None
N N N N N N N

Management
N N N Y Y N Y

Configuration
Y Y Y Y Y Y Y

The steps in configuring a schedule


In Visual Integrator 3, schedules are created and configured using Network Scheduler. There are two approaches: creating the schedule from the beginning a blank slate, or importing a schedule you have previously created and exported. By using the power of importing and modifying a schedule, you avoid the repetitive reentry of events common to all schedules such as default workdays and holidays.

Main steps in creating a schedule from the beginning:


1 2 3 4 5 6 Create a new schedule and name it to be meaningful to the operator. Configure the properties of the schedule, including the group of devices that use the schedule Add the schedule events to the schedule Prioritize overlapping events For device resident deployment, synchronizing the devices with the schedule For PCresident deployment, make the network variable connections then stop and restart the Synchronization service.

Main steps in configuring a schedule by importing:


1 2 3 4 Importing a previouslyexported schedule and name it to be meaningful to the operator. Configure the properties of the schedule if necessary, including the group of devices that use the schedule For device resident deployment, synchronizing the devices with the schedule For PCresident deployment, make the network variable connections then stop and restart the Synchronization service.

The following sections describe how to use Network Scheduler to perform each step.

Document Number 800263 Revision 3.7

299

Chapter 12 Using Network Scheduler

Creating a new schedule


The key to providing an intuitive, easytomaintain set of site schedules is coming up with a convention for naming the schedules that the operator can relate to. The schedule name may reflect the equipment it controls, for example: Roof top unit A or it may represent the building layout or zones that are individually scheduled, for example: 3rd floor. Once you have created the schedule and named it, you can rename it at anytime without affecting any other aspects of it.
Before you start:

Ensure you are logged on to Visual Integrator 3 as an operator with schedule configuration permission.
To create a new schedule: 1 Choose Tools > Network > Scheduler or click the Network Scheduler button on the toolbar. 2 The Network Scheduler window is displayed. The left pane provides a Windows Explorerlike navigation tree view of all schedules associated with the site, and the right pane displays the details of the schedule selected in the treeview:

300

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Rightclick anywhere in the right pane and select New Schedule from the popup menu. The New Schedule dialog box is displayed:

4 Type the name for the schedule and a description if required, and then click OK. The new schedule appears in both the treeview and the detail view.

Importing a new schedule


You import a schedule that has been exported using Network Scheduler. Importing allows you to create a new schedule by reusing a previously developed and proven schedule without having to reenter the events and schedule properties. You still have to configure the group of devices that use the schedule.
Before you start:

Ensure you are logged on to Visual Integrator 3 as an operator with schedule configuration permission.

Document Number 800263 Revision 3.7

301

Chapter 12 Using Network Scheduler To import a new schedule: 1 Choose Tools > Network > Scheduler or click the Network Scheduler button on the toolbar. 2 The Network Scheduler window is displayed. The left pane provides a Windows Explorerlike navigation tree view of all schedules associated with the site, and the right pane displays the details of the schedule selected in the treeview:

3 Rightclick anywhere in the right pane and select Import New Schedule from the popup menu. The Windows Open dialog box is displayed. Navigate to the folder where you saved the exported schedules:

4 Select the schedule you want to import and click Open. 5 The new schedule appears in both the treeview and the detail view with a schedule name prefixed by the text Imported.

302

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring schedule properties


Each schedule can be individually tailored through its properties, which are: Name of schedule and description Schedule type Default state and allowed schedule states Schedule state assigned by default to new events Names and color that represents each schedule state Devices to which the schedule is downloaded and synchronized (for deviceresident schedules) Network variable to use (for PCresident schedules) The procedure for configuring the schedule properties is described below.
To modify the schedule properties: 1 Rightclick on the icon representing the schedule in the left pane and choose Properties from the popup menu. The Properties dialog box is displayed. 2 Select the States tab:

3 The Schedule Type dropdown list allows you to select the network variable type associated with the schedule. The significance of this setting is different for deviceresident deployment and PCresident deployment, as described below. Deviceresident deployment Schedule Type must be set to SNVT_tod_event for all Circon devices except the MAC300STA. The MAC300STA is the only device with a scheduler functional block that supports changeable types. If you

Document Number 800263 Revision 3.7

303

Chapter 12 Using Network Scheduler are creating a schedule for one or more MAC300STA devices then use the dropdown list to select the network variable type. For example if you are scheduling Douglas lighting panels, choose SNVT_scene. You must also configure the Scheduler functional block of each MAC300STA device to match the network variable type, using a network management tool and the Scheduler plugin. PCresident deployment Schedule Type must be set to the network variable type of the network variable you intend to use to connect from the PC to the devices you want to schedule. This type is used when creating or selecting the Network Variable property following. 4 The Network Variable dropdown list allows you to select or create the network variable used for PC resident deployment of this schedule. The list displays all network variables that exist on the LNS Network Interface that are of the type shown in the Schedule Type setting. If the list is empty or none of the existing network variables is appropriate, then create a network variable by typing its name in the Network Variable dropdown list. It is created when you click Apply or OK. IMPORTANT The Network Variable dropdown list and PCresident scheduling is available in Visual Integrator 3 version 3.6 and later. 5 The current default schedule state is indicated by the >> symbol in the Default column. The default schedule state is used in the schedule for time intervals when no schedule event is present. As shown above, the default state is Standby. To change the default schedule state, select the name of the state you want to be the default for this schedule and click Default State. Notice that the >> symbol changes position to mark the new default schedule state. 6 Configure the default schedule state for new events. This is the schedule state used when a new event is added to the schedule. The schedule state for new events is indicated by >> in the New column. In the example above, the schedule state for new events is Occupied. To change this, select the name of the state you want to be the schedule state for new events for this schedule and click Default New. Notice that the >> changes position to mark the changed schedule state for new events. 7 The Name column indicates the name associated with each state in Network Scheduler Day/month view. Select the name you want to change and click Properties. Type the new name in the Name box. In addition to its assigned color, the schedule states name appears on the corresponding events in the schedule day/month view. Operators with colorvision impairment can use the name text to determine the scheduled state. 8 The color column indicates the color associated with each schedule state in the day/month view. This color can be changed. To change the schedule state color, select the name of the state and click Properties. The Schedule State properties dialog box is displayed:

Use the color dropdown list to select the new color.

304

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 For PCresident deployment only, the procedure ends here. For deviceresident deployment, continue with the following steps. 10 To assign the devices to which the schedule is downloaded and synchronized, select the Device Schedules tab:

11 In the area labelled Select from all device schedules, click on the plus sign to expand the devices you want to download or synchronize this schedule to. The names of the device schedules within each device are shown. If a device schedule is already assigned to receive another schedule, it cant then be used for a second schedule. 12 Select the device schedules, one at a time, and click Add to assign this schedule. The device schedule appears in the area labelled Device schedules assigned as shown below:

Document Number 800263 Revision 3.7

305

Chapter 12 Using Network Scheduler 13 When you are satisfied that you have configured the properties correctly, click Apply. You can always add and remove device schedules from the group in the future. If you have assigned a device schedule already in use, the following error message will be displayed. You must remove that schedule object from one of the assigned lists.

Adding a schedule event to a schedule


When you add a schedule event to a schedule, you are determining the timeofdaybased operation of the devices to which the schedule is assigned.
To add a schedule event to a schedule: 1 Rightclick on the icon representing the schedule in the left pane or doubleclick the icon representing the schedule in the right pane. The Day/Month view of the schedule for the current day will appear in the right pane:

A B

The four components of the schedule Day/Month view as identified by letters above, are:

306

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide A the time of day in halfhour increments B the color indicator representing the schedule state for adjacent time period. Because the example above shows a new schedule, the default schedule event is the only event in the schedule and is shown as continuous. C the day view where additional schedule events can be created and displayed, as shown later in this procedure. D the month view; three items to note: 1) the small black arrowheads on either side of the title of the month of March allow you to navigate forward and backward through the calendar, 2) a small black outlined rectangle on a day, for example March 3, indicates todays date, 3) a small greyfilled rectangle on a date, for example March 11, indicates the date of the days schedule being displayed in the day view. Click on any day of any month to display the schedule for that day. 2 Right click anywhere in the Day view and choose New event from the popup menu. A new event is added, with an arbitrary time interval:

Document Number 800263 Revision 3.7

307

Chapter 12 Using Network Scheduler 3 Adjust the time interval, in 15 minute increments, by clicking and dragging the upper and lower event boundaries. (You can refine the boundaries to the nearest minute later in this procedure.) 4 Rightclick anywhere in the new event and choose Properties from the popup menu. The New Event Properties dialog is displayed, set to Daily recurrence:

5 The Event properties set the time and date and schedule state properties of a schedule event. Start by selecting the schedule state in effect during this schedule event. 6 Set the start time to the time of day you want this event to begin. When an event starts, the schedule state changes to the schedule state associated with this event. When an event ends, the schedule state changes to the schedule state associated with the next event or to the default schedule state, if there is no immediate next state. IMPORTANT: A schedule event ends when the hour and minute set as End Time have past. For example, if End Time is 3:59 AM, then the event ends at 3:59:59 AM. 7 Select the recurrence appropriate for the event. There are three choices: Yearly event reoccurs every year between the start date and end date Monthly event reoccurs every month between the start date and end date Daily event reoccurs every day between the start date and end date

308

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 8 To configure the exact recurrence you want for the event, it is best to explore the three recurrence settings one at a time until you find the best fit; Yearly and Monthly are shown below, Daily is shown in the previous step:

9 In addition to the flexibility inherent in the start date and end date selections, you may want to further restrict the events recurrence by using a day filter. Select the Day Filter tab to view the three options: Weekdays means Monday, Tuesday, Wednesday, Thursday and Friday. Weekend days means Saturday and Sunday.

Document Number 800263 Revision 3.7

309

Chapter 12 Using Network Scheduler 10 The example below configures an event for normal working days with the configuration as follows. The recurrence indicates every day of every month, and the day filter restricts that further to weekdays only:

11 Click OK to save these properties. 12 Finally, you may want to name this event to allow it to be readily understood by the operator. Right click anywhere on the event and select Rename. Type the name and terminate with the Enter key. The completed event is displayed as follows:

310

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Prioritizing overlapping events


When overlapping events are created, their priority is shown in the Day/Month view with the highest priority event in front of lower priority events on that day.
To display Day/Month view and adjust priority: Rightclick on one of the overlapped events and choose Bring To Front or Send To Back from the popup menu.

An alternative view of the complete schedule is provided that allows you to view all events and to adjust priority. This is the List view.
To display List view and adjust priority: 1 Rightclick on the time scale in the right pane and choose List view from the popup menu The List view of the schedule for the current day is displayed in the right pane:

2 Events of higher priority are shown as above (closer to the top of this list) those with lower priority. In the example shown above, the March 11 holiday event is lower priority than the Normal working hours event for the day March 11. Therefore the schedule will be according to Normal working hours on March 11. To change the priority so the March 11 holiday event is higher, click on the name, March 11 holiday, and drag the event to overlap with the Normal working hours event. Release the click and the March 11 holiday event is repositioned as higher priority than the Normal working hours event. Alternatively, right click on the March 11 holiday event and select Raise priority from the popup menu. The order of the events is changed as shown below: List View

Document Number 800263 Revision 3.7

311

Chapter 12 Using Network Scheduler Day/Month View

312

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Exporting a schedule
By exporting a schedule you make it available to be imported either to the same site or to a different site. Exported schedules include the schedule properties, except the associated devices and schedules, and the events and their priorities. The data is exported to a file and saved as XML.
To export a schedule: 1 From the Network Scheduler tree view of all schedules associated with the site, or from the right pane view of all schedules, rightclick on the schedule you want to export and select Export to File from the pop up menu. The Save as dialog is displayed:

2 Navigate to the folder where you are saving schedules and click Save to export the schedule.

Synchronizing devices with a schedule


This procedure applies when using deviceresident deployment only. When you have completed the schedules using Network Scheduler, the information is stored in the Visual Integrator 3 SQL database on the computer where Network Scheduler is running. The final step, for deviceresident deployment, is to synchronize the schedules in that database with the LNS database and the device schedules that use them. You can choose to synchronize all schedules in all devices or synchronize only the schedules you have changed with the devices affected. You must be attached to the network and OnNet to synchronize schedules. If you make changes to schedules but do not synchronize before closing Network Scheduler, you are reminded of your choice with the prompt as below:

Document Number 800263 Revision 3.7

313

Chapter 12 Using Network Scheduler To synchronize the Visual Integrator 3 schedule database with the devices: 1 Rightclick on the folder titled Schedules in the left pane at the top of the navigation tree, and select Synchronize Devices from the popup menu. If VI3 is attached to the network and OnNet then the Synchronize Devices dialog box appears : If there are no pending schedule changes to be synchronized with devices, the dialog box appears as below: If you made changes to a schedule that now needs to be synchronized with devices, the dialog box appears as below, displaying the devices that should be synchronized:

If Visual Integrator 3 is not attached to the network, the following message is displayed. You must close Network Scheduler and attach Visual Integrator 3 to the network first.

If Visual Integrator 3 is attached to the network, but is not OnNet, the following message is displayed. You can choose to go OnNet and continue with the synchronization by clicking Yes, or terminate the synchronization by clicking No.

314

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 2 If you are satisfied with the list of devices displayed in the upper list box, then proceed to step 3. Otherwise remove devices you do not want synchronized or select additional devices to be synchronized using your preferred method: Click Add All to select all possible devices, or click the plus sign in the lower list box to expand the tree and select individual devices and click Add. The selected devices are displayed in the upper list box, as below:

If you click Add Changed and no devices appear on the upper list, then no schedule changes have occurred since the last synchronization. To remove multiple devices from the upper list box, use Windows multiselect operation by holding down the Ctrl or Shift key and clicking devices to remove then click Remove.

Document Number 800263 Revision 3.7

315

Chapter 12 Using Network Scheduler 3 When the list of devices to synchronize is complete, click Apply to begin the synchronization process. The Synchronization Summary dialog is displayed, indicating the progress and results of the synchronization. Three possible outcomes are shown below: b) When a device is commissioned but not online, the LNS database is updated successfully but the schedule has not reached the device. A warning message for that device appears as below

a) When the synchronization completes successfully for all devices, the summary appears as below:

c) When a device is not yet commissioned, the LNS database will be updated successfully but the schedule will not have reached the device. A warning message for that device will appear as below:

4 Click Done to close the Summary and click Done to close the Synchronize Devices dialog box.

316

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Verifying device synchronization with the activity log


This procedure applies when using deviceresident deployment. Network Scheduler records its synchronization activity in the Visual Integrator 3 activity log. The activity log can be viewed using the site management feature or the reports feature of Visual Integrator 3. See below for two examples of activity log records corresponding to the previous examples above.
Activity log showing successful synchronization of two devices

Activity log showing successful synchronization of one device and failure of the other.

Deploying a PCresident schedule


This procedure applies when using PCresident deployment. For PCresident deployment, after the schedule is complete, you make the network variable connections and stop and restart the Synchronization service.
Making the network variable connections

A network management tool is needed to make the network variable connections. Network variable connections cant be made with Visual Integrator 3, unless the Network Editor option is available. The procedure for making connections is described in the network management tool documentation.
Stopping and restarting the Synchronization service 1 Start Visual Integrator 3 and log in using an administrator account. 2 From the toolbar choose, Circon Service Manager. The Circon Service Manager is displayed. 3 Click on the text Circon Local Synchronization service to select it.

Document Number 800263 Revision 3.7

317

Chapter 12 Using Network Scheduler 4 Click Stop to stop the service. Wait until the Status for the Circon Local Synchronization service changes to blank space.

5 Click Start to start the service. Wait until the Status for the Circon Local Synchronization service changes to Started. 6 Close the Circon Service Manager dialog. You can verify that the service has started by reviewing the most recent entries in the Visual Integrator 3 Application log, via the Site Management utility.

Schedules report
The Schedules report allows you to prepare a report showing all or selected schedule information kept in the Visual Integrator 3 SQL database pertaining to schedules created by Network Scheduler. Visual Integrator 3 provides two approaches for displaying the schedule report: as a schedule report document in DocumentView or as a report generated by a Site Management operator. See Chapter 4 Working with Visual Integrator Documents for a description of the schedule report document and how to use it. See Chapter 13 Using Reports for a description of the schedule report and how it can be generated by a site management operator.

Schedule document
As an alternative to using Network Scheduler to set up and maintain schedules you can provide access to individual schedules from TreeView when you use the schedule document. See Chapter 4 Working with Visual Integrator Documents for a description of the schedule document and how to use it.

318

Document Number 800263 Revision 3.7

Chapter 13 Using Reports


isual Integrator 3 provides access to information in its SQL database through builtin reports. Using the reports filter property, the range of data included can be selected. Once a report has been generated it can be printed or its contents can be exported to a file. Visual Integrator 3 includes these builtin reports: Activity report contains the information recorded in the Audit log and the Application log. Alarms report contains alarm event information Runtime report contains runtime and startup count data Schedule report contains information about schedules created by Network Scheduler Operator report contains information about individual operators Operator Groups report contains information about the operator groups

Generating a report using Site Management


The reporting function for all reports is included within the Site Management utility.
To generate a report: 1 Choose Tools > Manage Sites 2 Open the Reports folder; the six reports are displayed. 3 Open a report by double clicking; for some reports a filter dialog is displayed, for others the report is generated directly. 4 If a filter dialog is displayed, select the filter options then click OK to generate the report. 5 After the report is generated you can choose to print the report or to export the data as a comma separatedvalue file. Exporting is described later in this chapter.

Generating a report using Documents


Alternatively, the Alarms report and the Schedules report can be generated without using the Site Management utility, by adding the Alarms Report document and the Schedules Report document to TreeView. See Chapter 4 Working with Visual Integrator Documents for a description of these two report documents.

Document Number 800263 Revision 3.7

319

Chapter 13 Using Reports

Activity report
The Activity report consists of two sections: the Application log and the Audit log activities. The filter dialog for the Activity report is as follows:

Time specifies the period of time from which the activities are taken User Login enter the login name of a specific operator to generate a report containing only that operators activities Description To view only those activities with a specific text fragment in their description, type that text fragment in the Description box and use the wildcard character % to indicate that it is a fragment. For example, to display only activities with the word "logon" in the description, type %logon% in the description box. The SQL LIKE clause is used when filtering on descriptions; you may want to investigate this clause to understand its other wildcard capabilities. Customer specify a single customer or all customers to generate a report containing activities for sites owned by those customers Site specify a single site or all sites to generate a report containing activities for those sites

320

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Alarm report
In addition to the items on which filters can be configured, the alarms report includes the comments entered by the operator when acknowledging the alarm and when clearing the alarm. The filter dialog for the Alarm report is as follows:

Time specifies the period of time from which the alarms are taken State select alarm state(s) to generate a report containing only alarms in that state. Priority select alarm priorities to generate a report containing only alarms in those priorities. Category select a category of alarms or all categories to generate a report containing only alarms in that category. Code select an alarm code or all codes to generate a report containing only alarms with that alarm code. Description To view only those alarms with a specific text fragment in their description, type that text fragment in the Description box and use the wildcard character % to indicate that it is a fragment. For example, to display only alarms with the word "temperature" in the description, type %temperature% in the description box. The SQL LIKE clause is used when filtering on descriptions; you may want to investigate this clause to understand its other wildcard capabilities. Customer specify a single customer or all customers to generate a report containing alarms for sites owned by those customers Site specify a single site or all sites to generate a report containing alarms for those sites

Document Number 800263 Revision 3.7

321

Chapter 13 Using Reports

Operator groups report


The operator groups report contains information about all the operator groups in the VI 3 SQL database. Information includes customer, site and permissions. There is no filter for this report.

Runtime report
The runtime report contains information about all runtime and startup counts recorded in the in the VI 3 SQL database for all devices that reported. There is no filter for this report.

Schedules report
The filter dialog for the Schedule report is as follows:

Customer specify a single customer or all customers to generate a report containing schedules for sites owned by those customers Site specify a single site or all sites to generate a report containing schedules for those sites

Operators report
The Operators report contains information about all the operators in the VI 3 SQL database. Information includes login name, email address, and operator groups they are a member of. There is no filter for this report.

322

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Exporting data from a report


Data contained in a report can be exported to a file formatted as commaseparatedvalue (CSV). Data in files of this format can be imported into many analytical tools such as Microsoft Excel.
To export data to a CSVformatted file: 1 Generate the report as described earlier in this chapter. 2 Click the Export button on the report viewer toolbar, as indicated below:

3 Select the CSV format from this list presented. 4 Select the location of the file and its name from the Choose Export File dialog. 5 Click OK to save the data to file. The file extension is .csv.

Document Number 800263 Revision 3.7

323

Chapter 13 Using Reports

This page is left blank intentionally.

324

Document Number 800263 Revision 3.7

Chapter 14 Securing Access to a Site


isual Integrator 3 is a featurerich product designed to meet the needs of a wide range of operators. Typically, not all operators should have access to all the features. Visual Integrator 3 allows you to tailor the access to restrict each operator to the appropriate sites and features of Visual Integrator 3. Access to Visual Integrator 3 is made secure by requiring operators to log in with a valid username and password. Once logged on, an operators access to the site and features of Visual Integrator 3 is restricted by permissions. Visual Integrator 3 allows you to create operators and organize them into operator groups. Operator groups are granted access to a site. An operator group with access to one site does not have access to other sites unless you grant that operator group access to those sites. Once an operator group is granted access to a site, you allocate permissions to that operator group that apply only to that site. The same operator group can have different permissions for different sites. Permissions govern the extent to which members of the operator group can utilize the functions of Visual Integrator 3 such as Network Editor, Network Scheduler and Graphics Editor and their ability to access and modify the LNS network database and devices on the site network. An operator who is a member of the Administrator group manages usernames, passwords, groups, and site permissions through the Site Management utility.

Main steps to securing access to a site:


1 2 3 4 5 Create operators for the individuals or roles you want to use Visual Integrator 3 Create operator groups Place operators into the appropriate operator groups Grant operator groups access to the appropriate sites Assign the site permissions to the operator groups

Operators
Every authorized operator has the capability to log in to Visual Integrator 3. However, the ability for an operator to have access to a particular customer/site and to use the functions of Visual Integrator 3 is determined by its operator group membership and the operator group permissions. Every operator requires a username and password to log in to Visual Integrator 3.

Document Number 800263 Revision 3.7

325

Chapter 14 Securing Access to a Site

Operator groups
Members of an operator group have access to the same sites and have the same permissions at each site. Remember though, that the permissions are site specific. An operator group can have different permissions at different sites. An operator group should contain operators with similar jobs and similar site access requirements. For example, you may want to create two operator groups of building operators. Both operator groups access the same site, but one operator group can use Visual Integrator 3 to monitor the site only while the other operator group can monitor the site, change some setpoints, and manage alarms. None of the operator groups you create permit their members to use the site management utility to perform administrative functions; only members of the Administrator group described below can perform administrative functions.
Administrator group The Administrator operator group is the default operator group that ships with Visual Integrator

3 containing one operator: the operator Administrator with password circon The Administrator group must always contain at least one member. It cant be deleted. After you add other members to the Administrator group you can delete the administrator operator Administrator if you want to. Only members of the Administrator operator group can use the Site Management utility. An operator who is a member of the Administrator operator group manages operators, usernames, passwords, operator groups, and site permissions through the Site Management utility.

Permissions
Permissions refer to the ability of operators to utilize the functions of the Visual Integrator 3 for a specific customer/site. Permissions can be uniquely specified per every operator group per every site. For example, one operator group may have the ability to launch device plugins, but may not have the ability to perform network maintenance tasks while connected to the network, whereas another operator group may have the ability to launch device plugins and may be able to perform network maintenance tasks, as well as perform administrative duties. A complete description of permissions can be found later in this chapter.

Managing operators
Operators are individuals with a Visual Integrator username and password account that allows them to log in to Visual Integrator or with their Windows user account login integrated with the Visual Integrator login.

326

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Operators are granted access to Visual Integrator functions when they are assigned to an operator group and inherit its site permissions. When new operators are created, their accounts are enabled, meaning they can log in to Visual Integrator. To disable an operator account, see Modifying an operator's properties.

Windows account prerequisites


To run Circon software, the operators Windows account must be either a member of the Administrators group or a member of both the Circon Users group and another Windows group such as the Users group. The Circon Users group is a Windows group that allows its members to run Circon software. The Circon Users group combined with another Windows group such as the standard Windows Users group provides the most secure environment in which to run Circon software. . The Circon Users group is a local Windows group that is created automatically when Access Integrator is installed. See the release notes for more information about this group. There are some limitations for Circon Users group users over the Windows Administrators group: The Circon Service Manager opens as readonly where the operator can see the status of the services, but cant start or stop any services. They cant use the Task Scheduler. Its not listed on the Tools menu. Alarm notifications in the Alarm Log viewer and the Alarm Notifier are delayed several seconds because the database must be polled.

For operators who are not members of the Windows Administrators group, alarm notifications in the Alarm Log viewer and the Alarm Notifier are delayed several seconds because the database must be polled.

Adding an operator
To add an operator: 1 Log in to Visual Integrator 3 as a member of the Administrator group. The default administrative operator is username Administrator with password circon. 2 Choose Tools > Manage Sites. The Site Management window is displayed. 3 Double click the Operators folder. Its contents are displayed in the right pane: 4 Right click in the white space of the right pane and choose New Operator or Add Windows Account from the popup menu. Continue this procedure below, based on this choice. Using the New Operator dialog: 5 Choose New Operator from the popup menu. The New Operator dialog is displayed.

Document Number 800263 Revision 3.7

327

Chapter 14 Securing Access to a Site

6 In the field labelled Login, type the username. This is the name the operator uses to log in and the name that appears in the Operators folder, in thte activity log and on reports. Login is not case sensitive. 7 In the fields labelled First Name and Last Name, type the optional full name of the operator. 8 In the fields labelled Password and Confirm Password, type the same password. The operator can change this later on. The password is displayed as asterisks. The password can consist of numbers, letters, oddball characters (e.g. @, #, $), or a combination thereof. The minimum password length is one character, and the maximum is 25 characters. The password is case sensitive. 9 Type an optional description of this operator. 10 Click OK to create this operator. The new operator appears in the Operators folder. Using the Add Windows Account dialog:

Use the Add Windows Account to integrate an operators Windows user login account with the Access Integrator login. When Access Integrator or Log Viewer is started by operators who were added using their Windows accounts, the Circon login dialog is bypassed. When you choose Add Windows Account from the popup menu, the Windows Select Users or Groups dialog is displayed. This is not a Visual Integrator dialog; the help provided is supplied by Microsoft. Instructions for using this dialog are outside the scope of Visual Integrator help. The operators Windows account is added to the Circon Users group. In certain circumstances, an operator who normally logs in with a Windows account and bypasses the Visual Integrator login dialog may want to use that dialog to log in as a different operator. To do this, start Visual Integrator from the Windows Run command, as follows: C:\Program Files\Circon\BIN\vilns32.exe /logon

328

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Renaming an operator
To rename an operator and change the login: 1 Double click the Operators folder. Its contents are displayed in the right pane. 2 Rightclick the operator you want to rename and choose Rename from the popup menu. 3 Modify the name of the operator by entering a new name in the highlighted field. This will be the username by which the operator logs in. 4 Press the Enter key of your keyboard when complete.

Deleting an operator
Deleting an operator removes the operator permanently from the Visual Integrator 3 database. If you want to retain the operator information but disable access by the operator, you can disable the account. To disable an operator account, see Modifying operators general properties below.
To delete an operator: 1 Double click the Operators folder. Its contents are displayed in the right pane: 2 Rightclick the operator you want to delete and select Delete from the popup menu. A confirmation dialog is displayed. 3 Click the Yes button. The operator is deleted permanently.

Modifying operators properties


To modify an operators properties: 1 Double click the Operators folder. Its contents are displayed in the right pane: 2 Rightclick the operator you want to modify and choose Properties from the popup menu. 3 Review and modify user name and description on the General tab.

Document Number 800263 Revision 3.7

329

Chapter 14 Securing Access to a Site IMPORTANT: when Account is disabled is selected, the operator cant log in to Visual Integrator 3. However, none of the operators account properties or operator group memberships is changed.

4 Review and modify email addresses on the Notifications tab. The operator is sent alarm notifications to these email addresses. An operator can have none, one or two email addresses. Enter email address in the form xxx@yyy.zzz Members of an operator all receive the alarm notifications by email for the same alarm codes. See Chapter 11 Logging and Viewing Alarms in the section Using email to send alarm messages for a description of this group property.

330

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 Review and modify the operator groups this operator is a member of, on the Groups tab.

Changing or setting a new password


You may need to change or set an operators password while logged on as an administrator.
To modify an operators password: 1 Double click the Operators folder. Its contents are displayed in the right pane. 2 Rightclick the operator you want to modify and choose Set Password from the popup menu:

3 In the fields labelled New password and Confirm new password, type the same password. The operator can change this later on. The password is displayed as asterisks. The password can consist of numbers, letters, oddball characters (e.g. @, #, $), or a combination thereof. The minimum password length is one character, and the maximum is 25 characters. The password is case sensitive.

Adding an administrative operator


If you want a new operator to be able to use the Site Management utility and have administrative capabilities, ensure the operator is a member of the Administrators operator group. See Adding operators to an operator group for detailed information on adding operators to operator groups.

Document Number 800263 Revision 3.7

331

Chapter 14 Securing Access to a Site

Managing operator groups


Groups of operators are granted access to a site. An operator group with access to one site does not have access to other sites unless you grant access to those sites. Once an operator group is granted access to a site, you allocate permission to the operator group. Typically, multiple operator groups are granted access to a site to fulfill various operator roles such as administrator, operator, maintenance, etc. An operator who is a member of the Administrator operator group manages operator groups and site permissions through the Site Management utility.

Adding an operator group


To add an operator group: 1 Log in to Visual Integrator 3 as a member of the Administrator group. The default administrative operator is username Administrator with password circon. 2 Choose Tools > Manage Sites. The Site Management window is displayed. 3 Double click the Operator Groups folder. Its contents are displayed in the right pane: 4 Right click in the white space of the right pane and choose New Operator Group from the popup menu. The New Operator Group dialog box is displayed:

5 In the field labelled Name, enter the operator group name. The operator group name can be up to 50 characters. The operator group name should reflect the role and permission level of the operator group, for example: Operators view only. 6 Enter an optional description of this operator group. 7 Click OK to create this operator group. The new operator group appears in the Operator Group folder:

332

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Renaming an operator group


To rename an operator group: 1 Double click the Operator Groups folder. Its contents are displayed in the right pane. 2 Rightclick the operator group you want to rename and choose Rename from the popup menu. 3 Modify the name of the operator group by entering a new name in the highlighted field. 4 Press the Enter key of your keyboard when complete. When an operator group is renamed, the only change is the name of the operator group. It retains all members and allows access to the same sites with the same permissions that the previous named operator group did.

Deleting an operator group


To delete an operator group: 1 Double click the Operator Groups folder. Its contents are displayed in the right pane. 2 Rightclick the operator group you want to delete and choose Delete from the popup menu. A confirmation dialog is displayed. 3 Click Yes. The operator group is deleted permanently. Deleting an operator group does not delete the operators in that group.

Adding operators to an operator group


To add operators to an operator group: 1 Double click the Operator Groups folder. Its contents are displayed in the right pane. 2 Rightclick the operator group you want to add operators to and choose Properties from the popup menu. The Properties dialog is displayed with the name of the operator group in the title bar. 3 Select the Operators tab.

Document Number 800263 Revision 3.7

333

Chapter 14 Securing Access to a Site 4 The area titled Operators NOT in this group lists all the operators you have defined. To add a particular operator to this operator group, select the operator and click Add. The operator disappears from this section and appears in the area titled Operators in this group. 5 Repeat the above step to add all the operators you want in this operator group. The Operators tab may appear as follows:

6 If you have inadvertently added an operator who you do not want in the operator group, select that operator and click Remove to take the operator out of the group.

Removing an operator from an operator group


To remove an operator from an operator group: 1 Double click the Operator Groups folder. Its contents are displayed in the right pane. 2 Rightclick the operator group you want to remove an operator from and choose Properties from the popup menu. The Properties dialog is displayed with the name of the operator group in the title bar. 3 Select the Operators tab. 4 The area titled Operators in this group lists all the operators in the operator group. To remove a particular operator from this operator group, select the operator and click the Remove button. The operator disappears from this section and appears in the area titled Operators NOT in this group. 5 Repeat the above step to remove all the operators you want from this group.

Setting alarm notifications for an operator group


Members of an operator group all receive the alarm notifications by email for the same alarm codes. See Chapter 11 Logging and Viewing Alarms in the section Using email to send alarm messages for a description of this group property.

334

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Setting mandatory alarm acknowledgement comments for an operator group


Members of an operator group can be required (forced) to type a comment when acknowledging and clearing certain alarms. By default, comments are optional for all alarms. Use the procedure below to select the alarms for which operators in the operator group are forced to type a comment.
To configure mandatory comments for alarm acknowledgement: 1 From the toolbar, choose Site Management 2 Open the Operator Groups folder and select an operator group. 3 Double click on the operator group to display the operator group properties dialog; select the Alarm Acknowledgement tab. 4 In the lower pane titled Operators are not required to comment to acknowledge these alarms, select the alarms you want to force this operator group to type a comment for, when acknowledging. Use Windows standard selection methods to quickly select multiple alarms: to select several contiguous alarms, hold down Shift and select the first and last alarm. to select several of nonadjacent alarms, hold down Ctrl and select the individual alarms. 5 When you have selected all the alarms, click Add. The alarms appear in the top pane of the dialog. Members of this operator group are forced to type a comment when acknowledging any of these alarms.

Document Number 800263 Revision 3.7

335

Chapter 14 Securing Access to a Site

Setting site permissions for an operator group


Permissions are used to restrict an operators ability to perform certain Visual Integrator 3 functions when working with a particular site. Site access permissions are assigned to operator groups. All operators who are members of the same operator group inherit the same permissions. An operator group can be assigned the same or different permissions for different sites. Typically, operators who are members of the Administrators group are assigned all permissions.
To configure permissions for a specific site for an operator group: 1 In Site Management, click the plus sign to the left of customers and then click the plus sign to the left of the particular customer who owns the site you want to change permissions for. 2 Click the Sites folder. The sites for this customer are displayed in the right pane. 3 Rightclick the site name and choose Properties from the popup menu. 4 Select the Permissions tab. The area title Operator Groups that can access this site lists all the operator groups you have granted access to this site. 5 Set the permissions for the operator group you have assigned site access to. Click the plus sign adjacent to the group to expand and display the permissions list. 6 Select the check box for appropriate permissions. The permissions are described below:

Override Network Variables allows an operator to override network variables via control objects in an HMI document or via an Inspector document. See Chapter 6 Control Objects Reference for a description of the control objects that support override, and see Chapter 4 Working with Visual Integrator Documents for a description of the device inspector and the functional block inspector documents. Override Configuration Properties allows an operator to override a devices configuration properties via control objects in an HMI document or via an Inspector document. See Chapter 6

336

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Control Objects Reference for a description of the control objects that support override, and see Chapter 4 Working with Visual Integrator Documents for a description of the device inspector and the functional block inspector documents. Edit Graphics enables the graphics editor button on the tool bar such that an operator can make changes to the site graphics. Launch PlugIns allows the operator to launch device configuration plugins and make changes to device configuration properties. Network Maintenance allows the operator to perform network maintenance tasks including: commissioning and decommissioning devices, loading device application into devices, replacing devices, resynchronizing configuration properties, testing devices and viewing device status. See also Network Management permission. Alarm Management allows operator to acknowledge and clear alarms Network Management allows the operator to perform network configuration tasks including: all network maintenance permissions tasks and creating, deleting, renaming and moving devices, subsystems, and routers, and creating and deleting connections (bindings). You must have the optional Network Editor function licensed to perform the additional Network Management tasks. See also Network Maintenance permission. Schedule Configuration allows the operator to use Network Scheduler to perform scheduling functions: view, modify existing schedule events in existing schedules, and synchronize schedules with devices. See table below for details. Schedule Management allows the operator to use Network Scheduler to perform scheduling functions: view, create, modify, delete schedules and events, and synchronize schedules with devices. See table below for details. Access Configuration Not applicable to Visual Integrator 3. Access Management Not applicable to Visual Integrator 3. If neither schedule configuration nor schedule management is checked then the operator is allowed to use Network Scheduler to view schedules only.
Network Scheduler permissions defined

Permission Function
View schedule properties View schedule events View event properties Create new schedule Edit schedule properties Rename schedule

None
Y Y Y N N N

Management
Y Y Y N N N

Configuration
Y Y Y Y Y Y

Document Number 800263 Revision 3.7

337

Chapter 14 Securing Access to a Site

Permission Function
Delete schedule Create new event Edit event properties Rename event Delete event Synchronize 7 Click OK to save and close the site properties dialog.

None
N N N N N N

Management
N N Y Y N Y

Configuration
Y Y Y Y Y Y

338

Document Number 800263 Revision 3.7

Chapter 15 Using Network Editor

etwork Editor is a complete network design, programming, installation and management tool for the LNS network architecture. It provides you with the ability to design, install, program, commission and integrate complete LonWorksbased control networks. Network Editor is a separatelylicensed but fullyintegrated feature of Visual Integrator 3.

Network Editor provides the same features and functions as Circons Network Integrator 3 software product, with the convenience of being in the context of the site when launched. Rather than including the Inspector feature directly with Network Editor, it is provided as the Inspector object and the device inspector and functional block inspector documents within Visual Integrator 3. For information about Network Editor, refer to the Network Integrator 3 User Guide and the Network Integrator 3 online help files included with Visual Integrator 3. The Network Integrator 3 online help files can be found at C:\Program Files\Circon\BIN\ni3.chm. The user guide can be found on the product distribution CD.

Document Number 800263 Revision 3.7

339

Chapter 15 Using Network Editor

This page is left blank intentionally.

340

Document Number 800263 Revision 3.7

Chapter 16 Testing and Verifying Devices

esting and verifying devices is an important maintenance and troubleshooting procedure after a LonWorks control network has been fully installed and commissioned. Testing of all installed devices and other network components verifies the communications on the network as well as proper control functionality of all devices. Visual Integrator 3 provides capabilities that allow an operator with the proper permissions to test and verify devices and network communications. Visual Integrator 3 is not intended to replace a network management tool except when the Network Editor feature is available.

What needs to be tested?


After a network has been fully installed and commissioned, each device should be tested periodically for proper communication. This indicates that the communications path to the device is fully accessible in the network. After a communications test is completed with a device, a device functionality test should be conducted to verify that the device is functioning properly. This ensures that the device is operating and functioning as expected. For every device on the network the following tests can be performed:
1 2 3 4 5 6 Can all the devices be reset? Can all the devices be refreshed? Does the commission status of each device indicate Updates Current? Are the devices in the Configured, Online state? Does each device pass all tests when a test command is issued? Does the service LED flash when a wink command is issued?

Document Number 800263 Revision 3.7

341

Chapter 16 Testing and Verifying Devices

Verifying and testing router operation


Verifying router operational state
Each side of a router, the near side and the far side, contains a Neuron chip. The Neuron chip accumulates network and operational data that can be viewed for diagnostic and troubleshooting purposes.
To view the status of each Neuron chip in a router: 1 Log in using the as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that you want to diagnose or test and choose the Subsystem Status document that contains the routers. 3 Rightclick the router you want to determine the status for, and choose Properties from the popup menu. 4 Select the Near Status tab as below:

When the router Near Status tab is selected, Visual Integrator 3 sends a Query Status network diagnostic message to the device. This message retrieves the network error statistics accumulators, the cause of the last reset, the state of the device, and the last runtime error logged. This message is typically used after the device has been reset to verify that reset has occurred. 5 The Current State field should indicate Configured, online. The devices Neuron chip condition consists of two parts: state and mode. Generally, the devices state is preserved across resets, whereas the mode is not. The additional states that may be displayed for a router are described below:

Applicationless, Unconfigured No application is loaded yet, the application is in the process of being loaded, or the application is deemed corrupted due to application error. The devices service LED is on but not blinking in this state.

342

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Unconfigured (with application) The application is loaded but the configuration is not loaded, is being loaded, or is deemed corrupted due to configuration error. The devices service LED blinks at a one second rate in this state. Configured, Online the normal device state. The devices application is running and the configuration is considered valid. This is the only state in which messages addressed to the application are received. In all other states, they are discarded. The devices service LED is off in this state. Configured, SoftOffline The application is loaded but not running. The configuration is considered valid in this state. A device that is in a softoffline state will go online when it is reset. The devices service LED is off in this state. Configured, HardOffline This is identical to a softoffline, except that the hardoffline mode is preserved after a reset.
6 The other fields contain diagnostic information as described below:

Last Reset Cause specifies the cause of the last reset. A reset is generally equivalent to power cycling the device. The cause of the reset can be any one of the following: Hardware Reset Occurs after a device/router has been commissioned. Powerup Occurs after the device has been power cycled. Software Reset Occurs after a reset command from a network management tool or user interface. Watchdog Reset Three watchdog timers protect the Neuron chip processors against malfunctioning software or memory faults, one per processor. If application or system software fails to reset these timers periodically, the entire Neuron chip is automatically reset. Last Error Log indicates the last error encountered by the Neuron Chip. The error log will generally display an error code and message that can be used for troubleshooting purposes. Transmit Errors indicates the number of CRC errors detected by the device during packet reception. These errors may be due to collisions on the network, or noise on the transceiver input. Missed Messages specifies the number of times that an incoming packet was discarded because there was no network buffer available. This may be due to excess traffic on the channel, insufficient network buffers on the device, or the network buffers not being large enough to accept all packets on the channel, whether or not addressed to this device. Lost Messages specifies the number of times that an incoming packet was discarded because there was no application buffer available. This may be due to an application program being too slow to process incoming packets, insufficient application buffers, or excess traffic on the channel. If the incoming message is too large for the application buffer, an error is logged, but the lost message count is not incremented.

Document Number 800263 Revision 3.7

343

Chapter 16 Testing and Verifying Devices

Transaction Timeouts indicates the number of times that the device failed to receive expected acknowledgements or responses after retrying the configured number of times. These may be due to destination devices being inaccessible on the network, transmission failures because of noise on the channel, or if any destination device has insufficient buffers or receive transaction records. Receive Tx Full Specifies the number of times that an incoming packet was discarded because there was no room in the transaction database. This may be due to excessively long receive timers, or inadequate size of the transaction database.
7 Click Clear to specify that all counters and timers be cleared and reset to zero. 8 After a few moments, click Refresh. This action retrieves the network error statistics accumulators, the cause of the last reset, the state of the device, and the last error logged. This message is used after the device has been cleared, or reset. 9 Take note of all the values in the Near Status tab, and compare them from the values in the previous step. 10 After approximately 5 seconds repeat above steps. Have the status values changed? How have they changed? 11 Select the Far Status tab and repeat this procedure.

Testing and diagnosing a router


Typically, the LonTalk routers on the network are the first devices to be tested. After a router is commissioned, a diagnostic test can be performed to test the operational state, as well as the communication link with the router. The diagnostic test can help determine the health of the router anytime during the routers life.
To diagnose and test a router: 1 Log in using the as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that you want to diagnose or test and select the Subsystem Status document that contains the routers. 3 Rightclick the router you want to test and diagnose, and choose Properties from the popup menu. When the router properties is opened, a Query Status network diagnostic message is sent to the device. This message retrieves the network error statistics accumulators, the cause of the last reset, the state of the device, and the last runtime error logged. This message is typically used after the device has been reset to verify that reset has occurred.

344

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 4 Select the Diagnostics tab.

5 The Current State field should indicate Configured, online. The devices Neuron chip condition consists of two parts: state and mode. Generally, the devices state is preserved across resets, whereas the mode is not. The additional states that may be displayed for a router are described below:

Applicationless, Unconfigured No application is loaded yet, the application is in the process of being loaded, or the application is deemed corrupted due to application error. The devices service LED is on but not blinking in this state. Unconfigured (with application) The application is loaded but the configuration is not loaded, is being loaded, or is deemed corrupted due to configuration error. The devices service LED blinks at a one second rate in this state. Configured, Online the normal device state. The devices application is running and the configuration is considered valid. This is the only state in which messages addressed to the application are received. In all other states, they are discarded. The devices service LED is off in this state. Configured, SoftOffline The application is loaded but not running. The configuration is considered valid in this state. A device that is in a softoffline state will go online when it is reset. The devices service LED is off in this state. Configured, HardOffline This is identical to a softoffline, except that the hardoffline mode is preserved after a reset.
6 Click Reset to issue a reset command to the router. The Current state should indicate Configured, online after a reset is issued to the router. The Reset command resets the router by sending the Reset network management command to both sides of the router to stop execution, stop all packet forwarding, set all temporary settings to their initial values, and restart the router application.

Document Number 800263 Revision 3.7

345

Chapter 16 Testing and Verifying Devices If a router is reset while in a softoffline state, the router will be placed online after the reset. This action will also reset all counters back to zero, and cause the current state to be refreshed. If a device resets while a network management command is in progress (e.g. commissioning, or loading an application), the reset will likely manifest itself as either a communication problem or a transaction failure. When EEPROM writes are involved (e.g. loading an application), there is significant probability that a memory location being modified at the time of the reset will become corrupted. 7 Click SoftOffline. The Current State should indicate Configured, SoftOffline. The routers application is put in the offline state. This causes the router to stop forwarding packets. If the router was previously in the offline state, this has no effect. If a router is reset while Offline, the router will be placed Online after the reset. 8 Click Online. The Current State should indicate Configured, Online. The routers application is put in the online state. This allows the router to forward packets between its two channels. If the router was previously in the online state, this has no effect. 9 Click Test. After a few moments the Test Results field should indicate: The device has passed all tests. The Test button causes a communication and diagnostic test message to be sent to the router. The test results are indicated in the Test Results field. The test results often describe the operational and communication state of the router. 10 Click Refresh to determine the current state of the router again and refresh the Current State field 11 Click Ok when complete. 12 Repeat the above steps for each router installed on the network.

Verifying and testing device operation


Verifying device operational state
Every LonWorksbased device contains a Neuron chip. The Neuron chip accumulates network and operational data that can be viewed for diagnostic and troubleshooting purposes.
To view the status of the Neuron chip: 1 Log in using the as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that you want to diagnose or test and select the Subsystem Status document that contains the routers. 3 Rightclick the device you want to determine the status for, and choose the Properties option from the popup menu.

346

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 4 Select the Status tab as shown below. When the Status tab is selected, Visual Integrator 3 sends a Query Status network diagnostic message to the device. This message retrieves the network error statistics accumulators, the cause of the last reset, the state of the device, and the last runtime error logged. This message is typically used after the device has been reset to verify that reset has occurred.

5 The Current State field should indicate Configured, online. The devices Neuron chip condition consists of two parts: state and mode. Generally, the devices state is preserved across resets, whereas the mode is not. The additional states that may be displayed for a router are described below:

Applicationless, Unconfigured No application is loaded yet, the application is in the process of being loaded, or the application is deemed corrupted due to application error. The devices service LED is on but not blinking in this state. Unconfigured (with application) The application is loaded but the configuration is not loaded, is being loaded, or is deemed corrupted due to configuration error. The devices service LED blinks at a one second rate in this state. Configured, Online the normal device state. The devices application is running and the configuration is considered valid. This is the only state in which messages addressed to the application are received. In all other states, they are discarded. The devices service LED is off in this state. Configured, SoftOffline The application is loaded but not running. The configuration is considered valid in this state. A device that is in a softoffline state will go online when it is reset. The devices service LED is off in this state. Configured, HardOffline This is identical to a softoffline, except that the hardoffline mode is preserved after a reset.

Document Number 800263 Revision 3.7

347

Chapter 16 Testing and Verifying Devices The other fields contain diagnostic information as described below:

Last Reset Cause specifies the cause of the last reset. A reset is generally equivalent to power cycling the device. The cause of the reset can be any one of the following: Hardware Reset Occurs after a device/router has been commissioned. Powerup Occurs after the device has been power cycled. Software Reset Occurs after a reset command from a network management tool, or user interface. Watchdog Reset Three watchdog timers protect the Neuron chip processors against malfunctioning software or memory faults, one per processor. If application or system software fails to reset these timers periodically, the entire Neuron chip is automatically reset. Last Error Log indicates the last error encountered by the Neuron Chip. The error log will generally display an error code and message that can be used for troubleshooting purposes. Transmit Errors indicates the number of CRC errors detected by the device during packet reception. These errors may be due to collisions on the network, or noise on the transceiver input. Missed Messages specifies the number of times that an incoming packet was discarded because there was no network buffer available. This may be due to excess traffic on the channel, insufficient network buffers on the device, or the network buffers not being large enough to accept all packets on the channel, whether or not addressed to this device. Lost Messages specifies the number of times that an incoming packet was discarded because there was no application buffer available. This may be due to an application program being too slow to process incoming packets, insufficient application buffers, or excess traffic on the channel. If the incoming message is too large for the application buffer, an error is logged, but the lost message count is not incremented. Transaction Timeouts indicates the number of times that the device failed to receive expected acknowledgements or responses after retrying the configured number of times. These may be due to destination devices being inaccessible on the network, transmission failures because of noise on the channel, or if any destination device has insufficient buffers or receive transaction records. Receive Tx Full Specifies the number of times that an incoming packet was discarded because there was no room in the transaction database. This may be due to excessively long receive timers, or inadequate size of the transaction database.
6 Click Clear to specify that all counters and timers be cleared and reset to zero. 7 After a few moments, click Refresh. This action retrieves the network error statistics accumulators, the cause of the last reset, the state of the device, and the last error logged. This message is used after the device has been cleared, or reset. 8 Take note of all the values in the Status tab, and compare them with the values in the previous steps. 9 After approximately 5 seconds repeat steps. Have the status values changed? How have they changed?

348

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Testing and diagnosing a device


After a device is commissioned, a diagnostic test can be performed to test the operational state, as well as the communication link with the device. The diagnostic test can help determine the health of the device anytime during the devices life.
To test a device: 1 Log in as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that you want to diagnose or test and select the Subsystem Status document that contains the device. 3 Rightclick the device you want to test and diagnose, and choose Properties from the popup menu to display the properties dialog. When the device properties dialog is opened, Visual Integrator 3 sends a Query Status network diagnostic message to the device. This message retrieves the network error statistics accumulators, the cause of the last reset, the state of the device, and the last runtime error logged. This message is typically used after the device has been reset to verify that reset has occurred. 4 Select the Diagnostics tab as shown below:

5 The Current State field should indicate Configured, online. The devices Neuron chip condition consists of two parts: state and mode. Generally, the devices state is preserved across resets, whereas the mode is not. The additional states that may be displayed for a device are described below:

Applicationless, Unconfigured No application is loaded yet, the application is in the process of being loaded, or the application is deemed corrupted due to application error. The devices service LED is on but not blinking in this state. Unconfigured (with application) The application is loaded but the configuration is not loaded, is being loaded, or is deemed corrupted due to configuration error. The devices service LED blinks at a one second rate in this state.

Document Number 800263 Revision 3.7

349

Chapter 16 Testing and Verifying Devices

Configured, Online the normal device state. The devices application is running and the configuration is considered valid. This is the only state in which messages addressed to the application are received. In all other states, they are discarded. The devices service LED is off in this state. Configured, SoftOffline The application is loaded but not running. The configuration is considered valid in this state. A device that is in a softoffline state will go online when it is reset. The devices service LED is off in this state. Configured, HardOffline This is identical to a softoffline, except that the hardoffline mode is preserved after a reset.
6 Click Reset to issue a reset command to the router. The Current state should indicate Configured, online after a reset is issued to the router. The Reset command resets the router by sending the Reset network management command to both sides of the router to stop execution, stop all packet forwarding, set all temporary settings to their initial values, and restart the router application. If a router is reset while in a softoffline state, the router will be placed online after the reset. This action will also reset all counters back to zero, and cause the current state to be refreshed. If a device resets while a network management command is in progress (e.g. commissioning, or loading an application), the reset will likely manifest itself as either a communication problem or a transaction failure. When EEPROM writes are involved (e.g. loading an application), there is significant probability that a memory location being modified at the time of the reset will become corrupted. 7 Click SoftOffline. The Current State should indicate Configured, SoftOffline. The routers application is put in the offline state. This causes the router to stop forwarding packets. If the router was previously in the offline state, this has no effect. If a router is reset while Offline, the router will be placed Online after the reset. 8 Click Online. The Current State should indicate Configured, Online. The routers application is put in the online state. This allows the router to forward packets between its two channels. If the router was previously in the online state, this has no effect. 9 Click Test. After a few moments the Test Results field should indicate: The device has passed all tests. The Test button causes a communication and diagnostic test message to be sent to the router. The test results are indicated in the Test Results field. The test results often describe the operational and communication state of the router. 10 Click Wink. This causes the device to generate an application dependent audible or visible response such as flashing the Service LED. This command has an effect only if the device supports the Wink function. This can be useful for identification and testing purposes. 11 Click Refresh to determine the current state of the router again and refresh the Current State field

350

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Querying a Device
The Network Editor feature of Visual Integrator 3 provides the ability to query any device on the network. Querying a device verifies the physical device with the logical device in the LNS network database. This is useful when devices are mislabeled or are unknown to the operator.
To query a device on the network: 1 Log in as an operator with Network Management permission for the site. 2 Open the Customer/Site that you want to view and choose Network Editor from the toolbar 3 Rightclick the Site icon from the Network Editor tree view and choose Query Service Pin from the popup menu. A network management dialog is displayed:

4 Locate the physical device on the network and press its service pin. 5 If Visual Integrator 3 is properly connected to the network it receives the service pin message from the device and displays a message that indicates the associated device name found in the LNS network database.

Document Number 800263 Revision 3.7

351

Chapter 16 Testing and Verifying Devices

This page is left blank intentionally.

352

Document Number 800263 Revision 3.7

Chapter 17 Maintaining a Site and Network

LonWorks network may require maintenance over its lifetime. Regular checkups of network devices ensure that the control system is operating efficiently and properly, and provide diagnostics of potential control deficiencies before they become problems. A site, which consists of the LNS network database, the graphics files, and the schedule database information, typically does not require regular maintenance except for periodic backups as changes are made. The entire SQL database, which includes information about all operators, operator groups, customers, sites, trend, event and alarm data, should be backed up periodically, so that a recent backup is available in the event of hardware problems with the server. Visual Integrator 3 includes utilities to back up this information and to restore it after a failure has occurred. The backup can be configured to occur automatically or it can be performed on demand, as required. To preserve trend and event data for future review and analysis, archiving of the SQL database is recommended. Use Visual integrator 3 to create an archive and use Log Viewer to view the data in the archive. Common site and network maintenance tasks described in this chapter are: Resynchronizing device configuration properties and device templates Replacing network devices such as routers, repeaters, and control devices Upgrading or updating control and network devices Moving devices to another location on the network, both physical and logical changes Renaming or deleting devices Commissioning and uncommissioning devices Backing up the LNS network database Restoring the LNS network database from backup Backing up the site Restoring the site from backup Backing up the SQL database Archiving the SQL database

To perform these procedures the operator must have Network Maintenance permission for the site. Some procedures require that the operator is a Windows administrator user.

Document Number 800263 Revision 3.7

353

Chapter 17 Maintaining a Site and Network

Resynchronizing device configuration properties


When device configuration properties are different from the configuration properties as set in the LNS network database then they are made to match by resynchronizing them. This allows the device configuration properties to match the configuration properties in the LNS network database for future reference and possible future replacement.
To resynchronize device configuration properties: 1 Log in as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that includes the devices you want to resynchronize, and choose the Connect option. Ensure that the management mode is OnNet 3 Select the Subsystem Status document that contains the devices. 4 Select the device you want to resynchronize as follows: Method 1: Select one or more devices in a subsystem. Rightclick one of the selected devices and choose Resync CPs from the popup menu. Method 2: Select all devices in a subsystem by rightclicking in the blank space of the subsystem view. Choose Resync CPs from the popup menu. The Set Configuration Properties dialog is displayed:

5 Select the option as below:

Download current values to device: specifies that the configuration properties currently set for the device in the LNS network database are downloaded to the device. Upload current values from device: specifies that the configuration properties currently set in the device be uploaded to the LNS network database from the device. This option is possible if a previously configured device from a different network is added to the existing network. The values in the database need to be updated accordingly. Set device to default values: specifies that the default configuration properties stored in the device template be downloaded to the device. Set device template defaults from device: specifies that the current configuration properties set in the device be uploaded and saved as the new default configuration property values in the device template.

354

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Click OK when complete. The resynchronization procedure will proceed.

Replacing a device
You can replace a device without changing the configuration of the device. The old device may have failed or a new version of the device may have become available. Visual Integrator 3 allows you to replace a device while leaving the network configuration unchanged. The new device should have the same hardware characteristics as the old device, and must support the application version and external interface file as specified in the LNS network database. If the device or the information in the LNS network database needs to be upgraded or updated, see Updating a device later in this chapter before proceeding. Before replacing the device, a thorough investigation should be conducted to determine the cause of failure (if any).
To replace a device: 1 Replace the old device physically by installing the new device in the location of the old device. 2 Log in as an operator with Network Maintenance permission for the site. 3 Open the Customer/Site that includes the device you want to replace, and choose the Connect option. Ensure that the management Mode is Onnet. 4 Select the Subsystem Status document that contains the old device. 5 Select the devices you want to replace as follows: Method 1: Select one or more devices in a subsystem. Rightclick one of the selected devices and choose Replace from the popup menu. Method 2: Select all devices in a subsystem by rightclicking in the blank space of the subsystem view. Choose Replace from the popup menu. The Commission Wizard dialog is displayed. This dialog lists all the devices from those you selected that have the same device template. It allows you to specify the device template for these device(s):

6 Click Next to repeat the previous step until all selected devices are assigned a device template.

Document Number 800263 Revision 3.7

355

Chapter 17 Maintaining a Site and Network 7 The next Commission Wizard dialog is displayed:

8 This step allows you to identify the application image for devices with the same device template. The dialog lists all the devices from those you selected that have the same device template. It allows you to chose to download the application and to specify the location of the application file for these device(s):

Load Application Image: select this check box to have the application image file loaded into the listed device(s). The application image determines the behavior of the device. The device may contain the application as it was loaded by the manufacturer or it may be provided as a file that you download during the commissioning process. Image File: specifies the location of the image file to load into the devices
9 Click Next to repeat the previous step until all selected devices are assigned an application image. When complete, the next Commission wizard dialog is displayed:

10 This dialog lists all the devices you selected and allows you to specify the initial state after replacing and the source for the configuration properties to use during the replacing process. In the area labelled State, select the initial state of the device, where:

Offline: specifies that the device remains offline so that its application is not running. This option is typically used to bring up devices in an orderly fashion during commissioning. Resetting a device when in the Offline state puts the device into the Online state.

356

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Online: specifies that the device goes online so that its application is running after it is commissioned. Resetting a device when in the Offline state puts the device into the Online state. In the area labeled Source of Configuration Properties, select the initial values for the configuration properties, where: Current values in database: specifies the configuration properties currently set for the device in the LNS network database. If this option is selected for a new device the current values are the default values. Default values: specifies the default configuration properties stored in the device template. Current values in device: specifies the configuration properties already set in the physical device and uploads them to the LNS network database.
11 Click Next when complete, the next Commission wizard dialog is displayed:

12 This dialog lists all the devices you selected and allows you to specify the source of the Neuron ID to uniquely identify the device. If only one device is being commissioned and you select Manual, enter the devices Neuron ID in the field provided.

Service Pin: the identity of the device will be provided by pressing the devices service pin. Network Integrator reads the Neuron ID from the devices service pin message. Manual: the Neuron ID will be provided by manual entry. This can be advantageous if the devices are in a difficult to reach location or if you are commissioning many devices in a network installed over a large area. The devices Neuron ID is usually located with the devices bar code.
13 Click Finish. Visual Integrator proceeds to acquire the Neuron Ids, as described below.

Document Number 800263 Revision 3.7

357

Chapter 17 Maintaining a Site and Network

Service pin entry


14 If you are currently connected and OnNet (or OffNet) with the network and you specified to obtain multiple devices identity by pressing their service pins, you are prompted as follows:

Received: displays an incrementing count of the number of service pin messages received from devices that do not match the required program ID, when the Filter on Program Id check box is selected.
15 Locate and press the devices service pin. When each service pin is pressed, the Neuron ID appears on the list next to the device it was assigned to. The order you press the service pins is important. Network Integrator attempts to assign the Neuron ID automatically to a device with the same program ID it received in the service pin message, according the following rules: If more than one device qualifies, Network Integrator chooses the first qualified device in the list that does not already have an assigned Neuron ID. If none of the devices qualify and the Filter on program ID check box is selected, the service pin message is ignored. If none of the devices qualify and the Filter on program ID check box is not selected, Network Integrator chooses the first device in the list that does not already have an assigned Neuron ID. The dialog closes after the last service pin message is received or when Continue is clicked. The device replacing progress update dialog is displayed. The Status column reflects the outcome of the replacing process. Success means device has been replaced and loaded with the device application and its configuration properties synchronized. Other messages indicate why the replacing failed

Updating a device
Updating a device refers to upgrading the devices hardware characteristics, or updating the device with a new application program (*.apb, or *.nxe) and/or external interface file (*.xif), or both, or updating the devices LNS plugins. All of these tasks are generally done with a network management tool such as Circons Network Integrator 3 or Echelons LonMaker. You can also use the Network Editor feature of Visual Integrator 3.

358

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

New APB, old XIF To update a device with a new application, the new application program file (*.apb, or .nxe) must

be compatible with the current external interface file (*.xif). That is, the both files must have the same Program ID, the same number of network variables, same configuration properties, etc. Refer to the device manufacture release notes, or documentation for more detailed information on the compatibility of the devices program files.
New APB, new XIF If the existing device requires both a new application program and a new external interface to be

updated the device manufacturer will need to supply a new external interface file and a new application image file. In this case, the Program ID will be different and a new device template will be created bases on the latest files. For example, an existing Circon UHC300 series controller can be upgraded to its latest version using a new application program file (i.e. UHC300m03.apb), and a new external interface file (i.e. UHC300m03.xif). Refer to the device manufacture release notes, or documentation for more detailed information on upgrading the device.
New XIF, old APB To update a device with a new external interface, the new external interface file (*.xif) must be

compatible with the current application program file (*.apb, or *.nxe). That is, the both files must have the same Program ID, the same number of network variables, same configuration properties, etc. Refer to the device manufacture release notes, or documentation for more detailed information on the compatibility of the devices program files.
Hardware Upgrade Some devices may require some physical upgrade to the device itself (e.g. chip change). Refer to

the device manufacturers release notes, or documentation for more information.


Device PlugIns Some device manufacturers may include a new set of PlugIns to accompany improved, or

updated application, and external interface files. Refer to the device manufacturers release notes, or documentation for more information.
Updating a Device Before updating a device on the network, obtain and install the appropriate program and interface files, as well as any associated PlugIns for the device.

Document Number 800263 Revision 3.7

359

Chapter 17 Maintaining a Site and Network

Resynchronizing a device with its device template


Typically, after you have resynchronized a device template to resource files you should then resynchronize the device itself with the device template.
To resynchronize a device with its device template:

1. Select the device you want to resynchronize as follows:


Method 1: Select one or more devices in a subsystem. Rightclick one of the selected devices and choose Resynch to Device Template from the popup menu. Method 2: Select all devices in a subsystem by rightclicking in the blank space of the subsystem view. Choose Resynch to Device Template from the popup menu. The Resynch to Device Template dialog is displayed:

16 Select check boxes and click OK to resynch.

Moving a device
A device on a control network may need to be moved due to ongoing building configuration changes, or network changes. A device can be moved to a different channel on the network, or can be moved to a different subsystem on the network.

Moving to a new channel:


1 Do not physically move the device until instructed to do so in this procedure. 2 Log in as an operator with Network Maintenance and Network Management permissions for the site. 3 Open the Customer/Site that includes the device you want to move, and select the Connect option. Ensure that the management Mode is OnNet. 4 Select the Subsystem Status document that contains the old device. 5 Rightclick the device you want to move.

360

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Choose Change Channel from the popup menu. The Change Channel dialog is displayed:

7 Set the parameters for the move as described below.

Original Channel: specifies the name of the current channel. This field is disabled if you are using drag and drop to move the device. Destination Channel: specifies the name of the destination channel. This field is disabled if you are using drag and drop to move the device. State After Move: specifies the state of the replacement device after it has been replaced. Setting the device to Offline stops the device application from running. This option is typically used to bring up devices in an orderly fashion during commissioning. Setting the device to Online allows the device application to run. The Restore option indicates that moved devices would be restored to their original online/offline state. If a device is power cycled or reset as part of the move, this information is lost, and the device will be put Online.
8 Click OK. If you are moving a commissioned device then the next Move dialog is displayed,

otherwise the device move operation is completed.

9 Click OK after the device has been moved and connected to the destination channel. Visual Integrator 3 will indicate the move status of the device.

Document Number 800263 Revision 3.7

361

Chapter 17 Maintaining a Site and Network

Renaming a device
A device on a control network may change the area to which it serves due to ongoing building configuration changes, or network changes. A device can be renamed to reflect the new area to which it serves. This task is generally done with a network management tool such as Circons Network Integrator 3 or Echelons LonMaker. You can also use the licensed Network Editor feature of Visual Integrator 3.

Deleting a device
A device on a control network may no longer be required due to ongoing building configuration changes, or network changes. This task is generally done with a network management tool such as Circons Network Integrator 3 or Echelons LonMaker. You can also use the licensed Network Editor feature of Visual Integrator 3.

Commissioning a device
After devices are defined (added) in the network database you need to commission them. : For a full description of this procedure, see the Network Integrator User Guide, Chapter 11.
To commission a device: 1 Log in as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that includes the device you want to commission, and choose the Connect option. Ensure that the management Mode is Onnet. 3 Select the Subsystem Status document that contains the device. 4 Select the devices you want to commission as follows: Method 1: Select one or more devices in a subsystem. Rightclick one of the selected devices and choose Commission from the popup menu. Method 2: Select all devices in a subsystem by rightclicking in the blank space of the subsystem view. Choose Commission from the popup menu. 5 Follow the dialogs to completion. For a full description of these dialogs, see the Network Integrator User Guide, Chapter 11.

362

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Decommissioning a device
The decommission process completely uninstalls a device by unconfiguring it and may or may not remove its Neuron ID from the network database. This is useful when you are making changes to your network and need to temporarily uninstall devices or when you are troubleshooting.
To decommission a device: 1 Log in as an operator with Network Maintenance permission for the site. 2 Open the Customer/Site that includes the device you want to decommision, and choose the Connect option. Ensure that the management Mode is Onnet. 3 Select the Subsystem Status document that contains the device. 4 Select the devices you want to commission as follows: Method 1: Select one or more devices in a subsystem. Rightclick one of the selected devices and choose Decommission from the popup menu. Method 2: Select all devices in a subsystem by rightclicking in the blank space of the subsystem view. Choose Decommission from the popup menu. 5 Follow the dialogs to completion. For a full description of these dialogs, see the Network Integrator User Guide, Chapter 11.

Backing up a network database


Every LNS network database must be backed up before, during and after the installation and commissioning phase. This procedure is vital to ensure data and network recovery in the event of failure, or deletion. You can use Visual Integrator to create a backup of your LNS network database. This backup is formatted to be compatible with both Circons Network Integrator and Echelons LonMaker network integration tools for LNS Turbo Edition. You can create the backup manually or use Task Scheduler to run the Circon Site Backup task to create the backup automatically. The manual method allows you to backup only one LNS network database and store the backup file on the local disk drive at a location you choose. The manual method requires that you eliminate contention by stopping all Visual Integrator services that may be running, such as the data logger or alarm logger services, and by disconnecting all LNS applications. The automatic method allows you to backup multiple LNS network databases. For each site that is backed up, the backup file is stored in the site folder, in a folder named "backup", on the local disk drive. As well, the backup file can be transferred to a FTP site location. The Circon Site Backup task makes two attempts to back up the LNS database. Firstly, the task attempts to create the backup using the same method as the manual method, which requires all services and LNS applications to be stopped. Secondly, if the first attempt fails due to file contention, the second

Document Number 800263 Revision 3.7

363

Chapter 17 Maintaining a Site and Network

attempt uses the LNS Turbo hot backup method which does not require services and LNS applications to be stopped. However, this method establishes a network connection. Alternatively, a backup of the network database is part of a complete site backup, described later in this chapter.
To backup an LNS network database using the manual method: 1 Log in as an Administrator operator. 2 Use the Service Manager utility and stop all Visual Integrator 3 services that may be running such as the data logger or alarm logger services. 3 From the Visual Integrator 3 toolbar, open the Site Management utility and navigate to the customer / site you want to backup. 4 Doubleclick on the site to display the site properties. Select the LNS tab. 5 Click Create Backup to begin the backup procedure. A dialog as follows is displayed. Click Browse to set the location where you want the backup to be stored, and then click Next.

6 The Export Progress dialog is displayed. If you see a message as shown below, you may not have stopped all the Circon services, or another application that uses this LNS database is still running. Click Cancel and fix the problem.

364

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 7 The Export Progress dialog displays the successful completion message. Click Finish.

8 Transfer, or copy the network database backup to movable media storage. Mark the site name and the date of the back up on the storage media for tracking purposes and store the back up copy of the LNS network database in a safe location for future use. To backup an LNS network database using the automatic method: 1 Log in as an Administrator operator and as a Windows user with Administrator permissions. 2 From the Visual Integrator 3 toolbar, open the Site Management utility and navigate to the customer / site you want to backup. 3 Doubleclick on the site to display the site properties. Select the Backup tab as below:

4 Click LNS Database Only in the Type of Backup area. 5 To save the backup file to the local hard drive, select Back up the site to site folder in the File Backup area. The Location box displays the path to the folder where the backup file will be stored.

Document Number 800263 Revision 3.7

365

Chapter 17 Maintaining a Site and Network 6 To save the backup file to an FTP site, perform the previous step, then select Backup site using FTP in the FTP Backup area. Specify the location, user and password for the FTP site. Location must a complete URL of the form: ftp.abc.com/foldername. 7 Click OK 8 Repeat above steps for each site LNS database you want to back up automatically and close Site Management. 9 From the Visual Integrator menu, select Tools > Schedule Tasks. The Task Scheduler dialog is displayed. 10 Select the Circon Site Backup task and click Schedule. The Circon Site Backup schedule dialog is displayed. 11 Configure the task schedule. 12 From the Task Scheduler, click OK to add the task to the Circon Task Scheduler list and the Windows Scheduled Tasks list.

Restoring a network database from LonMaker backup


As mentioned in the previous section, every LNS network database must be backed up during and after the installation and commissioning phase. This procedure is vital to ensure data and network recovery in the event of failure, or deletion. If the LNS network database was originally created, configured, and backed up using Network Integrator 3 or LonMaker via a LonMakercompatible backup file, the database can be restored using the procedure described here. If the LNS network database was originally created, configured, and backed up using a different network management tool that does not support the LonMaker backup format, the database will need to be restored according to the network tools database restoration procedure. Refer to the network tools documentation for more detailed information on backing up and restoring the LNS network database. Restoring a network database means using a backup to refresh a network already known to Visual Integrator 3, that is already in the LNS Server Global database.
To restore a network database from a backup file in LonMaker format: 1 Close all applications that have the database open. 2 Log in as an Administrator operator. Do not connect to the site. 3 Shut down all Circon services and the Echelon LNS Server. To do this, use the Circon Services Manager. 4 From the Visual Integrator 3 toolbar, open the Site Management utility and navigate to the site you want to restore.

366

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 5 Doubleclick on the site to display the site properties. Select the LNS tab. The network name is displayed in the box labelled Network Name.

Document Number 800263 Revision 3.7

367

Chapter 17 Maintaining a Site and Network 6 Click Restore Backup to begin the restore procedure. A dialog, as shown below, is displayed. Click Browse to set the location of the backup file. 7 Type the name of the network you want to restore. It must be the same name as displayed in the site properties, as shown below.

8 A confirmation prompt is displayed. Click Yes.

IMPORTANT: If this confirmation prompt was not displayed, you did not type the LNS network name correctly. The database was restored to whatever name you typed in. Repeat this procedure and be certain to type the database name correctly.

368

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 9 The database restore completes successfully as follows:

10 Click Finish and close the site management utility. When you open the site, the restored database is used.

Backing up a site
Every site must be backed up during and after the installation and commissioning phase and whenever changes are made to the sites HMI. This procedure is vital to ensure its recovery in the event of failure or accidental deletion. You can use Visual Integrator 3 to create a complete site backup. The site backup file is in a Zip format that can be transferred to another computer where a new site based on the backup can be created using the complementary site Restore function. Restore does not allow you to merge the backup site with an existing site. Site backup creates a backup of the following information: Sites LNS network database in LonMakercompatible format Visual Integrator 3 graphics files associated with the site Visual Integrator 3 schedule database information associated with the site

You can create the backup manually or use Task Scheduler to run the Circon Site Backup task to create the backup automatically. The manual method allows you to backup only one site and store the backup file on the local disk drive at a location you choose. The manual method requires that you eliminate contention by stopping all Visual Integrator services that may be running, such as the data logger or alarm logger services, and by disconnecting all LNS applications. The automatic method allows you to backup multiple sites. For each site that is backed up, the backup file is stored in the site folder, in a folder named "backup", on the local disk drive. As well, the backup file can be transferred to a FTP site location. The Circon Site Backup task makes two attempts to back up the LNS database. Firstly, the task attempts to create the backup using the same method as the manual method, which requires all services and LNS applications to be stopped. Secondly, if the first attempt fails due to file contention, the second attempt uses the LNS

Document Number 800263 Revision 3.7

369

Chapter 17 Maintaining a Site and Network

Turbo hot backup method which does not require services and LNS applications to be stopped. However, this method establishes a network connection.
To create a site backup using the manual method: 1 Log in as an Administrator operator. 2 Use the Service Manager utility and stop all Visual Integrator 3 services that may be running such as the data logger or alarm logger services. 3 Open Site Management, choose the Customer and open the Sites folder to list the sites in the list pane. 4 Rightclick on the site you want to back up and choose Create Backup from the popup menu. 5 The Create Site Backup dialog is displayed:

6 Type or browse to choose a location for the backup file, and then click Next. 7 The Export Progress dialog is displayed. If you see a message as shown below, you may not have stopped all the Circon services, or another application that uses this LNS database is still running. Click Cancel and fix the problem.

370

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 8 The Export Progress dialog displays the successful completion message. Click Finish.

9 Transfer, or copy the site backup to movable media storage. The backup file name is the site name with a .zip extension. Mark the site name and the date of the back up on the storage media for tracking purposes and store the back up copy of the site in a safe location for future use. To backup a site using the automatic method: 1 Log in as an Administrator operator and as a Windows user with Administrator permissions. 2 From the Visual Integrator 3 toolbar, open the Site Management utility and navigate to the customer / site you want to backup. 3 Doubleclick on the site to display the site properties. Select the Backup tab.. 4 Click Entire Site including LNS Database, Graphics and Schedules in the Type of Backup area. 5 To save the backup file to the local hard drive, select Back up the site to site folder in the File Backup area. The Location box displays the path to the folder where the backup file will be stored. 6 To save the backup file to an FTP site, perform the previous step, then select Backup site using FTP in the FTP Backup area. Specify the location, user and password for the FTP site. Location must a complete URL of the form: ftp.abc.com/foldername. 7 Click OK 8 Repeat above steps for each site you want to back up automatically and close Site Management. 9 From the Visual Integrator menu, select Tools > Schedule Tasks. The Task Scheduler dialog is displayed. 10 Select the Circon Site Backup task and click Schedule. The Circon Site Backup schedule dialog is displayed. 11 Configure the task schedule. 12 From the Task Scheduler, click OK to add the task to the Circon Task Scheduler list and the Windows Scheduled Tasks list.

Use the Windows Event Viewer to verify that the task ran properly.

Document Number 800263 Revision 3.7

371

Chapter 17 Maintaining a Site and Network

Restoring a site from back up


As mentioned in the previous section, every site should be backed up after the installation and commissioning phase. This procedure is vital to ensure site recovery in the event of failure or deletion. The site backup file is in a Zip format created using the Visual Integrator 3 site backup procedure described earlier in this chapter. A site back up can be transferred to another computer where a new site based on the back up can be created using the Restore procedure described below. Restore does not allow you to merge the backed up site with an existing site.
To create a new site by restoring a site backup: 1 Log in as an Administrator operator. 2 Use the Circon Service Manager and stop all Visual Integrator 3 services that may be running such as the data logger or alarm logger services. 3 Open Site Management, choose the Customer and open the Sites folder to list the sites in the list pane. 4 Rightclick anywhere in the pane away from the list of sites and choose Restore Site from the popup menu. 5 The Restore Site Backup dialog is displayed:

6 Type the site name and select or enter the location of the backup file you created using the Visual Integrator 3 Site backup utility. Click Next to proceed.

372

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 7 The Restore LonMaker Backup dialog is displayed:

8 Type the name for the new network, exactly the same as the name of the database that was backed up. See Restoring a network database from LonMaker backup before completing this step. 9 Select or type the location of the LNS database. The recommended path is shown in the dialog above. Click Next to proceed. 10 The Import Progress dialog is displayed:

11 Click Finish to complete the restore operation. 12 Open the site property dialog and configure the network interface and the permissions to complete the site, as described in Chapter 3 Working with Customers and Sites.

Document Number 800263 Revision 3.7

373

Chapter 17 Maintaining a Site and Network

Maintaining the SQL database


In the event of software or hardware problems, it is important to have a recent backup copy of your SQL database. Visual Integrator includes utilities to back up this information and to restore it, if necessary, after a failure has occurred. A backup is a set of files that contain a complete copy of the entire Circon SQL database. As well, you may want to retain copies of the logged data portion of the SQL database to provide a historical archive to which you can refer in the future, should the need arise. Visual Integrator includes a utility to create an archive of this information. An archive is a complete copy of the SQL database with logged data records that are more recent than a specified age deleted from it. An archive is used to retain old data in a way that it can be accessed later, without using possibly limited capacity in the working SQL database. The logged data in an archive can be viewed using Log Viewer. You may also need to delete old data from the SQL database to manage the hard disk space usage. Visual Integrator includes a utility to purge this information. Purging logged data permanently removes (deletes) it from the working SQL database alarm log, event log and system log. All of these utilities: backing up, archiving and purging, are performed by scheduling the appropriate task, using the Visual Integrator Task Scheduler. Tasks run in the background at their appointed time, using the Windows Scheduled Tasks utility. With Task Scheduler and Windows Scheduled Tasks, you can schedule any Circon back up, archive or purge task to run at any time that is convenient. You can also:
Schedule a task to run once, daily, weekly, monthly, or at certain times such as system startup. Change the schedule for a task Customize how a task will run at its scheduled time

Backing up the SQL database


You use Task Scheduler to run the Circon SQL Database Backup task to create the backup automatically. Use the Restoring the SQL database procedure to restore a backup to the SQL Server. Note: SQL database backup files remain on the computers hard drive until you move them to the removable backup medium, a network drive or delete them. The filename for the backup is the date and time when the backup was made.

374

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide To configure an SQL database backup: 1 Log in to Windows as a member of the Administrators group and then to Visual Integrator as a member of the Administrators group. 2 From the Visual Integrator menu, select Tools > Schedule Tasks. The Task Scheduler dialog is displayed. 3 Select the Circon SQL Database Backup task and click Schedule. The Circon SQL Database Backup schedule dialog is displayed: 4 Configure the task schedule. 5 From the Task Scheduler, click Properties to set the folder location where the backups are saved to a folder on a local disk. Use Browse or type the location directly. Note: The location must be on a local disk on the server computer. If the location is set to a network drive or share on another computer, the backup will fail. 6 From the Task Scheduler, click OK to add the task to the Circon Task Scheduler list and the Windows Scheduled Tasks list.

Restoring the SQL database from backup


An SQL database backup is restored using the RestoreDb application provided with Visual Integrator 3. RestoreDb is a standalone application that you run only when all applications using the SQL Server are shutdown.
To restore the SQL database from backup: 1 Use the Circon Service Manager to stop all Circon services. 2 Shut down Visual Integrator 3 and any other Circon applications such as Network Integrator 3 and Access Integrator 3. 3 Navigate to the location of RestoreDb which is C:\\Program Files\Circon\BIN\RestoreDb and start the RestoreDb application. The Circon SQL Restore dialog is displayed:

4 Select the SQL database backup file you want to restore. The filename of the backup file indicates the date and time it was created. Click Refresh to update the list of backups. 5 Click Restore to begin the database restore operation. If the restore operation cannot be completed, an error message is displayed:

Document Number 800263 Revision 3.7

375

Chapter 17 Maintaining a Site and Network

This error message indicates that an application that uses the SQL server is running. Refer to Steps 1 and 2 of this procedure. When you are sure all applicable applications are shutdown, click OK to close the error message and then continue the procedure at step 4. 6 When the restore operation completes success fully, a confirmation dialog is displayed:

7 Now, when you start Visual Integrator 3, the information displayed is that of the backup you restored.

Archiving the SQL database


You archive logged data to remove older records from the working SQL database and save that data for later review and analysis. You use Task Scheduler to run the Circon SQL Database Archive task to create the archive automatically. This task also purges the older logged data from the working SQL database after the archive is completed. In summary, the archive task performs these actions:
Create the archive database which is a complete copy of the working database Purge the working database of all logged data records older than the specified age Purge the archive database of all logged data records more recent than the specified age

The result is that no logged data records are duplicated between the archive and the working database. You use Log Viewer to view logged data in an archive and run queries on the logged data
To configure an SQL database archive: 1 Log in to Windows as a member of the Administrators group and then to Visual Integrator as a member of the Administrators group. 2 From the Visual Integrator menu, select Tools > Schedule Tasks. The Task Scheduler dialog is displayed. 3 Select the Circon SQL Database Archive task and click Schedule. The Circon SQL Database Archive schedule dialog is displayed: 4 Configure the task schedule. 5 From the Task Scheduler, click Properties to set the folder location where the archives are saved to a folder on a local disk. Use Browse or type the location directly. You also specify the age of the logged data records you want to include in the archive.

376

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide Note: The location must be on a local disk on the server computer. If the location is set to a network drive or share on another computer, the backup will fail. 6 From the Task Scheduler, click OK to add the task to the Circon Task Scheduler list and the Windows Scheduled Tasks list.

Purging logged data from the SQL database


When you are sure old logged data in the system logs, event log and alarm log are no longer needed, or if you are concerned the SQL database or hard drive may have too little space remaining, you can delete (or purge) logged data from the SQL database. Purging logged data permanently removes it from the working SQL database alarm log, event log, trend log, runtime log and system log. Alternatively, if you want to keep a copy of this information, you should create an archive of this data rather than purging it.
To purge logged data: 1 Log in to Windows as a member of the Administrators group and then to Visual Integrator as a member of the Administrators group. 2 From the Visual Integrator menu, select Tools > Schedule Tasks. The Task Scheduler dialog is displayed. 3 Select the Circon SQL Database Purge task and click Schedule. The Circon SQL Database Archive schedule dialog is displayed: 4 Configure the task schedule. 5 From the Task Scheduler, click Properties to specify the age of the logged data records to purge. 6 From the Task Scheduler, click OK to add the task to the Circon Task Scheduler list and the Windows Scheduled Tasks list.

Managing and troubleshooting scheduled tasks


The Visual Integrator Task Scheduler essentially replicates the essential functions of Windows Scheduled Tasks. You can use the full power of Windows Scheduled Tasks to manage and troubleshoot scheduled tasks. To learn about the Windows Scheduled Tasks capabilities, see Windows Scheduled Tasks help. To start Windows Scheduled Tasks, click start > All Programs > Accessories > System Tools > Scheduled Tasks. Help is available from the Help menu. The Advanced menu offers several management commands. To confirm that tasks run as expected, view the log file by selecting Advanced > View Log from the menu. Alternatively, view the Windows Event Log by clicking start > All Programs > Administrative Tools > Event Viewer ands choosing Application Log.

Document Number 800263 Revision 3.7

377

Chapter 17 Maintaining a Site and Network

Copying the SQL database to another computer


To copy the SQL database to another computer, follow this procedure. The term "target computer" is the computer the database is being copied to. Copying the SQL database does not change the original database. This procedure is performed only when the SQL database server is not running. When it is not running, it is not available for any applications or services. The target computer must have the same version of Visual Integrator installed as the original computer.
To copy the SQL database to another computer: 1 Log in to windows as a member of the Administrators group on both the original and target computers. 2 Close all Circon applications on both the original and target computers. 3 On the original computer start menu, open Circon Service Manager: Start > All Programs > Circon > Access Integrator > Circon Service Manager. 4 Select SQL Server (CIRCON) and click Stop. Stop all dependent services, if any, when prompted. Close Circon Service Manager. 5 Repeat the previous two steps on the target computer. 6 On the original computer, navigate to the location of the SQL database files: C:\Program Files\Circon\DATA\DB and copy these two files: circon.mdf and circon.ldf to the same location on the target computer. 7 On the original computer, restart the SQL Server and any other services, using Circon Service Manager. 8 On the target computer, restart only the SQL Server, using Circon Service Manager. 9 On the target computer, navigate to C:\Program Files\Circon\BIN and run InstallDb.exe. The Installing Circon database message is displayed while the database is being installed. When this message disappears, the target computer is ready to be used.

378

Document Number 800263 Revision 3.7

Chapter 18 Setting up Visual Integrator 3 as server and workstations

isual Integrator 3 server and workstation allow additional Visual Integrator 3 operators to work with the site at the same time. A workstation operator has virtually the same capabilities as an operator logged in to the Visual Integrator 3 server computer. Typically, a workstation is used to add access to the site for casual operators. The Visual Integrator 3 server computer does the heavy lifting. It hosts and runs the systems SQL database, the Circon services that gather alarms, trends and event data from the network devices, and the LNS server where the network database resides. The Visual Integrator 3 workstation interacts with the SQL database and the LonWorks network devices on the server remotely over a common TCP/IP network. The following illustration shows a typical usage of Visual Integrator 3:

All workstations and the Visual Integrator 3 server must reside on the same network domain.

Document Number 800263 Revision 3.7

379

Chapter 18 Setting Up Visual Integrator 3 as server and workstations

Visual Integrator 3, the SQL database and the LNS server must already have been installed and the site must have been configured. See Chapter 3 Working with Customers and Sites for that information. Visual Integrator 3 workstation also links to the sites operator interface files on the server computer that you developed using Visual Integrator 3. The following sections provide a stepbystep procedure for setting up Visual Integrator 3 server and workstations.

Main steps in setting up Visual Integrator 3 workstation


1 2 Complete the tasks in section A, outlined below. Complete the tasks in section B, outlined below.

A. Configuring the server computer


1 2 3 4 5 6 Configure the Visual Integrator 3 server for file and database sharing Create the Role key in the server registry Add workstation names to Visual integrator 3 Configure the server to start the LNS server automatically Set LNS server access permissions to allow workstations to gain access to the network database Add workstation users to Windows Administrators group on server

B. Configuring the workstation computer


1 2 3 4 5 6 Install Visual Integrator 3 on the workstation Set up the connection from the workstation to the server SQL database Create the Role key in the workstation registry Configure site to match the server. Configure the Alarm Client service Install plugin software as required on the workstation.

380

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring the server computer


The steps following detail the procedure to configure the server computer to work with one or more Visual Integrator 3 workstations.

Step A1 configuring the server for LNS file and database sharing
On the Visual Integrator 3 server, file and database sharing is set up to allow workstations to access information. Each workstation connected to the Visual Integrator 3 server computer has to be added as allowed to read/write to the files in the LNS database directories.
To set up a shared LNS database directory and its authorized operators 1 Start the server computer and ensure that it connects on the same Windows network domain as the workstation computers. 2 Launch Windows Explorer: rightclick Windows Start and select Explore from the popup menu. Select Tools > Folder Options. Select the View tab and in the Advanced settings list, select Use simple file sharing. 3 Navigate to the folder that holds the LNS network database. This folder is typically created by the network management tool that created the LNS network database. By default, Circons Network integrator 3 names this folder C:\NI; Echelons LonMaker names this folder C:\Lm 4 Rightclick that folder and choose Properties from the popup menu. Select the Sharing tab:

5 Click Share this folder.

Document Number 800263 Revision 3.7

381

Chapter 18 Setting Up Visual Integrator 3 as server and workstations 6 Click Permissions. The Share Permissions dialog is displayed:

7 To add Windows users whom you want to access the server from a workstation, click Add. The Select Users, Computers or Groups dialog is displayed. 8 Select the users and click Add to move them to the lower list box. Click OK when you have selected the users. 9 The Share Permissions dialog is displayed again. Highlight a user in the upper pane and in the lower pane select Full Control in the Allow column. Repeat for all other users you added in the previous step.

The Visual Integrator 3 server is now set up to share all files and folders in the LNS database directory. These Windows users have full read and write permissions for these files and all LNS databases on the server computer.

Step A2 creating the Role key in the server registry


Visual Integrator 3 evaluates the setting of a registry entry to determine whether or not it should act as the server. The Role key must be added to the Windows Registry and its value set to allow Visual Integrator 3 to act as the server, rather than a workstation.
To create a registry entry and set it for Visual Integrator 3 server: 1 Close Visual Integrator 3. 2 From the Windows Start menu, select Run and type regedit to open the Registry Editor. 3 In the Registry Editor treeview, expand HKEY_LOCAL_MACHINE. 4 Expand SOFTWARE. 5 Expand Circon Systems Corporation.

382

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Select the Shared folder:

7 To create a new key, choose Edit > New > DWORD Value. Type Role for this keys name.

8 Rightclick Role and choose Modify from the popup menu. The Edit DWORD Value dialog is displayed. Type 1 in the Value data box to identify this computer as being the Visual Integrator 3 server.

Document Number 800263 Revision 3.7

383

Chapter 18 Setting Up Visual Integrator 3 as server and workstations 9 Click OK and close Registry Editor.

Step A3 adding workstation names to Visual integrator 3


Visual Integrator 3 server must know the names of all workstations that may be used to access its SQL database. Before you complete this procedure, you must have previously created the Role key and set it for Visual Integrator 3 server.
To add a workstation to Visual integrator 3 server: 1 Start Visual Integrator 3 and log in as a member of the Administrators group 2 Open Site Management and select Workstations. The workstations folder is displayed only after the Windows registry Role key is configured to make the computer you are working on to be a Visual Integrator 3 server. 3 Rightclick in the righthand pane and choose New Workstation from the popup menu. The New Workstation dialog is displayed. 4 Type the name of a workstation computer that you want to use to access this server. To find the name of the computer, go to that computers desktop, rightclick on My Computer and select Properties. Select the Network Identification tab. The computer name is the first part of the Full computer name before the domain extension. 5 Repeat these steps for additional workstations.

Step A4 configuring the server to start the LNS server automatically


To allow Visual Integrator 3 on a workstation to connect to the LNS network database and gain access to the network devices, the LNS Server, a software program provided by Echelon, must be running on the server. There are two approaches for starting the LNS Server: automatically and coordinated by Visual Integrator 3, or separately from Visual Integrator 3 using the Echelonprovided utility. When you are using the Visual Integrator 3 alarm and event logging services, you must also use Visual Integrator 3 to start the LNS Server service. This approach ensures that all services are started in an orderly manner and problems connecting to the network database are minimized. If you are not using alarm or event logging services, then use the Echelonprovided utility to start the LNS Server. Both approaches are described below.
To start the LNS Server with alarm and event logging, using Access Integrator 3: 1 On the Visual Integrator 3 computer with the LNS Server, close the site and use the Circon Service Manager to stop the Local Synchronization Service. This also stops the alarm logging and event logging services. 2 Start Site Management and open the site properties, selecting the Services tab.

384

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 3 Select either or both of Enable Alarm Logging and Enable Data Logging check boxes, then select the Launch LNS Server check box.

4 Click OK then close Site Management. 5 Use the Circon Service Manager to start the local alarm logging and local data logging services. The LNS Server service is also started. Review entries in the Application log to verify that all services started.

If you check Automatic Startup in Services Manager for the Local Synchronization Service then the LNS Server is started automatically when the computer restarts.
To start the LNS Server using the utilities provided by Echelon: 1 Close the site. 2 On the Visual Integrator 3 computer with the LNS Server, click Start > Programs > Echelon LNS Utilities > LNS Server. The LNS Server starts and the Open Network dialog is displayed. Select the network you want to open and click OK. 3 The Network Interfaces dialog is displayed. The Network Interfaces dialog displays all network interfaces that have been configured on the LNS server computer. Select the network interface that the LNS Server uses to connect to the site network, as configured on the site properties LNS tab. 4 Click OK when complete. The LNS Server viewer displays status information for the site network.

5 The Management Mode of the open database must be OnNet to be accessible by the remote full client(s). From Utilities choose Management Mode. Click the Set the Management Mode ONNET option and click OK to complete.

IMPORTANT: The LNS Server must remain running to allow workstations to gain access to the site. You can minimize the dialog but do not close it. For more information on the features of the LNS Server, click Help from the LNS Server viewer.

Document Number 800263 Revision 3.7

385

Chapter 18 Setting Up Visual Integrator 3 as server and workstations

Step A5 set LNS server access permissions to allow workstations to gain access to the network database
To improve the security of access to the LNS server from computers on the TCP/IP network, you should set the remote lightweight client access permissions. These permissions determine which workstations can gain access the network. IMPORTANT: This step is optional. It is recommended that you leave the permission list empty to allow any workstations (remote lightweight clients) to access the LNS server, until you have completed the workstation and server configurations successfully.
To set the LNS access permissions for workstations: 1 Start Visual Integrator 3, log in as Administrator and open the site. 2 Rightclick on the site in tree view and choose Network Properties from the popup menu. Select the Permissions tab:

3 There are three components for each remote lightweight client: Client IP, Mask, and Permission. Click Add to add access permissions. The Access Permission dialog is displayed:

4 In the box labelled Client IP, type the IP address of the workstation computer that you want to grant access. In the box labelled Mask, type an IP mask. Various combinations of Client IP and Mask can be used to allow and deny groups of Client IPs, as described in the example below. 5 Select the Allow Access check box to grant access to the client IP address, or clear the Allow Access check box to deny access to the client IP.

386

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 6 Click OK. The Client IP is displayed in the Permissions tab:

The permissions are processed in the order they are listed. For example, to allow access to all addresses beginning with 204.191 except 204.191.176.110, set up the permissions as shown in the screen capture above: When a workstation attempts to access the LonWorks network over an IP network, the LNS server checks for access permission as follows: the IP address of the remote lightweight client is logically ANDed with the corresponding mask and compared to the Client IP. If they match, then the client is either granted or denied access, as specified by the Permission. Any number ANDed with 0 results in 0. Any number ANDed with 255 results in the number. For example, a client IP of 204.191.0.0, a mask of 255.255.0.0, and a permission of Allow grants access to all clients whose address starts with 204.191. A client IP of 204.191.176.110, a mask of 255.255.255.255, and a permission of Deny prevents access from 204.191.176.110. If there is any permission in this list then any client not specifically granted access would be denied. It is recommended that you set the last line of the list to Client IP: 0.0.0.0, Mask: 0.0.0.0, Permission: Allow or Client IP: 0.0.0.0, Mask: 0.0.0.0, Permission: Deny to control explicitly whether addresses which are in the list will be granted access or denied.

Step A6 opening ports through the Windows XP firewall


If the Windows XP firewall is running on the server, then some ports must be opened to allow the workstation to connect.Specifically, ports TCP 445, UDP 1433 and UDP 1434 must be opened and the LNS Server must be unblocked, using the procedures below.
To open TCP port 445: 1 From the servers Windows Start menu, select Run and enter firewall.cpl to open the Windows Firewall dialog. 2 Select the Exceptions tab. 3 In the area titled Programs and Services, select File and Printer Sharing. 4 Click Edit to open the Edit a Service dialog. 5 Select the TCP 445 check box.

Document Number 800263 Revision 3.7

387

Chapter 18 Setting Up Visual Integrator 3 as server and workstations 6 Click OK To open UDP port 1433: 1 From the servers Windows Start menu, select Run and enter firewall.cpl to open the Windows Firewall dialog. 2 Select the Exceptions tab. 3 In the area titled Programs and Services, Click Add Port to open the Add a Port dialog. 4 Type SQL send in the Name box. 5 Type 1433 in the Port number box. 6 Click UDP. 7 Click Change scope to open the Change Scope dialog. 8 Click My network (subnet) only. 9 Click OK To open UDP port 1434: 1 From the servers Windows Start menu, select Run and enter firewall.cpl to open the Windows Firewall dialog. 2 Select the Exceptions tab. 3 In the area titled Programs and Services, Click Add Port to open the Add a Port dialog. 4 Type SQL receive in the Name box. 5 Type 1434 in the Port number box. 6 Click UDP. 7 Click Change scope to open the Change Scope dialog. 8 Click My network (subnet) only. 9 Click OK To unblock the Echelon LNS Server: 1 From the servers Windows Start menu, select Run and enter firewall.cpl to open the Windows Firewall dialog. 2 Select the Exceptions tab. 3 In the area titled Programs and Services, select Echelon LNS Server. 4 Click OK

Step A7 adding workstation operators to the Windows Administrators group


The Windows user accounts on the workstation that are used to run Visual integrator 3 must be members of the Windows Administrators group or both the Windows Circon Users group and the Windows Users group on the server. Otherwise, the workstation is not able to open the SQL database. To add a Windows user to the Windows Administrators group, click Windows Start > Control Panel > User accounts. >> SERVER CONFIGURATION IS COMPLETE <<

388

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Configuring the workstation computer


The steps following detail the procedure to configure a workstation computer to work with a Visual Integrator 3 server.

Step B1 installing Visual Integrator 3 on the workstation


The prerequisites and procedure for installing Visual Integrator 3 can be found in the release notes provided on the product distribution CD. The same version must be installed on both the workstation and the server.

Step B2 setting up the connection from the workstation to the server SQL database
Each workstation must have a connection pointing to the servers SQL database. Otherwise, the local SQL database on the workstation is used and the operator cant access the system SQL database and the alarming and event data which resides on the server.
To set up the connection to servers SQL database 1 From the workstations Windows Start menu, select Run and enter cmd to open the Command Prompt utility. 2 Type cd c:\program files\circon\bin and press the Enter key. 3 Type this command:

setconnect "Trusted_Connection=YES;Provider=SQLOLEDB;Server=<server computer name>\Circon;Database=Circon"

and press the Enter key. for example: setconnect "Trusted_Connection=YES;Provider=SQLOLEDB;Server=qatestxp\Circon;Dat abase=Circon"

Step B3 creating the Role key in the workstation registry


The workstation must have a role entry created in its registry with the value set such that it knows it is a client to the servers SQL database.
To add a workstation registry entry and set it for server SQL database On the workstation computer, follow the procedure described earlier in this chapter in Server: creating the Role key in the server registry.

IMPORTANT: For a workstation, set the Role key to 2, not to 1 for a server.

Document Number 800263 Revision 3.7

389

Chapter 18 Setting Up Visual Integrator 3 as server and workstations

Step B4 configuring site to match the server


A site must now be configured on the workstation to allow access to the same site on the Visual Integrator 3 server, as a remote lightweight client. The LNS Server already must be running on the Visual Integrator 3 server.
To configure the site on the workstation 1 On the workstation, start Visual Integrator 3 and log in using the Administrator username and password. If you logged in successfully to Visual Integrator on the workstation, then you are viewing the customers, and sites from the server computer. This means you have completed previous steps successfully. 2 From the toolbar, choose Site Management. 3 Add a Customer and Site using the same names as on the Visual Integrator 3 server. 4 Rightclick the site and choose Properties from the popup menu. 5 Select the LNS tab. 6 Select Remote Lightweight Client in the area titled LNS Server Access. 7 In the area titled Network name, click Add to add the remote network name. The Add Remote Network dialog is displayed. In the Remote LNS Network Name box, type the network name, and in the Server Address box, type the address, as described below: Remote LNS Network Name specifies the name of the LNS network corresponding to the system network. Use the same name that is used for this site on the Visual Integrator 3 server. Server Address specifies the unique network identification of the Visual Integrator 3 server, where the LNS server is running. There are two options that work here: the full computer name or the IP address. To determine the full computer name, rightclick My Computer on the Visual Integrator 3 server and choose Properties. The full computer name is displayed on the Computer Name tab. To determine the IP address, click Windows Start > Run > cmd on the Visual Integrator 3 server. In the Command window, type ipconfig to display the IP address.

Server Address using full computer name

Server Address using IP address

8 In the area titled Authentication Key, type the remote sites Authentication Key (12 hexadecimal characters). If authentication is not enabled for the remote site, use the default authentication key: FFFFFFFFFFFF. 9 Select the Permissions tab. 10 Click the Administrators operators group in the area titled Groups that can NOT access this site. 11 Click Add to add the Administrators group to the area titled Groups that can access this site.

390

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide 12 Click the plus sign in front of the Administrators group. The group expands to display the permissions available for this group. Verify that all permissions are selected. 13 Select the General tab and set the path to the files on the Visual Integrator 3 server. When you set this path, the workstation uses the same site files as the server. In the area titled Store files in, click Browse to display the Browse for Folder dialog. Navigate as required through the network to locate the Visual Integrator 3 server computer by name. To locate the site folder, open the shared folders on the server. Typically, the path is similar to: \\Aipcxp\NI\Files\ABC_Company\A_Bldg. This step depends on you having already set up the file sharing on the server, described in Configuring the server for file and database sharing. 14 Click OK. The path is displayed in the Store files in box. 15 Click OK to save and close the changed properties. 16 Test by attempting to open the site.

Step B5 configuring the Alarm Client service


To allow alarms to be viewed on the workstation Alarm Log Viewer, the Alarm Client service must be configured. If alarm display is not required at the workstation, then it is not necessary to perform this procedure.
To configure the Alarm Client service on the workstation: 1 Register the Alarm Client service with Windows as follows: click Start>Programs>Accessories>Command Prompt and navigate to C:\Program Files\circon\BIN. Type AlarmClient /service and press the Enter key.

2 Start the Alarm Client service and set it to run automatically at start up, as follows: click Windows Start > Control Panel. Open Administrative Tools and start Services. Rightclick the Circon Alarm Client entry and choose Properties. On the properties dialog, set Startup type to Automatic and click Start. Click OK. When configured to this step in the procedure, the Alarm Client service checks the servers SQL database for alarms once per minute. To improve the response time, a port in the firewall must be unblocked, as described in following steps. If you do not want to change how the firewall works, do not complete these steps. 3 For realtime alarm notifications to work with Windows XP Service Pack 2, the firewall must be turned off or UDP port 138 must be unblocked.

Document Number 800263 Revision 3.7

391

Chapter 18 Setting Up Visual Integrator 3 as server and workstations 4 To unblock UDP port 138, click Windows Start > Control Panel. Start Security Center and click Windows Firewall. On the Windows Firewall dialog, select the Exceptions tab. On the Exceptions tab, select the check box for File and Printer Sharing:

5 With File and Printer Sharing selected, click Edit to display the Edit a Service dialog. Select the UDP 138 check box to add this port to the list of excepted ports.

392

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Step B6 installing plugin software


If you want to allow workstation operators to launch device plugins then you must install the plugin software on the workstation; plugins cant be shared from the server.
To install LNS plugins on the workstation: 1 Install the plugin software on the workstation following the installation instructions provided by the manufacturer. 2 Start Visual Integrator 3, log in as Administrator and open the site. 3 Rightclick on the site in tree view and choose Network Properties from the popup menu. Select the Plugins tab of the Network Properties dialog. 4 The plugins you installed should be listed in the Not registered area. Select the plugin name you want to register from the Not registered area and click Add. The plugin name moves to the To be registered area. 5 Click Apply to start the plugin registration. When it is complete, click OK to close.

>> END OF WORKSTATION CONFIGURATION PROCEDURE <<

Document Number 800263 Revision 3.7

393

Chapter 18 Setting Up Visual Integrator 3 as server and workstations

This page left blank intentionally.

394

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Index
customizing translation 289

A
accelerator keys 78 acknowledging alarms 272 ActiveX properties of objects 84 adding See also creating, ActiveX controls from other manufacturers 79 administrative operator 331 alarm code 293 Button object 172 customer 28 DataPoint object 168 device document 178 document to a site 53 EnumPoint 198 floor plan 173 Functional Block Inspector document 180 hyperlink 185 Image object 165 Label object 167 NVAnimated object 194 object to document 73 operator 327 operator group 332 operators to operator group 333 schedule events 306 scroll bars 173 TimePoint object 170 TrendLog object 182 administrator default password 326 operator 326 operator group 326 alarm code about 268 associating sound with 278 creating 293

translation 288 Alarm Log Viewer about 266 acknowledging and clearing alarms 272 properties 270 viewing alarm details 269 viewing alarms 266 Alarm Notifier 277 Alarm Report document See document alarms about 243 acknowledge to operator group 275 acknowledging 272 Alarm Log Viewer 266 Alarm Notifier 277 Circon BASIC 251 CirconAlarm object 88 clearing 272 code 268 configuring site 256, 260 configuring SLTALink Manager 257 connectivity options 244 email notification of 279 hard drive space 294 Local Alarm Log service 264 local site alarm logging 18 logging to line printer 286 MAC300STA 243 message tag connections 253 network variable connections 251 notifications to operator group 280, 334 operator comments 321 pagers 243 priority 268 Remote Alarm Log service 265 remote site alarm logging 18 report 321 setting up alarm logging 250

Document Number 800263 Revision 3.7

395

Index

SMC300 243 SNVT_alarm, using 251 sound 278 state 267 timestamp 267 UNVT_alarm, using 251 viewing 266 aligning objects in document 76 animation See NVAnimated archive SQL database 376 autovalue 96, 105, 123

site 31 site for data logging 214 SLTALink Manager 36 SLTALink Manager for alarms 257 units of measure 159 connections, for alarms 251 connectivity options 9 control object See object copying object 74 creating See also adding, a report 319 custom device document 191 document template 53 event profile 232 HMI 161 runtime/startup profile 236 site 30 trend profile 222 customer adding 28 deleting 29 renaming 29

B
backup network database 363 site 369 SQL database 374 beeeeeep 18 bindings See connections Blank Graphic document See document Builtin document See document Button object adding 172 properties 84

D
data logging about 211 configuring interval 215 configuring network for 214 event profile 232 exporting data 231 introduction 45 Local Data Logger service 218 local site 18 main steps to set up 212 printing trend plot 231 Remote Data Logger application 219 Remote Data Logger service 220 remote site 18 runtime report 322 runtime/startup profile 236 startup counts report 322 trend plot 226 trend profile 222 viewing archived data 221 viewing logged data 221 viewing trend plot 230

C
cache monitored points 40 Checkbutton object properties 86 Circon Users group 327 Circon Web Site document See document CirconAlarm object properties 88 clearing alarms 272 code of alarms 268 configuring administrator permissions 44 alarm acknowledge to operator group 275 alarm logging for site 256, 260 alarm notifications to operator group 280 Alarm Notifier 277 cache monitored points 40 management mode 36 network database 34 network interface 32

396

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide DataLabel object properties 92 DataObject object properties 92 DataPoint object adding 168 properties 92 deleting customer 29 object in document 75 operator 329 operator from operator group 334 operator group 333 site 31 device commissioning 362 decommissioning 363 moving 360 query service pin 351 replacing 355 resynch to device template 360 resynchronizing configuration properties 354 state of 347 testing operation of 346 updating 358 device document adding 178 creating 191 creating custom template 199 Device document See also document, about 50 Device Inspector document See document DeviceStatus object properties 98 diagnosing device problems See testing device operation diagnosing network problems See maintaining a site/network document about 49 adding Alarm Report document 61 adding Blank Graphic document 60 adding device document 53 adding Device inspector document 56 adding Functional Block document 63 adding Functional Block inspector document 65 adding Link document 58 adding Notepad document 59 adding Schedule document 62 adding Schedule Report document 60 adding Subsystem Status document 57 adding to a site 53 Alarm Report document 51 Blank Graphic document 50 Builtin document type 51 categories of 49 Circon Web Site document 51 creating template 53 Device document 50 Device Inspector document 50 Document Wizard 205 editing template 52 font, default 53 Functional Block document 50 Functional Block Inspector document 50 graphic document type 51 Inspector 50 Link document 51 Notepad document 50 restoring 184 Schedule document 51 Schedule Report document 51 Subsystem document 50 target path 52 template 52 types 51 viewing template 52 Document Wizard about 205 main steps in using 205 dominant object 75 drawing order of objects in document 77 driver See network interface

E
EditBox object properties 101 editing document template 52 email address operator 330 email address 280 email alarm notification 279 EnumObject object

Document Number 800263 Revision 3.7

397

Index

properties 103 EnumPoint object adding 198 properties 103 event data See data logging event properties of objects 83 exporting data from report 323 logged data 231 schedule 313

Toolbar 70 window 68 GUI See HMI

H
help 24 hidden properties 69 HMI See also user interface, creating 161 tutorial 161 hyperlink, adding 185

F
floor plan, adding 173 font, default 149 Frame object properties 107 Functional Block document See document Functional Block Inspector document See document

I
i.LON 10/100 network interface 40 i.LON 1000 network interface 33 Image object adding 165 properties 108 setting extent 173 importing schedule 301 Inspector Device Inspector document 50 Functional Block Inspector document 50 Inspector object properties 111 integrity, device and network monitoring 262

G
global alarm translation 289 Graphic document See document Graphics Editor accelerator keys 78 adding ActiveX controls from other manufacturers 79 adding an object 73 aligning objects 76 copying an object 74 deleting an object 75 dominant object 75 drawing order of objects 77 hidden properties 69 how to use 67 Layout bar 73 make template 68 menu 68 moving an object 74 Object bar 71 opening a document 67 selecting an object 73 setting extent 173 sizing an object 75 Status bar 73 tab order of objects 77

L
Label object adding 167 properties 114 Layout bar 73 licensing options 7 Line object properties 117 Link document See document LNS Server access for Visual Integrator 3 32 Local Alarm Log service 264 local alarm translation 291 Local Data Logger service 218 local site defined 9 Log Viewer creating event profile 232 creating runtime/startup profile 236

398

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide creating trend profile 222 plotting trend data 226 using 221 viewing event data 232 viewing runtime/startup data 236 viewing trend data 226 logging , See also data logging alarms to printer 286 alarms, about 243 configuring site, alarm logging 256, 260 setting up alarm logging 250 management mode 36 menu Graphics Editor 68 Visual Integrator 3 23 message tag See alarms moving object in document 74 multiple sites, connecting to 10

N
nciSetpoints See NVSetpoint object network database automatic backup 365 backup 363 configuring 34 creating 35 manual backup 364 restoring 366 Network Editor about 339 online help 340 user guide 340 network interface configuring 32 defined 9 dialup iLON 43 dialup SLTA 36 i.LON 10/100 40 i.LON 1000 33 iLON 43 PCC10 33 PCLTA20 33 SLTA10 33 SMC300 36 network management tool See Network Editor Network Scheduler about 297 adding schedule events 306 creating a new schedule 300 deviceresident scheduling 297 downloading schedule 313 exporting a schedule 313 importing a new schedule 301 main steps in creating a schedule 299 PCresident scheduling 297 permissions 298 prioritizing schedule events 311

M
MAC300STA alarming 243 main steps configuring i.LON 10/100 network interface 40 creating a HMI 161 creating a schedule 299 creating a site 27 fully functional operator workstation 25 securing access to site 325 setting up alarm logging 250 setting up data logging 212 setting up email alarm notification 279 setting up line printer for alarms 286 using Document Wizard 205 maintaining a site/network See also testing device operation, archiving SQL database 376 backing up network database 363 backing up site 369 backing up SQL database 374 common tasks 353 deleting a device 362 moving a device 360 purging SQL database 377 renaming a device 362 replacing a device 355 restoring network database 366 restoring site from back up 372 restoring SQL database 375 resynchronizing configuration properties 354 updating/upgrading a device 358 make template 68

Document Number 800263 Revision 3.7

399

Index

report 322 schedule deployment 297 schedule event priority, defined 296 schedule event properties 296 schedule properties 303 schedule state, defined 296 scheduling concepts 295 synchronizing devices 313 verifying device synchronization 317 network variable connections See alarms normal properties of objects 83 Notepad document See document NVAnimated object adding 194 properties 118 NVDigital object properties 120 NVGauge object properties 126 NVSetpoint object properties 128 NVSlider object properties 131 NVSwitch object properties 134 NVTime object properties 134

Frame object 107 Image object 108 Inspector object 111 Label object 114 Line object 117 moving in document 74 normal properties 83 NVAnimated object 118 NVDigital object 120 NVGauge object 126 NVSetpoint object 128 NVSlider object 131 NVSwitch object 134 NVTime object 134 ObjectLabel object 134 PenPlot object 137 PlugIn object 139 PlugInButton object 141 RadioButton object 142 reference to properties 84 selecting in document 73 sizing in document 75 SwitchPoint object 144 tab order of 77 TheFrame/TheView object 149 TimePoint object 151 Timer object 154 TrendLog object 155 viewing properties 81 working with properties 81 Object bar 71 object properties, components of 82 ObjectLabel object properties 134 operator report 322 operator groups about 326 adding 332 adding operators 333 administrator group 326 alarm notification 280, 334 deleting 333 deleting operator 334 mandatory comments 275 renaming 333 report 322

O
object about 71 ActiveX properties 84 adding to document 73 aligning in document 76 button object 84 Checkbutton 86 CirconAlarm object 88 copying 74 DataLabel object 92 DataObject object 92 DataPoint object 92 deleting in document 75 DeviceStatus object 98 dominant object 75 drawing order of 77 EditBox object 101 EnumObject object 103 EnumPoint object 103 event properties 83 font, default 149

400

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide site permissions 336 operators about 325 adding 327 adding administrative operator 331 adding to operator group 333 Administrator 326 deleting 329 email address 280, 330 password 331 permissions 336 properties 329 renaming 329 overriding using DataPoint 93 using EnumPoint 103 using NVDigital 121 using SwitchPoint 145 CirconAlarm object 88 DataLabel object 92 DataObject object 92 DataPoint object 92 DeviceStatus object 98 dialup SLTA or SMC300 network interface 39 EditBox object 101 EnumObject object 103 EnumPoint object 103 Frame object 107 i.LON 10/100 network interface 41 Image object 108 Inspector object 111 Label object 114 Line object 117 NVAnimated object 118 NVDigital object 120 NVGauge object 126 NVSetpoint object 128 NVSlider object 131 NVSwitch object 134 NVTime object 134 object 81 ObjectLabel object 134 of a schedule 303 operator 329 operator group 333 PenPlot object 137 PlugIn object 139 PlugInButton object 141 RadioButton object 142 site 31 SwitchPoint object 144 TheFrame/TheView object 149 TimePoint object 151 Timer object 154 TrendLog object 155 purge SQL database 377

P
pagers for alarming 243 password default 326 operator 331 PCC10 network interface 33 PCLTA20 network interface 33 PenPlot object properties 137 permissions See also reports, operator groups, about 326 administrator 44 configuring for operator group 336 defined 336 Network Scheduler 298 persistent connection defined 9 PlugIn object properties 139 PlugInButton object properties 141 plugins, installing and registering 48 poll interval 60 Poll Interval 57, 164, 180 printing alarms 286 printing trend log plot 231 priority of alarms 268 properties Alarm Log Viewer 270 button object 84 Checkbutton object 86

Q
query device 351

Document Number 800263 Revision 3.7

401

Index

R
RadioButton object properties 142 Remote Alarm Log service 265 Remote Data Logger application 219 Remote Data Logger service 220 remote LNS client remote site defined 10 renaming customer 29 operator 329 operator group 333 site 30 reports activity report 320 alarm report 321 creating a report 319 exporting data from report 323 operator groups report 322 operator report 322 runtime report 322 schedules report 322 startup counts report 322 restoring deleted documents 184 network database 366 site from back up 372 SQL database 375 router, testing operation of 342 runtime data See data logging

single site 32 server configuring 380 Service Manager 20 service pin, query 351 services Alarm Print service 286 beeeeeep 18 Circon services persist connection 42 Email Notification service 284 Local Alarm Log service 264 Local Data Logger service 218 Local Synchronization service 18 overview 18 Remote Alarm Log service 265 Remote Data Logger service 220 service defined 10 Service Manager 20 time synchronization 19 site adding document 53 automatic backup 371 backing up 369 configuring 31 configuring alarm logging 256, 260 configuring data logging 214 configuring data logging interval 215 configuring permissions 336 creating 30 deleting 31 local, defined 9 management mode 36 manual backup 370 network database 34 network interface 32 opening and connecting to 46 properties 31 remote, defined 10 renaming 30 restoring 372 securing access to 325 selecting single site 32 units of measure 32 Site Management tool introducing 28 sizing object in document 75

S
Schedule document See document Schedule Report document See document Scheduled tasks about 374 mantaining 377 troubleshooting 377 schedules report 322 scheduling See Network Scheduler SCPTsetPnts See NVSetpoint object scroll bars, adding 173 securing access to a site about 325 selecting object 73

402

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide SLTA10 network interface 33 SLTALink Manager, configuring 36 SMC300 alarm protocol 253 using for alarm logging 250 SMC300, using for alarming 243 SNVT_alarm, using 251 SNVT_switch See SwitchPoint object SNVT_time_stamp See TimePoint Object SQL database archiving 376 backing up 374 copying to another computer 378 purging 377 restoring 375 startup count data See data logging state, alarms 267 status bar Visual Integrator 3 24 Status bar 47, 73 Subsystem document See document SwitchPoint object properties 144 TrendLog object adding 182 properties 155

U
units of measure changing default units text 159 configuring 159 displaying on document 159 site 32 UNVT_alarm, using 251 user interface See also HMI, Alarm Log Viewer 22 Alarm Notifier 277 DocumentView 21 Graphics Editor 67 introducing 21 Log Viewer 221 menu 23 status bar 24 Status bar 47 Toolbar 22 TreeView 21

T
tab order of objects in document 77 template, creating custom device document 199 temporary connection defined 10 testing device operation See also maintaining a network, current state 347 device 346 query device 351 router 342 TheFrame/TheView object properties 149 time synchronization 19, 45 TimePoint object adding 170 properties 151 Timer object properties 154 Toolbar Graphics Editor 70 Visual Integrator 3 22 translation of alarm code 288 trending See data logging

V
VBS See Visual BASIC scripting verifying device operation See testing device operation viewing alarms 276 archived data 221 document template 52 event data 232 logged data 221 object properties 81 runtime/startup data 236 trend plot 230 Visual BASIC scripting language documentation 157 minieditor 157 Script Wizard 158 Visual Integrator 3 addons 7 features 5 getting started 1

Document Number 800263 Revision 3.7

403

Index

help 24 installing 1 licencing 1 licensing 7 menu 23 network connectivity options 9 package contents 1 password, default 3 quick tour 5 registering 1 remote LNS client 379 server 379 starting 3

status bar 24 system requirements 1, 8 tiering 7 Toolbar 22 user interface, introducing 21 workstation 379

W
Windows accounts 327 workstation configuring 380

404

Document Number 800263 Revision 3.7

Visual Integrator 3 Integrator Guide

Document History
Revision 1.0 1.1 3.4 Date April 2001 August 2002 September 2003 Comments First version. Revised and updated with new features Revised and updated with new features. Document version number now indicates corresponding version of Visual Integrator 3. 3.5 3.5 Update 1 June 2004 Revised and updated with new features. For details, see release notes for version 3.5. November 2004 Revised Chapter 18 section on starting LNS Server, to add new feature Revised Chapter 10 section on configuring for local data logging to add configuration step when using i.LON 10/100 network interface, and to indicate limitation on SNVTs supported for data logging and plotting. 3.6 November 2005 Changed term user to operator and term group to operator group. Support for LNS Turbo Edition Revised and updated with new features. For details, see release notes for version 3.6. 3.7 October 2006 Revised and updated with new features. For details, see release notes for version 3.7.

Document Number 800263 Revision 3.7

405

Circon Systems Corporation 110 6651 Fraserwood Place Richmond, BC, Canada V6W 1J3 www.circon.com