StruxureWare SCADA Expert

Vijeo Citect 2015
Quick Start Guide Part 2 - Advanced
Configuration
June 2015
Legal Information
DISCLAIMER
Schneider Electric makes no representations or warranties with respect to this manual and, to the maximum extent permitted by law,
expressly limits its liability for breach of any warranty that may be implied to the replacement of this manual with another. Further,
Schneider Electric reserves the right to revise this publication at any time without incurring an obligation to notify any person of the
revision.
The Example Projects are provided to you for the purpose of illustrating how the SCADA software 2015 could be used in an oper-
ational environment ("the Purpose").Schneider Electric grants you a royalty free, non exclusive, non transferable license to use the
example projects installed with your SCADA software version 2015 (“the Example Projects”) for the Purpose only.
The Example Projects are provided by Schneider Electric as part of the SCADA software version 2015 on an "as is" basis and Schneider
Electric does not guarantee the reliability, serviceability or function of the Example Projects.
Should you modify the Example Projects, you bear the risk of any use of such modified Example Projects.
Schneider Electric gives no express warranties, guarantees or conditions and to the extent permitted under applicable laws, Schneider
Electric disclaims all implied warranties, including any implied warranties of merchantability, fitness for a particular purpose or non-
infringement of third parties’ intellectual property rights.
Schneider Electric shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action
taken by you or others related to the Example Projects.

COPYRIGHT
© Copyright 2015 Schneider Electric All rights reserved.

TRADEMARKS
Schneider Electric has made every effort to supply trademark information about company names, products and services mentioned in
this manual.
Citect, CitectHMI, Vijeo Citect, Vijeo Citect Lite and CitectSCADA are either registered trademarks or trademarks of Schneider Electric.
Pelco, Spectra, Sarix, Endura, are registered trademarks of Pelco, Inc.
IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.
MS-DOS, Windows, Windows NT, Microsoft, and Excel are either registered trademarks or trademarks of Microsoft Corporation in the
United States and/or other countries.
DigiBoard, PC/Xi and Com/Xi are trademarks of Digi International Inc.
Novell, Netware and Netware Lite are either registered trademarks or trademarks of Novell, Inc. in the United States and other
countries.
dBASE is a trademark of dataBased Intelligence, Inc.
All other brands and products referenced in this document are acknowledged to be the trademarks or registered trademarks of their
respective holders.

GENERAL INFORMATION
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective com-
panies.
June 2015 edition for Vijeo Citect Version 2015.
Manual Revision Version 2015.

PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed
by Schneider Electric for any consequences arising out of the use of this material. © 2015 Schneider Electric. All Rights Reserved.
Validity Note
The present documentation is intended for qualified technical personnel responsible for the implementation, operation and main-
tenance of the products described. It contains information necessary for the proper use of the products. However, those who wish to
make a more "advanced" use of our products may find it necessary to consult our nearest distributor in order to obtain additional
information.
The contents of this documentation are not contractual and in no way constitute an extension to, or restriction of, the con-
tractual warranty clauses.

Contact Schneider Electric today at www.schneider-electric.com

Contents

Legal Information 2

Contents 4
Intention 6

Safety Information 8

Chapter 1: Introduction 10
Definition of Terms 10

Quick Start Tutorial - Part 2 12

Chapter 2: Configuring Servers and Clusters 14

Configuring Clusters 15
Configuring Network Addresses 16
Configuring an IO Device 17

Chapter 3: Security Validation 22

Chapter 4: Using Super Genies 24

Creating a Super Genie 24

Chapter 5: Using a Genie 36

Creating a Genie 36
Using Genies on Graphics Pages 41

Chapter 6: Tag Data Quality 48

4
Contents

Tag Override 48
Control Inhibit 56

Index 60

5
Intention
This document is intended to provide a quick introduction to Vijeo Citect. It is not inten-
ded to replace any specific product documentation, nor any of your own design doc-
umentation. On the contrary, it offers information additional to the product
documentation on installation, configuration and implementing the system.
The application described in this document is not a specific product in the normal com-
mercial sense. It describes an example of how Schneider Electric and third-party com-
ponents may be integrated to fulfill an industrial application.
A detailed functional description or the specifications for a specific user application is
not part of this document. Nevertheless, the document outlines some typical applic-
ations where the system might be implemented.
The application described in this document is for illustration purpose. Your specific
application requirements may be different and will require additional and/or different
components.  In this case, you will have to adapt the information provided in this doc-
ument to your particular needs. To do so, you will need to consult the specific product
documentation of the components that you are substituting in this application.  Pay par-
ticular attention in conforming to any safety information, different electrical requirements
and normative standards that would apply to your adaptation.
It should be noted that there are some major components in the application described in
this document that cannot be substituted without completely invalidating the archi-
tecture, descriptions, instructions, wiring diagrams and compatibility between the vari-
ous software and hardware components specified herein.  You must be aware of the
consequences of component substitution in the architecture described in this document
as substitutions may impair the compatibility and interoperability of software and hard-
ware.

EQUIPMENT INCOMPATIBILITY OR INOPERABLE EQUIPMENT

Read and thoroughly understand all hardware and software documentation before attempt-
ing any component substitutions.
Failure to follow these instructions can result in injury or equipment damage.

6
7
 Safety Information

Safety Information
Hazard categories and special symbols

The following symbols and special messages may appear in this manual or on the
product to warn of potential hazards or to call attention to information that clarifies or
simplifies a procedure.

Symbol Description

The addition of either symbol to a “Danger” or “Warning” safety

label indicates that an electrical hazard exists which will result in
or personal injury if the instructions are not followed.

This is the safety alert symbol. It is used to alert you to personal

injury hazards. Obey all safety messages that follow this symbol to
avoid possible injury or death.

DANGER indicates an imminently hazardous situation, which, if not avoided, will result in
death or serious injury.

WARNING indicates a potentially hazardous situation, which, if not avoided, can result in
death or serious injury.

CAUTION indicates a potentially hazardous situation which, if not avoided, can result in
minor or moderate injury.

NOTICE
NOTICE used without a safety alert symbol, indicates a potentially hazardous situation
which, if not avoided, can result in property or equipment damage.

Please Note

8
Safety Information

Electrical equipment should be installed, operated, serviced, and maintained only by

qualified personnel. No responsibility is assumed by Schneider Electric for any con-
sequences arising out of the use of this material.

Before You Begin

Vijeo Citect is a Supervisory Control and Data Acquisition (SCADA) solution. It facil-
itates the creation of software to manage and monitor industrial systems and processes.
Due to Vijeo Citect's central role in controlling systems and processes, you must appro-
priately design, commission, and test your Vijeo Citect project before implementing it in
an operational setting. Observe the following:

UNINTENDED EQUIPMENT OPERATION

Do not use Vijeo Citect or other SCADA software as a replacement for PLC-based control pro-
grams. SCADA software is not designed for direct, high-speed system control.

Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.

LOSS OF CONTROL

l The designer of any control scheme must consider the potential failure modes of con-
trol paths and, for certain critical control functions, provide a means to achieve a safe
state during and after a path failure. Examples of critical control functions are emer-
gency stop and overtravel stop, power outage and restart.
l Separate or redundant control paths must be provided for critical control functions.
l System control paths may include communication links. Consideration must be given
to the implications of unanticipated transmission delays or failures of the link.
l Observe all accident prevention regulations and local safety guidelines. 1
l Each implementation of a control system created using Vijeo Citect must be indi-
vidually and thoroughly tested for proper operation before being placed into service.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.

1. For additional information, refer to NEMA ICS 1.1 (latest edition) "Safety Guidelines
for the Application, Installation, and Maintenance of Solid State Control", and to NEMA
ICS 7.1 (latest edition) "Safety Standards for Construction and Guide for Selection, Install-
ation and Operation of Adjustable-Speed Drive Systems" or their equivalent governing
your particular location.

9
Chapter 1: Introduction
This tutorial assumes that you have successfully installed Vijeo Citect on your computer
and is an introduction to some of the features and functionality found in the product.
You do not require a Vijeo Citect license to complete this tutorial.
The tutorial is designed to be completed in a little over an hour, and is not intended as a
substitute for attending a Vijeo Citect training course. You are encouraged to refer to ref-
erenced topics in the main help for more information, and attend a training course to
complete your basic training, learn how to use time saving tools, or go on to learn some
of the more advanced features of the product.

Definition of Terms

Term / Definition
Icon

Click or Briefly press the left mouse button

Select

Double- Press the left mouse button twice, quickly

Click

Right- Briefly press the right mouse button

Click

Type Use the keyboard to type in the specified characters

“Text”

Drag Position the mouse cursor over an item, click and hold the left mouse button while
moving the mouse cursor to a new position, then release the left mouse button

Alt-Tab Use the keyboard to press and hold the Alt key, then press the Tab key, then
release both

10
Chapter 1: Introduction

11
Quick Start Tutorial - Part 2

In part 2 you will:

l Configure an IO Device and primary and stand-by connection
l Configure a Network Address
l Create a cluster
l Define Servers and map the network address
l Security Validation
l Create a Super Genie
l Create a Genie
l Use Genies on Graphics Pages
l Tag Data Quality
l Tag Override
l Control Inhibit
If not already done so complete part 1 of the tutorial before com-
mencing part 2.

12
13
Chapter 2: Configuring Servers and Clusters
In this step you will assign the Cluster and the Network Address to the server roles that
are required on the system including, IO Communications, Alarming, Trending and
Reporting roles.
For more information on Clusters and Server definitions refer to Clusters and About
Cluster Context in the main help.
1. From the Citect Project Editor -> select the Servers menu.

2. Select Alarms Servers

3. Select the Network address drop-down. Select “MyServer”
4. Add a meaningful Comment.
5. Click Replace to update the record.

This identifies the Alarm Server process to run on the computer with MyAddress TCP/IP
address, within the MyCluster server group, in the Primary mode. The Server Name
“MyServer” will be used by networked clients to connect to this server to acquire the
alarm information for display purposes.
6. Repeat the steps outlined above for the Report, Trend and I/O Servers.

14
Chapter 2: Configuring Servers and Clusters

Note: If your production system has redundant servers, then you would configure
two Servers for each role, one for the Primary and one for the Standby. Each one will
need its own Network Address.

Configuring Clusters
Clusters define where server processes (IO communications, data logging, alarming, etc),
are run, and how different server processes interact with each other for redundancy pur-
poses (refer to Building Redundancy into your system the online help for more details).
Every Vijeo Citect system should have at least one cluster defined, with related Network
Addresses and Server roles.

Under the Tutorial project, expand the project tree and select Communications. Double-
click Clusters.

Note: If the Project Editor does not appear, then use Alt+Tab until it appears.

In the Clusters form:

1. Add an appropriate description in the Comment field
2. Click Replace (the Cluster1 record was created as part of the starter project in part 1
of this tutorial).

15
 Chapter 2: Configuring Servers and Clusters

3. Close the Clusters window by clicking on the icon or pressing ESC on the key-
board.

Note: When editing forms in the Vijeo Citect Editor, pressing Enter on the keyboard
will Add a new record, not replace the existing record. If you accidentally hit Enter
or Add when you intended to Replace, you can scroll to the last record on the form,
and select Delete to remove the unwanted record.

Configuring Network Addresses

Network Addresses are required for any node in your Vijeo Citect network which will
act as a Vijeo Citect Server (IO communications, trends, alarms or reports). Network
addresses need to be configured in the database so that clients will know where to go for
various data items.

Note: Equipment data items are located on the Vijeo Citect Reports Server.

From the pull-down menu at the top of the Vijeo Citect Project Editor, -> Servers ->Net-
work Addresses.

16
Chapter 2: Configuring Servers and Clusters

In the Network Address form, enter a name for your server, and in the Address field
enter the TCP/IP address as “127.0.0.1”.

Note: The network address can be either a DNS name or a TCP/IP address. In a pro-
duction system you would use your network DNS names, however for the purposes
of development and inhouse testing, you can use the LocalHost or loopback TCP/IP
address.

Click Add, and close the form.

Configuring an IO Device
The equipment tags used in this project are based on an “Internal” PLC emulator. It has
no logic in it, being just data, allowing you to create tags and read and write persisted
values to them.
When communicating with real-world PLCs and RTUs, you need to configure IO
Devices to identify where and how Vijeo Citect should communicate.
For more information on Configuring IO Devices, refer to the section Communicating
with I/O Devices in the main help and the relevant Driver Help.
1. Open the Project Editor
2. From the Communications menu select the Express Wizard

3. In the Express Wizard Click Next

17
 Chapter 2: Configuring Servers and Clusters

4. Check that “IOServer1” is selected as the existing I/O Server and click Next

5. Rename the IO Device to “TankFarmPLC” and click Next

6. Select the option Persisted Memory I/O Device. This configures the system to use a
memory based device which persists to disk instead of a physical device.

18
Chapter 2: Configuring Servers and Clusters

7. Click Next
8. Select the OFSOPC Protocol and click Next.

9. Click Next

10. Click Finish. The wizard will close.

19
 Chapter 2: Configuring Servers and Clusters

Your system is now configured to access an emulated PLC to write and read data.
The next step is to re-configure the equipment tags (configured in Part 1 of this tutorial)
to use the PLC.
1. Open the Equipment Editor,
2. select Motor2 and edit the Equipment Type.
3. From the Items list, select Run
4. Modify the “I/O Device” field from “Internal” to {equipment.IODEVICE} as shown
below.

5. Repeat for items Mode and Speed.

6. Select the Equipment Tab
7. Edit the Equipment definitions for Pump 1 and Pump 2. The I/O Device field is
blank. Use the pull-down list to select the new I/O Device: IODev.

20
Chapter 2: Configuring Servers and Clusters

8. Repeat for Pump 2.

9. Create a new pump using the same Equipment Type. Name the pump “Pump 3”.
10. Save and select Update Equipment.
11. From the Citect Project Editor -> select File -> Pack. Once pack is complete recompile
and run your project to confirm that it still works.

Note: When connecting Vijeo Citect to real-world PLCs and RTUs, there are three
forms that contain the connection information: Boards, Ports and I/O Devices. The
Express Communication Wizard fills in some of the required information for you,
but some devices and protocols require you to add additional information (such as
the TCP/IP address of the target PLC).
Refer to the Driver Help for detailed information on how to configure these forms to
achieve successful communications.

21
Chapter 3: Security Validation
Vijeo Citect contains security functions to make it easier for companies to implement elec-
tronic signatures and multi-user validation. In this step you will modify the Pump 1
manual button to require signature validation before changing the mode to Manual (set-
ting the Pump_1_Mode value to 1).
Switch to the Graphics Builder. Open your MyPage graphics display, and double-click
on the Manual button to access its animation properties. Click on the Input tab, and
modify the command to: (format in code text)

MultiSignatureTagWrite("Pump_1_Mode", "1", "", "kernel", "", "", "")

Save your page. Switch to the Vijeo Citect Editor and compile your project. Run your pro-
ject.
Once the project is running, open MyPage, and click on the Manual button. Instead of
immediately changing the pump’s mode to manual, Vijeo Citect will display an elec-
tronic signature verification form.

22
Chapter 3: Security Validation

Click on the Verify button, then enter the password for the kernel user you created
earlier and click OK.

An approval dialog is displayed.

Click OK.
The pump mode will now be changed to Manual.
Further information on the Security Cicode functions is available from the Cicode Refer-
ence.

23
Chapter 4: Using Super Genies
Super Genies are pages which can dynamically switch between different tag groups at
runtime.
Super Genies are configured just like pages, but placeholders are inserted in the graph-
ical animation configuration form instead of direct tag references. To use Super Genies,
you must either link them to Genies (see the next step in this tutorial), or call them from
Cicode. Refer to Genies and Super Genies for more information.

Creating a Super Genie

1. From the Graphics Builder select File -> New
2. From the New Dialog ->Select Super Genie

A new Super Genie page will open. The dotted lines identify the default page size for the
popup.
3. Click on the Text object - [A] in the Toolbox.
4. In the text properties dialog type “PUMP” and click to place the text on the page.
5. Click OK.

24
Chapter 4: Using Super Genies

6. Adjust the position of the title by placing it on top of the page, centered.

7. Click on the Toolbar and select the text tool.

8. Type in “Title” and click to place it on the screen. Modify the alignment to be
“Centre”.

25
 Chapter 4: Using Super Genies

9. Click on the Display Value tab.

10. Change the display type to String, and type in a string expression of ?Title?.
The question marks identify this text as placeholder text, which will be replaced by a
dynamic value at runtime, depending on what data is passed into the page. For inform-
ation regarding substitutions refer to Defining substitutions for Super Genies in the main
help.

26
Chapter 4: Using Super Genies

11. Click OK, and position the new text in the centre of the page, below 'PUMP'.
12. Select the Straight Line tool from the Toolbox.
13. Click on the left side of your page slightly below the Title text and holding the mouse
draw a straight line to the right side of your page. Using the grid will help keep your
lines straight.
Experiment with colors and shading to get the effect you desire
14. Click OK.

15. Copy the three controls for the pump onto your Super Genie page. Use File-> Open to
open your previous graphics page with the pump and tanks on it. Holding the Ctrl
key down click on the three control buttons and corresponding lights, and click Ctrl-C
to copy them to the clipboard.

16. Switch back to your Super Genie (Ctrl-F6), and paste these items onto your page
using Ctrl-V.

27
 Chapter 4: Using Super Genies

17. Double click on the Manual button to access its properties. Modify the Input com-
mand to:

?Mode? = 1

18. Click OK to close the form. Similarly, modify the Auto button command to:

?Mode?=0

28
Chapter 4: Using Super Genies

19. Access the On/Off button and modify its command to:

Toggle(?Run?)

20. And its Disabled Access expression to:

?Mode?=0

29
 Chapter 4: Using Super Genies

In replacing the tag names in the original buttons with parameter names when you pass
a tag name into the page as one of these parameters, the tag name will be used to
acquire and write data instead of the placeholder.
21. Double click the light next to the Manual button to access its properties. Modify the
ON symbol expression to:

?Mode? = 1

30
Chapter 4: Using Super Genies

22. Repeat this process for the Auto light: ?Mode? = 0

23. And the On/Off light: ?Run? = 1
The Super Genie controls and lights configuration is complete.

To create a close button, draw the button at the bottom of the form.
24. In the Appearance tab, select the button type as Symbol instead of text. Click Set to
browse the symbol libraries for an appropriate image.
25. Select the “clos2” icon from the icons library.

31
 Chapter 4: Using Super Genies

26. Change to the Input tab, and type “Winfree()” in the Up command expression. This
will tell the popup window to close when the button is clicked. Click OK when fin-
ished.

The Super Genie should look like this.

In the next step you will define the tag relationships (called associations) the Super
Genie page will use to relate tags to the parameters names you have specified.
27. Right-click at an empty location on the page and choose Page Properties from the
menu (or select Properties from the File menu).

32
Chapter 4: Using Super Genies

28. Select the Associations tab from the top menu and click Add.
29. Select “Mode” from the pull-down list in the Name column, then type in a mean-
ingful description.

30. Repeat this for “Run” and “Title”, and then click OK to close the form.

33
 Chapter 4: Using Super Genies

Note: that when you declare page associations for a Super Genie in the page prop-
erties, you do not place the name of the association between question marks. Also
notice that the In Use cell next to an association name will automatically indicate
“Yes”, if you have referred to that association anywhere on your page.If an asso-
ciation you added is not in use, it means you have not successfully referred to that
tag when creating your graphical objects. Repeat the previous steps and check you
have typed in the correct expressions. Repeat the previous steps and check you have
typed in the correct expressions.

31. Save your Super Genie. Genies and Super Genies need to be saved in libraries. If this
is the first time you are creating a Genie or a Super Genie, you will not be able to do
so unless you also create a library. Ensure that the tutorial project is selected, then
click on the New button.

34
Chapter 4: Using Super Genies

32. On the popup page type in “myequipment” and click OK. This will create a new lib-
rary file in your project called myequipment. This file can contain many Super
Genies.

33. Myequipment will now be listed under the library box. Make sure this new library is
selected, then give your Super Genie the name “!pump” and click OK to save. An
update warning message will appear and click OK.

Note: Placing an exclamation mark in front of a page name marks it as a system file,
and it is not listed on automatic menus and other locations.

35
Chapter 5: Using a Genie
Generally, you use Genies to create generic equipment or animated graphical symbols
which you can reuse many times on your pages. By doing so, you can create a single lib-
rary object for a specific purpose with known properties and reuse it within your project
many times without creating a new object each time.
When you used on a page, that instance is linked with the Genie in the library so that
any changes you make after you have used a Genie are automatically populated out
across all instances in your project. This makes modification and maintenance of your
project much easier. Refer to Genies in the main help for more information.

Creating a Genie
1. In Graphics Builder, select New then Genie.
2. Select, copy and paste your Pump symbol from your graphics page into your new
Genie.
3. Drag the Genie anchor point across to the bottom left of your pump symbol. Turn
your Grid off to get pixel accurate position.

4. Double click the symbol to access its animation properties. Modify the On Symbol
expression to: %Run% = 1

36
Chapter 5: Using a Genie

Note: Refer to Defining Genie Substitutions Defining Genie Substitutions for more
information about %%.

5. Click on the Input tab.

6. Select Up from the Action list, and in the Up Command window type in the fol-
lowing:

AssMetadata(-2, -2);

WinNewAt("!pump", 100, 200, 877, "Cluster1");

The AssMetadata function will perform the required Super Genie associations using the
tags or expressions you define when you use your Genie object on a page. The first para-
meter (-2) specifies that the next window or page displayed will receive the tag asso-
ciations. The second parameter (-2) specifies that the associations will come from the
Genie being clicked.
The WinNewAt function displays a new window. The first parameter defines the name
of the page - in this case, a Super Genie – to display. Next two parameters are the X and
Y coordinates, respectively, where the window or page will be displayed on the screen.
The parameter that follows the X and Y coordinate values is used to determine the win-
dow behavior properties or mode (for example, resize, movement, and so on).
Refer to the Cicode Reference to see different modes to be used with the WinNewAt func-
tion.
The last parameter is the (optional) cluster name.

37
 Chapter 5: Using a Genie

7. Select the Metadata tab from the top menu.

8. Click Add and type in "Mode". Inside the Value cell, type in "%Mode%". Repeat this
for "Run" and "Title".

9. Click OK when you are finished.

10. From the Edit menu- select Attach Super Genie. Attaching a Super Genie allows the
page to be referenced in your project when the associated Genie is used from the lib-
rary. Associations to defined tag relationships can also be used on any page in your
project.

38
Chapter 5: Using a Genie

11. On the Attach Super Genie popup screen, click on the Add Button.

12. Scroll down and select your library by clicking on it, then select your Super Genie
and click OK.

39
 Chapter 5: Using a Genie

You should now see myequipment.!equipment on the list of attached Super Genies.
13. Click OK.

Now when you click on the Genie object, the Super Genie page will pop up, and the
metadata you link to your Genie object will be passed to Super Genie page as asso-
ciations.
14. Save your Genie. Check that your myequipment library is selected, and type in
“genie_pump” as your Genie’s name, and click OK.

40
Chapter 5: Using a Genie

15. Close your Genie.

Now you have created your genie object and linked it with your Super Genie page, you
will take a look at how to use these objects on the page you have previously designed.

Note: Genies can be used on their own without a Super Genie. They still add a lot of
value to your project by providing templates for animated symbols, but add even
more value when linked to Super Genies.

In the next step of this tutorial you will use the genie on your MyPage.

Using Genies on Graphics Pages

1. Inside the Graphics Builder, open MyPage screen.
2. Select the genie icon form the Toolbar.
3. Scroll down and select myequipment library from the Library list. You should see the
genie_pump object on the left hand side. Select it and click OK to add it into your
page.
A pop-up window will prompt you to enter the Genie tags to be used for each of the
three parameters. Enter the desired variable tag names in the empty fields.
To link the variable tag Pump_1_Run to the run Metadata, type in the tag name inside
the field. Link your Pump_1_Mode tag to the Mode metadata of your genie object.

41
 Chapter 5: Using a Genie

4. For the Title metadata, type in the static text ’Pump 1’ inside single quotes. Genie
associations don’t need to be tags, they can be text string or numerical replacements
as well, but they must have single quotes around them to allow Vijeo Citect to recog-
nize them as such.
The Title metadata is linked with a constant string expression “Pump 1”. This is
because you do not need to use a variable tag for the title.

Note: If you do not place an expression inside single quotes when linking your
metadata, Vijeo Citect will look for a tag with the specified name; and if no tags can
be found, you will not be able to see the association on your Super Genie page at
runtime. More importantly, if you forget to place your string expression inside single
quotes and it happens to be the name of an already declared tag, you will see the
value of the tag instead.

Your page should now look like this:

42
Chapter 5: Using a Genie

5. Delete the original pump symbol you initially created and move the new Genie
Pump to its place to replace it.

6. Save your project by clicking the save icon and then click on compile button and run
your project.

43
 Chapter 5: Using a Genie

When you turn the Pump On and Off from the menu on the bottom right corner, You
will notice that the Genie based pump will change its color just like the original. Now
you will see how to make use of the Super Genie popup. When the mouse hovers over
the pump, it will be surrounded by white borders. This indicates that you can click on
the object.
Click the Pump.

Your Super Genie page will appear. You should now be able to control the status of
Pump 1 directly from the popup window. Click on the On/Off button to toggle between
its run modes. You can also press the Auto or Manual button and the status indicators
on MyPage will update instantly to represent its new state.
Once you have finished testing your Super Genie page, click the Close button.
7. Return to the Graphics Editor and open you graphics page again. Copy your Genie
Pump and place it in two new locations on your page. Double click each of the new
pumps and edit their parameters to suit pumps 2 and 3.

44
Chapter 5: Using a Genie

8. Save and close your graphics page.

9. Select Update Pages from the Tools menu.

10. Confirm that you want to continue, wait for the process to complete, then re-compile
and run your project. You should now be able to access all three pumps and their
related popups.

45
 Chapter 5: Using a Genie

Using Equipment Import, Genies and Super Genies, you can rapidly scale out your pro-
ject and also control the quality and consistency of your project.

46
Chapter 5: Using a Genie

47
Chapter 6: Tag Data Quality
Tags have additional properties and methods that you can access for your tags above
and beyond their actual values. These include quality flags, quality timestamps, and
override functions. For this exercise you will focus on the Tag Override feature.

Tag Override
Tag Override allows you to set your tag’s value to a different value than it is receiving
from the field devices.
1. Open the Equipment Editor and switch to the Equipment Types tab.
Right click on the project node and select Add Type. Configure your equipment type as
shown below:

Tag Name {equipment.tagprefix}_Level Cluster Name Cluster1

Data Type REAL Raw Zero Scale 0

I/O Device {equipment.iodevice} Raw Full Scale 32767

Address {equipment.tagprefix}.level Eng Units %

Eng Zero Scale 0 Format ###.# EU

Eng Full Scale 100 Deadband 0.25

Comment {equipment.comment} level Historize TRUE

2. Save your changes and switch to the Equipment tab.

3. Add a new equipment to your project called “Tank_1”. Make sure that its type is Ana-
log_Input. Then, click OK to create the equipment.

48
Chapter 6: Tag Data Quality

4. Next, configure your equipment as follows:

l Cluster Name = Cluster1
l Tag Prefix = Tank_1
l I/O Device = IODev
l Comment = Tank 1

5. Select Save All from the File menu and then select Update Equipment.
Variable Tags should now show a new tag called Tank_1_Level.
6. Switch to the Graphics Builder and open your graphics page. Select the Pump 1
Speed indicator and slide controller, then copy and paste these items to the left of the
source tank. Adjust its height to match that of the tank and keep a record of it (shown
on the bottom status bar). You will use the bar graph to show the level in the tank, as
if it were being measured by a field transmitter, and you will use the slider to sim-
ulate that field transmitter.

49
 Chapter 6: Tag Data Quality

7. Double click the bar graph to access its properties. Change the Level Fill expression to
use the new Tank_1.Level equipment item.

8. Click OK when you are finished.

Note: Because it is referencing the entire variable tag object, this bar graph will show
the value for the currently active mode of the tag. If you switch to Override Mode, it
will show the override value, if you switch to Normal Mode, it will show the real
value. If instead, you had specified a specific tag data quality, then it would always
show the value for a specific mode. This is demonstrated below using the slider to
always reflect a value from the field transmitter.

50
Chapter 6: Tag Data Quality

9. Double click the slider object to access its properties. Modify the Slider to use the new
Tank_1.Level equipment item, and extend the tag to use the field value. This will
force the slider to always use the real field value (as if it were a real field transmitter),
regardless of the item’s mode.
10. Adjust the maximum offset by setting it to the height of the level indicator for the
tank.

11. Add a numerical input to allow us to set the override value when you are in override
mode.
12. Select the Number object from the Toolbar and click to place it on the screen near the
tank. Adjust the font, size, color and 3D shadowing to suit your style preferences.
13. Select the Display Value tab on the far right hand side of the form, and enter the
Numeric Expression:
Tank_1.Level.field.v
14. Select Keyboard Commands under the Input tab, and Add a new key sequence:
##### Enter, with a command of Tank_1.Level.field.v = Arg1.
15. Click OK when finished.

51
 Chapter 6: Tag Data Quality

16. Copy and paste your new numerical input object, then double-click it to access the
new object’s properties. Modify the Numeric expression to display “Tank_
1.Level.Override.v”, and the Input command to read “Tank_1.Level.Override.v =
Arg1”.

17. Click OK when finished.

UNINTENDED EQUIPMENT OPERATION

When the tag is put into the override mode, the default tag element value will be equal to
the Override element value instead of the Field element value. If the system is configured in
such a way that it does not give the operator any indication that the tag is in override mode,
the operator may assume that he is seeing the Field element value (live data) and con-
sequently may operate the plant inappropriately.

You need to always configure the system in such a way that it provides a visual indication to
the operator that a tag is in override mode.

Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.

52
Chapter 6: Tag Data Quality

18. Open File menu in Graphics Builder and select Open.

19. In the Open dialog, scroll down to the bottom of the list and select Variable Tags
page. Then click OK to open it.

20. Double click anywhere on the page. This will bring the Data Browse dialog to the
screen. Type in “1” into the Privilege field and click OK. This will ensure that users
without the privilege 1 will not be able to modify values on this page.

21. Save your page, before compiling and running your project.

53
 Chapter 6: Tag Data Quality

22. Change the field transmitter’s value by using either the slider, or by hovering over
the field numeric value and typing in a new value on the keyboard. The Override
value is not updated.
23. From the Navigation Pane, drill into Tags node and select the All Variable Tags page.
You can resize the columns using the Auto-fit Columns command from the page com-
mands.
24. Locate the Tank_1_Level tag and right click on it. The various options should be
greyed out due to insufficient security privileges. Login as ‘Bob’ or ‘kernel’ to attain
security privilege 1, then right-click again and change the Tank_1_Level tag’s mode
to Override Mode.

54
Chapter 6: Tag Data Quality

The value displayed has changed to zero. Right click on the tag and set a new override
value. If you navigate back to your graphics page you will see that your display has
changed due to the override mode.

Firstly, the bar graph has been dotted out, indicating that the value it is displaying is
coming from the Override value and not the field transmitter. If you use the slider to
modify the field value (simulating a field instrument signal), the bar graph ignores it,
and continues to use the override value at all times.
Secondly, the numeric value for the Override value and the Field value are displaying
their respective values.
Finally, if you navigate to the Manual Override page, the tag will be listed here to allow
you to easily identify any tags whose mode has been manipulated.

55
 Chapter 6: Tag Data Quality

Note: There are numerous other features available for Tag Data Quality. Refer to the
online help for more details, or experiment with the ManualOverride and Control
Inhibit functions and pages available in your tutorial project.

Control Inhibit
1. Return to the Variable Tags page, and select the Pump_1_Speed tag.
2. Right click and inhibit control of this tag.

3. Return to your graphics page and try to manipulate your pump’s speed. As soon as
you modify the value, it will return to the original value because the system is inhib-
iting any control of its value.
Similar to the tank level bar graph, the pump bar graph, slider and numerical display
are dithered to indicate that the tag is not in its normal operating mode.

56
Chapter 6: Tag Data Quality

UNINTENDED EQUIPMENT OPERATION

When the tag is put into the control inhibit mode, writing to the Field element value is pro-
hibited. If the system is configured in such a way that it does not give the operator any
indication that the tag is in the control inhibit mode, the operator may assume that he is per-
forming a control operation which does not, in fact, occur.

You need to always configure the system in such a way that it provides a visual indication to
the operator that a tag is in the control inhibit mode.

Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.

4. Return to the Control Inhibit page and right click on the tag again to return it to its
normal mode.
5. To see which of your tags are in control inhibit or manual override mode, navigate to
the relevant page from the Pages list.

57
 Chapter 6: Tag Data Quality

This completes the tutorial.

58
Chapter 6: Tag Data Quality

59
Index
U
Using Genies on Graphics Pages
Quick Start 41

C
Configuring
Network Address 16
Configuring an IO Device
Quick start tutorial 17
Configuring Clusters
Quick Start Guide 15
Configuring Servers and Clusters 14
Control Inhibit
Quick Start tutorial 56
Creating a Genie
Quick Start tutorial 36
Creating a Super Genie
Quick Start Guide 24

D
Definition of Terms
Quick start 10

P
Part 2 56

Q
Quick start tutorial 16
Quick Start Tutorial - Part 2 12

S
Security Validation
Quick Start tutorial 22

T
Tag Override
Quick start guide 48
tutorial part 2 17

60
Index

61