CITECT-1hr Quick Start Tutorial2
CITECT-1hr Quick Start Tutorial2
Definition of Terms......................................................................................................4
Create a New Project Folder.......................................................................................5
Configure an I/O Device..............................................................................................6
Configuring Tags.........................................................................................................8
Creating Graphic Pages............................................................................................12
Creating Graphic Pages, Creating a new page ........................................................13
Creating Graphic Pages, Saving your page..............................................................14
Creating Graphics pages, Configuring buttons. ........................................................15
Creating Graphics Pages, Configuring Symbol Sets ................................................21
Testing Graphics Pages, Computer Setup Wizard ...................................................24
Testing Graphics Pages, Runtime ............................................................................25
Creating Graphics Pages, Precision Drawing...........................................................27
Creating Graphics Pages, Analog Indicators & Controls ..........................................29
Creating Graphics Pages, Configuring Numbers......................................................35
Creating Graphics Pages, 3D rectangles..................................................................36
Creating Graphics Pages, Pumps & Piping ..............................................................37
Creating Graphics Pages, Change Background Color .............................................40
Configure an Alarm Display Page.............................................................................43
Configuring Trends ...................................................................................................45
Configure a Trend Page............................................................................................46
Runtime.....................................................................................................................48
Backing Up Your Project...........................................................................................50
Restoring Your Project..............................................................................................51
Troubleshooting. .......................................................................................................53
Page 2 of 53
1 Hour Quickstart Tutorial
Disclaimer
Citect Pty Ltd makes no
1 Hour Quickstart Tutorial
representations or warranties
with respect to the contents or Welcome, and thank you for purchasing CitectHMI/SCADA. We would like your
use of this manual and, to the
extent permitted by law, experience with the product to be a pleasant one, so we have created this tutorial to
expressly limits its liability for help new users get familiar with some of the fundamental features of the product.
breach of any warranty that
may be implied to the
replacement of this manual The tutorial is designed so that you can complete it in under one hour. The tutorial is
with another. Citect Pty Ltd not intended as a substitute for attending a CitectHMI/SCADA training course. We
assumes no responsibility for
any errors that may be in this encourage you to attend a training course to complete your basic training, learn how to
document and reserves the use time saving tools or go on to learn some of the more advanced features of the
right to revise this document at product.
any time without incurring an
obligation to notify any person
of the revision. Repetition is an important part of learning or memorizing. One way you can speed up
your familiarization is to take a few minutes to click through all the menus in the
Copyright product and (briefly) try and figure out what each thing might be for, if you can’t make
© Copyright 2002, Citect Pty
Ltd. All rights reserved. No part sense of something, don’t be concerned just move on to the next thing anyway. You
of this document may be may not consciously remember everything you see, but it helps to set a framework for
reproduced, photocopied, or
transmitted in any form or by
the mind to put things when you revisit these places in the tutorial and in this way you
any means (electronic or will remember them much better.
mechanical), for any purpose,
without the express written
permission of Citect Pty Ltd.
By completing this tutorial you will learn the following…
Trademarks
Citect, CitectHMI, • Creating a New Project
CitectSCADA and
Plant2Business are registered • Setting Up Communications with a PLC
trademarks of Citect Pty Ltd. • Configuring and deleting tags
All other brand or product
names may be trademarks of • Creating New Graphics
their respective holders. o Use Templates
o Button Commands
o Disabling Buttons
o Dynamic Symbols
o Drawing objects
o Manipulating objects Copy, Paste, Align, Mirror, Send to Back, Size,
Move
o Drawing Text
o Displaying analog values
o Drawing Pipes
o Grouping Objects
o Change background color
o Defining Alarms
o Configure an alarm page
o Storing Trend Data
o Configuring a trend page
• Operating Runtime Displays
• Backing up and restoring a project
Page 3 of 53
1 Hour Quickstart Tutorial
Definition of Terms
Click = Briefly press left mouse button
Drag = Position mouse, click and hold left mouse button, move
mouse, then release mouse button.
Alt+Tab = Press the Alt key, hold it down, then press the Tab key.
Single Click
Double Click
Type
Citect Project Editor – Mainly used for entering database type information
To make sure that you have selected the correct icon you can let the mouse hang over
the icon for about 2 seconds and a tool tip will appear to guide you.
Page 4 of 53
1 Hour Quickstart Tutorial
As you go through this Create a New Project Folder
tutorial you might like
to click on the Help Run the Citect Explorer. The Citect Exporer allows you to create and manage your
button located on CitectHMI/SCADA projects. It is also the controlling configuration application from
many of the dialogs as
which you can run the Project Editor, Graphics Builder and Cicode Editor.
this will show you
some of the other
things available to you Click on Start, Click Programs, Click Citect, Click Citect Explorer.
that are not covered by
this tutorial. On the Tool Bar, Click on the New Project icon.
Tips.
Consider using the
Quickstart Project as
this can save you a lot
of time.
Use the Example In the New Project Dialog Box, type Tutorial in the Name field to give the new
project to get ideas project a name, then Click OK.
and learn how things
are made, by pulling
them apart.
Page 5 of 53
1 Hour Quickstart Tutorial
Page 6 of 53
1 Hour Quickstart Tutorial
On the Express Communications Wizard, just press the Next button for these
windows.
When you see the window below Click Disk I/O Device
Click Next
When you see the page below Click on Citect Generic Protocol
On the following screens you just need to press the Next & Finish buttons.
Page 7 of 53
1 Hour Quickstart Tutorial
Configuring Tags
Click on Tags (in LEFT pane)
Double Click on Variable Tags (in right window)
The right hand window will display Variable Tags, Trend Tags & SPC Tags as shown above.
This will bring the Project Editor to the foreground and display the Variable Tags
dialog. The Project Editor is mainly for editing database type information.
Page 8 of 53
1 Hour Quickstart Tutorial
.
IMPORTANT
Do NOT press Enter before filling in all the required fields. Each time you press Enter,
a new record will be added . For learners, it is better to use the Add button instead. If
you add an extra record by mistake, you can use the Delete button to mark it for
deletion. Once marked for deletion the record will be ignored.
If you press delete by mistake you can press it again to undelete. To view records
marked for deletion go to Tools, select Options, check Show Deleted.
To permanently remove the record go to File then select Pack.
Page 9 of 53
1 Hour Quickstart Tutorial
You can save a lot of Configure Tags Continued…
time configuring tags
by entering similar CAUTION
types of Tags together Where a drop down is provided you should use it. If you
and just changing the
parts that are different
mistype data into fields that require specific settings you
before pressing Add. may cause compile errors.
If you are having difficulty reading from the screen grabs here is the information in text
form.
Page 10 of 53
1 Hour Quickstart Tutorial
The format field Configuring Tags Continued…
defines the default
style of displaying this
vavriable.
# defines number of
characters. Eg; ###.##
would have 3 digits to
the left of decimal and
2 digits to the right.
Please use the scroll bar on the right to scroll through each tag (record) and
double check that you have entered the correct information. On the last tag,
check that the number of tags (records) = 3.
Close the Variable Tags window by clicking on the X in the top right corner.
Page 11 of 53
1 Hour Quickstart Tutorial
Creating Graphic Pages
Switch to the Graphics Builder – click on the Graphics Builder Icon.
The Graphics Builder is an editing utility that you can use to create your graphics
pages and the objects that comprise the graphic pages.
Before you start lets take a look at what you will create.
Page 12 of 53
1 Hour Quickstart Tutorial
In the Use Template dialog, make sure Standard is selected in the Style box, then
Double Click the Normal template as shown.
Instead of double
clicking on Normal
we could single click
on Normal and then
click OK
Page 13 of 53
1 Hour Quickstart Tutorial
###.## indicates
dynamic values that will
change at runtime.
It is good practice to save your graphics pages regularly, so lets begin the habit right
now.
Page 14 of 53
1 Hour Quickstart Tutorial
To draw the button, Click and hold the left mouse button while moving the mouse
then release the left mouse button. ie; Drag the mouse.
Page 15 of 53
1 Hour Quickstart Tutorial
Horizontal Tabs
Vertical Tabs
Page 16 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Buttons Continued…
Pump_1_M will be inserted into the Up Command Edit Box. Click your mouse to the
right of the Tag Pump_1_M and type =0.
When the project is run, pressing on the Manual Button will set the Tag Pump_1_M to
0.
Page 17 of 53
1 Hour Quickstart Tutorial
There are many Creating Graphics Pages, Configuring Buttons Continued…
ways to copy
objects. It is quicker to make copies of things than to draw them from scratch. Here is a quick
way to make a copy and position an object.
Ctrl + D will
duplicate the Place the cursor over the Manual Button.
currently selected Hold down the Ctrl Key.
object. Hold down the left mouse button.
Move the mouse to position the copy.
Ctrl + C will copy an You don’t need to be precise with position at this time – we will fix that later.
object.
If you move the mouse
Ctrl + V will paste an immediately after holding
object. down left mouse button,
then you will only see the
These last two work outline of the object as it is
in almost all moved.
windows programs
so are well worth If you wait half a second
remembering. before moving the mouse,
you will see the object itself
You can also select being moved. The + sign
Copy, Paste or will appear on the hand
duplicate from the about half a second after
Edit menu or by pressing the left mouse
using the icons on button indicating change of
the menu. mode.
Page 18 of 53
1 Hour Quickstart Tutorial
You can also use the Creating Graphics Pages, Configuring Buttons Continued…
reserved word TRUE
instead of a 1, and Click on the Appearance Tab
FALSE instead of a 0. Double Click on the word Manual in the Text: Edit Box, overtype with Auto
Click OK
TRUE and FALSE are
not case sensitive, but
this is a common
convention used to
indicate that this is a
reserved word.
Now we have made some buttons that will set the control mode of the pump into Auto
or Manual. Next we need something to turn the pump on and off. Instead of using two
buttons, one for on, and one for off, we’ll use just one button.
Make a copy of the Auto Button. (Hold Ctrl, Click on Auto Button and hold then
move the mouse).
Change the button Text to read “On/Off”, then Click on the Input Tab
Page 19 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Buttons Continued…
Under the access tab
In the Up Command Edit Box overtype with Toggle(Pump_1_CMD)
you may notice there
is a section called Click on the Access Tab
security. This is a very
powerful feature in You can also use the
Citect that allows you Insert button to lookup
to precisely define who the Toggle function and
can access what. paste it into the Up
Configuring security is Command.
covered in the Citect
Configuration training
course.
Now we will prevent the On/Off button from working while the pump is in Auto mode
and we’ll add a tool tip on the way.
In the Tool tip: Edit Box type “Must be in Manual to Toggle Off and On”
Then Click the Disable Tab. (on the right side of the dialog).
Page 20 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Buttons Continued…
When Pump_1_M is true (in Auto) this button will now be disabled. The buttons
appearance will be altered using the Embossed style to indicate that it is disabled. The
tool tip will not be disabled.
Page 21 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Symbol Sets continued…
In the ON symbol when Edit Box type Pump_1_M=0 then Click OK.
Copy the Symbol Set and place the new one next to the Auto button.
(Hold Ctrl, Hold Left Mouse button on object, move mouse).
In the ON symbol when Edit Box overtype with “Pump_1_M=1” then Click OK.
Page 22 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Symbol Sets continued…
Make a copy of the symbol set and position it next to the On/Off button.
In the On Symbol When Edit Box overtype with Pump_1_CMD then Click OK
Page 23 of 53
1 Hour Quickstart Tutorial
Testing Graphics Pages, Computer Setup Wizard
It’s time to take a look and see how your page looks and feels to an operator.
First however, we need to run the Computer Setup Wizard to configure how you want
this computer to run your project.
Page 24 of 53
1 Hour Quickstart Tutorial
Testing Graphics Pages, Computer Setup Wizard continued…
For the next two screens just Click Next then Click Finish.
If you have not inserted the protection key you will see the following message.
Just Click OK.
Page 25 of 53
1 Hour Quickstart Tutorial
Testing Graphics Pages, Runtime continued…
The menu page is built automatically and is the first page you will see when runtime
starts.
Click on the Auto button and check to see that the light turns red.
Move the mouse over the On/Off button and wait a couple of seconds to see that the
tool tip appears. See what happens if you Click on the On/Off button. Click on
Manual, then try clicking on the On/Off button again.
To switch from runtime back to Graphics Builder, press Alt + Space together
Then Click on Graphics Builder.
If you’ve made to this point, give yourself a gold star and take a moment to stretch
your muscles.
Page 26 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Precision Drawing
Next we’re going to tidy up the appearance of the page. It is worthwhile to make your
pages look good as it will encourage operators, to take a little more care and have
more confidence in the system.
Making sure everything is drawn precisely, aligned correctly and evenly spaced helps
to make your pages look professional.
First we need to select all the buttons. Place the cursor near one of the corners, hold
down the left mouse button while moving the mouse to opposite corner, then
release the left mouse button. ie; Lasso the buttons with the mouse.
In the Vertical section, Click on Even. In the Horizontal section Click on Left, then
Click OK.
Page 27 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Precision Drawing Continued…
Using Snap to Grid To align the lights you can use the same process, but first align one light with the
can save you a lot of center line of the top button and one light with the center line of the bottom button.
aligning. The nice
thing with grids is Click the the top button and the top light. Then Align – Vertical – Center.
that it forces objects Do the same for the bottom button and light.
to be placed in Now select all the lights.
specific positions –
but this is not always Use Align, Vertical - Even, Horizontal - Left to evenly space the lights.
what you want. You
can turn the Grid on
and off quickly using
the F8 function key.
To make sure your objects are aligned or positioned perfectly you can use the Zoom
tool. From the Menu select View, Show Zoom.
You can move the zoom window by placing the cursor on the title bar (the
big blue bar at the top) then hold down the left mouse button and move
the mouse
Page 28 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Precision Drawing Continued…
Select all the lights so that we can move them all at once. Place cursor above and to
left of top button, hold down left mouse button and move mouse, then release
mouse button.
You can precisely position the lights by placing the cursor over the lights (make sure
the hand cursor appears) then press Enter (or hold down left mouse button), next use
the arrow keys on the keyboard to move the buttons one pixel at a time in the
direction that you want. Press enter again to set the position (or release left mouse
button if you used that method). Close the Zoom window.
Select Rectangle Tool from the Toolbox. Place the cursor to the left of the Top button
and draw a rectangle as shown. (Hold down left mouse button and move mouse).
Click on the 3D Effects Tab on the right hand side of the dialog.
Page 29 of 53
1 Hour Quickstart Tutorial
Next use the Zoom and nudge to precisely position the Rectangle. You may need to
change the vertical size to match the height of the buttons.
Place the cursor over the top (or bottom) center selection handle, when you see the
cursor change to the vertical selection arrows, press enter to switch to nudge mode,
then press the up or down arrow keys (on the keyboard) until the height is correct.
With the rectangle selected, Click on the Palette button on the tool bar.
Click on the gray as shown below.
Page 30 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Analog Indicators & Controls continued…
With the Rectangle selected, make a copy of the the rectangle. (Press Ctrl + D).
Click on the Vertical Tab on the right hand side of the dialog.
In the Axis control box, Click on the bottom of the box as shown to anchor the scaling
point at the bottom. Click OK.
Page 31 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Analog Indicators & Controls continued…
.
With the new rectangle selected, Click on the Color palette button on the toolbar,
then click on bright red.
Now position the new rectangle over the top of the first one.
You will need to know the how far (in pixels) the slider needs to move. To find this out
(make sure you still have the rectangle selected) take a look at the bottom right corner
of the Graphics Builder.
The status bar will show you the width and height of the selected object. Write down
the height of the rectangle.
If the status bar is not visible, go to View, Show Status Bar and click on it.
Page 32 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Analog Indicators & Controls continued…
Position the pointer at the left bottom side of the red rectangle.
Double Click on the Pointer Symbol to open the Properties sheet.
Click on the Slider Tab, then Click on the Vertical Tab on the right hand side.
Now is a good time for a regular page save. Click the save icon.
Page 33 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Text
Now we will place some text above the buttons to label the controls.
Type Pump 1.
Note: If you do not see any keyboard echo as you type it is most
likely because the currently selected color is the same as the
background.
Place the cursor above the buttons and click to position the text.
Click Bold, Size 22 (point) and make sure the Foreground color is red.
Click OK.
Page 34 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Configuring Numbers
On the Toolbox, click on the number tool.
Click below the On/Off button to place the number.
Page 35 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, 3D rectangles
Next we’ll add some cosmetics.
Draw a large rectangle that covers all the things you have drawn so far.
Set the Line color to gray, Check the Filled Check box and set the Filled color to
Gray also.
Click on 3Deffects tab.
Page 36 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, 3D rectangles continued…
Since it will be difficult to see your work with the large rectangle in front of it, we need
to send it to the back.
Click to the right and below the new rectangle to place the symbol set.
Click on both Clear buttons.
Click on the Set Button next to the Off Symbol: edit box.
Page 37 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Pumps & Piping continued…
In the Library box, use the scroll bars then click on pumps.
In the Symbol window, use the scroll bars to locate Pump_6_w_r then Double Click
on it.
Page 38 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Pumps & Piping continued…
Page 39 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Pumps & Piping continued…
Page 40 of 53
1 Hour Quickstart Tutorial
Creating Graphics Pages, Change Background Color continued…
The properties dialog will be displayed. On the General Tab you can set the Window
title and other properties of the page. Click on the Appearance Tab to access
appearance properties.
Click on the color shown below. (If you choose a different color some items you will
configure later on may not be visible or stand out very well).
Page 41 of 53
1 Hour Quickstart Tutorial
Configuring Alarm
Switch to Citect Project Editor (Click on the icon or use Alt +Tab keys).
On the Project Editor Menu, Click on Alarms then Click on Digital Alarms
Fill in the Digital Alarms form as shown below. Remember it is better to use the drop
downs to ensure data is entered correctly. When the form is complete press Add.
Page 42 of 53
1 Hour Quickstart Tutorial
Configure an Alarm Display Page
.
Switch to the Citect Graphics Builder using the icon or Alt + Tab keys.
Click on the New icon. When the New form appears click on the Page button.
On the Use Template dialog, use the scroll bar to scroll up to the Alarm Template,
then Double Click on the Alarm Template.
Page 43 of 53
1 Hour Quickstart Tutorial
In the alarm Save As dialog, type Alarm in the Page: edit box, then Click OK.
Page 44 of 53
1 Hour Quickstart Tutorial
Configuring Trends
.
First we need to configure a trend tag to store trend data.
Switch to Citect Project Editor (Click on icon or use Alt +Tab keys).
On the Project Editor Menu, Click on Tags then Click on Trend Tags
Fill in the Trend tag form as below then click Add. Remember to use drop downs
where possible.
There are many more trend features available in Citect. Press F2 with this form
open to see some of the advanced possibilities. Pressing F2 again will return you
to the basic menu’s.
Page 45 of 53
1 Hour Quickstart Tutorial
Configure a Trend Page
Switch to the Citect Graphics Builder using the icon or Alt + Tab keys.
Click on the New icon. When the New form appears click on the Page button.
Page 46 of 53
1 Hour Quickstart Tutorial
Click on the Pen 1 drop down as shown below and select Pump Speed from the list
then Click OK.
Page 47 of 53
1 Hour Quickstart Tutorial
. Use the back Runtime
button at runtime to go Now it’s time to run your project and test it to make sure that you have completed the
back through the tutorial correctly.
pages that you have
visited.
You will also see an alarm is generated. The Alarm clock will rock back and forward.
Click on the Alarm clock to view the Alarm page.
Page 48 of 53
1 Hour Quickstart Tutorial
Runtime continued…
.
You can acknowledge individual alarms by clicking on each alarm.
Place your cursor on the Pointer. Hold down the left mouse and move the mouse up
and down. The red bar should change it’s height in line with the pointer movement.
You should see the trend of the Pump Speed. Take some time to familiarize yourself
with the buttons on the trend page.
Page 49 of 53
1 Hour Quickstart Tutorial
Backing Up Your Project
It is important to keep backup copies of your project, so that you can always recover
from a disaster with minimum effort.
Make sure you are in the Citect Explorer. (Click on the icon or use Alt + Tab).
Use the Browse button to locate a directory where you want to save your files.
Alternately you can type the directory and filename into the Backup File: edit box. If
the directory does not exist Citect HMI/SCADA will automatically create it for you when
it saves the file. Click OK and when the Backup Complete message pops up, Click OK
on that also.
Page 50 of 53
1 Hour Quickstart Tutorial
Restoring Your Project
With any software, it is good practice to check and make sure you can restore from
your backup copies. It is a very rare to experience problems restoring from a backup
but the time taken to check is a tiny fraction compared to the time it would take to
recreate the project from scratch.
Click on the Restore Icon (it is next to the backup icon) or on the menu Click Tools
then Restore.
We will restore to a New project, test it, then delete it, as this is a much better test than
restoring over the existing project and less chance of anything going wrong (eg; what if
the power fails half way through restoring over the top of your existing project and your
backup has a fault in it?).
In the Name: Edit box type a name for the new project eg;Test_Tutorial then click
OK.
When the restore is completed (Click OK on the Restore Complete Dialog), Click on
the Test _Tutorial project to switch to that project.
Page 51 of 53
1 Hour Quickstart Tutorial
Restoring your project continued…
Click on the Citect Runtime icon to make sure the project will compile and run, if
it does then you can have confidence that you have a good backup.
To delete the Test_tutorial project, Click File on the Citect Explorer menu, then click
Delete Project.
Page 52 of 53
1 Hour Quickstart Tutorial
Troubleshooting.
.
If you experience results that are different to what you see in the tutorial…
1. Go back and double check what you have done. Most likely you have done
something different from the instructions.
2. The tutorial largely assumes Citect HMI/SCADA is freshly installed and default
settings haven’t been changed. By taking a closer look at the screens in the
tutorial you may be able to identify any differences.
3. If problem is in Runtime, shutdown runtime and restart it.
4. Read the On Line Help. Most dialog boxes have a help button that provides
context sensitive help with just a mouse click.
5. Read the CitectHMI/SCADA knowledgebase. This is available on the
CitectHMI/SCADA software CD or from our website www.citect.com.
6. Worst case, start again, just create a new project and call it tutorial2. The
upside to this is the extra practice will make you more proficient.
If nothing appears to happen when you press a button, do not press it repeatedly in the
hope that something will happen – chances are your PC is busy trying to do what
you’ve asked it to do.
Page 53 of 53