CitectSCADA Basic Configuration v6.0
CitectSCADA Basic Configuration v6.0
Otect
Educational
www.citect.com Services
1
CJtect
Educational
Services
Basic Configuration
Training Manual
Version 6.00
1 3 Fitzsimons Lane
GORDON NSW 2072
PO Box 174
PYMBLE NSW 2073
AUSTRALIA
Telephone: 61 294967300
Fax: 61 294967399
J
DISCLAIMER
Citect 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, Citect Pty. Ltd. reserves the right to revise this publication at any time 1
without incurring an obligation to notify any person of the revision.
1
COPYRIGHT
TRADEMARKS
Citect Pty. Ltd. has made every effort to supply trademark information about company names, products and
1
services mentioned in this manual. Trademarks shown below were derived from various sources.
MS-DOS, Windows, Windows 95, Windows NT, Windows for Workgroups, LAN Manager, Excel and MSMAIL
are trademarks of Microsoft Corporation. 1
DigiBoard, PC/Xi and Com/Xi are trademarks of DigiBoard.
Novell, Netwarc and Netware Lite are registered trademarks of Novell Inc.
General Notice:
Some product names used in this manual are used for identification purposes only and may be trademarks of their
respective companies.
.1
~J
jj January 2005
~ 1
1 Table of Contents
iv January 2005
J
l
1 CHAPTER 12: ALARMS 12-1
Overview 12-1
Configuring Alarms 12-2
Alarm Categories: 12-7
Logging Alarms to a Printer 12-14
Device Groups 12-15
Displaying Alarms 12-16
Alarm Groups 12-20
Audible Alarms 12-24
Using Alarm Properties as Tags 12-26
CHAPTER 13: TRENDS 13-1
Overview 13-1
Trend Tags 13-2
Displaying Trends 13-5
Configuring the Trend Display 13-10
Trend History Files 13-14
Instant Trends 13-15
Displaying Instant Trends 13-18
CHAPTER 14: PROCESS ANALYST 14-1
Overview 14-1
What is the Process Analyst? 14-2
The Process Analyst Active X Control 14-3
Properties of the Process Analyst.. 14-4
Displaying Tags in the Process Analyst.. 14-5
Pen Types 14-6
Displaying Trends 14-8
Changing the Properties of the Process Analyst 14-12
Comparing Trend Data 14-15
Displaying Alarms 14-17
Comparing Trends and Alarms 14-19
CHAPTER 15: NAVIGATION 15-1
Overview 15-1
Menu Configuration Tool 15-2
Custom Page Navigation 15-5
Navigation Parameters 15-9
CHAPTER 16: ACCUMULATORS 16-1
Overview 16-1
Configuring an Accumulator 16-2
Accumulator Parameters 16-5
CHAPTER 17: REPORTS 17-1
Overview 17-1
Defining a Report 17-2
Viewing Reports 17-5
J
. _J
vi January 2005
J
Chapter 1: Introduction to CitectHMl/SCADA
Overview
. 1
Before You Begin
1
Your Instructor Please write the name of your Instructor here rff>
}
Your Instructor will be spending the next three days with you, and will guide
you through this training course. Your Instructor is an experienced 1
CitectHMI/SCADA user so please feel free to ask questions.
t
Defining the This training manual is a supplement to Citect Certified Training. In order to
Scope of this make full use of the software you should also reference the Online Help and
Training J
CitectSCADA Knowledge Base.
Manual
The graphics displaying screen shots have been taken using the Windows XP
operating system. If you are running a different version of Windows then
I
your screens may differ slightly from the ones shown in the training manual.
I
I
I
I
}
Course Please take a few moments to have a look through your Training Pack. In
Material addition to this manual, you will fmd the following items:
~ Citect Compendium
~ Citect Mouse Pad
~ Pen
~ Notepad
~ 3Y2 inch floppy disk
~ The current version of Plant2Business on CD Rom
) ~ The current version of CitectHMIISCADA on CD Rom
Dav Topics 1
1 ~ Introduction to CitectHMI/SCADA
~ The Citect Explorer, Citect Project Editor, Citect Graphics
Builder and the Cicode Editor
I
~ Managing Projects
1
~ The Design Specification
~ Setting up communications I
~ Graphics
2 ~ Commands and Controls 1
~ Genies
}
~ Super Genies
~ Devices
~ Events
t
~ Alarms
~ Trends
~ Process Analyst
3 ~ Navigation
~ Accumulators
~ Reports
~ Security
~ Networking CitectSCADA
~ Introduction to Cicode ( optional)
~ Multi-language projects ( optional)
~ Troubleshooting
Objectives These are the skills you will achieve 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·
~ Know Topic A
~ Understand Topic B
~ Be able to complete Topic C
Exercises After a concept is explained you will be given exercises that practise the skills
you just learned. These exercises begin by explaining the general concept of
each exercise and then step-by-step procedures are listed to guide you through
each procedure.
Example-
Exercise 3-1 Paste a genie from a library in the Include project onto a test page called Utility.
Step Action
1 Run the Milk_Treatment project then trigger and view some
alarms.
i. Use the following template settings:
I Hints and Tips This heading will provide you with useful or helpful information that will
make configuring your project easier
I Example-
J
} Continued on next page
Whenever you are required to type information into a field or dialog box it
will be written in this font
Example-
KETTLE_TEMP/25
See Also Text written in this way indicates further references about the current topic.
Example-
See Also:
For further information about Templates, see CitectSCADA Help - Using Page
Templates. I
I
1
1-6 January 2005
1
Chapter 2: Citect Configuration Environment
, } Overview
~ 1
Introduction The Citect Configuration Environment consists of four separate programs.
1 The programs are the Citect Explorer, the Citect Project Editor, the Citect
Graphics Builder and the Cicode Editor.
I
Contents In this chapter you willleam:
I
j
L }
LJ
)
System Requirements
Overview Before you install CitectSCADA Version 6.0 you will need to ensure that
your system meets the minimum hardware and software requirements.
Note: If you are using the Process Analyst, we recommend that you use a
graphics card with at least 64MB ofVRAM and do not share
VRAM with main memory.
1
Software CitectSCADA Version 6.0 runs on:
1 Requirements
~ Windows XP Service Pack 1
~ Windows 2000 Service Pack 3
~ Windows NT 4.0 Service Pack 6
~ Windows NT Server (Enterprise Edition Service Pack 5 and Terminal
Server Service Pack 6).
~ Windows 2003 Server support is expected to work but is not yet fully
tested.
Note: The Process Analyst and the CitectSCADA Web Server do not run
on Windows NT. Also, you must use Internet Explorer version 6.0
or above if using the Process Analyst, CitectSCADA Web Client,
or CitectSCADA Web Server.
I _ J
~~~ ]
~J
~)
Explorer
Screen
J ~Projects .
t':, .tJ CSV_Example y ~l~ ~ ~
:.,..:>
....
f!':~~ PaQeS Temo!ol;es Symbols Genies Super Genies
. iCJ Alarms
!.::.J System
. to Communications
: ;cJ Cicode Files
tj CitectVBA Fi~s
if 5 CSV)nclude
Etr .5 Ex~mple
It.!' ~El Include
I
When you start Citect Explorer, the Project Editor and Graphics Builder .I
automatically start and are minimised. When you close Citect Explorer, the
other CitectSCADA applications are shut down.
See Also:
For more information about the Citect Explorer select the menu
Help I gxplorer Help.
1 Include Projects
Overview The Include projects are installed when CitectHMI/SCADA is installed and
contain pre-defined elements that can be used in your CitectHMIISCADA
projects. There are two Include projects installed with CitectHMIISCADA
Version 6.00. These are the Include project and the CSV_Include Project.
~~~. Z~--,~::,~"-:~--"~:~~-
·'21 Tags
.~ Alarms
System
Communications
Cicode Files Super GenIes
, CitectvBA Ales
:t.J ~ CSV_Include
&'; ::1 Example
itJ ~ loclude
Elements of the The Include Project contains the original pre-defined elements from
Include CitectHMIISCADA prior to Version 5.50. These elements include keyboard
Projects key definitions, font definitions, genies, super genies and symbol libraries.
The CSV_Include Project is a preconfigured project that is installed with
CitectHMIISCADA Version 5.50 or later. The CSV_Include Project provides
an updated set of these elements that can be used to create new projects based
on the Windows XP style.
You can choose to view or hide the Include projects in your Project List by
toggling the ~jew I Show !nclude Project menu.
Overview The Citect Project Editor is used to create and manage the CitectSCADA
databases. These databases contain the configuration information for your 1
CitectSCADA project, which is not related to graphics pages. You can view
all CitectSCADA project database records in the Citect Project Editor. 1
Opening the The Project Editor is started when Citect Explorer is started.
Project Editor
;1,'tCitect Project Editor [ CSV_EKample ] - COMPILED I!!!II!I EJ
EOe ~dit' rails eliltrllS :}.vstern ~ommul1ication Tools Y![lndol.'l tielp
-····_····_·,-
····"--r·····-·~""···_· __·····-········.- ,.,._ ~'~ .., ,.,~ ...,., , -,·,·,·,·,·..
·,···~_·l·,·,·,·,·,·~--,·,·'· ..·..r·I-·'-···,, ", ,.. u , _ _ •• •••• _
~~~~~~~ .
See Also:
For more information about the Citect Project Editor select the menu
!:!elp I Project Editor Help.
Overview The Citect Graphics Builder is used to create and edit graphics pages,
I including the objects that comprise the graphics pages.
1 Opening the The Citect Graphics Builder is started when Citect Explorer is started.
Graphics
Builder .,f. C,teet GraphICS BUIlder I!I~ f3
Eile ~ ~ Qbjects I&Xt &r~ Toc!s !'llndow I:feIp
-~. £11 .,nDI ~Li')I8iI~1 'QI~I};JI .¥.J~11ii~-,;rrf;rj>j~r~F~r~r--··--"-··-··--·-£B·-
DO
Gff
A #41
O~.
~ fix)
iii
J1:i OltO l-b 962.135 l-'Il r f:il
~ meet.Graphics Builder
See Also:
For more information about the Citect Graphics Builder select the menu
Help I Graphics Builder Help.
Overview The Cicode Editor is used to write and edit your Cicode programs. The
Cicode Editor may also be used as a debugger at runtime to help you trace 1
through your running Cicode and track down programming errors. You can
also debug your Cicode programs from a remote computer. Within the Cicode
Editor window, you can get help for any Cicode function. Right-click the
1
function name and choose Help from the menu.
Starting the Unlike the other programs the Cicode Editor is not started with the Citect
Cicode Editor Explorer.
Flies 'oS.!!
f!.J'N":TIC'N
$ :iJ CSV_Example OpenRecipe( )
i[} Activex. ci
~ ~mt5.CI IF hRecipe < D THEN
, 'i'\~: CSV_Exemple, cj
ire EXAMPlE,C)
// :::a:~.NGE~ 1.L:H.:: ~.'·l)\ti: (pn:: !:-:;::.:ipe 1l00'0e lH~t:'eJ fr'()~t: de:·/lce '.;l.£\.~,ai')~e
hRecipe .- C'ev;)pen( '~;:.,>~,:c:. ~.Jn~.'. ");
:~;c Logns.cI
IF hRecip~ >- U THEN
~ Mmedie,cl DacabaseToMemory();
l\:?J REOPE.Cl ELSE
\© Semple,CI
~ smoIetr.d £WD
~ TRENOARC.O OlC·
il~F=ila ---lI~'L""'''.LC1E"",•••~I t
i.~ tIl
Ready
Exercise 2-1 Look at the CSV_Example project that comes with CitectHMIISCADA and
get used to navigating between the four applications that are a part of
CitectHMIISCADA.
I Step Action
1 Start the Citect Explorer.
1 i. From the Windows Start menu, select frograms I Citect I
Citect Explorer.
2 Select the Example project and look at its contents.
i. In the Citect Explorer, click on the CSV_Example project icon
in the Project List to select it as the active project.
ii. Click on the "+" symbol next to the icon to expand the project
folder list and navigate through the components of the project.
3 Click on the icons t1i,
.-.t{., ltJ,iil,
to switch to the applications
that are a part of CitectHMI/SCADA.
4 In the Citect Explorer, select the Tools menu and switch to the
other CitectHMI/SCADA applications from there.
5 Run the CSV_Example project.
i. In the Citect Explorer, select the CSV_Example project.
ii. Click on the Run Project button g on the tool bar to run the
project.
ii i. Navigate through the project by clicking on buttons to change
pages.
iv. When finished, click on the Close button ill to shutdown the
project when finished.
.I
I
I
J
2·10 January 2005
I
Chapter 3: Managing Projects
Overview
Introduction The Citect Explorer is the application from which you organise your projects
and launch the configuration and run-time applications. Fundamental tasks
such as creating, deleting, backing up and restoring projects are all performed
in the Citect Explorer.
r-~~J
Topic See Pa2e
L... Creating a New Project 3-2
~ Computer Setup Wizard 3-5
» Backing Up, Restoring and Deleting a Project 3-9
Including Projects 3-13
l J
[J
Creating a New Project
or
right-click on any icon in the Project List and select New Project. ..
!CSV_EKample ::OJ ~ ~ ~ ~ ~ ~ ~ ~
"'1P=fQ1='e=ct=Us=t================ ~Contents of My Projects
I'----.-:-----"-'-::::i:----=-------:::----I
~
gcsv Ex:
Run
.
I 51 CSV =ln~.'.4i§@5 ~ computer csv_example Include example
l±i ,ffi ExamplE Delete Projed ~ Setup
l±I B Include
copy Project To...
AM Project link. ..
!?emd,ye Project link csv_IncJude
Backup ..
Restor,e .
fltojeet Properties
,fOeates a ne<'l<ptoject
) New Project E3
, Name:
DesCliption:
I LOC<!ltlon: IC:\PIOgtam FiJes\Citecl\Cilect
Pagedeleults--·-----------.
Template $lyle:
Background colour. ~
I However, there are times when XP Style should not be used. These are if you
need:
, )
~ SPC templates
I ~ Language Switching
~ Screen resolutions other than 1024*768
J
Continued on next page
Ste Action
1 Open the Citect Explorer, click on the New button : ~ 1
2 The following dialog will appear:
New Project E!
D~CljPlior.;
I leanpal I I]
- - - - - " - - .. _-_.-_
OK. lielp
... _ . , .. _._~" .. _~
yr Hints &Tips:
To go to the next field, use the mouse cursor or press the TAB key.
To go back one field press SHIFT·TAB
Overview The Computer Setup Wizard allows you to quickly setup and customise your
computer for use with CitectHMI/SCADA. The Computer Setup Wizard
should be used at least once every time a new project is selected in the Citect
Explorer.
The computer being setup can either run the entire CitectHMIISCADA
project or it can be part of a network and run part of the project:
Role Description
Stand-alone The computer is to function as a stand-alone Server and
Display Client.
Network The computer is to function as either a -
~ Server and Display Client
~ Display Client
~ Manager Client
I
I
J
I I
Exercise 3-2 Run the Citect Computer Setup Wizard to set up your Milk Treatment
project.
Ste Action
1 Open the Citect Explorer, click on the Computer Setup!!
button on the toolbar.
The following dialog will appear: 1
Cited Computer Setup Wizard I!liJ J3
Otect
(jtectt~~1
r Custom Setup
2 Choose Express Setup and then click Next >. The dialog below
will be shown:
r M~erCIier'll,
4 Select the project to use from the drop-down list in the froject
Name: field and then click Next >. The following dialog will
appear:
Cancel Help
1
Exercise 3-2 (continued)
Ste Action
5 Click Finish to save all changes and exit the Citect Computer Setup
Wizard. 1
Citect Computer Setup l!!loo EJ
CitectSCAD
OtectH
or
I
select the menu Iools I !!ackup...
or
Note: By default, backup files are given the extension .CTZ ifno
extension is specified. These files are in a standard zip format. This
means that any zip extraction tool may be used to open the file.
J How to- When a project is deleted in the Citect Explorer, all of the associated files and
Deleting a the project directory are permanently removed.
Project
~ To delete a project:
I In the Citect Explorer, click on the project in the Project List that you want to
delete, then either select the menu file I Qelete Project
I or
J right-click on the project icon and select Delete Project from the context
menu.
J
Basic Configuration Manual Revision 3 3-9
I
Backing Up, Restoring and Deleting a Project, Continued
1
Exercise 3-3 Backup, delete and restore the Milk_Treatment project.
Ste Action
1 Backup the Milk_Treatment Project
i. Open the Citect Explorer and select the Milk_Treatment
project icon in the Project List.
F4"l
ii. Click on the Backup button ..uJ. The following dialog will
appear.
Backup Project
Backl:lp \0
Bai:kup file;
1
IMilk_Tlea(menl.c12 !!rowse.•.
rOpliOns
P' Use j;<ompression r Use ~ncl9ptioo
r ~ave·compjled r S..ve,wslem jiIes
r Save .sub1Jrec.torie!
OK Cancel I _...;.J:l.;...eI.;..p_
iii. Add a path for the file location by either typing it in front of the
filename or by using the Browse button to select a location.
Click OK to continue.
Ste Action
2 Delete the Milk_Treatment project.
i. In the Citect Explorer, click on the Milk_Treatment project
icon in the Project List to select it.
ii. Select the menu file I Qelete Project. The following warning
dialog will appear:
Delete Project £I
,.
!, All your data wal be lost and cannot be recovered I
• Are you sure you want to delete the project 'Example'?
Backup Project
Overview With large systems, it might be more convenient to develop the application
using a series of smaller projects, instead of one large project. For example,
you could use a separate project for each section of the plant, or for each main
process. This way, you can develop and test each of the smaller projects
before including them in the main project.
CitectSCADA projects will not be included into the compile of any other
project unless they have specifically been included into that project from
within the Citect Project Editor.
1 Each CitectSCADA system is supplied with two include projects. These
projects contain pre-defined database records. The Include project is
I automatically included in each of your projects. The CSV_Include project is
only included in projects that are based on the XP_Style.
or Included
Projects:
open the Citect Project Editor and select the menu §ystem I
!ncluded Projects. Then complete the Included Projects form that appears.
PJojecl Name I j
Convnent I
I Add ] t fleplace I Qelele
I l:!elp
I
RecoId:
.:J
I
J
Basic Configuration Manual Revision 3 3-13
J
Including Projects, Continued
I
1
Exercise 3-4 Include the project CES_Include in your Milk_Treatment project.
1
Step Action
1 Restore the CES_lnclude project.
i. Your Instructor will provide you with a project backup file
I
called CES_lnclude. Restore the project following the steps
in Exercise 3-3.
2 Include the project CES_lnclude in your Milk_Treatment project.
i. Select the Milk_Treatment project in the Citect Explorer
project list.
Ii. Open the Citect Project Editor.
iii. Choose §.ystem I !ncluded Projects from the menu.
iv. You will see that the project CSV_Include is already listed.
Type CES_lnclude in the Project Name field and click the
Add button.
J
J
.j
3-14 January 2005
rl
C~apter 4: Design Specification
Overview
Introduction The first and perhaps the most important step in any project development is
planning. Good planning ensures that your runtime application is designed
and implemented efficiently and that it achieves the best possible
performance. It also assists with the commissioning and testing of your
application. Poor planning often results in substantial redesign or poor
performance, or both.
r~]
l.
Contents This chapter contains the following topics:
lJ
1
.J
,~l
[J
The Value of Good Design
Overview The most successful applications are those that are planned well. Professional
developers use up to 50% of the total project time in planning. While this
may seem excessive, good planning ensures that the configuration and testing
of the application is kept to the remaining 50% of the total time - not the
200% or 300% that usually results from an unplanned or badly planned
project.
By planning the total project before you begin configuring, you can
standardise the operator interface - how the application is displayed on the
screen, how operators use it, and its scope and purpose. Once you have a
plan, CitectHMI/SCADA's flexibility will actually reduce your development
time - the lack of restrictions allows you to configure your application exactly
to suit your plan.
Your course notes include a specification (for the application you will build in
this training course) that you can use as a template for your own projects.
> Declare the objectives, scope, and purpose of the application - the areas
of your plant the application covers and what it is meant to achieve.
> Allocate resources. Once you have a clear definition of the project, you
can estimate more accurately the amount of time required to configure and
test the application.
> Express your design ideas and concepts. A specification allows others
involved in the project (management, operators, other engineers, etc.) to
understand and contribute to the design of the proj ect.
> Allow two or more developers to work on the same project. A
specification allows you to allocate separate parts of the project to
individual developers, yet maintain consistency in the final application.
I
J
I
Operator Interface System
1
~
Design Specification I
1
}
Citect Pty. Ltd. January 25, 2005
3 Fitzsimons Lane 1
GORDON NSW 2072
PO Box 174
PYMBLE NSW 2073 }
AUSTRALIA
Telephone: 61294967300
Fax: 61294967399 J
.I
l
Continued on next page
J
4-4 January 2005
J
Sample Design Specification, Continued
1
Overview This document is the design specification for the Operator Interface System
1 (GIS) at the Citect United Dairy.
Step Action
1 The raw milk is stored in silos for at least one to two hours before
being processed as natural degassing of the milk takes place.
2 The milk is then fed into a balance tank. As the pasteuriser must
be full at all times to prevent the product from burning onto the
plates, the balance tank is fitted with a low-level electrode which
transmits a signal as soon as the level reaches the minimum point.
This signal actuates the Flow Diversion Valve, which returns the
product to the balance tank.
3 The Flow Controller maintains the flow through the pasteuriser at
the correct value. This guarantees stable temperature control and a
constant length of the holding time for the required pasteurisation
effect.
4 The cold untreated milk is pumped through the first section of the
pasteuriser, the preheating section. Here it is regeneratively heated
with the pasteurised milk, which is cooled at the same time.
5 The milk is pumped into the Centrifugal Clarifier where the milk
is separated from the cream and solids. The solids are ejected
whilst cream is fed through another pipe.
6 The skimmed milk then flows into the Alfast™ tank where cream
is reintroduced to create a given fat content for the type of milk
that is being produced. Surplus cream is then diverted to another
line.
7 The milk flows into the HomogeniseI' where the fat globules are
disrupted into much smaller ones.
8 Final heating to pasteurisation temperature with hot water,
normally of a temperature 2-3°C higher than the pasteurisation
temperature, takes place in the heating section. The hot milk
continues to an external tubular holding cell.
9 After the holding section the milk is returned to the regenerative
section for cooling. Here the pasteurised milk gives up its heat to
the cold incoming milk.
10 The outgoing milk is then chilled with cool water, ice water, a
glycol solution or some other refrigerant.
11 The final product is then sent to the Vats.
The application will be operated through the keyboard and mouse located at I
the CitectHMIISCADA server. CitectHMIISCADA runs in the Windows
environment, and uses the features of the Windows Graphical User
Interface-graphics screens (pages), buttons, and an arrow-shaped cursor that 1
is moved by the mouse.
I
I
I
I
I
I
I
j
I
1
J
4-6 January 2005
I
Process Control Hardware and Communications
Overview The pasteurising process will be controlled and monitored by the GIS on a
single computer, through a single PLC.
Hardware Description
Field The CitectHMIISCADA server will interface with the plant
through the following hardware:
~ Omron cn PLC.
Computer The CitectHMIISCADA server hardware will be as follows:
~ Minimum: Pentium 500, 128Mb RAM
.1
Recommended: Pentium IGHz, 512Mb RAM
~ SVGA Colour Monitor
~ Windows supported VGA graphics adaptor card
(1024x768, True colour), 64Mb RAM
~ Standard 101 Keyboard
~ Standard RS-232 Communication Port
LJ
Basic Configuration Manual Revision 3 4-7
•j
)
R8232 tabl,e
(supplied by manufaeturef) ~~c-.
, .
J
"~-'l
OMRON CJ1
PLC
1
To plant equipment
)
Hardware Communication between the CitectHMIISCADA server and the PLC will be )
Connections as follows:
~ RS232 cable, with:
9-pin D connector on the computer side )
RS-232 to RS-422 converter on the PLC side
}
Communica- The CitectHMIISCADA software will be configured to communicate with the
tion with the PLC using the OMRON communication protocol. I
PLC
)
)
I
)
}
4-8 January 2005
}
Process Data
Overview The variables from the dairy process (in the pasteurisation area) are listed in
column (1) of the Process Data table.
PLC Variables The OIS will read and write process variables in the PLC registers to control
and monitor the pasteurisation area. Column (2) in the Process Data table
shows the data type for each process variable, with its PLC address and
read/write status.
Display of Column (5) of the Process Data table shows how each variable will be
Variables displayed.
\ J
I
I
j
j
Basic Configuration Manual Revision 3 4-9
J
f'
~
o Process Data Table
(I) Process Variables (2) Storage in PLC Registers (3) Citect Tags (4) Ranges/Displayed Values (5) Displayed As
Silo Level ~ontrol INT MilkDevl DM! rfw LIC_Silo_PV 0 32767 0 1000 Lt Numeric + Bar Graph + Periodic Trend
Balance Tank Level Control INT MilkDevl DM2 rfw LIC_Balanee]V 0 32767 0 100 Lt Numeric + Bar Graph + Periodic Trcnd
Centrifugal Clarifier Speed Control INT MilkDevl DM3 r/w SIC_Cent]V 0 32767 0 1000 RPM Numeric + Periodic Trend
Homogeniser Pressure k:;ontrol INT !MilkDevl DM4 rfw PIC_HomOLPV 0 32767 0 100 kPa Numeric + Periodic Trend
Coolant Temp Control INT MilkDevl DM5 r/w TIC_Cool_PV 0 32767 -10 120 deg Numeric + Periodic Trcnd
Preheat 1 Monitoring INT !MilkDevl DM6 r ;nC]l]V 0 32767 -10 120 deg Numeric + Periodic Trcnd
Preheat 2 Monitoring INT MilkDevl DM7 r TIC_P2]V 0 32767 -10 120 deg Numeric + Periodic Trend
Preheat 3 Monitoring INT ~ilkDevl DMS r TIC]3]V 0 32767 -10 120 deg Numcric + Pcriodic Trend
Prcheat 4 Monitoring INT lMilkDevl DM9 r T1C]4_PV 0 32767 -10 120 deg Numeric + Periodic Trend
Hot Water Temp Monitoring INT MilkDevl DMIO r IC_HW_PV 0 32767 -10 120 dcg Numeric + Pcriodic Trcnd
Holding Tubc Temp Monitoring INT MilkDcvl DMII r IC_Hold_PV 0 32767 -10 120 deg lNumeric + Bar Graph + Periodic Trend
~ilo Agitator Status Monitoring DIGITAL MilkDcvl ~96000 r Agitator_Silo_V Symbol Set
!Alfast Agitator Status Monitoring DIGITAL MilkDcvl ~96001 r Agitator_Alfast_V ~ymbol Sct
Centrifugal Clarifier Status Monitoring DIGITAL MilkDcvl ~96002 r Centrifuge_Clar_V Symbol Sct
Fecd Pump ~ontrol DIGITAL MilkDevl ~96101 r/w Irump]ccd_CMD Symbol Set
~oolant Valvc ~ontrol DIGITAL MilkDcvl ~96102 rfw lvalve_Cool_CMD Symbol Set
C-
W
:::J
Hot Water Valve ~ontrol DIGITAL MilkDevl 1296103 rfw Valve_HW_CMD ~ymbol Set
c:
W
o.<! Flow Diversion Valve ~ontrol DIGITAL MilkDevl 1296104 r/w Valve]low_CMD Symbol Set
IV
o
o
VI ~entrifugal Clarifier Runtime Control INT MilkDevl DMll rfw CENT_RT Symbol Set
iCentrifugal Clarifier Starts iControl INT MilkDevl DMI2 r/w CENT_ST Numeric
* M~'e: Oll.-nu PLC A,!-I·n~ses a.r - M follow- "M# - lu' "'2r ]Ol;n+! -Inr" r'1i1 In<,io{ ~ Ou'--" ~oil
---'
r/'l
I"
Data Files
r'l
Data Files The following files will be maintained by CitectHMIISCADA:
~ "1 ~ History files, maintained on a rotational basis. A series of 2 history files
will be kept for each variable to be logged for trend analysis. Files that
1 need to be archived will be backed up by using the Windows Explorer.
~ Alarm log, an ASCII file that records each configured alarm.
1 ~ Alarm summary, a dBASE file that summarises alarms.
~ Report log, an RTF file that is written each time the report is run.
~J
,j
__J
: J
~J
~-
.- ',",
-:.....-~-~---.-~ .
--...-.....-""---.-
- ~-, ....
--~ . -
_-,.~.~,_
-. .. -
I
Graphics Pages 1
1
Overview The OIS, and all the processes it monitors and controls, will be presented to
operators through CitectHMI/SCADA screens (called graphics pages). 1
Operators will navigate through graphics pages by using the keyboard and
mouse. I
Navigation The navigation menus will feature items to: 1
Menus
~ Display the graphic page representing the dairy process and its variables.
~ Display the Utility and Test pages. I
~ Display the alarm pages.
. J
~ Display the trend page.
~ Display the Process Analyst
~ Generate and display a report.
I
~ Log in, log out, and shut down the OIS. 1
]
Test Page A test page will be configured to test the communications and other processes
during the configuration of the application.
I
I
I
1
I
J
4-12 January 2005
)
1 Graphics Pages, Continued
I
Pasteurisation A flow diagram of the pasteurisation area will be displayed
I Area CitectHMIISCADA, on a graphics page called Pasteuriser.
III
Vats
Milk Silo
_EU
-:
Normal
_EIJ
~
Homogeniser
_EU
Objects on the Pasteurisation page will represent the items of equipment that
are to be controlled and monitored. The Pasteurisation page will reflect the
true plant configuration, so operators will recognise the layout of the plant.
Each object will be labelled with its common name and tagged with its
process variable and will display changes in the variable. Text, numbers,
symbol sets, and colour floods will reflect the changing conditions in the
processes. The appearance of an object will change when its process variable
changes. (See the Process Data table for the list of variables, with their tags
and graphical object types.)
Commands will be activated from this page to switch valves and pumps ON
or OFF, change the recipe, and display other pages.
Utility Page The Utility page will contain some tools that will allow maintenance of the
system security database as well as some tools to access some high level
CitectHMIISCADA functions during the system's development.
1
Alarm Pages Equipment that often has fault conditions will trigger alarms, for example,
when the temperature sensors show high or low levels, and when the feed 1
pump has been turned off. Alarms will be displayed on a separate alarms
page, and an alarm summary page will display a summary of all alarms.
Operators will use commands on the alarms pages to handle alarms.
1
Hardware alarms (faults within the OIS itself) will be reported on a hardware
alarm page. 1
All alarm pages will be displayed from the navigation menu.
t
Function
Hardware The Hardware button will display all hardware alarms 1
(faults within the OIS) on the Hardware Alarms page.
These alarms will be handled directly from }
CitectHMIISCADA, needing no configuration.
Alarm Configured alarms will be logged to an ASCII file and
displayed on the default Alarms page, displayed by I
selecting the Alarm button on the menu page. To
acknowledge an alarm, operators will select the alarm
and click the left mouse button or press the Enter key.
I
To acknowledge all alarms, operators will select the
Alarm Ack button. (Only authorised operators will have I
the privilege to acknowledge alarms.)
An alarm changes colour when it is acknowledged, but
remains displayed on the Alarms page until it is reset.
I
Each alarm is identified by its name, current state, the
time it changed state, and (for analog alarms) the current I
value of the analog variable.
Summary A summary of alarms will be logged to a dBASE file )
and displayed on the Alarm Summary page, displayed by
selecting the Alarm Summary button on the menu page.
An alarm is logged to the alarm summary when it is
I
activated, and when it remains displayed for longer than
I hour. Each alarm is summarised by its name, current j
state, the time it changed state, and the time taken to
return it to its normal state.
}
Trend Pages A trend graph will display changes in temperature of the pre heating
chambers and the holding tube. Trends will be displayed in real time on a
separate trends page, but the variables will be logged continuously, so that
operators will be able to view past trends as well as current trends.
Variables that are to be analysed will be assigned trend tags and logged in
history files. These variables will be displayed on graphical trend pages,
displayed by selecting the Trend pages in the Trend menu. Each variable is
represented by a line (called a pen) in the trend window plotted against time.
Operators can position a slidewire cursor at a selected time to display the
value of a pen at that time. Operators can scroll horizontally across the trend
graph by using trend control buttons.
Process Analyst Trends and Alarms will be displayed in the Process Analyst. The Process
Page analyst offers a more intuitive view of trends and alarm tags than the old style
trend and alarm pages.
Report Pages A single report will be run on operator request, logging the position of the hot
water valve, and the temperature of the holding tube. The logged report will
be displayed on request.
I
J
I
Basic Configuration Manual Revision 3 4-15
J
1
Operator Commands
1
Overview Operators will activate CitectHMI/SCADA commands from both keyboard
function keys and command buttons drawn on the graphics pages. I
Commands that will be needed from any page will be configured as system
keyboard commands. Commands local to a page will be configured as page 1
keyboard commands, activated either from function keys or from buttons
drawn on the page. Operators will activate buttons by positioning the mouse
pointer on the button and either clicking the mouse button or pressing the
Enter key on the keyboard.
I
System The following key will be configured as a system keyboard command that can
Keyboard be activated from any page:
Commands 1
Key Name
Shutdown
Keyboard Key
END
Description
Shutdown
i
CitectHMIISCADA
Home ESC Display the home I
page
1
Page Keyboard The following key will be configured as a page-wide command, to be
Commands activated only from the Pasteurisation page: I
Key Name
Info
Keyboard Key
CTRL
Description
Displays Object
I
Information
I
I
I
J
4-16 January 2005
)
Operator Commands, Continued
Operators will alter the values of the variables from the Pasteurisation
graphics page as follows:
~ Place the cursor over the value.
~ Type in the new value (####) and press the Enter key.
Operators will manually switch the valves ON or OFF from the Pasteurisation
graphics page as follows:
~ Place the cursor over the valve.
. J
I
Touch The feed pump, coolant valve, hot water valve and flow diversion valve, will
Commands be configured with buttons: I
Variable Mouse Button Description
Feed Pump left (up) Toggle Feed Pump
1
Coolant Valve left (up) Toggle Coolant Valve
Hot Water Valve left (up) Toggle Hot Water Valve
1
Flow Diversion Valve left (up) Toggle Flow Diversion Valve
1
Operators will manually switch the valves and pump ON or OFF from the
Pasteurisation page as follows:
).> Place the cursor over the button associated with the pump.
).> Click the left mouse button.
Slider Controls A slider will be drawn on the Pasteurisation graphics page to alter the levels
of the Milk Silo, the Balance Tank and the Holding Tube Temperature.
I
I
I
I
I
I
I
I
j
J
4-18 January 2005
)
1
1 Operator Notification
I
Alarms The OIS will detect analog and digital alarms.
I
I Analog Alarms An Analog alarm will be triggered depending on the value of the variable:
Variable Setpoint High High High Low Low Low Deviation Dead Band
Holding Tube Temperature 73 85 80 65 60 3 2
Reports A report will be produced on the status of the Holding Tube Temp and the
Hot Water valve, using the following variables:
~ TIC Hold PV
- -
~ Valve HW CMD
I
I
I
I
1
Basic Configuration Manual Revision 3 4-19
I
Security I
1
Overview Process data will be secured against unauthorised use by the use of passwords
and user privileges. Users will be classified as either operators or engineers, I
with access to a subset of commands.
I
Levels The GIS will use passwords to ensure security in the application. The levels
of security are as follows: I
Level Description
1 The CitectHMIISCADA application will start up this level. Only
1
the Password button can be executed.
2 The operator will enter a password to reach Level Two, from J
which all plant monitoring, operations, and alarm acknowledgment
functions will be available.
3 The supervisor's password will be entered to attain this level, from I
which system commands will be available.
1
Areas The plant will also be split into two distinct areas:
I
Area Description
1 Main plant operation. This gives the user access to the Menu page
and all pasteurisation and alarm pages.
I
2 Test area. This reserves areas for testing and administrative
operations such as creating new users. J
Communications
Cable
~
!f ....................."'----"-
Inputs ~
~I.....I...u...I.r-- ___
Outputs
1
Overview The Express Communications Wizard enables you to quickly set up
communication with a new or existing I/O Device. I
Each CitectHMI/SCADA project will need to have at least one I/O Server
defined for it to communicate to I/O Devices. Each I/O Device will need to
be set up in CitectHMI/SCADA with an appropriate communications protocol
and settings and any interface boards and communications ports in the
computer will also have to be defined.
or
Go to the Citect Project Editor and select the menu Communication I Express
Wizard
Exercise 5-1 Set up communications for the Milk_Treatment project to the type of 1/0
Device you will be using for this training course.
Ste Action
1 Open the Citect Explorer and select the Milk_Treatment project.
2 Go to the Citect Project Editor by clicking the Project Editor
CJ~t.ec tc:··~
,,:J'( DA···.'
atectH
1
Exercise 5-1 (continued)
Ste Action
4 Use the Express Communications Wizard to set up your I/O
Device.
i. This dialog allows you to create and name your new I/O
Server. Give the new I/O Server the name Milk. Click !:!ext >
to continue.
Cancel Help
~_~_. _ _ , _ , " , _ "_ _• • •_ . _ , , , _ , _ , •• M _ _ • •_ _ • • • _ _
ii. This dialog allows you to create a new I/O Device or edit an
existing I/O Device. Select ~reate a new I/O Device and name
the device MilkDev1 then click !:!ext > to continue.
<iaok Help
"I
J
1
Exercise 5-1 (continued)
Ste Action
4 iii. This dialog allows you to select the I/O Device type. If your
(cant.) training PC is connected to an I/O Device, then select External
I/O Device, otherwise select Disk I/O Device. If in doubt, your
instructor will tell you what type of device to create.
.......~
..,., r Memory I/O Device
Disk I/O Device data is stored in a file on the hard disk, at a specified
location. If CitectHMI/SCADA is restarted then the data is still
available. Disk I/O Device data can also be shared across a network
with other CitectSCADA computers. Memory I/O Device data is lost
when CitectHMI/SCADA is restarted.
J'
the,1I0 Device· i±i-IDSC
Selecteddri\(eJ~''''''-----------'----'----
Marnlach:llel: Omron
ModSl' CS1 Series PLC:s,
. eo~tlaUom; Selie! (S.y.IIMc·W,ey protocol) _. . _
1
<~aclt H,tlllt) Cancel Help
Ste Action
4 vi. The next dialog will appear if you are connected to a serial
(cont.) device and allows you to setup a modem connection to your
I/O Device. We will not be using this feature in the training
course. Click Mext > to continue.
Help
vii. This dialog allow you to enter the com port for your serial
device. Select the correct com port. If you are unsure which is
the correct port ask your instructor. Click Mext > to continue.
1
Exercise 5-1 (continued)
Ste Action
4 viii. The next dialog box allows you to link to an external database
(cont.) containing variable tag information. The link can be to a static
file or it may take advantage of Microsoft's COM and DCOM
technologies. We will not be using this feature in the training
course either. Click .tfext > to continue.
_--=-_~--.;;M;.,ellt_>_1 __Cance
__ ' _ Help
Ste Action
4 ix. The final dialog displays a summary of the communications
(cant.) setup, If you have chosen to configure a real I/O Device then
the summary will include your communications board and port
settings,
u
Basic Configuration Manual Revision 3 5-9
lJ
Communications Dialogs
I/O Server, After running the Express Communications Wizard, a set of communications
Boards, Ports dialogs are created as part of your project.
and I/O Devices
These can be opened from the Citect Explorer, in the Communications folder
or in the Citect Project Editor, by selecting the menu £ommunication.
The dialogs that would have been created in the previous exercise, for an
Omron SJ-l Series PLC connected serially via Coml are shown below:
ServerNam~ IMilk
Comment I'm
Server Neme IU~1
I edd
-=- Rt ..
'Board Name
,.--....,.,."...,....----
Repord: 1
Spe:cl.al Opt
Commer,l
N,arne
I 8dd J -
J
A'ddresy
_A8&01d:
_~_ 1 _ I?lolocol
Comment J
l,Mj BeplaGe I Qelete' I I:!elp
U
Continued on next page
.J
J
, .l
J
Exercise 5-2 Open and review the communications forms in the Milk_Treatment project.
Step Action
1 Open the Citect Project Editor and choose ~ommunication 11/0
§erver from the menu.
2 Choose each of the items §.oards, forts and 1/0 Qevices from the
~ommunication menu to display the associated forms.
3 For information on the fields on each form, click on the !::!.elp
button on the form.
or J
open the Citect Project Editor, select the menu lags I yariable Tags
I
or
open the Citect Project Editor, click on the Variable Tags icon 11I1 on the
toolbar.
Overview All forms in CitectHMIISCADA have the same standard interface. The
buttons are:
Button Function
Add Add the currently displayed information to the database
as a new record.
Replace Replace the current record with the information currently
displayed.
Delete Delete the current record.
,I Help Open the Citect Help Topics for the parameters on the
current form.
The scroll bar can be used to scroll from one record to the next. Records are
in the database in order of entry.
I
j
j
]
Testing Communications
I
Overview It is very important to test communications early in the development of a new
project. Without reliable communications, your CitectHMI/SCADA project 1
will not operate effectively. Testing communications also ensures that the
correct addressing fonnat is being used for the Variable Tags defined in the 1
project.
Exercise 5-3
I
Place a Variable Tag on a page in your project and confinn that there IS
communications to the I/O Device being used.
1
Step Action
1 Define a variable tag called Test. i
i. Return to the Citect Project Editor. Choose lags I ~ariable
Tags from the menu. The Variable Tags form will be
displayed: 1
Ste Action
1 2 Create a new graphics page to display the value of the Test tag.
i. Open the Citect Graphics Builder, click on the New button "'~.
ii. The following dialog will be displayed:
US!! T!!mplat!! EJ
Templale. N(lima!
Fr-----~~
I&i-;-~ =
PopTlend PopupJarge
__He!_P_ _ P
I
OK Help
t
I
l
I
Testing Communications, Continued
Ste Action
3 iv. Click on the Input tab (at the top of the dialog) and the
(cant.) following dialog will be displayed. In the Up command field
=
type Test 1. Click OK.
Button Properties EJ
fupcommand
1
Exercise 5-3 (continued)
J
Ste Action
4
(cant.)
iii. Click on the Appearance tab along the top of the dialog and
then click on the Display Value tab at the right of the dialog. I
The following dialog will be displayed:
I
J
Note: Don't forget to look for the vertical tabs in these dialog boxes
In the ON text when field type Test (as a default the Type
should already be set as On I off), in the OFF text field type
OFF and in the ON text field type ON. Click OK.
5 Save the page.
i. Your page should now look similar to the following:
= CSV_Display_ TitleO
OFF
Turn TUi Tag Off
Page
New
Delete
:?J
.l::!e!p
Iii
,I
iii. Select Milk_Treatment from the Project list and then type
Test in the Page field.
iv. Click OK.
6 Run the Computer Setup Wizard.
i. Click the Computer Setup icon S on the Citect Graphics
Builder tool bar.
ii. Choose Express Setup mode.
iii. Select Stand-alone Computer (Server and Display Client ).
iv. Select the Milk_Treatment project from the drop down list.
v. As there is only one I/O Server defined in the Milk_Treatment
project, it will automatically be selected. Click Next >.
vi. Click Finish to complete the setup and save changes.
1
Exercise 5-3 (continued)
]
Ste Action
6
(cont.)
Compile and run the project and check you have
communications. 1
i. Click on the Run Project button 1.il'1. This first compiles then
I
runs the project.
I
I
J
5·20 January 2005
I
· )
Testing Communications, Continued
iii. The new page Test will be added to the menu. Go to the Test
page.
'r.
Pag~ Trends Alarms rae
iv. Check that you have communications and can change the
value of the Test tag. If the I/O Server and I/O Device are not
communicating, then #COM will appear where the text was
drawn.
Overview Citect puts few restrictions on the names of variable tags, but you will benefit
from using a tag naming convention. By using a tag naming convention, your 1
project will be easier and faster to design, configure, and commission, and
will require less time for future maintenance.
The following naming convention is recommended for a CitectHMI/SCADA
system - to obtain maximum benefit when using features such as Genies and
Super Genies. J
}
See Also:
For further information about Structured Tag Names, see Citect Help Topics -
Using Structured Tag Names.
]
I
Area The Area section identifies a plant area, number, or name. If you use a prefix I
that identifies tags within a particular area, you can easily duplicate all
CitectHMIISCADA functions within the area. For example, if you have three
pasteurisers with the same controls on each pasteuriser, you can configure the 1
tags for pasteuriser number one, and copy the tags to pasteurisers two and
three. You then only need to change the area section in the tag names to the
area of the second and third pasteuriser. The remainder of the tags remain
I
unchanged, for example:
I
Part Tag Name
Pasteuriser 1
Pasteuriser 2
PI TIC 101 PV
P2 TIC 101 PV
I
Pasteuriser 3 P3 TIC 101 PV
I
If you do not need this facility, you can omit the Area section of the Tag
Narne to reduce the number of characters in the tag.
I
Continued on next page
I
I
I
5·22 January 2005
I
Structured Tag Names, Continued
1
Type The Type section identifies the Type of parameter, process equipment, or
1 control hardware. The ISA standard naming system is recommended.
Attribute The Attribute section identifies the attribute or particular parameter that is
associated with the equipment.
Exercise 5-4 Add the variable tags listed in the following table to your project.
Variable Tag Type I/O Device Omron Your Raw Raw Eng Eng Eng Format
Name Addre.ss Address Zero Full Zero Full Units )
L1C Silo PV 1NT MilkDev1 DM1 0 32767 0 1000 Lt ####EU
0 32767 0 100 Lt ###EU
L1C Balance PV INT MilkDev1 DM2
0 32767 0 1000 RPM ####EU
SIC Cent PV !NT MilkDev1 DM3
0 32767 0 100 kPa ###EU
PIC Homoa PV INT MilkDev1 DM4
0 32767 -10 120 dcg ###EU
TIC Cool PV INT MilkDev1 DM5
0 32767 -10 120 deg ###EU
TIC P1 PV INT MilkDev1 DM6
0 32767 -10 120 dcg ###EU
TIC P2 PV INT MilkDev1 DM?
0 32767 -10 120 deg ###EU
TIC P3 PV INT MilkDev1 DM8
0 32767 -10 120 deg ###EU
TIC P4 PV INT MilkDev1 DM9
0 32767 -10 120 deg ###EU
TIC HW PV (NT MilkDev1 DM10
0 32767 -10 120 deg ###EU
TIC Hold PV INT MilkDev1 DM11
Exercise Use Microsoft Excel to add the variable tags to you variable tag database.
(Optional)
Step Action
1 Open the Variable Tags database in Excel.
i. Make a backup copy of the file Variable.dbf (found in your
C:\CITECT\USER\<Project Name> directory) to a different
directory, such as C:\TEMP.
ii. Run Excel and open the Variable.dbf file in your project
directory.
I iii. Open the file called Save_dbf.xls in the C:\CITECT\BIN
directory. This loads the Excel macro required to properly save
files in the correct format.
I 2 Add and or change the tags in the file and save using the
macro.
J i. Excel can be used to copy, paste and sort the tags.
I ~ Hints &Tips:
In Excel, dragging the bottom right hand corner of a cell with the
I mouse, will do a data fill, automatically incrementing numerics.
Holding down the Ctrl key while dragging will stop the incrementing.
j
Continued on next page
J
1
(Optional) (continued)
Step Action
2
(cant.)
ii. When finished, point the mouse over any spreadsheet cell and
click on the right mouse button. This will bring up a context 1
menu. Choose the option Save/Close DBF to save and close
the file.
1
Database Settings
Set Criteria/Extract
Filter
Extract
~l
Introduction The graphics pages are one of the principle components of a Citect system.
:--1 They are the interface to plant operators, and can be designed to display data
as well as to accept operator input.
r I Graphics pages comprise of a page template, the objects drawn on the page,
as well as properties specific to the page.
, 1
Contents This chapter contains the following topics:
t I Topic See Pa2e
~, ~ Creating Pages 6-2
I ~ CSV_Include Project 6-3
~ Creating aNew Page 6-5
~ Drawing Basic Objects 6-7
~ Runtime Properties 6-17
~ Creating Symbols 6-29
~ ActiveX 6-32
I
I I
~l
"]
Creating Pages
Yl
Overview When starting a new project, new pages created can be designed to follow the
"look and feel" that is required. The simplest page is based upon the Blank
c1
template, which is simply a blank window. The developer can then add
objects and functionality to the window and develop new templates for their ,1
project pages.
"l
~ ~l
Standard For a developer with a short development schedule or someone who is new to
Templates CitectHMIISCADA, there are a number of pre-designed templates that enable
the user to quickly create pages. The standard templates in the Include project )
are designed to reliably perform all of the basic functions required in a
project. The Normal page from the Include project looks like this. ~,
;!
J
~ _~. _ •• _ . . lo; N
Jf ---, •
• ,M ..... _ •• _*"?:a:.' .. w '1.1:: .:::--. . . . . . ~ ......
"1
I
I
.J
J
I
J
:f' ...- _.
..J
L.J
I
:._J
I
1
6-2 January 2005
J
.I
CSV_Include Project
-U;vWofO
~:!3l1JmU~~~
Alongside a standard graphics page template for the creation of plant graphic
pages, the project includes predefined trend and alarm display pages, an
administration tools page, a file page for displaying text and Rich Text
Format files, and a selection of popup windows. All feature common
navigation and alarm menus for consistent functionality and appearance
I across an entire project. The project even supports multi monitor display,
allowing a number of graphics pages to be simultaneously displayed across
J several computer screens.
Common All the pages in the CSV_Include project include common toolbars that
Toolbars provide easy navigation and access to key functionality, as well as a 1
consistent appearance. There are three toolbars that remain on screen during
operation.
1
I
I
I
!
Custom Menus This menu provides drop-down menus capable of navigating to a specific
I
Toolbar page or calling a Cicode function. The content of the menus is generated at
runtime using a lookup table. I
Navigation This toolbar provides navigation buttons and direct access to key pages such
Toolbar as the Trends page and Admin Tools page. I
Alarm Toolbar The Alarm toolbar provides access to Alarms pages and displays the last three
active alarms. I
j
Custom Most projects create templates that are designed specifically for the site.
Templates Most of the pages in this course will be based on templates from the
CES_Include project. This project has been designed for the Citect I
Educational Services training courses. The pages in this project have been
based on the CSV_Include project. j
I
I
I
~J
6-4 January 2005
I
Creating a New Page
or
I or
1 See Also:
For further information about Templates, see CitectSCADA Help - Using Page
I Templates.
I
1
._ J
l~J
I
J
.J
b,J
Exercise 6-1 Create a new graphics page based on the xp_style Normal template.
1
Step Action
1 Create a new page in your Milk_Treatment project - use the
following template settings:
1
Style xp_style
Linked ./
Resolution XGA I
Template Normal
'1
2 Save your page, naming it Pasteuriser.
)
'1
I
I
I
I
Overview Objects can be drawn on a page by selecting the object from the
1 toolbox, or by selecting the object from the Objects menu.
The steps for drawing each of the objects varies slightly - look
in the Drawing category of Citect Help Index for specific
information on how to draw each object.
1 The objects can be manipulated by using the items in the Edit,
View, Text and Arrange menus. As in other drawing packages,
they can be rotated, enlarged, grouped and aligned.
I
I
J v' Hints &Tips:
If you are editing an upgraded Citect v3.xx/v4.xx project, then tools from those
I versions may be displayed by selecting Iools I Qptions... and ticking Show
version 3.xx/4.xx tools
Object In the previous exercise, you will have come across property dialog boxes.
Properties Shown below is the property dialog box for an ellipse object. This dialog box
contains all of the properties for that object:
Ellipse Properties Ei
1'_.,. ±J Ii r.-
Ir
EliPae Starl-engk;; 10
Pie· f i c e " - - ..-
:B diJgl~
S~. ISolid :::J Ir Ale End angle: 1°._.. _ ::H degrees
Colour. '.·1 i
fiB
r~e
Colol-lc \.·1
I
J
OK Cancel I
I
Continued on next page
.I
1
Object Every object you draw has a set of properties that detennine how it looks and
Properties behaves. These object properties include such things as the static appearance 1
(continued) of an object in the Graphics Builder, as well as runtime properties such as
how the object moves and scales or how it responds to a mouse click. 1
~ Hints &Tips: I
The horizontal tabs are the major sections for the object properties. Each of the
horizontal tabs will have different sub-sections in the vertical tabs. When a tab has
had information inserted a tick ./ appears on the tab. When you are following the 1
screen shots make sure you have both the correct horizontal and vertical tabs
selected.
I
Details about the properties can be found III the CitectSCADA Help - 1
Object Properties.
1
Citect Each CitectHMIISCADA project may contain one or more library files, each
HMI/SCADA
Libraries
of which can hold a number of library objects such as page templates,
symbols and genies (we will look at genies in a later chapter).
I
The Include and CSV_Include projects come with several libraries of pre-
drawn symbols and pre-made genies for your use along with all of the
standard templates. When you create new symbols, you can create new
library as part of your project and store them there. When you backup and
]
restore a project only the libraries that are part of the project are transferred.
\
I
I
I
I
I
I
I
I
6-8 January 2005
Drawing the Milk_Treatment Graphics Page
The first step in building the graphics page is to draw the basic objects on the
page. The objects to be drawn and their approximate positions on the page
are shown in the following diagram:
Vats
Milk Silo
Regenerative
Heating
Skim Milk
Homogeniser
Cream
Centrifugal Alfast Surplus Cream
Clarifier
I
J
-t·-.,;..
......-J
;,.
I' J
Drawing the Milk_Treatment Graphics Page, Continued
1
Exercise 6-2 Draw the graphics page as shown on the previous page.
I
Ste Action
1 Add the static symbols to your new page.
1
i. Paste the Milk Silo symbol onto your page using the
tool~.
Paste Symbol
I
Paste Symbol D
J
I
]
I
I
ii. Next paste the following symbols onto your page - leave all of
the symbols Linked to the library. 1
Object Library Symbol
Balance Tank Ces_Config Balance- tank 1
Holding Tube Coil
Centrifugal
Clarifier
Centrifuge Centrifuge_large I
Alfast Tanks_Cylindrical Tank_large
Homogeniser Tank_large
I
~ Hints &Tips:
Save your page regularly! Do not wait until the whole page is
completed.
If you need to undo an action, select gdit I Y,ndo from the menu.
To display the grid, go to the menu ~iew I Grid setup ... and select
Display Grid.
Exercise 6-2
(continued)
Ste Action
2 Add the Symbol Sets to the page. These will be animated later
in this chapter.
A!r~
Ar1imaIIld II ~
'<
OFF_*nbot ON -lYmbQI:
~
~L
talLgrey
~ ~~I •
5Qhl.Ued
~aI
C!eat Property I
OK Cenc.el I AP~ I Help
1~O-1 I
I
~ To draw a square:
D
Continued on next page
How to- The Ellipse tool is used to draw ellipses, circles, arcs, and pie-slices. Like the
Using the Rectangle tool the Ellipse tool can be moved, resized, reshaped, brought to
Ellipse Tool the front and so on, and their properties edited just like other types of object.
~ To draw an ellipse:
.
I
I
I •
:~.
,
•
I
I
. -.-.-.. "'-'-'-ro
I
I
•
~ To draw a circle:
··,
I
·
.••••.••• -+0
1
Exercise 6-3 Use squares and rectangles to create the Pasteuriser.
I
Ste Action
1 Add rectangles to your page.
1
i. Use the Rectangle tool to draw the pasteuriser. This object can
be as simple as four rectangles.
1
1
]
ii. Experiment with the 3D effects and add more rectangles to
create the look of four separate chambers.
1
I
I
I
2 Save the page.
I
I
J
I
I
I
I
I
J
Node Editing Pipe, Polyline, or Polygon objects can be edited to change their shape. Each
of these objects consists of a continuous series of lines drawn between
structural anchor points called nodes. Nodes are visible when an object is
selected. Each node appears as a small square located at specific anchor
points along the object. There is always a node located at the start and end of
a polyline or pipe, and at every change of direction in an object's shape.
Selected
Node
Pipe, Polyline, and Polygon objects can have their shapes changed in many
ways. Their nodes can be selected individually or by group and moved to a
different position, thus changing the shape of the object.
The Pipe, Polyline, and Polygon objects also support node adding and
deleting.
Position the
Position the cursor over the
cursor over the NODE and
LINE and press DELETE
press INSERT
1
Exercise 6-4 Add the rest of the static objects to your page.
I
Step Action
1 Add pipes and lines to your page.
1
i. Draw the pipes using the pipe tool Jf - double click to
terminate.
1
ii. Draw the arrows using the line tool ~.
iii. Draw the text next to each object with the text tool A
iv. Save your page.
2 Compile and run the project and test your modifications.
ii. r I
If the compiler reports any errors, select .!aoTo to display the
dialog where an error exists and fix the problem.
ii i. When you have corrected all errors, click on Run Project again
iv. Go to the Pasteuriser page and check that it displays correctly.
3 Shutdown the project.
I
J
Overview When you drew the objects on your Pasteuriser page, they were drawn so that
at runtime they would appear the same as they were drawn. This is fine if the
objects that were drawn are intended only as a static graphical representation
of your plant. However, at runtime you want to receive information about
your plant from the graphical display - this can be done by setting the
properties of the objects and by drawing some additional objects.
The following diagram shows the next stage in drawing the Pasteuriser page:
Vats
Milk Silo
---~
Homogeniser
Surplus Cream
Balance Tank
Overview Graphics page objects have dynamic properties such as colour, size and
position, which can change at runtime, to reflect a change in condition. For
example, the colour of the Pasteuriser would be an ideal way of conveying its
temperature to the operator.
Exercise 6-5 Change the runtime properties of the Pasteuriser chambers to indicate their
temperatures.
Step Action
1 Add an Array Expression to the runtime properties of the
Pasteuriser objects.
i. Double click the first rectangle to open up the Properties
dialog.
ii. On the Appearance (General) properties, tick the Filled box.
ii i. Go to the Fill (Colour) properties - select Type: Array and
then click on the Help button and read the information under
the headings [Type] Array, Array expression and Array colours.
j
Continued on next page
.I
J
6-18 January 2005
}
Displaying Objects in Different Colours at Runtime,
Continued
Ste Action
1 i. Choose the Array colours for values 0, 1, 2, 3, 4 and 5 by
(cont.) clicking on the colour swatch.
Rectangle Properties £I
Appearence I r' Mo-.;ement I "Scaung '" Fat I Input I Slider' Access I
~
ri ~~nJOff
(')
I .r MuRi·slale
:d.s:l ~
r.~!l I
1
-r Threshold .:J I i
1r
1
Gradient
L . - -.._ _- - '
Clear PJopetly I
OK Cancel I BPplJf Help
1
LIe Silo PV
Rectangle Properties E3
Appearance I Movement I Scaling v' Fill 1 Input I Slider I Access I
Level expres$ion-'~----~-------'------
Clear PIOpelly I
OK ] Cancel I BPply Help
iii. Add a bar graph to the Balance Tank to display the value of the
tag L1C_Balance_PV.
1
Exercise 6-6 (continued)
1
Ste Action
2 Paste a pre-built genie to change the Milk Silo level.
i. To change the value of the milk silo level. Click on the Paste
Genie tool "<»).
ii. From the Controls library select the Ramp_UpDown_btn2
Genie.
iii. In the Dialog box, select the L1C_Silo_PV variable tag.
iv. Place the Genie alongside the bar graph as shown below:
v. Place another genie alongside the Balance Tank. Select the tag
L1C_Balance_PV.
vi. Save your page.
j
j
J
Basic Configuration Manual Revision 3 6-21
I
Displaying Numbers at Runtime
1
Overview You can display the value of any tag or expression as a number at runtime.
When the value of the tag or expression changes, the number on your I
graphics page is updated automatically.
J
Exercise 6-7 Use the Numeric tool to add objects to your page. These will indicate the
numeric values of tags. )
Ste Action
1 Display the value of the LIC_Silo_PV tag near the Milk Silo.
1. Click on the Numeric tool ## in the Graphics Builder.
ii. Move the mouse pointer to where the number is to be
)
displayed on the page and click the left mouse button.
iii. Insert the tag L1C_Silo_PV into the Numeric expression box
as shown below:
1
Text Properties EJ I
v' Appearahoe I Movement I Scaling I . Fill I Input I SITder I Access I
]
---~ :
- Type~-...-~ ..-..._...
rOn/oil
r
r
Multi-slate
Array ~
r. Numeric .._----
(' String
I
Clear Prope,ly I
OK C<!Inoel I 6PP'l' Help
Overview You can display different text messages on a graphics page, depending on the
1 state of a digital tag or a condition. For example, you can display the word
RUNNING next to a motor when it is on, and the word STOPPED in the
same location when the motor is off.
Exercise 6-8 Display the status of the tag Agitator_Silo_V near the Milk Silo.
Ste Action
1 Add a text object to the Pasteuriser page.
i. Click on the Text tool A in the Graphics Builder.
ii. Type the words Silo Agitator OFF.
iii. Move the mouse pointer to where you want the text to be
displayed and click the left mouse button to place the text.
iv. Go to the Appearance (General) properties and set the
desired display font, colour, alignment and effects.
v. Go to the Appearance (Display Value) properties and select
Type: On I off.
vi. In the ON text when box enter the variable tag
Agitator_Silo_V.
vii. Set the ON Text to Silo Agitator ON.
TeHt Properties a
.", App~ral1Ce I Movement I Seeling I Fiil I Il1pu I SRder] Access I
I ON lex ISaOAgitator ON
Clear Propelty I
OK Cancel I £lpply Help
I
}
)
__ J
Overview Symbol Sets can be used to display different symbols on your page depending
on different variable tag values and expressions, as well as to simulate
movement.
You have already used the Symbol Set tool ~ to paste the Hops Extractor
and Whirlpool onto your page - we will now go back to these items and add
properties that will make these objects appear they are rotating when they are
switched on.
Step Action
1 Modify the Silo Agitator so that is animates at run time.
i. Double click on the agitator symbol to display the properties
dialog.
ii. Go to the Appearance (General) properties and select
Type: Animated. Insert the tag -
Agitator_Silo_V
~ Hints &Tips:
You can use the Expression Wizard ,:". to insert the tag name in to
the Animate when expression.
I
LJ
Basic Configuration Manual Revision 3 6-25
:I
Using Symbol Sets, Continued
1
Ste Action
1 iii. In the Animation frames box, you will see that the symbol you
(cant.) previously selected is shown as the Off frame. By clicking on
the Set... button you can fill Frame 1 through to Frame 4 with
the symbols you want displayed while the expression in
Animate when is true. Note: You will find that in the
Agitator_3D library there are 4 tall_green symbols in order
from left to right - each is drawn to show increasing rotation.
1
Symbol Set Properties EI
V'Appearance I Moveme'nt} Scel;hg I F~I 1 InpUtl SliClel! ACCB~ I
~
~'~n I off " , - -
r Mullkl~le
r AlTay
Co Animated
~~---,-"
"V".
talLgre!l
.!J
Clear Propelly I
8K Cancel I 8pply' I Help I'
Step Action
3 Add valves onto the pipes.
f,,-r_~:_~~_!te~JIIIJI'I:~:~~~
, r Allay
~~I .-I :1\1.
I
j'
r A,~maled ..:J .
,.
~
IS'
!l
! OFF symbol: ON symbol:
I--
dl
c:Lt
(
c.,
~
l up_smalLred
!i
Clear Properly I
I OK I Cancel I 6PPiY I Help I
i. KiJ
Click on the Run Project button mil in the Project Editor.
ii. If the compiler reports any errors, select 11(ltil to display the
dialog where an error exists and fix the problem.
iii. When you have corrected all errors, click on Run Project
again.
iv. Test the pages and objects in your project.
7 Shutdown the project.
Using Libraries You can store frequently used objects or groups of objects (including bitmap
objects) in a library as symbols. You can then paste these symbols onto your
page.
After you paste a symbol from the library onto a graphics page, it can be
moved, re-sized, re-shaped, brought to the front, and its properties can be
edited, just like any other type of object.
- As a linked symbol;
the symbol on the page is updated when the symbol in the library is changed
(to alter the properties of a symbol in the library, open the library and edit it
in the library). If you edit the symbol from the page and then change the
source symbol in the library, the pasted symbol changes. For example, if you
double the size of a pasted symbol, then double the size of the symbol in the
library, the pasted symbol doubles again. You can cut the link to the library
by using the Edit I Cut Link command.
See Also:
For further information about Using Symbols and Libraries, see CitectSCADA
Help - Using libraries.
Importing The Graphics Builder has several file format filters to allow you to import
Graphics graphics from other applications, such as drafting programs, illustration
programs, presentation packages, scanners, etc. After a graphic is imported,
you can use the graphics builder to edit the image.
1
Exercise 6-10 Create a new graphics symbol and library.
J
Ste Action
1 Import an image to create a new Homogeniser symbol.
1
i. Click on New Lj and then select the Symbol button.
ii. Choose File Ilmpo'1... from the menu. 1
iii. Select the file Homogeniser.bmp provided by your Instructor.
Click Open.
iv. Place the symbol so that it is above and to the right of the
base point.
Base Point ) {-
Note: The Base Point is the reference point on the object when
it is pasted using the mouse pointer.
v. Select from the menus Tools I Swap Colours ... and fill in the
dialog as shown - the From colour swatch is white and the To
colour swatch is transparent:
Swap Color 13
"31
C Flom§njlcolol r Swaprenge
Ste Action
2 Create a new library and save the symbol.
i. Click on Save ~ to open the Save As dialog. Click on New to
create a new library in which to save your symbol. Type
training as a name for your library name and click on OK.
29
$lrp.':I3"'t>:\'
"I
Cancel
Name; Itraining
ii. Type homogeniser as the name for your symbol and click on
OK.
3 Replace the tank on your Pasteuriser page with the
homogeniser symbol.
4 Save your page.
5 Compile and run the project.
ActiveX 1
1
Overview CitectHMlISCADA allows you to incorporate ActiveX objects into the
graphics pages of your CitectHMlISCADA project, allowing you to make use I
of tools and components that have been developed independently of
CitectHMlISCADA. For example, you could incorporate a batch application
in a CitectHMlISCADA graphics page, and use it to communicate directly
1
with your lIO Devices to control and monitor recipe levels, etc.
)
It is important to remember that the behaviour of an ActiveX object within
CitectHMlISCADA will be largely determined by the object itself. An
object's functionality, reliability and its suitability to CitectHMlISCADA will 1
depend on the way the object has been developed by its creator.
]
Inserting The easiest way to insert an ActiveX object into your CitectHMlISCADA
ActiveX project is via the Graphics Builder. Using the ActiveX tool from the Graphics
Objects via Builder toolbox, you can select and insert ActiveX objects in your graphics
Graphics pages in much the same way conventional objects are inserted. Just like other
Builder
objects, they can also be moved, reshaped, and copied.
ActiveX objects have predefined properties that relate to their features and
functionality. You can view these by simply double clicking on an object
once it has been positioned.
I
J
1
J
Ste Action
1 Use the Active X Object CiMeterX to display the Holding Tube
Temperature.
i. On the Pasteuriser page choose the Active X button from the
Objects menu.
I ActiveX
CiRecipe. RecipeMngl
ciT ext.ComboS ox
ciT ext. TextB ox
ciT reeView. Splitler
ciT leeView. Tlee
ColorSvr Class
COMNSView Class
Cr Behavior Faclory
Crystal Active>< Query Viewer 1.0
........ _1_1 n l ""~ .• h_1 .:J
location: C;\Program Files\Common
Files\Cilect\C"iM elelXocx
Insell
I
--:.l Cancel
I
ActiveX, Continued
1
Exercise 6-11 (continued)
Ste Action
1 iii. Change the Caption to Holding Tube Temp.
(cant.)
CiMeterX.TechMeter Properties EJ
.,' Appeereoce-I Movement] Sc.-anng I Access]
CaPtiOn:
IHolding Tube Temp
Caption Afignment
po Caption Visible 12. Center 3
E;,;;I1QJ/'le;::.·..;.:..CJin::..;:g~U;,;;n:;;,.it L=..m=e:.::.~_______ Po;ition:
I --3--'
T"""o-pL-er-1
1,..,..0....,.
iv. Go to the Tag Association tab and choose the Value property
from the left pane. Insert the tag TIC_Hold_PV into the right
pane. Click OK.
v. The following message will appear because the Property Type
is REAL. You can display this by clicking on the ,bist Property
Type button in the Tag Association tab. The TIC_Hold_PV is
an INTEGER which is why the message is displayed. Click res
to continue.
Warning
Ste Action
2 Your page should now look something like this. Save the page.
Vats
Milk Silo
HW
d. valve
~
~Holding
~Tube
.-"'-0.. . . -;
Homogenlser
Balance Tanl<
ii. I I
If the compiler reports any errors, select tloTo to display the
dialog where an error exists and fix the problem.
iii. When you have corrected all errors, click on Run Project
again.
4 Shutdown the project.
1
J
I
1
1
I
~ Slider controls that an operator can use to change the values of analog
variables.
~ Touch commands that an operator can issue by clicking on an object
with the mouse.
~ Keyboard commands that an operator can issue by typing instructions on
the keyboard.
You can assign privileges and areas to commands and controls and you can
also send a message to a log each time an operator issues a command.
~~J
. J
1
Slider Controls 1
1
Overview Slider controls allow an operator to change the value of an analog variable by
dragging an object on the graphics screen. The position of a slider will also 1
automatically update when the value it controls changes.
Exercise 7-1 Add a slider control on the Pasteuriser page to adjust the Milk Silo
temperature.
Step Action
1 Remove the genie you pasted in the last chapter to change the
Milk Silo level.
i. Select the Paste Symbol tool ~ and choose a pointer from the
thumbs library that will suit a vertical slider. For example,
knob_vert_red • would be a suitable choice.
J
Continued on next page
Ste Action
3 Add properties to the symbol to turn it into a slider.
i. Go to the Slider (Vertical) properties and fill in the dialog as
shown:
Symbol Propertie5 £I
Appellrance I MoveMent r SCllling I ,Fill I Inpt.41 '" Sfider 1 Access I
rTag-----------------------------,t
s:l1 i
:r
"ILlC_SiIO_PV ::;or
..:1 I <.
At ::zJ pixels
minimum ..:J (down)
Clear f"roperly I
OK Help
Tool Tip Change the MILK SILO level with this slider
1
Exercise 7-1 (continued)
Ste Action
iii. Move the pointer to the bottom of the bar graph next the Milk
Silo:
Milk silo
#ft.ft.#.#
.I
J
7-4 January 2005
Touch Commands
1
Overview The operator can execute a command (or series of commands) by clicking on
an object with the mouse.
You can define several commands for an object - one command to execute
when the mouse button is pressed down, another for when it is released, and
another to operate continuously while an operator holds the button down.
To define a touch command you need to fill in the Input (Touch) properties for
an object.
Ste Action
1 Draw a button on your Pasteuriser page.
L Select the Button tool 0 and draw a button near the Feed
Pump.
ii. In the Appearance (General) properties type the Text you
want displayed on the button face, and choose one of the
CitectHMIjSCADA fonts.
Button Properties 13
P.ppearance I Input I
r T.YPe-··_··_·-'
r. Text I IFeed Pump
l~ ;:m;~._. J
Texl:
OK Help
Ste Action
1 iii. Go to the Input (Touch) properties for the button and fill in the
(cont.) dialog as shown:
Button Properties E!
Appearance '" (nput I ApCle~s 1
Up c o m m a p d - - - - - - - - - - - - - - - - - ,
IAction Toggle(PumpJeed_CMO)
~.
[Logging
Log message: I
~ Hints &Tips:
You can use the Expression Wizard ,:... to paste the function
ToggleO and then the tag name in to the Up command box.
Step Action
2 If you are not connected to an external I/O Device: Add the
following Input (Touch) and Access (General) properties to the
equipment status text on the Pasteuriser page:
Now, when you click on any of these text objects, you will toggle
the associated piece of equipment on and off.
I
l
]
j
J
Basic Configuration Manual Revision 3 7-7
J
I
Keyboard Commands 1
1
Overview Keyboard commands have a key sequence that an operator enters on the
keyboard and a command (or series of commands) that executes when the key 1
sequence is entered.
If the same key sequence is defined for different keyboard commands and
contention occurs, the keyboard command with the highest precedence will
execute.
The order of precedence (highest to lowest) is:
1. Object Keyboard commands
2. Page-wide Keyboard commands
3. System Keyboard commands.
J
7-8 January 2005
Keyboard Commands, Continued
System Keyboard commands are commands that are executed when certain keyboard
1 Keyboard keys or key sequences are pressed. More then one command can be run from
Commands each keyboard command. System keyboard commands are available in all
parts of a project.
I
Page Keyboard Page keyboard commands are like system keyboard commands, however they
Commands are only available on the graphics pages in which they are defined. More than
1 one keyboard command can be defined on a page.
Object Any object can accept keyboard input in a similar way that it can accept
Keyboard mouse input. Editing the Input I Keyboard Commands property allows the
Commands definition of one or more key sequences associated with an object.
I
I
I
I I
J
I
1
Exercise 7-3 Define some keyboard keys and then define system, page and object keyboard
commands. I
Ste Action )
1 Define the keyboard keys.
i. In the Citect Project Editor select System I Keyboard Keys
from the menus. l
ii. Fill in the following form:
1
!ElKeyboard Keys [Milk_Treatment] I!!I~EJ !
Step Action
2 i. In Citect Project Editor, select System I Keyboard Commands
from the menus. Fill in the following dialog as shown:
11J!iffi!jjjj~,j'Ii!'Ii'I",,jf,,!,,,mi'@!&j'I' _IDI~
r
Ke)' Se!<Ue!lCe' ShUldown :::::J
Command 'IShuldownO: 3
Priv~ege I
Comment IShul~ down Citec\HMl/SC.6DA in~lantl)'
I I
,I I
I Add Beplace Qeleta Help
Record; r Deleted
..::::J
Ste Action
3 iii. Fill in the dialog box as shown below:
(cont.)
Pasteuriser Properties £J
J I
Gehefal Appearance Keyboald Commands Events ~nvionment I I
· r r'-~
r"~1
Key sequence
j
'.t [seCUfilY
I
~ SMlelll~&~ IV No privilepe restrictions
I
:I)lIL"l1V,.d l.llP.ll 1<·411 Gfll4. :::J ~Ji.:, *!!!Y'.J" I '" 31
..:.J! ._.~ - ~ ..:J
A..I... I "_1_._ I ....I.. I I ~logging
~il I log~age:
I ._ ";•••_ 'M~""""_'" ... - ......
Clear Prop6lt1' I
OK Help
You can select the Key sequence from the drop down list it rather
than typing it in.
J
7-12 January 2005
Keyboard Commands, Continued
Ste Action
5 Define the object keyboard commands that toggle the valves
open and closed.
i. Double click to view the Coolant Valve properties.
ii. Go to the Input (Keyboard commands) properties and fill in the
following:
i , ~ • • •. x
vi Appeara~ceI Movement 1 Scaling I Fil vi In~l I Slidell Access 1
TOQQle
rFe'
i:w"'_COOLCMDI
command-"
--_._--~~ j ~
---- -..-_._.-
-_._ __._ _ _----,
....
I
.. .. .. ~
[__.
~:~:S::~l'---"---'--"-------'--"-'--"'-'
.. . .__.._.__.. . J
Clear Properw I
OK Cancel I 8pply Help
iii. Go to the Access (General) properties and give the object a tool
tip as shown in the table below.
iv. Click on OK.
v. Repeat for the other objects listed in the table below:
Ste Action
6 Add the following object keyboard command to the displayed
L1C_Silo_PV tag value near the Milk Silo:
TeKt Properties EJ 1
.,; Appearance I M'ovementl Scaling I Fm .,; Input I Slider 1 ACcess 1
'1i~1I11 ENTER' c o m m a r l d - - - - - - - - - - - - - - - . ,
I Key·sequence UC_Silo_PV~rQValuel
11111111 ENTER
'Sect,l,~JI,-----------------......,
P Same· area asobjecl P Same pri"Rege as object
UJ;nmaqd alee.: I<J,JI1llei;p ::::I PUil',!ege fe,vel ,1<Non,;. :::J
~~
......... I "'_i_._1 I'A' [LOWing
_~_,_m_es_sa_.g_e:_I
'I .
C1~r PIO~IY I
OK Cancel I---- Help
Overview Privileges may be set so that only specific users have access to the commands
and controls. Areas and privileges will be covered in more detail in a later
chapter. However, at this point we will need to create a temporary user in
order to gain control and access to all of the default elements of the project.
1 CSV Include Some of the content of the CSV_Include project is protected via a user login.
Default Without a valid login, certain functionality within the project will be disabled.
Privileges
I For example, the tools page will be mostly inactive if you login as a user with
restricted privileges.
I By default, the following elements within the CSV Include project are
protected by global privileges.
When configuring a CSV_Include project, you should make sure your users
have appropriate access to the available functionality. In particular, you need
to make sure your users can Acknowledge Alarms if required, and that they
have access to the full functionality of the Admin Tools page.
Exercise 7-4
Ste Action
1 Create a temporary user called Designer.
i. In the Citect Project Editor select System I Users from the
menu.
ii. The following form will appear. Fill in the form as shown
below. The password is des.
~En}'C"8;
rill Ctect In:
i!l ';,:ste,n S8LP
~ :~:~:~:,~~~:~:~ Grc,-,p~
Ste Action
2
(cant.) ii. Click the Login 1t~"'9iro
• button. This dialog will be displayed.
Enter the username Designer and the password des. Click
OK.
login Form !3
Name IOesignei
Pas~word J'"
~
iii. Move your pointer over the items on the Admin Tools page.
Now that you have logged in as a user with level 8 privilege
you are able to select items on this page.
l
I
}
I All types of graphic objects and their configuration data can be stored with
the genie. For example, you can define a genie for a start/stop controller
(with a start button, a stop button and an indication lamp), and use the same
.I genie for all equipment (pumps, conveyors, etc.) that use that type of
controller. When you use the genie you only need to specify the information
\ that is unique to that particular pump or conveyor (i.e. the variable tag).
i]
Pasting a Genie from the Libraries
'-1
Overview The Include project, which is part of the basic CitectHMI/SCADA installation,
~-l
has several libraries containing genies for use in your projects. Genies are
usually defined without specific variable tags so that they can be reused, both
in the same project and in different projects. When you paste a genie onto a
page, a dialog box will request the entry of one or more variable tags and
~l
comments or other data, to control the display and actions of the genie object
at runtime.
:---]
~'--l
._J
'1
~J
._1
I
I
Exercise 8-1 Paste a genie from a library in the Include project onto a test page called
Utility.
Ste Action
1 Create a new page in your project called Utility.
i. Use the following template settings:
Style
Linked
Resolution XGA
Template Normal
2 Paste a genie onto the Utility page to display the Feed Pump
status.
Paste Genie Ei
ot:.
!
I
Canoel I
[eli! I
I
Ste Action
2 iv. In the dialog box, select the Pump_Feed_CMD variable tag.
(cont.)
Genie - Pump
T~Q lPumpJeed_CMD 3
EI
1
.oK ,Geneel I .tjelp I I
v. Click on OK.
3 Paste a genie to toggle the Pump_Feed_CMD variable tag and
place it under the pump genie on the Utility page.
Paste Geme EJ
Genie: P'Lo1/;JO!.igle2 Ub!ary.
-:J heelcool
molars
power
pumps
pwrdisl
trainirlg
IIA rl~
•
Overview In the previous exercise, we pasted two genies to accomplish what could
easily have been done with one genie. It is easy to create a single genie by
pasting existing genies or objects on to a new genie and then saving this in a
library as part of a project.
or
Modifying a You can at any time, modify a genie that you have created. If the genie has
Genie been pasted onto pages in the project, then ensure that all pages in the project
are saved and closed before modifying the genie.
After making changes, save the Genie and select the menu Too!s I Y,pdate
Pages to refresh all pasted copies of the genie in the project.
I
I
I
, J
Basic Configuration Manual Revision 3 8-5
I
1
lag1
lag2
QK ~ancel
Note: In the above example, %tag2% is used twice, however the user is
only prompted once for the substitution. Every time a copy of the
genie is pasted onto a graphics page, all instances of %tag2%
within that copy will be replaced with the name supplied.
Exercise 8-2 Create two new genies for your Pasteuriser page. The first is to control the
Feed Pump and the second will be used in a number of places, for the
keyboard input of values into variable tags.
Ste Action
1 Create a new genie with an animated pump symbol.
New E3
Page
Cjeate a new gtaphic$ page
baneel r
U$ing a Ple-delined l~
Help I
TlllTlPIble
Q!\ale }'Ol~ own ltllf~ 10 ll$tl &l'a base 101
mlial gt"P/'liCt page$.
S,I'Il1boI
Deate a new ~ 101 obiecla lhal ~u ~
olter.
G_
Deale a new genie 101 g1oup$ of objects t~
have COlI\IIlOI'l altribu15.
SupetGenie
Create a 1_
acc~ alIUl1\ime.
",.ipelg.;.t'ie t11/1\ can be
ii. Click the Genie button. A blank page will be displayed, with a
Genie Locater Point ~ (this is reference point when the genie
is pasted onto a graphics page).
o
~.,.~
:..J
I
LJ
LJ
J
Basic Configuration Manual Revision 3 8-7
U
Creating a New Genie, Continued
Ste Action
1 iii. Paste a pump to display the status near the Locater point,
(cant.) using the Symbol Set tool ~
---'1
Symbol Set Properties EI
y' Appear Ilnce I Movement I, Scaling I Flit 1 l"putl Slider I Access I
"'-1
'\,.
Type_'---J ["N ~mbol
j"'m "".~"_CMD
W"Oh
.,.---_.- .. -~-.,.--.,----~
Q
r. o:J~
Cll
On I off p_
r Multi.stllle I :.]
r Array
r Animated .i:J ~
OFF symbol:
.-_.._-_.
ON symbot
j -l
I" _~'d
~ , ~
Clear I I
~
lell_green
Clear Property I
OK Cancel I BPPIl' Help
.J
LJ
GJ
8-8 January 2005
",. 1
Ste Action
1 v. Click on Save and fill in the dialog:
(cont.)
Genie
Preview: QK
P'Enable
. .Qllr.cel
I
Name: IT raining
Ste Action
2 Create a button to control the pump.
i. Select the Button tool 0 and draw a button above the pump.
Set the object properties as follows:
Button Properties £I
Appearance I '" Input '" AcCe$$]
Identification "-
Q
~ OblOfCtMI
~
r
~
!!
:;]
~
Description: his button toggles the pump state
=<;
0
..:J ~
~
(II
Security:--------------------------.·
RTI32 ~ S-ame arBa,...as.."pag_8 --. , '1'1 r No Pfrvnege reslliclions
-L!J
I:!J 0 leU-'fe.;;' I • reas> ::oJ Priv~ege level: l%priv~egeY.
['-
,; ~ Log device: I
Step Action
2 iv. Go to the Access (Disable) tab. Tick the box to Disable on
(cont.) insufficient area or privilege. Choose Hidden for the Disable
Style.
I . • • i- xl
Od~1
Q
g
!!(
!!;
I .:J 0
-
Disable slyle-
r Embossed
r Grayed
r. Hidden
CIB<lr Properly I
I OK 1 Cancel I 8Pply
I Help
I
v. Click on OK.
~N~me'" Pump
I
ii. Save your genie again.
iii. Select file I £Iose from the menus to close your genie.
Ste Action
4
Use the Paste Genie tool "'¢l to paste the PumpControl genie
onto your Pasteuriser page.
i. Specify Feed as the Name. Leave the Privilege field blank.
PumpControl £i
tlJame IFeed
Pliv~ege , . . - - - - - - - - - : . . ; . . - - - '
t QK &ancel I !:Ielp I
ii. Replace the Pump symbol set and toggle button with the genie.
iii. Add genies for the Cool Pump and HW Pump. (See page 8-15
for a suggested placement)
5 Create a genie to display the value of a tag and accept keyboard
input to change the value of the tag.
i. Create a new blank genie as before.
ii. Click on the Numeric tool ## and click near the Genie Locator
Point to place a numeric object.
iii. Insert %TAG% into the Numeric expression field, as shown:
. t ype _'H'HHH"~'''''"91
r Onlofl
(" MJU'state
r Altay
~ ~Iullleri, .I
r stri:lg
n
Exercise 8-2 (continued)
Ste Action
5 iv. Go to the Input (Keyboard Commands) properties and
(cant.) complete the dialog as shown:
1 Text Properties EI
". Appticllance 1 Movement I Scaling I Fill ". Input I ' Sftder! Access I
~I[='-
I II'
Clear Properly
J
u
1
Basic Configuration Manual Revision 3 8-13
Creating a New Genie, Continued
Ste Action
5 v. Go to the Access (General) properties. Untick the box next to
(cont.) No privilege restrictions, and type %PRIVILEGE% in the
Privilege level field.
OK Cancel I
6
Use the Paste Genie tool ~ to paste the ChangeValue genie
onto your Pasteuriser page - specify L1C_Silo_PV as the TAG and
move the genie next to the Milk Silo. Leave the PRIVILEGE field
blank - this will be used in a later chapter•
Ste Action
7 Repeat the previous step for each of the following variable tags
and place each genie next to the associated plant item on the
page:
L1C_Balance_PV
SIC_CenCPV
PIC_Hom09_PV
TIC_P1_PV
TIC_P2_PV
TIC_P3_PV
TIC_P4_PV
TIC_HW_PV
TIC_Cool_PV
8 Save the page. Your Pasteuriser page should now look similar to
this:
Milk Silo
_eu
Silo Agitator OFF
_#II EU
Regenerative
~Ieatlng
-i~lI
_ru . I-iOnlogenlg:er
i/#lUIt
I
I
\
1
I
Introduction Popup pages and super genies are dynamic pages to that you can use to pass
information when the page displays in the runtime system. You can use them
for pop-up type controllers for a process or a single piece of plant floor
equipment. The same page can then be re-used with different sets of tags.
1 For example you could configure a graphics page with several pumps, and
use a super genie pop-up controller for each of the pumps on the page.
]
In most cases where you use a popup page, you use it in association with a
geme.
J
Contents This chapter contains the following topics:
I
Topic See Pa2e
Creating Popup Pages 9-2
Calling Popup Pages from Symbols 9-8
}> Calling Popup Pages from Genies 9-9
Creating Super Genies 9-11
I
I
I
I I
J
: ]
I
Creating Popup Pages 1
I
Super Genies The difference between a Pop-up page and a Supergenie is that a Supergenie
and Popup is saved into a *.ctm library file. A Supergenie must also be attached to a 1
Pages - What is genie. Usually a pop-up page is all that is needed for most people who only
the Difference? work on one site. However if you are an integrator and you work with many
different sites a Supergenie *.ctm file may be saved and copied easily into
I
other projects.
I
Creating a First create and save a new blank page. This page can be attached to a genie
Popup Page or called directly from a page. In either case, a super genie function will need
to be used to open the popup page at runtime.
1
Super Genie There are a number of functions that can be used to call and modify a super
Functions genie (see Citect Help Topics I Index - Super Genies: Cieode Functions). These 1
functions can be used from pages or genies to open and modify a super genie
page at runtime and many of them can contain a list of tag names to be passed
to the super genie.
I
Example - I
The function,
AssPopUp("sgPage","Tag1","Tag2","Tag3")
1
calls the super genie page sgPage and associates three variable tags with the
page. The order of the tags here will be the order in which they are
referenced in the super genie page using super genie syntax. I
Continued on next page
I
1
1
Super Genie Variable tag names can be substituted at runtime by usmg a senes of
I Syntax substitution names with the syntax:
?type number?
1
where number is the position of the tag name in the list provided in the super
genie function that was called to open the super genie page. It is not strictly
necessary to use type in the supergenie syntax. However, if you do wish to
use type it is the data type in the variable tag ( ego string, int, real or digital ).
Example -
In the previous example of AssPopUpO, if the tags were a string, integer and
digital respectively, then they could be referenced anywhere in the super
geme as:
Structured Tag If a super genie function such as AssPopUpO is used in a genie, then part or
Names all of the tag names passed can be specified as genie substitutions. The
advantage is that if variable tags in the project all follow a standard naming
convention, then only part of the name needs to be passed to the genie.
Example -
AssPopUp("sgPage","Pump1_Valve1 ","Pump1_Valve2");
AssPopUp("sgPage","%Pump%_Valve1","%Pump%_Valve2");
and when the genie is pasted onto a graphics page, CitectHMI/SCADA will
only prompt for the pump name, which will be Pump1. This genie will now
work with all pumps that have a variable tag naming scheme which follows
that of Pump 1.
Exercise 9-1 We will now create a popup page to open and close the valves on the
Pasteuriser page.
Ste Action
1 Create a new popup page as shown called !Valve which can be
used to open and close any valve.
New E3
Pege
C,eele e new gra~page
usihg apr6~~e.
Help
Templete
Cleele your own teroplate to ute ~ a bate lor
ifmllal giaphic$ pages.
SJIII\bo(
Cre';'le "new ~ 101 obieCts tt,bI yPu we
oflel\
Genie
Cr~te a new.gMie fCli glOUj)$'bf objepl$1hat
h\lve COfflITIOl'I atlnDutes,
Super Genie
Ct~e It new SUjlel ~ IheI ren be
accemd at·runtme.
I oJ
l .....
Ste Action
2 Choose the blank page template when this form is displayed.
(cant.)
Use Template m
Te'l'p1<!1te: blank St~:
I~::~ .
rn
"-b-Iank·'''' book1menu lop
version2
xp_sljlle Edit
t1J ""---[0-"'--
=
I ~~ bookfwnen:
P
r
Linked
Titlebal
Reaolution:
IXUA 3
disabled doublelJend eventspcxls eventtlend.:.l He\:)
ii. Draw the two buttons near the top left hand corner of the page
with the following properties:
Step Action
2 iii. Draw the two light symbols using the Symbol Set tool ~. 1
(cant.) Set the properties as follows:
vi. Place the pointer at the bottom right hand corner of the
buttons. This is to indicate the size of the page you will need
for your popup page.
OPEN
I
CLOSE
I
0 I
~
Ste Action
2 The status bar at the bottom of the screen will display the
(cont.) pointer position from the top left hand corner of the page.
!Valve Properties Ef
I
GeI"Ielal Appearance Keyboard Commands I Events I Environmentl
- Template-.- ..- - - -
Style: Istandard :::J
I Resolution: [ - X G A - - - - - - - - - - - - - - - - : : : .J
.....
OK Cancel I Help
viii. Click on the Save filii button and save the page
with the name !Valve.
I
)
I
I
1
J
9·8 January 2005
Calling Popup Pages from Genies
Ste Action
1 Create a genie called ValveControl with a button to call the page
!Valve.
New E3
p*
Create \!I new grophics page
CanOl:I
using a ple-dellned lempla\e;
Help
Tern~e
Deale yow owntemplale to use as a ba$e to!
sirnilllt gt~ pages.
S}'Q)bol
Deale a new S'j!fbol IO! ~ that you use
often "
Genie
Cleate a new gerde 101 910ups of obiecls !hal
have common alltW\!I$.
So,jpI.>rume
Create a new super genie that can be
accesserl at lunlime.
Text %Valve%AnValve
Input AssWin(l!Valve",%OriginX%,%OriginY%,
(Touch) Up 1+8+512, II VALVE_%Valve%_CMD" )
Command
Tool Tip OPEN/CLOSE %Valve% Valve
Advanced Create a super genie to open and close the valves on the Pasteuriser page.
Exercise
(Optional)
Ste Action
1 Create a new super genie page as shown called "!AdValve"
which can be used open and close any valve.
New E3
Page
C16<Jie lJ 11eW gJaphics page
\l$ing a p1e.cle1iried template.
Help
T~
DellIe jIOUI oW'H~e-1o 4Se-llS a base lor
",lrr,;w gr!IPhics~ ..
$!8l1bor
Cleate 8.:tleW $ymbo! Cor objec~ that you use
often. .
Genie
Deate a new gem, for gr~$ of oblects th.!lt
Mve COfillllOn altJibu!8;1. .
S\JPllI Genie
Cceate a new wpet genie that san be
~ ~ at 1l.1I"Itime: -
A blank page will displayed with an area in the top left corner
bounded by a dotted line - this is the area that will be visible
when the super genie is displayed.
Note: AI:1ew super g~I:1ie page will have animation points AnI
'i! and An2 .1; already placed. AnI is where
keyboard input is echoed and An2 is where prompt
information is displayed. These Animation Points must
not be deleted.
iii. Move Anl and An2 out of the area bounded by the dotted line.
We do not need them on our super genie, but will leave them
defined so we cannot accidentally create new objects with
either of these two animation numbers.
Ste Action
1 iv. Open the popup page !Valve. Select and copy the objects on
(cont.) the page.
v. Return to the super genie page and paste the objects. Move
the objects to the top left corner of the page.
vi. Go to the super genie properties by selecting the menu
file I Properties. In the Appearance properties, change the
View Area to a size that is appropriate for your page.
vii. Click on OK.
viii. Click on the Save III
button and save the super genie with the
name !AdValve into the Training library of your
Milk_Treatment project.
ix.
New E3
P~e ~
CI~e a new gr~ p*
uSing a.llre,deftnM lemplll!",
TrJiTlplab~'
<C,ellle yow own t'empiale tiJ ture as a. hare (Of
war graphics pages.
S}lfl1bol
Cleate e hew $!IfI\boI 11M tIbj'ecIs U~ ~'OU use
allIIn.
Genie
_.J
Create a new genie lor gr~ of objecb that
have common llllribulell
Super Genie
Qell\e a new super genie that can be
accessed at llJl1lime.
.J
Continued on next page
Ste Action
2 iii. Draw a button near the Locater point with the following
(cant.) properties:
Text %Valve%AnValve
Input (Touch) AssWin("!AdValve",%OriginX%,%OriginY%
Up Command ,1+8+512, "VALVE_%Valve%_CMD") i
WinTitle(%Valve% Valve)
Tool Tip OPEN/CLOSE %Valve%
vr Hints &Tips:
Look in the eitect Help Topics for the function AssWinO to find out
what parameters can be passed to this function.
.........., , _ _ .. J,.
Beroove
J
Continued on next page
I
I
Ste Action
2 vi. Click on Add to select your !AdValve super genie from the
(cont.) training library:
Select Super Genie Ei
Genie: !AdII~e
.I
II
~ healcool
" t.J keyenlry
OK
1
-lllItilll
_._-!=.-_
motOiS
powel
Cancel
I
pumps
J
IIII I
IAoValve !S!Llirne Wldis! Edit
~ New I
-----If
IIII~ Help
vii. The Attach Super Genies dialog should now look like this:
lralnln IAdllelv"" O~
I
Cahcel
I
II ~ II
Bemove I
~ l:ielp
Click on OK.
viii. Click on Save IiirlJ and save the genie with the name
ValveControl in the training library of your Milk_Treatment
project.
Step Action
3 Paste the ValveControl genie onto your Pasteuriser page next to
the Mash Valve and the Brewed Wort Valve. Fill in the genie
fields as follows (leave the PRIVILEGE field blank for now):
Q\1-G1 Wn-H~
-(r------
Q\i-GS fV1aJlfYl~
I
I
LJ
Basic Configuration Manual Revision 3 9-15
I~ I
I
1
1
I
Introduction A Device is a utility that transfers high-level data (such as a report, command
log or alarm log) between CitectHMI/SCADA and other elements (such as a
printer, database, RTF file, or ASCII file) in your CitectHMI/SCADA system.
Devices are similar to I/O Devices in that they both allow CitectHMI/SCADA
to exchange data with other components in your control and monitoring
system.
'I1
:..J
~J
1
I
What Are Devices? 1
1
Overview
Citect exchanges high- 1
level data using a Device
Device 1
Input -+----M u---+-+ Output
from a
database or
~=;r!l to a printer
database or
r 1
ASCII file ASCHfRTF file
I
Citect
J
Citect exchanges plant-floor
data with an I/O Device
(using a communications
cable)
Inputs Outputs
from field devices to field devices
You can use Devices for a variety of purposes, for example, to send the
output of a report to a printer, or write data to a database.
I
.J
1
Overview ~ Using a Device, you can write data to:
I (continued)
- RTF files
- ASCII files
- dBASE databases
- SQL databases (through ODBC-compliant drivers)
- Printers (connected to your CitectHMIISCADA computer or network)
~ Using a Device (and cicode functions) you can also read data from:
- ASCII files
- dBASE databases
- SQL databases
Citect
Printer
Shift
;..a.;l...IL.......L..iRe port
I L:-~-tProduct t";:::=:'J
Report
J
Basic Configuration Manual Revision 3 10-3
j
I
Setting Up Devices 1
1
Overview Each device in CitectHMI/SCADA has a separate record that defines the
format of the data transferred to or from the device and the type and name of J
the device.
~ -1
How to »- To define a Device: , "'}
In the Citect Explorer, open the System folder in the selected
project and double click on the Devices icon:
Devices J
or
~J.
in Project Editor, select the menu §ystem I Qevices t.
'l
I
1
J
l
J
J
j
10-4 January 2005
~J
Using Device History Files
Overview If you use a device to log data to a file for long-term storage, you should
specify the number of device history files. CitectHMIISCADA uses a system
of rotational history files to store historical data. Data is stored in several
files as illustrated in the following figure:
Time 6:00:00
1
Period Monday '---1
CitectHMIISCADA will create a new file each Monday at 6:00am. If you ----1
start your runtime system at 7:30am on Sunday, your first file only contains
22.5 hours of data
..:~-)
,
Note: If you want to archive your data for long-term storage, you must , '·--1
backup the history files before they are overwritten.
I
I
)
I
)
I
I
I
~.J
..J
IJ·
, . ...
Exercise 10-1 Mouse or keyboard input can trigger a message to be sent to a log device via
the CitectHMI/SCADA MsgLog. The log device must also be defined with
MsgLog as one of the format fields. In this exercise we will set up logging of
keyboard input for some of the valves on the Pasteuriser page.
Ste Action
1 Define a text file device called CommandLog to log commands
from the CitectHMI/SCADA Message Log.
i. In the Citect Project Editor select System I Devices from the
menus:
For more information on any of these forms click on the Help button.
This will take you directly to the help topic for that form.
Record:
..:J
I
../ Hints & Tips
If there are already devices defined, then select one and modify it.
When finished, click Add to create a new device record.
I
Exercise 10-1 (continued)
Step Action
1 iii. Fill out the device definition form with the following properties:
(cont.)
Name CommandLog
Format {Date,10} {Time,S} {MsgLog,32}
File Name [DATA] : Com_Log. txt
Type ASCII - DEV
No. Files -1
Comment Log file for logging operator
commands
2 Edit the Coolant Valve object on the Pasteuriser page and add
an appropriate log command for when the valve has been
toggled.
i. Double click on the Coolant Valve and go to the
Access (General) properties and set the Log device:
Step Action
3 Repeat part 2 of this exercise for both the Hot Water and the
Flow valves.
4 Compile and run the project and test your modifications.
5 Shutdown the project.
6 Start Windows Explorer and open the \CitectSCADA\Data
directory. Open the Com_Log.txt file using Notepad and confirm
that your keystrokes are being recorded correctly.
1
1
I
I
1
Introduction You can use an Event to trigger an action such as a command or set of
commands. For example, an operator can be notified when a process is
complete, or a series of instructions can be executed when a process reaches a
certain stage.
~ You can run an event by the following methods:
- Automatically at a specified time and period
- Automatically when a trigger condition becomes TRUE
- Automatically when a trigger condition is TRUE at a specified time and
period
J
I
l I
Defining and Enabling Events
Overview Events are defined in the project and stored in a database. For events to run
they must be enabled by running the Citect Computer Setup wizard. If there is I
more than one CitectHMIISCADA computer running on a network, then the
Citect Computer Setup wizard is run on each computer to specify which
events will run on that computer.
1
Events do not have unique names - you can specify several events with the I
same name. Any events given the special name Global will automatically run
on all CitectHMI/SCADA computers that have events enabled.
I
~ To define events:
In the Citect Explorer, select a project and open the System folder, S:j~ J I
then double click on the Events i c o n : ¥ l "
Events
or
or
or
I
j
11-2 January 2005
}
Defining and Enabling Events, Continued
Step Action
1 Add two events to your project.
i. In the Citect Explorer, select a project and open the System
folder, then double click on the Events icon.
ii. The following form will appear:
l!!!#§ddmiI1.wjU _IDI~
Name J
Time I iJ Pefiod I iJ
Tli.\l!:ler I ;:]
Action I
Comment I
I
,I I I
I Add Beplace .Q.elele /jelp
Record: r Deleted
~
Ste Action
2 Enable the events to run on your computer.
i. In any of the Citect Windows double click on the Computer
:-1
Setup. icon.
ii. On the first page of the Computer Setup Wizard, select
Custom Setup.
iii. Progress through the dialogs until you reach the Events Setup
dialog:
,~J'
,-; .'
t...1.::' ~:,
Events Setup BIS EJ
~ EYel'll$c <iJ~:used to Ir>gge, actions; Fe! events to tun ona gi~en o~,puler
I~ Ihey must Ills!- be el)abled You C<lIn choo-se 10 enable eYllfll's on this
computer and indillid,uafly select which event.s-.wiU be enabled.
PEMble Events on this compUter
E.venls disabled: Events enabled
CSV AlarmCfrent
=
CSV T'6l'I~Clienl
2J VALVE
CSV_T,en~Selver
The two lists on this dialog display all of the events defined in
the project - one list contains the events disabled and the
other contains the events enabled on this computer.
~J
Step Action
2 iv. Tick the box (by clicking on it) next to Enable Events on this
(cant.) computer.
v. Use the controls between the two lists to change the state of
the VALVE event from disabled to enabled.
I
}
. }
, I
11-6 January 2005
Chapter 12: Alarms
Overview
~ Hardware Alarms
CitectHMI/SCADA continually runs diagnostic routines to check all
peripheral equipment, such as I/O Devices. All faults are reported
automatically to the operator. This facility is fully integrated within
CitectHMI/SCADA - no configuration is necessary.
~ Configured Alarms
Unlike hardware alarms, you must configure the alarms that report fault
conditions in your plant (for example, when a tank level is too high or when a
motor overheats).
Overview Alarms are entered into a database using forms, in a similar fashion to
variable tags. Each type of alarm has different triggers and parameters and so
has a separate configuration form with different options.
Digital Alarms These depend upon the change of state of one or two digital tags. If two tags
are specified, then both must change for the alarm to be triggered.
Time Stamped Time stamped alarms are similar to digital alarms - the alarm is triggered by a
Alarms state change in a digital tag. However, time stamped alarms have a time
source, which supplies the exact time that alarm was triggered. The timer is
typically a time stamp read from an I/O Device.
See Also:
Citect Help Topics - Time Stamped Alarms.
Analog Alarms Analog alarms are triggered when an analog variable changes beyond one or
more specified limits. Each alarm may be configured as any combination of
the following types:
Advanced Advanced alarms are triggered when the result of a Cicode expressIon
Alarms changes from FALSE to TRUE.
Hardware Hardware alarms are separate from the user alarm system. They display when
Alarms problems are detected in the operation of CitectHMI/SCADA or when a
connection to an I/O Device fails. All hardware alarms are pre-configured in
every CitectHMI/SCADA system.
See Also:
Citect Help Topics - Hardware Alarms.
J
12-2 January 2005
F' 1
r~l
Configuring Alarms, Continued
I
,1 How to ~ To add a new alarm:
Open the Citect Explorer, select a project and open the Alarms folder, then
double click on the icon for ~ ,~ &1~~; 3~ft ~
I the type of alarm you wish to
' Digital Alarms Time Stamped Analog Alarms
(',
Advanced
.~ . ~.
Multi-Digital
add, Alarms Alarms Alarms
or
Open the Citect Project Editor, select the 81arms menu and then choose the
appropriate menu for type of alarm to be added,
L J
U
Basic Configuration Manual Revision 3 12-3
I J
Configuring Alarms, Continued
Exercise 12-1 Configure the alanns that will be used in your Milk_Treatment project.
Ste Action
1 Configure one digital alarm for when the Silo Agitator is
stopped and another digital alarm that is triggered if the
Centrifugal Clarifier is on but the Feed Pump is off.
i. Open the Citect Explorer, select the
Milk_Treatment project and open the ! '"
Alarms folder, then double click on the
Digital Alarms icon or open the Citect Digital Alarms
Project Editor, select the Alarms I Digital
Alarms menu item.
ii. The following form will display:
AlalmName ...
M
A:ISlin D,esc
Vatiable. T~g P. ,:::1 ,V<lliable Tag 8
CalegolY.
,..------- Help
Dela,..
Comment
Deviation 3
Deadband 2
Format ###
Ste Action
3 Configure two advanced alarms that are triggered when
the Hot Water Temp drops below 7S degrees and when the
Coolant Temp rises above 3 degrees.
i. Open the Citect Explorer, select the
Milk_Treatment project and open the
1
Alarms folder, then double click on the
Advanced
Advanced Alarms icon or open the Citect Alarms
Project Editor, select the Alarms I
Advanced Alarms menu item.
ii. The following form will display:
AlalmName I
AJarmDesc r----------
Expression
Category Help I
Delay
Comment
Overview Each alann in your system can be assigned to a category and each category is
processed as a group. For each category, you can set alann display details
(font and page type) logging details (printer or data file) and the action to be
taken when an alann in the category is triggered (eg. activate an audible
alann) or reset.
If you do not specify a category for an alann, the alann has the same
attributes as alann category O. Category 255 is used for all hardware alanns.
If you do not define alann categories 0 or 255, CitectHMIISCADA uses the
defaults for those categories. Category 254 is used for user additions to the
alann summary.
Each category can have an associated priority. Alann priorities can be used
to order alann displays, providing useful filtering for the operator.
~ Hints &Tips:
It is a good idea to separate alarms of different types into different categories, so
that different formats and actions can be given to each type.
I
I
J
Basic Configuration Manual Revision 3 12-7
J
]
1
Alarm Categories, Continued
1
Exercise 12-2 Configure two devices for alarm logging and three alarm categories.
Step Action
1 Define an alarm summary device as a database file and an
alarm log device as a text file.
i. In the Citect Explorer, open the System folder in
~
the Milk_Treatment project and double click on the en
Devices icon or in the Citect Project Editor, select
the System I Devices menu item. Devices
Ste Action
2 Define three new alarm categories for the digital, analog and
advanced alarms.
i. In the Citect Explorer, select the Milk_Treatment
project and open the Alarms folder, then double r't j
-~
click on the Alarm Categories icon or in the
Citect Project Editor, select the Alarms I Alarm Alarm
Categories
Categories menu item.
ii. The folloWing form will display:
1
Exercise 12-2 (continued)
]
Step Action
2 iii. Add the following advanced alarm to the database:
(cant.)
Category 1
Number
Alarm orr CSV_UrgAlmUnAck
Unacknowledged
Font
Alarm orr CSV_UrgAlmAck
Acknowledged
Font
Alarm On CSV_UrgAlmUnAck
Unacknowledged
Font
Alarm On
Acknowledged
Font
ON Action Beep (0) i Prompt ("Advanced Alarm
Triggered" )
OFF Action Prompt ("Advanced Alarm INACTIVE")
Alarm Format {DATE,12}A t {TIME,14}A t {NAME,20}A t
{DESC,34}A t {STATE,lO}
{TAG,lO}A t {NAME,22}A t
)
Summary
Format {SUMDESC,22}A t {ONTIME,S}A t
{OFFTIME,sl
1
Summary Device AlarmSummary
Log Device AlarmLog
Comment Advanced alarm category I
Continued on next page j
I
I
J
Step Action
2
(cont.)
Category 2
Number
Alarm Off CSV_UrgAlmUnAck
Unacknowledged
Font
Alarm Off CSV_UrgAlmAck
Acknowledged
Font
Alarm On CSV_UrgAlmUnAck
Unacknowledged
Font
Alarm On CSV_UrgAlmAck
Acknowledged
Font
ON Action Beep (0) i Prompt ( \\Digi tal Alarm
Triggered" )
OFF Action Prompt (\\Digital Alarm INACTIVE")
Alarm Format {DATE,12}A t {TIME,14}A t {NAME,20}A t
{DESC,34}A t (STATE,10}
Summary {TAG,10}A t {NAME,22}A t
Format {SUMDESC,22}A t {ONTIME,S}A t
{OFFTIME,S}
Summary Device AlarmSummary
Log Device AlarmLog
Comment Digital alarm category
1
Exercise 12-2
I (continued)
Step Action
1 3 Go back to the alarm definition forms for the digital, analog
and advanced alarms and assign categories to the alarms as
I follows:
I
1
. J
I
I
J
I
~ j
Basic Configuration Manual Revision 3 12-13
. J
Logging Alarms to a Printer
How to You can print alanns to a printer as they happen by writing to the device
configured as shown below:
Name PrintAlarms
Format {TAG,10}~t {NAME,22}~t {SUMDESC,22}~t
{ONTIME,8}~t {OFFTIME,a}
File Name LPT1.DOS
Tvpe ASCII DEV
No. Files -1
Comment Prints Alarms to a Printer
NOTE: The printer must also support line printing, if alanns are to be
printed as they occur.
or
1 in the Citect Project Editor, select the menu 2ystem I Groups.
Example -
To configure a device to log alarms to both a printer and to the alarm log, add
a new group and fill out the form as follows:
Then in the Alarm Categories form, change the Log Device to Log Alarms (i.e.
the name of the new Group).
Displaying Alarms 1
~l
Overview There are some standard pages in the CSV_Include Project. These are used to :---l
display alarms of different types:
These pages are all based on alarm templates that are in the CSV_Include r" "1
Project.
I
J
Exercise 12-3
Ste Action
1 Run the Milk_Treatment project then trigger and view some
alarms.
i. Compile and run the project.
ii. Go to the Pasteuriser page and trigger some alarms. When an
The Alarms Toolbar at the bottom of the page will display the
most recent three alarms.
iii. Right click one of the alarms to open a menu. The first item
on the list will be the name of the Alarm Tag. Choose the
Alarm Tag option from the list.
',M ACktlowl~ge
~-
Disable
Enable
Ste Action
1 iv. This screen will open displaying the Alarm Info.
(cant.)
I
1
I
v. These alarms may be acknowledged by right clicking on the
alarm and choosing Acknowledge from the menu.
Help
Ste Action
2 View the alarms from the default alarm pages.
i. Click on the Active Alarm icon i.!~. This will open the Alarm
page.
Alpagesille~
ii. An Alarm may be selected by clicking the icon to the left of the
line. Once the alarm has been selected it may be
acknowledged by either
Overview The CSV_Include project allows you to use Alarm Groups to display a
specific set of tags defined by the alarm category and area settings configured
within the runtime CitectSCADA project. For example, you could create a
group defined by all category one alarms. This group could then be used as a
filter to create a list of all of the category one alarms currently displayed on
the Active Alarms page. It is also possible to define groups containing
multiple categories.
Exercise 12-4 Create alarm groups in your Milk_Treatment project during runtime.
Ste Action
1 Use the Alarm Groups to view specific alarm categories on the
Active Alarms page.
i. Go to the Pasteuriser page and trigger some alarms.
ii. Select the Configure Alarm Groups option from the Alarms
menu.
,J
_ _..~J
o
of
o
Area
· J
J
Basic Configuration Manual Revision 3 12-21
I
Alarm Groups, Continued
Ste Action
1 iv. Add three groups to display the different categories.
(cant.)
v. When the groups have been added close the Configure Alarm
Groups dialog by clicking the close £a button.
2 Display the different groups on the Active Alarms page.
i. Select the Active Alarms option from the Alarms menu.
Alarm Summary
Disabled Alarms
Hardware AIafIl\5
CoofiQure Alarm GrOfJps
ii. From the Alarm List Filter Tasks displayed on the left side bar
choose Apply a filter to the list.
Ste Action
2 iii. The Alarm Filter Groups dialog will open and display the three
(cant.) alarm groups that you just configured. Choose one of the
groups and click OK.
Select Group
.. Advanced Filter ..
.. Display All Alarms ..
Advanced Alarms
Analog Al<lIms
Digil~ AlafffiS
The sidebar will also display the name of the category that is
currently being displayed and provide you with the Clear Filter
option,
Analog Alarms
Overview The CSV_Include project offers support for audible alanns. You can
configure a project so that a selected wav file is sounded whenever an alann
of a particular priority is triggered. You can even assign different sounds to
different alann priorities, allowing the urgency of an alann to be
distinguishable from the sound it makes.
Exercise 12-5 Assign priorities to each of the alann categories and then configure sound
files to play when alanns in those categories have been triggered.
I
Step Action
1 Assign priorities to the Alarm Categories J
i. Open the Citect Project Editor and select Alarms I Alarm
Categories from the menu.
1
ii. Assign these Priorities to each alarm category.
Category Priority
Advanced alanns 1
Digital alanns 2
Analog alanns 3
Soundl=[RUN] :AdvAlarm.wav
Sound2=[RUN] :DigAlarm.wav
Sound3=[RUN] :AnaAlarm.wav
Your instructor will provide you with these files or you may
use standard wav files from the [WINDOWS]\MEDIA
directory. For example
Soundl=C:\WINDOWS\MEDIA\TADA.WAV
Sound2=C:\WINDOWS\MEDIA\DING.WAV
Sound3=C:\WINDOWS\MEDIA\CHIMES.WAV
Ste Action
3 Enable the CSV_AlarmClient event.
i. On the first page of the Computer Setup Wizard, select
Custom Setup.
ii. Progress through the dialogs until you reach the Events Setup
dialog.
iii. Tick the box (by clicking on it) next to Enable Events on this
computer.
iv. Use the controls between the two lists to change the state of
the CSV_AlarmClient event from disabled to enabled.
v. Click !:iext when finished.
vi. Continue through the remainder of the dialogs by clicking
!:iext. When you get to the last page, click on the finish
button to save your selections.
Example-
I
I
I
J
I
12-26 January 2005
1
Using Alarm Properties as Tags, Continued
Exercise 12-6
Step Action
1 Add an Alarm I/O Device.
i. Select your project and open the Communications folder in
the Citect Explorer and then double click I/O Devices in the
Contents Area.
ii. Fill in the I/O Devices form with the following information:
Name AlarmDevice
Number 12
Protocol ALARM
Port Name ALARM
l r- -:M.....:::::.=
uRj.stllld:. r:A~~I;:IQi~
B HTA.L 01 HTA.LL
• • • • • • • • • • •~.1 Add I ~
-=...J 0
I r Au".I' I r::::::..-::::::::::::::::::::] I
0 elete m
I r Numeric
rr String
I,I
. ..::J ~
Edi' I ~
1 ..::J J
Clear Prope,ty I-
OK J Cancel I 4i::',J!~ I Help I
3 Save your page.
4 Compile and run the project.
5 Go to the Pasteuriser page and that test alarm property tags
are working, by changing the Holding Tube temperature.
6 Shutdown the project.
J
12-28 January 2005
Chapter 13: Trends
Overview
You can also scroll back through historical data to display past values of the
variable (or process). Historical data collection continues even when the
display is not active. You can switch between pages without affecting trend
graphs.
You can trend any single variable or Cicode expression. You can display any
number of trends on the screen simultaneously, and display the trends of up to
eight variables in any trend window.
I
. J
Trend Tags
Overview Trends in CitectHMI/SCADA are added by creating trend tags. Each trend
tag will have one or more separate files in which trend data is stored.
CitectHMIISCADA will continuously store trend data, regardless of whether
it is displayed on a graphics page.
To trend a variable tag, create a trend tag for it and define one or more history
files in which to log the value of the trend tag. You then display the trend by
creating a trend page and assigning a pen to the trend tag to display it in the
trend window.
Trend History CitectHMIISCADA uses a series of rotational history files in which to store
Files logged data, rather than a single large file. By default, CitectHMIISCADA
uses 2 files with each file storing the data for one week, beginning at
midnight on Sunday. The default log file name will be the trend tag name.
You can change the frequency of logging and the number of log files to use.
To view the trend history file setup, open the trend tag form and press F2 to
view the extended options.
or
n
Exercise 13-1 Trend some of the tags in the Milk_Treatment project.
Ste Action
1 Create five periodic trends.
i. Open the Citect Project Editor and choose Tags I Trend Tags
from the menu.
1 ii. The following form will appear (press F2 to display the lower
half of the form).
EXple$sion :.:oJ
:JI
i
Trigger .----------3
Sample Period 3 Type I ::oJ
Commer~
File Name I
S.lorage Method I
PrIVIlege I l'Jea
Eng Uni~ I ":1 Formal I
No.FiIe$ r-
Time I :.:oJ PElIiod I
I ~dd Replace I Qelele
I l:!elp
I
Record' r Deleted
~.H
I
j
1
Trend Tags, Continued
1
Exercise 13-1 (continued)
I
Ste Action
1
(cant.)
iii. Fill in the form as shown below to create a periodic trend tag
that will trend the value of the tag TIC_P1_PV (press F2 to I
display the lower half of the form).
1
DTrend Tags [Milk_Treatment] I!I~ £i
I 8~ B.~place I lLelele
I tI~lp
,
r ~('Ieted
------------------~,. ~!
ReOOld:
Note: Ifthe fields in the lower form are left blank the trend tag
will be configured to use these values by default.
iv. Add a new record for each of the trend tags defined in the
table below. Leave the sample period, type, no of files, time
and period the same.
P3 P TIC P3 PV [DATA] : P3 _ P
P4 P TIC P4 PV
HT P TIC Hold PV
Overview You can create pages in your project based upon the following trend
templates in CitectHMI/SCADA:
~ SingleTrend - a single, full page trend, where one trend window displays
on a graphics page.
~ DoubleTrend - a full page trend, where two trend windows display on a
graphics page.
~ CompareTrend - where two trends are overlaid in the one trend window.
~ ZoomTrend - with two trend windows and added functionality for
zoommg.
~ PopTrend - that you can 'pop up' anywhere (in a separate window) on
your computer screen.
~ EventTrend - based upon events rather than time.
There is also a trend object available from the toolbox in Graphics Builder.
This can be used to create a completely customised trend, on any page in the
project.
I
I
j
. J
Exercise 13-2
Ste Action
1 View the trends you have just defined by using the
preconfigured page CSV_Trend,
i. Compile and run the project.
ii. Open the Single Trend page by choosing the Trends I Single
Trend menu item.
Popup trend
Instant TreQd
I
Configure Trcend Groups .l
iii. When the Single Trend page opens it will look like this.
1
Exercise 13-2 (continued)
Ste Action
Right click the first Trend Field and choose Select Trend Pen
1 1
(cant.)
iv.
1.
I
I
1
v. When the Trend Selection dialog opens select the trend tag
Trend Selection
Select \lend tag;
Add Canccl
Ste Action
1 vi. Add the rest of the trend tags to the trend pens. Your page
(cant.) should now look like this.
-NOC"lI"JIlJ
...,. -1Ib!·nvt
"., -tu(l.&»*
I
1
I or
click the Select Trend Group : : ; icon and choose the Clear
Trend group.
Trends
Select Trend
.. Clea, Trend ..
OK Cancel
1
Displaying When a trend first displays in a trend window, the values display
Trends in Real- dynamically, that is, in real-time mode. The locations of the graph lines I
Time (trend pens) represent the values of each trend tag. The graph scrolls across
the trend window as new values display. I
Displaying Because all trend data is logged to disk, you can use historical mode to scroll 1
Historical back and view past values. Trend data displayed in historical mode is static,
Trends and only displays values for the specified period.
I
Historical mode is toggled on and off by checking and unchecking the
Display history mode box. I
·e Display history mode 0
1
The trend control buttons scroll the trend back to historical mode and forward
to real-time mode. Clicking the clock icon allows you to enter an end date. 1
Trend Groups The CSV_Include project allows you to use Trend Groups to display a 1
specific set of trend tags. A trend group includes a set of up to eight variable
tags that can be automatically loaded into a trend display without having to
select each tag individually.
I
Continued on next page I
I
I
1
I
I
1
Exercise 13-3
Ste Action
1 Use the Trend Groups to assign the trend pens to a predefined
group of trend tags.
i. Select the Configure Trend Groups option from the Trends
menu.
ii. The Configure Trend Groups dialog will open. Enter the
group name Pasteuriser Trends into the Description field.
DescrlptiQn
Ste Action
1 iii. The Trend Tag name may be entered into the Trend Pen fields
(cont.) by either typing the name of the trend tag directly into the 1
field or by clicking the ellipsis button J
at the end of each
field. Using the ellipsis button will open the Trend Selection
dialog. Use either method to Add the P*_P trend tags to the
1
Pasteuriser Trends group.
Trend Selection
Select llend tag.
iv. When you have finished configuring the group click Add to
save the group and then click the close button to continue.
Description
I PasteuriS81 Trends IJ
I'-"
.I
Trend P n 1 r-- ..... _.p
IJ
Trend Pen 2 1P2J> LJ
Trend Pen 3 J P3_P LJ 1
Trend Pen 4 1P4J> l.J of
Trend Pen
I IJ 1
Trend Pen 6
I I.J
Trend Pen 7 L_ IJ
Trend Pen 8
1 IJ
Area !
L I e
Add Replace Delete
'--'-'-"-'--'
I J
Continued on next page
Ste Action
1 ;::: ...j'
(cant.) v. Click the Select Trend Group L..-" icon and choose the
Pasteuriser Trends group. Click OK to continue.
Trends
Select Ttend
I
.. Clear Trend ..
Pasteutiser Trends
OK IICJ;a~:! II
vi. All of the trend tags in the group will be added and the group
name is displayed next to the Trend Group icon.
37.97
72.94
Calculating Each data sample in a scaled trend requires two bytes of storage. You can
Disk Storage therefore calculate the total disk storage required for each trend record, by
using the following formula:
Period (sees) x (No.Files) x 2 )
Bytes reqd = 464 x No. Files + 176 + (
--"'--"'--...;......-"'----
(for eaeh Sample Period (sees)
trend tag)
For example, if a trend record produces one sample every ten seconds for one
week, and you are using five data files (five weeks), the number of bytes
required is:
(7 x 24 x 60 x 60) x 5 x 2 )
Bytes required = 464 x 5 + 176 + --------
( 10
= 607296 bytes
Floating point (eight byte) trends are approximately four times larger.
Therefore use the same formula as the scaled trends and multiply the result by
four.
Re-configuring If you change the configuration of your trend history files (in an existing
History Files project), or you change the configuration of a trend tag that affects the
number, time, or period of the trend files, you must delete all the existing
trend files - before you run the new system.
If you change the paths in your trend tag definitions, you will need to move
the history files or CitectSCADA will create new ones.
Note: You must not delete the history files (that CitectHMIISCADA
creates) from your hard disk while your system is running.
Backing Up In many cases it is advisable to backup (or archive) trend data for later use.
Trends This may be for analysis in the future or to save disk space on the Trend
Server.
When you backup your old trend files, rename them so that they do not clash
with existing, active file names. For example, the file name TR1_96.MAY
shows the age ofthe trend data in the file.
Restoring To restore an old (backed up) trend history file to the trend system, you can
Trends use the Cicode function TrnAddHistoryO.
CitectHMIISCADA determines the trend name from the header section of the
specified file. The data in the file is then added to the trend history.
Overview Instant Trends gives the user the ability to "watch" any integer or digital
CitectSCADA variable tags in a popup trend window. Unlike pre-defined
trend tags, instant-trending of the variable tag begins when the window is
displayed, and ends when the window is closed, and does not require
configuring at design time.
I
J
Selection Pane The Trend Tag Selection Pane includes these features
68 Ll
60 deg
75 deg
This feature is similar to the Windows Task Manager as it displays the CPU
Usage History and Memory Usage History whilst the window is open. It does
not save that data.
• ~. • • •• . : . ; . I • • •
• • -<. . . " . . -. • • • -. • •
• r f····
• •.•••• ; ••••••• 1 •••
Up to four variable tags may be trended within a single Instant Trend popup.
However, multiple Instant Trend popups may be open concurrently.
Note: The Instant Trend feature does not support variable tags of the type
LONG or REAL.
Exercise 13-4 Instant Trends are not available in your project by default. You must first
configure your project to run the Instant Trend events.
Ste Action
1 Set up the Instant Trend events.
i. Run the Computer Setup Wizard Custom Setup and scroll
through to the Events Setup form.
Exercise 13-5 The templates provided in the CSV_Include project are already configured
with an Instant Trends option on the toolbar.
Ste Action
1 Display the Instant Trends.
I. Start your project,
ii. Open the Pasteuriser page and select the Trends I Instant
Trend menu.
-,,,'.
l10pup Trend
~
. Con~l~ure Trend Gro.ups . :
!
Ste Action
1 iv. Right click the first (green) trend pen button and choose
(cont.) Select Trend Pen 1 from the menu.
• - M
v. The Tag Selection dialog will open. Choose any tag and click
OK to continue.
Tag Selection
Select tag to !tend-
Agaatol_Alfasl_V
Agaato,_Silo_V
Cen~~uge_Clar_V
L1C Balance PV
L1C=Silo_PV-
P1C_Homo!J..PV
PumpJeed_CMD
SIC Cent PV
TesT -
TIC_CooLPV
T1C_HoId_PV
T1C_H\A'-PV
TIC Pl PV
TIC=PZ=P<I
DK
Ste Action
1 vi. The variable tag value will immediately be displayed in the
(cont.) trend window.
li
ta2s,15 AM
.Q~lQ7~
vii. Hover your pointer over an object that has a tag defined e.g.
the Balance Tank Level bar graph.
Ste Action
1 viii. Press the + key. This will add the tag to the next available pen
(cant.) in the Instant Trend window.
586 Ll
Slll\
·I
J
What is the Process Analyst?
Overview The Process Analyst is an Active X control that may be placed onto a
CitectSCADA graphics page. In its simplest form, no other configuration is
needed than to add the Process Analyst Active X control to a CitectSCADA
graphics page. It is capable of displaying all trend types and alarm data in the
same window. As it uses the same information provided by the existing
trend and alarm servers that the trend and alarm pages use there is no extra
trend or alarm configuration needed other than creating trend and alarm tags.
lr~FTFTj;:;' 1nZ'E ~.
711012004 ~45.00 PM ~ 711012004 ,6O".OOPM
~;I-_'_-_-"_"-"h~-lL-O-"'·'-"-""---l'--..L-
r":_',--'''~I - - , -
rr"--'O· ·"...JT-_,,·
_.. ·--l-'_f'..1.- . -:.-=_
. ,.··l_'
. . . f+-·r--- -~. - "'; ~~~,,~o H~;";:;:~~;~~~
f.1'··oo·_~·,,_ -ttl~.__-_..·_
.._·_"--_-
...... ··..""·ta.
"..---'-m'&-.. ,,_.-=.-=.--"··m....._·""m"....
..__'tii
... '....
··..,,-"tii....
."..._'-_·,,"-"t)·'O-"""..I:·"m,-,,,,,-",til·"....
"_".:'='""""".+-"".,,,'
'4-·"_"·_""·_"...L,,1ll .._.....
,...,,*~ ._",,_, · m··--1·I"''l\..., , - ' " ......,! 7110120042.49.1' PM ;"-"-~"-
I .....1
.1 "j'lA
r..5 !'1...--:-----,,,.,....--..,,,...-;;;!'l~-..,.I'1;-----:::----=-----.~
. .. ....- - . f , j - - - - H : On {UnacknotrAl;!dgedl
~~'\·r~ y"bF'~ <'iJ\ ~ilcrl'&,·.rrl'l J'~ l'I I'l.~ fl!"l?,q ~ ( "\" <>-. ••••• i :7110120042.49.1''''
~ "1m! ~lJ ~ y\J W b¢J l-#l 'lrl ~ori''''J """
J .
7/10120042:4fI:15 PM
o o
0 0
Object T:r.ee Is
~ I I ..!J 0
0 0
i
J
14-2 January 2005
1 The Process Analyst Active X Control
Exercise 14-1 Place a Process Analyst ActiveX Control onto a new graphics page
Ste Action
1 Create a new page and add the Process Analyst.
i. Open the Citect Graphics Builder and create a new page based
on the xp_style Normal template.
ii. Save the page as Analyst.
o o o
o o
Object Tree Is
o o
iv. Use the resize handles to enlarge the object so that it fills the
page.
l_J
Basic Configuration Manual Revision 3 14-3
.l
Properties of the Process Analyst
Overview The Process Analyst control allows Operators to view trend and/or alarm tag
data (both real-time and historical) for comparison and analysis during
runtime through their existing CitectSCADA server architecture. Users can
configure certain properties of the Process Analyst control during design
time.
Mam
. ~ I.
r
\~,
lbar Date/Tire Axis
~ P1A
_ •• _ - '--~ On [Unacknowledged) 1"------.. .
1711012004 "40,,, PM ceJ
',f1071101200414:52:15:612~
O!l 1...&-
-SP....1
i>R: HTA Deviation H~h [Acknowledged]
'V '" PIA On IUr>ock~d]
i
Obiect Toolbar Navigation Toolbar
The trend and alarm tags are added to the Process Analyst during runtime.
Pens can be added to (or removed from) any pane.
Pens are added by using the Add New Penes) dialog. This dialog allows the
operator to search for trend and alarm tags then add pens to the current
window that will represent these tags. An operator can choose pens and
configure their types and names.
I
!ype: Trends o:J Fdtel: I
5ellrchtesults - - - - . - - . - . - - - - - . -..- ..- - . - - - . - -..- ...- - - - . - - - - -..- ..- - - -
Tao I Comment I R<WI Zero Scale I Raw Full5cale I Enalneerino-Zer... I E ·1 AQdpens to:
_TrendX_046 Generic Trend... O. 32000 O. 3 INeWPllne
_TrendX_047 Generic Trend ,.. 0, 32000 O. 3
_TrendX_048 Generic Trend .. , 0, 32000 O. 3 Pen T!pe:
_TrendX_049
PI.P
Generic Trend", 0,
0,
32000
1000,
O.
-10,
3
I
IAnalog
• 1 P2_P 0, 1000, -10. I Pen name :
1~:31~.·:
It:ii·• ••••••••• ~!I:• • •IIII!I.:Iil~~:m~I:
nI.I. • • • •~lI:~I:
I. • •••~.:_-
~ .. ITag
::oJ
41
!-5Sof55
I
S~ectedltems - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
QK ~ancel tlelp
J
Basic Configuration Manual Revision 3 14-5
Pen Types 1
Overview A Process Analyst pen represents either trend or alarm data. The Process
Analyst supports three types of pen: analog, digital, and alarm. Each pen has
its own graphical representation. You can configure most pen properties
during runtime.
Analog Pens The Process Analyst control typically uses analog pens to represent non- I
binary data. Only analog pens have a value (vertical) axis, which the data is
plotted against, as shown here:
J
See Also:
For further information about Analog Pens, see Citect Process Analyst Help -
Analog Pens.
Digital Pens The Process Analyst control typically uses digital pens to represent binary
data. Values on the pen are clamped to a range of 0 to 1. Any value equal to
or greater than 0.5 is clamped to 1; all other values are clamped to O. A fill
color is used to indicate where the data is 1, as shown here:
See Also:
For further information about Digital Pens, see Citect Process Analyst Help -
Digital Pens.
J
14-6 January 2005
n
n Pen Types, Continued
1
n Alarm Pens The Process Analyst uses alarm pens to graphically display the history of a
CitectSCADA alarm over time. The Process Analyst supports seven different
types of alarm pens.
1 The alarm's on/off transition, state changes, and acknowledgments are all
represented graphically in the alarm pen display. To achieve this, the alarm
pen consists of three elements: the alarm state, on/off, and acknowledgment.
The diagram below illustrates how an alarm pen displays the information of
r l an alarm tag:
l@
t
on/off
N
lili
~ I
I
@
See Also:
For further information about Alarm Pens, see Citect Process Analyst Help -
Alarm Pens.
Exercise 14-2 Use the Process Analyst to display the Trend tags that you configured in the
previous chapter.
Ste Action
1 Configure the Process Analyst to display trends in runtime.
i. Run your project and open the page Analyst.
ii. Click the Add Pens button.
1
iii. The Search Type defaults to Trends. Click the §earch button.
iv. All available trends will populate the Search results window.
Pen'name :
Icomment 3
qmment __
~=o ~
Step Action
1 vi. Add the five trend tags that you defined in the Trend chapter
(cant.) to the S!lected Items. The pens may be selected by either
double clicking the trend or highlighting the trend and clicking
the 8dd button. Click OK to continue.
." ..
Def~sear~'" Xi
lype., ITrendS :.::J Fll1:er: I :i.eon:h I
search results --.-------~.--- I
Tao
Pljl
P3Y
I Cammer,!; I En~ellna lJijts I Sample Fe<1od
1.o00ooo
... I
1.o00ooo
I Trend Type
Periodic:
Periodit
I Raw Aqdpensta:
0·1 INeW Pai1e
I
0,1 Pen TI5X':
:.::J I!
P4_P 1.o00ooo Pellodlc 0·1
HTy 1.o00ooo Periodic 0·1
IAnaloo :.::J
Pellname-: I
ITaQ 3 I
~
cI I .!J &kI
l:;ToIt
I I.G !jIJ"
I 1- 5 015 1'I",:t :.-;
I ~"'¢.
I
S!l,letted Items --- - .~~
·iI I .!J
I
_...... _ ... _--,._ .... ,._... ". -~-:-- ,~---_ _
... ...-._-_..- ",---
J
J
2~ I ~enuel
I lielp I:
Step Action
1 vii. The five trend pens will be displayed in a new pane.
(cant.)
3011112004 j2 40:00 PM
~50r, f\_ ~j ~:~l"\ " r\ r\ ....., ", r\ J r>. r'-, l' .w, r......... J~
. :".lL.L..:.~<_.;L . ~~, __l~:<~c~..!. \1.\"
r .. 1°\ I', r f"]:
3011112004 ,00:00 PM
100
... _-_..
Continued on next page
Ste Action
2 ii. Click and hold the pointer on the Date/Time axis. Dragging this
(cant.) axis to the left and right will adjust the time span of the view.
You can also adjust the span by using the scroll wheel on the
mouse.
iii. Click the Show/Hide Cursor ·1'" button on the Main toolbar.
This will display the Cursor and the Cursor Labels. The Cursor
Labels may be toggled on and off by clicking the Show/Hide
Cursor Labels .:r.~' button.
PI_P
2.474176
30/11/20044:58.10 PM
100
(\..r.. . ~J
ii.
How to Process Analyst Control Properties dialog box may be used to configure the
views in the Process Analyst.
or
Right click on the pane and choose Properties from the menu.
~
I.~ ~~~:::e
J Autd-scroll
to Now l! 11
~ Locked Pens
l' Copy
Print
PropeltIes ...
This will open the Citect Process Analyst Control Properties dialog.
Adminifllalion - -..- - - - - _ - - - - -
~gelevet
i
--------===;:=D=K=:;==Ca=n=ceI~I~·~~~=~_.=t~:-=_7==Help==~11
_ _ - _ _----_ __._.._.. _ ___ _._..
.. _" .. .. ~----_.,
Exercise 14-3 Examine the properties ofthe different objects in the Process Analyst.
Ste Action
1 Use the Properties dialog to change the properties of the pens.
i. Click the Show Properties ~ button on the main toolbar.
ii. The left pane displays the Property Tree. This is a hierarchical
list of the Process Analyst Interface components. Select each
of the items in the Property Tree and examine their properties.
l-0.1 ""
"" P4_P
Ei
HT P
Cwsor1
: Default Settings
(0"
r
Valiable
Fi~ed
I Size: ~. weight\plxe!s.
-;;, All pens
l-uij Cursor
-~ Analog
Dig~al
Alarm
EPane
Ste Action
2 Save the Process Analyst View.
iii. Click the Open button. The view will be displayed as it was
saved. If the view had been saved with the Auto-scroll
feature turned on the pens will appear synchronised to "Now".
Exercise 14-4 Use the Process Analyst to compare values from one pen at different times.
Ste Action
1 Remove pens from the display.
i. Highlight one of the pens then click the Remove Pen /'
button.
ii. Repeat for each pen except the pen HT_P.
2 Add the pen a second time so that the values may be
compared.
i. Click the Add Pen f- button and add the pen HT_Po The
object Tree will display both pens.
J
Basic Configuration Manual Revision 3 14-15
Comparing Trend Data, Continued
Ste Action
3 iii. Click and hold the pen and drag the line vertically down the
(cant.) page to separate the two pens.
1112120041 :30:00 P M
1-0·"'0- - - - - - - - + - - - - - - -
'-----------'-------------
4 Unlock the pens so that they may be moved independently.
i. Click the Lock/Unlock Pens button on the Main Toolbar.
ii. Click and hold one of the pens and drag to the right so that the
current data may be compared to earlier data from the same
trend.
111212004 1 :35:00 PM
Ste Action
1 Add Alarm tags to the Process Analyst.
i. Reopen the Analyst page. This will clear the View.
ii. Click the Add pens,)'+ button to open the Add Pens dialog.
iii. This time choose the Type: Alarms for your Search. The alarm
pens may be added into the same pane or a new pane may be
added to the display by choosing Agd pens to: I New pane.
Select the five alarms then click OK.
5eatchtesulls - - - - - - - - - - - - - - -------~--
AWl Agdpensto,
Silo 0 Silo I !New pene ::OJ
Clarifier 0 Clori
HTA 0 Pffl Type:
PIA
IAA
0 PI T
ill
IAlllrm 3
Pen name ,
Irag ::OJ
.!..l 8.dd I
1-5«5
I
Sdectedltems - - - - . -.., . - - - - - - - - - , . -....- ...---.--..- - - - - - - . -....- - -
Commert
Panel
Panel
Pene2
Panel
Pane;?
Ste Action
1 iv. The alarms will be displayed like this.
(cant.)
Exercise 14-6 Display Trend and Alann pens in the same pane.
Ste Action
1 Open the saved View CompareTrends.pav.
2 Add the alarm pen HTA.
,I
Overview:
,I
I
I
~_.J
,J
L~J
J
Menu Configuration Tool
Overview The content of the menus can be configured via the Menu Configuration tool,
which is launched from the Citect Configuration panel of the Admin Tools
page. This panel is accessed during the project runtime.
[f) ~ Pages
~Pages
When the contents of this table are changed by the user, the new
configuration is saved in the Menu.dbf file in the project directory.
~ Pages
The page field is defined as either Generic, or the name of a page within the
project. Generic specifies that the menu is associated with all pages, a specific
page name indicates the menus that will appear just on that particular page.
~ Menuname
The name(s) of the menus included on the specified page.
~ Menuitem
The item(s) that appear within each menu.
~ Submenu
Any submenus that appear in a menu.
Note: Adding a sub menu will automatically remove the action defined
for the menu item it is branched from, as the parent becomes a
placeholder for the list of sub menus.
Ste Action
1 Customise the menu bar to open your pages.
i. Run your Milk_Treatment project and log in as the user
Designer.
ii. Select the menu option Tools I Admin Tools.
iii. On the Admin Tools page choose the Configure Menu option.
~E::o(~::k)i{.:r
~<:jt(':<1Ir!i
~ ':;y:~tf~~Y: ':'t:··tup
El ~ Generic Bl.ltton
"·~Pages
!t>'~ Pages
H+-~ Trends '· • • ~Trends
!
·"·~Alarms
H+"~ Alarms
!
+!""~File ;;~File
!
+!""~ Tools ,';~Tools
Ste Action
v. Expand the Pages branch then drag and drop the Analyst
Item onto the Trends page. Notice that the Action is simply
the name of the page Analyst.
~ Pages
L__ rio" fA;;-;;~~~
! n·'·""L...,,:':.
1-·- J~.~ Pasteuriser
!r- ', _ Tes t
1-- Jtf~ Utility
L-l!.~:
[f] ~
if] ~ Alarms
.,.C",
Updale Page List."
).n,~j'i.·t
~
[f] ~ File
[f] ~ Tools
NewPage
New ButtO/"l
New Item
tJiWl 51lhlOOo"ll
Delete Page
Delete Button
De!' Jter'(l
OtJlcrti 5\tMt'l<tr.
CopyPat;le
Save
J
viii. Close the Menu Configuration dialog
Exercise 15-2 New pages may be configured in the custom menus to create menus that are
either specific to one page or to override the default settings. Create a user
function to provide error checking to the login and logout functions. Then
create a full login menu.
Ste Action
1 Create a new Cicode function.
New E3
New OK
CileclVBA Cancel
Help
iii. Create a function that returns the runtime to the Home page if
the login fails.
FUNCTION
MyLogin ()
INT iFail
iFail = LoginForm(}
IF NOT iFail THEN
CSV_Nav_Home ()
END
END
iv. Create another function that returns the runtime to the Home
page before logging out.
FUNCTION
MyLogout ()
CSV_Nav_Home ()
Logout ()
END
1
v. Save the Cicode file as MenuCommands.ci.
j
Basic Configuration Manual Revision 3 15·5
}
Custom Page Navigation, Continued
Step Action
2 Add an Action to the page templates.
i. Start your project.
ii. Log in as the user Designer.
iii. Open the Admin Tools page.
iv. Open Configure Menu.
v. Right click inside the left pane of the Menu Configuration dialog
and choose New Page from the listed options .
• t.;I.-
New. Buttafllr
New Item
;'J'I)W SJ.o!bu4h
Delet"P*
Delate Button
tl~ER>?ti1
Oo"~<:' :i\iit:Jltv.m
COPYPaQe
Save
vi. Name the page Template. This will override the default
template settings and allow you to add custom commands to
the buttons on the Navigation bar.
vii. Right Click and choose New Button from the Menu. Name the
button Login.
viii. Right Click and choose New Item. Name the item Designer.
Your Menu Configuration should look like this.
~ Generic
if] ~ Pages
±: ~ Trends
±: ~ Alarms
if] ~ File
!
i l+: ~ Tools
i:::::i- Sl Template
]:::::) ~ Login
,-... .Il~!P.. Designer
Action
I ?L.ogin Gesigner,des I
p-rl'""":Vl1-eg-e-----;::lo===.:J=i.j
OK I I Cancel J
?Login Designer,des
xi. Add another two items to the Login button to open the Login Form
and to log out the user.
Step Action
n
3 Delete unnecessary items from the menu.
i. Expand the Pages branch and right click the Update Page
n
List... item. Select Delete Item from the menu.
a··j Gen'3lic
: 8"~ Pages
!!.!!!!._.
•.!!!."!. PasteUliser
_.. ~ Test
i Edltltem
I$'_.~ Trends ··-;-",-pag-·-e---
I
,'I
,_u.'_'"
:]
rJ
[J
[J
[J
iJ'
L
Exercise 15-3 Another way to configure navigation in your project is by changing the
[Navigation] parameters in the Citect.ini file. Create new pages and adjust
the parameters to open these pages from the existing templates.
Ste Action
1 Create a custom Home page.
i. Open the Citect Graphics Builder and open the page
CES_HomePage located in the CES_lncude project.
ii. Save the page in your Milk_Treatment project as Home.
iii. Change the text object that says "Welcome to" to read
" "Welcome to Citect United Dairy".
1 iv. In the menu File I Properties (General) change the Window
Title: as shown below.
Home Properties EI
I I I I
Geoeral Appearance Keybo'lld Commands Events Environment I
Yiindow ti Ie' lalect United Dairy - Home Page
.Q.e&Cliption:
log device: ~
o Help
Ste Action
3 Create custom Alarm pages.
i. Open the Citect Graphics Builder and create a new alarm page
based on the template CES_Style Alarm.
Use Templilte f3
Templ;,te: alarm Sl)lle:
,..
bollom
I OK
standard Ca1cel
top
velsion2
"p_sly!e Ecfit
~
poplrend ~ Linked
r nle~
Resoli:Jtion:
IXGA
Step Action
5 Change the Navigation parameters in the Citect.ini file.
i. Open the Citect Explorer and go to View I Configuration file.
This will open your Citect.ini file.
ii. Add these parameters.
[Naviga t ion]
HomePage = Home
AlarmPage = Alarm
HardwarePage = Hardware
SummaryPage = Summary
ToolsPage = Admin
TrendPage = Trend
Introduction Accumulators keep track of incremental runtime data, such as motor run
hours, power consumption, and downtime. For each accumulator you can set
a trigger (eg. motor on) to increment three counters:
» The number of times the accumulator is triggered (eg. the number of starts
for the motor).
» The run time, in seconds.
» A totalised value, by an increment you define (eg. the current).
You can monitor and display the accumulated data by animating, trending, or
logging the variable tags.
J
1
Configuring an Accumulator
Overview Accumulator data is stored as variable tags, which can either be in an external
I/O Device or in a disk I/O Device. Accumulator data will not usually be
stored in a memory I/O Device as all the data will be lost whenever
CitectHMI/SCADA is restarted.
or
Exercise 16-1 We will use an accumulator to record how often the Centrifugal Clarifier is
started and for how long it has run.
Ste Action
1 Define the following two variable tags for the accumulator
data:
Name
Trigger
Run Time
No. of Starls
Tota~ser Ino
TotaUser
Comment
I I I
I
8dd .Beplace
r Deleted
.Qelele H.elp
I
Record:
-_._.,--------- .:JI
Complete the form with the accumulator properties given in
this table and then click Add.
arne Centrifuge
Trigger
Run Time CENT RT
No. of Starts CENT ST
Step Action
3 On the Utility page in your project, place a text object with the
Text tool A to display the Centrifugal Clarifier status (started
or stopped) and place two numeric objects with the Numeric
tool ## to display the number of starts and run time. Your
display may look similar to the following diagram:
AccumUlators·
centrIfugal Clarifier Stopped
Centrifugal Clarifier Starts: ####
Centrifugal Clarifier Run Time: ####EU
••• _,_,_,_.... _. __,_,, __ , __ ., _ ......... _.....,." .......,., .... ••, "'A'~'_ ... "
n, ...
_
"
,
_
,
"
"
,
"
,
~
n
n
n
~
n
4 Save the page.
S If you are connected to an External I/O Device ignore this
step. If you are not connected to an external I/O Device -
Define the following event:
Name GLOBAL
Time 00:00:00
Period 00:00:05
Action Toggle (Centrifuge_Clar_V)
Overview You can alter the period of checking for the trigger and updating by changing
1 the following accumulator parameters:
[Accumulator]WatchTime
)
This parameter is the time in seconds between each check of the accumulator
I trigger. You can set this parameter to a large value to conserve CPU and PLC
communication time. If you set this parameter to a low value,
CitectHMI/SCADA must poll the PLC more often for the trigger value, using
I CPU and PLC communication bandwidth.
I [Accumulator]UpdateTime
Step Action
1 Change both the Accumulator WatchTime and Accumulator
UpdateTime parameters to 1 second.
i. Open the Citect.ini file.
ii. Add these parameters.
[Accumulator]
watchTime = 1
UpdateTime = 1
. }
OvervieV\(
Introduction You can request regular reports on the status of the plant and reports to
provide infonnation about special conditions in the plant. Reports can be run
on a request basis, at specified times, or when certain events occur (such as a
F 1 change of state in a bit address). Reports can also include Cicode statements
that execute when the report runs.
. )
,__ J
J
J
J
Defining a Report
Overview Reports, like events, can run periodically or be triggered (or both). They may
also be run at any time by using the cicode function ReportO (see the
CitectSCADA Help - Report). The format of a report is specified in the report
format file and the output of the report is defined in a device.
Report Format The sdit button on the report form is linked by default to the standard
File Word pad editor. Clicking on sdit will open an existing report file or open a
blank file if this is a new report. When saving the file, make sure that it has
the correct suffix to match the desired output format:
The report format file can contain information such as static text, formatting
information, cicode and data from variable tags. For a full description of
report format files, see: Citect Help Topics - Reports: Report Format Files.
yr Hints &Tips:
To change the default report editor application:
In Project Editor, select the menu Tools I Options ... and specify the editor to be
used.
Exercise 17-1 Define a new report output device, and then create a report that will be run
manually from a button in the project.
Ste Action
1 Define a new device called PastLog using the following
information:
Name PastLog
File Name [DATA] : Past_Rep. rtf
Type ASCII DEV
No. Files -1
d
~Report5 [Milk_Treatment] I!lIiIEf
Name
Time il Period I !
Trigger f
Repolt Form!ll File
OUlput Dtwice 3 I
I
Comment Ii
I Add fiepJ~ I Qelete I £dit Help I i
I
Record: r Deleted ~l ,
iii. Complete the form using the information in the table below
then click Add to create a new report.
Name Past
Report Format File Past. rtf
Output Device PastLog
J
Basic Configuration Manual Revision 3 17-3
J
Defining a Report, Continued 1
1
Exercise 17-1 (continued)
Step Action
3 Click the ~dit button on the report form to create a blank report
format file and complete the file as follows:
{Cicode}
Prompt ("Report Complete") i
{End}
Overview If you set up a device to point to a file, then you can view that file in
CitectHMIISCADA. The method by which you view the file depends on the
file fonnat.
L. I
~J
~ 1
~_ J
Exercise 17-2 Create a new page in the project to display the RTF report Past.
Ste Action
1 Create a page called !RTF_File based upon the Normal template
which will be used to display the report.
i. Create a new page based upon the CES_Style Normal
template.
ii. Save the page with the name !RTF_File.
iii. Use the Cicode Object tool ftx) to place a cicode object on the
page where you want the top left corner of the RTF file to
appear.
iv. Your page should look like this:
= CSV_Display_ TitleO
~ Cicode
Object
Note: When you are adding this command take care that the
path is correct and that there are no spaces.
See Also:
Citect Help Topics - PageRich TextFile function.
Step Action
2 Create two items in the File menu to run and view the Report.
i. Run your project and log in as the user Designer.
ii. Open the Configure Menu dialog and add two new Items to
the File menu.
Note: The use of -1 in No. of Files means that the device will
create one file. New infonnation written to the device is
appended to the end of the file.
vr Hints &Tips:
To add scrolling to the page, add some buttons to the page that use
the functions DspRichTextScrollO or DspRichTextPgScrollO. See
Appendix C for a further exercise.
,1
Introduction You can configure your CitectHMI/SCADA system to control and monitor all
'1 the processes in your plant. You can monitor and display real-time data, and
define commands that perform specific tasks, such as starting and stopping
machinery, acknowledging alarms and issuing reports.
LJ
Planning Plant Security
Overview Because of the various levels of complexity that can be used in securing a
CitectHMIISCADA system, you should plan very carefully before
implementing any security. You should determine:
In most applications, your operators will issue commands when they are
required. However, there might be some commands that should be restricted
and not available to all your operators, for example, commands that operate
specialised machinery, acknowledge critical alarms, or print sensitive reports.
User records provide this security.
Security can also be based on Areas, where users only have access to the
Areas that are allocated to them in their User definition-a user can be
restricted from operating or viewing a part of the plant that is restricted from
them.
If you do not define an Area or Privilege for an item, then it will default to an
Area of a and a Privilege of O. That item will have no security control, and
that page or control will be available for any user.
A combination of Areas and Privileges gives you an extremely high level of
security.
As well as setting up security for the operation of your plant, it is advisable to
set up security for the CitectHMIISCADA system itself. For example, when
CitectHMIISCADA is running you may not want the operator to switch to
other Windows applications.
Note: Any user assigned a global privilege (of any level) will
automatically have access to all areas.
Example -
A plant has 3 areas and 3 operators. The areas are called Input (Area I),
Processing (Area 2), and Output (Area 3). The operators are called OPI,
OP2, and OP3. The privilege levels are I (primary plant control), 2
(secondary plant control) and 3 (shutdown privilege).
Each operator has responsibility for one part of the plant, and must be able to
see (but not control) the whole plant:
[ Area 1
J [ Area 2
J ( Area 3
J
OP1 OP2 OP3
Viewable Areas 1 ,2,3 Viewable Areas 1,2,3 Viewable Areas 1,2,3
Areas tor Priv 1 1 Areas tor Priv 1 2 Areas tor Priv 1 3
Areas tor Priv 2 1,2 Areas for Priv 2 1,2,3 Areas for Priv 2 3,2
,ll,reas tor Priv 3 1 ,2,3 Areas for Priv 3 1,2,3 Areas for Priv 3 1,2,3
How to To restrict access to a particular page you can assign an area to the page. To
restrict access to an object you can assign both an area and privilege level to
the object.
When allocating areas and privileges, you should start with the page and then
progress to the objects.
Objects can also have a Disable style when an operator has insufficient area or
privilege to operate the object. The selected disable style defines how the
object will appear. Available disable styles are: Embossed, Grayed and
Hidden.
~ Hints &Tips:
It is recommended that disabled objects do not have the hidden style, so users who
have forgotten to log on with sufficient privilege can still see the objects.
Overview You should add a database record for each user (or class of user) of your
runtime system. User records enforce an orderly login and restrict access to
your system by defining the area and privilege rights for a user. Each
operator for whom you add a user record must enter their user name and
password to gain access to the runtime system.
See Also:
Citect Help Topics - Security: Cicodeful1ctions.
or
I
J
Basic Configuration Manual Revision 3 18-5
I J
Adding User Records, Continued
Exercise 18-1 Create 3 user types, Operator, Engineer and Manager and assIgn the
following Areas and Privileges in the Milk_Treatment project:
Exercise 18-1
(continued)
Step Action
1 Add three new users - Operator, Engineer and Manager.
i. In the Citect Explorer, select your project and open the
System folder, then double click on the Users icon.
ii. The following form will appear (press F2 to see the extended
form if it is not visible):
ImJ!If1§iJ·;n1M@!,.I§.I. _ILlJ~
User NilIIle IOperalOl
FuJI Name !plant Operalol
Password IliIAlUt_.-lIJl:llaJIQ.ltl*1C1llr.1I1UllUtklUllOtlllll:ll...
Conl~m PaS$"iOId
I:M1I:JU[1II::MJlJlXICIUI·M _.lClllll~lt~ lNelI'lQI,'lUIIlI.lrJClOIlOClC1I
J
Basic Configuration Manual Revision 3 18-7
Adding User Records, Continued
Ste Action
2 Assign Privilege 1 to objects in your project as shown in the
table below:
yr Hints &Tips:
You will need to open and modify the disable style for the
ValveControl and PumpControl genies - don't forget to save and
use the Update Pages menu command.
Button Properties Ei
0("
Disable when-..· · - · · · - - - - · - - - - - - - - - - - , Q
-=:J~
CD
~
Ii!!.
0("
.:.1 0
'~
P' Disable on InsUfficient'8rea,or p/ivill!lge i
. Dm~ble.$tjJleJ
r Embossed
r Grayed
[ (0 Hidden
-----
Clear Properly I
OK Cancel I Help
Step Action
3 Assign Privilege 2 items, Main Plant Operation (Controllers and
Reports)
/~ (\-\-ec-\. . iV\,
Object / Key Sequence Command Page ( Disable Style
Close Button Touch Parameter i -
[PrivilegeJ
Shutdown
Run Report button Menu Toolbar Embossed
Shutdown - END key Keyboard - -
Info - CTRL-I key Keyboard Pasteuriser -
Pa2e Area
Pasteuriser 1
Utility 2
!RTF File 2
J
Step Action
6 In the Template menu, create the following two items:
Disabling The Control Menu (in the top left comer of an application window) provides
Control Menu commands to position and size the application window, and in some
Commands applications to control the application. The runtime system's Control Menu
can be tailored to give access to several commands specific to
CitectHMIISCADA, such as Shutdown (to shut down the runtime system), or
Kernel (to display the Kernel).
You can enable and disable these commands with the Citect Computer
Setup Wizard.
Displaying Each graphics page and window in CitectHMIISCADA has the option of
Windows turning on or off the display of the title bar. Without a title bar, a window
without Title cannot be moved on the screen or closed with a mouse click. Pages in
Bars CitectHMIISCADA can also be dynamically resized at runtime. Use the
Citect Computer Setup Wizard to enable or disable the Title Bar. You must
also make sure that the Page Properties do not have the Title Bar Option
ticked.
I
Note: When using XP style templates, Windows' title bars should be
, J turned off as the templates have their own built in. XP templates do
not support dynamic sizing and will automatically disable it.
I
Continued on next page
I
I
J
Removing the When the CitectHMIISCADA runtime system starts, a message box displays
Cancel button the status of the system startup. This message box normally contains a Cancel
from the button that allows you to cancel the startup. This button is most useful when
Startup you are debugging or testing the system. You can remove the Cancel button
Message Box
with the Citect Computer Setup Wizard.
You can disable the AU Space command with the Citect Computer Setup
Wizard.
You cannot directly disable the AU Tab, Alt Esc and Ctrl Esc commands -
you should use Windows System Policy Editor or a third party product to
implement Windows desktop security
As the project size increases, the Alarms, Reports and Trend functions can be
run on separate server computers.
" .
CitectSCADA's Client/Server Architecture
Using Below is a small system that consists of one server and four Display Clients.
CitectSCADA
on a Network Display Display Display
Client Client Client
LAN
LD Set\ler /
Display Client
t»='l
To
I/O Devices
These tasks can be performed in a single computer, or you can distribute them
between two or more computers as shown below:
~!1"---....3
!
! . LAN
.0 .-
(~\
.:J--
To
I/O Devices
I
\
LJ
Basic Configuration Manual Revision 3 19-3
, _1
Project Location
Overview When implementing CitectSCADA on a network there are two ways in which
you can run your CitectSCADA projects:
~ You can run your project individually on each computer - each computer
has the project files on its hard disk.
~ You can run your project from a file server - the project files are stored on
one computer on a network and the other computers run this copy of the
project.
The advantages and disadvantages of both methods are outlined below.
Individually ~ Advantages:
- If any of the CitectSCADA computers on the network fails, no other
CitectSCADA computer's project is affected.
- Different projects can be installed on each machine as long as they have
the same project name. This is often used when one area of a plant only
needs to access some of another area's information but not all. This has
the advantage of reducing the point count for that computer.
~ Disadvantages:
- When any changes need to be made that affect the project as a whole, the
changes need to be made on each individual computer. However, in most
cases, projects can be set to update at startup, from a designated master
project (see Help Topics - CtEdit Copy Parameter) and so changes to the
master only require a restart of all other CitectSCADA projects.
- It is difficult to track changes if the project is modified by multiple users.
- Consumes more disk space on individual computers.
LAN
{::~\
To
1/0 Devices
~ Advantages
- When changes need to be made to a project they only need to be done on
the file server and all changes will immediately be reflected on each
individual CitectSCADA computer.
- Negligible amount of disk space is needed on individual CitectSCADA
computers.
~ Disadvantages
- If the file server fails then all Display Clients also fail.
- Each Display Client has the same project running and so each will have
the same point count.
Overview Many industrial plants cannot afford to have their CitectSCADA monitoring
system fail at any time. Building redundancy into your system can prevent
the loss of control and monitoring of your CitectSCADA system.
File Server When using a Global project residing on a Server, you can build file server
Redundancy redundancy into your system. A redundant server ensures that if the main
server fails your system can continue without interruption.
To
I/O Devices
Data Path With most brands of PLCs, you can install a parallel data path from the
Redundancy I/O Server to the I/O Device. A parallel data path ensures that if one data
path fails, your system can continue without interruption.
Primary Standby
Data Path Data Path
J I/O Device
1
I/O Server Systems with a single I/O Server have a single point of failure. If the Server
Redundancy fails, control and monitoring of the system is lost. The single point of failure
can be eliminated with a redundant I/O Server that is connected to the same
I/O Devices. These CitectSCADA Servers are called the primary and standby
servers (you can also use both CitectSCADA servers as Display Clients).
(~-:,
LAN
. j
-,
,
I
LAN A second Local Area Network (LAN) and file server would ensure system
Redundancy stability even in the event of network failure.
LAN 2
~-----f ",
, ,
~----- ,----- I
Complete On large systems with multiple servers, you can parallel the Alarms, Reports,
System and Trends Servers. To achieve this level of redundancy, you configure three
Redundancy other computers (or Display Clients) as standby servers. Then if a primary
server fails, its operation is immediately transferred to its standby server.
Reports
Display Display File File
Servers
Client Client Server 1 Server 2 Pdrnary Standby
LAN 1
LAN 2
Primary Primary
Primary Standby
I/O Server lIO Server
~ Standby '----~-e::::-..-=
••=,.",.",,!J Standby
Trends Alarms
Servers Servers
See Also:
Building Redundancy Into Your System in the Citect Help Topics.
Exercise 19-1 Set up one computer as an I/O Server and Trends, Alarms and Reports Server
and the other computers will be setup as display clients. Below is a diagram
of the network that will be setup in the training room:
To
I/O Devices
Ste Action
1 Run the Citect Computer Setup Wizard to setup the role of your
computer.
i. In the Citect Explorer, select the menu Iools I Computer
§etup.
ii. Select ,Express Setup and click tfext > to continue.
iii. If your computer is going to be the server, select Network
Computer I Server and Display Client as shown:
[Stand-alone computer
r ~etVer and Display Glienl
J
Network c.ompl.lter ~~,'~~'-~
rr ~isp'al' 8~ent
Lr Manage! C6ent
Ste Action
1 If your computer is going to be one of the display clients select
(cant.) Display Client as the role for your computer, as shown:
r s"",."._ "'" t
r. .!Qhp~~ j'.
r .Maneger CUent
<3
J
Click Hext > to continue.
Ste Action
1 vi. Enter the name of the primary Alarms, Reports and Trends
(cont.) Server, as given by your instructor (e.g. Train):
Ste Action
1 vii. The Computer Setup Wizard will automatically assign a unique
(cant.) name for your computer on the network. You can change this
if needed:
atect5CA
GtectH
Help
Step Action
2 Compile and run the project.
3 Check that your project is operating successfully.
i. Check the Production page to see if you have communications
- #COM will indicate no connection to the I/O Server.
ii. Check the Hardware Alarms page. If you get either of the
folloWing hardware alarms - Server name not found or No
server could be found - then there is a problem with your
setup or the server is not running. Check to see if the server
is running. If it is then go through the Computer Setup Wizard
again and then run your project.
~ Hints &Tips:
You do not have to compile your project after running the Citect
Computer Setup Wizard.
, ,
J
Citect Knowledge Base
When you purchase CitectHMI/SCADA, you also receive a recent copy of the
Knowledge Base on the same CD.
The Knowledge Base is being updated constantly, and if you have purchased
support, you can obtain the latest Knowledge Base from the Citect Web site.
Exercise 20-1 Navigate through the Citect Knowledge Base and to find specific information
with the search facility.
Step Action
1 From the Start menu in Windows, run the Citect Knowledge
Base.
2 Click on the Latest Articles branch to view the most recent
additions to the Knowledge Base.
3 Use the §earch tab to search for articles containing information
about Timezone.
4 Use the §earch tab to find Knowledge Base article Q1060 -
read this article.
S Exit the Knowledge Base.
I
I
J
Overview The Kernel provides a window into the core of CitectHMI/SCADA. By using
the Kernel, you can perform low-level diagnostic and debugging operations
for runtime analysis of your CitectHMI/SCADA system. You can use it to
display all the low level data structures, runtime databases, statistics, debug
traces, network traffic, I/O Device traffic and other useful information. You
can also call any inbuilt Cicode function or user-written Cicode function from
the Kernel.
Kernel When displayed, the Citect Kernel consists of an application window and one
Interface or more child windows. The first time the Kernel is invoked, one child
window (called Main) is opened. The Main window contains a command line
interface (similar to the DOS prompt) where you can type in Kernel
commands that perform a Kernel operation or display other child windows.
A few of the Kernel commands and their functions are described below:
Window Function
Main Window Displays startup of modules and driver errors.
Page General Displays general statistical information on the overall
performance of CitectHMI/SCADA and licenses.
Cicode Opens a child window that you can use to call Cicode
functions, on either a local or remote computer. Any
inbuilt or user-written function can be called from this
window.
Page Unit Displays information about each I/O Device in the
CitectHMI/SCADA system.
Page Table Shows each Cicode task and what the current and last
Cicode user functions are, as well as the last Cicode function
executed.
See Also:
For more information on the Citect Kernel, see Citect Help Topics - The
Citect Kernel.
I
,
Basic Configuration Manual Revision 3 20-5
J
The Citect Kernel, Continued
Exercise 20-2 Use the Admin page to open the Kernel and then look at some of the pages in
the Kernel.
Ste Action
1 Run your project and log in as the Engineer.
2 Open the Kernel from the link on the Admin Tools page and
display some of the different Kernel pages.
i. Go to the Admin Tools page and click on the General Window
link to display the Citect Kernel.
~ GI·:·)11Pld \,\;inck)w·
t ';l:atU!c~' \'iinc\Jw
~ R.eset Stat,m:,
,([ Dc,buf)
~ Debug Orr
~ Probe
'SJ Dump <erne!
/"'2\
.•.. c',lclu-q
~~f-'
'·'o·r
~'>'--'''''.-
The services of Citect Support are available to customers who have a current
support agreement.
Required Before you phone Citect Support for the first time, you should be at your
Information computer, with CitectHMIISCADA rmilling, and with the following
when Phoning information:
~ Your site number, company name, and contact phone and facsimile
numbers.
~ The version of CitectHMIISCADA being used and any
CitectHMIISCADA Service Packs you have installed.
~ The type of hardware you are using, including network hardware (if
applicable).
~ A list of other software you are using.
~ The operating system you are using.
~ The exact wording of any messages that displayed on your screen and the
error number, if any.
~ A description of what happened and what you were trying to do when the
problem occurred.
~ A description of how you tried to solve the problem.
I
J
I
~J
Basic Configuration Manual Revision 3 20-7
I
Contacting Citect Support, Continued
Required Please include as much information as possible in the following format and
Information send it to Citect Support by email or facsimile:
Using Fax or
Email Citect Solution Request
CITCITCITCITCITCITCITCITCITCITCITCITCITCITICITCITCITCITCITCITCITCITCIT
CITCIT
This information should reflect your system as close as possible.
Please replace the default information with your details or N/A where applicable.
CITCITCITCITCITCITCITCITCITCITCITCITCITCITICITCITCITCITCITCITCITCITCIT
CITCIT
Cited Support
Which Citect The Citect Support office you should contact can be found in the Getting
Support Office Technical Support section of the CitectSCADA Help Topics.
Should You
Contact?
CitectWeb Go to the Support menu and choose Contact Citect Support from the list. The
Support first time you enter this area you will need to create a MyCitect Support
account. The toolbar on the left will list Support Request Forms in the
available options.
Otect
SCADA & HMllndustrial Automation software
Cited ie the world'.....geat Independent 8upplier of SCAOA. induetrl.'
autometion end Indu.,crl.llnform&tion Manllgement (IIMI solutions. Citett
hll8 over JO yaor. of experience .pecilllizing in innovlltille, relt1ble end eoet
effectiue product•.
.. '29n 1-04 <':11I..-\ Aol..... Cltct"tSCAtiA it> VAt&l'~ Hew in CrlectSCI\OA VI) ~ Customer ~tlsfac:1ion S~y $. MyCitec;\ t4ews
V. ~ AoWy).,~ & o(y'irni<,v with Ciler-tUM HiM! YOlM" say end help us iTtlrove 0l.I' I'kMlIlmb8~;llflf;BJnlw...! ~lm WJt nfl"V!
.. 10111104 Clteet Will" ~-r>u Rapu Gold
""ne Contr.cl
~ Citffi PluJt20usines. V,." ptoc:b::tsllfldsel¥~
t. ClKtomer hcellentt" Awards
• CledSCADA V6 0 - \NeI:J ~
• Sed compenies stend slrong as rMterlell.s
~ ClI.ectSCAOA hurtlirlll for MltfMJlJistri lll'lCI energy costs rise
• 01 t11.(M Au~r.lllnll("'\MIKm 'W'intt in CompetIJOn Closed - see who won
Chlnt i~ Traininij Course Detl--.a
• Sr:d'lil;tt1 on S~h-E!lst Asia
h f IIld .. Pilo;net .. LOAm
" Downlol(K l'OI"'.lOC:.tICUl::fParttlitfr~·'t'OU
• VJddoft.~CO~"'.bf*II~
Vl.I1t our Pr.u Room L• ..Ifn aboUt oUr Products VlalC our Evtnu c-arendl'
l
l