VJCUpgrade V7.2

Manual Release 1
Vijeo Citect Upgrade

Training Manual
Version 7.20
Citect Pty Ltd
3 Fitzsimons Lane
GORDON NSW 2072
PO Box 174
PYMBLE NSW 2073
AUSTRALIA
Telephone: 61 2 9496 7300
Fax: 61 2 9496 7399
DISCLAIMER
Schneider Electric (Australia) 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. Furthermore, Schneider Electric (Australia) reserves
the right to revise this publication at any time without incurring an obligation to notify any person of the revision.
Schneider Electric (Australia) Pty Ltd
ABN 4200 4969 304
Vijeo Citect Upgrade Training Manual
INTRODUCTION AND LEGAL NOTICE
Your purchase of this official Vijeo Citect Upgrade Training Manual entitles you to undertake the Vijeo Citect Upgrade training course. The number allocated to
you on purchase of this manual is your key to complete the course evaluation.
Satisfactory completion of this evaluation is mandatory for you to obtain a certificate of completion of the training course.
The contents of this manual are proprietary to Schneider Electric (Australia) and all rights, including copyright, are reserved by Schneider Electric (Australia).
You must not copy any part of the manual in hard or electronic form or make any adaptation or other commercial use of it without Schneider Electric's prior
written consent.
Schneider Electric (Australia) will not accept any liability for action taken in reliance on this training manual.
COPYRIGHT
(c) Schneider Electric (Australia) 2006-2010. All rights reserved. This material is copyright under Australian and international laws. Except as permitted under
the relevant law, no part of this work may be reproduced by any process without the prior written consent of Schneider Electric (Australia). Any authorised
reproduction must acknowledge Schneider Electric (Australia) as owner of copyright in work.
TRADEMARKS
Schneider Electric (Australia) has made every effort to supply trademark information about company names, products and services mentioned in this manual.
Trademarks shown below were derived from various sources.
CitectSCADA, CitectHMI, Vijeo Citect, CitectFacilities, CitectHistorian, Vijeo Historian and Ampla are registered trademarks of Schneider Electric (Australia)
Windows, Windows NT, Windows 2000, Windows XP, Windows Vista, MSSQL Server and Excel are trademarks of Microsoft Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Novell and NetWare are registered trademarks of Novell Inc.

dBASE is a trademark of dataBased Intelligence, Inc.
GENERAL NOTICE
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective companies.
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed by Schneider Electric
(Australia) Pty. Ltd. for any consequences arising out of the use of this material.
Validity Note
The present documentation is intended for qualified technical personnel responsible for the implementation, operation and maintenance 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 contractual warranty clauses.
For further information contact Schneider Electric (Australia). at www.citect.com/scada or www.schneider-electric.com/vijeocitect
About Us
Members of Educational Services' team of Instructional Designers have tertiary qualifications in Education, Educational Course Development and are also
experienced instructors in their own right; some are also published authors. Currently, the team is supporting a range of over 70 courses in multiple languages
and multiple software environments.
Authors
Alynda Brown, David Heath, Michelle J Richardson
Contributors
David MacKay, Ian Thompson
November 2010 Edition for Version 7.20

Manual Release 1
Written, Printed and bound in Australia
ii Version 7.20 November 2010

Contents
CHAPTER 1: INTRODUCTION TO UPGRADING VIJEO CITECT ................................... 1-1

Overview .................................................................................................................... 1-1
Before the Course Begins ........................................................................................... 1-2
Course Overview ........................................................................................................ 1-3
Conventions Used in this Manual............................................................................... 1-5
CHAPTER 2: UPGRADE PROJECTS .............................................................................. 2-1

Overview .................................................................................................................... 2-1
How to Prepare for an Upgrade .................................................................................. 2-2
System Requirements ................................................................................................. 2-3
Upgrade the Citect License ........................................................................................ 2-5
How to Upgrade the Projects ...................................................................................... 2-8
Installing and Managing Multiple Versions ............................................................. 2-11
Known Pitfalls .......................................................................................................... 2-24
The Upgrade Process ................................................................................................ 2-27
CHAPTER 3: TAB_STYLE_INCLUDE PROJECT ........................................................... 3-1

Overview .................................................................................................................... 3-1
Using Tab Style Templates ........................................................................................ 3-2
Trend Templates ......................................................................................................... 3-4
Alarm Viewing ........................................................................................................... 3-9
Menu Configuration ................................................................................................. 3-19
CHAPTER 4: ON-LINE CHANGES ................................................................................ 4-1

Overview .................................................................................................................... 4-1
Online Changes .......................................................................................................... 4-2
CHAPTER 5: TAG EXTENSIONS................................................................................... 5-1

Overview .................................................................................................................... 5-1
Tag Extensions ........................................................................................................... 5-2
Quality Information .................................................................................................... 5-3
Additional Tag Extensions ......................................................................................... 5-9
Manage Tag Extensions ........................................................................................... 5-18
CHAPTER 6: GRAPHICS ENHANCEMENTS .................................................................. 6-1

Overview - Graphics Enhancements .......................................................................... 6-1
Graphics Enhancements and Popup Pages ................................................................. 6-2
CHAPTER 7: SYSTEM SECURITY ................................................................................. 7-1

Overview .................................................................................................................... 7-1
Server Access Authentication..................................................................................... 7-2
Vijeo Citect Upgrade Manual Release 1 iii
Roles ........................................................................................................................... 7-4
AutoLoginMode Parameter ........................................................................................ 7-9
Multi Signature Support ........................................................................................... 7-10
CHAPTER 8: COURSE SUMMARY ................................................................................ 8-1

Overview .................................................................................................................... 8-1
Summary - Vijeo Citect Upgrade ............................................................................... 8-2
Course Evaluation ...................................................................................................... 8-3
Further Training.......................................................................................................... 8-4
Examinations .............................................................................................................. 8-6
APPENDIX A: MY APPENDIX ....................................................................................... A-1
iv Version 7.20 November 2010

Chapter 1: Introduction to Upgrading Vijeo Citect
Overview
Introduction
Upgrading your existing Vijeo Citect system requires careful planning to ensure
that the upgrade is successful. The procedures will change depending on your
current version of Vijeo Citect. The older your version the more steps that are
required.
Vijeo Citect has undergone many changes between Version 6.10 and Version 7.20.
Version 7.20 of Vijeo Citect includes new features and developments that may
impact the functionality of projects created using earlier releases. This training
course steps you through the most common procedures for a successful upgrade and
many of the new features in Vijeo Citect Version 7.20.
This Chapter Covers These Topics:
 Before the Course Begins ...................................................... 1-2

 Course Overview ................................................................... 1-3
 Conventions Used in this Manual .......................................... 1-5
Before the Course Begins
Course
Instructor Please write the name of the Instructor here  ____________________
The course Instructor will be spending the next one day with the class, and will
guide all students through this training course. The Instructor is an experienced
Vijeo Citect user so please feel free to ask questions.
Scope of this This training manual is a supplement to the authorised training. In order to make
Training Manual proper use of the software students should also refer to the Online Help and Vijeo
Citect Knowledge Base.
The graphics displaying screen shots have been taken using the Windows XP
operating system using Classic mode display properties. If students are running a
different version of Windows then screens may differ slightly from the ones shown
in the training manual.
Some screen shots may have been taken from beta versions of the software and may
vary slightly from release screen shots.
1-2 Version 7.20 November 2010

Course Overview
Course By the completion of this training course students will be able to:
Objectives
 Upgrade previous project versions
 Implement the content within the new Tab_Style_Include project
 Use Server-side On-line Changes
 Take advantage of the Tag Extensions functionality
 Use Named Associations and Metadata
 Enhance system security using Roles
Target Audience The Vijeo Citect Upgrade training course is an integral part of the complete
Educational Services curriculum. This course is designed for:
 Engineers who have attended the full course curriculum using previous
versions of Vijeo Citect
Prerequisite The Vijeo Citect Upgrade training course is set at the Advanced level within the
Knowledge Educational Services curriculum. Therefore, some prerequisite knowledge is
necessary before enrolling in this course.
 Students attending this course must be familiar with Windows Operating

Systems
 Students should have attended all Vijeo Citect training courses or should be
familiar with the content and concepts within those courses
Course Material Please take a few moments to have a look through the Training Pack. In addition to
this manual, many training centres will provide one or more of the following items:
 Compendium
 Mouse Pad
 Pen
 Notepad
 Memory Stick
 The current version of Vijeo Citect on CD or DVD Rom
Vijeo Citect Upgrade Manual Release 1 1-3

Course Overview (cont.)
Course Assets For this course, in addition to the standard Vijeo Citect software, the following files
are required.
Pulp_V610_R1.ctz A fully configured V6.10 project to display the

operation of a simple Wood Chip Mill.
Upgrade_Include A V7.20 include project containing additional

resources required for the execution of the course
Colorpik.exe RGB colour management tool.
These projects may have been restored onto the students' computer by the
Instructor. If they have not, students will have to restore themselves according to
guidance from the Instructor.
Course Program This training course will take one day to complete. The following program outlines
the topics that will be covered:
Day Topics
1  Upgrade Projects
 Tab_Style_Include Project
 On-line Changes
 Tag Extensions
 Graphics Enhancements
 System Security
Support If support or additional information about any concepts or products in the course is
required, students should ask the Instructor who will either address the issue or
obtain additional technical assistance as required.

Conventions Used in this Manual
Objectives These are the skills to be achieved by the end of each chapter. An overview
providing a brief synopsis of the topic begins each section. Often, examples are
given to illustrate the conceptual overview.
Example -
The Vijeo Citect configuration environment consists of several toolbars, browser
windows and programming editors. This chapter introduces the user to the
configuration environment using an example project with pre-defined elements.
Exercises After a concept is explained, students will be given exercises that practise the skills
just learned. These exercises begin by explaining the general concept of each
exercise and then step-by-step procedures are listed to guide students through each
procedure.
Example -
Paste a genie from a library in the Include project onto a test page called Utility.
1 Run the Milk_Upgrade project then trigger and view some alarms.
i. Use the following template settings:
User Input Whenever information is to be typed into a field or dialog box it will be written in
this font:
Example -
KETTLE_TEMP/25
Note that some exercises will show a fragment of information already typed into a
Vijeo Citect screen and then ask students to add extra lines of configuration. In this
instance, the previously entered material will be given to the student as pale grey
italic text:
KETTLE_TEMP/25
OVEN_TEMP/5

Conventions Used in this Manual (cont.)
Hints and Tips This heading will provide students with useful or helpful information that will make
configuring the project easier
Example -
 Hints & Tips

To go to the next field, use the mouse cursor or press the TAB key.
Note A note will refer to a feature which may not be obvious at first glance but
something that students should keep foremost in their minds
Example -
 Note:
Any events named GLOBAL are enabled automatically when events are enabled.
Menus and Menu Text separated by the double arrow symbol “»” indicates that users are to select a
Options menu
Example -
File » New…
Open a menu “File” then select the menu option “New…”
Horizontal and Text written this way indicates the Horizontal then the (Vertical) tab to be selected.
Vertical Tabs
Example -
Appearance (General)

Conventions Used in this Manual (cont.)
See Also Text written in this way indicates further references about the current topic.
Example -
See Also:
For further information about Templates, see Vijeo Citect Help - Using Page
Templates.
Further Training This heading describes topics that are covered in more advanced courses.
Example -
Further Training:
Trend Table Maths is a topic in the Vijeo Citect Customisation and Design
Course.
Caution This heading describes situations where the user needs to be careful.
Example -
 Caution!
If restore is configured for Current project, then the currently selected project in
the Citect Explorer will be overwritten.

Chapter 2: Upgrade Projects
Overview
Introduction
There are many steps involved in performing a successful upgrade of Vijeo Citect
from the earliest versions up to the most current. This section deals with the steps
necessary to perform a successful upgrade as well as some of the most common
pitfalls.
 How to Prepare for an Upgrade ............................................. 2-2

 System Requirements ............................................................ 2-3
 Upgrade the Citect License .................................................... 2-5
 How to Upgrade the Projects ................................................. 2-8
 Installing and Managing Multiple Versions ........................ 2-11
 Known Pitfalls ..................................................................... 2-24
 The Upgrade Process ........................................................... 2-27
How to Prepare for an Upgrade
Getting Started Performing a successful upgrade requires different procedures depending upon the
original version of Vijeo Citect. The older the version the more steps required to
perform an upgrade.
Back Up Existing Possibly the most important step in an upgrade procedure is to back up the existing
Files files. If the upgrade fails somewhere, or the project is not suitable for an upgrade, a
method to restore the system to its original state must be available. Ensure that
there are at least two separate backups of the existing project in the original version,
plus all other associated files, such as citect.ini files for each server and clients, as
well as drivers for specific I/O Devices.
File Default Location

Citect.ini C:\Windows
Project Files C:\Schneider Applications\Vijeo Citect\Vijeo
Citect 6.10\User
Driver Files (if you are using any special I/O C:\Program Files\Schneider Electric\Vijeo
Device Drivers Citect\Vijeo Citect 6.10\Bin
Copy these files to separate locations that are considered safe e.g. to disk or on a
network server. Restore these backups onto a non-critical Vijeo Citect computer to
ensure that they are reliable. People often make backups that are corrupted or do
not work. This is a terrible situation to live through. People believe that that have
done the right thing by backing up all their data, but because they have never tested
the backup, the do not realise that it did not work. Please test all backups before
proceeding any further.
Prepare the The safest way to upgrade a project is to use a new computer that is not needed for
Computer the functioning of the Vijeo Citect system. This way if something goes wrong with
the upgrade time will not be lost due to a computer that is not functioning.
Format this computer so that the installation proceeds from a totally clean hard
drive. Uninstalling software does not always remove every module associated with
old software, for example some may be marked as shared but not needed. If it is
considered that this upgrade is important, please format the hard drive.

System Requirements
Before the Before installing CitectSCADA or Vijeo Citect the computer that will be used as
Installation of the Server needs to be configured. Vijeo Citect has been designed for machines
Vijeo Citect with the following specifications:
Hardware The computer equipment may need to be upgraded to run Version 7.20, as the
Requirements minimum hardware requirements have changed:
Description Minimum Specification

Processor Intel Pentium 3
Processor Speed 1 GHz
Random Access Memory (RAM) 500MB or 1GB if running Windows Server 2003, or if
running a Web Server (2GB if running both Windows
Server 2003 and a Web Server)
Available Disk Space 80GB, or 160GB if running a Web Server
Graphics Adapter 1024 x 768 pixel resolution, with 64MB of VRAM if
using Process Analyst
Description Recommended Specification or Higher

Processor Intel Pentium 4
Processor Speed 3.2 GHz
Random Access Memory (RAM) 2GB for all supported operating systems, or 3GB if
running a Web Server
Available Disk Space 160GB or 256GB if running a Web Server
Graphics Adapter 1024 x 768 pixel resolution, with 128MB of VRAM if
using Process Analyst

System Requirements (cont.)
Software
Requirements Vijeo Citect Component Minimum System Software
Vijeo Citect Server Windows XP Professional with Service Pack 2 and
Service Pack 3 - (32 and 64 Bit)
or
Windows Server 2003 Standard Edition with Service
Pack 1
or
Windows Server 2008 Standard Edition with Service
Pack 2
or
Windows Vista with Service Pack 2 (32 and 64 Bit)
or
Windows 7 (32 bit or 64 bit)
and
Microsoft .NET Framework 3.5 with Service Pack 1
(installed with Vijeo Citect if required)
Internet Explorer Version 7.0
A Local Area Network (LAN) for clients to gain
access to the server
If running under virtualization with VMWare, the
minimum system requirement is VMWorkstation
6.03 and later.
Note: Due to compatibility issues between VMWare
Workstation and the SafeNet Sentinel hardware
protection key, Vijeo Citect cannot run in a
virtualized 64 bit environment.
Vijeo Citect WebServer As for Vijeo Citect Server, with the addition of:
A New Technology File System (NTFS)
A LAN running TCP/IP and
Microsoft Internet Information Services (IIS)
Vijeo Citect Knowledge Base As for Vijeo Citect Server

Driver Update Tool As for Vijeo Citect Server
Time Scheduler As for Vijeo Citect Server
Batch As for Vijeo Citect Server
 Note:
The target drive for the Web Server software must use an NTFS file system,
otherwise the required Windows security settings will not be available (that is, the
Folder Properties dialog will not have a Security tab). If the computer is currently
using a FAT/FAT32 system, ensure that the drive is converted to NTFS before
installing the Web Server software.

Upgrade the Citect License
The Citect A Vijeo Citect licence is programmed into a device called a Hardware Protection
License Key, sometimes referred to as a dongle. If Vijeo Citect is run without a key it is
only able to be run in Demonstration (or Demo) mode. Demonstration mode
allows you to use all the features of Vijeo Citect normally, but with restricted
runtime and I/O.
The following demonstration modes are available:
 15 minutes with a maximum of 50,000 real I/O.

 10 hours with no static points and a maximum of 1 dynamic real I/O. This is
useful for demonstrations using Disk I/O. Vijeo Citect will start in this mode if
no static points are configured and no software key is present.
Demonstration mode is useful for configuration away from the real system and to
test the product, however if Vijeo Citect is to be used in a real system then a licence
must be used.
When to Upgrade Vijeo Citect keys must be updated between major releases. A major release is an
the Key increment in the first digit after the decimal point of the version number. For
example if you are upgrading from V5.2 to V5.3 you will need to update your key.
However an upgrade from 5.3 to 5.31 or upgrading to a Service Pack does not
require a key upgrade.
Key upgrades are free for customers holding a current support contract.

Upgrade the Citect License (cont.)
Upgrade the Key The Vijeo Citect licence may be updated by fax, phone, email. If internet access is
available the key may be updated online. The program Ciusafe.exe needs to be
installed on the same computer as the key. This file is located in the \Bin directory
or it can be downloaded from www.citect.com. Most commonly, it is accessed
from the menu Citect Explorer Help » Citect Key Update.
When Ciusafe.exe is run it will look something like this (here demonstrating a
dongle already upgraded to Vijeo Citect Version 7.20).
If the information is sent via email, fax or phone the Serial Number, which can be
found on the printed label on the key, and the Key ID will need to be included.
Serial Number 0478-12345
Key ID ABCDEFGHIJKLMNOPQRSTUVWXYZ
 Note:
As with most versions of Vijeo Citect, dongle upgrades must be performed as a pull
operation. In other words, the new version of Vijeo Citect should be installed, then
the dongle should be upgraded using the latest version of CiUSAFE included with
the new version.

Upgrade the Citect License (cont.)
Upgrade Online If Internet access is available the Online Authorisation Code Generator, located
in the Customer Service Area of the Citect website, may be used.

How to Upgrade the Projects
Restore Projects In order to perform a successful upgrade the new version must first be installed then
into the New the projects are restored into the new version. If the original projects are not
Version restored into the new version but instead are just pointed to the new version, the
upgrade will not be successful. There are a lot of behind-the-scenes things going
on during an upgrade (these change from one version to another) that must happen
for a successful upgrade. These will only happen if the project is restored into the
new version.
Whenever a project is restored, inter-project dependencies are checked. For

instance, any included projects will be checked for existence. For this reason, it is
important to restore Included projects prior to Master projects to ensure they do in
fact exist prior to the test being performed.
If the upgrade procedure does not follow this sequence, the upgrade process may be
interrupted or even corrupted.
Upgrade Version Many releases of Vijeo Citect may build on technologies introduced in a previous
Process version. Therefore, Schneider Electric recommends that a sequential upgrade be
performed.
In order to keep the software from excessive ‘bloat,’ each version only includes
functionality to upgrade from the most recent significant version.
For example, when performing an upgrade from early version 5.00 releases the
following upgrade path is recommended:
 Version 5.21 Service Pack G

 Version 5.42 Service Pack B
 Version 5.50 Service Pack B
 Version 6.00 or 6.10
 Version 7.0, Version 7.10 or Version 7.20

How to Upgrade the Projects (cont.)
Upgrade Issues Version 7.20 of Vijeo Citect includes new features and developments that may
impact the functionality of projects created using earlier releases so there are a
number of things to consider before migrating projects to Version 7.20 from
Version 6.x. These considerations relate primarily to the introduction of new
features, or changes to existing functionality.
The following list identifies some of the changes which will have low impact on
existing Vijeo Citect Version 6.x projects when they are migrated to this version.
These changes can optionally be incorporated into existing projects during later
development, or may be ignored if they are of no benefit to the way that Vijeo
Citect is used in your organization.
 Improved support for Clustering

 Online Changes for Clients
 Server Side Online Changes
 New communications architecture
 Improved hardware alarms
 Event driven Cicode
 Windows Integrated Security
 Multi-Signature Support
 New Font Selection for Graphics Button
 New Alarm Field Enhancements
 Runtime Writes to Custom Alarm Fields
 New Time Synchronization Service
 Improved Installation process
 Control SCADA Client Connections
 Dynamically Optimised Writes
 Graphics Enhancements
 Performance Improvements
 Persisted I/O Memory Mode
 Post Compile Commands
 Supportability Enhancements
 Tab Menu Templates
 Tag Extensions
 Note:
It is optional to utilise the clustering capabilities, however, after installing Vijeo
Citect Version 7.20 a minimum of one cluster must be created.

How to Upgrade the Projects (cont.)
Changes The following list identifies functionality changes that may impact migration of
Impacting existing projects to Vijeo Citect Version 7.20:
Migration
 Network Support
 Local Variables
 Publish Alarm Property
 Dual Network Support
 Project-Based Network Configuration
 Parameters and Cicode Functions
 New Location for Configuration and User Files
 Enhanced Driver Installation
 Microsoft Windows Vista and Windows 7 Support
 Improved Security
See Also:
Schneider Electric highly recommends that all known Upgrade issues are examined
before upgrading to the latest version of Vijeo Citect. To view the latest
information regarding Upgrade issues, see Vijeo Citect Knowledge Base » Vijeo
Citect » Upgrade Issues Version 7.20.

Installing and Managing Multiple Versions
Environment Once the computer has been prepared Vijeo Citect needs to be installed. Be aware
Manager that if the upgrade proceeds from a ‘distant’ version, more than one version of
Vijeo Citect may need to be installed. See Upgrade Version Process for more
information regarding this process.
Like most programs run in the Windows environment it is possible to select the
location of the program during the installation. However, each of the Vijeo Citect
versions needs to have its own citect.ini file.
Prior to Version 7.0, recommended best practice was to retain all citect.ini files in
the C:\Windows folder and to rename each to reflect the relevant Vijeo Citect
version number. This recommendation has changed for versions of Vijeo Citect
from Version 7.0; it is now suggested that each version retains the matching .ini file
in the appropriate [BIN] folder. Additionally, it is wise to ensure that project files
are isolated. Exercise - Set Up the Environment Manager (page 2-13) guides
students through the process of modifying any current installation and preparing
Version 7.20 to conform with the new regime.
Where multiple versions are required on a single computer, it is strongly

recommended that the versions are installed in their release order to allay issues
with the security software sentinel.com which manages the licensing of the Vijeo
Citect key.
Various versions of Vijeo Citect will use different software libraries (DLLs) that
are typically stored in common locations such as C:\Program Files\Common
Files\Schneider Electric. When a new version is installed, older versions of the
files are overwritten. This means that older versions of Vijeo Citect are unable to
run.
A utility called Environment Manager has been created to assist in exchanging the
relevant files for the most significant versions of Vijeo Citect

Installing and Managing Multiple Versions
(cont.)
Environment
Manager (cont.)  Note:
This utility is included on the Vijeo Citect Version 7.20 Installation Disk. The
installation file may be downloaded from the Schneider Electric website also. For
more information, contact your local Schneider Electric distributor. A MyCitect
account is required to gain access to the downloadable files on the website.
 Note:
If an installation of Vijeo Citect has never been run, Environment Manager will not
be able to locate it as the citect.ini file will not have been initialised.
See Also:
The Environment Manager has considerably more functionality than is described in
this chapter. For further information about Environment Manager, see Vijeo Citect
Help - <Help Subject>.
How to Swap  To change between Vijeo Citect product versions:

between Versions
Run the Environment Manager.
Right click the Vijeo Citect version that will be made the Current Active Version
and select Make active from the menu.

Exercise - Set Up the Environment Manager
1 Run then close Vijeo Citect Version 6.10.

i. Run the installed version of Vijeo Citect Version 6.10 and confirm
proper functionality.
ii. Open the Citect Explorer and select Tools » Computer Setup Editor
from the menu. Confirm the version of the citect.ini linked to this
version of Vijeo Citect. Note the location of this file.
iii. Close Vijeo Citect V6.10.
2 Move the version specific citect.ini file to the [BIN] folder.

i. Run the Environment Manager Utility. This is located by default in
Start » Programs » Schneider Electric » Environment Manager
v2.15.
This is the dialog that will appear:

(cont.)
ii. Highlight the Vijeo Citect V6.10 Release entry. Right click this entry
and select Properties from the menu.
iii. Click the Move INI to BIN... button.

(cont.)
3 Capture the common files.

i. The purpose of the Environment Manager is to manage the different
versions of common files. If you wish to swap between different
versions of Vijeo Citect you need to save or Capture the files that are
needed to run each version. Right click the Version 6.10 entry and
select Capture common files... from the menu.
If the Current Active Version is Unknown the Capture common

files...option will not be available. Select Make Active from the
menu.

(cont.)
ii. The Environment Manager will prompt to proceed. Click Yes to

continue.
The final screen verifies that the files have been saved. Click OK to
continue.

Exercise - Install a New Product Version
1 Install Vijeo Citect Version 7.20.

i. Install the supplied version of Vijeo Citect Version 7.20. The course
Instructor will advise how to do this.
ii. When the Destination Folder screen appears ensure that this version
will be installed into a different location from any of the previous
versions.
 Caution!
All installation paths MUST be distinct from the installation paths of previous
versions. This will ensure that all required version files and all standard projects
(Include, Tab_Style_Include etc) are available to all versions.
iii. Click Next and proceed to the end of the Installation wizard.
iv. As Vijeo Citect does not support multiple versions running side-by-
side by default, an Installation wizard warning will display advising
the removal of existing versions before continuing with the
Installation. Click Yes to continue, as Environment Manager will be
used to manage the coexisting versions.

Exercise - Install a New Product Version (cont.)
2 Run the newly installed Vijeo Citect Version 7.20.

i. Start Vijeo Citect Version 7.20 from the Start menu, Start »
Programs » Schneider Electric » SoCollaborative » Vijeo Citect
7.20 » Vijeo Citect Explorer.
ii. Close Vijeo Citect Version 7.20.
iii. Run the Environment Manager and check for the new installation.
iv. If the new installation has not been listed, select Installations » Scan
this PC... from the menu to scan the computer for new versions.
v. Select a scan of the local hard disks (C:) and click Scan.
vi. Environment Manager will scan the selected drive and list the results
upon completion. Click Save to continue.

Exercise - Install a New Product Version (cont.)
3 Review Properties and Capture Common Files.

i. Right click the new installation, and select Properties. Note that
there is no option to Move the INI file as seen previously, as the
default location of the INI has been changed (as of Version 7.10) to a
product and version specific location.
ii. Click OK to close the Properties window.

iii. Right click the new installation, and select Capture Common Files.
iv. The Environment Manager will prompt to proceed. Click Yes to
continue.
v. An Information dialog verifies that the common files have been

saved. Click OK to finish.

Exercise - Swap between Vijeo Citect Versions
1 Use the Environment Manager to return to Version 6.10

i. The Environment Manager will now display two product entries. The
Version that us currently set to run is called the Current Active
Version. This version is listed in bold and displayed in the lower
pane of the Environment Manager window.
ii. In order to swap between versions the Current Active Version needs
to be changed. Right click the Vijeo Citect V6.10 entry and select
Make active.
The Environment Manager will reinstall the captured files from

Version 6.10. When this process is complete the Current Active
Version will change to Version 6.10.

(cont.)
2 Run a project to test that the Citect Runtime runs correctly.

i. Right click the Vijeo Citect V6.10 entry and select Start configuration
environment from the menu. Vijeo Citect V6.10 will open in the
configuration environment.
ii. Restore the file Pulp_V610_R1.ctz. The course Instructor will advise
where this is located.
iii. Run the Computer Setup Wizard in Custom mode, making sure all
the Events are enabled.
iv. Run Pulp_V610_R1 to test that the version will run correctly.
v. Open the WoodChip page and observe the Bark Drum Speed and
Chipper Speed Setpoints - these rely on Memory PLC tags; observe
also the Normal object - this relies on an Alarm device. Adjusting
the Digester Temp slider will set this object to show either Cold,
Normal or Overheat.
vi. Neither Memory PLCs nor Alarm Devices are supported from Version
7.0 onwards. The next exercise will address these issues.

(cont.)
3 Shutdown Vijeo Citect Runtime and Close this version.

i. Close the running project.
ii. Close Vijeo Citect v6.10 by switching to the Citect Explorer and
closing the application.
4 Prepare the computer to use Vijeo Citect Version 7.20 using the
Environment Manager, but do not run Vijeo Citect just yet.
i. Run the Environment Manager.
ii. Right click the Version 7.20 entry and select Make Active.



Known Pitfalls
Creation of Roles User Security is handled differently under Vijeo Citect Version 7.20. Previously,
each User was defined with Area and Privilege levels that determined what each
could and could not do, or access in the runtime system.
Under Version 7.20, Area and Privilege levels are defined as a set of permissions as
a Role. These Roles are then assigned to Users. The Migration Tool provides an
option to migrate the existing project Users database so that Roles are created
automatically based on existing permissions.
Removal of Alarm Devices were used in previous version of Vijeo Citect to access the current
Alarm Devices property of an Alarm Tag, for example, whether it is in High-High state. The
Publish-Subscribe model for tag data exchange introduced with Version 7.0 made
Alarm Devices redundant, as the Alarm Server could be configured to publish this
data directly.
With Version 7.20, the Alarm Server reuses the Alarm Properties Port. As a result
of this, Alarm Properties are always published for configured Alarm Servers and an
Alarm’s Properties carries not only Value, but also items similar to Tag Extensions
Items (see Tag Extensions (page 5-1)). The Alarm reference syntax is now:
[Cluster.]Alarm.AlarmProperty[.Item] where
Cluster The optional Cluster Name
Alarm The Alarm Name
AlarmProperty The Alarm Property Name
Item The optional Item name. If the item name is not specified, the
Value of the Alarm Property is referenced. Available items
are:
Value V
Value Timestamp VT
Quality Q
Quality Timestamp QT
Overall Timestamp T

Known Pitfalls (cont.)
Removal of The new clustered structure of Vijeo Citect precludes the use of Memory I/O
Memory I/O Devices. All tags links to such devices will be replaced with local variables.
Devices
Dual Network Previous versions of Vijeo Citect supported network redundancy via NetBIOS.
Support Since NetBIOS is no longer used, users are able to specify multiple IP addresses for
each server, permitting native support for network redundancy.
Project-based Many parameters (such as server names and locations) that used to be configured in
Network the Citect.ini file are now accessed via a new Server menu in the Project Editor.
Configuration
Cicode Functions A number of Cicode functions have undergone revision. Notably the ReRead()
function is no longer required to maintain currency of data under the Publish-
Subscribe data model. A full list of additions, deletions and modifications is
available in the “What’s New in Vijeo Citect V7.x” section of the on-line help.

Known Pitfalls (cont.)
Accumulators Accumulators keep track of incremental runtime data, such as motor run hours,
power consumption, and downtime. Each accumulator may have a trigger set (eg.
motor on) to increment three counters:
 The number of times the accumulator is triggered (eg. the number of starts for
the motor).
 The run time, in seconds.
 A totalised value, by an increment defined in the project (eg. the current).
Configuration changes in Version 7.20 have caused additional fields in the
Accumulators form to be mandatory. The Totalizer and Totalizer Inc fields must
now be completed when upgrading previous version projects containing
accumulators.

The Upgrade Process
Three Stage Upgrading has become a 3-stage process from Version 7.0 onwards:
Process
 Restore and open a project from a previous version
 Create a Cluster
 Run the Migration Tool
Firstly, as with previous versions, restoring and opening a V6.10 project will cause
an automatic upgrade. The automatic upgrade process will extend the table
definitions for those .dbf files where new fields have been added and also add
additional project files that are new to Version 7.20. Note that if you cancel the
automatic upgrade process, you can reinstate it by setting the ini file parameter
Update to true.
Secondly, there are two manual tasks to perform. The first of these is the creation
of a Cluster, the other is to run the Migration Tool which located on the Tools
menu of either Citect Explorer or Project Editor (but not Graphics Builder).

The Upgrade Process (cont.)
Migration Tool After the first two steps are complete, the last stage is to run the Migration Tool,
located on the Tools menu of both the Citect Explorer and Project Editor
applications. The Migration Tool is a separate application which should be run
manually after the automatic upgrade has been executed, and initiated after the
project has been prepared for final migration. This tool will address the critical
changes in project functionality in Version 7.20 so it is important that existing
projects are prepared for a successful upgrade using this tool.
First consideration is the removal of Memory I/O Devices. From Version 7.0
onwards Vijeo Citect no longer supports Memory PLCs. Review the project to
identify which memory I/O Devices are Local Variable holders and which ones
need to be changed to non-memory so that the Migration tool does not convert their
variables. The Migration Tool will set any I/O Device's port which is identified as a
Memory device to the new Local Variable, and the original device record will be
deleted.
Vijeo Citect from Version 7.0 onwards no longer supports Alarm Device types– the
functionality of such devices has been included in the Publish-Subscribe
implementation. Additionally, from Version 7.20, the Alarm Server reuses the
Alarm Properties Port. As a result of this, Alarm Properties are now always
published for configured Alarm Servers. Therefore the Migration Tool will delete
all Alarm Devices but no extra engineering is required to maintain functionality.

The Upgrade Process (cont.)
Migration Tool Another consideration is Roles. When upgrading an existing project using the
(cont.) Migration Tool, a new Role will be created (if needed) for every existing User. The
new Role will have the same security settings that were defined for that User and be
given a generic name such as Role_1, Role_2 etc. During the upgrade process, if a
Role exists with the same security settings as the User, then the existing Role will
be assigned to the User being upgraded. For example; If Role_1 exists and matches
the security settings of the upgraded User then that User will be assigned Role_1
also.
The option to Copy the existing XP_Style menu into a Tab_Style Menu is
available to convert legacy menu entries to the format required by the new menu
configuration system. By default this option is unchecked, to avoid potential
compile errors that may occur after migration if the legacy menu.dbf contains
functions which have been removed.
Lastly, consider whether to Migrate Included Projects as well as the selected

project.
 Note:
Selecting both Copy XP Style menu into Tab_Style Menu and Migrate Included
Projects when the Migration Tool runs will generate a warning message regarding
conflicts. To avoid potential conflicts, it is recommended that the Migration Tool is
run twice - the first time selecting the Menu Copying option, the second time to
migrate the Included Projects.

Exercise - Upgrade a Project
Upgrade a project created in an earlier version of Vijeo Citect to Version 7.20.
1 Open Vijeo Citect Version 7.20 from the Environment Manager.

i. Restore the Version 6.10 project Pulp_V610_R1.ctz.
ii. Restoring a project triggers an Automatic Update. Click OK to
continue.
iii. A progress window will track the update
2 Prepare the project for migration.

i. Open the Citect Project Editor.
ii. Select Tools » Options… from the main menu. Check that
Incremental compile is turned off.
iii. Select File » Pack from the Citect Project Editor main menu.
iv. Run the Computer Setup Wizard. Note the warning that the
currently selected project is not compiled. Cancel the wizard.
v. Compile the project. Note the number of errors.

Exercise - Upgrade a Project (cont.)
3 Configure the Cluster and Servers.

i. Vijeo Citect Version 7.0 onwards requires that all projects must have
a defined Cluster name. If the project has Alarms, Reports or
Trends configured then the project must also have named Alarm,
Report and Trend Servers defined in the project (rather than in the
Setup Wizard as was done in versions prior to 7.0). Open the Project
Editor and select Servers » Clusters. Name the cluster Pulp then
click Add.
ii. Select Servers » Alarm Servers.

iii. Select the Cluster Pulp from the dropdown list in the Cluster Name
field.
iv. Name the Alarm Server PulpAlarm then click Add.
v. Select Servers » Report Servers. Add the Cluster Name Pulp and
name the Report Server PulpReport.
vi. Select Servers » Trend Servers. Add the Cluster Name Pulp and
name the Trend Server PulpTrend.
vii. Compile the project. Notice that most of the errors have been
resolved. The remainder are addressed by the Migration Tool.
4 Confirm the existence of the Alarm and Memory I/O Devices.

i. Open the Project Editor and select Communication » I/O Devices.
ii. Scroll down the I/O Device list to confirm the existence of both
AlarmDevice and MemDev1.
iii. Close the dialog box.

5 Run the Migration Tool. This will delete all instances of Alarm and
Memory I/O Devices.
i. From the Project Editor, select Tools » Migration Tool. Select the
required options, and click the Migrate button to begin the process.
This will take a few moments to execute.
ii. On completion, an Information window displays the results of the

migration. Click OK to close.
iii. Click Close to close the Migration Tool.

iv. Re-open the I/O Devices dialog box and observe both the Alarm and
Memory PLC devices are no longer present. The remaining I/O Device
PulpDevP is a Disk I/O Device that provides system-wide global
variable tags that are managed by an I/O Server.
 Note:
Vijeo Citect Version 7.20 includes a feature called Persistence which may be
applied to I/O Devices. Persistence applied to I/O Devices in Memory Mode
provides an alternative to Disk I/O Devices as synchronisation is supported in
scenarios where a server becomes unavailable for a period of time.
See Also:
For further information about Persisted I/O Devices, see Vijeo Citect Help - Using
Persisted I/O Memory Mode.

v. Tags that were previously linked to the Memory I/O Device are now
located under a new entry Tags » Local variables in the Project
Editor. Check that the Setpoint tags exist here.
vi. Open the Migration Log and review the changes implemented as
part of the migration. By default, this log will be located at
C:\Documents and Settings\All Users\Application
Data\Citect\CitectSCADA
7.20\User\Citect.CitectSCADA.Migration.log.
Note the creation of Roles and Local Variables.

6 Test the project.

i. Compile the project and start the Computer Setup Wizard for the
Pulp_V610_R1 project in Custom Setup mode.
ii. Step through the Wizard, selecting options as below:
Wizard Screen Parameters

Computer Role Setup Server and Control Client
Multi-Process
Network Setup Stand alone
Alarm Server Properties Setup defaults
Report Server Properties Setup defaults
Trend Server Properties Setup defaults
CPU Setup defaults
Events Setup Enable All Events on the Client computer
Startup Functions Setup Client - StartUp()
Cluster Connections Setup defaults
Server Authentication C1tectr@1n
Configure Server User defaults
Security Setup - Control Menu defaults
Security Setup - Keyboard defaults
Security Setup - Miscellaneous defaults
General Options Setup Startup page: PulpHome
 Note:
New screens have been implemented to the Computer Setup Wizard as part of
Version 7.20 Security enhancements (these will be covered in the chapter System
Security (page 7-1)).
iii. Run the project.
iv. Log in as the user Designer. The password is des.
v. Observe that the running project is indistinguishable from the v6.10
environment. Test the operation of the Setpoint tags and the
Normal object to confirm the actions of the Migration Tool.
vi. Shutdown the project.

Summary
Summary In this chapter you have learned the following topics:
 How to Prepare for an Upgrade (page 2-2)

 System Requirements (page 2-3)
 Upgrade the Citect License (page 2-5)
 How to Upgrade the Projects (page 2-8)
 Installing and Managing Multiple Versions (page 2-11)
 Known Pitfalls (page 2-24)
 The Upgrade Process (page 2-27)
Questions The following questions are to check your understanding:
 When preparing for an upgrade, what are the most important files to be backed
up?
 In order to perform a successful upgrade, name two of the steps that must be
followed.
 How do you allow for different versions of Vijeo Citect to run?
 Which components of a project are affected by the Migration Tool?
 Where is the latest information regarding upgrade issues available?

Chapter 3: Tab_Style_Include Project
Overview
Introduction
The Tab_Style_Include Project is a preconfigured project that is installed with
Vijeo Citect. Designed to reduce the amount of time required to configure a new
project, it includes a set of templates and a standard startup page styled for the
Windows environment.
When a new Vijeo Citect project is created using the Tab Style, the
Tab_Style_Include project is incorporated as an included project automatically.
This means that all of the project's templates and associated content are available
for implementation when creating a new graphics page in the Citect Graphics
Builder. The project created using these templates will have a Windows Tabbed
design style.
 Using Tab Style Templates .................................................... 3-2

 Trend Templates .................................................................... 3-4
 Alarm Viewing ...................................................................... 3-9
 Menu Configuration ............................................................. 3-19
Using Tab Style Templates
Common All the templates in the Tab_Style_Include Project include common elements that
Toolbars provide a consistent look and feel to the built-in graphics templates. Also, the
updated templates incorporate frequently used features, such as Menus, Page
Navigation, Trend and Alarm Viewing which previously required customised
engineering. This will significantly reduce configuration time for new projects.
To allow seamless upgrade from the CSV_Include templates to the new templates,
the layout of the new base template has been based on the equivalent one in the
CSV_Include project. In contrast though to the templates in the CSV_Include
project, the title bar will no longer be drawn within the template. It is expected that
the Windows title bar is shown at runtime instead.
Custom Menus The Tabbed Menu provides multiple tabs capable of navigating to a specific page
Toolbar or calling a Cicode function. The content of the tabs is generated though the Menu
Configuration option in Project Editor.
Navigation The Navigation Panel provides navigation buttons and direct access to key pages
Toolbar such as the Login tool and the Forward / Back and Home buttons.
Alarm Toolbar The Alarm toolbar provides access to Alarm pages and displays the last three active
alarms.

Exercise - Apply Tab_Style_Include Templates
1 Include the new Tab_Style_Include project

i. Ensure the Pulp_V610_R1 is selected within Citect Explorer.
ii. Open the Project Editor.
iii. Choose System » Included Projects from the menu.
iv. You will see that the project CSV_Include is already listed from
previous configuration. Type Tab_Style_Include in the Project Name
field and click the Add button.
2 Apply the latest Normal template to the main page in the

Pulp_V610_R1 project.
i. Open the page WoodChip.
ii. Select File » Properties from the menu. Open the Appearance tab
and select the Designed for showing title bar checkbox.
iii. Change the Style to tab_style_1 and click OK to apply the new
Normal template and close the Properties window.
iv. Save the page.
v. Apply the new Normal template to the PulpHome page using the
same technique as above.
vi. Save the change.
vii. Run the project and view the changes. In particular, note how the
tabbed menu has been created based on the previous menu
configuration within the Included projects. The Menu Configuration
will be updated in Menu Configuration (page 3-19).
viii. Shut down the project.

Trend Templates
Viewing Trends In Vijeo Citect Version 7.20, Trends are viewed using the Process Analyst, an
ActiveX control designed to allow operators to view Trend data from a Vijeo Citect
Trend Server, and Alarm tag data from a Vijeo Citect Alarm Server. The Process
Analyst provides a visual means to analyse and compare Trend data (real-time and
historical) in a more intuitive manner than the Vijeo Citect previous Trend Viewer.
Process Analyst The Process Analyst template is the default template for the creation of Trend
Templates pages. The Tab Style project includes templates for the three following types of
Trend display:
 SinglePA
 DoublePA
 PopPA
The functionality of traditional Trends, Double Trends, and Popup Trends have
been incorporated into the new templates.
There is a key difference between the new Process Analyst templates and the
previous Trend templates, which is Pen assignment.
Pens are assigned to the page at both design time and runtime in the case of the
Trend templates, but all the Process Analyst templates have the pens assigned at
runtime only, for example by calling Cicode functions, or pre-loading Process
Analyst Views (.pav files).

Exercise - Create a Process Analyst Page
1 Create new pages for displaying Trends.

i. Open the Citect Graphics Builder and create a new page based on the
tab_style_1 singlepa template.
ii. Save the page as ProcessAnalyst.
iii. Create another new page, for Popup Trend displays, based on the
tab_style_1 poppa template.
iv. Save the page as !ProcessAnalystPopup.
2 Test the new Pages

i. Compile and Run the project
ii. Open the Process Analyst pages from the Trends tab menu.
iii. View Trend Tags to confirm functionality.

Other Data Sources
Variable Tags In addition to displaying trend lines for Trend tags and Alarms, the Process Analyst
and Local can also display "on the fly" trend lines for Variable Tags and Local Variables.
Variables Such trend lines are generally referred to as Instant Trends.
These alternate data sources are accessed via the Pen Type dropdown list.
Contrary to the behaviour of Trend tags; prior to identifying the Variable Tag for
display no data is available for drawing on the screen; thus the trend line will
commence at the moment the pen is identified.

Exercise - Variable Tag Trends
1 Select variable tags in Process Analyst.

i. Clear all Trend and Alarm pens currently being displayed.
ii. Click the Add Pens button to open the Add New Pen(s) dialog.
iii. On the Type: dropdown list, select Variable Tags.
iv. Then click the Search button.
A full list of the Variable tags defined in the Pulp_V610_R1 Project

will be displayed.
v. Select the Level Tags for the Bark Drum, the Bark Tank, the Chip Pile
and the Digester.
vi. Set the Pen Name to be Tag and click the Add button.

Exercise - Variable Tag Trends (cont.)
vii. Click OK to view the trend lines.
Observe that no 'historical' information is available for the selected

tags - the graphical display commences at the moment the pen set is
created.
viii. Shut down the project.

Alarm Viewing
Standard Alarm The Alarm Templates are the default templates for creating different types of Alarm
Templates pages for a project. Four templates are provided in the Tab_Style_Include project:
Alarm - for displaying Active alarms
Disabled - for displaying Disabled alarms
Summary - for displaying Summary alarms
Hardware - for displaying Vijeo Citect internal alarms
Alarm information is rendered field by field and displayed in a tabular format by

custom Cicode within the new Alarm templates. Additionally, the Alarm display
format is defined by a new set of INI parameters which allow the user to define
various display attributes.
These changes to the new Alarm templates provide extra user interactivity,
including:
 Resizing of a display column.

 Adding and/or removing columns at runtime.
 Re-ordering of columns on the page at runtime.
 Saving a View.
 Printing and exporting of the alarm list, including specifying the number of
pages.
 Generic filtering.

Exercise - Create Alarm Pages
1 Create the Active Alarms page.

i. In Graphics builder, create a new graphics page using these settings:
Style tab_style_1
Linked 
Resolution XGA
Template alarm
Title bar 
ii. Using the name Alarm, save the page into the Pulp_V610_R1
project.
2 Repeat for the other three Alarm pages.

i. Repeat the previous steps to create pages as follows:
Template Page Name

disabled Disabled
hardware Hardware
summary Summary

Exercise - Display Alarms
1 Run the Pulp_V610_R1 project then trigger and view some alarms.
i. Compile and run the project.
ii. Open the WoodChip page and trigger some alarms. When an alarm
is triggered the Active Alarm icon will start to flash.
The prompt message configured in the ON Action of the alarm

category will be displayed in the prompt line.
The Alarms Toolbar at the bottom of the page will display the three
most recent alarms.
 Note:
The time displayed with the alarm is taken from the I/O Server, not the Alarm
Server, as was true in previous versions of Vijeo Citect.
iii. Right click one of the alarms to open a menu. The first item on the
list will allow the operator to access further information regarding the
selected alarm. Select this Information option from the list.

Exercise - Display Alarms (cont.)
iv. This screen will open displaying the Alarm Information dialog.
v. These alarms may be acknowledged by right clicking the alarm and

choosing Acknowledge from the menu.
 Note:
The operator must be logged in as a user with a privilege level of 1 to be able to
acknowledge alarms; privilege level 8 is required to disable or enable alarms. The
required privilege level may be changed by setting the parameter
[Privilege]AckAlarms in the citect.ini file.

Exercise - Display Alarms (cont.)
2 View the alarms from the default alarm pages.

i. Click the Active Alarm icon.
ii. This will open the Alarm page.
iii. An Alarm may be acknowledged by right clicking the alarm and

choosing Acknowledge from the menu as demonstrated in the
previous exercise.

Exercise - Modify Alarm Display Appearance
1 Sort the order of alarms displayed.

i. Open the Active Alarms page.
ii. Hover the mouse over the Name column.
iii. Click on the Name button to sort the alarms in descending

alphabetic order.
iv. Click the button again to sort ascending.
v. Click one more time to return the values to their original order. Note
the small triangle symbol to the lower-right of the button to indicate
the sort order.
vi. Repeat the sorting for the Time and Tag columns. Observe that the
alarms cannot be sorted by the Description column.
2 Adjust the column widths.

i. Hover the mouse between the Name and Desc columns. A vertical
line will appear.
ii. Drag to the right to widen the column.

iii. Adjust other columns wider or narrower as needed.

(cont.)
3 Insert additional columns to the alarm display.

i. Right click a column heading to display the context sensitive menu.
ii. Select Insert Column to display a list of additional columns that may
be added to the display.
iii. Click the required column to be added to the display.
 Note:
Alternatively, there is an Add column link within the View Tasks area that opens
the same list of additional columns.
4 Delete columns from the alarm display.

i. Right click the column heading to be deleted to display the context
sensitive menu.
ii. Select Delete Column to remove the column from the alarm display.

(cont.)
5 Move columns within the alarm display.

i. Click on the column heading name to be moved.
ii. Whilst holding down the left mouse button, drag the column heading
to the required position with the table header.
iii. Release mouse button when positioned as required.

Exercise - Filter Alarms
1 Apply a Filter to the displayed alarms.

i. Navigate to the Active Alarms page.
ii. In the left-side column, locate the option Set Filter.
iii. Click the Set Filter option to open the filter dialog box.
iv. In the Name field, type D* and click in the tick-box beside Name.
v. Click OK to apply the filter.

vi. This will result in only those Alarms with a name starting with the
letter D being displayed.

Exercise - Filter Alarms (cont.)
vii. Remove the Alarm Filter using the Reset Filter command.
viii. Experiment with other filtering options.

ix. Shutdown the project.
Further Training:
Alarm Filtering is covered more extensively in the Vijeo Citect Customisation
and Design Course.

Menu Configuration
Customise Menus The structure of the menus may be configured using the Menu Configuration tool
provided as part of the Project Editor.
Select System » Menu Configuration to access this tool.
Menu entries are generally used to display specific graphics pages, although there is
no reason to stop project developers from launching Cicode functions or Reports
(for instance) from menu items.
The menu level names are kept entirely generic so that any template system, be it
the current Tab_Style_Include, the older CSV_Include or any newer
implementation may make use of the menu definitions in any way it sees fit.
Menu entries will be displayed in the running project in the order in which they are
defined in the pagemenu.dbf file. If a different order is required, the Order field
should be used to give each entry a sequential number.
 Note:
If no menu system is created in the project, a default structure is applied.

Menu Configuration Tool (cont.)
Menu Levels The menu system has four levels (these examples are drawn from the Vijeo Citect
Version 7.20 Example project):
 Level 1
In accordance with the general principles of "Tab-Style" menus, Level
1 menu entries form the tabs. In this instance, "What's New?"
"Example" etc form the level 1 menu items.
Icons to be associated with this menu level should be drawn from the
icons_16x16 library.
 Level 2
Level 2 menu items form the set of sub-options for each of the level
1 tabs. In the image above, the level 2 entries for the "What's New?"
tab are shown; in the image below the level 2 items for the "Tools"
tab are seen. Observe that the "Engineering Page" level 2 menu
item is disabled as it has a privilege requirement attached to it; one
which have not been satisfied by the currently logged-in user.
Icons to be associated with level 2 menu items should be drawn from

the icons_32x32 library.
 Level 3
Any level 2 item may have a drop-down menu attached to it - the
dropdown list is a sequence of level 3 menu items. Any level 2 item
with a drop-down level 3 list will have a small down-facing triangle
attached to it, as can be seen above for the "New Templates" and the
"Tag Extensions" items.
Level 3 menu items do not make use of icon symbols.

Menu Configuration (cont.)
Menu Levels (cont.)  Level 4

A level 4 menu item will appear as a side-menu attached to the right-
side of a level 3 menu item. Again, the presence of a small triangle
indicates the existence of sub-menu items.
 Note:
Adding a Level 4 item to an existing Level 3 item will automatically remove the
action defined in the level 3 menu item, as the parent becomes a placeholder for the
list of sub menus. This does not apply to Level 1 or Level 2 items which may have
a page associated with them as well as carry sub-menu items.
Order of When processing the entries in the PageMenu.DBF file, the Citect compiler must
Creation encounter parent entries prior to finding the child menu items which rely upon
them.
In normal practice, the project builder would create the highest-level menu items
then follow the structure down by creating the first level 2 item and then all the next
level items; then the next level 2 item followed by all of it's level 3s etc.
The following diagram indicates a reasonable order of creation:

Exercise - Create the Menu System
1 Create top-level menu entries

i. Open the Citect Project Editor and select the menu System » Menu
Configuration.
ii. Create the following Menu entries:
1. Top-level item
Level 1 Home
Level 2
Level 3
Menu Command PageDisplay("PulpHome")
Symbol icons_16x16.page
2. Level 2 'Pages' item

Level 1 Home
Level 2 Mill Pages
Level 3
Menu Command
Symbol icons_32x32.time
3. Level 3 'WoodChip' item

Level 1 Home
Level 2 Mill Pages
Level 3 WoodChip
Menu Command PageDisplay("WoodChip")
Symbol

Exercise - Create the Menu System (cont.)
4. Level 2 'Alarms' item

Level 1 Home
Level 2 Alarms
Level 3
Menu Command
Symbol icons_32x32.alarm_act
5. Level 3 'Active Alarms'

item
Level 1 Home
Level 2 Alarms
Level 3 Active
Menu Command PageDisplay("Alarm")
Symbol
6. Level 3 'Disabled Alarms'

item
Level 1 Home
Level 2 Alarms
Level 3 Disabled
Menu Command PageDisplay("Disabled")
Symbol
7. Level 3 'Hardware
Alarms' item
Level 1 Home
Level 2 Alarms
Level 3 Hardware
Menu Command PageDisplay("Hardware")
Symbol

Exercise - Create the Menu System (cont.)
8. Level 3 'Alarm Summary'

item
Level 1 Home
Level 2 Alarms
Level 3 Summary
Menu Command PageDisplay("Summary")
Symbol
9. Level 2 'Trends' item

Level 1 Home
Level 2 Trends
Level 3
Menu Command
Symbol icons_32x32.trend
10. Level 3 'Analyst' item

Level 1 Home
Level 2 Trends
Level 3 Process Analyst
Menu Command PageDisplay("ProcessAnalyst")
Symbol
2 Test the changes.

ii. Use the menu items to navigate amongst the pages.
iii. Shut down the project.

Exercise - View the Menu in Excel (Optional)
1 Define the MASTER.DBF location in the Project DBF Add-in.

i. Open Microsoft Office Excel.
ii. If Microsoft Office Excel 2003 is used the Project DBF Add-in
toolbar opens as either a floating toolbar or it may be moved to a
fixed toolbar location. If the toolbar is floating move it to a fixed
location at the top of the screen.
If Microsoft Office Excel 2007 is used the Project DBF Add-in

toolbar opens in the tab Add-Ins.
iii. Click the down arrow next to the Enter new path prompt and select
Enter new path to MASTER.DBF from the menu.
iv. Browse to the location of the User folder. Select the MASTER.DBF
file then click Open.

Exercise - View the Menu in Excel (Optional)
(cont.)
2 Select the project and table.

i. When the MASTER.DBF file is configured the SCADA Project list
becomes active as the list is populated by the entries in the
MASTER.DBF file. Click the Select Project arrow and select the
Pulp_V610_R1 project from the dropdown list.
ii. Once the project has been identified the SCADA Table list becomes
active. Click the Select Table arrow and select pagemenu.dbf from
the dropdown list.
iii. The contents of Pagemenu.dbf will fill the current Excel pane.
iv. Close Excel.
 Note:
By leaving the PAGE column blank, the system will apply this menu structure to
every page in the project. Project developers may want to create specific menu
entries for a small group of pages - perhaps those pages delivered to a high-
permission user.

Exercise - Create a Tools Menu
1 Create a new menu on the Home tab.

i. Open the Citect Project Editor and select the menu System » Menu
Configuration..
ii. Add the following Menu items:
1. Level 2 'Tools' item

Level 1 Home
Level 2 Tools
Level 3
Menu Command
Symbol icons_32x32.maint
2. Level 3 'TagDebug' item

Level 1 Home
Level 2 Tools
Level 3 Tag Debug
Menu Command TagDebug()
Symbol
3. Level 3 'Display Kernel'

item
Level 1 Home
Level 2 Tools
Level 3 Display Kernel
Menu Command DspKernel(1)
Symbol

Exercise - Create a Tools Menu (cont.)
4. Level 3 'Shutdown' item

Level 1 Home
Level 2 Tools
Level 3 Shutdown
Menu Command Shutdown()
Symbol
2 Test the changes.

ii. Test the operation of the newly created commands.
iii. Shutdown the project.

Re-Order Menu Items
Change the By default, menu items (at any of the 4 levels) will always appear in the running
Order of Menu project in the same order in which they are defined in the Menu Configuration tool.
Items
For instance, the previously defined Tools menu:
Will display the in-project menu in the same order.
By making use of the Order field in the Menu Configuration tool, the menu entry
sequence may be changed.
The following rules apply:
 All menu items assigned a value in the Order field will appear in order of that
value.
 Any menu items with the same Order value will appear in the running project
in the order in which they are encountered in the Menu Configuration tool.
 Any menu items with no assigned Order number will appear in the running
project in the same order they are defined in the Menu Configuration tool and
be positioned before all numbered items. Blank order number fields may be
treated as if they have an Order Number of zero.

Exercise - Modify the Way Menu Items are
Displayed
1 Modify the Order of the "Display Kernel" entry in the Tools menu.
i. In the Project Editor, select the menu System » Menu
Configuration.
ii. Scroll down to the Level 3 item Display Kernel (it will be near the
bottom of the list). Set the Order to be 1.
iii. Click the Replace button to save the change.

iv. Repeat for the other Tools entries:
Tag Debug 2
Shutdown 3
2 Test the changes.

ii. Open the Tools dropdown menu.
iii. Observe that the Display Kernel item is now at the top of the list.
iv. Shutdown the project.

Exercise - Modify the Way Menu Items are
Displayed (cont.)
3 Perform some additional changes (optional).

i. Return to the Menu Configuration tool and make changes to achieve
the following outcomes.
On the Home Tab, order the Level 2 items: Mill Pages, Tools, Trends, Alarms
Move the Tag Debug item from the Tools menu to the Mill Pages menu
Arrange the Alarms pages (under the Alarms item) in reverse alphabetical
order
Create a new Level 1 menu called Tools and promote the two remaining Tools
items to level 2.
ii. Compile and run the project to test the changes.


Home Button
Configure Home As part of the Normal template in the Tab_Style_Include project, a series of pre-
Button defined navigation buttons are provided.
These are defined as follows.
Forward and back through the most recently viewed graphics pages. The
down arrow allows access to the list of recent pages. This tool functions
identically to the similar buttons found in any web browser.
Any graphics page in the project may have a 'parent page' defined for it.
This button will navigate to the defined parent page of the current page.
A graphics page may form part of a sequence of pages - perhaps the
succession of pages in a complex industrial process. Each page in that
sequence may have it's 'previous' and 'next' neighbours defined. These
buttons may be used to navigate that sequence.
This button navigates to the defined home page for the project.
The pages button will display a list of all pages in the project, permitting
the operator to select any of them for display.
The login button. Clicking this button displays a login dialog box.
Clicking the small down-arrow to the right will show a login-related menu.
See Also:
For further information about Navigation buttons, see Vijeo Citect Help -
Navigation Toolbar.

Exercise - Configure the Home Button
1 Configure the HomePage item in the Citect.ini file.

i. From the Project Editor, select the menu Tools » Computer Setup
Editor.
ii. Complete the Parameter details as follows:
iii. Click Add to save the new value.

iv. Close the Computer Setup Editor and save when prompted.
2 Test the changes.

ii. Navigate to the WoodChip page.
iii. Click the HomePage button.

iv. Confirm that the required page is displayed.

Summary
Summary The following topics have now been addressed:
 Using Tab Style Templates (page 3-4)

 Trend Templates (page 3-4)
 Alarm Viewing (page 3-9)
 Menu Configuration (page 3-19)
Questions The following questions are to check understanding:
 What Template(s) may be used to create Trend Pages?

 What Pen Types may be added and viewed on a Trend Page?
 How many default Alarm Templates have been provided?
 List four (4) improvements to the Alarm Viewer in Version 7.20.
 What are the four levels within the menu system and how are they represented
in the running project?
 Which tool is used to configure menus?

Chapter 4: On-line Changes
Overview
Introduction
Many modifications may be made to a running project without requiring a restart of
either the relevant Server or any of the Clients.
It is important to understand the ramifications of making changes and also to be

aware of the limitations of this ability to rapidly modify the project.
 Online Changes ...................................................................... 4-2

Online Changes
Server Side To improve the ability to change configuration on a live runtime system without
Online Changes having to Restart the servers, Vijeo Citect Version 7.20 now provides the facility to
Reload Server configurations during runtime, either programmatically or by using
the Runtime Manager.
Previously, the Display Client supported online changes for graphic pages and tags,
but the servers needed to be restarted if any changes were made to the
configuration. This meant that simple changes such as removing an Alarm or Trend
record required restarting the server. With Vijeo Citect Version 7.20, simply make
changes to the configuration files in the Project Editor by adding or deleting records
and modifying existing records. Then recompile the configuration to update the
Runtime DataBase (RDB) files while the system is running. Initiate a
configuration Reload, and the Server will compare the RDB files with the data
already loaded in memory. The server determines which records have been added,
deleted or changed, and will allocate and initialise records from the new RDB files
and send the changed information to the Client.
Restarting servers is something to be avoided if at all possible, especially when it is

just a new alarm that is to be added, or a simple report amendment to action. Now,
simply make the configuration change, compile the project and reload the relevant
server. This allows Alarm, Trend or Reports to be added or changed whilst the
system is running.
Anything in the system which is already running and has not been modified will not
be changed or effected as part of a reload – only the modified items will be
effected.
Also, as the reload is a background process, the system will run as normal whilst
the reload is happening. Modified items will be available at completion of the
reload with no interruption to anything else. The Syslog files for each server will
provide a record of what occurred during the reload.

On-line Changes (cont.)
How Online When a system has been configured so that Clients are able to be updated Online all
Changes Work changes take place on the Server. The Clients are able to update their information
because they are linked to a central project or the COPY parameter has been used
and the local project will update when changes are detected.

Online Changes (cont.)
How Online When a change to the project is made on the Server, the Server must be reloaded.
Changes Work If the Server is providing more than one type of Server functionality, Multi-Process
(cont.) mode allows the user to reload that process only with the Runtime Manager.
Once the Server is reloaded, the changes are transferred to the Clients and are
available online. During the reload operation, the existing compliment of Alarms,
Trends etc will continue to be available to Clients; once the reload is complete, the
new items will automatically become available.

Online Changes (cont.)
How Online Individual servers may be Restarted or Reloaded from the Runtime Manager,
Changes Work located in the System Tray.
(cont.)
 Note:
There are a number of limits on exactly what will change without a reload based on
the wider impact of the change. These limits are detailed in the Vijeo Citect Help -
Effects of Server Reload on Servers.

Project-based A new Cicode function ServerReload() is available to cause a Client-initiated

Server Reload reload of a Server component.
Project developers might choose to offer this functionality via a security-protected

button.
See Also:
For further information about ServerReload, see Vijeo Citect Help - ServerReload.
ServerGetProperty() returns information about the specified server and can

be called from any Client.
Various properties may be accessed using this function, for example calling
ServerGetProperty on an Alarm Server using the property RDBMemTime
would give the Date and time of currently loaded alarm records Runtime Database
file (in-memory), and RDBDiskTime would provide the date and time for
compiled Alarm records on disk.
See Also:
For further information about ServerGetProperty, see Vijeo Citect Help -
ServerGetProperty.
Effects of an Configuration changes resulting from adding, deleting or modifying Alarm records
Alarm Server whilst the Alarm Server is running will be available to the Client when an Alarm
Reload Server is Reloaded. So for example, a Client will be able to access a new Digital
Alarm or adopt modifications to an Advanced Alarm after an Alarm Server Reload.
Alarm Categories are slightly different as some fields are used by the Client, and
others are used by the Alarm Server. Those fields that are purely related to the
Client will not be reloaded, but the Alarm Category fields used by the Server will
be reloaded:
 ON Action
 OFF Action
 ACK Action
 Summary Device
 Log Device, ON, OFF and ACK log devices

Effects of a Trend Tag and SPC Tag records that have been added, removed, or modified will
Trend Server be Reloaded on a Trend Server. Modifying a Trend record’s Archive Properties
Reload however will make the existing Trend file invalid and put the record in an error
state and no acquisition will be done for corresponding records. A Hardware alarm,
a Syslog entry and a Reload error message will be raised.
Archive Properties are:
 Sample Period
 Type (from Periodic to non Periodic or vice versa)
 Filename
 Storage Method
 Number of Files
 Time
 Period
Due to Reload, the Display Clients will need to request latest configuration data for
Trend records. The Process Analyst will periodically refresh configuration data
from Trend Server and has been modified to handle deleted records.
 Note:
Old history files will not be automatically deleted. To preserve a valid archive for
the modified record, manually archive the old history files and then delete them.
Then trigger the reload again after forcibly compiling the Trend configuration. This
is required because the trend system does not reload the Trend RDB file if the
compile time of the in-memory file is same as the on disk file. Therefore changes to
an existing Trend record’s Archive Properties is a two-stage reload.
Effects of a Reports and Accumulators will also be reloaded on a Report Server, however,
Report Server changes to related devices will not be reloaded because the devices may be in use
Reload by other Cicode tasks.

Cicode Library The Cicode library is not reloaded when Reloading a Server. Consequently, the
Server will be using data and structures from the new RDB files but the Cicode
library remains the same in the memory.
When the timestamp of the Cicode library in memory is different to the timestamp
of the cicode library on disk, a Hardware Alarm will be raised, and a log will be
written to the corresponding syslog file.
 Note:
It is recommended that the ServerGetProperty Cicode function be used with the
LibRDBMemTime and LibRDBDiskTime properties to check if there is a change to
the Cicode library before attempting a Reload. Following a Reload check the
corresponding server's syslog.dat file for any reload messages. The Cicode changes
will not be reloaded, therefore a Restart may be more appropriate.
Restart vs. The startup of any server may be divided into two discrete stages. Firstly it must
Reload identify how it is to be configured and secondly, it must determine what it has to
do. For an Alarm Server the first stage would include log file locations and other
such information while the second stage would be to create the list of actual alarms
with which it has to operate.
A Server Restart reinitialises both components while a Reload only attends to the
list of things it must do. As an analogy, consider a band on stage. It could be
assumed that getting the instruments ready on the stage and all the sound equipment
performing properly would be the first stage described above, while the hand-
written list of songs taped to the keyboard player's instrument is the second.
With that in mind, it is obvious that reinitialising the equipment is a very difficult
task, while changing the list of songs is trivial to achieve mid-performance.

Exercise - Online Changes: Tags and Pages
1 While the Pulp_V610_R1 project is running, create a new Variable

Tag.
i. Open the Citect Project Editor and select Tags » Variable Tags.
ii. Create a new Variable Tag in the Pulp_V610_R1 project using the
settings shown below and click Add.
2 Add a Genie to the Woodchip page.

i. Open the Citect Graphics Builder then open the Woodchip page.
ii. Copy the existing Chipper Speed genie and paste it onto the page.
iii. Double click the new genie to open the genie form. Enter the settings
as shown below then click OK.
iv. Save the page.

Exercise - Online Changes: Tags and Pages
(cont.)
3 Recompile and access the modified project.

i. Compile the project.
ii. In the running project, navigate away from, and back to the
Woodchip page to refresh the graphics page with the changes.
iii. Note the new genie is displayed, but is showing #COM as the new
tag has not yet been made available to the Client.
iv. In order for this new tag to become available to a Client the I/O
Server must be restarted. Click the Runtime Manager in the System
Tray and right click the I/O Server entry Pulp.PulpPrimary. Select
the Restart option.
The I/O Server will execute a shutdown and restart. Note that the
Client detects a brief loss of I/O Server connectivity then reconnects.
v. From the Woodchip page manipulate the newly created Chipper
Motor tag using the genie's slider.

Exercise - Online Changes: Alarms
1 While the Pulp_V610_R1 project is running, create a new

Advanced Alarm.
i. Open the Citect Project Editor and select Alarms » Advanced
Alarms.
ii. Create a new Advanced Alarm using the settings shown below and
click Add.
iii. Compile the project and Reload the Alarm Server processes.
iv. In the running project, trigger the new alarm by setting the
Chipper_Motor to a value less than 500.
v. Open the Alarm Server log Syslog.dat and review the activities of
the Reload.

Exercise - Online Changes: Alarms (cont.)
2 While the Pulp_V610_R1 project is running, modify an existing

Analog Alarm.
i. Select Alarms » Analog Alarms.
ii. Modify the Digester_Temp Alarm so that a LOW Alarm is triggered at
30° instead of 20°.
iii. Compile the project and Reload the Alarm Server processes.
iv. In the running project, trigger the amended alarm by setting the
Digester_Temp to 29°.
v. Reopen the Alarm Server log Syslog.dat and review the activities of
the Reload.

Exercise - Online Changes: Trends
1 While the Pulp_V610_R1 project is running, create a new Trend

Tag.
i. Open the Citect Project Editor and select Tags » Trend Tags.
ii. Create a new Trend Tag using the settings below and click Add.
iii. Compile the project.

iv. In the running project, open the Process Analyst page from the
Trends menu.
v. Open the Add Pens dialog and search for all configured Trend Tags.
vi. Note the new Tag is not listed.
2 Reload the Trend Server.

i. Open the Runtime Manager and Reload the Trend Server.
ii. Open the Trend Server log Syslog.dat and review the activities of the
Reload.
iii. Reopen the Process Analyst Add Pens dialog and search again for all
configured Trend Tags.
iv. Note the new Tag is now listed.
v. Add the new Tag to the Pane, as well as the two other Chipper Tags
(CCS_P and CPL_P).

Exercise - Online Changes: Trends (cont.)
vi. Note the availability of historical data of the three tags - the Chipper
Conveyor Speed and the Chip Pile Level Trend Tags will display data
since the project was run, whereas the Chipper Speed Trend Tag will
only show data from when the Trend Server was Reloaded.
3 (Optional additional step) Modify the Trend sample period.

i. Select one of the trend tags and change the sample period to (for
example) 5 seconds.
ii. Attempt to deploy the update via Online Changes and observe the
result.
iii. Shut down the project.

Summary
 Online Changes (page 4-2)
 With regard to on-line changes, what is the use of the Copy = parameter?
 If a new tag is created on the I/O Server, and the I/O Server computer is also
acting as a Trend, Report and Alarm Server, what actions need to be
performed for the change to take effect over the whole system?
 What is the difference between Restarting and Reloading a server?

Chapter 5: Tag Extensions
Overview
Introduction
In addition to the plant data attached to a Tag, Vijeo Citect can access additional
information related to the data as part of the tag.
These data elements provide access to a view of the circumstances surrounding the
data. Such elements include the quality of the data, the time-stamp of when it last
changed and other useful information.
 Tag Extensions....................................................................... 5-2

 Quality Information ............................................................... 5-3
 Additional Tag Extensions..................................................... 5-9
 Manage Tag Extensions ....................................................... 5-18
Tag Extensions
Access to Plant A tag name by itself (for instance TIC_P1_PV) carries the current value as its only
Meta-data attribute. In order to access additional information, a series of sub-fields, referred
to as Tag Extensions has been defined.
In addition to the actual plant data, Tag Extensions provide access to:
 Tag value Quality and Timestamp information

 Extended data associated with a variable tag
In addition, it is now possible to perform the following actions:
 Override the tag variable value

 Prohibit writing to the tag variable value
 Display and trend the tag values even if quality is not “Good”
Access to this extra information allows operators to gain a deeper understanding of
the actual state of their plant.
Quality information was available in Vijeo Citect v7.0 and v7.10 via a suite of
Cicode functions, however the information has now been made more visible with
this new structure.
See Also:
For further information about Tag Extensions in previous versions, see Vijeo
Citect KnowledgeBase - "Q5741 - PSI Quality values."
Project developers should also be aware that Tag Extensions can be used inside
SuperGenies and Popup pages, but not in their associations.
If a tag with an extension is passed to an association then Runtime doesn't parse it

and split to Tag, Element and Item, but interprets entire string with dots as a tag
name. This will almost certainly lead to a ‘tag not found’ compile error.
 Note:
The use of tag Extensions will have an effect on network traffic as the distribution
of Quality and Value timestamps will increase the amount of data being sent
between servers and clients.

Quality Information
Quality The primary extension fields are as follows;

Attributes
tagname.v The current tag value (this is the same as referencing the
tagname without any extension).
tagname.vt The value timestamp. This is the timestamp of when the value
last changed.
tagname.q The quality of the tag value. This will represent the quality of
the value and is expressed as either GOOD, UNCERTAIN or
BAD
tagname.qt The quality timestamp. This is the timestamp of when the

quality last changed
tagname.t The timestamp of when the tag or element was last updated.
Tags may now be referenced according to this syntax:
[Cluster.]Tag[.Element][.Item]
The tag data may be accessed via a Cicode function, or a Text element on a
graphics page by using either a qualified or an unqualified tag reference.
A qualified tag reference includes the tag element name and provides access to the
specified tag element or the element item, for example. “Tag1.Field”,
“Tag1.Field.Q” where "Field" is the element name and "Q" is the item name. An
unqualified tag reference is one that does not include a tag element name or item
name, and is resolved at runtime, for example “Tag1”, “Tag1.Q”.

Quality Information (cont.)
#COM Error In previous versions, any loss of data connection for a Tag value on a graphics page
Display will produce a #COM error message in place of the displayed value.
Tag Extensions permits a much finer-grained view of the reasons for the loss of
connectivity and thus there are a variety of signals to give a better understanding of
the problem.
Value Interpretation Notes

#BAD 'Bad' quality [Page]BadText to change displayed
string
#COM Communications cannot be changed

Error
#UNC 'Uncertain' [Page]UncertainText to change

quality displayed string
In addition to being able to offer a text object in place of the tag value, a dithering
pattern (of a selected colour) may be placed over the last known tag value as a
signal to the plant operators while permitting them to see the last known value.
Here, the Chip Level is displaying the last known value while the Conveyor Speed
is simply indicating #BAD.

Quality Information (cont.)
Default Quality Unless modified by the system designer, tag quality data will be represented on a
Display graphics page via the tooltip.
As shown, the default tooltip will access both the Value Timestamp and the Quality
attribute. Manually assigning a tooltip to the object will override the quality
display.
This display is controlled by the Citect.ini parameter

[Page]EnableQualityToolTip which set true by default.

Exercise - Manipulate Quality Attributes
1 Prepare the WoodChip graphics page.

i. Restore the project Upgrade_Include.
ii. Include this newly restored project to Pulp_V610_R1.
iii. Open the Graphics Builder and open the WoodChip page in the
Pulp_V610_R1 project.
iv. Paste the Symbol tagextensions.TagExtButton somewhere just to
the left of the Set Initial Values button
v. Save the page.

vi. Compile and run the project.
2 Open the Tag Extensions pop up page.

i. Open the WoodChip page and click the Tag Extensions button.
ii. In the Input box, type the tag name Chip_Pile_Level and click OK.

Exercise - Manipulate Quality Attributes (cont.)
 Note:
For a full list of available tags, check the Variable tags dialog box in Project Editor.
Chip_Pile_Level is convenient as it occurs in the lower-right corner of the project
and is visible with the pop up page open.
iii. The Tag Extensions pop up page will appear.
This page has been crafted to display all features of the Tag
Extensions system. Such a page would not normally be required in a
typical plant, although some of its functionality might be
implemented.

Exercise - Manipulate Quality Attributes (cont.)
3 Trigger 'Bad' quality settings.

i. Click the Bad text object at the bottom of the Tag Extensions pop up
page. This places the I/O Server in a pseudo-disabled state. On the
WoodChip page all tag values are displayed as #BAD.
On the pop up page, the Chip_Pile_Level tag is shown as #BAD and

at the top right of the pop up page the current Status of the tag will
display.

Additional Tag Extensions
Tag Extension
Syntax
Cluster The optional cluster name.
Tag The tag name or SuperGenie assignment.
Element The optional element name. If the element name is not specified,
the requested element will be determined at runtime. Available
Element values are: Field, Valid, Status, ControlMode, Override
and OverrideMode.
Item The optional element item name. If the item name is not specified,
the whole element is referenced. Available Item values are: V,
VT, Q, QT and T. These were previous described in Quality
Attributes (page 5-3).
[[N]…] Index/indexes if the referenced tag is an array (note that it is

always placed at the end of the reference eg Array.V[index],
Array.Field[index], Array.Field.V[index]).

Additional Tag Extensions (cont.)
Tag Status The Tag Status element is used to represent the current status of the tag. The value
of this element is affected only for those tag operations that involve a physical
device (for example, writing to the Field element will affect the status element, but
writing to the Control Mode will not). Tag Status element is reset after I/O Server
restart. The element value contains a set of bit flags.
Tag Status element

Tag.Status.V INT Value of Tag Status element:
0x1: Read Pending
0x2: Write Pending
0x4: Write Successful
0x8: Write Failed
Tag.Status.VT TIMESTAMP Timestamp of when the value last changed
Tag.Status.Q QUALITY Quality
Tag.Status.QT TIMESTAMP Timestamp of when the quality last changed
Tag.Status.T TIMESTAMP Timestamp of when the element was last updated

Warnings

Control Mode Control inhibit mode enables the prohibition of writing to the Field tag element.
Setting a tag in Control inhibit mode is applied system-wide and thus blocks
writing to the Field element for all I/O data consumers.
Control Mode
Tag.ControlMode.V INT Value of ControlMode element:
0 Control inhibit is Off
1 Control inhibit is On
Tag.ControlMode.VT TIMESTAMP Timestamp of when the value last changed
Tag.ControlMode.Q QUALITY The Control Mode quality is QUAL_GOOD if the
tag was put into the Control inhibit mode on the
primary server and it was propagated to all
redundant servers. Otherwise the general quality
status will be QUAL_UNCR and the extended
susbstatus will be QE_NOT_REPLICATED to
indicate that not all redundant servers are aware of
the fact that the tag is in Control inhibit mode.
Tag.ControlMode.QT TIMESTAMP Timestamp of when the quality last changed
Tag.ControlMode.T TIMESTAMP Time of when the tag was put in or out of Control
inhibit mode.
This means that an operator is able to make changes to the project which do not get
conveyed to the field devices.

Override Mode If it is determined that a tag value is incorrect due to sensor malfunction or
communication loss, the tag value may be overridden. the 'forced' value is stored in
the Override tag element and the state of the Override is stored in OverrideMode.
Override tag element

Tag.Override.V INT Value of Override element
REAL
STRING
Tag.Override.VT TIMESTAMP Timestamp of when the value last changed
Tag.Override.Q QUALITY The Override value always has “Good” quality
except when it is out of range
Tag.Override.QT TIMESTAMP Timestamp of when the quality last changed
Tag.Override.T TIMESTAMP Timestamp of when the element was last updated
 Note:
The quality of tags referenced by items, ex. Tag1.v or Tag1.Field.t, is always
GOOD and the timestamps are always 0 (INVALID TIMESTAMP). Therefore
there is no visual indication of any non good quality, error or change in handling
state such as control inhibit or override mode regardless of the setting used for the
[Page] IgnoreValueQuality parameter
[Page] parameters are discussed in Citect.ini Parameters (page 5-18)
Override Mode tag element

Tag.OverrideMode.V INT Value of Override Mode element (see below for the
modes)
Tag.OverrideMode.VT TIMESTAMP Timestamp of when the value last changed
Tag.OverrideMode.Q QUALITY The Override Mode quality is QUAL_GOOD if the
tag was put into the Override mode on the primary
server and it was propagated to all redundant
servers. Otherwise the general quality status will be
QUAL_UNCR and the extended substatus will be
QE_NOT_REPLICATED to indicate that not all
redundant servers are aware of the fact that the tag
has been overridden.
Tag.OverrideMode.QT TIMESTAMP Timestamp of when the quality last changed
Tag.OverrideMode.T TIMESTAMP Time when the tag was put in or out of Override
mode. (equal to 0 at start up)

Override Mode (cont.)
Override Modes
0 The Override Mode is Off.
1 The tag is in Static Override Mode and the Override value is initially set to the
value of the tag’s Field element.
2 The tag is in Static Override Mode and the Override value is initially set to the
value of the tag’s Valid element.
3 The tag is in Static Override Mode and the Override will remain at the
previously set value of the tag's Override element.
4 The tag is in the Dynamic Override Mode and the Override value will
continually track the value of the tag's Valid element. The ability to write to the
value of the tag’s Override element is disabled in this mode.

Exercise - Control Inhibit and Override Modes
1 Enable Tag Override.

i. In the Tag Extensions popup, click the Change button in the
Override section.
ii. Enter any value (preferably one quite different to the current tag
value) and click OK.

(cont.)
iii. There are a number of ways in which a tag may be overridden.

These are described in the last part of Override Mode (page 5-13)
iv. Apply each of the 4 Override modes and observe their effect on the
Chip_Pile_Level tag.
v. Once done, return to Override Mode 0.
2 Apply the Control Inhibit status to a tag.

i. Click the button Toggle in the ControlMode section of the popup
page. This will halt any write operations to the Chip_Pile_Level tag.
ii. Observe that the ControlMode value is set to 1 and both the Tag
and Tag.Field values have a dither pattern placed over them.

(cont.)
iii. Refer to the WoodChip page.
 Note:
The Quality tooltip may be disabled by setting the Citect.ini parameter
[Page]EnableQualityTooltip=0
iv. Here, the Chip Level genie and the pile representation are also
dithered.
v. Hover the mouse over the Chip Level genie to see the tooltip
indicates the tag is in Control Inhibit mode. In addition, only the
Chip Pile is inhibited; the Conveyor Speed tag may be freely
modified.
vi. Attempt to change the Chip Pile Level by dragging the slider. The
marker will move with the mouse but will snap back to its original
position almost immediately.
vii. Click the ControlMode Toggle button to resume modifications to the
tag value.
3 Shut down the project.

Manage Tag Extensions
Citect.ini A large number of parameters in the Citect.ini file are available to configure the
Parameters way in which Tag Extension information is managed in a project.
[Page]BadDitheringColor Sets the dithering color for graphics elements which are
dithered if the value quality is “bad”.
[Page]BadDitheringDensity Sets the dithering density for graphics elements which are
dithered if the value quality is “bad”.
[Page]BadText Text Objects can be displayed as #COM type errors, or as the
text overlaid with a dithered pattern if the ‘display value’
expression has “bad” quality.
[Page]BadTextBackground- Sets the background color for numeric or text graphics objects
Color to indicate “bad” quality.
[Page]ControlinhibitDithering- Sets the dithering color for graphics elements which are
Color dithered if their values are in ControlInhibit mode.
[Page]ControlInhibitDithering- Sets the dithering density for graphics elements which are
Density dithered if their values are in ControlInhibit mode.
[Page]ControlInhibitText- Sets the background color for numeric or text graphics objects
BackgroundColor to indicate that the value presented on the objects is in
ControlInhibit mode.
[Page]DefaultQualityFormat The format of the string representation of quality when a
Cicode QUALITY function is used.
[Page]EnableQualityToolTip Controls the visibility of the quality tooltip.
[Page]ErrorDitheringColor Sets the dithering color for graphics elements which are
dithered if an internal error occurs.
[Page]ErrorDitheringDensity Sets the dithering density for graphics elements which are
dithered if an internal error occurs.
[Page]IgnoreValueQuality Defines the value quality handling by graphic pages.
[Page]OverrideDitheringColor Sets the dithering color for graphics elements which are
dithered if their values are override (“forced”).
[Page]OverrideDithering- Sets the dithering density for graphics elements which are
Density dithered if an internal error occurs.
[Page]OverrideText- Sets the background color for numeric / text graphics objects
BackgroundColor to indicate that the value presented on the objects is override
(“forced”).
[Page]ShowBadText Text Objects can be displayed as #BAD text, or as the text
overlaid with a dithered pattern if the "display value"
expression has “bad” quality.
[Page]ShowErrorText Text Objects can be displayed as #COM type errors, or as the
expression has “uncertain” quality
[Page]ShowUncertainText Text Objects can be displayed as #UNC text, or as the text
overlaid with a dithered pattern if the "display value"
expression has “uncertain” quality.

Manage Tag Extensions (cont.)
Citect.ini Parameters
(cont.) [Page]UncertainDithering- Sets the dithering density for graphics elements which are
Density dithered if the value quality is “uncertain”.
[Page]UncertainDithering- Sets the dithering color for graphics elements which are
Color dithered if the value quality is “uncertain”.
[Page]UncertainText Text Objects can be displayed as #COM type errors, or as the
expression has “uncertain” quality.
[Page]UncertainText- Sets the background color for numeric or text graphics objects
BackgroundColor to indicate “uncertain” quality.
All DitheringColor and BackgroundColor settings require a value between

0x000000 and 0xFFFFFF, representing the RGB value of the selected colour. The
default DitheringColor is 0x000000 (black).
All DitherDensity settings require a value of 1 (highest density) to 4 (lowest

density. The default is 2.
See Also:
For further information about Tag Extension [Page] parameters, see Vijeo Citect
Help - Page Parameters.

Ensure To provide a visual indication to the operator that a tag is in the Control inhibit
Operators are mode the following can be done:
Aware
Set any of the following Citect.ini parameters in such a way that Control inhibit
mode will be indicated by changing the background colour or overlaying the
numeric or text graphics objects and symbol set objects with a dithered pattern:
[Page]ControlInhibitDitheringColor
[Page]ControlInhibitDitheringDensity
[Page]ControlInhibitTextBackgroundColor
In addition, set [Page]IgnoreValueQuality parameter to a value of 0 or 2.
or
Use the Control Mode element value (0 if the tag is not in the control inhibit
mode or 1 otherwise)
or
Use the Field element quality Tag Status ControlInhibit bit (1 if the tag is in the
control inhibit mode or 0 otherwise)
 Caution!
Dithering values are not implemented when values are delivered to a graphic page
using the tagname.V format. If the .V format is used, project designers must find
some other way to identify that Override of Control Inhibit modes are set. This
may be confirmed with a close inspection of the popup page in Exercise - Control
Inhibit and Override Modes (page 5-15) .

Quality and There are a number of Cicode functions provided to deal with the Quality and
Timestamp Timestamp attributes of the Tag Extension fields.
Cicode Functions
Quality Functions
QualityCreate Creates a quality value based on the quality fields provided.
QualityIsBad Returns a value indicating whether the quality is bad.
QualityIsGood Returns a value indicating whether the quality is good.
QualityIsUncertain Returns a value indicating whether the quality is uncertain.
QualityIsOverride Returns a value indicating whether the tag is in Override Mode.
QualityIsControlInhibit Returns a value indicating whether the tag is in Control inhibit
mode.
QualityGetPart Extracts a requested part of the Quality value from the QUALITY
variable.
QualitySetPart Sets a Quality part’s value to the QUALITY variable.
QualityToStr Returns a textual representation of the Vijeo Citect quality.
VariableQuality Extracts the quality from a given variable.
Timestamp Functions
TimestampAdd Adds time (in part of) to a TIMESTAMP variable.
TimestampCreate Returns a timestamp variable created from the parts.
TimestampToStr Converts a TIMESTAMP variable into a string.
TimestampDifference Returns a difference between two TIMESTAMP variables as a
number of milliseconds.
TimestampCurrent Returns the current system date and time as a TIMESTAMP
variable.
TimestampFormat Format a TIMESTAMP variable into a string.
TimestampGetPart Returns one part (year, month, day, etc) of the timestamp variable.
TimeIntToTimestamp Converts a time INTEGER which is represented as a number of
seconds since 01/01/1970 to a TIMESTAMP
TimestampSub Subtracts time (in part of) from a TIMESTAMP variable.
TimestampToTimeInt Converts a TIMESTAMP variable into a time INTEGER which is
represented as a number of seconds since 01/01/1970.
VariableTimestamp Extracts the timestamp from a given variable.

Exercise - Use Quality [Page] Parameters
1 Set the text to display for #BAD quality

i. Open the Computer Setup Editor.
ii. Create a new Parameter under [Page] called BadText.
iii. Create a Value of HORRIBLE (or any other chosen text).
iv. Save the entry.

v. Close the Computer Setup Editor.
vi. Run the project.

Exercise - Use Quality [Page] Parameters (cont.)
vii. Open the Tag Extensions popup page and click the Bad marker to
disable the I/O Server.
viii. All Tag values will be replaced with #HORRIBLE.
ix. Return the I/O Server to the Good state; display of the correct tag
values will resume.
x. Shut down the project.
2 Modify the indicators that show the dither pattern.
It is important to ensure operators are aware that the status of tags

is changed from the normal. Thus far, a simple dithering pattern of
black dots is drawn over the affected tags. Although as can be seen,
this may not necessarily be obvious when drawn over a dark page
background.
i. Open the Computer Setup Editor and add the following entries to the
[Page] section.
 Note:
The provided utility Colorpik.exe may be used to determine the RGB values of any
selected colour.
Parameter Value
BadDitheringColor 0xC83264
BadDitheringDensity 1
BadTextBackgroundColor 0xFFFF00
ControlInhibitDitheringColor 0xFF0000
ControlInhibitDitheringDensity 1
ControlInhibitTextBackgroundColor 0x28FF50
OverrideDitheringColor 0xC81EE6
OverrideDitheringDensity 3
OverrideTextBackgroundColor 0xE6963C

Exercise - Use Quality [Page] Parameters (cont.)
ii. Close the Computer Setup Editor and save the changes.
iii. Run the project.
iv. Open the Tag Extensions popup page and set the I/O Server to Bad.
v. A considerably more obvious dither pattern is now displayed.
vi. Here the dither has a denser pattern of dots, and those dots are
bright purple. However, the bright yellow BadTextBackgroundColor
is not visible. This relies on setting [Page]IgnoreValueQuality=2.
vii. Shut down the project.
viii. Add the parameter [Page]IgnoreValueQuality=2 to the Citect.ini file.
ix. Restart the project.
x. Disable the I/O Server and observe the effect on the graphics page.
xi. This Citect.ini setting disables the use of the Bad Text and instead
preserves the tag value with the selected background colour.
xii. Examine the effect of the other Dither settings by applying a Control
Inhibit or Override function via the Tag Extensions popup page.

Optional Exercise - Manipulate Tag Extension
Data
Write a Cicode function to examine the various information contained within the
Tag Extension fields and provide an on-screen display of the length of time a tag
has been in Control Inhibit mode.
1 Create a Cicode function.

i. With reference to the Cicode function information in Quality and
Timestamp Cicode Functions (page 5-21) create a Return function
that calculates the difference between the time at which a tag was
placed in Control Inhibit mode and the current time.
ii. Determine a suitable method to display the time difference on a
graphics page.
2 Test the function.

i. Place a display object on the WoodChip page to show the result of
the function.
ii. Determine a suitable method to refresh the value.
iii. Test the function by using the Tag Extensions pop up page to place a
tag in Control Inhibit mode and confirm the delay value updates
properly.

Summary
 Tag Extensions (page 5-2)

 Quality Information (page 5-3)
 Additional Tag Extensions (page 5-9)
 Manage Tag Extensions (page 5-18)
 What information is displayed on a Quality tooltip and what options are there
for changing it?
 What is the difference between using a TagName reference and a TagName.v
reference?
 Why was a 'danger' warning provided for the Control Inhibit and the Override
modes?

Chapter 6: Graphics Enhancements
Overview - Graphics Enhancements

Introduction
Enhancements have been made to the way that Graphics Pages and their objects
may be configured:
 Association parameters may now be identified by Names rather than just

integers.
 Default values for association parameters may be set if the substitutions are not
performed.
 Value on error may be defined
 Each Animation Point may have Metadata assigned, that is a collection of
Name-Value pairs, which may be modified at runtime.
These enhancements may be used in the creation and implementation of
Supergenies and Popup Pages.
Popup Pages and Super Genies are dynamic pages that may be used to pass
information when the page displays in the runtime system. They may be used for
popup type controllers for a process or a single piece of plant floor equipment. The
same page can then be reused with different sets of tags. For example, a graphics
page could display several pumps, and a super genie popup controller is used for
each of the pumps on the page.
 Graphics Enhancements and Popup Pages ............................ 6-2

Graphics Enhancements and Popup Pages
Super Genies and Popup pages and super genies are dynamic pages that are used to pass information
Popup Pages - when the page displays in the runtime system. However an integrator may develop
What is the controllers that are used across many different sites. In this case a Super Genie
Difference? *.ctm file may be saved and copied easily into other projects.
How to Create a  To create a Popup Page:

Popup Page
First create and save a new blank page. This page can be called directly from a
page using an appropriate function.
Substitution Variable tag names are substituted at runtime by using a series of substitution
Syntax names. There are two methods of using this syntax:
?type number? (numbered association)
?type name? (named association)
Numbered With a numbered association, number is the position of the tag name in the list
Associations provided in the function that was called to open the Popup page. It is not strictly
necessary to use type in the substitution syntax. However, if the type is used for
further clarity it is the data type in the variable tag ( eg. string, int, real or digital ).
Example –
In the example of the function AssPopUp(),
AssPopUp(“popPage”,”Tag1”,”Tag2”,”Tag3”)
if the tags are a string, integer and digital respectively, then they could be
referenced anywhere in the popup page as:
?string 1? Strings must have the type defined
?int 2? or ?2?
?digital 3? or ?3?

(cont.)
Named Named Associations are an extension of the Numbered Associations that may be
Associations defined in previous versions of Vijeo Citect.
Vijeo Citect Version 7.20 allows Association parameters to be identified by Names

rather than just integers. Additionally, descriptions for Association parameters may
be added to improve the identification, documentation and maintainability of
SuperGenies in a project.
In a Named Association instance, a separate function must be used to link a

variable tag (or other data source, such as a constant or local variable) to a local
name defined within the popup window.
As is true for Numbered Associations, the datatype is optional for numeric

variables and mandatory for strings.
Example –
Firstly, a connection must be made between the data source and the popup's internal
variable. In this instance, the popup contains the variable ?Valve? and it will be
linked to the variable tag "Valve_tag."
Ass(-2, "Valve", "Valve_tag",0)
The next step is to launch the popup window. All pending tag associations will be
drawn into the popup as it is launched.
WinNewAt("popPage", 250, 250, 1+8+512)

(cont.)
Metadata Animation objects can now contain metadata. This allows each animation point to
have a collection of name-value pairs, which can be modified at runtime. Metadata
is configured on a new tab within the Object Properties.
In Vijeo Citect version 7.10 and before, it is not possible to associate a large
number of parameters before launching a SuperGenie/Popup page using only the
expression field of the Input command. This is because of the 253 character limit in
Cicode expression fields. To get around this limitation, it is now possible to instead
create a set of Name/Value pairs which are stored with the animation point as
Metadata. These will contain all the Page Associations defined in the
SuperGenie/Popup Page Properties and set the values that will be used in the
SuperGenie/Popup Page Associations.
Then simply call a built-in Cicode function that will take this Metadata and
Associate each of the Names to the Values for the next page to be opened.
Example -
AssMetadataPop("!PopControl")
The AssMetadataPopup function uses the Metadata information from the current
AN for the Associations for a Popup Page, and displays the Popup Page in a popup
window all in one function.

Exercise - Popup Pages
Popup pages are dynamic pages to which information can be passed when the page
opens in the runtime system. These pages can be used for pop-up type controllers
for a process or a single piece of plant floor equipment.
For example, a graphics page could be configured with several pumps, and a single
super genie or a pop-up controller could be used for each of the pumps on the page.
1 Create a popup page (as shown below) that displays and controls
both a digital and a numeric tag.
i. Open the Citect Graphics Builder.

ii. Create a New page based on the Standard Blank template.

Exercise - Popup Pages (cont.)
iii. Add five buttons to the page.
Appearance (General) Input (Touch) Up

Text/Symbol
Start ?Digital State? = 1
Stop ?Digital State? = 0
Auto ?Digital Mode? = 0
Manual ?Digital Mode? = 1
icons.clos2 Winfree();
iv. Draw the four light symbols using the Symbol Set tool. Set the
properties as follows:
Object ON symbol when Symbols

Start Light ?Digital State? = 1 OFF lights_square_medium.grey
ON lights_square_medium.green
Stop Light ?Digital State? = 0 OFF lights_square_medium.grey
Auto Light ?Digital Mode? = 0 OFF lights_square_medium.grey
Manual Light ?Digital Mode? = 1 OFF lights_square_medium.grey
v. Add a numeric object to the page.
Appearance (Display Value) ?INT Numeric?

Numeric expression
Input (Keyboard Commands) #### ENTER
Key sequence
‘#### ENTER’ command ?INT Numeric? = ArgValue1

vi. Place the pointer at the bottom right hand corner of the objects.
Check the pointer position display on the status bar.
vii. Go to the File » Properties » Appearance Tab and enter the X and Y
pointer positions into the Width and Height. This will define the size
of the popup page. The Background colour of the page may be
changed here also.
See Also:
For further information about Supergenie page sizes, see Vijeo Citect KB Article
Q3083 - Minimum size of a SuperGenie page.
viii. Select the Associations Tab and enter the Name and Description of
the substitutions used on the page.
ix. Save the page as !PopControl.

2 Assign the popup page to the genie.

i. Open the genie PumpController from the mill genie library.
ii. Double click the pump and replace the genie Touch command with
the details below:
Input (Touch) AssMetadataPopup("!PopControl");

Up Command WinTitle(AssGetProperty("State","TagName"))
iii. Add the named items that are to be associated with the Popup page
into the Metadata (General) tab of the pump symbol
Name Value
State %Tag%_Pump_Run
Mode %Tag%_Pump_Man
Numeric %Tag%_Pump_Speed
See Also:
For further information, search the Vijeo Citect Help for Metadata.
iv. Save the genie and select Tools » Update Pages to propagate the
changes through the project.
3 Compile and run the project to test the genie.

ii. Open the page WoodChip and click the Bark Tank Pump symbol
set. The popup page !PopControl should look like this:

(cont.)
Value on Error The functionality of these popup pages may be extended by using Smart Pages. A
popup page may be used with other objects but sometimes there may be a tag
association that is not used. If this happens the #ASS (Association) error is
displayed on the page.
A Value on Error provides a value to be used if the substitution was not performed
or a tag name was specified that did not resolve to a valid tag name. This allows the
popup pages to ignore assignment errors and increase the usability of the popup
pages.

Exercise - Create Smart Popup Pages
Use Value on Error and Hidden When properties to cope with unresolved tag
names.
1 Create a new popup page for the machine controllers

i. Return to the Citect Graphics Builder and open the popup page
!PopControl.
ii. Save the popup page as !SmartControl.
iii. Delete the Auto and Manual buttons and corresponding lights.
iv. Move the Numeric object and Close button up and resize the View
area accordingly and change the background colour.
v. Select the Associations tab and edit the details as below:
Name Value on Error Description

Numeric NA Machine Speed
State NA Machine Control ON/OFF
2 Hide the objects in the popup page if tags are not assigned to the
objects.
i. Use the function AssGetProperty() in the buttons and symbol sets to
hide the objects if the tags do not exist.
Object Appearance (Visibility)

Hidden when
Start Button
Start Light
AssGetProperty("State","ErrorValUsed")
Stop Button
Stop Light
Numeric Object
Numeric Object AssGetProperty("Numeric","ErrorValUsed")
Rectangle
ii. Save the page.

Exercise - Create Smart Popup Pages (cont.)
3 Create a Genie to call the Smart Popup Page.

i. Create a new genie.
ii. Paste the symbol mill.gears near the Genie Locator Point .
iii. Double click the symbol to open the Symbol Properties and add this
Touch Command:
Input (Touch) AssMetadataPopup("!SmartControl");

Up command WinTitle(AssGetProperty("State","TagName"))
iv. Add the Metadata:
Name Value
Numeric %Tag%_Speed
State %Tag%
v. Save the genie as smartcontroller in the Mill library.
4 Implement the genie and popup page.

i. Add these genies to the WoodChip page.
near Machine Variable Tag

Barking Drum Bark_Drum
Chipper Chipper
Digester Digester
ii. Save the page.

Exercise - Create Smart Popup Pages (cont.)
5 Test the genies and popup pages.

ii. Open the WoodChip page - it should look something like this:

Summary
Summary This chapter covered the following topics:
 Graphics Enhancements and Popup Pages (page 6-2)
 Describe the difference between Named and Numbered parameter substitution

in popup pages.
 What information would appear on the Associations tab of the popup page
Properties dialog box?
 What makes a popup page 'Smart?'

Chapter 7: System Security
Overview
Introduction
Vijeo Citect Version 7.20 sees the implementation of several Security
Enhancements. These enhancements mean changes to the way User records are
handled. User based security settings have been removed from the Users form. User
security settings are now defined by the Roles field.
Additionally, setting up a trusted SCADA network will involve configuring a

shared password to enable authentication.
 Server Access Authentication ................................................ 7-2

 Roles ...................................................................................... 7-4
 AutoLoginMode Parameter ................................................... 7-9
 Multi Signature Support ...................................................... 7-10
Server Access Authentication
Server As part of the process to increase system security, whenever multiple computers are
Authentication involved in a Vijeo Citect network, be it a Server with multiple Clients or a
Distributed Server model, all Servers must be given the same Server Password.
This is configured via the Computer Setup Wizard.
The password is saved into the local Windows secure store.
Once configured, this never needs revisiting. However, the password MUST be the
same on all connected machines.
The password was configured earlier in the course in Exercise - Upgrade a Project
(page 2-30).
 Note:
System administrators should use extreme care when changing this password. It is
not possible to manage a gradual change-over from one password to another as
there will be severe problems with connectivity between Servers. This cannot even
be properly managed in a fully redundant system. Passwords should only be
changed during a full system shutdown event.

Server Access Authentication (cont.)
The Server User Using the credentials provided, a Server User will be automatically logged in to
the server processes on the current computer, giving any Cicode run from that
Server, the privilege level of this Server User.
This user has nothing to do with the Runtime Manager or any processes related to
it, only Cicode tasks.
 Note:
The Server User configuration screen is only available when the Computer Setup
Wizard is configured for Multi-Process.
There are three options for the Server user.
Default Server User All Cicode will be run on the Server as if it is owned
by a user with full access to all areas and all
privileges - this is an internally defined 'virtual' user.
None Any Cicode function requiring a Privilege level on

the server will fail to run.
Specific User The user must be either a known user in the current
project or a valid Windows user connected to the
project via the Windows groups feature.
The Server User was configured earlier in the course in Exercise - Upgrade a
Project (page 2-30).

Roles
Roles In Vijeo Citect Version 7.20, User Privileges are organised into Roles.
A Role is used to define the security permissions for a group of people; hence the
name 'role.' This is used to identify a job-role and define the permissions
appropriate to that Role.
There is no reason that multiple Roles cannot have the same array of permissions,
but because of operational issues, it might make sense to keep operationally-defined
Roles distinct. Perhaps a Role called Manager might have the same permissions as
another Role called Supervisor.
Once defined, one or more Roles can be assigned to individual Users.
How to Add  To define a role:

Roles
In the Citect Explorer, select a project and open the System folder, then double
click the Roles icon:
or
In Citect Project Editor, select the menu System » Roles.

Roles (cont.)
Migrating Users When upgrading an existing project using the Migration Tool, a new Role will be
created (if needed) for every existing User. The new Role will have the same
security settings that were defined for that User and be given a generic name such
as Role_1, Role_2 etc. During the upgrade process, if a Role exists with the same
security settings as the User, then the existing Role will be assigned to the User
being upgraded. For example; If Role_1 exists and matches the security settings of
the upgraded user then that user will be assigned Role_1 also.
If you do not want to migrate users from an existing project de-select the option
Create Roles from User security information from the Migration Tool dialog
before running it.
All upgraded Users are shown in the Migration log file, as well as the newly created
Roles.

Exercise - User Security
1 Add a new Role.

i. Open the Project Editor and select System » Roles from the menu.
ii. Type Supervisor in the Role Name field.
iii. Add Global Privilege of 4 in the Global Privilege field.
iv. Click Add. The dialog should look like this:
v. Close the Roles dialog.
2 Create a new User using the new Role.

i. In the Project Editor, select the menu System » Users.
ii. Create a new User using the details below:
User Name Sammy
Full Name Sammy Supervisor
Password sammy
Role Supervisor
3 Apply Security to project.

i. In the Project Editor, select the menu System » Menu
Configuration.
ii. Press F2 to view the extended version of the form.
iii. Edit the Tools menu items as below:
Menu item Privilege level

TagDebug 4
Display Kernel 1,8
Shutdown 8

Exercise - User Security (cont.)
iv. In the Project Editor, select the menu Tools » Computer Setup
Editor.
v. Complete the Parameter details as follows:
vi. Click Add to save the new value.

vii. Close the Computer Setup Editor and Save when prompted.
4 Log in to running project.

ii. Once the project is running, attempt to Shutdown the project by
clicking the Windows Titlebar Close button.
iii. A Shutdown Vijeo Citect dialog will display as a Privilege Level of 8
is now required to Shutdown a running project.
iv. Click the Login button (in the upper left of the running
project) and login with the Name of Sammy and the password of
sammy.
As Vijeo Citect authenticates the User credentials this message will

appear on the screen:
v. When the User credentials have been authenticated, the Username

will appear in the top right corner of the screen.

Exercise - User Security (cont.)
vi. Try again to Shutdown the project using the Windows Titlebar Close
button - again the No Privilege for Action dialog will display as
Sammy does not have the required Privilege Level to Shutdown the
project.
vii. Test the other security measures:
Login as user Test Expected result Check

Sammy Access the TagDebug (Tools Should be allowed
menu)
Access the Kernel (Tools menu) Should not be allowed
Designer Access the Kernel (Tools menu) Should be allowed
Shut down the project Should be allowed

AutoLoginMode Parameter
AutoLogin The pre-existing AutoLogin capability has been extended to include the client,
when the user is a Windows user with an associated Vijeo Citect role. In order to
invoke this functionality for a Windows user the [Client]AutoLoginMode
parameter needs to be set in the Citect.ini file.
These are the allowable values for the [Client]AutoLoginMode parameter:
Value Description
0 (default) Auto login disabled. Control Client starts in view-only mode, until a valid
user logs on
1 Login current windows user at system start up
2 Login current windows user as system default user at start up
3 Prompt user for login at startup
4 Prompt user for login at startup and logout
5 Try login with saved credential at startup
6 Try login with saved credential at startup and on logout

Multi Signature Support
High Level When a User is logged on to a runtime system with the associated Privileges and
Authorisation Areas of the Role to which the User belongs, there are times when a higher level
authorisation is required for the User to perform certain actions. An example of this
is in the Pharmaceutical Industry in the United States where FDA guidelines on
electronic records and electronic signatures are defined in Title 21 CFR Part 11 of
the Code of Federal Regulations. One of the requirements of this code is that
electronic signatures must be countersigned by more than one person.
In order to comply with regulations such as these Vijeo Citect has developed Multi
Signature Support. The MultiSignatureForm function can be displayed through a
Cicode form to allow countersigning of an operation by another User who has the
required level of Privilege.
The MultiSignatureForm function displays a form that allows up to four Users to

have their credentials verified in order to approve an operation. The Usernames can
be native Vijeo Citect or Windows Integrated Security users.
See Also:
For further information about the MultiSignatureForm function, see Vijeo Citect
Help - MultiSignatureForm.
Further Training:
Techniques used to create Vijeo Citect forms using Cicode are covered in the Vijeo
Citect Customisation and Design Course.

Exercise - Multisignature Support
1 Create a device to log all MultiSignature activity.

i. Open the Project Editor and select System » Devices from the menu.
ii. Complete the Device definition form with the following information:
Name ApprovalLog
Format {Date,10} {Time,5} {Text,256}
File Name [DATA]:App_Log.txt
Type ASCII_DEV
No. Files -1
Comment Records operations that were approved
iii. Click Add to create the new device then compile the project.
2 Add MultiSignature Support to a command in the project.

i. Return to the Graphics Builder and open the Woodchip page.
ii. Double click the Bark Conveyor light to open the properties of the
symbol set.
iii. Open the Input (Touch) tab. The Up command uses the function
Toggle(Bark_Conveyor) to turn the Bark Conveyor on and off. Add
the MultiSignatureForm() function before the Toggle() function.
IF MultiSignatureForm("Toggle Bark Conveyor",

"ApprovalLog","Designer", "Operator", "", "")
THEN
Toggle(Bark_Conveyor)
END
iv. Click OK to close the dialog then save the page and compile the
project.

Exercise - Multisignature Support (cont.)
3 Test the MultiSignature approval.

i. Run the Pulp_V610_R1 project and log in as any user.
ii. Open the Woodchip page.
iii. Click the Bark Conveyor light. The Signature Verification form will
open and prompt for verification from the two users Designer and
Operator.
iv. Click the Verify button for the Designer.

v. The Authenticate credentials form will open. Use the password des.
Click OK to close the form.

Exercise - Multisignature Support (cont.)
vi. Repeat for the Operator. Use the password opr. When both users
have been verified this form will appear.
vii. Click the Approve button. The Operation Approved form will be
displayed. Click OK to close the form.
viii. Open the App_Log.txt file in the [DATA]: directory and check the
information that has been recorded.

Summary
 Server-to-Server Authentication (page 7-2)

 Roles (page 7-4)
 AutoLoginMode Parameter (page 7-9)
 Multi Signature Support (page 7-10)
 What is a Role?
 What are the three (3) options for a Server User?

Chapter 8: Course Summary
Overview
Introduction
This chapter covers the course summary and the next steps through the Educational
Services curriculum.
 Summary - Vijeo Citect Upgrade .......................................... 8-2

 Course Evaluation .................................................................. 8-3
 Further Training ..................................................................... 8-4
 Examinations ......................................................................... 8-6
Summary - Vijeo Citect Upgrade
Course At the completion of the Vijeo Citect Upgrade course, students should:
Objectives -
Summary  Upgrade previous project versions
 Implement the content within the new Tab_Style_Include project
 Use Server-side On-line Changes
 Take advantage of the Tag Extensions functionality
 Use Named Associations and Metadata
 Enhance system security using Roles

Course Evaluation
Evaluation Form At the end of each training course, all participants are requested to complete the
Course Evaluation Form.
The Evaluation Form is used by the Educational Services team to constantly

improve the quality of the courseware and services.
Training Training Certificates are presented to participants who have completed one of the
Certificates courses in the Vijeo Citect Curriculum (excluding Overview). The completion of
the Course Evaluation Form is mandatory in order to receive a Training
Certificate.
Please Fill Out At the completion of a Vijeo Citect course, students who would like an attendance
Evaluation certificate, should go to this site:
http://www.citect.com/evaluation

Further Training
Next Steps in Citect offers a variety of technical training courses to meet your specific training
Training requirements. Instructor-led courses provide you with hands-on experience, leaving
you feeling confident to design and configure your own systems.
Citect training services include configuration and programming courses, update

courses, and introductory courses for Vijeo Citect, Vijeo Historian and Unity Pro.
We have developed unique, step-by-step training that has proven highly effective,
and our curriculum is continually updated, enabling you to stay in step with rapidly
changing technology.

Further Training (cont.)
Course Offerings Educational Services offer the following courses:
 Vijeo Citect Configuration Course: Citect Configuration Environment,

Project Management, Communications, Graphics, Operator Input, Genies,
Popup Pages, Events, Alarms, Process Analyst, Page Management, Reports,
Accumulators, Security, Introduction to Cicode, Multi-Language Projects,
Design Specification.
 Vijeo Citect Upgrade Course: Upgrade a project to the latest version of Vijeo
Citect, Install Multiple Versions of Vijeo Citect, Vijeo Citect Architecture, Tag
Extensions, Diagnostic Tools and New Templates.
 Cicode Programming Course: Introduction to Cicode, Variable Operators,
Cicode Editor, Cicode Functions, Conditional Executors, Structured
Programming, Cicode Debugger
 Vijeo Citect Architecture and Redundancy Course: Vijeo Citect
Architecture, On-line Changes, Clustered Control System, Vijeo Citect
Redundancy, Web Client and Windows Integrated Security.
 Vijeo Citect Customisation and Design Course: Custom Templates, Smart
Genies and Popup Pages, Forms, Exchanging Data with other Applications,
Custom Alarm Filtering.
 Vijeo Citect Diagnostics and Troubleshooting Course: Network
management and the kernel, Publish Subscribe Model of Communications,
Cicode and the Kernel, System Logging Tools, Tag Extensions, System profile
Tools and Network Analysis.
 CitectHistorian Configuration Course: Installation, Connecting to HMIs,
SQL Server, Publishing Data, Historian, Backfill Manager, Security, Managing
Projects, Displaying Information in Clients, SQL 2005 Reporting Services
Design, Connecting to SQL Databases, Events, Tasks.
 Unity Pro Configuration Course: The Unity Pro Interface, Managing Projects,
Language Editors, Functional Block Diagram Language (FBD), Animation and
Animation Tables, Graphics, Function Blocks, Sequential Function Chart
(SFC), Project Maintenance and Documentation, Communications and OFS
Server.
Full course descriptions are available on the Citect website.

Examinations
Certified The CEP program distinguishes and recognizes engineers skilled in the integration
Engineer of Schneider Electric based automation projects, and encourages other engineers to
Program move in this direction. At the heart of the CEP program is the CEP exam, which
provides a means of testing experienced systems engineers. It encompasses tests for
both Vijeo Citect knowledge as well as a range of related topics such as PLC
communications, Windows OS and networking.
Further information regarding the CEP program is available on the Schneider

Electric website.

Appendix A: My Appendix
Vijeo Citect Upgrade Manual Release 1 A-1

VJCUpgrade V7.2

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

VJCUpgrade V7.2

Uploaded by

Copyright:

Available Formats

Manual Release 1

Vijeo Citect Upgrade

Citect Pty Ltd

Schneider Electric (Australia) Pty Ltd

ABN 4200 4969 304

Vijeo Citect Upgrade Training Manual

INTRODUCTION AND LEGAL NOTICE

Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Novell and NetWare are registered trademarks of Novell Inc.

Alynda Brown, David Heath, Michelle J Richardson

David MacKay, Ian Thompson

November 2010 Edition for Version 7.20

ii Version 7.20 November 2010

CHAPTER 1: INTRODUCTION TO UPGRADING VIJEO CITECT ................................... 1-1

CHAPTER 2: UPGRADE PROJECTS .............................................................................. 2-1

CHAPTER 3: TAB_STYLE_INCLUDE PROJECT ........................................................... 3-1

CHAPTER 4: ON-LINE CHANGES ................................................................................ 4-1

CHAPTER 5: TAG EXTENSIONS................................................................................... 5-1

CHAPTER 6: GRAPHICS ENHANCEMENTS .................................................................. 6-1

CHAPTER 7: SYSTEM SECURITY ................................................................................. 7-1

CHAPTER 8: COURSE SUMMARY ................................................................................ 8-1

APPENDIX A: MY APPENDIX ....................................................................................... A-1

iv Version 7.20 November 2010

This Chapter Covers These Topics:

 Before the Course Begins ...................................................... 1-2

1-2 Version 7.20 November 2010

 Students attending this course must be familiar with Windows Operating

Vijeo Citect Upgrade Manual Release 1 1-3

Pulp_V610_R1.ctz A fully configured V6.10 project to display the

Upgrade_Include A V7.20 include project containing additional

Colorpik.exe RGB colour management tool.

1-4 Version 7.20 November 2010

Vijeo Citect Upgrade Manual Release 1 1-5

 Hints & Tips

Open a menu “File” then select the menu option “New…”

1-6 Version 7.20 November 2010

Vijeo Citect Upgrade Manual Release 1 1-7

This Chapter Covers These Topics:

 How to Prepare for an Upgrade ............................................. 2-2

File Default Location

2-2 Version 7.20 November 2010

Description Minimum Specification

Description Recommended Specification or Higher

Vijeo Citect Upgrade Manual Release 1 2-3

Vijeo Citect Knowledge Base As for Vijeo Citect Server

Time Scheduler As for Vijeo Citect Server

Batch As for Vijeo Citect Server

2-4 Version 7.20 November 2010

The following demonstration modes are available:

 15 minutes with a maximum of 50,000 real I/O.

Vijeo Citect Upgrade Manual Release 1 2-5

Serial Number 0478-12345

2-6 Version 7.20 November 2010

Vijeo Citect Upgrade Manual Release 1 2-7

Whenever a project is restored, inter-project dependencies are checked. For

 Version 5.21 Service Pack G

2-8 Version 7.20 November 2010

 Improved support for Clustering

Vijeo Citect Upgrade Manual Release 1 2-9

2-10 Version 7.20 November 2010

Where multiple versions are required on a single computer, it is strongly

Vijeo Citect Upgrade Manual Release 1 2-11

How to Swap  To change between Vijeo Citect product versions:

2-12 Version 7.20 November 2010