Manual Release 1

Vijeo Citect Architecture and Redundancy

Training Manual
Version 7.20

Schneider Electric (Australia) 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) Pty Ltd 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) Pty
Ltd 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 Architecture and Redundancy Training Manual

INTRODUCTION AND LEGAL NOTICE

Your purchase of this official Vijeo Citect Architecture and Redundancy Training Manual entitles you to undertake the Vijeo Citect Architecture and Redundancy
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) Pty Ltd and all rights, including copyright, are reserved by Schneider Electric
(Australia) Pty Ltd. 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) Pty Ltd will not accept any liability for action taken in reliance on this training manual.

COPYRIGHT

(c) Schneider Electric (Australia) Pty Ltd 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) Pty Ltd. Any
authorised reproduction must acknowledge Schneider Electric (Australia) Pty Ltd as owner of copyright in work.

TRADEMARKS

Schneider Electric (Australia) Pty Ltd 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)
Pty Ltd

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) Pty Ltd. 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

Contributors

David MacKay, Ian Thompson

October 2010 Edition for Version 7.20

Manual Release 1
Written, Printed and bound in Australia

ii Version 7.20 October 2010

Contents

CHAPTER 1: INTRODUCTION TO ARCHITECTURE AND REDUNDANCY ...................... 1-1

Overview .................................................................................................................... 1-1
Before the Course Begins ........................................................................................... 1-2
Course Overview ........................................................................................................ 1-3
Conventions Used in this Manual............................................................................... 1-6

CHAPTER 2: VIJEO CITECT ARCHITECTURE ............................................................. 2-1

Overview .................................................................................................................... 2-1
Citect Servers, I/O Servers and Clients ...................................................................... 2-2
Clustering ................................................................................................................... 2-5
Network Addresses in Vijeo Citect .......................................................................... 2-11
Configure Servers for Networking ........................................................................... 2-13
Time Synchronisation............................................................................................... 2-19
Servers and Control Clients...................................................................................... 2-28
Distributed Processing.............................................................................................. 2-35
Runtime System Management.................................................................................. 2-38
Manage Vijeo Citect Files ........................................................................................ 2-39
The Copy Parameter ................................................................................................. 2-47
Shared Citect.ini File Settings .................................................................................. 2-52

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

Overview .................................................................................................................... 3-1
Online Changes .......................................................................................................... 3-2

CHAPTER 4: CLUSTERED CONTROL SYSTEM ............................................................ 4-1

Overview .................................................................................................................... 4-1
Global Clients............................................................................................................. 4-2
Multi-Project Backup and Restore ........................................................................... 4-15

CHAPTER 5: VIJEO CITECT REDUNDANCY ................................................................ 5-1

Overview .................................................................................................................... 5-1
File Server Redundancy ............................................................................................. 5-2
Data Path Redundancy ............................................................................................... 5-4
Network Redundancy ................................................................................................. 5-6
Alarm, Report and Trend Server Redundancy ........................................................... 5-7
I/O Server Redundancy ............................................................................................ 5-14
Multiple Standby Devices ........................................................................................ 5-21
I/O Device Promotion............................................................................................... 5-23
Disk PLC Redundancy ............................................................................................. 5-26

Vijeo Citect Architecture and Manual Release 1 iii

Redundancy
CHAPTER 6: WEB CLIENT .......................................................................................... 6-1
Overview .................................................................................................................... 6-1
What is the Web Client?............................................................................................. 6-2
System Architecture ................................................................................................... 6-4
Internet Information Services - (IIS) .......................................................................... 6-7
Install the Web Server Software............................................................................... 6-10
Web Server File Structure ........................................................................................ 6-16
Prepare the Vijeo Citect Project for Deployment..................................................... 6-20
Web Deployment Preparation Tool.......................................................................... 6-23
Web Deployment Page ............................................................................................. 6-26
Web Client Home Page ............................................................................................ 6-28
Configure a Deployment .......................................................................................... 6-29
Manage Deployment Packages................................................................................. 6-42
Security..................................................................................................................... 6-46
Web Server Security................................................................................................. 6-47
File System Security Configuration ......................................................................... 6-57
Redundant Servers.................................................................................................... 6-68
Management of Floating Licenses............................................................................ 6-70

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

Overview .................................................................................................................... 7-1
Server Access Authentication..................................................................................... 7-2
Roles ........................................................................................................................... 7-4
Multiple Roles ............................................................................................................ 7-9
AutoLoginMode Parameter ...................................................................................... 7-14
Multi Signature Support ........................................................................................... 7-16

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

Overview .................................................................................................................... 8-1
Summary - Vijeo Citect Architecture and Redundancy ............................................. 8-2
Course Evaluation ...................................................................................................... 8-3
Further Training.......................................................................................................... 8-4
Examinations .............................................................................................................. 8-6

iv Version 7.20 October 2010

 Chapter 1: Introduction to Architecture and
Redundancy

Overview
Introduction
A Vijeo Citect monitoring and control system may be configured to suit any
industrial application. Vijeo Citect has been designed with flexibility in mind,
therefore, a system may be designed to suit the exact project requirements.

Vijeo Citect suits both small and large applications. Because it is flexible, Vijeo
Citect will keep pace with the plant and information requirements as they change
and expand.

Although modern computer systems have a very high degree of reliability, it is

critical for modern production facilities to ensure uninterrupted operation. Full
multi-server redundancy in Vijeo Citect may be implemented without changing the
project configuration.

This Chapter Covers These Topics:

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

 Course Overview ...................................................................1-3
 Conventions Used in this Manual..........................................1-6
 Before the Course Begins

Course
Instructor Please write the name of the Instructor here  ____________________

The course Instructor will be spending the next two days 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.

Prerequisites Students attending this course are expected to be familiar with basic aspects of
network design and architecture. This includes the following topics:

 Characteristics of a distributed file system

 The OSI Reference Model
 Ethernet and wireless network topologies
 IP addresses and subnet masks
 WANs and the Internet
 Principles of routing
Students unfamiliar with these concepts should consider attending the 1-day course
"Ethernet-IP"

In addition, students should be entirely familiar with the material and concepts
covered in the Vijeo Citect Configuration course.

1-2 Version 7.20 October 2010

 Course Overview

Course By the completion of this training course students will:

Objectives
 Implement complex server structures
 Manage on-line changes
 Implement Clustering and multi-cluster structures
 Implement Redundancy
 Configure Vijeo Citect for use over the LAN using the Web Client
 Configure Windows Integrated Security

Target Audience The Vijeo Citect Architecture and Redundancy training course is an integral part of
the complete Educational Services curriculum. This course is designed for:

 Engineers who will be responsible for the design and maintenance of a Vijeo
Citect network
 Network administrators who need to understand how Vijeo Citect is configured
on their network
 Vijeo Citect System Integrators and Designers
 Technical users who maintain and develop an installed Vijeo Citect system

Prerequisite The Vijeo Citect Architecture and Redundancy training course is set at the
Knowledge Advanced level within the 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 the Vijeo Citect Configuration course or should
be familiar with the content and concepts within that course

Vijeo Citect Architecture and Manual Release 1 1-3

Redundancy
 Course Overview (cont.)

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

Course Assets For this course, in addition to the standard Vijeo Citect software, the following files
are required.

Training_Include.ctz An include project containing additional resources

required for the execution of the course.

Pulp.ctz A fully-configured project to display the operation of a

simple paper-processing pulp mill.

Paper.ctz A colour-blending solution to produce the dyes

required to produce coloured paper.

PulpDSK.ctz An identical project to the Pulp project above, but

based on a Disk PLC IODevice.

PaperDSK.ctz An identical project to the Paper project above, but

based on a Disk PLC IODevice.

ModelSolution.zip Multi-cluster exercise solution project.

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.

1-4 Version 7.20 October 2010

 Course Overview (cont.)

Course Program The training course will take two days to complete. The following program
outlines the topics that will be covered on each day:

Day Topics
1  Vijeo Citect Architecture
 On-line Changes
 Clustered Control System
2  Vijeo Citect Redundancy
 Web Client
 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.

Vijeo Citect Architecture and Manual Release 1 1-5

Redundancy
 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

1-6 Version 7.20 October 2010

 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)

Vijeo Citect Architecture and Manual Release 1 1-7

Redundancy
 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.

1-8 Version 7.20 October 2010

 Chapter 2: Vijeo Citect Architecture

Overview
Introduction
This section broadly covers all aspects of Vijeo Citect networking including Citect
Servers, I/O Servers, Clusters and Distributed Servers. Managing a Vijeo Citect
system will also be discussed.

This Chapter Covers These Topics:

 Citect Servers, I/O Servers and Clients .................................2-2

 Clustering...............................................................................2-5
 Network Addresses in Vijeo Citect .....................................2-11
 Configure Servers for Networking ......................................2-13
 Time Synchronisation ..........................................................2-19
 Servers and Control Clients .................................................2-28
 Distributed Processing .........................................................2-35
 Runtime System Management .............................................2-38
 Manage Vijeo Citect Files ...................................................2-39
 The Copy Parameter ............................................................2-47
 Shared Citect.ini File Settings .............................................2-52
 Citect Servers, I/O Servers and Clients

How Vijeo Citect As well as being a client, any computer in a Vijeo Citect system may act as an
is Structured, Alarm, Report, Trend or I/O server. Clearly in a larger environment, server tasks
Client/Server will be dedicated to individual servers, but small sites could reasonably configure a
single computer to handle all server and client functionality.

The diagram shows each of the duties assigned to individual computers, but Vijeo
Citect permits all of these to be configured on a single computer.

 Note:
Windows XP supports a maximum of 10 inbound client connections. More than
one of these might be used by a single remote computer, for instance a
<ShortName1> client and a file share would each consume a connection.

A Windows server product must be used if more than 10 connections are required.

2-2 Version 7.20 October 2010

 Exercise - Examine Client/Server Structure

Divide the class into two groups. Most of the course will use these two groups to
test different aspects of Vijeo Citect networking and redundancy.

1 Restore the projects Pulp and Paper.

i. Restore the Training_Include project.
ii. Restore the two projects Pulp and Paper provided by the Instructor.

 Note:
The first group will use the project called Pulp and the other group will use the
project called Paper. However, both will be required at various times during the
course.

The projects are configured with these I/O Server and I/O Device
names.

Pulp Paper
I/O Server PulpPrimary PaperPrimary

I/O Device PulpDevP PapDevP

I/O Device No 1 2

Vijeo Citect Architecture and Manual Release 1 2-3

Redundancy
 Exercise - Examine Client/Server Structure
(cont.)

2 Compile the projects.

i. Open the Citect Project Editor; click the Compile button. There
should be some errors.

ii. Examine the errors. These are caused because the Cluster Names
and Servers have not been configured.

2-4 Version 7.20 October 2010

 Clustering

What is a A cluster is a discrete group of alarm, trend, report, and I/O servers. Local Vijeo
Cluster? Citect clients will connect to this cluster. For a plant comprising several individual
sections or systems, multiple clusters can be used, one cluster for each section.

There are many variations in the way in which a Vijeo Citect clustered system can
be configured. The most appropriate configuration will depend on the requirements
for the solution to be deployed and the environment in which it is being deployed.
In the next few exercises the class will explore some of these clustering structures.

Vijeo Citect Architecture and Manual Release 1 2-5

Redundancy
 Clustering (cont.)

Rules of When configuring Vijeo Citect the following rules apply:

Clustering
 Each Cluster must have a unique name.
 Each Server component must belong to one Cluster.
 Each Server component must have a unique name within the Cluster.
 Each Cluster contains only one pair of Alarm Servers. Those Servers, which are
redundant to each other, must reside on different computers.
 Each Cluster contains only one pair of Report Servers. As with the Alarm
Servers, those redundant Servers must reside on different computers.
 Each Cluster contains only one pair of Trend Servers. Again, those redundant
Servers must reside on different computers.
 Each Cluster can contain an unlimited number of I/O Servers (up to the limit of
16,383 I/O Devices). It is possible to have more than one I/O Server on the
same computer as long as they are in different Clusters.
The diagram below is an example of a Vijeo Citect system running with two
Clusters across three machines. All Server and Client components have been
deployed in accordance with the clustering rules.

2-6 Version 7.20 October 2010

 Clustering (cont.)

Breaking The next diagram demonstrates circumstances which break the clustering rules.
Clustering Rules

The Vijeo Citect compiler or the Vijeo Citect Runtime Manager detects when the
rules of clustering are not being observed and advises the user accordingly.

How to Create a  To name a cluster:

Cluster
Open the Citect Project Editor and select the menu Servers » Clusters.

See Also:
For further information about Clusters, see Vijeo Citect Help - Using Vijeo Citect »
Implementing Clustering.

Vijeo Citect Architecture and Manual Release 1 2-7

Redundancy
 Exercise - Create Clusters

Create a Cluster in each project.

1 Create a Cluster called Pulp_Cluster_1 for the Pulp project.

i. Open the Citect Explorer and ensure that the Pulp project is
selected.
ii. Open the Citect Project Editor and select Servers » Clusters.

iii. In the Cluster Name field, enter Pulp_Cluster_1 and click the Add
button.

 Note:
The Record indicator, located in the lower left corner of the Cluster [Pulp] window,
should now specify that one Cluster record has been created for the Pulp project.

2 Create a Cluster called Paper_Cluster_1 for the Paper project.

i. Return to the Citect Explorer and select the Paper project.
ii. Open the Citect Project Editor and select Servers » Clusters.
iii. In the Cluster Name field, enter Paper_Cluster_1 and click the Add
button.

2-8 Version 7.20 October 2010

 Exercise - Assign Clusters to Servers

1 Create a Report server called Pulp_Report_P for Pulp_Cluster_1 of

the Pulp project.
i. From the Project Editor, open the menu Servers » Report Servers.

ii. Select Pulp_Cluster_1 from the Cluster Name dropdown list.

iii. Name the new Report Server Pulp_Report_P then click Add.

2 Create Alarm and Trend servers.

i. Using the same naming scheme, create an Alarm Server.
ii. Repeat the process to create a Trend Server.

Vijeo Citect Architecture and Manual Release 1 2-9

Redundancy
 Exercise - Assign Clusters to Servers (cont.)

3 The project has an existing I/O Server. Open the I/O Server
definition form and add it to the cluster.
i. Open the Citect Project Editor. Select Servers » I/O Servers.
ii. Select Pulp_Cluster_1 from the Cluster Name dropdown list.

Students should remember to click Replace, not Add.

iii. The set of four server configuration screens should look like this:

iv. Compile the project; confirm there are no errors.

4 Repeat the entire exercise for the Paper project.

5 Backup the projects as PulpStandAlone and PaperStandAlone.

2-10 Version 7.20 October 2010

 Network Addresses in Vijeo Citect

Project Based The project's network topology is embedded in the project. This means that the
Definition network architecture is configured from within the Project Editor. Servers and their
IP addresses are set up in the Network Addresses dialog in the Project Editor.

This means that physical computers in the system can be changed easily. As long as
the IP address of the new machine is the same as the one being replaced, the new
computer will be able to take the same role immediately.

As each computer starts it reads the Network Addresses database. If its own
network address matches any of the network addresses defined in the project the
computer will assume those defined roles.

How to  To configure a Network Address:

Configure
Network In the Project Editor, select Servers » Network Addresses.
Addresses

Vijeo Citect Architecture and Manual Release 1 2-11

Redundancy
 Exercise - Configure Network Addresses

Create a machine Network Address record for each project.

1 In conjunction with the class Instructor, decide the network

addresses for the Pulp project.
i. Find the IP Address of the local computer.
ii. Open the Citect Explorer and ensure that the Pulp project is
selected.
iii. Open the Citect Project Editor and select Servers » Network
Addresses.

iv. Enter the name Pulp_Server, and the IP address of the local
computer, then click the Add button.

2 Repeat the exercise for the Paper project.

2-12 Version 7.20 October 2010

 Configure Servers for Networking

How a In any Vijeo Citect system, the various Server components need to be named.
Networked However it is only when the system is changed from a stand alone system to a
Server is network configuration that the Network Addresses need to be added to all of the
Configured server definitions.

When the computer starts it looks at the definition files. If the Network Address
identifies the computer as one or more servers it will start up and assumes those
roles.

Vijeo Citect Architecture and Manual Release 1 2-13

Redundancy
 Exercise - Configure Servers for Networking

1 Add the network addresses to the server definitions.

i. Open the Citect Explorer and ensure that the Pulp project is
selected.
ii. Open the Citect Project Editor and select Servers » Alarm Servers.
iii. Select the computer from the Network Addresses dropdown list.

iv. Click Replace.

v. Add the Network Address to the Server definition forms for the
Report, Trend and I/O Servers.

2 Add the Network Addresses to all the servers in the Paper project.

3 Compile the projects.

2-14 Version 7.20 October 2010

 Exercise - Configure Servers for Networking
(cont.)

4 Run the Computer Setup Wizard.

i. Click the Computer Setup Wizard button on the main toolbar.

Select Express Setup.

ii. Select the Pulp project.

Vijeo Citect Architecture and Manual Release 1 2-15

Redundancy
 Exercise - Configure Servers for Networking
(cont.)

iii. Server and Control Client will be selected automatically. Tick the
Multi-Process box and then click Next >.

iv. Select Networked as the primary networking model and click

Next >.

2-16 Version 7.20 October 2010

 Exercise - Configure Servers for Networking
(cont.)

v. Set the Server Authentication password to be C1tectr@1n.

 Note:
Server Authentication is covered in depth in System Security (page 7-1)

vi. Click Finish to exit the wizard.

Vijeo Citect Architecture and Manual Release 1 2-17

Redundancy
 Exercise - Configure Servers for Networking
(cont.)

5 Repeat the entire exercise for the Paper project.

6 Run the projects in both Stand-Alone and Multi-Process mode to

test the new configuration.
i. Login as the user Dean (with password dean) to shut down the
running project.

7 Backup the projects as PulpNetwork and PaperNetwork.

2-18 Version 7.20 October 2010

 Time Synchronisation

TimeSyncService Versions of Vijeo Citect prior to Version 7.10 employed a message-based time
synchronisation server to ensure clocks on computers running a Vijeo Citect project
maintained time synchronisation. To support Vijeo Citect running under standard
user rights with User Access Control (UAC) enabled in Windows Vista and
Windows 7, the existing Time Server functionality has been replaced.

In order to maintain time synchronisation Vijeo Citect Version 7.20 installs a

Windows service called TimeSyncService, which runs under the Builtin
LocalSystem account. This purpose of this service is to maintain the time on the
local computer against one or more Time Source computers.

The Time Source computer must have Vijeo Citect installed. However, the Time
Source computer does not need any project configured to allow the Vijeo Citect
computers synchronise with its time nor does it need to have a project running.

Vijeo Citect Architecture and Manual Release 1 2-19

Redundancy
 Time Synchronisation (cont.)

TimeSyncService A Time Synchronisation utility is provided by Vijeo Citect to configure time

(cont.) synchronization, and control the service as part of the administration environment.
The dialog stores and reads settings in the TimeSyncConfig.xml file, which is
installed in the Vijeo Citect Config directory by default. The configuration utility
allows an alternative path to the config file, such as a network share, to be
specified. This can be useful where there are multiple computers using the same
configuration data and to change any setting only one computer needs to be
updated.

This utility requires administrator rights as it configures and controls a windows

service. When run on Windows Vista or later with UAC on, the user will be
prompted to elevate to an administrator. When run on earlier operating systems, the
utility will exit after displaying an error if the current user is not an administrator on
the local machine.

How to Display  To display the Time Synchronization dialog:

the Time
Synchronization Open the Citect Explorer then select Tools » Time Synchronization from the
dialog menu.

2-20 Version 7.20 October 2010

 Time Synchronisation (cont.)

Time Synch as a The status of the Time Synchronization Service may be viewed in the Computer
Service Management screen of the Control Panel, where it is named "Citect Time
Synchronization Service."

Vijeo Citect Architecture and Manual Release 1 2-21

Redundancy
 Exercise - Time Synchronisation

1 Configure the Time Source.

i. Select one computer in the room to be the designated Time Source,
for example, Training01.
ii. Return to the Citect Explorer then select Tools » Time
Synchronization from the menu. This will open the Time
Synchronization Configuration dialog.

iii. Change the Startup type: to Automatic. Click Apply.

2-22 Version 7.20 October 2010

 Exercise - Time Synchronisation (cont.)

iv. Click Start Service then click OK.

Once the service has started on the Time Source computer Vijeo
Citect can be closed and the service will keep running. If the Startup
type: has been set to Automatic and the computer is restarted the
service will restart when Windows restarts.

Vijeo Citect Architecture and Manual Release 1 2-23

Redundancy
 Exercise - Time Synchronization (cont.)

2 Synchronise all computers to the Time Source computer.

i. Open the Time Synchronization Configuration dialog on all of the
computers that will use the Time Source.

ii. Change the Startup type: to Automatic.

2-24 Version 7.20 October 2010

 Exercise - Time Synchronization (cont.)

iii. Click the Keep this computer's time synchronised checkbox. This
will allow the computer to become a Time Client. Note that when
this checkbox is enabled the Synchronize with the first available of:
section becomes active.

Vijeo Citect Architecture and Manual Release 1 2-25

Redundancy
 Exercise - Time Synchronization (cont.)

3 Add the Time Source computer to the list of available time sources.
i. Click the Add button. When the New time source input box opens
enter the name of the Time Source computer, e.g. Training01. Click
OK.

When the dialog closes the Time Synchronization Service will

search for the Time Source. When the Time Source computer is
located the time will appear in the Current Time column.

2-26 Version 7.20 October 2010

 Exercise - Time Synchronization (cont.)

ii. Click the Start Service button. When the service has started the
Current status: will change to Running.

iii. Click the Synchronize Now button.

iv. Click Yes to save the configuration.

v. If the computers are set to different times the time on the client
computer will change to the time on the Time Source computer.
vi. Click OK to close the Time Synchronization Configuration dialog.

Vijeo Citect Architecture and Manual Release 1 2-27

Redundancy
 Servers and Control Clients

How a Control A Vijeo Citect Control Client is configured using the same project-based
Client Connects information as the servers themselves. The Client needs the same information as
to the Server the Server, i.e. the Network Addresses of the servers that it will join. These are the
Report, Alarm and Trend Servers.

The client will use the Network Address definitions to find the Computer Name of
respective servers of Reports, Alarms and Trends to connect to each Server.

2-28 Version 7.20 October 2010

 Servers and Control Clients (cont.)

Servers are also Every Vijeo Citect Server is automatically a Control Client. If a Vijeo Citect
Control Clients computer is defined to be an I/O Server, it will initialise and attempt to contact any
I/O Devices (in the current running project) defined against the I/O Server of that
name.

 Note:
When building large scale systems it is recommended that separate Control Clients
are used to view plant data rather than viewing from Servers.

 Note:
If the Client process running on a Server computer is not being used it can be
stopped in the Runtime Manager without affecting the Server processes.

Vijeo Citect Architecture and Manual Release 1 2-29

Redundancy
 Exercise - Configure Control Clients for
Networking

A Vijeo Citect Control Client needs the network addresses of the Servers defined.

1 Configure the computer to be a client.

i. Select one computer in the room to be the Server. The rest will be
Control Clients.
ii. Open the Citect Explorer and ensure that the Pulp project is
selected.
iii. Open the Citect Project Editor and select Servers » Network
Addresses.
iv. Change the IP address of the local Pulp_Server from the one
previously configured, to the IP address of the computer that has
been allocated as the Server.

v. Click Replace.
vi. Compile the project.

2-30 Version 7.20 October 2010

 Exercise - Configure Control Clients for
Networking (cont.)

2 Run the Computer Setup Wizard.

i. Open the Computer Setup Wizard and select Express Setup.

ii. Select the Pulp project.

Vijeo Citect Architecture and Manual Release 1 2-31

Redundancy
 Exercise - Configure Control Clients for
Networking (cont.)

iii. The Server and Control Client option on the Computer Role Setup
screen will be greyed out. This is because the IP address of the
computer does not match the IP Address configured in point 1 iv.
Select Control Client then click Next >.

 Note:
This sets the [Client]FullLicense parameter in the citect.ini file to 1 (the
default value).

There are three types of Vijeo Citect licence.

1. A Control Client. This is a normal read-write licence which permits full

operation of the project.

2. A View-only Client (in the past referred to as a Manager Client). This grants the
user view-only access to the project; no tags may be changed.

3. A Full Licence. This is the only licence that can run a Vijeo Citect server.
However, should there be a ‘spare’ Full Licence on-site - perhaps during testing or
where an existing server has been decommissioned, this is available for client use.
A Full Licence must be installed locally on the computer; unlike other client
licences, it cannot be accessed across the network.

Vijeo Citect does not permit the dynamic allocation of licenses other than as
specified in this dialog; in fact it will never provide a license different to that which
was requested - if none of the requested license-type is available, none will be
provided.

2-32 Version 7.20 October 2010

 Exercise - Configure Control Clients for
Networking (cont.)

iv. Select Networked as the primary networking model and click Next >.

v. Click Finish to exit the wizard.

3 Repeat the entire exercise for the Paper project.

Vijeo Citect Architecture and Manual Release 1 2-33

Redundancy
 Exercise - Configure Control Clients for
Networking (cont.)

4 Start the Vijeo Citect Network.

i. If the computer that has been designated as the Server for the group
has been changed to a Client in the previous section, ensure that it is
changed back to the Server. As it starts the status line displaying
each of the Servers will be displayed as they are initialised.

ii. Start the Clients. Watch the Status as the Clients connect to the
server.

iii. Change the values in the runtime on the Server and Client machines.
The values will change on all computers in the Vijeo Citect network.
For instance, on the Pulp project, drag the chip-level slider right or
left to increase or decrease the visible chip pile; on the Paper project,
drag the Recycled_Pulp slider to adjust the level of the tank.
iv. On a newly-started project, the values cannot be changed. Why is
this and how is the problem rectified?

5 Shutdown the projects.

2-34 Version 7.20 October 2010

 Distributed Processing

Share the Load In any evolving system, usage will grow, both in terms of PLC tag count and user
impact. After a sustained period of growth, the level of activity may cause too
much of a load for one computer to handle all the server tasks. The scalability of
Vijeo Citect makes it easy to add more computers to the network and to share the
server load between them.

Load sharing of system components across different computers and CPUs means
the workload of a potentially stressed system can be split across multiple machines,
better utilising the available infrastructure.

For example, managing alarms can draw heavily on a CPU's performance, while
trending data can use a lot of disk space. By assigning the trend and alarm servers
to different processes on a shared computer, an alarm server can be used as a
standby trends server, making practical use of idle disk space.

This approach can be used to improve network performance, data access times, and
general system stability.

Although Report, Alarm, and Trend Servers may be renamed, the name of an I/O
Server is not as easily changed since all the I/O Devices are tied to that Server
name. However, all Servers can be easily assigned to run on different computers by
changing the Network Address field.

When the computers are restarted after role reassignment, the new Servers will
recognise their new roles from the Network Addresses in the Server forms and start
in those assigned roles.

Vijeo Citect Architecture and Manual Release 1 2-35

Redundancy
 Exercise - Distributed Processing

1 Create Network Addresses for all services.

i. Open the Pulp project and select one of the Control Clients to be the
Trend Server. Make a note of its IP Address.
ii. Open the Citect Project Editor and select Servers » Network
Addresses.
iii. Rename the Pulp_Server to Pulp_Alarm_P then click Replace.
iv. Create these Network Addresses and make the IP address of the
Trend Server that of the second server. Use the example IP
addresses below as a guide. The Instructor will coordinate the group;
all network settings must be configured by all students for both
projects.

Pulp Pulp Addresses Paper Paper Addresses

Pulp_Alarm_P 10.176.235.101 Paper_Alarm_P 10.176.235.105
Pulp_Trend_P 10.176.235.102 Paper_Trend_P 10.176.235.106
Pulp_Report_P 10.176.235.101 Paper_Report_P 10.176.235.105
Pulp_IO_P 10.176.235.101 Paper_IO_P 10.176.235.105

2 Replace the Network Addresses in the Server definitions.

i. Open the Alarm Server definition form. Change the Network
Address to Pulp_Alarm_P. Click Replace.
ii. Change the rest of the Servers to their corresponding Network
Addresses.
iii. Pack and Compile the project.
iv. Run the Computer Setup Wizard.

3 Test the new configuration.

i. Restart the projects.
ii. Use the graphics pages to change values and ensure that the system
is performing correctly.
iii. Shutdown the projects.

4 Use a workshop environment to test different Client/Server

configurations.
i. Once this first step in Distributed Processing has been mastered,
experiment with a variety of Server layouts to test multiple
possibilities.

2-36 Version 7.20 October 2010

 Exercise - Distributed Processing (cont.)

ii. Complete the following table of tasks. The first 5 should be

performed on each of the Pulp and Paper groups of students. The
final two should be performed as a combined group.

One computer running all server tasks, all other

computers as clients.

As above, but move the Trend Server to one of the

existing client computers.

Retain the configuration above, move the Alarm Server

to a different computer.

Repeat for the Report Server.

Reconfigure the system to have one computer as I/O

Server, another as a combined Alarm, Report and Trend
Server; the remaining computers as Clients.
Swap the Pulp and Paper Alarm Servers by designating
an existing Pulp Client as the Paper Alarm Server and
vice versa.
Swap all Pulp computers (in whatever role they have) to
the equivalent role in the Paper project, and similarly
convert all Paper computers to Pulp.

iii. Complete additional tasks as agreed by the class and Instructor.

Vijeo Citect Architecture and Manual Release 1 2-37

Redundancy
 Runtime System Management

Development and Whenever a running system needs modification, either to add functionality or to
Runtime correct problems, there are clear issues in managing how the changes will be
implemented, tested and introduced.

A compiled Vijeo Citect project is located in the [RUN] folder with the majority of
the application loaded into the memory of the computer (either server or control
client) and generally no further reference to the running application. This means
that it is entirely possible to recompile a project and have a major mismatch
between the running and the stored versions of the project.

Thus it is possible to compile underneath a running system. While this may be true,
it is not recommended for a number of reasons.

 First, there is no going back. The existing project is understandably destroyed

by this activity and replaced by a project of unknown reliability.
 Second, unless the system is tightly controlled while this procedure is
underway, Vijeo Citect computers may hang or crash as users try to change
pages and so on. Even if they do not have any major issues, pages may appear
distorted because of mismatched files (between memory and disk).
A preferable arrangement is to have a separate development area. All modifications
and so on should be done in this project thereby allowing separate testing and
verification. Once this new project is running smoothly all Vijeo Citect computers
on the system can be shifted across. This could be done in conjunction with a
network restart.

Clearly the whole premise of Online Changes (which is addressed in another

chapter) requires the project to be compiled in situ but the warnings above of
version mismatches and potential problems are still true even in that environment.

See Also:
For further information about restarting a running system, see Vijeo Citect Help
Topics - Restarting the System Online.

2-38 Version 7.20 October 2010

 Manage Vijeo Citect Files

Maintain Large A large Vijeo Citect development poses a number of problems. In general larger
and Small projects require larger teams and accordingly better software change management is
Systems required. With a small system it is usually possible to get away with a separate copy
of the [BIN] and the project on every Vijeo Citect computer.

Maintaining a large and complex system like this can quickly get extremely
confusing and tedious however. Typically, Project Managers will recognise the
advantages of a centralised file storage area, allowing many developers to work on
the project(s) at once. This means that updates may be achieved from a central
location and the projects on the runtime computers are updated the next time Vijeo
Citect is restarted.

Once the project is compiled and ready to run, the best location for the runtime files
must be decided. One option is to store them on each Vijeo Citect computer’s local
hard drive. That way the machine is immune to problems on the file server. Another
option is to store the files centrally, obviating the need to copy the runtime files
down to each Vijeo Citect computer after every compile.

Not all files are required for a “runnable” project. In order to sufficiently defend a
Vijeo Citect system against failure, these network architecture questions must be
considered. What will happen if the network fails? What if the file server goes
down? How should the development environment be backed up? What sort of
performance can be expected?

Vijeo Citect Architecture and Manual Release 1 2-39

Redundancy
 Manage Vijeo Citect Files (cont.)

Folder Traversal In order to access the folders containing the various Include projects of a complete
project, it is necessary that the clients have permission to traverse all of the sub-
folders in the [USER] folder. These clients also require write permission, as clients
will update files in the server target location.

To achieve this, it is usual to share the User folder on any source file host to permit
the easy traversal of the entire structure.

2-40 Version 7.20 October 2010

 Exercise - Manage Vijeo Citect Files

Use runtime system management to set up a Vijeo Citect project on a File Server.

1 Designate one computer in each class group to be the File Server.

i. A simple way to navigate to the correct project is to use the location
in the project properties. Open the Citect Explorer on the designated
File Server and compile Pulp the project. When the compile is
complete right click the Pulp project and select Project Properties.

ii. Highlight the path in the Location field, right click and select Copy.

Vijeo Citect Architecture and Manual Release 1 2-41

Redundancy
 Exercise - Manage Vijeo Citect Files (cont.)

iii. Open Windows Explorer, paste the location into the Address field
and click Go.

iv. In the tree hierarchy on the left side of the window, locate and then
right click the User folder and select Properties.
v. Within the Sharing tab select Share this folder.

vi. Click the Permissions button.

2-42 Version 7.20 October 2010

 Exercise - Manage Vijeo Citect Files (cont.)

vii. Give the Everyone group Full Control and then click OK.

viii. Click OK to close Pulp Properties.

ix. Repeat the exercise for the Paper computer.

 Note:
Full Control (and by implication Write Permission) is required as files in the project
are updated when the remote link is established and it is entirely feasible (although
not recommended) that the project may be modified from the Client location; the
system must allow for this.

Vijeo Citect Architecture and Manual Release 1 2-43

Redundancy
 Exercise - Manage Vijeo Citect Files (cont.)

2 Link the project located on the File Server to the Clients.

i. On each of the other computers open the Citect Explorer and remove
the project link from the project that was running previously.
Highlight the project and select Remove Project Link from the right
click menu.

 Note:
Removing the Project Link simply detaches the project entry in the project list
from the current location in the file system. It does not delete the files located in
the original project folder. The next step is to connect the project entry to the new
location on the File Server.
ii. Click Yes to confirm the choice to remove the project link.

iii. Right click My Projects and select Add Project Link… from the
menu.

2-44 Version 7.20 October 2010

 Exercise - Manage Vijeo Citect Files (cont.)

iv. Locate the File Server by using the directory tree. Click OK to add
the Project Link.

v. Once the project link is established, an upgrade to the current

version will occur (even though it is already at the current version).

vi.

3 Run the projects to test the new configuration.

 Note:
If the project was compiled before the project link was established, the remote
computers may under certain circumstances not believe the project is compiled and
will not run the Setup Wizard until a recompile is completed. This recompile may
be initiated from any attached computer (either the 'file server' or any remote client)
and need only be done once.

Vijeo Citect Architecture and Manual Release 1 2-45

Redundancy
 Exercise - Additional File Server Concepts

1 Change the IP address for the Alarm Server.

i. The student sitting at the designated File Server should change the
IP Address of the Alarm Server.

ii. After completing the IP address, click Replace to save the changes.

2 Update and run the project.

i. Group discussion: which computers need to run the Computer Setup
Wizard?

After the class agrees on an answer, configure the computers in

accordance with the decision and test the solution.
ii. Update as necessary until a working system is re-established.

2-46 Version 7.20 October 2010

 The Copy Parameter

Keep Systems Up When trying to keep a Vijeo Citect system up to date with the most recent project
to Date changes, the Copy parameter may be used. It is located under the [CTEDIT] section
in the citect.ini file; it is called COPY = (as opposed to say, RUN =).

When Vijeo Citect starts, it looks in the RUN = path for the necessary project files.
It then compares the first file it needs with the same file on the COPY = path.

If the file held in COPY = is different from the one in the RUN = directory, Vijeo
Citect copies the file from COPY = to RUN = and then loads it. It then does the
same operation with every file it needs, as it needs them.

Pages may not be updated for some considerable period of time simply because
they may be rarely visited. This means that Vijeo Citect can automatically update a
local copy of the running project on the fly from a central master copy.

The RUN = parameter can be pointed at an empty directory and it will work, as long
as COPY= links to a valid project. Since Vijeo Citect only copies those files it
needs for running, the bare minimum are used so copying and running across the
intranet is more of a possibility. This is perfect for maintaining a distributed project
arrangement yet still reap the benefits of a centralised file store on a server.

Vijeo Citect Architecture and Manual Release 1 2-47

Redundancy
 The Copy Parameter (cont.)

Rules to Follow There are some specific rules to follow in order that all members of the multi-
computer group can agree on the state of the project. In particular, it is wise to
make certain that a final compile of the project be performed after all clients have
connected to the COPY location - this will ensure that all computers agree that the
project is compiled, permitting the Setup Wizard to be run locally on each machine.

 Note:
After setting the Copy parameter, do not use the Citect Explorer. If the Run path
only contains the runtime files, not the entire project, the Citect Explorer will not
recognise it as a valid project.

Henceforth in this training manual, the computer which contains the master copy of
the project files will be referred to as the Copy Host, while the clients of this host
will be referred to as Copy Consumers.

2-48 Version 7.20 October 2010

 Exercise - The Copy Parameter

Use the Copy parameter to automatically propagate project changes to Clients.

1 Change the citect.ini files of the Clients to use the local project as
the RUN directory and the file server as the COPY host.
i. Remove the project link to the File Server from the previous exercise
and on the Clients re-establish the link to the local copy of the Pulp
or Paper project.
ii. Backup the local projects as this exercise will overwrite the original
projects.
iii. Open the Computer Setup Editor and add the Copy = parameter to
the [CTEDIT] section. Select the CtEdit branch in the expandable
tree.

Vijeo Citect Architecture and Manual Release 1 2-49

Redundancy
 Exercise - The Copy Parameter (cont.)

iv. Select the Copy parameter and add the UNC name in the Value:
field that is appropriate for the local configuration.

v. The new parameter will be displayed in the tree. Close the Computer
Setup Editor and Save the changes when prompted.

2 Start the entire network.

i. Restore the previously backed up projects PulpNetwork and
PaperNetwork that were saved in Exercise - Configure Servers
for Networking (page 2-14).
ii. Configure and run either Pulp or Paper.
iii. Make a change on the graphics page (either Woodchip or Recipe) in
the project on the File Servers.
iv. Save the page and compile the project.
v. Any pages on the File Server that have been changed will be copied
across to the local projects on the client computers when the page is
loaded. Open the home page (by pressing the Home key on the
keyboard) then return to the main graphics page; the changed page
will appear at the client computer.

 Note:
In order to observe the effects of the COPY parameter, it is essential that the Copy
Consumer computers be running the project prior to the change being made on the
Copy Host. Once done, the consumers may navigate away from the affected page
and return to it to see the changes automatically propagated.

2-50 Version 7.20 October 2010

 Exercise - The Copy Parameter (cont.)

3 Test local changes.

i. Make a change to the graphics page of the Copy Consumer
computers. Perhaps add a text object to either the Woodchip or
Recipe page.

ii. Save, compile and run the project.

4 Discuss what ought to happen with the class

i. Before opening the modified page, discuss with the class what will
happen.
ii. Open the modified page and confirm that it behaves as expected.

5 Shutdown the project.

Vijeo Citect Architecture and Manual Release 1 2-51

Redundancy
 Shared Citect.ini File Settings

System-wide All runtime parameters in the citect.ini file are available for configuration from
Parameters within the project.

At startup, any entries in the Parameters table are interpreted as if they came from
the citect.ini file and are used for the running project.

The Parameters table will automatically be distributed to any Vijeo Citect Copy
Consumer to distribute project changes.

 Note:
The Parameters entries are not written to the citect.ini file, instead, they are
interpreted as if they were sourced from there. If the same parameter exists in
citect.ini and the Parameters list, citect.ini takes precedence.

2-52 Version 7.20 October 2010

 Shared Citect.ini File Settings

How to  To display the Parameters dialog:

Configure
Parameter Open the Project Editor and select the menu System » Parameters.
Settings
Every section of the citect.ini file is available in the first dropdown list:

Once a Section Name is selected, most of the parameters of that section are
available from the Name dropdown list. If the desired parameter is not available, it
may be entered manually.

Vijeo Citect Architecture and Manual Release 1 2-53

Redundancy
 Exercise - Distribute Shared Citect.ini Settings

1 Ensure client computers are configured correctly.

i. On all computers in both the Pulp and Paper networks that act as a
Copy Consumer, open the Computer Setup Editor and ensure there is
no entry for [Page]Startup.

It is likely that there is no [Page] section present at all; however if it

exists for other parameters please leave them unchanged.

2-54 Version 7.20 October 2010

 Exercise - Distribute Shared Citect.ini Settings
(cont.)

2 Configure the project startup page.

Make the following changes on the computers which act as the Pulp
and Paper Copy Hosts:
i. In the Project Editor, select the menu System » Parameters.
ii. Scroll down to find the Page, Startup entry.

iii. Observe that the Startup page is currently set to be PulpHome (or
PaperHome) - this is how the projects locate and display the normal
front page with the factory or paper rolls image.
iv. Change the entry to be Woodchip (or Recipe) and click the Replace
button.
v. Compile the projects.

 Note:
To populate an entry for a previously unused parameter, the Section and Name
must be selected from the drop down lists.

3 Shutdown and restart the Copy Consumer projects.

i. Observe that the Woodchip (or Recipe) page is displayed in place of
the normal startup page (with the image of either the pulp mill or
paper rolls) when the Client projects start.

4 Modify the startup page.

i. Return to the Copy Host computers and change the Startup page to
be either PulpHome (or PaperHome).
ii. Be sure to click Replace.
iii. Compile the projects.

5 Restart the Copy Consumers again.

i. After a restart, the clients will load the normal startup page
automatically.


Vijeo Citect Architecture and Manual Release 1 2-55
Redundancy
 Summary

Summary The following topics have now been addressed:

 Servers and Clients (page 2-2)

 Clustering (page 2-5)
 Network Addresses in Vijeo Citect (page 2-11)
 Configure Servers for Networking (page 2-13)
 Time Synchronisation (page 2-19)
 Servers and Control Clients (page 2-28)
 Distributed Processing (page 2-35)
 Runtime System Management (page 2-38)
 Manage Vijeo Citect Files (page 2-39)
 The Copy Parameter (page 2-47)
 Shared Citect.ini File Settings (page 2-52)

Questions The following questions are to check understanding:

 What is a Cluster?
 When a new project is created what Cluster elements need to be defined?
 How many Trend Servers can exist on the same computer?
 Is it possible to have a Primary Alarm Server and a Standby Alarm Server on
the same computer if they belong to different clusters?
 What is the purpose of Remove Project Link?
 What is the purpose 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 the whole system?

2-56 Version 7.20 October 2010

 Chapter 3: 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.

This Chapter Covers These Topics:

 Online Changes......................................................................3-2
 Online Changes

Clients Update Vijeo Citect Clients from Version 7.0 onwards don't require configuration updates
without being or restarts when changes are made on the Server. When any Alarm, Trend or
Reinitialised Variable Tag is added, removed or updated on the Server side, Clients will not
require updates or restarts for them to adjust to the new configuration. Only the
Server needs to be restarted or (effective from V7.20) reloaded.

 When a Trend, Alarm or I/O Server is restarted with an updated configuration,

Clients currently running will adjust automatically to the changes without
requiring restart.
 Rather than browsing the local trend database to provide a list of trends, a
Trend Client will now ask the Trend Server for a list of trends.
 The Alarm Client has been changed to recognise when the Server connection
has been changed or restored, check whether the alarm configuration is still the
same, and flush its local cache if needed to ensure any data is correct.
 Reloading a Server will not interrupt the execution of the Clients; they will
continue processing the existing Alarms or Trends until the reload is completed,
when the new items will become available.

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.

3-2 Version 7.20 October 2010

 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.

Vijeo Citect Architecture and Manual Release 1 3-3

Redundancy
 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.

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.

3-4 Version 7.20 October 2010

 On-line Changes (cont.)

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.

Vijeo Citect Architecture and Manual Release 1 3-5

Redundancy
 Exercise - Online Changes: Tags and Pages

1 Recreate a single server configuration with the rest of the

computers in each group as Control Clients.
i. In the previous exercise the Control Clients were configured so that
the COPY parameter pointed to either the Pulp project of one
computer or the Paper project of another computer. Configure each
project such that this computer (the COPY Host) runs the I/O and
Alarm Servers and another computer runs the Trends and Reports
Servers; connect all other computers in each group as Control
Clients.
ii. Run the Computer Setup Wizard on all computers.
iii. Start all of the computers.

2 Create a new Variable Tag on each of the Servers.

i. Open the Citect Project Editor on the computers designated as the
Copy Host and select Tags » Variable Tags.
ii. Create a new Variable Tag in the Pulp project using the settings
shown below and click Add.

Create a new Variable Tag in the Paper project using the settings
shown below and click Add.

3-6 Version 7.20 October 2010

 Exercise - Online Changes: Tags and Pages
(cont.)

3 Add a Genie to the Woodchip page.

i. Open the Citect Graphics Builder on the Pulp Server 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.

4 Add a Genie to the Recipe page.

i. Open the Citect Graphics Builder on the Paper Server then open the
Recipe page.
ii. Copy the existing Blue_Dye 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.

Vijeo Citect Architecture and Manual Release 1 3-7

Redundancy
 Exercise - Online Changes: Tags and Pages
(cont.)

5 Recompile and access the modified project.

i. Compile the project on the Copy Host computers only.
ii. In order for this new tag to become available to a Control 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_Cluster_1.PulpPrimary. Select the Restart option.

The I/O Server will execute a shutdown and restart. Note that the
Control Clients detect a brief loss of I/O Server connectivity then
reconnect.
iii. At the Control Clients, reopen the Woodchip page and manipulate
the newly created Chipper Motor tag.
iv. Repeat the process on the Paper Server. Click the Runtime
Manager in the System Tray and right click the I/O Server entry
Paper_Cluster_1.PaperPrimary. Select the Restart option.

3-8 Version 7.20 October 2010

 Exercise - Online Changes: Alarms

1 Create a new Advanced Alarm on each Server.

i. Select Alarms » Advanced Alarms.
ii. Create a new Advanced Alarm on the Pulp Server using the settings
shown below and click Add.

Create a new Advanced Alarm on the Paper Server using the

settings shown below and click Add.

Vijeo Citect Architecture and Manual Release 1 3-9

Redundancy
 Exercise - Online Changes: Alarms (cont.)

iii. Recompile the projects and Restart the Alarm Server processes.

iv. While the Alarm server is restarting, observe that the Alarm display
at the bottom of the graphics page on every client goes blank
momentarily.

2 Perform a Reload of the Alarm Server.

i. Return to the Runtime Manager and right click the Alarm Server.

ii.
iii. Select Reload from the right click menu. The Alarm Server will
perform a full refresh of its list of Alarms, but will not cease
processing alarms at any time; thus maintaining a supply of Alarm
information to all clients without stopping.
iv. Observe that in either case (Restart or Reload) the new Alarms will
be available as soon as the Alarm Server returns to full functionality.

3-10 Version 7.20 October 2010

 Exercise - Online Changes: Trends

The current Server arrangement includes two computers acting as Servers. One
(the Copy Host) is acting as the I/O and Alarm Servers, while the other is running
as the Report and Trend Servers. Thus, when adding Trend Tags, consideration
must be given to exactly how the tag should be added.

1 Class discussion
i. When adding a new Trend Tag to a multi-computer project, on which
computer should the tag be added.
ii. Discuss the options and agree on an answer.

2 Add a Trend tag to each of the locations (in Pulp or Paper)

selected in the discussion.
i. Select Tags » Trend Tags.
ii. Create a new Trend Tag in the Pulp project using the settings shown
below and click Add.

Create a new Trend Tag in the Paper project using the settings
shown below and click Add.

Vijeo Citect Architecture and Manual Release 1 3-11

Redundancy
 Exercise - Online Changes: Trends (cont.)

iii. Recompile the projects and Reload the Trend Server processes.

iv. Open the Popup Process Analyst Sample page on the Trends Tab of
any Control Client.
v. This will fail:

vi. On the Copy Host, create a new graphics page based on the
tab_style_1.poppa template.
vii. Save the page as !ProcessAnalystPopup - this is the default name
for a Process Analyst popup page in a project with no customised
menu system.
viii. Recompile the project.
ix. At the Control Client, again attempt to open the Process Analyst
popup page - it will now succeed.

3-12 Version 7.20 October 2010

 Exercise - Online Changes: Trends (cont.)

x. On the Process Analyst page, click on the Add Pen Button.

xi. Click the Search button to scan the Trend Server for available Trend
tags.

xii. Observe that without a restart at the client, the new Trend Tag
(CM_P) is now available. If it is not, reconsider the results of the
discussion earlier in this exercise and modify the project to match.
xiii. Add the new pen and confirm that it appears in the Process Analyst
display.

Vijeo Citect Architecture and Manual Release 1 3-13

Redundancy
 On-line Changes (cont.)

Remote Restart In a multi-server environment, there may be a requirement to force a server to

and Reload Restart or Reload without physically attending the computer (perhaps from a
management workstation in the project development office).

There are two Citect.ini parameters that control the ability to remotely act on a
server:

 Server Restart
On all computers that will issue a Server Restart request, the
following parameter must be set:

[Shutdown]NetworkStart=1

 Server Reload
On all servers that will receive a Server Reload request, the
following parameter must be set:

[LAN]AllowRemoteReload=1

3-14 Version 7.20 October 2010

 Exercise - Create a Server Administration Page

1 Embed Server reload into the running project.

i. For both the Pulp and Paper projects, and only on the COPY host
computer, add a set of buttons on a new Control page to reload any
of the Alarm, Report, Trend or I/O Servers.
ii. Configure each button on the page as follows (similarly for the Paper
project):

Server Input (Up) Command

I/O Server ServerReload("PulpPrimary")

Alarm Server ServerReload("Pulp_Alarm_P")

Report Server ServerReload("Pulp_Report_P")

Trend Server ServerReload("Pulp_Trend_P")

Vijeo Citect Architecture and Manual Release 1 3-15

Redundancy
 Exercise - Create a Server Administration Page
(cont.)

iii. Add a second set of four buttons to the Control page to execute the
ServerRestart() command.

Server Input (Up) Command

I/O Server ServerRestart("PulpPrimary")

Alarm Server ServerRestart("Pulp_Alarm_P")

Report Server ServerRestart("Pulp_Report_P")

Trend Server ServerRestart("Pulp_Trend_P")

2 Test the buttons.

i. Compile and run the project.
ii. Attempt to restart or reload servers.
iii. Observe that only servers on the same computer as the buttons are
clicked may be Reloaded or Restarted.

3 Permit remote Reload.

i. Add the citect.ini parameter [LAN]AllowRemoteReload=1 to each of
the computers that are hosting the server components of the system.
Without this parameter set, servers will ignore any remote Reload
requests.
ii. Close the Setup Editor and save when requested.
iii. Compile and run the project.
iv. Confirm that remote servers may now be Reloaded.

v. Observe the limits of this functionality: The IOServer cannot be

reloaded.

3-16 Version 7.20 October 2010

 Exercise - Create a Server Administration Page
(cont.)

4 Enable remote Restart.

i. On all computers that will issue a Restart request, add the following
parameter to the citect.ini file:

ii. Close the Setup Editor and save when requested.

iii. Shutdown and restart all projects to make use of the modified
citect.ini file parameter.

5 Experiment with other options

i. With due consideration of the Vijeo Citect Help topic Effects of Server
Reload on Servers, plan experiments in conjunction with the
Instructor and other students to test the limits of on-line changes.

This might include changes to Cicode functions as well as exploring

those situations where online changes might fail.

6 Open the Computer Setup Editor on the Clients and remove the
Copy parameter from the citect.ini file.
i. Right click the Copy parameter and select Delete Parameter from the
menu. Close the Editor and save when prompted.

Vijeo Citect Architecture and Manual Release 1 3-17

Redundancy
 Summary

Summary The following topics have now been addressed:

 Online Changes (page 3-2)

Questions The following questions are to check understanding:

 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?

3-18 Version 7.20 October 2010

 Chapter 4: Clustered Control System

Overview
Introduction
Clustering allows a Client to attach to more than one set of I/O, Alarms, Trends and
Reports Servers. In previous versions, a Client could only attach to one set of
Report, Alarm, and Trend Servers at a time. Now, large systems may comprise
multiple sets of Servers and Clients may connect to some or all Servers
simultaneously.

This Chapter Covers These Topics:

 Global Clients ........................................................................4-2

 Multi-Project Backup and Restore.......................................4-15
 Global Clients

Combine A clustered system allows discrete sites being controlled by local operators to be
Discrete Sites viewed by a global Control Client. A typical cluster consists of a Primary and
Standby Server providing Alarm, Trend, Report and I/O Servers support. The
cluster may also have local Vijeo Citect Clients and several other I/O Servers. A
Citect Cluster is typically a plant or in the case of very large or distributed plants, a
Cluster may be a section of a plant.

Each site is represented in the project with a separate Cluster, grouping its Primary
and Standby Servers. Clients at each site are only interested in the local Cluster,
whereas Clients at the central control room are able to view all Clusters.

The deployment of a control room scenario is fairly straightforward, as each site

can be addressed independently within its own Cluster. The control room itself only
needs Control Clients.

4-2 Version 7.20 October 2010

 Exercise - Configure and Run Standalone
Servers

1 Identify two computers in the room to act as the reference Pulp

and Paper servers.

By preference, these should be computers at which there are no

students as these machines will play very little part in the remainder
of this chapter. If the class is full, then these will have to be student
computers.

2 Restore and configure the Global projects.

i. On each of the two global Server computers, restore either the
PulpNetwork or PaperNetwork project. These were backed up in
step 7 of Exercise - Configure Servers for Networking (page 2-
14).
ii. In the Project Editor, select Servers » Network Addresses. Ensure
that the IP address is set to be that of the computer upon which the
project is running.

iii. Compile the projects and on each server run the Computer Setup
Wizard in Express mode to confirm the correct project is in Multi-
process, Networked mode.
iv. Run the project on each Global Server.

Vijeo Citect Architecture and Manual Release 1 4-3

Redundancy
 Exercise - Create a Global Project

In order to attach to multiple Citect Clusters, a Global Client needs to be

configured.

1 Create a Global project that includes the two existing projects

PulpNetwork and PaperNetwork.
i. On all Client computers, restore the PulpNetwork and PaperNetwork
projects. These were backed up in step 7 of Exercise - Configure
Servers for Networking (page 2-14).
ii. In the Project Editor, select Servers » Network Addresses. Ensure
that the IP address is set to be that of the computer upon which the
project is running, as configured in the previous exercise.

iii. In Citect Explorer, create a new project called Global.

iv. In the Citect Project Editor select System » Included Projects from
the menu.
v. Include the two projects, PulpNetwork and PaperNetwork.

 Note:
The names PulpNetwork and PaperNetwork should correspond to the project
names of the clusters that are being configured. If they are different then change
the names accordingly.

4-4 Version 7.20 October 2010

 Exercise - Create a Global Project (cont.)

2 Add a Process Analyst page.

i. Create a Page in the Global project called PA, based on the singlepa
template.
ii. Create a Keyboard Command for the <CTRL>-P key to open the PA
page.
iii. Compile the Global project. Click OK when the Compile Error
message appears.

There should be eight errors reported by the compiler.

3 Repair the errors.

i. On the following page, a work sheet lays out each of the eight errors
and describes what has caused them. Students should discuss in
class what each error means and agree on a suitable resolution.
While considering various possible solutions, the following points
should be kept in mind:

 Separate business units within the organisation are responsible for each
of Pulp and Paper and should be consulted prior to making changes to
their projects.
 Proper change-management processes should be invoked for all
proposed changes.
 Potential solutions may change as much or as little of the existing
projects as can be reasonably justified.
 The Instructor will act as a management representative for both
company divisions and will answer any questions that arise.
 There is no correct answer although a model solution will be provided
once the exercise is completed in order to move the course forward on
common ground.

Vijeo Citect Architecture and Manual Release 1 4-5

Redundancy
 Exercise - Create a Global Project (cont.)

Global Project compile error worksheet.

Error Message Interpretation Resolution

A duplicate menu Both projects contain a
entry already exists top-level menu item called
[‘Home’] 'Home'

Tag already defined Both projects contain a

[StartUp() Cicode cicode function called
Function] 'StartUp'

Tag already defined The role 'Designer' exists

['Designer' role] in both projects

Tag already defined Both projects contain a

[BDL_P trend tag] trend tag called BDL_P

Tag already defined Both projects contain an

[page 'Alarm'] active alarm page called
'Alarm.' Note that this is
the default name for the
page.

Tag already defined Both projects contain an

[page 'Disabled'] active alarm page called
'Disabled.' Note that this
is the default name for the
page.

Tag already defined Both projects contain an

[page 'Hardware'] active alarm page called
'Hardware.' Note that this
is the default name for the
page.

Tag already defined Both projects contain an

[page 'Summary'] active alarm page called
'Summary.' Note that this
is the default name for the
page.

Tag already defined Both projects contain the

[page ' !Process same Process Analyst
AnalystPopup '] Popup page.

4-6 Version 7.20 October 2010

 Exercise - Create a Global Project (cont.)

4 Implement the planned solution.

i. Apply all changes to all computers as agreed by the class. In order
to ensure consistency across all projects, any changes to either Pulp
or Paper should be implemented on the two Servers configured in the
previous exercise.
ii. Compile the Global project on all Clients and confirm it is now error-
free.

5 Run the Computer Setup Wizard on the Control Clients.

i. Run the Computer Setup Wizard in Custom mode.
ii. Step through until the Cluster Connections Setup page is reached.

iii. Click the Modify button.

Vijeo Citect Architecture and Manual Release 1 4-7

Redundancy
 Exercise - Create a Global Project (cont.)

iv. Add a tick in the box beside whichever cluster is not ticked (probably
Paper).
v. Click the OK button to save the changes.

vi. Continue to the end of the Setup Wizard.

6 Test the Global project.

i. Start the Servers.
ii. Start the Control Clients.
iii. Check that the Reports, Alarms and Trends from both projects are
visible. Press <CTRL>-P (or whatever keystroke was configured in
step 2 above) to open the newly created PA page.

4-8 Version 7.20 October 2010

 Exercise - Create a Global Project (cont.)

iv. Click the Add Pens button and confirm that Trends from both
clusters are visible.

v. Add a pen from each cluster and confirm they are displaying correctly
and responding to changes made on the Woodchip and Recipe
pages on the Stand-alone Servers configured earlier.

Vijeo Citect Architecture and Manual Release 1 4-9

Redundancy
 Exercise - Create a Global Project (cont.)

vi. At this point, Clients are unable to change the tag values in either
sub-project and in fact all variables are replaced with #COM markers.
This will be addressed in the next exercise.

vii. Shutdown the projects.

 Note:
The model solution will be made available as part of an upcoming activity -
Exercise - Complex Project Backup and Restore (page 4-16).

4-10 Version 7.20 October 2010

 Exercise - Resolve Tag References on Pages

In the previous exercise, it was discovered that Alarms and Trends were visible
across Clusters (there was no simple means to test Reports, but they would have
worked as well). However there were no valid tag values shown on the graphics
pages - they were replaced with #COM. This issue will now be remedied.

1 Edit the properties of the Woodchip and Recipe pages.

i. In Graphics Builder, open the Woodchip page.
ii. Select the menu File » Properties.

iii. On the General tab, select the Cluster Pulp_Cluster_1 from the
dropdown menu.

Vijeo Citect Architecture and Manual Release 1 4-11

Redundancy
 Exercise - Resolve Tag References on Pages
(cont.)

iv. Click OK to accept the changes.

v. Save the Woodchip page.
vi. Open the Recipe page and assign it to the Cluster Paper_Cluster_1.
vii. Save the Recipe page.

2 Test the changes.

i. Compile the project.
ii. Open the Woodchip page. Note that tag values are now correctly
displayed.

iii. Similarly open the Recipe page and confirm that that page is also
now correct.
iv. Shutdown the project.

4-12 Version 7.20 October 2010

 Exercise - Resolve Tag References on Pages
(cont.)

3 Create a combined-source page.

i. In Graphics Builder, create a new page called Main and save it in the
Global project.
ii. Add a simple heading, a numeric tag from each project (perhaps
Chip_Pile_Level and Blue_Dye) and a suitable label for each tag.
iii. Save the page.
iv. Add a menu item to display the new page.
v. Compile and run the project.

vi. What is wrong with the page?

vii. Discuss with the class the best method to fix the problem.

Vijeo Citect Architecture and Manual Release 1 4-13

Redundancy
 Exercise - Resolve Tag References on Pages
(cont.)

4 Update the Main page.

i. Prefix the two tag references on the numeric objects with a cluster
identification.
ii. These should now read Pulp_Cluster_1.Chip_Pile_Level and
Paper_Cluster_1.Blue_Dye.

iii. Compile and run the project.

iv. Confirm that the two tag values are correctly displayed.
v. Shut down the project.

4-14 Version 7.20 October 2010

 Multi-Project Backup and Restore

Environment Environment Manager is an external suite of utilities to support the smooth

Manager operation of a Vijeo Citect facility.

The package contains a launch manager to load the development environment along
with a method to manage multiple versions of Vijeo Citect on a single computer.

In those situations where a project is composed of multiple include projects, as has

just been done in the previous exercises, it is important to be able to create a backup
of the entire suite of projects as a single entity. Environment Manager performs
that task.

Vijeo Citect Architecture and Manual Release 1 4-15

Redundancy
 Exercise - Complex Project Backup and Restore

1 Open the Environment Manager.

i. From the Windows Start menu, select Programs » Schneider
Electric » Environment manager.

2 back up the existing Global project suite.

i. Right click the Global project entry. Select Multi-project backup.

4-16 Version 7.20 October 2010

 Exercise - Complex Project Backup and Restore
(cont.)

ii. Click Browse to select a backup location.

iii. Click Make New Folder to create a Desktop folder to store the
backup (this is simply to make the NEW folder easy to find).

iv. Name the folder GlobalProject.

Vijeo Citect Architecture and Manual Release 1 4-17

Redundancy
 Exercise - Complex Project Backup and Restore
(cont.)

v. Click Backup to commence.

vi. Once complete, the system offers to display the backed up projects
in their destination folder.

vii. Optionally, select Yes to view the files or No to close the backup
screen.

4-18 Version 7.20 October 2010

 Exercise - Complex Project Backup and Restore
(cont.)

3 Restore the model solution.

Previously, in Exercise - Create a Global Project (page 4-4)

specific mention was made of a model solution. This will now be
restored.
i. From the main Environment Manager window, right click the Vijeo
Citect 7.20 entry and select Multi-project restore.

Vijeo Citect Architecture and Manual Release 1 4-19

Redundancy
 Exercise - Complex Project Backup and Restore
(cont.)

ii. The Instructor will advise the location and names of the projects to
be restored. the following sequence demonstrates a restore using
the same group of projects as were backed up in the previous steps.

iii. Click the Browse button and navigate to the location provided by the
Instructor.
iv. Click the first item in the list and <Shift> Click the last item.

4-20 Version 7.20 October 2010

 Exercise - Complex Project Backup and Restore
(cont.)

v. Click Open to continue.

vi. Click Restore to commence the project restore.

vii. Click OK to complete the restore.

viii. Close the Environment Manager.

Vijeo Citect Architecture and Manual Release 1 4-21

Redundancy
 Exercise - Examine the Model Global Project
Solution

1 Open the restored projects.

i. Return to Citect Explorer.
ii. Note that the newly restored projects are now included in the project
list on the left side.

2 Examine the features.

i. In conjunction with the Instructor, and being mindful of the
implementation previously developed by the class, examine the
various methods by which the model solution deals with the issues of
merging the Pulp and Paper projects.

3 Shut down Vijeo Citect.

4-22 Version 7.20 October 2010

 Summary

Summary The following topics have now been addressed:

 Global Clients (page 4-2)

Questions The following questions are to check understanding:

 What does the Clustered Control System feature enable?

 What is the collective name for Alarms, Trends and Reports Services?
 Why set up a Global Client?

Vijeo Citect Architecture and Manual Release 1 4-23

Redundancy
 End Day One - Summary

Summary At the end of Day One, students should:

 Understand the Citect Architecture

- Citect Servers, I/O Servers and Clients
- Networking and Clusters
- Time Synchronisation
- Run-time system management
 Be able to manage On-line Changes:
- Client-side changes
- Server-side changes
 Be able to manage multiple clusters in a single environment:
- Global clients
- Multi-cluster control clients

4-24 Version 7.20 October 2010

 Chapter 5: Vijeo Citect Redundancy

Overview
Introduction
Many industrial plants cannot afford to have their Vijeo Citect monitoring system
fail at any time. Building redundancy into the system can prevent the loss of
control and monitoring of the Vijeo Citect system. In this Chapter the various
types of redundancy will be discussed.

This chapter is a workshop. Use the time in the classroom to test as many different
variations of redundancy configurations as time allows.

See Also:
For further information about Redundancy see Vijeo Citect Help - Building
Redundancy into Your System.

This Chapter Covers These Topics:

 File Server Redundancy.........................................................5-2

 Data Path Redundancy...........................................................5-4
 Network Redundancy ............................................................5-6
 Alarm, Report and Trend Server Redundancy.......................5-7
 I/O Server Redundancy........................................................5-14
 Multiple Standby Devices....................................................5-21
 I/O Device Promotion..........................................................5-23
 Disk PLC Redundancy.........................................................5-26
 File Server Redundancy

Primary and When using a common project residing on a File Server, File Server Redundancy
Standby Servers can be built into the system. A redundant server ensures that if the main server fails
the system can continue without interruption.

 Note:
File Server redundancy cannot be used in conjunction with the COPY parameter.

See Also:
For further information about File Server Redundancy, see Vijeo Citect Help -
File Server Redundancy.

5-2 Version 7.20 October 2010

 Exercise - File Server Redundancy

1 Set up File Server Redundancy.

i. Link the Clients to the shared project on a selected File Server
computer using the same technique covered in Exercise - Manage
Vijeo Citect Files (page 2-41). It is sufficient for all students to use
the Pulp project.
ii. Choose another computer to be the Backup File Server and share the
project directory.
iii. On the client computers open the Computer Setup Editor and add
this parameter:

[CTEDIT]

Backup = \\BackupServer\User\Projectshare

Use appropriate computer and share names for the Backup File
Server.

2 Connect the clients to the File Servers.

i. Start the runtime on the Client computers.
ii. When they are running and displaying the project files, remove the
LAN cable from the Primary File Server. The Clients should be able to
connect to the files on the Backup File Server.

 Note:
Always ensure that the project in the Backup path is the same as the one in the Run
directory - each time the project in the run directory is compiled, it should be
copied into the backup directory.

Vijeo Citect Architecture and Manual Release 1 5-3

Redundancy
 Data Path Redundancy

Parallel I/O Data path redundancy is another form of redundancy involving defining data paths
Device Data Path between the I/O Server and the connected I/O Devices. A second (parallel) data
path, ensures that if one data path to the I/O Device fails, the other can be used.

Most brands of PLCs have the facility to allow a parallel data path from the I/O
Server to the I/O Device to be installed typically via Ethernet.

The diagram above shows that an additional data path (running in parallel) has been
defined. The redundancy is provided as follows:

 When the runtime system is started, Vijeo Citect connects to the I/O Device
using the primary data path.
 Should communications with the I/O Device fail at any time, e.g. if the
communications cable is cut, Vijeo Citect will switch to the standby data
path without any interruption to the system.
 Vijeo Citect reconnects through the primary data path when it is returned in to
service.

5-4 Version 7.20 October 2010

 Data Path Redundancy (cont.)

Large Scale On a larger Vijeo Citect system (such as one running on a network), data path
Systems redundancy can be used to maintain device communications with multiple I/O
Server redundancy, as shown in the following diagram.

The redundancy is provided as follows:

 By using a redundant data path from the I/O Device (one path to each I/O
Server), I/O Device communication can be maintained.
 Should communications with either the Primary I/O Server or Standby I/O
Server fail, the I/O Device is still accessible.

Vijeo Citect Architecture and Manual Release 1 5-5

Redundancy
 Network Redundancy

Parallel Network A second Local Area Network (LAN) would ensure system stability even in the
event of network failure. The dual end point (or multiple network interfaces)
capabilities of each component can be utilised, effectively enabling a complete and
unique network connection from a client to a server to be specified.

See Also:
For further information about Network Redundancy, see Vijeo Citect Help -
Network Redundancy.

Network redundancy is configured by defining a Network Address for each of the

Network Interface cards (NICs) installed in the Server and specifying both Network
Address entries in the Server definition dialog box separated by commas.

5-6 Version 7.20 October 2010

 Alarm, Report and Trend Server Redundancy

Primary and Redundant Alarm, Report, and Trend Servers can be configured. This can be
Standby Servers achieved by allocating the Primary and Standby Servers to different physical
machines.

How Report, When a system has been configured to use redundant Report, Alarm and Trend
Alarm and Trend Servers, the Vijeo Citect system maintains the same data on both Servers.
Redundancy
Works

Vijeo Citect Architecture and Manual Release 1 5-7

Redundancy
 Alarm, Report and Trend Server Redundancy
(cont.)

How Report, If any of the Primary Servers become inoperative or communications become
Alarm and Trend inoperative, their Standby counterpart immediately assumes operation.
Redundancy
Works (cont.)

When the Primary Server comes back online the Clients remain connected to the
Standby Server until the Standby Server goes offline or the Client is restarted. This
is why it is quite normal for some Clients to be connected to the Primary and others
to the Standby.

5-8 Version 7.20 October 2010

 Exercise - Alarm, Report and Trend Server
Redundancy

Create individual Network Address for all of the Server roles.

1 Create Network addresses for the Standby Alarm, Report and

Trend Servers in the projects.
All students are to complete this exercise.
i. Restore the projects backed up in Exercise - Configure Servers for
Networking (page 2-14) with the names PulpRedund and
PaperRedund.
ii. Link the Client computers back to their local projects and return the
class to their separate groups Pulp and Paper.
iii. Open the Citect Project Editor and select Servers » Network
Addresses.
iv. Create new Network Addresses for the Standby Servers. Separate
the Primary I/O Server computer from the Primary Alarm, Report and
Trend computer. Use the example IP addresses below as a guide.

Pulp Pulp Addresses Paper Paper Addresses

Pulp_IO_P 10.176.235.101 Paper_IO_P 10.176.235.105
Pulp_Alarm_P 10.176.235.102 Paper_Alarm_P 10.176.235.106
Pulp_Report_P 10.176.235.102 Paper_Report_P 10.176.235.106
Pulp_Trend_P 10.176.235.102 Paper_Trend_P 10.176.235.106
Pulp_Alarm_S 10.176.235.103 Paper_Alarm_S 10.176.235.107
Pulp_Report_S 10.176.235.103 Paper_Report_S 10.176.235.107
Pulp_Trend_S 10.176.235.103 Paper_Trend_S 10.176.235.107

2 Create standby Alarm, Report and Trend Servers.

i. Open the Citect Project Editor and select Servers » Alarm Servers.
ii. Add another server called Pulp_Alarm_S. Use the Network Address
of Pulp_Alarm_S and change the Mode to Standby.

iii. Create Standby instances of Report and Trend Servers.

iv. Pack and Compile the project.

Vijeo Citect Architecture and Manual Release 1 5-9

Redundancy
 Exercise - Alarm, Report and Trend Server
Redundancy (cont.)

3 Repeat for the Paper project.

4 Run the projects.

i. Run the Computer Setup Wizard.
ii. Add the entry [Debug]Menu=1 to the citect.ini file. This will permit
access to the kernel later in the exercise.

 Note:
If the Computer Setup Wizard does not offer a Server option for any of the
computers for which a Server has been defined, ensure any COPY parameter values
are deleted from the citect.ini file, then pack the databases and force a re-compile.

iii. Run the project on all computers.

iv. From the Runtime Manager screen, open the kernel screen for the
Client process.

5-10 Version 7.20 October 2010

 Exercise - Alarm, Report and Trend Server
Redundancy (cont.)

v. At the main kernel screen, type the command:

page table tran

to open the list of connections. This will appear slightly differently

depending on whether the computer is also some kind of Server in
addition to the Client process.

Server view:

Client view:

Further Training:
Kernel usage is a topic covered extensively in the Vijeo Citect Diagnostics and
Troubleshooting Course.

Vijeo Citect Architecture and Manual Release 1 5-11

Redundancy
 Exercise - Alarm, Report and Trend Server
Redundancy (cont.)

5 Test Alarm Server redundancy.

i. Test the redundancy by stopping the Alarm Server process on the
Primary Server's Runtime Manager screen.

ii. Observe on the kernel screen that the reference to the Primary Alarm
Server is marked off-line for the Server and Client computers.

5-12 Version 7.20 October 2010

 Exercise - Alarm, Report and Trend Server
Redundancy (cont.)

iii. Restart the Primary Alarm Server and note the re-appearance of the
Primary Alarm Server on the kernel screens.
iv. Observe also that at no time was there a loss of alarm functionality.
v. Test this by stopping the Alarm Server on BOTH the Primary and
Standby Servers. The three-line alarm panel at the bottom of all
Client screens will be blanked.
vi. Restart the Alarm services.
vii. Close all kernel screens.

6 Test Trend Server redundancy.

i. Open a Process Analyst page on all computers and trend a few tags.
ii. Stop the Trend Server process on the Primary Server.
iii. Observe that the trend lines continue uninterrupted (even on the
Client attached to the Primary Server).
iv. Restart the Trend Server and notice that the display remains
uninterrupted.
v. Shutdown the project on all computers.

7 Alarm, Report and Trend Server redundancy workshop.

i. Allocate Primary and Standby Server roles of each of the Alarm,
Report and Trend Servers to different computers (hint: modify the
Network Address entries then compile and run the Computer Setup
Wizard).
ii. Test the new configuration.
iii. Shutdown the project on all computers.

8 Experiment with extra redundancy.

i. Add a second Standby Alarm server to the project and link it to the
IP Address of any server that does not currently host either a Primary
or Standby Alarm server.
ii. Predict what will happen and then compile / run the project to test
the prediction.

Vijeo Citect Architecture and Manual Release 1 5-13

Redundancy
 I/O Server Redundancy

Primary and Systems with a single I/O Server have a single point of failure. If the Server fails,
Standby Servers control and monitoring of the system is lost. By introducing a second I/O Server
and dedicating it to communicating with the same I/O Devices, the single point of
failure can be eliminated.

How I/O Server A Primary and Standby I/O Server exist in the system. When the system is in
Redundancy operation, both I/O Servers are identically maintained. Although both I/O Servers
Works are identical, it is important to recognise that the Standby Server is not duplicating
the Primary Server's functions. If it were, the load on the PLC portion of the
network would be double and would significantly reduce performance. Therefore,
only the primary server communicates with the PLCs (labelled I/O Devices in the
image below) at any given time.

5-14 Version 7.20 October 2010

 I/O Server Redundancy (cont.)

How I/O Server If the Primary I/O Server fails the Standby I/O Server will assume operations.
Redundancy
Works (cont.)

When the Primary I/O Server is brought back online, the system returns control of
the I/O Devices back to the Primary Server; allowing the Clients to reconnect to it,
and thereby resuming control of the system.

Vijeo Citect Architecture and Manual Release 1 5-15

Redundancy
 Exercise - I/O Server Redundancy

1 Create a Standby I/O Server. All students must complete these

steps.
i. Open the Project Editor and select Communication » Express
Wizard from the menu.
ii. Create a new I/O Server. Name the I/O Server PulpStandby or
PaperStandby.

iii. The next screen will ask for the new I/O Device to be identified.
Name the new I/O Device PulpDevS or PaperDevS.

5-16 Version 7.20 October 2010

 Exercise - I/O Server Redundancy (cont.)

iv. Select the type External I/O device.

If no genuine I/O Device is available for the I/O Servers to connect

to, select Persisted Memory I/O Device in place of External I/O
Device.

v. Select the Modbus/TCP (Ethernet) driver for the Schneider-Electric

M340 device.

Vijeo Citect Architecture and Manual Release 1 5-17

Redundancy
 Exercise - I/O Server Redundancy (cont.)

vi. Set the IP address (and Port, if necessary) according to the

information provided by the course Instructor.

vii. Continue to the end of the Express Communications Wizard.

2 Configure the new I/O Servers

i. Agree within the class which computers will be the two Standby I/O
Servers.
ii. Create a new Network Address entry for the Standby I/O Server.

iii. Click Add to save the new record.

iv. Open the new I/O Server record for PulpStandby and assign the new
Pulp_IO_S Network Address to it. Click Replace. Also assign the
I/O server to the existing cluster. Similarly add the network address
and cluster information for the PaperStandby Server.

5-18 Version 7.20 October 2010

 Exercise - I/O Server Redundancy (cont.)

3 Configure the Standby I/O Devices

i. Open the I/O Devices dialog (scroll down to the second I/O Server
definition) and set the Startup Mode to Standby.

ii. Click Replace.

iii. Compile the project.
iv. There will be a warning that the Standby IODevice did not have a
priority specified and that the issue was repaired by Applying Priority
2 to Standby Unit PulpDevS.

Vijeo Citect Architecture and Manual Release 1 5-19

Redundancy
 Exercise - I/O Server Redundancy (cont.)

v. The compiled project will have the correction automatically inserted,

but it would be wise to properly update the I/O Device. Re-open the
Standby I/O Device and assign a Priority of 2.

vi. Click Replace.

4 Run the project.

i. Compile the project.
ii. Run the Computer Setup Wizard (in Express mode); accept all
screens as default.
iii. Run the projects on all computers.

5 Confirm expected operation.

i. Operate some of the Client computers and confirm that they are
operating normally.
ii. Shut down the Primary I/O Server and observe that the Clients
continue to receive tag values from the Standby Server.
iii. Shut down the Standby I/O Server and confirm that all tag
communication is lost.
iv. Restart both I/O Servers and observe the recovery of tag data.
v. Again shut down the Primary I/O Server. Pause a minute or so,
during which time some of the tag values on the main graphics page
should be changed.
vi. Restart the Primary I/O Server and confirm that the changed values
remain; that they are not replaced by the most recent values held by
the Primary I/O Server from before it was shut down.

5-20 Version 7.20 October 2010

 Multiple Standby Devices

Device Numbers Vijeo Citect can handle Redundant I/O Devices, though not without careful
planning. The key to understanding operation between I/O Servers and associated
devices is Device Numbers.

Device Numbers must be unique for each identifiable I/O Device.

For example, if the system consists of two I/O Servers each connected to the same
PLC, there would be two definitions for the device in the project, one for each
Server and each having the same Device Number. One would be defined Primary
and the other Standby.

Vijeo Citect Architecture and Manual Release 1 5-21

Redundancy
 Multiple Standby Devices (cont.)

Multiple However, if the system not only had redundant I/O Servers but redundant PLCs as
Definitions well, then the number of definitions doubles. The extra device definitions would
still require the same Device Number however because they are in fact referring to
the same data store.

This can rapidly become very confusing.

Vijeo Citect insists upon having only one primary for each Device Number, but
after that there can be any number of standby connections (it may be easier to think
of them as channels). Once the primary device fails the next unit Vijeo Citect
selects is determined by the I/O Device Priority, see I/O Device Promotion (page
5-23).

5-22 Version 7.20 October 2010

 I/O Device Promotion

I/O Device Promotion of I/O Devices depends on how the Priority of I/O Devices affect the
Priority system when the primary I/O Device fails.

The following diagram shows four I/O Devices connected to two I/O Servers.

Vijeo Citect Architecture and Manual Release 1 5-23

Redundancy
 I/O Device Promotion (cont.)

How PLC An additional I/O Server has been introduced to behave as the Standby I/O Server.
Redundancy Use may also be made of each I/O Server's dual end points to define two separate
Works data paths, each leading to two separate I/O Devices. That is, a Primary I/O Device
and a Standby I/O Device.

The following redundancy is provided:

 Should Primary I/O Device (Device1) fail, or the communications cable fail,
then the next configured Standby I/O Device (Device2) will be promoted to
primary status.
 Should the newly promoted I/O Device (Device2) fail, the next configured
standby I/O Device3 will be promoted to primary status.
 Should the Primary I/O Server (Server1) fail, then the Standby I/O Server
(Server2) will activate and become the Primary I/O Server and I/O Device3 will
remain the Primary I/O Device.
 If I/O Device3 fails, or communications fail, I/O Device4 will be promoted to
Primary status.
The order in which I/O Devices are promoted is decided by the order in which the
Standby I/O Devices are defined in the I/O Device form.

 Note:
Any standby devices connected to the same I/O Server as the primary, will have the
precedence to be promoted to primary status.

See Also:
For more information about I/O Device Promotion, see Vijeo Citect Help topic, I/O
Device Promotion.

5-24 Version 7.20 October 2010

 Exercise - Draw it all Together

This workshop exercise is intended to assist students to bring together all of the
concepts covered up to this point in the course.

A single test environment will be designed to include aspects of multi-server

configurations, redundancy, on-line changes and multiple-cluster configurations.

1 Define a configuration environment.

i. In conjunction with the Instructor and the entire class, determine a
series of implementation stages to integrate the following key
concepts:

1. Distributed Servers (Alarm, Report, Trend and I/O servers on

separate physical computers).
2. Redundant Servers.
3. Multiple Clusters should be created and used (consider re-building
the Global project to run Global, Pulp and Paper on a single
computer).
4. Modifications distributed (as much as possible) via On-Line
Changes and the COPY parameter. Use these techniques to test the
extent to which Servers may make changes without a full restart.
ii. Construct a logical sequence of events and a test plan to determine
the correct implementation of all stages.

Use this diagram as a guide to a reasonable implementation

strategy:

Vijeo Citect Architecture and Manual Release 1 5-25

Redundancy
 Disk PLC Redundancy

Standby and In many applications, processes use Disk PLCs to store vital information to run the
StandbyWrite plant. One example may be a factory that stores recipe information for a batch. In
this case, if the I/O Server that the Disk PLCs are connected to fails then recipe
information will be unavailable until it is online again. To avoid this loss of
information Disk PLC Redundancy may be used.

5-26 Version 7.20 October 2010

 Disk PLC Redundancy (cont.)

How Disk PLC While both the Primary and Standby I/O Servers are functioning, if the Standby
Redundancy Disk PLC is configured to StandbyWrite, Disk PLC data is written to both Disk
Works PLC files and updated together.

If either of the I/O Servers fail, the other I/O Server continues to write to its own
Disk PLC file.

When the I/O Server that failed starts up again, it checks both its own Disk PLC file
and the other I/O Server's file and updates its own file with the latest data.

Vijeo Citect Architecture and Manual Release 1 5-27

Redundancy
 Optional Exercise - Create Redundant I/O
Servers and Disk PLCs

Set up Redundant I/O Servers and Disk PLCs in the projects.

1 Configure Network Addresses for the Standby I/O Servers.

i. Restore the projects PulpDSK and PaperDSK. These are similar to
the previously used projects, but have their I/O Devices connected to
Disk PLCs.
ii. Use the Network Addresses form to create Standby I/O Server
Network Addresses for the Pulp and Paper projects. Name the
Network Addresses Pulp_IO_S and Paper_IO_S.

2 Create redundant Disk I/O Devices.

i. If the local Pulp and Paper have not been shared already, open
Windows Explorer and share the project directory either Pulp or
Paper.

ii. Open the Citect Project Editor and select Communication » Express
Wizard from the menu.

5-28 Version 7.20 October 2010

 Optional Exercise - Create Redundant I/O
Servers and Disk PLCs (cont.)

iii. Create a new I/O Server. Name the I/O Server PulpStandby or
PaperStandby.

iv. The next screen will ask for the new I/O Device to be identified.
Since Disk I/O Devices are going to be used the path names will need
to be manually configured later. Name the new I/O Device
PulpDevS or PapDevS. Note that the due to the limitation of the
number of characters in a field, the name of the Paper standby
device has been shortened.

Vijeo Citect Architecture and Manual Release 1 5-29

Redundancy
 Optional Exercise - Create Redundant I/O
Servers and Disk PLCs (cont.)

v. Select the type Disk I/O Device.

vi. Select the Generic Protocol.

vii. Continue to the end of the Express Communication wizard.

5-30 Version 7.20 October 2010

 Optional Exercise - Create Redundant I/O
Servers and Disk PLCs (cont.)

3 Add the new Servers to the project clusters and add the Network
Addresses.
i. Open the Citect Project Editor and select Servers » I/O Servers.
ii. Add the Cluster Name and Network Address to the Standby I/O
Server definition form. Click Replace.

The Pulp Project settings will look like this:

Vijeo Citect Architecture and Manual Release 1 5-31

Redundancy
 Optional Exercise - Create Redundant I/O
Servers and Disk PLCs (cont.)

The Paper Project settings will look like this:

5-32 Version 7.20 October 2010

 Optional Exercise - Configure Addresses for
Multiple Redundant Disk PLCs

1 Configure the Disk I/O Devices for Redundancy.

i. Return to the Citect Project Editor and select Communication » I/O
Devices from the menu.
ii. Open the definition form for the Standby I/O Device. Drag the scroll
button to do this.

iii. Press F2 on the keyboard to open the extended form. Change the
Startup Mode to StandbyWrite. Click the Replace button then press
F2 to close the extended form.

iv. If the Paper project is being configured change the Number to 2.

Since redundant I/O Devices are being configured this number needs
to be the same as the primary device.

Vijeo Citect Architecture and Manual Release 1 5-33

Redundancy
 Optional Exercise - Configure Addresses for
Multiple Redundant Disk PLCs (cont.)

v. The Disk I/O Devices are files. The Servers and Clients all need to
know the location of those files. When the Address of the Primary
device is being configured it must be followed by the Address of the
Standby device.

The Standby device must be configured the same way. The address
of the Standby device is entered first followed by the address of the
Primary device. The two addresses are separated by a comma ( , )
but must not have a space.

vi. Use this table to assist with the training room configuration. In this
example the Pulp Project Primary device is located on the computer
named Train1 and the Standby is on the computer named Train2.
The Paper Project Primary device is located on Train3 and the
Standby is on Train4.

Pulp Project Primary \\Train1\Pulp\PulpDevP.cdk,\\Train2\Pulp\PulpDevS.cdk

Pulp Project Standby \\Train2\Pulp\PulpDevS.cdk,\\Train1\Pulp\PulpDevP.cdk

Paper Project Primary \\Train3\Paper\PapDevP.cdk,\\Train4\Paper\PapDevS.cdk

Paper Project Standby \\Train4\Paper\PapDevS.cdk,\\Train3\Paper\PapDevP.cdk

vii. When the Address configuration is complete click the Replace

button.

5-34 Version 7.20 October 2010

 Optional Exercise - Configure Addresses for
Multiple Redundant Disk PLCs (cont.)

2 Test the redundancy.

i. Compile and run the project on all computers
ii. Operate some of the Client computers and confirm that they are
operating normally.
iii. Shut down the Primary I/O Server and observe that the Clients
continue to receive tag values from the Standby Server.
iv. Shut down the Standby I/O Server and confirm that all tag
communication is lost.
v. Restart both I/O Servers and observe the recovery of tag data.
vi. Again shut down the Primary I/O Server. Pause a minute or so,
during which time some of the tag values on the main graphics page
should be changed.
vii. Restart the Primary I/O Server and confirm that the changed values
remain; that they are not replaced by the most recent values held by
the Primary I/O Server from before it was shut down.
viii. Shut down the project on all PCs.

3 Reconfigure for the Persisted I/O version of the projects.

i. Backup the configured PulpDSK and PaperDSK projects to a
separate location such that they may be taken away from the
training room for later use without damaging the starting DSK
projects.
ii. Delete the DSK projects from the Citect Explorer.
iii. Select the Pulp project and run the Computer Setup Wizard to return
the focus of the computer to that project.

Vijeo Citect Architecture and Manual Release 1 5-35

Redundancy
 Summary

Summary The following topics have now been addressed:

 File Server Redundancy (page 5-2)

 Data Path Redundancy (page 5-4)
 Network Redundancy (page 5-6)
 Alarm, Report and Trend Server Redundancy (page 5-7)
 I/O Server Redundancy (page 5-14)
 Disk PLC Redundancy (page 5-26)
 Multiple Standby Devices (page 5-21)
 I/O Device Promotion (page 5-23)

Questions The following questions are to check understanding:

 Why build Redundancy into a Vijeo Citect system?

 On large systems with multiple Servers how would Redundancy be built in?
 What happens to the Clients that are connected to a Standby Alarm Server
when the Primary Alarm Server comes back online?
 What happens to the Clients that are connected to a Standby I/O Server when
the Primary I/O Server comes back online?
 Why is Time Synchronisation important for Redundant Disk PLCs?
 A Device Number does what?

5-36 Version 7.20 October 2010

 Chapter 6: Web Client

Overview
Introduction
The Vijeo Citect Web Client allows a live Vijeo Citect project to be viewed within
a Web browser. It also provides easy access to Vijeo Citect Runtime for LAN-
connected users requiring read/write access to current production information.

This Chapter Covers These Topics:

 What is the Web Client? ........................................................6-2

 System Architecture...............................................................6-4
 Internet Information Services - (IIS) .....................................6-7
 Install the Web Server Software ..........................................6-10
 Web Server File Structure....................................................6-16
 Prepare the Vijeo Citect Project for Deployment ................6-20
 Web Deployment Preparation Tool .....................................6-23
 Web Deployment Page ........................................................6-26
 Web Client Home Page........................................................6-28
 Configure a Deployment......................................................6-29
 Manage Deployment Packages............................................6-42
 Security ................................................................................6-46
 Web Server Security ............................................................6-47
 File System Security Configuration.....................................6-57
 Redundant Servers ...............................................................6-68
 Management of Floating Licenses.......................................6-70
 What is the Web Client?

Projects The purpose of the Web Client is to make a Vijeo Citect project available over the
Viewable in a Intranet using a Web Browser. The Vijeo Citect project's pages and runtime
Web Browser databases need to be converted into a format that is viewable in a Web Browser.
This is achieved using the Web Deployment Preparation Tool. This process is
performed on the Vijeo Citect Server and will be discussed in the section Web
Deployment Preparation Tool (page 6-23).

When the project is deployed and placed on the Web Server it needs to be made
available as an Internet location so that Web Clients will be able to find and
download the files. This service is provided by Internet Information Services
(IIS). This process is performed on the Web Server and will be discussed in the
section Web Server File Structure (page 6-16).

6-2 Version 7.20 October 2010

 What is the Web Client? (cont.)

Projects When the Web Clients connect to the Web Server they need to be provided with a
Viewable in a list of available Deployments. The process of creating Deployments is performed
Web Browser on the Web Server and is discussed in the section Configure a Deployment (page
(cont.) 6-29).

Vijeo Citect Architecture and Manual Release 1 6-3

Redundancy
 System Architecture

Three In order to display a Vijeo Citect project in a web browser, the pages of the project
Components and the current data need to be made available using standard web based
communications. There are three components involved in achieving this outcome.
These are:

 The Vijeo Citect Server

 The Vijeo Citect Web Server
 The Vijeo Citect Web Client

 Note:
During the exercises in this chapter all three of these components will be
configured on one computer. However, it is important to understand that in a real
scenario these roles are more likely to be performed on different computers.

Vijeo Citect The Vijeo Citect Server is the server, or the groups of servers, that host the runtime
Server project i.e. the I/O, Report, Alarm and Trend Servers.

6-4 Version 7.20 October 2010

 System Architecture (cont.)

Vijeo Citect Web The Vijeo Citect Web Server has two main functions. Firstly it hosts the files that
Server the Web Client will see in a special format called the Web Deployment. These are
located on the Web Server.

Secondly, the Web Server creates a Web Address for the Web Client to connect to
the runtime system. This is achieved using Internet Information Services.

Vijeo Citect Architecture and Manual Release 1 6-5

Redundancy
 System Architecture (cont.)

Vijeo Citect Web The Vijeo Citect Web Client allows a User to view a Vijeo Citect project over the
Client Intranet using Microsoft Internet Explorer.

The Web Client uses Internet Explorer to connect to the Web Address defined on
the Web Server.

6-6 Version 7.20 October 2010

 Internet Information Services - (IIS)

Why Is Internet Internet Information Services (IIS) is the Windows Web service that makes it easy
Information for information to be published on the Intranet. The purpose of Internet Information
Services (IIS) Services is to take local directory structures and turn them into a URL so that a
used? remote client can locate the source using a web browser.

IIS is not installed by default but can be added using the Add/Remove Programs
dialog box from the Control Panel.

Many applications produced by Citect use IIS including Vijeo Citect, Vijeo Citect
Web Client and Vijeo Citect Excel Client. Before installing any of these
applications IIS must be installed first.

If Internet Information Services has not been installed on the training computer
complete the following exercise before continuing with the Web Client chapter.

Vijeo Citect Architecture and Manual Release 1 6-7

Redundancy
 Exercise - Install Internet Information Services
(IIS)

Follow these steps if Microsoft Internet Information Services has not been installed.

1 Install Internet Information Services.

i. Go to Start » Settings » Control Panel and start the Add or Remove
Programs application.

ii. Select Add/Remove Windows Components.

iii. Tick the Internet Information Services (IIS) check box. Click Next >
to continue.

6-8 Version 7.20 October 2010

 Exercise - Installing Internet Information
Services (IIS) (cont.)

iv. Windows will install the Internet Information Services. The installer
may prompt for the location of the source files.
v. After IIS has been installed click Finish.

 Note:
This exercise was performed under Windows XP. IIS installations are somewhat
more complicated under newer Operating Systems and advice should be sought
from suitable experts if such an environment is to be used. Chapter 4 of the
Installation Guide outlines installation requirements for all relevant versions of IIS.

Vijeo Citect Architecture and Manual Release 1 6-9

Redundancy
 Install the Web Server Software

Located on any The only component of the Web Client system that requires installation is the Web
Computer on the Server. The Web Server can be located on any computer on the LAN.
LAN

 Note:
It is recommended that the Web Server be located on a different computer than any
of the Vijeo Citect Servers i.e. I/O, Report, Alarm or Trend Servers.

See Also:
Full installation and configuration instructions for the Vijeo Citect Web Client are
available in PDF format on the Vijeo Citect Installation DVD. See the file Vijeo
Citect Web Client.pdf located in the Manuals folder.

6-10 Version 7.20 October 2010

 Exercise - Install the Web Server Software

Prepare the computer to be a Vijeo Citect Web Server.

1 Install the Web Server Software.

i. Insert the Vijeo Citect Installation DVD.

The first two screens are the initial startup and the Welcome screens.
Click Next > to scroll through both of these.

ii. The Installation Documentation contains important information

regarding installation, upgrading and new features. This information
should be read before installing the new version on the system.

Vijeo Citect Architecture and Manual Release 1 6-11

Redundancy
 Exercise - Install the Web Server Software
(cont.)

iii. Accept the Licence Agreement.

iv. Select Custom then click Next > to continue.

6-12 Version 7.20 October 2010

 Exercise - Install the Web Server Software
(cont.)

v. There are no required Core Components on the next screen. Select

nothing and click Next >

vi. No Documentation components are required. Select nothing, simply

click Next >

Vijeo Citect Architecture and Manual Release 1 6-13

Redundancy
 Exercise - Install the Web Server Software
(cont.)

vii. At the Add-ons screen, select Vijeo Citect Web Server for IIS and
click Next >

viii. Click Install to begin the installation.

6-14 Version 7.20 October 2010

 Exercise - Install the Web Server Software
(cont.)

ix. Click Finish to complete the installation.

x. Exit the Installer.

Vijeo Citect Architecture and Manual Release 1 6-15

Redundancy
 Web Server File Structure

What has been Once a full installation has taken place, the following directories are located in the
Installed? specified destination folder. By default this is C:\Inetpub\wwwroot\Citect\.

 The WebServer directory primarily hosts the administrative pages that are
displayed by a Web Server.
 The cgi-bin and images directories contain the content required to display
these pages.
 The client folder contains the client components (.cab files) that are delivered
to a remote computer to run a deployment. Any subdirectories include the
components associated with a particular release (in this case, Version 7.0).
 The deploy folder includes the files associated with any deployments (Vijeo
Citect projects) that have been configured on the Web Server.
 The #DisplayClient folder (located in the Deploy folder) plays a key role in the
Web Server security, as the permissions defined for this folder determine the
access rights for each user.
 The locales folder contains the files required to support different languages for
the client interface.

6-16 Version 7.20 October 2010

 Web Server File Structure (cont.)

Share Earlier in the course a resource was created that may be shared across an internal
Information network in Manage Vijeo Citect Files (page 2-39). When files are shared across a
network the location of those files must be shared. The first step is to create a
Share Name on the local computer. In the following example the share is named
Pulp.

When the client computer connects to this share the Computer Name must be
identified and then the name of the Share. Using the Universal Naming
Convention the client can connect to the share by typing the address into Windows
Explorer. In this case the computer name is TRAINING01 and the share name is
Pulp.

\\Training01\Pulp

Vijeo Citect Architecture and Manual Release 1 6-17

Redundancy
 Web Server File Structure (cont.)

The IIS Virtual The purpose of IIS is similar to creating a share on the computer so that the local
Directory area network can connect using a UNC name. IIS creates a Share that a remote
computer can find using a Universal Resource Locator (URL).

When Vijeo Citect was installed these folders were created. The Local Path is:

C:\Inetpub\wwwroot\

The installation process creates a Share in Internet Information Services called

Citect. This is why Internet Information Services must be installed before Vijeo
Citect. If it is not the installer cannot create this share.

6-18 Version 7.20 October 2010

 Web Server File Structure (cont.)

The IIS Virtual This is the Property page of a Virtual Directory called Citect. The Local Path
Directory (cont.) field specifies the location of the files to be shared on the local drive.

When a remote computer connects to this location it must follow the same process
as connecting to a share across an internal network i.e. it must find the Computer
Name (an IP Address) and then find the Share (the IIS Virtual Directory).
However, instead of using a UNC (Universal Naming Convention) name...

\\training01\Pulp

...the share name is a URL (Universal Resource Locator).

http://10.176.234.103/citect

 Note:
The IIS share is installed only if the Web Server component is selected during the
installation.

Vijeo Citect Architecture and Manual Release 1 6-19

Redundancy
 Prepare the Vijeo Citect Project for Deployment

Defined on the The Vijeo Citect project needs to be prepared before the Web Client is able to
SCADA Servers connect. There are several steps involved in preparing the project.

 The Servers must be set up as Network Servers (not Stand-alone)

 The project files must be prepared for deployment
 The User folder must be shared
 The Vijeo Citect Web Users must be added to the User list in the project

6-20 Version 7.20 October 2010

 Exercise - Set Up the Network Server and
Control Client

1 Use the Citect Computer Setup Wizard to set up the Project Server.
i. On every computer, restore the previously backed up project
PulpStandalone. Compile the project.

ii. Click the Computer Setup Wizard button on the main toolbar.
iii. Select Express Setup. Click Next > to continue.
iv. Select the Server and Control Client option in Multi-Process mode.
Click Next > to continue.

v. Ensure the Server is configured to be Networked.

vi. Continue through to the end of the Wizard.

Vijeo Citect Architecture and Manual Release 1 6-21

Redundancy
 Exercise - Set Up the Network Server and
Control Client (cont.)

2 Run the project.

 Note:
Even though all communication will seem to rely on IIS to distribute the project, a
Web Client installation will only work if the server is set up to be networked. This
is because the normal communications channels are used to transmit tag data.

6-22 Version 7.20 October 2010

 Web Deployment Preparation Tool

Prepare for Web The final step in the process of preparing a project for deployment involves using
Based Delivery the Web Deployment Preparation tool. This takes a freshly compiled project and
creates the required files and directories for web-based delivery.

 Hints & Tips

The Web Deployment Preparation tool can be configured to run automatically when
a project is compiled. To do this, open the Citect Project Editor and select Tools »
Options from the menu. Select the Prepare for Web Deployment option and click
OK. Note that this increases the time taken for each compile, particularly for large
projects.

How to Prepare a  To run a project through the Web Deployment Preparation tool:
Deployment
Go to the Citect Explorer and select Tools » Web Deployment Preparation from
the menu.

or

Click the Web Deployment Preparation button on the main toolbar.

A progress indicator will appear. The size of the project will significantly affect
how long this process will take; a very large project with many files may take well
over ten minutes to process, depending on the hardware.

Vijeo Citect Architecture and Manual Release 1 6-23

Redundancy
 Exercise - Web Deployment Preparation Tool

Prepare a project for deployment. This step is only necessary on the Primary I/O
Servers.

1 Prepare the project files for deployment.

i. Open the Citect Explorer.

ii. Click the Web Deployment Preparation button. This progress

indicator will be displayed as the files are compiled

When the Web Deployment Preparation has completed this dialog will
be displayed. Click OK to continue.

 Note:
There is a web deployment option in the Citect Project Editor - Tools » Options…
» Prepare for web deployment. When this option is set it will automatically
update the deployment files whenever the project is compiled.

iii. Open Windows Explorer and check that the project folder now
includes a folder called webdeploy.

6-24 Version 7.20 October 2010

 Exercise - Web Deployment Preparation Tool
(cont.)

2 Share the Project folder.

i. Right click the project folder and select Properties from the menu.
ii. Open the Sharing tab. Select the option Share this folder and name
the Share Pulp. Click OK to create the Share.

Vijeo Citect Architecture and Manual Release 1 6-25

Redundancy
 Web Deployment Page

Configure and The Web Deployment page is where deployments are configured and edited.
Edit
Deployments
When a deployment has been configured the page will look like this:

 Note:
The yellow fields are mandatory

6-26 Version 7.20 October 2010

 Web Deployment Page (cont.)

Configure and This page is available to Admin users only and has a number of fields and icons.
Edit
Deployments Field Function
(cont.)
Deployment

The Deployment field labels the Name of the deployment

Description

The Description field is optional and allows more detail regarding the
deployment to be provided

Help Launches a PDF file explaining how to configure and use the Web
Client

Apply The Apply Changes icon initiates the process where all the project
files are retrieved from the path indicated, and copied to the Web
Changes Server ready for access by the Web Clients

Home Returns the user to the Web Deployment Home page

File Paths

The number to the left indicates how many files are included in the
project, the number to the right indicates the total size of the project

Project Path

This is the path to the project files. The path may be to the local drive
if the Vijeo Citect Web Server is on the same conputer as the project
folder. However, the most likely configuration will be to have the
Web Server on a separate computer. In this case the path needs to be
either to a mapped drive or a UNC name

Client Control

This is the file that a connecting client will download in order to

display the project files the first time it connects to the Vijeo Citect
Web Server

Vijeo Citect Architecture and Manual Release 1 6-27

Redundancy
 Web Client Home Page

Overview The Home Page displays the options available for each type of user. The users with
Administrator privileges will see all available options shown below.

The type of action that can be implemented in a deployment depends on the

permissions granted by the login. For example, if the user logs in as a View-only
Client, they will only be able to view a deployment. If the user is an
Administrator, they will be able to edit deployments and create new ones.

There are six Action icons on the Home page and a System Messages panel.

Icon Function
Add New Opens the Deployment Configuration page where new
Deployment deployments can be created (Administrator Clients only).
Help Launches a PDF file explaining how to configure and use the
Web Client.
Start Control Displays the selected deployment with Control Client
Client permissions (Control Client and View-only Client only).

Start View- Displays the selected deployment with View-only Client

only Client permissions.

Edit Opens the Deployment Configuration page and allows the

Deployment selected deployment to be edited (Administrator Clients only).
Delete Deletes the selected deployment (Administrator Clients only).
Deployment

System Messages

Provides notification of events that impact the current status of

the Web Server.

6-28 Version 7.20 October 2010

 Configure a Deployment

Overview A Deployment represents the implementation of a Vijeo Citect project on the Web
Server. It incorporates the files and components required to display a project and
then stores the location of the Servers where Vijeo Citect Runtime data is
generated.

The deployments configured on a Web Server are listed on the Web Client home
page, which is the page that appears when the user logs in. The configuration
details for a deployment can be displayed by clicking the small plus icon to the left
of the deployment name.

Vijeo Citect Architecture and Manual Release 1 6-29

Redundancy
 Exercise - Configure a Deployment

Configure a Deployment to connect to the Pulp project. This action is performed on

all computers as thus far, every machine is capable of being a Web Server.

1 Log in to the Vijeo Citect Web Client as an Administrator.

i. Start the Vijeo Citect Web Client. From the Start menu, select
Programs » » Launch Vijeo Citect Web.
ii. Log in as a user with Admin privileges (check with the course
Instructor).

2 Create a new Deployment.

i. Click the Add New Deployment icon. This will open the Vijeo
Citect Web Client Deployment page.

ii. Create a name for the deployment in the Deployment field.

6-30 Version 7.20 October 2010

 Exercise - Configure a Deployment (cont.)

iii. Add a description of the deployment in the Description field.

iv. Add the Project Path.

v. Select the location of the Web Client Control software from the drop
down list.

3 Save the deployment.

i. Click the Apply Changes icon to begin copying the deployment

files onto the Web Server. This dialog will indicate the progress of
the file copy.

When the files have been copied this dialog will be displayed.

Vijeo Citect Architecture and Manual Release 1 6-31

Redundancy
 Exercise - Configure a Deployment (cont.)

ii. Click the Home icon to return to the Home page. The new
deployment will be displayed.

4 Create another deployment for the Paper project.

6-32 Version 7.20 October 2010

 Exercise - Connect to the Web Server

1 Connect the Web Clients to the Web Server.

i. Open Internet Explorer on the local computer.
ii. Type the location of the Web Server into the Address Bar. Use the IP
Address of the local Web Server (connections to other students' Web
Servers will be made later).

http://10.176.235.101/citect

This location is the one that was configured in Internet information

Services during the installation.
iii. The Web Client screen will be displayed with the available
deployments listed.

Vijeo Citect Architecture and Manual Release 1 6-33

Redundancy
 Exercise - Connect to the Web Server (cont.)

2 Connect to the project.

i. Click the Start Control Client icon located beside the project
selected to run. The Client Control ActiveX object will be copied
across to the Web Client. The progress of the file copy is indicated on
the Internet Explorer status bar.

ii. When the file is installed the Web Client will start.

6-34 Version 7.20 October 2010

 Exercise - Connect to the Web Server (cont.)

iii. When the project appears log in to the Vijeo Citect system using the
normal Vijeo Citect login.
iv. Test the project for normal functionality.

3 Shut down the project.

i. Exit the Vijeo Citect project.
ii. Shut down Internet Explorer.

4 Connect to a different project in the room.

i. Re-open Internet Explorer.
ii. Connect to a different Web Server. Use the same format as at the
beginning of this exercise, but substitute the different IP address.
iii. Authenticate with credentials provided by the student at that
computer.
iv. When the Vijeo Citect Web Client Deployment page arrives, click the

Start Control Client icon.

v. Confirm that the project is correctly delivered.
vi. If desired, attempt to connect to other projects concurrently.
vii. Log out of the projects.

5 Connect as a view-only client.

i. Re-open the Web Client and select the Start View Only Client
icon.
ii. Once the project starts, login as the project Administrative user
(Dean) and confirm that even though this user has full rights, they
are unable to modify any tag values.
iii. Shut down the Web Client.

Vijeo Citect Architecture and Manual Release 1 6-35

Redundancy
 Exercise - Automate Project Updates

1 Automatically prepare for Web Deployment.

i. In the Project Editor, select the menu Tools » Options. Tick the box
labelled Prepare for web deployment.

ii. This will automatically cause a Web Deployment Preparation to

occur whenever the project is compiled. Click OK.

6-36 Version 7.20 October 2010

 Exercise - Automate Project Updates (cont.)

2 Automate the update of the deployment in the Web Deployment

page.
i. Open the Computer Setup Editor.
ii. Create a new section WebServer.
iii. Construct the following two parameters:

Parameter Value
DeployRoot c:\Inetpub\wwwroot\Citect\deploy
WebClientCab 720/CitectSCADAWebClient_7_20_0_598.cab

iv. Save the configuration and close the Computer Setup Editor.

3 Modify the Pulp project.

i. On one or more of the Servers, make a small change to a graphics
page (perhaps add a text object).
ii. Save the page and compile the project. Observe that the compile
process takes longer than usual, with a different completion
message.

Vijeo Citect Architecture and Manual Release 1 6-37

Redundancy
 Exercise - Automate Project Updates (cont.)

iii. Open the web client and re-open the deployed project as a Control
Client.
iv. Observe the modification to the page.

 Note:
The configuration of automated preparation and deployment will effectively give
Web Clients the same functionality as the On-Line Changes feature covered on the
previous day.

6-38 Version 7.20 October 2010

 Exercise - Distribute Non-standard Components

By default, the process of Web Deployment will only distribute the standard
contents of a project. In order to include other components, separate packages must
be created. Any ActiveX components must be stored in a file called Activex.zip
and all other objects (custom DBF files, HTML, images, CSV files etc) must be
stored in a file called Misc.zip.

1 Identify sound files in the project.

There are two sound files connected with the Pulp project. For very
obvious reasons, the Barking Drum will make the sound of a dog
barking; in addition, there is a second sound file hidden in the project
which will create the sound of a machine gun (students are welcome
to search for it).
i. In the running project (not the Web Client), hover the mouse over
the Barking Drum until a small white rectangle is seen.
ii. Click the mouse and a dog's bark will be heard (assuming the
computer's speakers are set loud enough and a user is logged into
the project).
iii. Perform the same action in the Web Client-based project and
although the rectangle is present, no sound will emerge.

2 Distribute sound files to the Web Clients.

i. In Windows Explorer, navigate to the Pulp project folder.
ii. Identify the two sound files (bark.wav and 30cal5.wav) and create a
zip file called Misc.zip to contain them (the Instructor will advise
what method is appropriate for the particular training room). Ensure
that the files are copied into the Misc.zip file and not moved.
iii. Also ensure that the file Misc.zip remains in the project folder.

3 Test the changes.

i. Return to the Project Editor and compile the project - it will claim
that no compile is necessary, but ensure it is done anyway.
ii. Open the Web Client and select the Pulp deployment as a Control
Client.
iii. Click on the Barking Drum and confirm that the sound now plays. Do
the same for the Machine Gun sound.

Vijeo Citect Architecture and Manual Release 1 6-39

Redundancy
 Exercise - Create a Stand-alone Web Server

Up to this point in the chapter, the Web Server (running on IIS) has been hosted on
the same computer as the Citect Servers (Alarm, Report, Trend and I/O).

In this exercise, a separate computer hosting IIS will be established; this will
demonstrate how the configuration may be used for a load-balancing configuration
with multiple web servers.

1 Designate a RAT-IO server.

i. Identify one of the computers as a Citect Server.
ii. Back up the existing project on that computer and then restore onto
all other student computers.
iii. Run the project on the RAT-IO Server.

2 Configure Web Servers.

i. On the other computers, compile the project with all automated web
deployment configuration still in place.
ii. DO NOT run the project on these computers. The project will only
run on the designated RAT-IO computer.
iii. Shut down the Vijeo Citect development environment on ALL
computers (including the RAT-IO server).

3 Run the Web Clients.

i. On the Web Server computers, run Internet Explorer and enter the
URL of the local web server into the address bar.

http://10.176.235.101/citect (for instance).

ii. Connect to the Pulp Project as a Control Client and run the client to
confirm full operation.

 Note:
The Web Server's role is to distribute the project to the Clients; it take no part in the
communication of data between the RAT-IO server and the client and although not
recommended, it may be shut down once all Clients have launched the project.

6-40 Version 7.20 October 2010

 Exercise - Create a Stand-alone Web Server
(cont.)

4 Connect multiple clients to multiple web servers.

Currently, there are a large number of Web Servers connecting to a

single RAT-IO Server. This might be considered a useful scenario for
load-balancing in a large environment with many Clients. Next
multiple Clients will be connected to each Web Server.
i. On every Web Server / Client computer, open additional instances of
Internet Explorer and connect to other Web Servers in the room.
ii. Also perform this step on the RAT-IO Server; thus permitting this
computer to connect to itself via a remote Web Server.
iii. Remove the LAN cable from one of the Web Servers to confirm that
the Client computers using that Server are not interrupted.

5 Shut down all clients.

 Note:
The steps taken above to perform a local compile of the project are only required in
a Workgroup environment. If the Servers and Client computers are members of a
domain, the deployment manager web page may simply make a connection to the
shared location on the RAT-IO Server to pick up the project ready for deployment
via the Web Server. The necessary authentication to complete this step cannot be
performed in a Workgroup environment, thus the additional steps above.

Vijeo Citect Architecture and Manual Release 1 6-41

Redundancy
 Manage Deployment Packages

Internet Explorer The project deployed to the clients is stored in the temp folder of the currently
%temp% Folder logged-in user.

Amongst other things, this means that multiple packages are stored, one for each
Windows user that has used the web client.

On occasions (apparently related to Internet Explorer's infrequent inability to detect

updated versions), a newly deployed project will not make its way to the client,
instead, the client computers will continue to make use of the existing project.

In this situation, it is an easy matter to simply delete the existing package and
permit the web client to download a replacement.

The local Temp folder may be accessed via the Start » Run command by accessing
the %temp% environment variable.

Run this command and the local Temp folder listing will be displayed.

From there, it is a simple matter to delete the entire Citect folder structure.

6-42 Version 7.20 October 2010

 Exercise - Manage the Deployment Package

1 Access the Temp file location.

i. From the Windows Start menu, select Run.

 Note:
The Run dialog box may also be launched by holding down the Window key on the
keyboard and pressing the R key.

ii. In the Open: field, type %temp%.

iii. Click OK to launch the command.

2 View the deployment files.

i. A Windows Explorer screen will be opened showing the contents of
the current user's Temp folder (here, shown for the user Student).

Vijeo Citect Architecture and Manual Release 1 6-43

Redundancy
 Exercise - Manage the Deployment Package
(cont.)

ii. Open the folder Vijeo.

iii. Here, there will be folders for the names of the projects deployed to
this computer (Pulp and Paper should have been deployed).

iv. Explore the contents of all folders to understand the material being
sent to the client computers.

3 Delete the Vijeo folder.

i. Return to the %temp% folder.

ii. Delete the Vijeo folder.

6-44 Version 7.20 October 2010

 Exercise - Manage the Deployment Package
(cont.)

4 Launch the deployed Web project.

i. Open the Vijeo Citect Web Client.
ii. Launch either the Pulp or Paper deployment.

iii. Observe that the deployment files are again sent to the Client
computer as the Client starts up. This may also be confirmed by re-
opening the %temp% folder to note that the Vijeo folder has been
re-created.

 Hints & Tips

Many sites have developed a script to delete the Vijeo folder and then launch the
Web Client, thus guaranteeing that the latest version is always available at every
Client computer.

iv. Close Internet Explorer.

Vijeo Citect Architecture and Manual Release 1 6-45

Redundancy
 Security

Integrated with Security on the Vijeo Citect Web Server is handled by IIS security, which is
Windows tightly integrated with Windows’ user-based authentication.
Security

 Note:
While the Web Server security architecture controls access to the projects on the
Web Server, it is important to note that Vijeo Citect’s system security
(privilege/area settings) still manages protection of the control system, maintaining
a primary level of security.

The installation and initial configuration of the Web Server must be performed by a
Windows user with local administrator permissions; that is, they must be able to
add and edit Windows’ User accounts, and modify file/folder protection.

This capability is required to set up Web Client user accounts and manage security
settings.

Security Systems When configuring security for the Web Server there are three different types of
Defined security that must be clearly defined and understood.

 Windows Security
Windows Security is the security system that is used to log in to the computer,
domain and/or workgroup. In order to set up the security for the web client the user
must be logged in to the computer as a Windows User with local administrator
privilege.

 Web Server Security

Web Server Security is the security system that controls access to the projects via
the Web Server. Users may be added from the Windows Security into Web Server
Security or new users may be created who are allowed access to the Web Client
system. Either way the two systems must be configured independently.

 Vijeo Citect Security

Vijeo Citect Security refers to the users that are set up to log in to the SCADA
projects. Even though the other two security types are used they do not replace the
Vijeo Citect Security that has been implemented at the project level.

6-46 Version 7.20 October 2010

 Web Server Security

User Types Web Server Security has three types of User account.

Account Type Description

Administrator The User is permitted to remotely view, add, update and delete
deployments.
Control The User can view project pages and make adjustments to writable
values
View-only The User can only view the project pages

The Web Server tests the access rights for each user when they log in and then
displays or hides the appropriate buttons on the home page accordingly.

Client Type The following table defines the access rights each type of user has to the Web
Access Rights Client’s installed directories, as defined by the properties for each.

In the table, read means Read and Execute, List Folder Contents and Read user
permissions are allowed, read and write means Full Control is allowed, and
access denied means Full Control is denied.

Installed directory Administrator Control View-only

Citect read read read
Citect \ cgi-bin read read read
Citect \ client read read read
Citect \ deploy read and write read read
Citect \ deploy\ #DisplayClient read read access denied
Citect \ images read read read

Vijeo Citect Architecture and Manual Release 1 6-47

Redundancy
 Web Server Security (cont.)

How to Set Up a Creating a user group associated with each type of Web Client account on the Web
User Group Server allows security to be managed without the need to configure each user on an
individual basis. Users can simply be added to a group, which means they
automatically inherit the security status set for the group. These accounts must also
be created on the Vijeo Citect Server that contains the WebDeploy folder.

 Note:
Web Client Security must be set up by a user who has logged into the computer as a
local administrator.

 To set up a Web Client User Group:

Go to Start » Settings » Control Panel » Administrative Tools » Computer
Management

or

Right click the My Computer icon on the Windows Desktop and select Manage
from the menu.

6-48 Version 7.20 October 2010

 Exercise - Web Client Groups and Users
Until this point, all access to the Web Server has been conducted as Local
Administrator. In real life, this is probably not a good idea. Configuring restricted-
access users is a complex activity involving the interaction between Windows users
and IIS restrictions and also special configuration of the Vijeo Citect Web Client
environment.

1 Configure Web Client Groups.

For a running system, the following groups need to be created on the

Web Server and the Primary I/O Server; however for the class, all
users should complete these steps.
i. Right click the My Computer icon on the Windows Desktop and select
Manage from the menu.
ii. Under the Local Users and Groups branch right click the Groups icon
and select New Group… from the menu.

Vijeo Citect Architecture and Manual Release 1 6-49

Redundancy
 Exercise - Web Client Groups and Users (cont.)

iii. Add a group called Web Client Admin then click the Create button.

iv. Add two more groups called Web Client Control and Web Client
View. Click the Close button when finished. Three new groups have
been added to the list of Local Groups.

6-50 Version 7.20 October 2010

 Exercise - Web Client Groups and Users (cont.)

2 Set up Web Client Users.

i. Right click the Users icon and select New User… from the menu.

ii. Add three Users. Use any names. The names of the people in the
class are a good idea. Click Create to add the name.

Vijeo Citect Architecture and Manual Release 1 6-51

Redundancy
 Exercise - Web Client Groups and Users (cont.)

iii. When the Users have been added click Close. The new Users will be
added to the list. (The examples below are Andrew, Carl and
Vanessa.)

3 Add Users to the Groups.

i. Select the Groups branch and right click the Web Client Admin
group. Select Properties from the menu.

6-52 Version 7.20 October 2010

 Exercise - Web Client Groups and Users (cont.)

ii. Click the Add… button.

iii. The Select Users or Groups dialog will be displayed. The default
location for choosing Users is the Windows domain or Workgroup.
The example below is displaying Training01 as the default location.
At this point it is possible to use Users that have been defined in the
Windows Security system of the individual company and add them to
the Web Client Groups, however this exercise will make use of local
users.

Vijeo Citect Architecture and Manual Release 1 6-53

Redundancy
 Exercise - Web Client Groups and Users (cont.)

iv. Select the Advanced... button to display the extended form and Find
Now to populate the list.

v. Select one of the newly created Users and click OK to continue. The
name will be added to the list as shown below. Click OK.

6-54 Version 7.20 October 2010

 Exercise - Web Client Groups and Users (cont.)

vi. The User will be listed as a Member of the Group Web Client Admin.
Click OK to finish.

4 Repeat these steps to add a user to each of the groups Web Client
Control and Web Client View.

Vijeo Citect Architecture and Manual Release 1 6-55

Redundancy
 Exercise - Web Client Groups and Users (cont.)

5 Adjust the default security settings in Internet Explorer.

i. Open Internet Explorer and select Tools » Internet Options from the
main menu.
ii. Open the Security tab and select the Local intranet icon.

iii. Click the Custom level... button. Scroll to the end of the list and
select the Prompt for user name and password setting. Click OK to
close the Security Settings dialog then OK again to close the
Internet Options dialog.

iv. Close Internet Explorer. This change will ensure that when the Web
Client is opened the user will be prompted for their username and
password.

6-56 Version 7.20 October 2010

 File System Security Configuration

Defined on the The security settings need to be adjusted in the WebServer folder and its sub
Web Server directories, as this will determine the access granted to each type of client account.

 To prepare the WebServer folder:

Launch Windows Explorer and browse to the WebServer folder.

Right click the WebServer folder and select Properties.

From the Properties dialog, select the Security tab. The dialog will display the
users that are currently configured for the folder.

Vijeo Citect Architecture and Manual Release 1 6-57

Redundancy
 Exercise - File System Security Configuration

The security settings in the Web Server file system need to be changed manually.
If the computer is using Windows XP, but is not joined to a domain, the Security
tab in the folder settings will not be visible. The first section of this exercise is
necessary only if this is the case.

1 Change the Windows Folder Options.

(This step may have already been done by the Instructor prior to the
commencement of the class)
i. Click Start » Settings » Control Panel.
ii. Double click Folder Options.

iii. Select the View tab.

iv. Scroll to the end of the Advanced settings: options and untick the
option Use simple file sharing. Click OK.

6-58 Version 7.20 October 2010

 Exercise - File System Security Configuration
(cont.)

2 Change the default security settings in the Web Server folders.

 Note:
These changes only need to be made on the computer that is going to be the Web
Server.
i. Find the Citect folder in Windows Explorer. The default location for
this is:

C:\Inetpub\wwwroot\Citect\

ii. Right click the Citect folder and select Properties from the menu.

Vijeo Citect Architecture and Manual Release 1 6-59

Redundancy
 Exercise - File System Security Configuration
(cont.)

iii. Open the Security tab.

iv. Set the Local Administrator Permission levels to be Full Control.

6-60 Version 7.20 October 2010

 Exercise - File System Security Configuration
(cont.)

3 Add the three Web Client groups to the folder security.

i. Click the Add button.

ii. Select the Advanced… button to show the extended form.

iii. Click the Find Now button to populate the list.

Vijeo Citect Architecture and Manual Release 1 6-61

Redundancy
 Exercise - File System Security Configuration
(cont.)

iv. Select the three Web Client groups then click OK. Click OK again to
close the Select Users or Groups dialog.
v. Confirm all three groups have the Permissions shown below.

6-62 Version 7.20 October 2010

 Exercise - File System Security Configuration
(cont.)

vi. Click the Advanced button. On the Permissions tab tick the check
box for the Replace permission entries… option. Click OK.

vii. Click OK to close the Advanced Security Settings dialog. A

Security warning will be displayed. Click Yes.

viii. Click OK to close the Citect folder properties.

Vijeo Citect Architecture and Manual Release 1 6-63

Redundancy
 Exercise - File System Security Configuration
(cont.)

4 Change individual folders to distinguish permissions for the Web

Client User Groups.
i. Open the Properties of the deploy folder. On the Security tab,
select the Web Client Admin Group and tick the Allow » Full Control
check box. Make sure that the Replace permission entries… option
is checked in the Advanced settings.

This allows the Web Client Admin group to create sub folders in the
deploy folder. The deploy folder is where the Vijeo Citect project
files will be located when the project is deployed, as it was in
Exercise - Web Deployment Preparation Tool (page 6-24).
ii. Click OK to save the changes and close the dialog.

6-64 Version 7.20 October 2010

 Exercise - File System Security Configuration
(cont.)

iii. Open the Properties of the #displayclient folder and select the
Security tab.
iv. Select the Web Client View group and tick the Deny » Full Control
check box. This will select Deny for all levels.

 Note:
The Deny setting will override the Allow setting.
v. Click OK to save the settings and close the dialog. A Security
warning will be displayed. Click Yes.

Vijeo Citect Architecture and Manual Release 1 6-65

Redundancy
 Exercise - File System Security Configuration
(cont.)

5 Test that the security settings are performing correctly.

i. Open the Vijeo Citect Web Client from the Windows Start Menu. By
default this will be located in Start » Programs » Citect »
CitectSCADA Web Server » Launch Vijeo Citect Web.
ii. Log in as the user who was added to the Web Client Admin group.

iii. A user with Administrator rights will see a screen that looks like this
(below). Notice that there are six Action icons - four for the
deployment along with the Help and New Deployment icons (these
were discussed in greater detail in the Web Client Home Page
(page 6-28) section).

iv. The status of the current user may also be seen in the System
Messages area, Andrew is described as Admin.
v. Close the Vijeo Citect Web Client.

6-66 Version 7.20 October 2010

 Exercise - File System Security Configuration
(cont.)

6 Test the Control Client User.

i. Reopen the Vijeo Citect Web Client.
ii. Log in as a user in the Web Client Control Group.

This time only three action icons are displayed - this user cannot
access any of the icons related to deployment management.
iii. Successively, select both of the icons for this deployment - confirm
that the user has full control using the Control Client icon and
cannot change any values when using the View Only Client.
iv. Close the Vijeo Citect Web Client.

7 Test the View-only Client User.

i. Reopen the Vijeo Citect Web Client.
ii. Log in as a user in the Web Client Manager Group.

Two action icons are displayed if the user is a Manager - just the
Help and View Only Client icons are available.
iii. Select the View Only Client icon to confirm correct operation.
iv. Close the Vijeo Citect Web Client.

Vijeo Citect Architecture and Manual Release 1 6-67

Redundancy
 Redundant Servers

Web Client As has been previously described, the Web Client can act as a normal Client onto a
Connects to a full Vijeo Citect system.
Redundant
Server Array
In addition, the functionality is correctly extended to a system will full redundancy.

6-68 Version 7.20 October 2010

 Optional Exercise - Build a Redundant Server
Array

1 Construct a Redundant Server Environment

i. With reference to any of the previous chapters, create a fleet of
redundant Alarm, Report, Trend and I/O Servers using the Pulp
project.
ii. On all computers, compile the project with all automated web
deployment parameters still set. This will automatically create a
deployment on the nominated Web Server.
iii. Distribute to all computers, run the Computer Setup Wizard and then
run the project.

2 Confirm proper operation of the project.

i. Using a full Display Client, confirm that proper operation of the
project continues when any of the Servers is disabled.

3 Connect a Web Client.

i. Run Internet Explorer on one or more of the computers and connect
to the Web Server.

ii. Click the Start Control Client icon for the Redundant project to
run the project.

4 Test redundancy.
i. Shut down any or all of the Primary Servers and observe that, just
like the Control Client, the Web Client is unaffected by the disruption.

Vijeo Citect Architecture and Manual Release 1 6-69

Redundancy
 Management of Floating Licenses

How the Clients Extensive tests with floating licenses has found that when a Vijeo Citect Client
Locate a Floating (Web Client and local Client) starts up, it will find a floating license in the
License following order on the connected Vijeo Citect network,

 Search all connected I/O Servers (on start-up, the Client tries to connect all
configured I/O Servers in the project)
 Search all connected Trend, Alarm, and Report services.
- Find Trend service first
- Find Alarm service second
- Find Report service last

Citect.ini Server One of the main features of Vijeo Citect is that the Services (including I/O, Trend,
Settings Alarm and Report) are distributable. To balance loads on all Vijeo Citect services,
each client should have its own citect.ini file in order to get connected with
specified Trend, Alarm and Report services. This preference is determined by the
Server Configuration within the project. For a local client, its citect.ini file can be
local and independent from the servers, and a user is able to modify it as required.

Web Client For a Web client, however its citect.ini is downloaded from the Web Server each
Citect.ini time it starts up. It means all web clients will use the same citect.ini per
deployment. If a different citect.ini is required for a particular web client, a second
deployment needs to be prepared. Doing so actually doubles the maintenance
work. That is, each time a change is made in the project, the web deployment must
be done twice. If there are more web clients using different citect.ini files, more
deployments and more maintenance will be required. For a large scale distributed
Vijeo Citect system, this restriction is not acceptable.

Floating License Distributing the floating licenses amongst the Vijeo Citect Servers will achieve a
Distribution high availability of floating licenses. As a general guideline, floating licenses
should be distributed among I/O Servers. For example, if there are three I/O Servers
and twelve floating licenses to achieve a higher availability of the licenses, four
licenses should be placed on each I/O Server machine instead of six of them on
each of so called Primary and Standby machines. Similarly, some floating licenses
may be placed on the Trend, Alarm or Report Servers. When this is being
configured, keep in mind the search order of floating licenses available on the Vijeo
Citect network.

6-70 Version 7.20 October 2010

 Summary

Summary The following topics have now been addressed:

 System Architecture (page 6-4)

 Internet Information Services - (IIS) (page 6-7)
 Install the Web Server Software (page 6-10)
 Web Server File Structure (page 6-16)
 Security (page 6-46)
 Web Server Security (page 6-47)
 File System Security Configuration (page 6-57)
 Preparing the Vijeo Citect Project for Deployment (page 6-20)
 Web Deployment Preparation Tool (page 6-23)
 Web Client Home Page (page 6-28)
 Web Deployment Page (page 6-26)
 Configure a Deployment (page 6-29)
 Management of Floating Licenses (page 6-70)

Questions The following questions are to check understanding:

 Why use the Vijeo Citect Web Client?

 What are the memory requirements for a Web Server?
 What network communication does the Web client require?
 What is the name of service to assist in publishing information to the
internet/intranet?
 What are the recommendations for installing the Web Server?
 What is the purpose of the virtual directory Vijeo Citect?
 What are the three types of security to be defined?
 What are the three types of user account?
 What is the final step in preparing a project for deployment?
 Who has access to the Web Deployment Page?

Vijeo Citect Architecture and Manual Release 1 6-71

Redundancy
 Chapter 7: System Security

Overview
Introduction
Vijeo Citect has the ability to incorporate Vijeo Citect users and security options
with the standard Windows security system. The Vijeo Citect native security may
still be used if it is preferable to define users in the project and logon to Vijeo Citect
runtime.

The integrated Windows security feature allows the Windows user to logon to
Vijeo Citect runtime with runtime privileges configured within the project.

This Chapter Covers These Topics:

 Server Access Authentication................................................7-2

 Roles ......................................................................................7-4
 Multiple Roles........................................................................7-9
 AutoLoginMode Parameter .................................................7-14
 Multi Signature Support ......................................................7-16
 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 - Configure Servers
for Networking (page 2-14).

 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.

7-2 Version 7.20 October 2010

 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 described in
Assign Windows Groups to Roles.

Vijeo Citect Manual Release 1 7-3

Architecture and
Redundancy
 Roles

Job Type Windows Integrated Security uses Role based security definitions that focus on
Templates the Areas and Permissions of a Job Type rather than the identity of any one
person.

Roles act as templates that define the Areas and Permissions for users who are
included in a linked Windows Group.

7-4 Version 7.20 October 2010

 Roles (cont.)

Assign Windows Domain groups and users are defined or created on the domain server by the
Groups to Roles domain administrator. Local groups and users are defined or created on the local
computer by the local administrator as demonstrated in Exercise - Web Client
Groups and Users (page 6-49). Any of these Windows Groups can be linked to a
Vijeo Citect Role. This means that any Windows User who is a member of that
Windows Group is able to login to Vijeo Citect and they will inherit the
permissions that have been assigned to the Vijeo Citect Role.

 Note:
Each Windows Group may be linked to only one Vijeo Citect Role.

 Note:
A Windows user need not be defined as a Vijeo Citect user. However, if a user is
defined as both a native Vijeo Citect user and a Windows user, the native Vijeo
Citect user will always take priority over a Windows user when logging in at
runtime. In this case, if a valid Vijeo Citect user login fails for some reason, the
Windows user credentials will not be checked and an alert will be generated to
advise that the login was not effective.

The advantage of this type of security model is that it allows for simpler security
management as administrators work with a few roles rather than a multitude of
users. Windows itself serves as a good example of a Role based security model,
where security within the system is managed by assigning membership to the
Administrators, Users, Guests and associated groups.

Vijeo Citect Manual Release 1 7-5

Architecture and
Redundancy
 Roles (cont.)

How to Create a  To create a role:

Role
Open the Project Editor and select System » Roles from the menu. Press the F2
key to open the extended form.

Add the name of the Role and assign a Windows Group name.

See Also:
For further information about Roles, see Vijeo Citect Help - Adding Roles.

7-6 Version 7.20 October 2010

 Exercise - Create a New Role

1 Add a new Role.

i. Open the Project Editor and select System » Roles from the menu.

ii. Type Administrator in the Role Name field and Web Client Admin in
the Windows Group Name field.
iii. Add Global Privileges 1 and 8 in the Global Privilege field.
iv. Click Add. The dialog should look like this:

v. Close the Roles dialog.

Vijeo Citect Manual Release 1 7-7

Architecture and
Redundancy
 Exercise - Create a New Role (cont.)

2 Use Roles to log in to Vijeo Citect.

i. Start the Pulp project and log in as the Web Client Admin user who
was defined in Exercise - Web Client Groups and Users (page 6-
49).

As Vijeo Citect authenticates the user credentials this message will

appear on the screen:

ii. When the user credentials have been authenticated the user name
will appear in the top right corner of the screen.

iii. Open the Woodchip page and change some values. If the values do
not change the user does not have Administrator permissions.
iv. Shutdown the project.

7-8 Version 7.20 October 2010

 Multiple Roles

Combine A Windows User can be linked to multiple Vijeo Citect Roles, with a maximum of
Privileges 256 Roles. When a Windows User who is linked to multiple roles logs into Vijeo
Citect runtime the Vijeo Citect privileges and areas that the User will be assigned
are the combined privileges of the linked Roles.

Example:
Windows User Charlie is a member of the Windows Group SCADA Operator
which is linked to the Vijeo Citect Role Operator. He is also a member of the
Windows Group SCADA Technician which is linked to the Vijeo Citect Role
Technician.

SCADA Role Operator has Privileges P2 and P5 in the Areas A2 and A3.
SCADA Role Technician has Privileges P1 and P3 in the Areas A1 and A4.

If the Windows User Charlie is a member of both Windows Groups, when he logs
into the SCADA system he will inherit the Privileges P2 and P5 in Areas A2 and
A3 as well as Privileges P1 and P3 in Areas A4 and A5.

Vijeo Citect Manual Release 1 7-9

Architecture and
Redundancy
 Multiple Roles (cont.)

A Windows The Windows Groups and Vijeo Citect Roles have a direct one to one relationship.
Domain will This means that one single Windows Group cannot be linked to more than one
Combine Groups Vijeo Citect Role. If a large plant requires different employees to have access only
in specific areas of the plant then separate Groups and Roles must be created and
linked together.

In this situation there may be a group of employees, e.g. Shift Supervisors, who
need Operator access to all areas. If the Windows Security system in the company
is a Workgroup then each Supervisor who should be included in more than one
Operator Group would need to be added into each Operator Group individually.
In a large organisation this can be cumbersome when new employees need to be
added into each of the groups.

7-10 Version 7.20 October 2010

 Multiple Roles (cont.)

A Windows Unlike a Workgroup which only allows individual Users to be added to a Group,
Domain will a Domain Security system will allow whole Groups to be added into other
Combine Groups Groups. This means that if the Windows Security system in the company is a
(cont.) Domain, a Supervisor Group can be created and each of the Supervisors can be
added into that Group.

The Windows Supervisor Group can then be added into each of the individual
Operator Groups. Since the Operator Groups are linked to the Vijeo Citect
Operator Roles each of the Supervisors will have access rights in all of the Vijeo
Citect Operator Roles. This reduces unnecessary replication of work for the
System Administrator.

Vijeo Citect Manual Release 1 7-11

Architecture and
Redundancy
 Exercise - Multiple Roles

1 Create a new Windows Group and Windows User.

i. Create a new Windows Group named SCADA Technician. Use the
steps outlined in Exercise - Web Client Groups and Users (page
6-49).
ii. Create a new Windows User called Tom. Add the User Tom to the
Windows Groups Web Client Admin and SCADA Technician.

2 Create a new Vijeo Citect Role.

i. Open the Project Editor and select System » Roles from the menu.
ii. Create a new Role called Technician with these parameters:

Role Name Technician

Windows Group Name SCADA Technician

Viewable Areas 1

Areas for Priv 1 1

Areas for Priv 2 1

iii. Click Add then close the Roles form.

3 Add Privilege 2 to an object.

i. Return to the Graphics Builder and open the Woodchip page.
ii. Double click the Digester Conveyor button then open the Access
(General) tab.
iii. Untick the No privilege restrictions box then change the Privilege
level: to 2. Click OK.

iv. Save the page and compile the project.

7-12 Version 7.20 October 2010

 Exercise - Multiple Roles (cont.)

4 Test the Privileges of the combined Roles.

i. Run the project and log in to the system as a user in the Web Client
Admin group.
ii. Open the Woodchip page and click the Digester Conveyor button.
The button should not be able to toggle the Digester Conveyor since
the command has a Privilege of 2.
iii. Log out then log in as the user Tom. This user should be able to
toggle the Digester Conveyor because it has inherited Privilege Level
2 from the Technician role.
iv. Select Tools » Admin Tools from the main menu. Click the
Configure Menu link. This link requires the user to have a privilege
level of 8. The user Tom is able to open this link because it has
inherited Privilege Level 8 from the Administrator role.

Vijeo Citect Manual Release 1 7-13

Architecture and
Redundancy
 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

7-14 Version 7.20 October 2010

 Exercise - AutoLogin Feature

1 Set the AutoLogin feature to log in a user automatically.

i. Open the Citect Explorer and select Tools » Computer Setup Editor
from the menu.
ii. Use the Parameter Details section to set the
[Client]AutoLoginMode parameter value to 1. Save the citect.ini
file.

2 Log in as a Windows Group user.

i. Log out of Windows then log in as one of the users in the Web Client
Admin group.
ii. Start the Pulp project. The AutoLogin feature should authenticate
the Web Client Admin group user without the need to log in
separately.
iii. Shutdown the project.

3 Change the AutoLoginMode parameter value to examine the other

modes.

Vijeo Citect Manual Release 1 7-15

Architecture and
Redundancy
 Multi Signature Support

High Level When a Windows user is logged on to a runtime system with the associated
Authorisation privileges and 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 in 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.

7-16 Version 7.20 October 2010

 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.

Vijeo Citect Manual Release 1 7-17

Architecture and
Redundancy
 Exercise - Multisignature Support (cont.)

3 Test the MultiSignature approval.

i. Run the Pulp 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.

7-18 Version 7.20 October 2010

 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.

Vijeo Citect Manual Release 1 7-19

Architecture and
Redundancy
 Summary

Summary The following topics have now been addressed:

 Roles (page 7-4)

 Multiple Roles (page 7-9)
 AutoLoginMode Parameter (page 7-14)
 Multi Signature Support (page 7-16)
 Server-to-Server Authentication (page 7-2)

Questions The following questions are to check understanding:

 What is a Role?
 How are Windows Groups assigned to Roles?
 How many Roles may be assigned to a Windows Group?
 What are the three (3) options for a Server User?

7-20 Version 7.20 October 2010

 Chapter 8: Course Summary

Overview
Introduction
This chapter covers the course summary and the next steps through the Educational
Services curriculum.

This Chapter Covers These Topics:

 Summary - Vijeo Citect Architecture and Redundancy ........8-2

 Course Evaluation..................................................................8-3
 Further Training.....................................................................8-4
 Examinations .........................................................................8-6
 Summary - Vijeo Citect Architecture and Redundancy

8-2 Version 7.20 October 2010

 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 If you have just completed your Vijeo Citect course and would like a certificate to
Evaluation be sent to you please go to this site.

http://www.citect.com/evaluationvjc

You will need your Training Manual Licence Number. The Licence Number is a
watermark in the lower left corner of each page of the manual.

If there is no Licence Number inside the front cover of your manual please contact
Educational Services at [email protected].

Vijeo Citect Architecture and Manual Release 1 8-3

Redundancy
 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.

8-4 Version 7.20 October 2010

 Further Training (cont.)

Course Offerings Citect Educational Services offer the following courses:

 Vijeo Citect Configuration Course: Citect Configuration Environment,

Project Management, Communications, Graphics, Commands & Controls,
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.
 Vijeo Historian 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.

Vijeo Citect Architecture and Manual Release 1 8-5

Redundancy
 Examinations

Certified The CEP program distinguishes and recognizes engineers skilled in the integration
Engineer of Citect based automation projects, and encourages other engineers to move in this
Program 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 Citect website.

8-6 Version 7.20 October 2010