Professional Documents
Culture Documents
Guide to Mimics
A ClearSCADA Reference Guide
07/2012
PD-6016.15
www.schneider-electric.com
The information provided in this documentation contains general descriptions and/or technical characteristics of
the performance of the products contained herein. This documentation is not intended as a substitute for and is not
to be used for determining suitability or reliability of these products for specific user applications. It is the duty of
any such user or integrator to perform the appropriate and complete risk analysis, evaluation and testing of the
products with respect to the relevant specific application or use thereof. Neither Schneider Electric nor any of its
affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein. If you have any
suggestions for improvements or amendments or have found errors in this publication, please notify us.
No part of this document may be reproduced in any form or by any means, electronic or mechanical, including
photocopying, without express written permission of Schneider Electric.
All pertinent state, regional, and local safety regulations must be observed when installing and using this product.
For reasons of safety and to help ensure compliance with documented system data, only the manufacturer should
perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant instructions must be
followed.
Failure to use Schneider Electric software or approved software with our hardware products may result in injury,
harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
2005, 2012 Schneider Electric. All rights reserved.
PD-6016 07/2012
Table of Contents
PD-6016 07/2012
PD-6016 07/2012
10
11
12
PD-6016 07/2012
Understanding How ClearSCADA Applies Alarm Filters to Embedded Alarms Lists .. 183
Define an Alarm Filter String for an Embedded Alarms List Manually ......................... 185
Use the Filter Window to Create an Alarm Filter String for an Embedded Alarms List 187
Editing an Embedded Image ............................................................................................... 191
Editing an Embedded Remote Image ................................................................................. 193
Editing a Button................................................................................................................... 195
Editing a Pie Chart............................................................................................................... 198
Editing a Pipe ...................................................................................................................... 200
Editing a Text Box................................................................................................................ 201
Border Tab.................................................................................................................... 202
Editing a Group of Mimic Objects ....................................................................................... 203
Common Editing Settings for Mimic Objects ...................................................................... 203
General Tab .................................................................................................................. 204
Fill Tab .......................................................................................................................... 210
Line Tab ........................................................................................................................ 219
Pen Tab ........................................................................................................................ 222
Font Tab ....................................................................................................................... 223
Using the Color Window ..................................................................................................... 226
13
Views.......................................................................................................... 229
Creating a View ................................................................................................................... 230
Editing a View ...................................................................................................................... 231
Removing a View ................................................................................................................. 231
Setting a View as the Default View ...................................................................................... 232
14
15
16
PD-6016 07/2012
17
Hyperlinks ..................................................................................................291
Understanding Hyperlinks and 'Chained' Displays ............................................................. 293
Configuring a Hyperlink on a Mimic .................................................................................... 297
Using Drag and Drop to Create a Hyperlink................................................................. 299
Using the Pick Action Wizard to Create a Hyperlink .................................................... 303
Using Animations to Create a Hyperlink ...................................................................... 307
Creating a Hyperlink to Another Mimic ............................................................................... 310
Creating a Hyperlink to a Mimic Shown at a Specific Level of Magnification.............. 312
Creating a Hyperlink to a Form............................................................................................ 315
Creating a Hyperlink to a List .............................................................................................. 316
Creating a Hyperlink to an Alarms List ................................................................................ 319
Creating a Hyperlink to a Trend or X-Y Plot ........................................................................ 321
Creating a Hyperlink to a Logic Program ............................................................................ 324
Creating a Hyperlink to a Schedule ..................................................................................... 325
Creating a Hyperlink that Displays in an Inset Window....................................................... 326
Creating a Hyperlink to a File .............................................................................................. 326
Creating a Hyperlink to a Web Page ................................................................................... 327
Link to a Web Page by using the Pick Action Wizard .................................................. 327
Link to a Web Page using Drag and Drop .................................................................... 328
Creating a Hyperlink to a Crystal Report............................................................................. 329
Creating a Hyperlink to a ViewX Document on Another ViewX Head ............................... 331
Cross Database Hyperlinks for WebX Clients ..................................................................... 334
Animating a Symbol Object to Hyperlink to Another Display.............................................. 335
Hyperlinks that Define Values for Mimic Parameters on a Target Mimic............................. 337
Locating the Absolute Address of a Display ....................................................................... 342
18
Animations .................................................................................................345
PD-6016 07/2012
PD-6016 07/2012
HeaderTextColour......................................................................................................... 382
Sql ................................................................................................................................ 382
System ......................................................................................................................... 382
TextColour .................................................................................................................... 383
Embedded Alarms List Animations ..................................................................................... 384
Filter.............................................................................................................................. 384
Embedded Trend Animations .............................................................................................. 387
BackAlpha .................................................................................................................... 387
BackColour................................................................................................................... 388
Embedded X-Y Plot Animations .......................................................................................... 389
BackAlpha .................................................................................................................... 389
BackColour................................................................................................................... 390
Image and Remote Image Animations ................................................................................ 391
Alignment ..................................................................................................................... 392
Url and RefreshRate Animations .................................................................................. 393
Pie Chart Animations........................................................................................................... 396
Key Pos ........................................................................................................................ 397
Key Style ...................................................................................................................... 398
Slice Animations........................................................................................................... 399
Pipe Animations................................................................................................................... 401
Width ............................................................................................................................ 401
Fill Animations ..................................................................................................................... 402
Blink.............................................................................................................................. 403
FillAlpha ........................................................................................................................ 404
FillColour ...................................................................................................................... 405
FlashFillAlpha ............................................................................................................... 407
FlashFillColour.............................................................................................................. 407
FlashGradAlpha............................................................................................................ 407
FlashGradColour .......................................................................................................... 408
Flash Mode................................................................................................................... 408
FlashOffset ................................................................................................................... 410
GradAlpha .................................................................................................................... 410
GradAngle .................................................................................................................... 410
GradColour................................................................................................................... 411
GradXPos ..................................................................................................................... 411
GradYPos ..................................................................................................................... 411
Hatch ............................................................................................................................ 412
Type .............................................................................................................................. 415
FillMode Animations ............................................................................................................ 416
Pen Animations.................................................................................................................... 416
Font Animations................................................................................................................... 417
Family ........................................................................................................................... 418
Height ........................................................................................................................... 419
HorzAlignment.............................................................................................................. 420
Orientation.................................................................................................................... 420
Style.............................................................................................................................. 421
PD-6016 07/2012
19
20
10
PD-6016 07/2012
Safety Information
Important Information
Read these instructions carefully, and familiarize yourself with ClearSCADA before trying
to install, operate, or maintain your system. The following special messages may appear
throughout this documentation or on the ClearSCADA application to warn of potential
hazards or to call attention to information that clarifies or simplifies a procedure.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained only by
qualified personnel. No responsibility is assumed by Schneider Electric for any
consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction and
operation of electrical equipment and the installation, and has received safety training to
recognize and avoid the hazards involved.
PD-6016 07/2012
11
WARNING
UNINTENDED EQUIPMENT OPERATION
The configuration of this product requires expertise in the design, configuration and programming
of SCADA control systems. Only persons with such experience should be allowed to configure
ClearSCADA. Only persons with the appropriate programming experience should be allowed to
write any scripts, Logic programs, expressions, or SQL queries intended for use in ClearSCADA.
Follow all local and national safety codes and standards.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
12
PD-6016 07/2012
Document Scope
This guide explains how to configure and operate ClearSCADAs interactive graphical
displays (Mimics).
For details on the subjects covered in this Guide, see Welcome to the Mimics Guide, on
page 15.
Intended Audience
This guide is intended for system operators who use Mimics to interact with the system
and also for those engineers who are responsible for the configuration and management
of Mimics.
Validity Note
This guide is valid for ClearSCADA 2010 R3 running on computers that are using an
appropriate Windows operating system (see Operating Systems, on page 25 in the
ClearSCADA Installation Guide).
Further Information
System Requirements: see ClearSCADA System Requirements, on page 11 in the
ClearSCADA Installation Guide.
Related Documents
This guide includes references to content in the following guides:
ClearSCADA Guide to Expressions
ClearSCADA Guide to Server Administration
ClearSCADA Guide to the Database
ClearSCADA Guide to Core Configuration
ClearSCADA Guide to Security
ClearSCADA Guide to Lists
ClearSCADA Guide to Trends
ClearSCADA Guide to Client Administration
ClearSCADA Installation Guide.
PD-6016 07/2012
13
User Comments
We welcome your comments about this guide. You can reach us by e-mail at
technicalsupport@controlmicrosystems.com.
14
PD-6016 07/2012
Welcome to the ClearSCADA Guide to Mimics. This guide provides reference information
about the various aspects of Mimic configuration and operation.
The guide consists of the following sections:
PD-6016 07/2012
15
16
PD-6016 07/2012
2 Displaying a Mimic
There are two types of Mimic that you can display in ViewX:
In WebX, you can only display Mimics that are stored in the database.
There are various techniques you can use to display a Mimic, some of which are only
available if your User account is configured to have certain features enabled or has
specific security permissions. In the following sections, we describe the various ways in
which you can display a Mimic, explain the difference between the two Mimic modes (Run
Mode and Design Mode), and also provide an overview of the Mimic interface:
Displaying Mimics that are Stored in the Database (see page 18)
PD-6016 07/2012
17
Use an Alarms List or Alarm Banner to Display a Mimic (see page 24)
Use the WebX Database Page to Display a Mimic (see page 25).
When you display a Mimic, it is shown in Run Mode or Design Mode, depending on the
technique you used to display the Mimic, the permissions allocated to your User account,
and the configuration of your User account. If you have the Configure permission for the
Mimic, you can switch between Run Mode and Design Mode as required (see Run Mode
and Design Mode, on page 26).
Further Information
The Mimic Display (see page 27).
18
PD-6016 07/2012
Double-click on the Mimic that you want to display (if your User account has the
Configure permission for the Mimic and has the Double Click Edits Documents feature
enabled, the Mimic will display in Design Mode; if Double Click Edits Documents is
disabled or you do not have the Configure permission, the Mimic is displayed in Run
Mode).
For more information on permissions, see Permissions for Database Items, on page 148
in the ClearSCADA Guide to Security. For details on the Double Click Edits Documents
feature, see Define the General ViewX Settings for a User, on page 109 in the
ClearSCADA Guide to Security.
Right-click on the Mimic that you want to display, then select the Display option to
display a Mimic in Run Mode. Alternatively, select the Edit option to display a Mimic in
Design Mode (see Run Mode and Design Mode, on page 26). The Edit option is only
available if you have the Configure permission.
Right-click on a Group, Group Template or Group Instance that contains the default
view Mimic you want to display, then select the Display Default View option. You can
only display a Mimic in this way if the Group, Group Template or Group Instance has
been configured to have a Default View.
Right-click on a database item for which an alarm has been raised, then select the
Display Alarm View option. This will display the Mimic that has been defined as the
Alarm View for the database item. You can only display a Mimic in this way if the
selected database item has an active alarm and has been configured to have a Alarm
View.
Right-click on a database item for which a Help View Mimic has been defined, then
select the Display Help View option. This will display the Mimic that has been defined
as the Help View for the database item. You can only display a Mimic in this way if the
selected database item has been configured to have a Help View.
Right-click on a database item then select the Display <Extra Link Field> option, where
<Extra Link Field> is the name of a metadata field (custom field) that has been
configured to provide access to a Mimic. Selecting a metadata field of this type will only
display the Mimic that is associated with the metadata field.
PD-6016 07/2012
19
If a database item references a Mimic, you can use the Display References action for
the item to gain access to the Mimic. The Display References action is available from
the context-sensitive menu for relevant database items.
When you select the Display References action for an item, a References window is
displayed. The References window contains a list of all of the database items that the
selected item references, including Mimics. You can display any of the listed Mimics by
double-clicking on the name of the required Mimic in the list of references.
Further Information
Database Bar: see Explorer Bars used in ViewX, on page 67 in the ClearSCADA Guide to
ViewX and WebX Clients.
The Mimic Display (see page 27)
20
PD-6016 07/2012
Further Information
WebX: see WebX Client, on page 37 in the ClearSCADA Guide to ViewX and WebX
Clients.
Lists: see Welcome to the ClearSCADA Guide to Lists, on page 11 in the ClearSCADA
Guide to Lists.
Lists in WebX: see View and Action Lists on a WebX Client, on page 61 in the ClearSCADA
Guide to ViewX and WebX Clients.
PD-6016 07/2012
21
Objects that provide access to the context sensitive menu of any item, including other
Mimics
If you display a Mimic that contains a hyperlink to another Mimic or provides access to a
Mimics context sensitive menu, you can use that Mimic to display other Mimics:
Either:
Select a hyperlink pick action that is configured to link to the Mimic you want to display.
Or:
Select a pick action that is configured to provide access to an items context sensitive
menu (object menu), then select Display Default View, Display Alarm View, Display Help
View, or Display <Extra Link Field> as required. These options work in the same way as
when accessed via the Database Bar (see Use the Database Bar to Display a Mimic, on
page 19).
Or:
Select a pick action that is configured to provide access to the Mimics context
sensitive menu (object menu), then select Display or Edit as required. These options
work in the same way as when accessed via the Database Bar (see Use the Database
Bar to Display a Mimic, on page 19)
When you use a Mimic to display another Mimic, the target Mimic (the Mimic that is
displayed when you select the hyperlink or action) can be shown in place of the original
Mimic, in a new window, or in an inset window. You can use the navigation features of
ViewX or the web browser used by WebX to move between the Mimics as required (see
Use the Navigation Features to Display a Mimic, on page 23).
Further Information
The Mimic Display (see page 27)
Hyperlinks (see page 291).
22
PD-6016 07/2012
If a Home Page Mimic has not been defined for the Guest User account or your User
account, the Home toolbar button is grayed out and cannot be selected.
The web browser used by WebX also has Back and Next buttons that you can use to
move between a sequence of displays, and the WebX interface has a Home button that,
when selected, displays the Home Page Mimic for your User account. If you have not
logged on, selecting the Home button will either display the Home Page Mimic for the
Guest User account or will display the default Mimic for the system, depending on
whether the Guest User has a Home Page Mimic configured). It is also possible to
configure the web browsers own Home button to display a Mimic by entering the http:/
address of a Mimic in the web browsers Home Page configuration settings.
To use the Navigation features to display a Mimic (ViewX and WebX):
Use the Back button/option to display a Mimic that was the previous ClearSCADA
document on display (in a chain of displays, where you have navigated away from the
Mimic to another display).
Use the Forward button/option to display a Mimic that is the next ClearSCADA
document on display (in a chain of displays, where you have navigated away from the
Mimic to another display).
Use the Home button/option to display a Mimic that is configured as the home page for
your user account/the Guest user account or the default Mimic for your system. For
more information, see Define the Client Specific Settings for the Guest User, on page
127 in the ClearSCADA Guide to Security and also see Define the Homepage Settings
for a User, on page 96 in the ClearSCADA Guide to Security.
NOTE: If you access ViewX via a User account that does not have a Home Page Mimic
defined in its configuration, the Home button is unavailable. In WebX, logging on via a User
account that has no defined Home Page Mimic will cause the browser to display the default
Mimic for the system.
Further Information
Navigating Between Mimics (see page 42).
The Mimic Display (see page 27)
PD-6016 07/2012
23
Display Help View to display the Mimic that is configured as the Help View Mimic
Display Alarm View to display the Mimic that is configured as the Alarm View Mimic for
the item in alarm.
24
PD-6016 07/2012
PD-6016 07/2012
25
Run Mode:
When a Mimic is displayed in Run Mode, its operational features are active. For
example, hyperlinks can be selected and will cause other displays to be shown, and
animated values will update in real-time. Run Mode is usually the active mode for
Mimics in control rooms etc., where they are used by operator level users to interact
with the system.
The Mimic configuration-related features are unavailable when a Mimic is displayed in
Run Mode. You cannot configure any Mimic objects when a Mimic is in Run mode, even
if your User account has the Configure permission.
Design Mode:
When a Mimic is displayed in Design Mode, its configuration features are active. For
example, if you select a hyperlink, you access the configuration settings for the
hyperlink rather than trigger the hyperlink to show the target display.
You can only access Design Mode if your User account has the Configure permission
for the Mimic. When a Mimic is in Design mode, you can add objects, edit objects,
rearrange objects, add views and layers etc. You can also create scripts and animations
and associate Mimic objects with pick actions.
Typically, operator level users have accounts that restrict their access to configuration
features, so they will only use Mimics in Run Mode. Engineers often have the Configure
permission and so can access both Run Mode and Design Mode.
If you are configuring a Mimic and need to test whether pick actions, animations etc.
work, you will need to switch the Mimic from Design Mode into Run Mode. This is
because pick action menus and animations are only active in Run Mode. To switch
between the two modes:
The Design button toggles between Run Mode and Design Mode (when it appears to be
pressed down, the Mimic is in Design Mode).You can also select/deselect the Design
option on the View menu.
NOTE: In WebX, you can only display Mimics in Run Mode. To configure a Mimic, you have
to use a ViewX client.
Further Information
The Mimic Display (see page 27)
26
PD-6016 07/2012
Depending on the configuration of the Mimic, the permissions allocated to your user
account, and the mode in which the Mimic is displayed, you may be able to:
Access pick action menus and context sensitive menus for Mimic objects by selecting
or right-clicking on a Mimic object. The pick action menus provide access to
operational features in Run Mode and configuration options in Design Mode.
Select Mimic objects that have been configured to act as hyperlinks to other displays
Use the Mimic Menu Options (see page 30) to access design and operational features
for Mimic objects and the Mimic itself.
Use the Mimic Editing Toolbar (see page 32) and Alignment Toolbar (see page 33) to
access Mimic design features.
PD-6016 07/2012
27
When you display a Mimic in Run Mode, you can access context sensitive menus by
selecting any object that is configured to provide a context sensitive menu. You can
determine which objects have context sensitive menus by looking closely at the cursor:
28
When you position the cursor over a Mimic object that provides access to a context
sensitive menu or acts as a trigger for a method, hyperlink etc., the cursor changes
from an arrow to a hand with a pointing finger.
When a Mimic object does not provide access to a context sensitive menu and does
not act as a trigger, the cursor is shown as an arrow.
PD-6016 07/2012
For information on the options that are displayed in the context sensitive menus, please
refer to:
Further Information
Run Mode and Design Mode (see page 26).
PD-6016 07/2012
29
The following list describes those menus and menu options that you can use specifically
when designing and operating Mimics:
File
30
Save as FileUse to save a Mimic as a file rather than as a database item (see File
Based Mimics, on page 51).
Edit
LayersUse to display the Layers window which you can use to create, delete, edit
and re-order layers on your Mimic. This option is only available in Design mode. For
more information, see Layers, on page 233.
ViewsUse to add, edit and remove Mimic views. This option is only available in
Design mode. For more information, see Views, on page 229.
AnimationsUse to add, edit and remove Mimic animations. This option is only
available in Design mode. For more information, see Animations, on page 345.
ParametersUse to add, edit and remove Mimic parameters. This option is only
available in Design mode. For more information, see Mimic Parameters, on page
461.
Import DXF FileUse to import a DXF file into a Mimic. This option is only available
in Design mode. For more information, see Importing a DXF File, on page 143.
Edit ScriptUse to access the script for a Mimic. This option is only available in
Design mode when the Mimic is configured to have scripting enabled. For more
information, see Mimic Scripts, on page 17 in the ClearSCADA Guide to Scripting.
Debug ModeUse to run the debugger on a Mimic script to test the validity of the
script. For more information, see Mimic Scripts, on page 17 in the ClearSCADA
Guide to Scripting.
PD-6016 07/2012
View
DesignUse to toggle between Design Mode and Run Mode. For more
information, see Run Mode and Design Mode, on page 26.
Display RulerUse to toggle the ruler. The ruler is only available in Design mode.
For more information, see Using the Mimic Ruler, on page 74.
Show Pick ActionsUse to toggle the highlight that shows which Mimic objects are
configured to provide access to a pick action. This sub-menu is only available in
Run Mode and has a None option for turning the highlight off and an Active option
for turning the highlight on.
Mimic DiagnosticsUse to display the Mimic Details dialog box which contains a
list of the Mimics contents. You can copy individual items in the list to your PCs
clipboard by using the Copy option, or copy every item by selecting Copy All. For
more information, see Displaying Mimic Diagnostics, on page 472.
Mimic NavigatorUse to display the Mimic Navigator which helps you to locate any
invalid expressions or animations on a Mimic. For more information, see Using the
Mimic Navigator to Locate Invalid Animations and Pick Actions, on page 473.
Tools
If you select Options to display the Options window, you will see that there is a
Mimics tab that allows you to define General Mimic settings, Update Rates, and
Custom Menu settings (see Using the Options Window to Define Settings that apply
to All Mimics, on page 79).
InsertUse the options in the Insert menu to add new objects to a Mimic. You can
choose from Line, Rectangle, Ellipse, Polygon, Pipe, Text, Image, Remote Image,
Button, Pie Chart, Mimic, Trend, X-Y Plot, List, Alarms List, Windows Metafile, and SVG
File. For more information, see Adding Objects to a Mimic, on page 111.
ArrangeUse to reorder the objects on your Mimic, make and break groups of objects,
combine and split polylines, reshape segments, rotate and flip objects, and change the
alignment of objects. For more information, see Mimic Editing Features, on page 58.
Of course, there are also common menus such as Window and Help and the menus also
contain other options which are applicable to many types of ClearSCADA display. For
more information, please refer to the documentation for the type of display you are using.
PD-6016 07/2012
31
The buttons on the Mimic Editing toolbar are (from left to right):
Insert LineAdds a line to the Mimic (see Add Shapes to a Mimic, on page 112)
Insert RectangleAdds a rectangle to the Mimic (see Add Shapes to a Mimic, on page
112)
Insert EllipseAdds an ellipse to the Mimic (see Add Shapes to a Mimic, on page 112)
Insert PolygonAdds a polygon to the Mimic (see Add Shapes to a Mimic, on page
112)
Insert PipeAdds a pipe to the Mimic (see Add Shapes to a Mimic, on page 112)
Insert TextAdds a text box to the Mimic (see Add Text to a Mimic, on page 113)
Insert ImageAdds an image file to the Mimic (see Embed an Image on a Mimic, on
page 126)
Insert Remote ImageAdds an image file that is hosted externally to the Mimic (see
Add Remote Images to a Mimic, on page 128)
Insert ButtonAdds a button to the Mimic (see Add a Button to a Mimic, on page 131)
Insert Pie ChartAdds a pie chart to the Mimic (see Add a Pie Chart to a Mimic, on
page 133)
Insert MimicEmbeds a Mimic on the Mimic (see Embed a Mimic on a Mimic, on page
114)
Insert X-Y PlotEmbeds an X-Y Plot on the Mimic (see Embed an X-Y Plot on a Mimic,
on page 119)
Insert ListEmbeds a List on the Mimic (see Embed a Queries List on a Mimic, on page
121)
Insert Alarms ListEmbeds an Alarms List on the Mimic (see Embed an Alarms List on
a Mimic, on page 125)
Active LayerUse to navigate between the Mimics layers. The layer that you select is
the active layer i.e. is the layer currently on display (see Layers, on page 233).
LayersUse to display the Layers window which you can use to add, edit and remove
the Mimics layers (see Layers, on page 233).
Further Information
Alignment Toolbar (see page 33)
32
PD-6016 07/2012
Alignment Toolbar
ClearSCADA includes an Alignment toolbar that you can use to quickly access Mimic
arrangement features. You can toggle the Alignment toolbar on and off via the
View>Toolbars menu.
The Alignment toolbar allows you to control how Mimic objects are placed on the Mimic
background. You can also use it to Group and Un-Group Mimic objects.
Certain buttons on the Alignment toolbar are only available when a minimum of two or
three Mimic objects are displayed or currently selected. The Alignment buttons are (in
order from left to right):
GroupOnly available when two or more Mimic objects are selected, the Group button
groups the selected objects so that they become 1 single group object. (see Making a
Group of Mimic Objects, on page 69)
UnGroupOnly available when a Group object is selected, the UnGroup button breaks
a group so that its objects become individual objects again (see Making a Group of
Mimic Objects, on page 69).
Bring to FrontOnly available when two or more Mimic objects are shown on the
Mimic, the Bring to Front button moves the currently selected object(s) in front of the
other objects on the Mimic. For more information, see Changing the Order of Mimic
Objects, on page 62.
Send to BackOnly available when two or more Mimic objects are shown on the
Mimic, the Send to Back button moves the currently selected object(s) behind the other
objects on the Mimic. For more information, see Changing the Order of Mimic Objects,
on page 62.
Bring ForwardOnly available when two or more Mimic objects are shown on the
Mimic, the Bring Forward button moves the currently selected object(s) in front of one
other layer of objects on the Mimic. For more information, see Changing the Order of
Mimic Objects, on page 62.
Send BackwardOnly available when two or more Mimic objects are shown on the
Mimic, the Bring Forward button moves the currently selected object(s) behind one
other layer of objects on the Mimic. For more information, see Changing the Order of
Mimic Objects, on page 62.
Left AlignOnly available when two or more Mimic objects are selected on the Mimic,
the Left Align button moves the currently selected object(s) so that they are aligned with
the left-hand side of the left-most selected object. For more information, see Changing
the Order of Mimic Objects, on page 62.
Center HorizontallyOnly available when two or more Mimic objects are selected on
the Mimic, the Center Horizontally button moves the currently selected object(s) so that
they are aligned with the horizontal center of the background. For more information, see
Changing the Order of Mimic Objects, on page 62.
Right AlignOnly available when two or more Mimic objects are selected on the Mimic,
the Right Align button moves the currently selected object(s) so that they are aligned
with the right-hand side of the right-most selected object. For more information, see
Changing the Order of Mimic Objects, on page 62.
PD-6016 07/2012
33
Top AlignOnly available when two or more Mimic objects are selected on the Mimic,
the Top Align button moves the currently selected object(s) so that they are aligned with
the uppermost side of the uppermost selected object. For more information, see
Changing the Order of Mimic Objects, on page 62.
Center VerticallyOnly available when two or more Mimic objects are selected on the
Mimic, the Center Vertically button moves the currently selected object(s) so that they
are aligned with the vertical center of the Mimic background. For more information, see
Changing the Order of Mimic Objects, on page 62.
Bottom AlignOnly available when two or more Mimic objects are selected on the
Mimic, the Bottom Align button moves the currently selected object(s) so that they are
aligned with the bottom edge of the selected object that is nearest the bottom of the
Mimic. For more information, see Changing the Order of Mimic Objects, on page 62.
Space HorizontalOnly available when three or more Mimic objects are selected on
the Mimic, the Space Horizontal button moves the currently selected object(s) so that
they are evenly spaced horizontally across the Mimic. For more information, see
Changing the Order of Mimic Objects, on page 62.
Space VerticalOnly available when three or more Mimic objects are selected on the
Mimic, the Space Horizontal button moves the currently selected object(s) so that they
are evenly spaced vertically across the Mimic. For more information, see Changing the
Order of Mimic Objects, on page 62.
GridUse to toggle the Grid on and off (see Define the Grid Settings for a Mimic, on
page 100).
RulerUse to toggle the Ruler on and off (see Using the Mimic Ruler, on page 74).
Further Information
Mimic Editing Toolbar (see page 32)
34
PD-6016 07/2012
3 Operating a Mimic
This section describes the basic navigation and operation features for Mimics, which
include:
Moving the Mimic within the Display (Panning) (see page 39)
Operator level users will need to have a good knowledge of the navigation and operation
features so that they can perform their duties. Engineer level users will also need an
understanding of the navigation and operation features so that they can test the Mimics
that they have configured. Some features, such as the magnification tools can be used
during Mimic configuration.
NOTE: For information on common displays such as menus, toolbars, and the Explorer Bar,
please refer to the ClearSCADA Guide to ViewX and WebX.
PD-6016 07/2012
35
If you have a mouse that has a wheel, you can use the wheel to change the level of
magnification. Roll the wheel forward to zoom in and roll it backwards to zoom out.
NOTE: The various magnification tools only have the described effect if the Mimic is
configured to allow magnification. Mimics can have their Zooming features enabled and
disabled via the Mimic Properties window (see Define the Magnification Settings for a Mimic,
on page 99).
36
PD-6016 07/2012
Zoom
In ViewX, you can use the Zoom combo box to display a Mimic at default levels of
magnification or to define a custom magnification level. The Zoom combo box is shown
on the Navigate toolbar.
In WebX, the Zoom feature is made available via the context sensitive menu that is
displayed when you right-click on the background of a Mimic.
When you select the Zoom combo box, a list of default magnification levels is shown. You
can choose any of the magnification levels or you can highlight the entry in the combo
box and overwrite it by typing a new value.
Overwriting the Zoom value is useful when you need to set the Mimic to a specific level of
magnification. For example, if a Mimic has a layer that is configured to be only visible
when the Mimic is shown at 30-50% magnification, you can overwrite the Zoom value to
any value in this range.
As well as the default levels of magnification, the Zoom combo box also provides 3
magnification options:
Size to PictureMagnifies the Mimic so that it makes maximum use of the ViewX
Document Display Area. The aspect ratio maintains the dimensions of the Mimic and
determines the amount of border that is shown.
Size to ContentMagnifies the Mimic so that the content of the Mimic makes
maximum use of the ViewX Document Display Area.
Size to SelectionMagnifies the Mimic so that the Mimic display is zoomed in on the
Mimic object you have selected.
The Zoom combo box is the magnification tool that provides you with the greatest
amount of controlyou can specify the exact amount of magnification required.
PD-6016 07/2012
37
Zoom In
Zoom Out
In WebX, the Zoom In and Zoom Out features are available via the context sensitive menu
that is displayed when you right-click on the background of a Mimic.
You can use the Zoom In tool to increase the magnification of your Mimic. The Zoom In
tool is useful for magnifying complex areas of a Mimic that may not be clearly visible when
the Mimic is displayed at its default magnification. It can also be used to display different
layers (Mimics can contain layers of information, with certain layers only visible when the
Mimic is shown in a specified range of magnification).
If you select the Zoom In tool, the magnification level is increased.
The Zoom Out tool has the opposite effect to the Zoom In toolit reduces the level of
magnification. The Zoom Out tool is useful for reducing the magnification of a Mimic so
that you can see more of the Mimic, although it may make it more difficult to view
complex areas or small text.
38
PD-6016 07/2012
Zoom Box
You can use the Zoom Box tool to magnify a Mimic. The main advantage of the Zoom Box
over the other Zoom tools is that it allows you to specify which part of a Mimic is to be
shown at an increased level of magnification.
To use the Zoom Box:
1.
Draw a selection box over the area that you want to magnify.
The area will be magnified when you release the left-hand mouse button.
3.
Select any area on the Mimic and keep the left-hand mouse button pressed down.
3.
Move the cursor to move the Mimic within the ViewX Document Display Area.
4.
Release the left-hand mouse button when the required part of the Mimic is shown.
NOTE: You can also use the Navigator tool to move the Mimic within the ViewX Document
Display Area (see Using the Navigator on a Mimic, on page 41).
PD-6016 07/2012
39
Locking a Mimic
You can use the Lock tool to determine whether a Mimic retains its original dimensions which correspond to A4 paper (landscape) - when you resize the ViewX/Webx window.
This feature is useful for setting a Mimic so that it is shown in its entirety.
When you activate the Lock tool, the Mimic makes maximum use of the ViewX or WebX
Document Display Area. This means that the level of magnification is changed
automatically so that the entire Mimic is visible.
When you de-activate the Lock tool, ViewX or WebX disregards the Mimic' s original
dimensions. The Mimic remains at its defined magnification and sizeparts of the Mimic
may be out of view when you resize the ViewX/WebX window (although you will be able to
scroll to any area of the Mimic).
To use the Lock tool:
40
PD-6016 07/2012
In the Navigator window, drag the Navigator Box over the area of the Mimic that you
want to view.
The relevant part of the Mimic is shown in the ViewX Document Display Area.
3.
Use the Zoom In and Zoom Out tools (or the mouse wheel if available) to increase or
decrease the level of magnification. When you change the level of magnification, you
will see that the Navigator Box becomes smaller (when you zoom in) or larger (when you
zoom out).
NOTE: Embedded objects such as lists are not shown in the Navigator window.
For more information on the Zoom In and Zoom Out tools, see Zoom In and Zoom Out, on
page 38.
PD-6016 07/2012
41
Back
Forward
Example:
An operator begins by viewing the default Mimic for a Group. In this instance, the default
Mimic is the 'Area 2 Monitoring Station' Mimic (1). The operator selects a link (in this case, a
button is configured to act as a hyperlink) to the 'Site Overview' Mimic (2). The operator
selects the Back button to return to the 'Area 2 Monitoring Station Mimic' (1).
42
PD-6016 07/2012
The operator selects the Forward button to proceed to the 'Site Overview' Mimic (2). On the
'Site Overview' Mimic, the operator selects the Site Alarms button which links to the 'Alarms'
Mimic (3). Then the operator selects the Staff button on the 'Alarms' Mimic to link to the
'Staff' Mimic (4). On the 'Staff' Mimic, the operator selects the Back button and is returned
to the 'Alarms' Mimic (3). From the 'Alarms' Mimic, the operator can select the Back button
again to return to the 'Site Overview' Mimic or select the Forward button to proceed to the
'Staff' Mimic.
PD-6016 07/2012
43
A context sensitive menu is displayed. It contains an option for each layer. The layers
that are currently on display are prefixed by a check mark.
2.
Select the option for the layer that you want to show or hide. If the layer was previously
on display, its check mark will be removed when you select it and the layer will be
hidden; if the layer was not on display, a check mark will be added to the option and the
layer will be shown on the Mimic.
NOTE: The layer names are defined during the configuration of the layers on the Mimic.
For more information on layers, see Layers, on page 233.
44
PD-6016 07/2012
Either:
Or:
2.
Select the required View from the list. (The name of each View is defined by the user
that configured the Mimic).
The Mimic is magnified and panned automatically to show the selected view.
For more information on Mimic Views, see Views, on page 229.
PD-6016 07/2012
45
Mimic objects can also be configured to perform a method when they are selected. This
means that when you select the object, a specific action takes place. For example, a
Mimic object could be configured to write a value to the database when you select it.
To access a pick action menu on a Mimic, simply select an object that has been
configured to provide access to a pick action menu. Usually, Mimics are designed in such
a way that it is clear which objects provide access to controls. For example, if a button is
configured to write a value to the database, the text on the button should indicate its
purpose.
NOTE: The availability of pick actions on a Mimic is dependent on the configuration of the
Mimic.
46
PD-6016 07/2012
PD-6016 07/2012
47
48
PD-6016 07/2012
To create a new Mimic that is stored in the database, you need to create a new Mimic
database item. You can only create a new Mimic database item if your User account has
the Configure permission for the Group that is to contain the Mimic.
To create a new Mimic database item:
1.
In the Database Bar, right-click on the Group, Group Template, or system that is to
contain the new Mimic.
A new Mimic database item is added to the Database Bar. It is selected automatically,
ready for you to define its name.
4.
Type a suitable name then press the Enter key to confirm (or select another part of the
ViewX interface).
When you have created a new Mimic database item, you can configure the Mimic. To
configure the Mimic, you need to display it in Design mode (see Displaying a Mimic, on
page 17). Once the Mimic is displayed in Design mode, you can add objects to it (see
Adding Objects to a Mimic, on page 111) and edit them.
We recommend that you refer to Designing a Mimic (see page 53) before starting your
Mimic configuration.
NOTE: You can also create new Mimics that are not part of the database (see File Based
Mimics, on page 51).
You can also define the Mimic properties (see Configuring the Mimic Properties, on page
77)
PD-6016 07/2012
49
50
PD-6016 07/2012
You can create Mimics that are not stored as part of the database. Instead, they are
stored as files on your network or on removable media such as CD-R.
File based Mimics are useful for engineers that need to experiment with Mimic
configuration. As file based Mimics have no effect on the database, users can alter
settings knowing that their actions will not have an adverse effect on the system.
ATTENTION: Mimic scripting cannot be used with file based Mimics as they have no host
system. If you load a file based Mimic that contains a script, ClearSCADA disables scripting
for that Mimic automatically and removes the script.
There are 2 ways to create a file based Mimic:
1.
Log on via an account that has the Configure Local Files permission (on the User Form)
and has the Configure permission for the Group that contains the Mimic.
2.
Select the New button on the File toolbar (or select the File menu then the New option,
then the Mimic option on the New File window)
Or:
1.
Log on via an account that has the Configure Local Files permission (on the User Form)
and has the Configure permission for the Group that contains the Mimic.
2.
3.
Select the File menu, then select the Save As File button.
4.
Choose an appropriate location and enter a suitable name for the Mimic file.
5.
A copy of the Mimic in the database is saved as a .DRW file at the specified location.
NOTE: When you save a Mimic as a .DRW file, any relative references are converted to
absolute references automatically. This is because relative references cannot be used with a
file based Mimic, as a file based Mimic is not part of the database and so has no relative
position to any database item. File based Mimics can only use absolute references as
absolute references define a specific location.
To open a file based Mimic:
1.
Select the Open button on the File toolbar or select the File menu, then the Open
option.
2.
3.
You can edit file based Mimics in exactly the same way as Mimics that are stored in the
database. The only difference is that any references to items in the database have to use
absolute paths. You need to remember this if you enter references manually.
PD-6016 07/2012
51
52
PD-6016 07/2012
6 Designing a Mimic
To configure a Mimic, you have to log on via a User account that has the Configure
permission for the Group that is to contain (or already contains), the Mimic. To save the
Mimic to the database, your User account also needs to have the Configure Document
and Configure Database permissions (defined in the User account configuration). To save
the Mimic as a file, your User account has to have the Configure Local Files permission
(also defined in the User account configuration).
When you have logged on via a suitable account, you can display a Mimic in Design mode
and begin configuring it by adding objects and editing them. Before you create a Mimic,
you should familiarize yourself with the following sections:
These sections will help you to design user-friendly Mimics and work efficiently. By using
features such as the Symbol Library, you can significantly reduce the amount of time and
effort required to create a practical and visually appealing Mimic.
When you are ready to begin the configuration of your Mimic, we recommend you begin
by Configuring the Mimic Properties (see page 77).
PD-6016 07/2012
53
Design Considerations
We recommend that each Mimic you design is:
Easy to interact withOperators will be able to function more quickly and efficiently if
the interactive parts of each Mimic (controls, navigation features etc.) are clearly
labelled.
Aesthetically pleasingthe Mimic should not be cluttered with too much information
and should use a color scheme that is complimentary to the information and objects
being displayed.
Polylines (in particular, where lots of separate lines are used where a single
segmented line or curved line could be used to create the same effect)
Objects with the Fast Update feature enabled (the Fast Update feature should be
used sparingly).
Designed to make use of the default Mimic PropertiesIf you need to create multiple
Mimics that require objects with the same settings, you will be able to save time and
effort by using the Mimic Properties settings. The Mimic Properties settings allow you
to define default settings for a single Mimic that you are configuring, or for every Mimic
that you configure on your client.
The default settings can reduce your workload, especially if you need to configure
several Mimics to contain objects that have the same attributes. For example, if you are
configuring 6 Mimics and each of these Mimics needs text boxes that use the same
coloring, font, size etc., it is quicker to define the text box settings once as default
settings than to configure them individually. Once you have defined the required
settings as the default settings, every text box that you add will already have the
required settings in place (as it will have the default settings automatically).
For more information on applying default settings to a single Mimic or every new Mimic
that you configure on your client, see Configuring the Mimic Properties, on page 77.
54
PD-6016 07/2012
Designed to make use of Group Templates and Group InstancesIf you need to create
multiple Mimics that contain the same type of information, you may benefit from using
the Group Template and Group Instances features. By using Group Templates and
Group Instances, you may be able to significantly reduce the amount of time it takes to
configure and maintain the Mimics.
When you create a Mimic in a Group Template, copies of that Mimic are automatically
added to the Group Instances that are 'children' of the Group Template. The Mimics in
the Group Instances are exactly the same as the Mimic in the Group Template, and any
changes you make to the Mimic in the Group Template are inherited by the Mimics in
the Group Instances. By default, you cannot edit any of the features of the Mimics in the
Group Instances. However, by using parameter items and the Property Override
features, you can configure a Mimic in a Group Template so that some of its properties
can be edited in the Group Instance versions.
Parameter items allow you to store values (strings, links, doubles etc.) that can be used
as the source of an animation on a Mimic. This means that you can create animations
on a Mimic in a Group Template that obtain their source values from the parameter
items that are stored in the Group Template. The Group Instances that are associated
with the Group Template automatically contain copies of the parameter items. By using
the Property Override feature on the parameter items in the Group Template, you can
allow the values of the parameter items to be reconfigured within each Group Instance.
You can then change the source values within each Group Instance as required. The
Mimics in the Group Instances will retain the overall look of the Mimic in the Group
Template, but can have different values as the source of the animations as required.
This reduces the amount of time and effort required to configure Mimics, as you can
design one 'master' Mimic that is used throughout the system. You can then change
the values of the parameters in the Group Instances so that each Group Instance
version of the Mimic displays different information.
Example:
A Group Template is created along with two Group Instances named 'West' and 'East'
respectively. The 'West' and 'East' Group Instances are associated with the Group
Template and so inherit their configuration and items from the Group Template.
A Mimic is configured in a Group Template. The Mimic contains a text box that displays
the name of a site: 'Main Site'. The text box is animated by a parameter item that stores
the text string 'Main Site'. By default, the Group Instance versions of the Mimic also
display 'Main Site' in the text box.
The Property Override feature of the Group Template item is used to enable overrides
on the string property of the parameter item. This means that users can configure a new
string for the Group Instance versions of the parameter item.
In the 'West' Group Instance, a user accesses the Form for the parameter item and
changes the String value from 'Main Site' to 'Western Site'. The Mimic in the 'West'
Group Instance changesits text box now displays 'Western Site'. The Mimic in the
'East' Group Instance and in the Group Template both still display 'Main Site'.
In the 'East' Group Instance, the string value of the parameter item is reconfigured to be
'Eastern Site'. The Mimic in the 'East' Group Instance changes to display 'Eastern Site'.
The Mimic in the Group Template still displays 'Main Site' and the Mimic in the 'West'
Group Instance still displays 'Western Site'.
PD-6016 07/2012
55
A tank symbol is added to the Mimic in the Group Template. As the Group Instances are
still associated with the Group Template, the tank is also added to the Mimics in the
Group Instances. Only those properties that can be overridden for each Group Instance
item can be different on the Group Instance versions of the Mimic (in this case, the
string values of the parameters can be different).
NOTE: Parameter database items are different to Mimic parameters. Parameter
database items store values that can be used to animate Mimic properties. Mimic
parameters allow you to create embedded Mimics that vary according to the values
associated with its parameters.
By taking these factors into account before you begin to design your Mimic, you can go
on to create a Mimic that runs efficiently, and provides the functionality you require.
You should also consider:
Using the symbol Mimics from the symbol library to reduce the amount of time it takes
to create visually appealing Mimic objects (see Using the Symbol Library, on page 57).
How users will access the Mimic. A Mimic can be associated with a Default View, Alarm
View, or Help View as well as being available as a database item and the target display
of hyperlinks.
For more information, please refer to the following sections:
Default View: see Defining a Default View, on page 213 in the ClearSCADA Guide to
Core Configuration
Alarm View: see Defining an Item or Groups Alarm Properties, on page 215 in the
ClearSCADA Guide to Core Configuration
Help View: see Specify a Help View, on page 200 in the ClearSCADA Guide to Core
Configuration
When you have considered your design and are ready to begin the Mimic configuration,
you will need to add objects to your Mimic (see Adding Objects to a Mimic, on page 111),
and you will need to edit them (see Mimic Editing Features, on page 58).
Further Information
For more information on Group Templates, Group Instances, and Property Overrides, see
Group Templates and Group Instances, on page 83 in the ClearSCADA Guide to Core
Configuration.
56
PD-6016 07/2012
A selection of the symbol Mimics that are available in the Symbol Library.
You can:
Copy the objects on a symbol library Mimic and paste them onto your own Mimic. This
is useful if you only want to use part of a symbol Mimic or you want to make alterations
to the object(s) on the symbol Mimic.
By using the symbol library, you can significantly reduce the amount of time it takes to
configure your Mimics. You can use the symbol library Mimics to represent common
system objects such as pumps, valves, pylons etc.
The symbol library Mimics also illustrate some of the effects that can be achieved with the
various Mimic editing tools.
The latest version of the symbol library is included on your ClearSCADA installation CD
(you can import the library file into your database by using the Import option that is
available when you right-click on a system in the Database Bar in ViewX).
PD-6016 07/2012
57
The editing pick menu has the following options which you can use during the design of
your Mimic:
58
CutUse to remove the object from the Mimic and place in the clipboard storage area
of your PC.
CopyUse to make a duplicate of the selected object. The duplicate is placed in the
clipboard storage area of your PC and replaces any data that is in the clipboard.
PasteUse to add the contents of your PC's clipboard storage area to the Mimic.
Paste SpecialUse to add the contents of your PC's clipboard storage area to the
Mimic. This option differs to the standard Paste option as it allows you to select which
format is used for the information being 'pasted' onto a Mimic. The Paste Special
option is only available when the clipboard area contains data in multiple formats, for
example, if you use the Copy Shortcut feature, this copies a hyperlink to the clipboard
area. You can then use the Paste Special option to paste the hyperlink onto a Mimic as
an actual hyperlink or as plain text.
DeleteUse to remove the selected object from the Mimic. The deleted object is not
stored on your PC's clipboard area.
Bring to FrontUse to move a Mimic object to the front (see Changing the Order of
Mimic Objects, on page 62).
Send to BackUse to move a Mimic object to the back (see Changing the Order of
Mimic Objects, on page 62).
PD-6016 07/2012
Bring ForwardUse to move a Mimic object forwards (see Changing the Order of
Mimic Objects, on page 62).
Send BackwardUse to move a Mimic object backwards (see Changing the Order of
Mimic Objects, on page 62).
FlipUse to flip a Mimic object so that it becomes a mirror image of its original self (see
Flipping a Mimic Object, on page 63).
RotateUse to change the angle of a Mimic object (see Rotating a Mimic Object, on
page 63).
AnimationsUse to access the Animations window for the selected Mimic object (see
Using the Animations Window, on page 348).
Pick Action WizardUse to access the Pick Action Wizard for the selected Mimic
object (see Associating Mimic Objects with Pick Actions, on page 247).
Advanced Pick MenuUse to access the Pick Menu window (see Custom Pick Action
Menus, on page 265)
Define PathUse to start the path definition process. After selecting this option, you
can define the path for a position animation (see Position Animations, on page 453)
Edit PointsUse to change the shape of a Mimic object (see Changing the Shape of an
Object, on page 65).
Convert to PipeUse to convert the selected shape or line into a pipe object.
Convert to PolylineUse to convert the selected pipe object into a shape or line.
SimplifyUse to simplify a Mimic object so that it contains fewer lines. This is designed
for use with the Import DXF File feature (see Importing a DXF File, on page 143).
PropertiesUse to access the Properties window for the selected Mimic object. For
more information, please refer to the section that describes editing the type of object.
For example, if you want to use the Properties window for a pipe object, see Editing a
Pipe, on page 200.
There are also useful Mimic editing features available via the main menu options at the top
of the display. Of particular use on Mimics are:
Edit > LayersDisplays the Layers window (see Layers, on page 233)
Edit > ViewsDisplays the Views window (see Views, on page 229)
Edit > AnimationsDisplays the Animations window for the currently selected object
(see Animations, on page 345)
Edit > ParametersDisplays the Mimic Parameters window (see Mimic Parameters, on
page 461)
Edit > Import DXF FileAllows you to import a DXF file (see Importing a DXF File, on
page 143)
View > DesignAllows you to toggle between Run mode and Design mode.
View > Mimic DiagnosticsDisplays the Mimic Details window. This option is only
available when a Mimic object is currently selected and it provides a list of detailed
information about that object, including the total number of its layers, pick actions etc.
PD-6016 07/2012
59
60
View > Mimic NavigatorDisplays the Mimic Navigator window. This option is only
available when a Mimic object is currently selected and it allows you to check for invalid
configuration on a Mimic (see Using the Mimic Navigator to Locate Invalid Animations
and Pick Actions, on page 473). You can also use this feature to switch easily between
objects on a Mimic - simply double click on the object you want to select in the Mimic
Navigator, then close the Properties window that is displayed to select the object.
Insert > LineAllows you to insert a line (see Add Shapes to a Mimic, on page 112)
Insert > RectangleAllows you to insert a rectangle (see Add Shapes to a Mimic, on
page 112)
Insert > EllipseAllows you to insert an ellipse (see Add Shapes to a Mimic, on page
112)
Insert > PolygonAllows you to insert a polygon (see Add Shapes to a Mimic, on page
112)
Insert > PipeAllows you to insert a pipe (see Add Shapes to a Mimic, on page 112)
Insert > TextAllows you to insert text (see Add Text to a Mimic, on page 113)
Insert > ImageAllows you to insert an image (see Embed an Image on a Mimic, on
page 126)
Insert > Remote ImageAllows you to insert an image that is stored on a web server
(see Add Remote Images to a Mimic, on page 128)
Insert > ButtonAllows you to insert a button (see Add a Button to a Mimic, on page
131)
Insert > Pie ChartAllows you to insert a pie chart (see Add a Pie Chart to a Mimic, on
page 133)
Insert > MimicAllows you to insert an embedded Mimic (see Embed a Mimic on a
Mimic, on page 114)
Insert > TrendAllows you to insert an embedded pre-configured Trend (see Embed a
Pre-Configured Trend on a Mimic, on page 117)
Insert > X-Y PlotAllows you to insert an embedded X-Y Plot (see Embed an X-Y Plot
on a Mimic, on page 119)
Insert > Alarms ListAllows you to insert an embedded Alarms List (see Embed an
Alarms List on a Mimic, on page 125)
Insert > Windows Meta FileAllows you to import a Windows meta file (see Importing a
Windows Metafile, on page 147)
Insert > SVG FileAllows you to import an SVG file (see Importing an SVG File, on page
145)
Arrange > Bring to FrontUse to bring an object to the front of a layer (see Changing
the Order of Mimic Objects, on page 62)
Arrange > Send to BackUse to send an object to the back of a layer (see Changing
the Order of Mimic Objects, on page 62).
Arrange > Bring ForwardUse to bring an object forward one position on a layer (see
Changing the Order of Mimic Objects, on page 62).
Arrange > Send BackwardUse to send an object back one position on a layer (see
Changing the Order of Mimic Objects, on page 62).
PD-6016 07/2012
Arrange > Make GroupUse to group multiple selected objects (see Making a Group of
Mimic Objects, on page 69)
Arrange > Break GroupUse to ungroup a selected group of objects (see Making a
Group of Mimic Objects, on page 69).
Arrange > Combine PolylinesUse to merge multiple selected shapes into a single
shape (see Creating a New Shape by Combining Mimic Objects, on page 70).
Arrange > Split PolylineUse to separate a combined shape into separate shapes (see
Creating a New Shape by Combining Mimic Objects, on page 70).
Arrange > AlignUse to position objects on a layer. You can choose from Left (aligns
the left-hand edges of the selected objects), Center Horizontally (aligns the center of
each of the selected objects along the horizontal axis), Right (aligns the right-hand side
of the selected objects), Top (aligns the top edge of the selected objects), Center
Vertically (aligns the center of each of the selected objects along the vertical axis),
Bottom (aligns the bottom edge of the selected objects).
Arrange > Space EvenlyDistributes the selected objects so that they have an equal
amount of space between them. The arrangement can be applied along the Horizontal
axis or Vertical axis.
Arrange > FlipAllows you to flip an object (see Flipping a Mimic Object, on page 63)
Arrange > RotateAllows you to rotate an object (see Rotating a Mimic Object, on
page 63)
Arrange >SegmentAllows you to split, curve, open, close and detach a segment (see
Changing the Shape of an Object, on page 65)
PD-6016 07/2012
61
By using the Bring to Front, Send to Back, Bring Forward, and Send Backward features,
you can change the order of the objects on your Mimic. For example, by using the Bring
Forward option on the Mimic shown above, you could move the circle in front of the
square.
To use the order features:
1.
2.
NOTE: Alternatively, you can also use the ordering options on the Alignment Bar or on the
Arrange menu.
62
PD-6016 07/2012
NOTE: The Flip feature is only available for Pipes, Lines, and Shapes.
To flip an object:
1.
2.
NOTE: You can also access the Flip options via the Arrange menu.
NOTE: The Rotate feature is only available for Pipes, Lines, and Shapes.
PD-6016 07/2012
63
2.
FreeThe object is selected for rotation. You control the amount of rotation by
holding down the left-hand mouse button and using the mouse to move the cursor.
Release the left-hand mouse button when the Mimic object is shown at the required
angle.
NOTE: You can also access the Rotate options via the Arrange menu.
For information on setting up a rotation animation, see Rotation Animations, on page 452.
64
PD-6016 07/2012
A rectangle forms a
figure by connecting 4
drawing points
By using the Edit Points feature and then making use of the segment tools, you can move
part of a figure. This allows you to manipulate shapes so that they can form irregular
shapes or can have curved lines. For example, you can curve two ends of a rectangle so
that it looks like a cylinder.
PD-6016 07/2012
65
2.
The handles for the object are shown and the segment options become available.
Handles
If you want to reshape the object but have no need for curved lines, proceed to step 4.
If you want to reshape the object so that it has one or more curved lines, proceed to
step 6.
If you want to reshape the object so that a segment is opened, closed, or removed,
proceed to step 10.
4.
5.
Repeat step 4 for the other handles until the Mimic object has the required shape.
NOTE: If you need to divide a line, right-click on it and select the Split Segment option.
An additional handle is added to the line.
If you need to open, close, or delete any of the segments, proceed to step 9, otherwise
proceed to step 12.
6.
Right-click on the line that you want to curve. You can select any line between 2
handles. This means that you can select parts of a line if the line has several handles.
Curve Segment (1 Handle)Adds 1 handle to the line. When you drag the handle,
the line will curve with the handle being the center of the arc.
66
PD-6016 07/2012
Curve Segment (2 Handles)Adds 2 handles to the line. The line can have 2
curves, one for each handle. When you drag either handle, the line curves with the
selected handle being the center of one arc.
8.
Drag the handle(s) to create the required curves. If you need to open, close, or delete
any of the segments proceed to step 9, otherwise proceed to step 12.
9.
Select the segment that you want to open, close, or remove. The handles for the
segment become black when it is selected.
Open SegmentUse this option to open the segment so that there is no line
between its handles.
PD-6016 07/2012
67
Delete SegmentUse this option to remove a segment. This will cause the object
to be reshaped as the handles either side of the deleted segment will connect to
complete the 'loop' for the line, pipe, or shape.
The segment is deleted and the
handles either side of the segment
connect to complete the 'loop' for
the line, pipe, or shape.
NOTE: You can straighten any curved segment by right-clicking on the segment and
selecting the Straighten Segment option from the context sensitive menu.
12. Right-click on the object and select the Select Object(s) option to return to the object
selection mode (i.e. turn Edit Points off).
NOTE: The segment options are also available from the Arrange menu.
68
PD-6016 07/2012
2.
3.
Select the other Mimic objects that are to be in the group in turn, keeping the Shift key
pressed down.
4.
When you have selected the Mimic objects, press the right-hand mouse button to
display a context sensitive menu.
5.
Alternatively, you can draw a selection rectangle over the Mimic objects that are to be in
the group (first, check that there are no drawing tools selected, and then draw the
selection rectangle by pressing the left-hand mouse button down and dragging the cursor
over the Mimic objects). When you have drawn the selection rectangle, the Mimic objects
in the rectangle are selected. Press the right-hand mouse button, then select the Make
Group option from the context sensitive menu.
If you want to take Mimic objects out of a group, right-click on the group and select the
Break Group option. This cancels the last group formation.
PD-6016 07/2012
69
Even-OddThe operating system determines whether each pixel of the shape should
be 'filled' or 'open'. To do this, it counts the number of lines between each pixel and the
edge of the Mimic. If the number is even, the pixel is included in the shape and is 'filled';
if the number is odd, the pixel is excluded from the shape and is 'open'.
Example:
Two rectangles are set to overlap.
The Fill Mode is set to Even-Odd and the rectangles are combined by using the
Combine Polylines action. The rectangles are combined to create the following shape:
The space where the rectangles overlapped is 'open' (not filled). To determine this, the
operating system counted the number of lines crossed when drawing a 'ray' from each
pixel to the edge of the Mimic. As the 'rays' for each pixel in the overlapping area cross
an even number of lines, the area is 'open'.
Crosses first line
The operating system determines how many lines are crossed when drawing a 'ray' from each
pixel to the edge of the Mimic. In this case, the 'ray' crosses 2 lines, so the number of lines
crossed is even. The pixel is 'open' and is excluded from the shape.
70
PD-6016 07/2012
The areas that do not overlap are included in the shape. The operating system
determines this in the same way, by counting the number of lines crossed when
drawing a 'ray' from each pixel to the edge of the Mimic. As the number is odd, the
pixels are included in the shape.
Non-ZeroThe operating system determines whether each pixel of the shape should
be 'filled' or 'open'. To do this, it draws a 'ray' from each pixel to the edge of the Mimic.
Each time the 'ray' crosses the line of a shape, it adds or subtracts one from a total:
If the 'ray' crosses the line of a shape that was drawn in a clockwise direction, 1 is
added to the total.
If the 'ray' crosses the line of a shape that was drawn in an anti-clockwise direction,
1 is deducted from the total.
If the final total is zero, the pixel is not included in the shape. If the final total is any
number other than zero, the pixel is included in the shape.
Example:
Two rectangles are set to overlap.
The Fill Mode is set to Non-Zero and the rectangles are combined by using the
Combine Polylines action. The rectangles are combined to create the following shape:
PD-6016 07/2012
71
The space where the rectangles overlapped is 'filled'. To determine this, the operating
system counted the number of lines crossed when drawing a 'ray' from each pixel to the
edge of the Mimic. Each time the 'ray' crossed a line that was drawn in a clockwise
direction, the operating system added 1 to the total. Each time the 'ray' crossed a line
that was drawn in an anti-clockwise direction, the operating system deducted 1 from
the total.
As the total number for the pixels in the overlapping area was not zero, the pixels are
included in the shape.
From this pixel, the 'ray' crosses 2 lines that were drawn
in a clockwise direction. This means the total is 2, and so
not zero. As the total for the pixel is not zero, it is
included as part of the shape.
NOTE: Shapes in ClearSCADA are usually drawn in a clockwise direction. However, you
can use the Line tool and the Polygon tool to draw shapes in an anti-clockwise direction
if required.
The Fill Mode is mainly used when combining shapes and is also used internally when
importing Third Party graphics such as SVG files. However, the same methodology is
used when determining the fill for a complex polyline that you have drawn manually
the areas between the lines will be 'filled' or left 'open' according to the Fill Mode
setting and the number of lines that are crossed by the 'ray'.
72
PD-6016 07/2012
Display the relevant Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
Or:
Positioning the cursor on an empty area of the Mimic, then with the left-hand mouse
button pressed down, drag the cursor so that it draws a selection box over the
objects you want to select. Release the mouse button to select the objects in the
selection box.
3.
Right-click to display a context sensitive menu, then select the Combine Polylines
option.
The shapes are combined into a single shape. By default, the shape uses the Even-Odd
Fill Mode.
4.
Right-click to display a context sensitive menu, then select the Properties option to
display the Multiple Selection Properties window.
5.
On the General tab of the Multiple Selection Properties window, use the Fill Mode
combo box to select Even-Odd or Non-Zero as required.
6.
7.
Select the objects to be included in the shape again (see step 2).
NOTE: When you combine shapes, the resulting shape will use the Fill properties of the
uppermost object in the selection (the object that is 'top' in the z order i.e. is layered above
the other objects or was created before the other objects).
PD-6016 07/2012
73
Or:
74
Select the View menu, then select the Display Ruler option.
PD-6016 07/2012
Keyboard Shortcuts
You can use the following keyboard shortcuts when designing a Mimic:
AltHold an Alt key when moving, resizing, or adding an object to disable the snap to
grid feature. (Design mode).
Shift:
Hold a Shift key when adding an object to force a 1:1 size ratio.
Hold a Shift key when adding a straight line to force an angle of 15.
Hold a Shift key when resizing to maintain the current aspect ratio.
CtrlHold a Ctrl key when you need to select multiple objects. Keep the Ctrl key
pressed down as you select the objects in turn.
Ctrl+MMake Group.
Ctrl+BBreak Group.
Ctrl+UpBring Forward.
Ctrl+DownSend Backward.
Ctrl+Shift+UpBring to Front.
Ctrl+Shift+DownSend to Back.
Ctrl+LNext Layer.
Ctrl+Shift+LPrevious Layer.
NOTE: The standard Windows keyboard shortcuts such as Ctrl+C for copy are also
available.
PD-6016 07/2012
75
76
PD-6016 07/2012
Before you begin adding and configuring individual Mimic objects, you should make use
of the settings on the Options window and also those on the Mimic Properties window.
These two windows allow you to define default settings that apply to either:
Or:
Or:
By defining appropriate default settings, you can significantly reduce the amount of time
and effort required to configure your Mimics, especially if you are configuring multiple
Mimics that need to have objects with similar or identical properties. For example, let us
assume that you are going to create and configure 4 Mimics, and each of these Mimics
needs to have text boxes that use the same font styles and colors etc. Rather than
configure each Mimics text boxes individually, you can define the text box settings in the
default settings. Then every text box that you add will have the required settings already in
place (as the new text boxes will use the default settings automatically).
In the following sections, we explain how to use the Options window and Mimic
Properties window to apply settings that can affect one or more Mimics:
Using the Options Window to Define Settings that apply to All Mimics (see page 79)
Define whether Flash Effects are Active in all Windows (see page 81)
Defining the Default Mimic Properties for New Mimics (see page 88)
Defining the Default Mimic Properties for a Specific Mimic (see page 89)
PD-6016 07/2012
Add, Edit, Reorder and Remove Layers on a Mimic (see page 93)
Smooth Mimic Graphics with the Anti-Aliasing Feature (see page 94)
77
78
Define the Polyline Line Settings for a Mimic (see page 101)
Define the Polyline Fill Settings for a Mimic (see page 102)
Define the Text Pen Settings for a Mimic (see page 103)
Define the Text Fill Settings for a Mimic (see page 104)
Define the Text Font Settings for a Mimic (see page 105)
Define the Button Pen Settings for a Mimic (see page 106)
Define the Button Fill Settings for a Mimic (see page 107)
Define the Button Font Settings for a Mimic (see page 108)
Define the Pipe Fill Settings for a Mimic (see page 109).
PD-6016 07/2012
Using the Options Window to Define Settings that apply to All Mimics
You can use the Options windows Mimics tab to define settings that apply to:
New Mimics when edited for the first time on your client PC
Existing Mimics that you display on your client PC (the settings may not apply when the
same Mimics are displayed on other client PCs).
To display the Options window, select the Tools menu, then choose the Options option.
When the Options window is displayed, select the Mimics tab.
The settings that you apply for Mimics via the Options window are specific to your client
PC, and they allow you to define:
The default settings that are in place whenever you first edit a new Mimic on your client.
By defining the default settings, you can reduce the amount of time and effort required
when configuring Mimics that have common features, such as the same orientation,
size, lettering styles etc.
To define the default settings for new Mimics, you need to use the Mimic Properties
window. You can display it by selecting the Edit button in the General section on the
Option windows Mimics tab.
For more information on the default settings for new Mimics, see Mimic Properties
Window, on page 90.
PD-6016 07/2012
79
Whether Mimics displayed on your client PC only flash when they are the active window
(i.e. are the currently selected display). For more information on the Only Flash If Active
setting, see Define whether Flash Effects are Active in all Windows, on page 81.
Whether Mimics displayed on your client PC use anti-aliasing to smooth the edges of
Mimic objects (especially noticeable on curved lines and curved shapes). For more
information on the Enable Anti-Aliasing setting, see Smooth Mimic Graphics with the
Anti-Aliasing Feature, on page 94.
Whether Mimics use WYSIWYG (What You See Is What You Get) printing. For more
information on the WYSIWYG Printing setting, see Enable or Disable WYSIWYG
Printing for Mimics, on page 84
How frequently Mimics displayed on your client PC are updated. For more information
on the Update Rates settings, see Define the Update Rates for a Mimic, on page 82.
The appearance of context-sensitive menus for Mimics on your client PC. You can
choose to use Custom Menus or leave the default Windows-style context sensitive
menus in place (see Enable or Disable Custom Menus for a Mimic, on page 85).
The settings you apply via the Options windows Mimics tab apply to those Mimics that
are displayed or created on your client PC only. When the same Mimics are displayed on
other client PCs, different settings may be applied (depending on the Options settings on
the other clients).
You should also be aware that when you select the Edit button on the Mimics tab, the
Mimic Properties window that is displayed is not the same as the Mimic Properties
window that is available for individual Mimics. Although the Mimic Properties windows
contain the same settings, there is a difference:
80
The Mimic Properties window displayed via the Options window has settings that apply
to every new Mimic on your client PC
The Mimic Properties window that is displayed when you select the Properties option
for a Mimic has settings that only apply to that specific Mimic.
PD-6016 07/2012
A high number of flashing effects can mean that they no longer serve their purpose - the
flashing objects no longer stand out and so may not attract users attention.
To help you use flashing effects appropriately, ClearSCADA includes a Only Flash If Active
setting. When enabled, this sets flashing effects so that they are only active if they are in
the currently selected window. So if a user has 4 Mimics on display and they have flashing
features, the flashing effects will only be visible on the currently selected Mimic (the
'active' Mimic).
To enable or disable the Only Flash If Active setting on your client PC, you need to use the
Options window:
1.
Select the Tools menu, then select the Options option to display the Options window.
NOTE: You can only display the Options window if your user account has the Configure
Options permission.
2.
3.
4.
Select the Only Flash if Active check box to restrict flash effects so that they are
only applied on the currently selected window.
Clear the Only Flash if Active check box to allow the flash effects to be applied on
every Mimic on display, irrespective of the currently selected window.
Select the OK button to confirm your changes and close the Options window.
Further Information
FlashAlpha (see page 369)
FlashColour (see page 369)
FlashMode (see page 369)
FlashOffset (see page 369).
PD-6016 07/2012
81
The configuration of the expression for each dynamic Mimic object. The expression is
configured to be associated with the Normal update group or the Fast update group. If
it is associated with the Fast update group, your client will request updates for the
expression more frequently than it will request updates those expressions associated
with the Normal update group.
The configuration of the Update Rates on the Options window on your client. The Fast
setting defines how regularly the client requests updates for those expressions that are
associated with the Fast update group. Similarly, the Normal setting defines how
regularly the client requests updates for those expressions that are associated with the
Normal update group.
Example:
Lets say that you have a Mimic that contains some expressions that have fast updates
enabled and some expressions that use normal updates. The Fast setting for your client PC
is set to 0.5 seconds and the Normal setting is 1.0 seconds.
When you first open the Mimic, your client informs the server that it has some tags that
should be updated at a maximum of once every half second, and some tags that should be
updated at a maximum of once every second. The server then monitors the tags and
updates them but only if the source of the tags value has changed since the last update.
The data source for one of the fast expressions is changing value every quarter of a
second. The server monitors this and updates the expression as fast as it can - every 0.5
seconds. The server cannot update the tag every time the source value changes as the
source value is changing every 0.25 seconds and the fastest that the server can update the
Mimic is every 0.5 seconds.
The data source for one of the normal expressions is changing value every hour. This
means that on the Mimic, the tag for the expression will also change once per hour even
though the Normal update setting is 1 second. This is because the server only updates the
Mimic when the source values change, and the update rates define the maximum speeds at
which the Mimic can be updated.
82
PD-6016 07/2012
You can use the Options window to define the update rate for the Fast and Normal update
groups. The settings you define will apply to the Mimics that are displayed on your client
PC.
To define the Update Rates:
1.
Select the Tools menu then select the Options option to display the Options window.
NOTE: You can only display the Options window if your user account has the Configure
Options permission.
2.
3.
Use the Update Rates settings to define the maximum rates at which the server can
update the values on a Mimic shown on your client PC:
Use the Fast spin box to define the maximum rate at which the server can update
those expressions that have Fast Updates enabled. The default setting is 0.5
seconds and the Fast update rate should be around twice as frequent as the
Normal update setting.
Use the Normal spin box to define the maximum rate at which the server can
update those expressions that have Fast Updates disabled. The Normal update
group should be updated at a slower rate than the Fast update group, usually
around half as often. By default, the Normal update group is updated every second.
Please be aware that changing the update rates may affect the performance of your
system.
4.
Select the OK button to apply the changes and close the Options window.
NOTE: The Fast and Normal update rates that you define will only apply to the dynamic data
on Mimics that are displayed on your client PC. When the same Mimics are displayed on
other clients, they will use the update rates that are defined on those clients Options
windows.
PD-6016 07/2012
83
Select the Tools menu then select the Options option to display the Options window.
NOTE: You can only display the Options window if your user account has the Configure
Options permission.
2.
3.
Use the WYSIWYG Printing check box to enable or disable the setting:
4.
84
Select the WYSIWYG Printing check box to enable WYSIWYG Printing. When you
print a Mimic, a lower resolution will be used. If the Mimic contains embedded Lists
or embedded Alarms Lists, a snapshot of those embedded Lists will be included in
the print-out. As the print-out is in a lower resolution, the edges will appear less
sharp, particularly on lettering and shapes.
Clear the WYSIWYG Printing check box to disable WYSIWYG Printing. When you
print a Mimic, a higher resolution is used and any embedded Lists or Alarms Lists
are excluded from the print-out. This means that the edges of shapes and text will
appear sharp, but there will be empty spaces in place of any embedded Lists/
embedded Alarms Lists.
Select the OK button to apply the changes and close the Options window.
PD-6016 07/2012
ClearSCADA Object Menu pick actions (pick actions that you configure to associate a
Mimic object with the context sensitive menu of a database item).
The custom design that you define is used instead of the standard, Windows-style
appearance.
Typically, the Custom Menus feature is used in organizations that prefer to apply custom
styles that match their corporate branding wherever possible.
To create your own custom menu design, you need to use the Custom Menus settings on
the Options window. The design you implement in the Custom Menus settings will apply
to the custom menus and custom pick action menus of the Mimics displayed on your
client PC. The settings will not apply to the Mimics when they are displayed on other
clients (unless the other clients have the same Custom Menus settings as your client).
PD-6016 07/2012
85
Select the Tools menu, then select the Options option to display the Options window.
2.
3.
Use the Enable Custom Menus check box to define whether the custom menus use the
alternate style of menus:
4.
Select the Enable Custom Menus option to apply the different menu style to custom
menus. The alternate menu style will only be applied to custom menus on Mimics
that are displayed on your client. When the same Mimics are displayed on other
clients, the Custom Menu settings of the other clients will apply.
Clear the Enable Custom Menus check box to set those Mimics that contain
custom menus to use standard Windows-style menus when displayed on your
client PC.
Use the Enable Custom Pick Menus check box to define whether ClearSCADA Object
Menus on Mimics use the alternate style of menus:
Select the Enable Custom Pick Menus option to apply the different menu style to
ClearSCADA Object Menus on Mimics (ClearSCADA Object Menus that are
associated with the pick action for a Mimic object). The alternate menu style will
only be applied to ClearSCADA Object Menus on Mimics that are displayed on your
client. When the same Mimics are displayed on other clients, the Custom Menu
settings of the other clients will apply.
Clear the Enable Custom Menus check box to set the Mimics ClearSCADA Object
Menus use standard Windows-style menus when displayed on your client PC.
5.
Use the Font combo box to select the style of lettering that will be used on the custom
menus and ClearSCADA Object Menus.
6.
Use the Height spin-box to define the size of the lettering on the custom menus and
ClearSCADA Object Menus. The measurements are in points.
7.
Use the Bold check box to define whether the text on the custom menus and custom
ClearSCADA Object Menus is emboldened. Select the check box to embolden the text
or clear it to use standard text.
8.
Use the Italic check box to define whether the text on the custom menus and
ClearSCADA Object Menus is italicized. Select the check box to italicize the text or
clear it to use standard text.
9.
Use the Text color button to define the color of the text on the custom menus and
ClearSCADA Object Menus. You can choose a color from the palette or create a
custom color. For more information, see Using the Color Window, on page 226.
10. Use the Selected Text color button to define the color of selected text on the custom
menus and ClearSCADA Object Menus. This is the color that the text will become when
an option or menu is selected. For more information, see Using the Color Window, on
page 226.
11. Use the Menu color button to define the color of the menu background on the custom
menus and ClearSCADA Object Menus. This is the color that is shown behind the text
on a custom menu or custom pick action menu. For more information, see Using the
Color Window, on page 226.
86
PD-6016 07/2012
12. Use the Selected Menu color button to define the color of the menu background on the
custom menus and ClearSCADA Object Menus. This is the color that is shown behind
the text on a custom menu or custom pick action menu when the menu or option is
selected. For more information, see Using the Color Window, on page 226.
Further Information
Associating Mimic Objects with Pick Actions (see page 247)
Custom Pick Action Menus (see page 265).
PD-6016 07/2012
87
Select the Tools menu, then select the Options option to display the Options window.
Select the Mimics tab, then select the Edit button in the General section.
NOTE: If you want to define the default settings for every new Mimic, you have to
display the Mimic Properties window by using the Edit button on the Mimics tab of the
Options window. If you display the Mimic Properties window by selecting the Properties
option for an individual Mimic, the settings on the Mimic Properties window only apply
to that specific Mimic. Some Mimic options can only be configured on a per-Mimic
basis, including the Layers, Views, and Script settings.
3.
Use the Mimic Properties window to define the settings that will apply to every Mimic
that is configured for the first time on your client PC. For more information on the
settings on the Mimic Properties window, see Mimic Properties Window, on page 90.
NOTE: You can only define the default settings if your user account has the Configure
Options permission. This permission is usually allocated to high level users such as
engineers.
88
PD-6016 07/2012
Display the Mimic for which you want to define the Mimic Properties. You need to
display the Mimic in Design Mode (see Displaying a Mimic, on page 17).
2.
3.
PD-6016 07/2012
Use the Mimic Properties window to define the settings that will only apply to the Mimic
that you are currently configuring. For more information on the settings on the Mimic
Properties window, see Mimic Properties Window, on page 90.
89
Any selected Mimic. The default settings you put in place for the Mimic will be applied
whenever the Mimic is displayed, irrespective of which client PC is used.
New Mimics that are being edited for the very first time. The default settings for new
Mimics are client-specific, so they only apply if your client PC is being used to configure
a Mimic that has not been configured before.
The default settings that you define on the Mimic Properties window are then used for
new objects that you add to a Mimic. For example, if you specify Text Font settings on the
Mimic Properties window, any text boxes that you add will use those settings by default.
But the default settings are just a starting point - each object that you add to a Mimic also
has its own properties window. You can use the Mimic object properties windows to
configure each Mimic object as required.
There are two different ways in which you can display the Mimic Properties window. The
technique you use determines whether the changes apply to a specific Mimic or every
Mimic on your client:
90
If you display the Mimic Properties window by selecting the Edit button on the Mimics
tab of the Options window, the settings will apply to each Mimic that you display on
your client PC. The settings are client-specific and so will not apply when the same
Mimics are displayed on other client PCs. For more information, see Defining the
Default Mimic Properties for New Mimics, on page 88.
PD-6016 07/2012
The Mimic Properties window consists of several tabs, each containing a variety of
settings. You can use the tabs as follows:
Add, Edit, Reorder and Remove Layers on a Mimic (see page 93)
Smooth Mimic Graphics with the Anti-Aliasing Feature (see page 94)
Polyline LineUse the settings on this tab to Define the Polyline Line Settings for a
Mimic (see page 101).
Polyline FillUse the settings on this tab to Define the Polyline Fill Settings for a Mimic
(see page 102)
Text PenUse the settings on this tab to Define the Text Pen Settings for a Mimic (see
page 103)
Text FillUse the settings on this tab to Define the Text Fill Settings for a Mimic (see
page 104)
Text FontUse the settings on this tab to Define the Text Font Settings for a Mimic (see
page 105)
Button PenUse the settings on this tab to Define the Button Pen Settings for a Mimic
(see page 106)
Button FillUse the settings on this tab to Define the Button Fill Settings for a Mimic
(see page 107)
Button FontUse the settings on this tab to Define the Button Font Settings for a
Mimic (see page 108)
Pipe FillUse the settings on this tab to Define the Pipe Fill Settings for a Mimic (see
page 109).
Further Information
For details on the properties windows for individual Mimic objects, see Editing Objects on
a Mimic, on page 149.
PD-6016 07/2012
91
You can choose a color from the palette or you can use the ... option to create a custom
color (see Using the Color Window, on page 226).
Further Information
Defining the Default Mimic Properties for New Mimics (see page 88)
Defining the Default Mimic Properties for a Specific Mimic (see page 89).
92
PD-6016 07/2012
PD-6016 07/2012
93
While the Anti-Aliasing feature does improve the appearance of curved lines on Mimics, it
is performed by the client PC and so places a demand on the client PCs processors. For
this reason, we recommend that you have the Anti-Aliasing feature disabled on slow PCs.
In this section, we explain how to:
94
Enable or Disable Anti-Aliasing for New Mimics on your Client PC (see page 96)
PD-6016 07/2012
Select the Tools menu, then the Options option to display the Options window.
2.
3.
Either:
Select the Enable Anti-Aliasing check box to activate the Anti-Aliasing feature on
your client PC. Your client PC will now apply Anti-Aliasing to any Mimics that are
configured to use Anti-Aliasing.
Or:
4.
Clear the Enable Anti-Aliasing check box to disable the Anti-Aliasing feature on your
client PC. Any Mimics that you display on your client PC will not use Anti-Aliasing,
even if they are configured to have Anti-Aliasing enabled.
Select the OK button to confirm your selection and close the Options window.
NOTE: You can only access the Options window if your user account has the Configure
Options permission.
Further Information
Enable or Disable Anti-Aliasing for New Mimics on your Client PC (see page 96)
Enable or Disable Anti-Aliasing for a Specific Mimic (see page 97).
PD-6016 07/2012
95
Select the Tools menu, then select the Options option to display the Options window.
NOTE: To access the Options window, your user account has to have the Configure
Options permission.
2.
3.
On the Mimic tab of the Mimic Properties window, use the Anti-Alias check box to
define whether Anti-Aliasing is enabled or disabled on any new Mimics displayed on
your client PC:
Select the check box to enable the Anti-Aliasing feature by default on new Mimics
(on your client PC only)
Clear the check box to disable the Anti-Aliasing feature by default on new Mimics
(on your client PC only).
5.
6.
Select the OK button to confirm your selection and close the Options window.
NOTE: If you access the Mimic Properties window by using the Properties option for a
Mimic, the changes you make will only apply to that specific Mimic. You have to access the
Mimic Properties window via the Options window to apply settings that are applied to each
new Mimic by default.
Further Information
Enable or Disable Anti-Aliasing for your Client PC (see page 95)
Enable or Disable Anti-Aliasing for a Specific Mimic (see page 97).
96
PD-6016 07/2012
Display the Mimic in Design Mode (see Displaying a Mimic, on page 17).
2.
On the background of the Mimic, right-click to display a context sensitive menu, then
select the Properties option. Alternatively, you can double-click on the background of
the Mimic.
The Mimic Properties window is displayed. The settings on the Mimic Properties
window only apply to the Mimic that you are currently configuring.
3.
4.
On the Mimic tab of the Mimic Properties window, use the Anti-Alias check box to
define whether Anti-Aliasing is enabled or disabled on the Mimic:
Select the check box to enable the Anti-Aliasing feature for the Mimic
Clear the check box to disable the Anti-Aliasing feature for the Mimic.
NOTE: If you access the Mimic Properties window by using the Edit option on the Options
window, the changes you make will apply to new Mimics on your client PC, not just the
Mimic you have on display.
Further Information
Enable or Disable Anti-Aliasing for your Client PC (see page 95)
Enable or Disable Anti-Aliasing for New Mimics on your Client PC (see page 96).
PD-6016 07/2012
97
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the size settings as follows:
98
CustomUse to set the Mimic size to your specific requirements. When you select
the Custom option, you can define the required size in the Width and Height fields.
StandardSets the Mimic to the standard size of 27.20 x 18.50 cm. This is an A4
page with margins.
A0-B10Sets the Mimic to a standard paper size. The options correspond to paper
sizes. When you select a size, the measurements for the size are shown in the
Width and Height fields. For example, if you select A5, the Width field shows 21.00
and the Height field shows 14.80.
LandscapeSelect this option button to set the Mimic to have a landscape orientation
(the top and bottom of the Mimic are the longest sides).
PortraitSelect this option button to set the Mimic to have a portrait orientation (the left
and right edges of the Mimic are the longest sides).
PD-6016 07/2012
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the magnification settings as follows:
ZoomingUse the Zooming settings to define whether the Mimic can be magnified,
and if so, what limits are in place:
EnabledUse this check box to define whether the Mimic can be magnified in Run
mode (via the Zoom tools on the Navigate toolbar). Select the check box to allow
the Mimic to be magnified or clear it to disable the magnification features for the
Mimic (in Run Mode).
MinUse the Min percentage spin-box to define the lowest level of magnification
that can be applied to the Mimic. In Run Mode, the Mimic will not be allowed to be
shown at a smaller size than the Min size.
MaxUse the Max percentage spin-box to define the highest level of magnification
that can be applied to the Mimic. In Run Mode, the Mimic will not be allowed to be
shown at a larger size than the Max size.
Further Information
Magnifying a Mimic (Zooming) (see page 36)
Displaying a Mimic (see page 17)
Run Mode and Design Mode (see page 26).
PD-6016 07/2012
99
Depending on the method you use to display the Mimic Properties window, the Grid
settings you define will be applied to:
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Grid settings as follows:
EnabledUse to enable or disable the Grid feature for the selected Mimic/new Mimics
on your client PC. Select the Enabled check box to set the Grid to be on display
(though not necessarily visible, see below); clear the check box to disable the Grid.
VisibleUse to define whether the grid can be seen. If you select the Visible check box,
the grid dots will be visible to users; if you clear the check box, the grid dots will not be
shown but the grid will still be in place and objects will still align to it.
WidthUse to increase or decrease the amount of space between each column of grid
dots.
HeightUse to increase or decrease the amount of space between each row of grid
dots.
NOTE: You can also toggle the grid on and off by using the Grid toolbar button (see
Alignment Toolbar, on page 33).
100
PD-6016 07/2012
EnabledSelect the Enabled check box to toggle the scripting feature on and off for
the Mimic. By default, the Enabled check box is clear (scripting is off).
EditWhen you select the Enabled check box, the Edit button becomes available.
When you select the Edit button, the Script Editor is displayed. You can use the Script
Editor to create a script for the Mimic (see Display the Script Editor for a Mimic, on page
19 in the ClearSCADA Guide to Scripting).
The Script settings on the Mimic Properties window are only available on a per-Mimic
basis (you have to access the Mimic Properties window by double-clicking on the
background of a displayed Mimic or by right-clicking on the background and selecting the
Properties option from the context sensitive menu).
For more information, please see Mimic Scripts, on page 17 in the ClearSCADA Guide to
Scripting.
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Polyline Line settings as required. The various PolyLine Line
settings work in the same way as the similarly named settings on the Line tab of the
Polyline Properties window (see Editing a Line, on page 150).
Further Information
Define the Pipe Fill Settings for a Mimic (see page 109).
PD-6016 07/2012
101
new Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Polyline Fill settings as required. The various PolyLine Fill settings
work in the same way as the similarly named settings on the Fill tab of the Polyline
Properties window (see Editing a Shape, on page 152).
Further Information
Define the Pipe Fill Settings for a Mimic (see page 109).
102
PD-6016 07/2012
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Text Pen settings as required. The various Text Pen settings work
in the same way as the similarly named settings on the Pen tab of the Text Properties
window (see Editing a Text Box, on page 201).
Further Information
Define the Text Fill Settings for a Mimic (see page 104)
Define the Text Font Settings for a Mimic (see page 105).
PD-6016 07/2012
103
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Text Fill settings as required. The various Text Fill settings work in
the same way as the similarly named settings on the Fill tab of the Text Properties window
(see Editing a Text Box, on page 201).
Further Information
Define the Text Pen Settings for a Mimic (see page 103)
Define the Text Font Settings for a Mimic (see page 105).
104
PD-6016 07/2012
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Text Font settings as required. The various Text Font settings work
in the same way as the similarly named settings on the Font tab of the Text Properties
window (see Editing a Text Box, on page 201).
Further Information
Define the Text Pen Settings for a Mimic (see page 103)
Define the Text Fill Settings for a Mimic (see page 104).
PD-6016 07/2012
105
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Button Pen settings as required. The various Button Pen settings
work in the same way as the similarly named settings on the Pen tab of the Button
Properties window (see Editing a Button, on page 195).
Further Information
Define the Button Fill Settings for a Mimic (see page 107)
Define the Button Font Settings for a Mimic (see page 108).
106
PD-6016 07/2012
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Button Fill settings as required. The various Button Fill settings
work in the same way as the similarly named settings on the Fill tab of the Button
Properties window (see Editing a Button, on page 195).
Further Information
Define the Button Pen Settings for a Mimic (see page 106)
Define the Button Font Settings for a Mimic (see page 108).
PD-6016 07/2012
107
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Button Font settings as required. The various Button Font settings
work in the same way as the similarly named settings on the Font tab of the Button
Properties window (see Editing a Button, on page 195).
Further Information
Define the Button Pen Settings for a Mimic (see page 106)
Define the Button Fill Settings for a Mimic (see page 107).
108
PD-6016 07/2012
New Mimics on your client PC (access the Mimic Properties window via the Edit button
on the Mimics tab of the Options windowsee Defining the Default Mimic Properties
for New Mimics, on page 88).
A specific Mimic (access the Mimic Properties window by selecting the Properties
option for the background of a Mimic or by double-clicking on the background of a
Mimicsee Defining the Default Mimic Properties for a Specific Mimic, on page 89).
When you have displayed the Mimic Properties window using the appropriate method for
your needs, define the Pipe Fill settings as required. The various Pipe Fill settings work in
the same way as the similarly named settings on the Fill tab of the Pipe Properties window
(see Editing a Pipe, on page 200).
PD-6016 07/2012
109
110
PD-6016 07/2012
You can add a variety of objects to your Mimics, including shapes, comments, and
dynamic values (referred to as animations). In this section, we explain how to:
For information on adding dynamic values (values that update according to the values
that are stored in the database), please refer to the Animations section (see Animations,
on page 345).
You can also add imported images to a Mimic:
PD-6016 07/2012
111
Line
Polygon
Rectangle
Ellipse
When you position the cursor on the Mimic, it will appear as a cross hair. This indicates
that a shape tool is selected.
NOTE: You can also use the Line, Rectangle, Ellipse, and Polygon options on the Insert
menu.
2.
For lines, rectangles, and ellipses, simply press the left-hand mouse button to
define the start of the shape, then keep the left hand mouse button pressed and
move the cursor to the end of the shape. When you release the left-hand mouse
button, the shape is drawn.
For polygons, press the left-hand mouse button once then move the cursor to the
next corner or angle of the polygon. At the corner, press the left-hand mouse button
again, then move the cursor to the next corner. Repeat this procedure until you have
drawn the required polygon, then double-click to confirm the entry.
When you have drawn a shape, you can re-position it by selecting it and dragging it to a
new location.
You can edit a shape by double-clicking on it to display its Properties window. You can
use the Properties window to define the appearance of the shape. (see Editing Objects on
a Mimic, on page 149).
You can also access editing features by right-clicking on the shape to display a context
sensitive menu (see Mimic Editing Features, on page 58).
112
PD-6016 07/2012
When you position the cursor on the Mimic, it will appear as a cross hair. This indicates
that the Text tool is selected.
NOTE: You can also use the Text option on the Insert menu.
2.
Draw a text box by pressing the left-hand mouse button and keeping it pressed down
while you drag the cursor.
3.
Release the left-hand mouse button to complete the drawing of the text box and
display the Text Properties window.
4.
Use the Text Properties window to define the settings for the text box.
Each tab provides the following settings:
GeneralUse to access the Animations and Pick Action settings, define the
ToolTip, enable or disable Visibility, and define Dynamic Positions.
FillUse to define the color and shading settings of the text box.
You can find more detailed information about the Text properties window in Editing a
Text Box (see page 201).
5.
You can reposition the text box by dragging it, or you can double-click on it to edit it (see
Editing a Text Box, on page 201).
You can also access editing features by right-clicking on the text box to display a context
sensitive menu (see Mimic Editing Features, on page 58).
PD-6016 07/2012
113
Embedded
Mimic
Embedded Mimics are particularly useful on Mimics that provide an overview of a specific part
of the system. For example, this Mimic contains an overview of status information, buttons that
link to related displays, and a visual overview in the form on an embedded Mimic.
114
PD-6016 07/2012
Each Mimic can contain a maximum of 6 levels of embedded Mimic. For example, if a
Mimic named 'Tanks' contains an embedded Mimic named 'Water Tanks', and the 'Water
Tanks' Mimic contains an embedded Mimic named 'Main Tank', then the 'Tanks' Mimic is
3 levels deep:
The limitation of six levels is designed to help prevent embedded Mimics from causing an
infinite loop where Mimics are constantly reloaded.
If you exceed the permitted depth of levels, a level limit icon
is displayed in place of
those embedded Mimics that are too deep (embedded deeper than six levels).
To add an embedded Mimic to a Mimic:
1.
Display the Mimic that is to contain the embedded Mimic. You need to display the
Mimic in Design mode.
2.
NOTE: You can also use the Mimic option on the Insert menu.
3.
Draw the outline of the embedded Mimic by pressing the left-hand mouse button, and
moving the cursor while keeping the left-hand mouse button pressed. The rectangle
that is drawn is the space that will be occupied by the embedded Mimic.
4.
5.
Use the browse window to locate the Mimic that you want to embed.
6.
Select the Mimic that is to be embedded, then select the OK button to confirm.
PD-6016 07/2012
115
Alternatively:
1.
2.
In the Database Bar, select the Mimic that you want to embed and drag it onto the
Mimic that you have already displayed in Design mode.
You can resize the embedded Mimic by selecting it and dragging its sides. Similarly, you
can reposition it by selecting it and dragging it to a new position.
You can edit the embedded Mimic by double-clicking on it (see Editing an Embedded
Mimic, on page 154).
You can also access editing features by right-clicking on the embedded Mimic to display
a context sensitive menu (see Mimic Editing Features, on page 58).
116
PD-6016 07/2012
They allow you to display Trend data on a Mimic, which is especially useful on
'overview' Mimics.
You can embed multiple pre-configured Trends on a single Mimic. This is useful for
comparing Trend data while also displaying other dynamic data such as states and
values.
Display the Mimic that is to contain the embedded Trend. You need to display the Mimic
in Design mode (see Displaying a Mimic, on page 17).
2.
NOTE: You can also use the Trend option on the Insert menu.
3.
Draw the outline of the embedded Trend by pressing the left-hand mouse button, and
moving the cursor while keeping the left-hand mouse button pressed. The rectangle
that is drawn is the space that will be occupied by the embedded Trend.
4.
5.
Use the browse window to locate the pre-configured Trend that you want to embed.
PD-6016 07/2012
117
6.
Select the Trend that is to be embedded, then select the OK button to confirm.
2.
In the Database Bar, select the pre-configured Trend that you want to embed and drag
it onto the Mimic.
Select the Embedded Trend option to embed the Trend on the Mimic.
You can resize the embedded Trend by selecting it and dragging its sides. Similarly, you
can reposition it by selecting it and dragging it to a new position.
You can edit the embedded Trend by double-clicking on it (see Editing an Embedded
Trend, on page 161). You can also access editing features by right-clicking on the
embedded Trend to display a context sensitive menu (see Mimic Editing Features, on
page 58).
118
PD-6016 07/2012
They allow you to display X-Y Plot data on a Mimic, which is especially useful on
'overview' Mimics.
You can embed multiple X-Y Plots on a single Mimic. This is useful for comparing X-Y
Plot data while also displaying other dynamic data such as states and values.
Display the Mimic that is to contain the embedded X-Y Plot. You need to display the
Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
Select the Embed X-Y Plot button on the Mimic Editing toolbar.
NOTE: You can also use the X-Y Plot option on the Insert menu.
3.
Draw the outline of the embedded X-Y Plot by pressing the left-hand mouse button,
and moving the cursor while keeping the left-hand mouse button pressed. The
rectangle that is drawn is the space that will be occupied by the embedded X-Y Plot.
4.
5.
Use the browse window to locate the X-Y Plot that you want to embed.
PD-6016 07/2012
119
6.
Select the X-Y Plot that is to be embedded, then select the OK button to confirm.
2.
In the Database Bar, select the X-Y Plot that you want to embed and drag it onto the
Mimic.
Select the Embedded X-Y Plot option to embed the X-Y Plot on the Mimic.
You can resize the embedded X-Y Plot by selecting it and dragging its sides. Similarly, you
can reposition it by selecting it and dragging it to a new position.
You can edit the embedded X-Y Plot by double-clicking on it (see Editing an Embedded
X-Y Plot, on page 168). You can also access editing features by right-clicking on the
embedded X-Y Plot to display a context sensitive menu (see Mimic Editing Features, on
page 58).
120
PD-6016 07/2012
They allow you to display List data on a Mimic, which is especially useful on 'overview'
Mimics.
You can embed multiple Lists on a single Mimic. This is useful for comparing List entries
from different Lists while also displaying other dynamic data such as states and values.
PD-6016 07/2012
121
Display the List that you want to embed on a Mimic. You can display an unfiltered List
or a filtered List (as you can embed both).
NOTE: To display a List, select the Queries button in the Operate toolbar, then locate
the required List in the Queries tree-structure and double-click on it. Use the Filter
Columns window to define any filters, then select the OK button to display the List.
2.
Select the View menu, then the SQL option to display the SQL code that provides the
List.
3.
4.
5.
6.
Display the Mimic that you want to contain the embedded List. You have to display the
Mimic in Design mode.
7.
NOTE: You can also use the List option on the Insert menu.
122
8.
Draw the outline of the embedded List by pressing the left-hand mouse button, and
moving the cursor while keeping the left-hand mouse button pressed. The rectangle
that is drawn is the space that will be occupied by the embedded List.
9.
Release the left-hand mouse button to display the Embedded List Properties window.
PD-6016 07/2012
10. Use the Embedded List Properties window to define the data that is shown on the list
and its appearance:
i.
Paste the SQL code onto the Query tab. To do this, right-click in the text area on the
Query tab and select the Paste option from the context sensitive menu.
Alternatively, you can press Ctrl and V simultaneously.
You have to remove each instance of this character, otherwise the List will not
display correctly.
iii. Examine the SQL Query for the embedded Queries List. If you want the List to
provide access to the context sensitive menus for the items in the List, include the
Id field in the Query. If the Id field is excluded, the list will not provide access to the
context sensitive menus.
iv. Use the General tab to:
v.
Use the List Font tab to define the size and style of the lettering used for the list
entries.
vi. Use the Header Font tab to define the size and style of the lettering used for the
column headings.
For more information on these settings, see Editing an Embedded Query List, on page
174.
11. Close the Embedded List Properties window.
The embedded List is shown on the Mimic. It displays list entries that comply with the
criteria you defined on the Query tab and has the display settings, animations, pick
actions etc., that you defined on the General, List Font, and Header Font tabs.
PD-6016 07/2012
123
2.
3.
4.
When the Embedded List Properties window is displayed, enter the required SQL code
in the Query tab and use the other tabs to define the required settings.
5.
This method should only be used by engineers and operators with a good knowledge of
SQL coding.
NOTE: The Embedded List option is also available via the Insert menu.
When you have added an embedded List to a Mimic, you can resize it by selecting it and
then dragging its sides. Similarly, you can reposition it by selecting it and dragging it to a
new position.
You can edit the embedded List by double-clicking on it (see Editing an Embedded Trend,
on page 161). You can also access editing features by right-clicking on the embedded List
to display a context sensitive menu (see Mimic Editing Features, on page 58).
124
PD-6016 07/2012
2.
Select the Embed Alarms List button on the Mimic Editing toolbar.
NOTE: You can also use the Alarms List option on the Insert menu.
3.
Draw the outline of the embedded Alarms List by pressing the left-hand mouse button,
and moving the cursor while keeping the left-hand mouse button pressed. The
rectangle that is drawn is the space that will be occupied by the embedded Alarms List.
4.
Release the left-hand mouse button to embed the Alarms List. The Alarms List contains
a list of the alarms on the system.
NOTE: Users can apply sorting to the embedded Alarms List by viewing the Mimic in Run
mode and using the Sort feature on the embedded Alarms List.
Further Information
Filtering an Embedded Alarms List: see Filter an Embedded Alarms List, on page 181.
Filtering an Alarms List: see Use the Filter Window to Filter Alarm Entries, on page 83 in
the ClearSCADA Guide to Alarms.
PD-6016 07/2012
125
Embedded Image
126
BMP
JPEG
EMF
WMF
PNG
ICO
PD-6016 07/2012
Use the browse window to locate the image file that you want to embed on the Mimic.
3.
The browse window is closed and the cursor changes shape to indicate that the image
tool is selected.
4.
Draw the outline of the embedded image by pressing the left-hand mouse button, and
moving the cursor while keeping the left-hand mouse button pressed. The rectangle
that is drawn is the space that will be occupied by the embedded image.
5.
When you have embedded the image, you can re-position it by selecting it and dragging it
to a new location.
You can define the animations, pick actions etc. for the image by double-clicking on it to
display its Properties window. For information on the image's property settings see
Editing an Embedded Image, on page 191.
PD-6016 07/2012
127
Web camsMimics can contain web cam images that can be updated at a specified
rate. This means that you can present ' live' images such as security images from a
webcam on a Mimic.
Managing pictures that are shown on web interfaces and Mimics at the same time. For
example, if a company logo is displayed on a web page and on a Mimic, the logo can
be stored on the web server. This means that if the logo is changed on the web server, it
is automatically changed on the Mimic and on the web pagethe pictures on the web
server are not stored as part of the Mimic.
Bitmap (.bmp)
If you have updating images that need to be added to a Mimic, for example, images from
a web cam, you have to host the images on a web server before you can add them using
the Remote Images feature.
NOTE: ClearSCADA uses the proxy server settings that are defined in Internet Explorer.
128
PD-6016 07/2012
On the Mimic Editor toolbar, select the Embed Remote Image button.
NOTE: You can also use the Remote Image option on the Insert menu.
2.
Draw the outline of the embedded image by pressing the left-hand mouse button, and
moving the cursor while keeping the left-hand mouse button pressed. The rectangle
that is drawn is the space that will be occupied by the embedded image.
3.
Release the left-hand mouse button to display the Remote Image Properties window.
4.
In the Source field, enter the address of the remote image file. For this example, we are
going to use the WebX logo that is stored on your WebX server (but you could use any
image that is available on the Internet, your network etc.):
http://localhost:81/file/images/logo.jpg
(Replace localhost:81 with the address of your WebX server if necessary).
For information on the other Remote Image Properties window settings, see Editing an
Embedded Remote Image, on page 193.
PD-6016 07/2012
129
5.
The remote image is displayed on the Mimic. If the remote image is not shown,
re-display the Remote Image Properties window by double-clicking on the embedded
image box and check that the Source entry is correct. If the entry is correct, you may
need to check the Internet connections on the client PC.
Remote Image (logo is stored on the WebX server)
When you have embedded the image, you can re-position it by selecting it and dragging it
to a new location.
You can define the animations, pick actions etc. for the image by double-clicking on it to
display its Properties window. For information on the image's property settings see
Editing an Embedded Remote Image, on page 193.
130
PD-6016 07/2012
On this Mimic, the buttons are used to control a point. The point sends a signal to
a pump that either empties the tank, empties the tank until it is at 50% volume,
fills the tank, or fills the tank until it is at 50% volume. The signal that is sent to the
pump is dependent on which button is selected.
PD-6016 07/2012
131
2.
NOTE: Alternatively, you can select the Insert menu, then select the Button option.
3.
Draw the outline of the button by pressing the left-hand mouse button, and moving the
cursor while keeping the left-hand mouse button pressed. The rectangle that is drawn is
the space that will be occupied by the button.
4.
When you have added the button, you can re-position it by selecting it and dragging it to
a new location.
You can define the animations, pick actions etc. for the button by double-clicking on it to
display its Properties window. For information on the button's property settings see
Editing a Button, on page 195.
132
PD-6016 07/2012
Pie Chart
2.
Select the Add Pie Chart button on the Mimic Editing toolbar.
NOTE: Alternatively, you can select the Insert menu, then select the Pie Chart option.
3.
Draw the outline of the pie chart by pressing the left-hand mouse button, and moving
the cursor while keeping the left-hand mouse button pressed. The rectangle that is
drawn is the space that will be occupied by the pie chart.
4.
Release the left-hand mouse button to add the pie chart. When you first add a pie chart,
it is entirely black. This is because it is not associated with any values.
To associate the pie chart with values and define its settings, see Editing a Pie Chart, on
page 198.
When you have added the pie chart, you can re-position it by selecting it and dragging it
to a new location.
PD-6016 07/2012
133
2.
NOTE: Alternatively, you can select the Insert menu, then select the Pipe option.
3.
Draw the pipeline in the same way that you would draw a polygon (i.e. left-click on a
position, then move the cursor to a new position, then left-click again). Each time you
press the left-hand mouse button, you define a new corner for the pipe. To complete
the pipe drawing, double-click the left hand mouse button.
When you have double-clicked to define the end of the pipe drawing, the pipe is selected
as a single object on the Mimic. It is gray with black and white shading by default. You can
alter its settings via the Pipe Properties window (see Editing a Pipe, on page 200).
134
PD-6016 07/2012
Dragging the required item from the Database Bar onto the Mimic to display a context
sensitive menu (see Database Bar, on page 75 in the ClearSCADA Guide to ViewX and
WebX Clients).
You can choose from any of the selection of live values that are shown on the context
sensitive menu, for example, for a database point, there are many current values that
you can add, including Alarm State, State, Last Updated time, Quality and a variety of
options for Value. You can also choose to add the Previous Value, Previous State,
Previous Updated time or Previous Quality.
For more information on the possible options that can be shown on the context
sensitive menu, see Drag and Drop Menu Options for Values on Mimics, on page 137.
Displaying the OPC Data Bar, expanding the OPC property tags for the required item,
then dragging the OPC tag you want to display onto the Mimic (see Working with the
OPC Data Bar, on page 39 in the ClearSCADA Guide to Core Configuration).
Displaying the OPC Historic Data Bar, expanding the hierarchy of items with historic
data, then dragging the item you want to display onto the Mimic. This will show live
historic data on the Mimic (the calculated Average value for the last hour). For more
information on the OPC Historic Data Bar, see Working with the OPC Historic Data Bar,
on page 51 in the ClearSCADA Guide to Core Configuration.
Creating an animation that references the database item and property that you want to
display on the Mimic (see Animations, on page 345).
Displaying the Queries Bar and dragging an SQL List, Data Grid, or Table onto the
Mimic. This adds an embedded version of the selected SQL List to the Mimic. For more
information on the Queries Bar, see Queries Bar, on page 77 in the ClearSCADA Guide
to ViewX and WebX Clients.
For example, if you wanted to display the live CurrentQualityDesc value of a point, you
could display the OPC Data Bar, expand the property tags for the point, then select
CurrentQualityDesc. With the property selected, you would then drag it onto the Mimic.
PD-6016 07/2012
135
ClearSCADA creates a text box containing the live CurrentQualityDesc value of the point
and displays it on the Mimic.
When you have added a live value to a Mimic, the value will update whenever the value
changes in the database.
The text boxes, shapes, Lists, etc., that are added to the Mimic when you drag and drop
have animations in place. You can edit these animations to suit your own requirements as
needed (see Animations, on page 345).
136
PD-6016 07/2012
NameAdds a text box that is animated to show the name of the item (see Text Box
Animations, on page 356).
Full NameAdds a text box that is animated to show the full name (including any
parent Groups) of the item (see Text Box Animations, on page 356).
Help ViewAdds a text box that is animated so that is works as a hyperlink to the
defined Help View of the item (see Animating an Object to act as a Hyperlink, on page
431).
Alarm ViewAdds a text box that is animated so that is works as a hyperlink to the
defined Alarm View of the item (see Animating an Object to act as a Hyperlink, on page
431).
Alarm StateAdds a text box that is animated so that it displays the current alarm state
of the item (see Text Box Animations, on page 356).
Value
ValueAdds a text box that is animated so that it displays the current value of the
item (see Text Box Animations, on page 356).
Formatted ValueAdds a text box that is animated so that it displays the current
formatted value of the item (see Text Box Animations, on page 356).
Vertical BarAdds a vertical bar that fills according to the current value of the item
(see Fill Animations, on page 402).
UpThe proportion of the bar that is filled represents the current value of the
item. The minimum possible value corresponds to the bottom of the bar and
the maximum possible value corresponds to the top of the bar.
The fill rises towards the top of the bar when the items value
increases and drops towards the bottom of the bar when the
value decreases.
PD-6016 07/2012
137
CenterThe proportion of the bar that is filled represents the current value of
the item. The minimum possible value corresponds to the center of the bar and
the maximum possible value corresponds to the top and bottom of the bar. So
when the value is low, the fill is close to the center, and when the value is high,
the fill expands from the center to reach closer to the top and bottom of the
bar.
The fill expands from the center towards the top and bottom of the
bar when the items value increases. It contracts towards the center
of the bar when the value decreases.
DownThe proportion of the bar that is filled represents the current value of
the item. The minimum possible value corresponds to the top of the bar and
the maximum possible value corresponds to the bottom of the bar.
Horizontal BarAdds a vertical bar that fills according to the current value of the
item (see Fill Animations, on page 402).
LeftThe proportion of the bar that is filled represents the current value of the
item. The minimum possible value corresponds to the left of the bar and the
maximum possible value corresponds to the right of the bar.
The fill expands from the left towards the right of the bar when the items
value increases. It contracts towards the left of the bar when the value
decreases.
CenterThe proportion of the bar that is filled represents the current value of
the item. The minimum possible value corresponds to the center of the bar and
the maximum possible value corresponds to the left and right of the bar. So
when the value is low, the fill is close to the center, and when the value is high,
the fill expands from the center to reach closer to the left and right of the bar.
The fill expands from the center towards the left and right of the bar when
the items value increases. It contracts towards the center of the bar when the
value decreases.
138
PD-6016 07/2012
RightThe proportion of the bar that is filled represents the current value of
the item. The minimum possible value corresponds to the right of the bar and
the maximum possible value corresponds to the left of the bar.
Sized BoxAdds an animated sized box to the Mimic (see Size Animations, on
page 454). The outline of the box represents the maximum value and an inner fill
represents the current value of the item. So when the item has a low value, the fill
is small and in the center of the box, and when the items value is high, the fill is
large and expands closer to the boundaries of the box.
Default ViewAdds a text box that is animated so that is works as a hyperlink to the
defined Default View of the item (see Animating an Object to act as a Hyperlink, on
page 431).
Embedded TrendAdds an embedded version of the selected Trend onto the Mimic
(see Embed a Pre-Configured Trend on a Mimic, on page 117).
Embedded X-Y PlotAdds an embedded version of the selected X-Y Plot to the Mimic
(see Embed an X-Y Plot on a Mimic, on page 119).
Current ValueAdds a text box that is animated so that it displays the current value of
the item (see Text Box Animations, on page 356).
QualityAdds a text box that is animated so that it displays the current quality of the
item (see Text Box Animations, on page 356).
Last UpdatedAdds a text box that is animated so that it displays the time stamp of
the most recent update to the items value (see Text Box Animations, on page 356).
StateAdds a text box that is animated so that it displays the current state of the item
(see Text Box Animations, on page 356).
Previous ValueAdds a text box that is animated so that it displays the previous
current value of the item (see Text Box Animations, on page 356).
Previous QualityAdds a text box that is animated so that it displays the previous
quality of the item (see Text Box Animations, on page 356).
Previous UpdatedAdds a text box that is animated so that it displays the previous
last updated time stamp of the item (see Text Box Animations, on page 356).
Previous StateAdds a text box that is animated so that it displays the previous
current state of the item (see Text Box Animations, on page 356).
PD-6016 07/2012
139
ColorAdds a rectangle that is animated so that its fill and line color represent the state
of the item. The rectangle is also animated to flash (see FillColour, on page 405).
Last ExecutedAvailable for use with Schedules, this option adds a text box to the
Mimic. The text box is animated so that it displays the time stamp for the previous
execution of the schedule (see Text Box Animations, on page 356)
Next ExecuteAvailable for use with Schedules, this option adds a text box to the
Mimic. The text box is animated so that it displays the time stamp for the next
execution of the schedule (see Text Box Animations, on page 356)
Duty UserAvailable for use with User Rosters, this option adds a text box to the
Mimic. The text box is animated so that it displays the name of the User or User Group
that is currently designated as the Duty User (see Text Box Animations, on page 356)
ListAvailable for use with Data Grids, this option adds an embedded version of the
selected Data Grid to the Mimic. The Data Grid is displayed as an SQL List.
SinewaveAvailable only for Random Generators, you can use this option to add a text
box that is animated with the Value, a vertical bar, a horizontal bar, or a sized box. In
each case, the text or fill represents the sinewave value of the random generator item
you have selected.
In other respects, the Value, Vertical, Horizontal and Sized Box options work in the
same way as the similarly named options from the Value sub-menu (see Value, above).
SawtoothAvailable only for Random Generators, you can use this option to add a text
box that is animated with the value, a vertical bar, a horizontal bar, or a sized box. In
each case, the text or fill represents the sawtooth value of the random generator item
you have selected.
In other respects, the Value, Vertical, Horizontal and Sized Box options work in the
same way as the similarly named options from the Value sub-menu (see Value, above).
RandomAvailable only for Random Generators, you can use this option to add a text
box that is animated with the value, a vertical bar, a horizontal bar, or a sized box. In
each case, the text or fill represents the random value of the random generator item
you have selected.
In other respects, the Value, Vertical, Horizontal and Sized Box options work in the
same way as the similarly named options from the Value sub-menu (see Value, above).
WalkAvailable only for Random Generators, you can use this option to add a text box
that is animated with the value, a vertical bar, a horizontal bar, or a sized box. In each
case, the text or fill represents the walk value of the random generator item you have
selected.
In other respects, the Value, Vertical, Horizontal and Sized Box options work in the
same way as the similarly named options from the Value sub-menu (see Value, above).
140
PD-6016 07/2012
Further Information
Alarm Views: see Defining an Item or Groups Alarm Properties, on page 215 in the
ClearSCADA Guide to Core Configuration.
Help Views: see Specify a Help View, on page 200 in the ClearSCADA Guide to Core
Configuration.
Alarm States: see Alarm Severity, Status, and Category, on page 16 in the ClearSCADA
Guide to Alarms.
Default Views: see Defining a Default View, on page 213 in the ClearSCADA Guide to Core
Configuration.
Schedules: see Using Schedules to Automate Regular Functions, on page 447 in the
ClearSCADA Guide to Core Configuration.
Duty User: see Specify the Duty User, on page 28 in the ClearSCADA Guide to Alarm
Redirection.
Data Grids: see Configuring Data Grids, on page 347 in the ClearSCADA Guide to Core
Configuration.
PD-6016 07/2012
141
142
PD-6016 07/2012
You can import DXF files into your Mimics. This is useful as it allows you to use DXF files
from other systems as objects on your Mimics.
Display the Mimic that is to contain the DXF file. You have to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
3.
4.
Use the browse window to locate the DXF file, select the file, then select the OK button.
The Import DXF window is displayed.
PD-6016 07/2012
143
5.
Use the settings to define which parts of the DXF file are to be imported:
i.
In the Layers list, select the check boxes for the layers that are to be imported.
Clear the check boxes for those layers that are not required.
Use the Offset settings to define the position of the DXF layer on the Mimic. Use the
Left percentage spin-box to set the position from the left-hand side of the Mimic
and the Top percentage spin box to set the position from the top side of the Mimic.
vi. Use the Scale settings to define the size of the DXF layer on the Mimic. Use the
Width and Height percentage spin-boxes to set the size as required. Use the
Preserve Aspect Ratio check box to define whether the DXF layer retains its original
dimensionsselect the check box to retain the dimensions so that the DXF layer
objects keep the same proportions as the original DXF layer or clear it to allow the
proportions to be changed.
vii. Repeat steps ii - vi inclusive for each layer.
6.
When the DXF file is imported, ClearSCADA converts the objects in the DXF file into
ViewX Mimic objectsit does not retain any reference to the DXF file. The imported DXF
objects become standard Mimic objects and can be configured and animated in the same
way as lines, shapes, pipes etc.
DXF files often contain many separate segments. Some of the segments may be
redundant in ClearSCADA and may affect performance as ViewX needs to draw each
segment in turn. To resolve this, we suggest that you:
1.
2.
3.
ViewX removes any redundant segmentsthe shape of the objects will not change, but
there will be less segments. This reduces the amount of processing required.
You can use the Mimic Diagnostics window to see how many segments have been
removed (see Displaying Mimic Diagnostics, on page 472).
144
PD-6016 07/2012
With ClearSCADA, you can insert any of your favorite Scalable Vector Graphics (SVG) into
your Mimic designs. Simply display your Mimic in Design Mode, select the SVG File
option from the Insert menu, and then choose the SVG file you want to use. ClearSCADA
will then add the SVG 1.0 or 1.1 file to your Mimic as a single, grouped image which you
can ungroup and edit as required.
ClearSCADA supports many of the SVG version 1.1 features, including:
ConceptsSVG files are written in XML and can make use of effects, fonts and
animations. These concepts are supported by ClearSCADA.
Basic Data Types and InterfacesClearSCADA supports the common data types for
SVG properties and colors.
PathsClearSCADA supports the path lines that are used in SVG files to create the
outlines of objects.
TextClearSCADA supports the SVG specification for the use of text on graphics.
Gradients and PatternsClearSCADA supports the SVG specification for color shading
and patterns.
Some SVG concepts cannot be converted for use with Mimics. Those SVG specifications
that are unsuitable for use in ClearSCADA include: Styling; Clipping, Masking and
Compositing; Filter Effects; Interactivity; Linking; Scripting; Animation; and Metadata. If an
imported SVG graphic contains features that are not supported by ClearSCADA, a
message box is displayed, describing which features could not be imported.
PD-6016 07/2012
145
When you import an SVG file, the various shapes of the SVG graphic are converted into a
group of Mimic objects that you can edit as required. You can also break the group so that
you can edit the individual objects (see Editing Objects on a Mimic, on page 149).
Display the Mimic that is to contain the SVG file. You have to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
3.
Use the browse window to locate the SVG file, select the file, then select the OK button.
5.
On the Mimic, position the cursor, keep the left-hand mouse button pressed down, then
drag the cursor over the area that is to contain the SVG file. This 'draws' a box. The
SVG file will be sized and proportioned to fill the box that you draw.
6.
NOTE: When you insert the SVG file, a message may be displayed. The message provides
details about any parts of the SVG graphic that are not supported by ClearSCADA.
You can edit the imported SVG graphics as required. By default, the individual graphics
are grouped. You can edit the group (see Editing a Group of Mimic Objects, on page 203)
or can break the group and then edit the objects individually.
Further Information
The SVG Specification: see The World Wide Web Consortium website at
http://www.w3.org/TR/SVG/.
146
PD-6016 07/2012
You can import Windows metafiles into your Mimics. This is useful as it allows you to use
graphics that were created in other packages and saved as .wmf to be used on Mimics.
When you import a Windows metafile, the various shapes of the graphic are converted
into a group of Mimic objects that you can edit as required. You can also break the group
so that the objects are individual objects that you can edit (see Editing Objects on a
Mimic, on page 149).
Display the Mimic that is to contain the Windows metafile. You have to display the
Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
3.
Use the browse window to locate the Windows Metafile, select the file, then select the
OK button.
5.
On the Mimic, position the cursor, keep the left-hand mouse button pressed down, then
drag the cursor over the area that is to contain the Windows metafile. This 'draws' a
box. The Windows metafile will be sized and proportioned to fill the box that you draw.
6.
NOTE: When you insert the Windows metafile, a message may be displayed. The message
provides details about any parts of the Windows metafile graphic that are not supported by
ViewX.
You can edit the imported Windows metafile graphics as required. By default, the
individual graphics are grouped. You can edit the group (see Editing a Group of Mimic
Objects, on page 203) or can break the group and then edit the objects individually.
PD-6016 07/2012
147
148
PD-6016 07/2012
When you have added an object to a Mimic, you need to access its Properties window so
that you can edit its settings. Each object's settings allow you to alter the appearance and
functionality of each Mimic object.
This section explains:
It also explains how to use the Color window to define custom colors (see Using the Color
Window, on page 226).
PD-6016 07/2012
149
Editing a Line
When you have added a line to a Mimic, you can access its Properties window to edit its
settings. The line's Properties window is called the Polyline Properties window.
To display the Polyline Properties window for a line, either:
or:
Right-click on the line and select Properties from the context sensitive menu.
The Polyline Properties window has three tabs which contain the settings that allow you
to:
150
Define whether the line is visible (see General Tab, on page 204)
Define a ToolTip for the line (see General Tab, on page 204)
Access the Animations settings for the line (see General Tab, on page 204)
Access the Pick Action Wizard for the line (see General Tab, on page 204)
Define which area of the line provides access to a pick action menu (see General Tab,
on page 204)
Define which areas of the line are filled (see Creating a New Shape by Combining Mimic
Objects, on page 70)
PD-6016 07/2012
Experiment with the line's rotation settings (see General Tab, on page 204)
Experiment with the line's sizing settings (see General Tab, on page 204)
Experiment with the line's position settings (see General Tab, on page 204)
Define the appearance of the outline of the line (see Line Tab, on page 219)
Define the appearance of the inside (the 'fill') of the line (see Fill Tab, on page 210).
When you have edited the line, you can close the Polyline Properties window.
NOTE: Remember that you will need to save the Mimic to store the changes you have made.
You can save the Mimic by selecting the Save button on the Operate toolbar or by selecting
the File menu, then the Save option.
PD-6016 07/2012
151
Editing a Shape
When you have added a shape to a Mimic, you can access its Properties window to edit
its settings. The shape's Properties window is called the Polyline Properties window.
To display the Polyline Properties window for a shape, either:
or:
Right-click on the shape and select Properties from the context sensitive menu.
The Polyline Properties window has three tabs which contain the settings that allow you
to:
152
Define whether the shape is visible (see General Tab, on page 204)
Define a ToolTip for the shape (see General Tab, on page 204)
Access the Animations settings for the shape (see General Tab, on page 204)
Access the Pick Action Wizard for the shape (see General Tab, on page 204)
Define which area of the shape provides access to a pick action menu (see General
Tab, on page 204)
PD-6016 07/2012
Define which areas of the shape are filled (see Creating a New Shape by Combining
Mimic Objects, on page 70)
Experiment with the shape's rotation settings (see General Tab, on page 204)
Experiment with the shape's sizing settings (see General Tab, on page 204)
Experiment with the shape's position settings (see General Tab, on page 204)
Define the appearance of the outline of the shape (see Line Tab, on page 219)
Define the appearance of the inside (the 'fill') of the shape (see Fill Tab, on page 210).
When you have edited the shape, you can close the Polyline Properties window.
NOTE: Remember that you will need to save the Mimic to store the changes you have made.
You can save the Mimic by selecting the Save button on the Operate toolbar or by selecting
the File menu, then the Save option.
PD-6016 07/2012
153
Double-click on the embedded Mimic (with the Mimic displayed in Design mode).
or:
Right-click on the embedded Mimic and select Properties from the context sensitive
menu.
The Embedded Mimic Properties window has only one tabthe General tab. The tab
contains Name, Visible, Animations, Pick Actions, ToolTip, and Dynamic Position settings
that work in the same way as on other General tabs (see General Tab, on page 204).
However, the General tab on the Embedded Mimic Properties window also contains some
settings that are specific to embedded Mimics:
154
PD-6016 07/2012
The embedded Mimic is resized so that it is smaller. As the Maintain Aspect Ratio check box
is clear, the smaller version does not retain its original dimensions and so can be 'stretched'.
In this case, the height of the embedded Mimic has been reduced, but the width has not been
altered.
Further Information
Editing an Embedded Mimic (see page 154)
PD-6016 07/2012
155
If Shared with Other Embedded Mimics is enabled (selected), ViewX loads a single
version of the embedded Mimic into memory. This version is then used as the
definition (source) for every instance of that embedded Mimic on the Mimic.
This Mimic has three
instances of the same
embedded Mimic.
The embedded Mimic
represents a pump.
Only one copy of the
definition for the
embedded Mimic is
loaded into
memorythe three
instances of the
embedded Mimic use
the same definition.
This reduces the
amount of memory
used by the Mimic.
If Shared with Other Embedded Mimics is disabled (cleared), ViewX loads a separate
definition of each embedded Mimic into memory. This means that every embedded
Mimic is unique and is not affected by changes to other instances of the same
embedded Mimic.
For example, lets say you have a Mimic that contains six embedded instances of a
Pump Mimic, and these embedded Mimics are only used as graphical aids (they have no
animations). If the Shared with Other Embedded Mimics setting is enabled, it means
ClearSCADA can load 1 definition of the Pump Mimic into memory and then use that
single definition for the six of the embedded Mimics. This reduces the amount of
memory required and so makes performance more efficient. However, if the Shared with
Other Embedded Mimics feature is disabled, ClearSCADA has to load six definitions of
the Pump Mimic into memory - one for each embedded instance of the Pump Mimic.
This requires extra memory and so is less efficient.
By default, embedded Mimics have Shared with Other Embedded Mimics enabled
(selected). This is because of the performance benefits gained by sharing, and also
because many Mimics are not affected by sharing a single Mimic loaded into memory.
However, there are certain types of embedded Mimic that require the Shared with other
Embedded Mimics setting to be disabled. These include embedded Mimics that use
buttons and hover features, as these features require an individual definition of an
embedded Mimic to be loaded into memory (for each instance of that embedded Mimic).
156
PD-6016 07/2012
We recommend that you only disable the Shared with other Embedded Mimics setting if
your embedded Mimic:
PD-6016 07/2012
157
If the Shared with Other Embedded Mimics setting had been enabled, only one
definition of the embedded Power LED Mimic would be loaded into memory. This
would mean that if you selected Power LED button on one of the embedded Mimics,
the Power LED button on the other embedded Mimic would also be selected.
158
PD-6016 07/2012
NOTE: For maximum Mimic performance, you should configure the Embedded Mimic
Cache Size setting so that it is large enough to store the embedded Mimics on a Mimic. For
more information, see Define the Size of the Embedded Mimic Cache, on page 74 in the
ClearSCADA Guide to Client Administration.
To change the Shared with Other Embedded Mimics setting, display the Embedded
Mimic Properties window (see Editing an Embedded Mimic, on page 154), then:
Select the Shared with Other Embedded Mimics check box to set the embedded
Mimics to share a single definition. Only one definition of the embedded Mimic will be
stored in memory. This is the default setting but is inappropriate for some Mimics as it
can cause slow performance (see below).
Clear the Shared with Other Embedded Mimics check box to set the embedded Mimics
to use individual definitions. A separate definition will be loaded into memory for
each individual instance of an embedded Mimic. For best Mimic performance, you
should clear the Shared with Other Embedded Mimics check box for embedded
Mimics that use:
button animations
hover animations
NOTE: The Share with other embedded Mimics setting only affects ViewX memory usage
it does not affect the storage of Mimics in the server.
PD-6016 07/2012
159
System
Each embedded Mimic has a System setting that you can use to specify which system
contains the original version of the embedded Mimic. (The system on which the
embedded Mimic is stored as a 'normal' Mimic.)
Typically, you will use the System combo box to select the same system that contains the
Mimic you are configuring. However, you may need to change the System setting if you
are editing a Mimic that has been copied from one system to another.
For example, a Mimic named 'Overview' is created on System A. The Mimic contains an
embedded version of a Mimic named 'Pipeline' and the 'Pipeline' Mimic is also stored on
System A.
The 'Overview' Mimic is copied and pasted into a folder on System B. Rather than have
the Mimic on System B referring to the 'Pipeline' Mimic on System A, you can change the
System setting so it refers to a local Mimic. On the 'Overview' Mimic on System B, the
System setting for the embedded Mimic is changed from System A to System B. This
means that the 'Overview' Mimic on System B refers to a local version of the 'Pipeline'
Mimic i.e. a 'Pipeline' Mimic on System B.
To change the System setting, display the Embedded Mimic Properties window (see
Editing an Embedded Mimic, on page 154), then select the required system name in the
System combo box.
Mimic
Each embedded Mimic has an Embedded Mimic Properties window that includes a Mimic
setting. The Mimic setting is grayed out and shows the name of the embedded Mimic
that you are currently editing.
Relative
Each embedded Mimic has a Relative setting that you can use to define whether an
embedded Mimic uses relative or absolute references. This only applies when the
embedded Mimic is stored on a different system to the Mimic that you are currently
editing.
If you clear the Relative check box, the embedded Mimic will use an absolute reference.
This means that:
The Mimic that contains the embedded Mimic cannot be moved (without breaking the
link to the embedded Mimic)
Copies of the Mimic will also contain the absolute reference and so has to be in the
same location as the original Mimic.
If you select the Relative check box, the embedded Mimic will use a relative reference.
This means that the link to the embedded Mimic will work as long as the Mimic and the
embedded Mimic maintain their locations in relation to each other. They can be moved
onto other systems, copied etc., and the link to the embedded Mimic will remain intact.
160
PD-6016 07/2012
or:
Right-click on the embedded pre-configured Trend and select Properties from the
context sensitive menu.
PD-6016 07/2012
161
SystemUse the System combo box to specify which system contains the original
version of the embedded pre-configured Trend i.e. the system on which the embedded
Trend is stored as a 'normal' pre-configured Trend.
Typically, you will use the System combo box to select the same system that contains
the Mimic you are configuring. However, you may need to change the System setting if
you are editing a Mimic that has been copied from one system to another.
For example, a Mimic named 'Overview' is created on System A. The Mimic contains an
embedded version of a Trend named 'Pressure' and the 'Pressure' Trend is also stored
on System A.
The 'Overview' Mimic is copied and pasted into a folder on System B. Rather than have
the Mimic on System B referring to the 'Pressure' Trend on System A, you can change
the System setting so it refers to a local Trend. On the 'Overview' Mimic on System B,
the System setting for the embedded Trend is changed from System A to System B.
This means that the 'Overview' Mimic on System B refers to a local version of the
'Pressure' Trend i.e. a 'Pressure' Trend on System B.
MimicThis field is read only (grayed out) and shows the name of the pre-configured
Trend that is embedded.
RelativeYou can use this check box to define whether an embedded Trend uses
relative or absolute references. This only applies when the embedded Trend is stored on
a different system to the Mimic that you are currently editing.
If you clear the Relative check box, the embedded Trend will use an absolute reference.
This means that:
The Mimic that contains the embedded Trend cannot be moved (without breaking
the link to the embedded Trend)
Copies of the Mimic will also contain the absolute reference and so has to be in the
same location as the original Mimic.
If you select the Relative check box, the embedded Trend will use a relative reference.
This means that the link to the embedded Trend will work as long as the Mimic and the
embedded Trend maintain their locations in relation to each other. As long as their
relative locations remain the same, the Mimic and Trend can be moved onto other
systems, copied etc., and the link to the embedded Trend will remain intact.
162
PD-6016 07/2012
BackgroundUse the Background color button to set the color of the background of
the embedded pre-configured Trend. The background is gray by default, but you can
change it to any of the system colors or to a custom color.
When you select the Background color button, a color palette is displayed.
If you want to use a default system
color, select the required color from
the palette.
You can select any of the colors on the palette, or select the ... option to access the
Color window. The colors on the palette are the system colors, and the Color window
allows you to create a custom color (see Using the Color Window, on page 226).
Show TitleSelect the check box to display the title on the embedded pre-configured
Trend or clear it to hide the title.
Show X-AxisSelect the check box to display the X-Axis on the embedded
pre-configured Trend or clear it to hide the X-Axis.
Show Y-AxisSelect the check box to display the Y-Axis on the embedded
pre-configured Trend or clear it to hide the Y-Axis.
Show KeySelect the check box to display the key on the embedded pre-configured
Trend or clear it to hide the key.
PD-6016 07/2012
163
The Main Font tab contains Family, Height, and Style settings. These are common text
settings and are explained in the Font Tab (see page 223) section.
164
PD-6016 07/2012
The Title Font tab contains Family, Height, and Style settings. These are common text
settings and are explained in the Font Tab (see page 223) section.
PD-6016 07/2012
165
The Label Font tab contains Family, Height, and Style settings. These are common text
settings and are explained in the Font Tab (see page 223) section.
166
PD-6016 07/2012
FamilyUse to choose the type of lettering (font) for the text shown on the embedded
Trends key.
StyleUse the check boxes to enable or disable the style settings: Bold, Underline,
Italic, Strikeout. Typically, the Style settings are used to improve clarity or add
emphasis.
The Orientation, Format and Alignment settings are grayed out on the Key Font tab, as
they are inappropriate for the key (but are common font settings, so are shown on the
Key Font tab).
These settings are common Font settings and work in the same way as the similarly
named settings on the Font Tab (see page 223). The only difference is that they apply to
the key on an embedded Trend rather than a text box.
PD-6016 07/2012
167
Double-click on the embedded X-Y Plot (with the Mimic displayed in Design mode).
or:
Right-click on the embedded X-Y Plot and select Properties from the context sensitive
menu.
168
PD-6016 07/2012
SystemUse the System combo box to specify which system contains the original
version of the embedded X-Y Plot i.e. the system on which the embedded X-Y Plot is
stored as a 'normal' X-Y Plot.
Typically, you will use the System combo box to select the same system that contains
the Mimic you are configuring. However, you may need to change the System setting if
you are editing a Mimic that has been copied from one system to another.
For example, a Mimic named 'Overview' is created on System A. The Mimic contains an
embedded version of a X-Y Plot named 'Pressure' and the 'Pressure' X-Y Plot is also
stored on System A.
The 'Overview' Mimic is copied and pasted into a folder on System B. Rather than have
the Mimic on System B referring to the 'Pressure' X-Y Plot on System A, you can
change the System setting so it refers to a local X-Y Plot. On the 'Overview' Mimic on
System B, the System setting for the embedded X-Y Plot is changed from System A to
System B. This means that the 'Overview' Mimic on System B refers to a local version
of the 'Pressure' X-Y Plot i.e. a 'Pressure' X-Y Plot on System B.
MimicThis field is read only (grayed out) and shows the name of the X-Y Plot that is
embedded.
RelativeYou can use this check box to define whether an embedded X-Y Plot uses
relative or absolute references. This only applies when the embedded X-Y Plot is stored
on a different system to the Mimic that you are currently editing.
If you clear the Relative check box, the embedded X-Y Plot will use an absolute
reference. This means that:
The Mimic that contains the embedded X-Y Plot cannot be moved (without
breaking the link to the embedded X-Y Plot)
Copies of the Mimic will also contain the absolute reference and so has to be in the
same location as the original Mimic.
If you select the Relative check box, the embedded X-Y Plot will use a relative
reference. This means that the link to the embedded X-Y Plot will work as long as the
Mimic and the embedded X-Y Plot maintain their locations in relation to each other. As
long as their relative locations remain the same, the Mimic and TX-Y Plot can be moved
onto other systems, copied etc., and the link to the embedded X-Y Plot will remain
intact.
PD-6016 07/2012
169
BackgroundUse the Background color button to set the color of the background of
the embedded X-Y Plot. The background is gray by default, but you can change it to
any of the system colors or to a custom color.
When you select the Background color button, a color palette is displayed.
You can select any of the colors on the palette, or select the ... option to access the
Color window. The colors on the palette are the system colors, and the Color window
allows you to create a custom color (see Using the Color Window, on page 226).
170
PD-6016 07/2012
The Main Font tab contains Family, Height, and Style settings. These are common text
settings and are explained in the Font Tab (see page 223) section.
PD-6016 07/2012
171
The Title Font tab contains Family, Height, and Style settings. These are common text
settings and are explained in the Font Tab (see page 223) section.
172
PD-6016 07/2012
The Label Font tab contains Family, Height, and Style settings. These are common text
settings and are explained in the Font Tab (see page 223) section.
PD-6016 07/2012
173
Double-click on the embedded list (with the Mimic displayed in Design mode).
or:
Right-click on the embedded list and select Properties from the context sensitive menu.
174
PD-6016 07/2012
Specify the database that will be queried for the embedded List.
SystemUse the System combo box to specify the database (system) to which the
SQL query in the embedded List is applied. This allows embedded Lists on one system
to display information taken from the database of another system.
Example:
A company has a ClearSCADA system that contains two databases. One database is
called 'North' and the other is called 'South'. The 'North' database contains a Mimic
that has an embedded List. The embedded List is set up to display the points on a
system. By default, the embedded List displays the points on the 'North' system as this
is the system that contains the Mimic. However, by using the System setting for the
embedded List, an engineer can set the embedded List to display the points that are in
the 'South' database. To do this, the engineer accesses the Properties window for the
embedded List and changes the System setting from North to South.
Similarly, on the South system, a Mimic can be setup to contain an embedded List that
shows the points on the North system. Again, an engineer has to access the Properties
window for the embedded List and change the System setting, only this time the setting
has to be changed from South to North.
Register for InterestUse the Register for Interest check box to define whether the
embedded List is to be updated when new values are available.
If you select Register for Interest, the embedded List will be updated when the
underlying data changes in the database. In ViewX, this is unlikely to cause any
performance issues and your embedded List will update as required. However, your
system may experience slower performance if you use multiple WebX clients to view
the Mimic simultaneously. This is because for a WebX client to update an embedded
List, it needs to frequently check all of the list data for updates. When multiple
embedded Lists all need to display the same data, this can cause slow performance.
With ViewX, this situation is avoided, as ViewX is able to check only for updates.
If you clear Register for Interest, the embedded List will not update on the Mimic. This is
useful when you have no need for the embedded List to update, for example, if you
want the embedded List to show a static list of system users. Clearing the Register for
Interest check box will mean that performance is not affected by the embedded List, no
matter how many ViewX or WebX clients are viewing the Mimic.
However, in some cases it can be inappropriate to clear Register for Interest. For
example, if you need the embedded List to indicate the alarm state of a point, you will
need to select Register for Interest (otherwise, the list will only be able to show the
alarm state that was in effect at the time the embedded List was displayed).
PD-6016 07/2012
175
ForegroundUse the Foreground color button to set the color of the text in the entries
on the list.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
NOTE: The Foreground color only takes effect if the Foreground is not included in the
SELECT part of the SQL Query for the list.
176
PD-6016 07/2012
BackgroundUse the Background color button to set the color of the background of
the list. The background color is shown in each row in the list and also at the extremities
of the list.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
NOTE: The background color only affects the background color of the lists cells if
Background is excluded from the SELECT part of the SQL Query for the list. If the
Background is included in the SELECT part of the SQL Query, the background color will
only affect the background of the table, not the individual cells.
The background color is set to red. As the SQL Query for the list includes
Background in its SELECT definition, the background color is not applied to
the background of the list entries.
Only the background of the table is set to red.
Header TextUse the Header Text color button to set the color of the text in the column
headings on the list.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
PD-6016 07/2012
177
Header FaceUse the Header Face color button to set the color of the column heading
cells on the list.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
Header ShadowUse the Header Shadow color button to set the color of the shadow
line in the header cells on the list. The shadow line is a thin line that is shown on the
bottom and the right-hand edge of each header cell.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
Header HighlightUse the Header Highlight color button to set the color of the
highlight line in the header cells on the list. The highlight line is a thin line that is shown
on the top and left-hand edges of each header cell.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
178
PD-6016 07/2012
Header Dark ShadowUse the Header Dark Shadow color button to set the color of
the dark shadow line in the header cells on the list. The dark shadow line is a thin line
that is shown around the bottom, left, and right edges of the header cells.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
Grid ColorUse the Grid Color color button to set the color of the lines that form the
cells.
As with other color buttons, you can choose a color from the palette, or use the ...
option to create a custom color on the Color window (see Using the Color Window, on
page 226).
PD-6016 07/2012
Grid SizeUse the Grid Size spin-box to define the size of the grid lines that form the
cells. You can increase or decrease the size as required.
179
A common use of the Query tab is to paste an SQL query that has been copied from a List
(you can copy the SQL code for a List by displaying the List, selecting the SQL option on
the View menu, highlighting the SQL code, then right-clicking and selecting the Copy
option). To paste the code onto the Query tab, you need to copy the SQL code as
described, then right-click on the Query tab and select the Paste option from the context
sensitive menu.
If you right-click in the text entry area on the Query tab, a context sensitive menu is
displayed containing the Generate Animation option. If you select this option, the SQL
string that you have entered on the Query tab is copied and converted into the correct
syntax for an animation of the Sql animation property. You can then amend the SQL
animation via the Animations window as required (see Embedded Query List Animations,
on page 379).
For more information, see the SQL Technical Reference on-line Help.
180
PD-6016 07/2012
Double-click on the embedded Alarms List (with the Mimic displayed in Design mode)
or:
Right-click on the embedded Alarms List and select Properties from the context
sensitive menu.
The Embedded Alarms List Properties window has three tabs: General, List Font, and
Header Font. These tabs work in the same way as the General, List Font, and Header
Font tabs on the Embedded List Properties window, except that they apply to the various
parts of the Alarms list (see Editing an Embedded Query List, on page 174).
However, there is one exceptionthe General tab for an embedded Alarms List has a
Filter button that you can use to Filter an Embedded Alarms List (see page 181).
In Design Mode, right-click on the embedded Alarms List to display a context sensitive
menu.
2.
Select the Properties option to display the Embedded Alarms List Properties window.
PD-6016 07/2012
181
3.
Define an Alarm Filter String for an Embedded Alarms List Manually (see page 185).
Or:
Use the Filter Window to Create an Alarm Filter String for an Embedded Alarms List
(see page 187). When you use the Filter window, ClearSCADA converts your
selections into an appropriate string, which it then uses to apply the filter settings.
Before you make your choice, you need to understand how the Alarm Filter String is
used (see Understanding How ClearSCADA Applies Alarm Filters to Embedded Alarms
Lists, on page 183).
4.
Use the Alarm Filter String field or Filter window to define the required filter string (see
Define an Alarm Filter String for an Embedded Alarms List Manually or Use the Filter
Window to Create an Alarm Filter String for an Embedded Alarms List, depending on
how you want to define the string).
5.
Select the OK button to apply the filter setting and close the filter configuration
windows (Edit Embedded Alarms List Filter String dialog box and Filter window).
The embedded Alarms List is now set to use the filter settings you defined every time it
is displayed. Users with appropriate permissions will be able to alter the filter settings
as required, but every time the embedded Alarms List is re-displayed, the filter settings
you defined will be in place.
Further Information
Understanding How ClearSCADA Applies Alarm Filters to Embedded Alarms Lists (see
page 183)
Define an Alarm Filter String for an Embedded Alarms List Manually (see page 185)
Use the Filter Window to Create an Alarm Filter String for an Embedded Alarms List (see
page 187)
182
PD-6016 07/2012
Now that you have an appreciation of how ClearSCADA uses the Alarm Filter String
settings, you can make an informed decision:
PD-6016 07/2012
183
If you want to apply a filter that differs from the default filter values, you can choose to:
Enter the alarm filter string manually (see Define an Alarm Filter String for an Embedded
Alarms List Manually, on page 185). You will need an understanding of the required
syntax: see Alarm Filter String Syntax, on page 77 in the ClearSCADA Guide to Alarms.
or
Use the Filter window to choose the filter settings. ClearSCADA will then generate the
appropriate filter string for you (see Use the Filter Window to Create an Alarm Filter
String for an Embedded Alarms List, on page 187).
If you want to use the default filter values for the embedded Alarms List and are willing to
let User account filter strings take precedence:
Leave the Alarm Filter String for the List blank (see Define an Alarm Filter String for an
Embedded Alarms List Manually, on page 185).
or:
If the default filter settings are not currently in place, you can use the Filter window to
reset the various options to their default value (see Use the Filter Window to Create an
Alarm Filter String for an Embedded Alarms List, on page 187).
If you want to use the default filter values for the embedded Alarms List and you want
these default values to take precedence over any User account filter strings:
see Making an Embedded Alarms Lists Default Filter Settings Take Precedence, on
page 189.
184
PD-6016 07/2012
When you define an alarm filter string manually, you may need to define values for some
of the clauses in your string. If you do not include certain clauses in your string,
ClearSCADA will use the default values for those clauses.
Clause
MinSeverity
Low
MaxSeverity
Critical
AlarmState
All States
Assigned
FALSE
Source
All Sources
AOI
Categories
All Categories
NOTE: Blank clauses in an Alarms List filter string cannot take precedence over defined
clauses in the User account filter string. For more information, see Making an Embedded
Alarms Lists Default Filter Settings Take Precedence, on page 189.
PD-6016 07/2012
185
Display the Embedded Alarms List String dialog box (see Filter an Embedded Alarms
List, on page 181)
2.
On the Edit Embedded Alarms List String dialog box, enter the string for your filter in the
Alarm Filter String text entry field. For more information on constructing an alarm filter
string, see Alarm Filter String Syntax, on page 77 in the ClearSCADA Guide to Alarms.
3.
When you have entered an appropriate string for the filter you require, select the OK
button to confirm. This closes the Edit Embedded Alarms List String dialog box.
4.
Further Information
Understanding How ClearSCADA Applies Alarm Filters to Embedded Alarms Lists (see
page 183)
Use the Filter Window to Create an Alarm Filter String for an Embedded Alarms List (see
page 187)
186
PD-6016 07/2012
Use the Filter Window to Create an Alarm Filter String for an Embedded
Alarms List
To define an alarm filter for an embedded Alarms List, you can either enter the alarm filter
string manually or you can use the various settings on the Filter window. If you use the
Filter window settings, you simply choose the filter options you want to apply and then
ClearSCADA constructs the corresponding filter string for you. This is useful if you are
unfamiliar with expressions and the syntax required for defining filters.
To use the Filter window to create an alarm filter string for an embedded Alarms List:
1.
Display the Embedded Alarms List String dialog box (see Filter an Embedded Alarms
List, on page 181)
2.
On the Edit Embedded Alarms List String dialog box, select the ... browse button to
display the Filter window.
3.
Use the Filter window settings to create the filter criteria for your embedded Alarms List.
These settings work in the same way as the alarm filter settings for an Alarms List, see
Use the Filter Window to Filter Alarm Entries, on page 83 in the ClearSCADA Guide to
Alarms.
PD-6016 07/2012
187
4.
Select the OK button to confirm your choices and close the Filter window.
ClearSCADA creates a string that represents the choices you have made. The string is
added to the Edit Embedded Alarms List dialog box automatically.
5.
The filter you have defined is applied to the list. You have now filtered the embedded
Alarms List.
Further Information
Understanding How ClearSCADA Applies Alarm Filters to Embedded Alarms Lists (see
page 183)
Making an Embedded Alarms Lists Default Filter Settings Take Precedence (see page
189)
188
PD-6016 07/2012
You want to use the default settings for an embedded Alarms Lists filter
and
You want the default settings to take precedence over any defined User filter strings.
This is because the default settings have no need for ClearSCADA to generate a string.
So when ClearSCADA merges the embedded Alarms Lists filter with that of a User
account, the User account filter string is used. This is because the User accounts filter
string has defined clauses whereas the embedded Alarms Lists filter is blank.
Embedded
Alarms List
Filter String
User Account
Filter String
Result
String created
manually by user
Blank
String created
manually by user,
every clause
included
String created
manually by user
String created
manually by user,
some clauses
omitted
String created
manually by user
Blank
Blank
String created
manually by user,
some clauses
omitted
Blank
Blank
String created
manually by user
To configure the embedded Alarms Lists filter so that its default filter values take
precedence over any User account filter strings:
1.
Display the Embedded Alarms List String dialog box (see Filter an Embedded Alarms
List, on page 181)
2.
On the Edit Embedded Alarms List String dialog box, select the ...browse button to
display the Filter window.
PD-6016 07/2012
189
3.
Select the Only Show Alarms Assigned to Current User check box
Add a Source
Select any State (i.e. select any option other than All States).
The reason for changing the settings from the default settings is that it forces
ClearSCADA to generate a string automatically. You can then edit the string so that the
default settings are used in the string, and so, as a result will take precedence over the
clauses in any User account filter strings.
4.
5.
Edit the string so that the default filter values are applied. Your string should appear like
this:
AOI="World"&Source="*"&MinSeverity="1"&MaxSeverity="1000"&Catego
ries="Alarm Inhibit;Archive
Volume;Archiving;Authentication;Callback;Channel Status;Control
Status;Dial In Overactive;EFM Alarm;File Upload
Status;Forecast;Interface Alarm;Off Scan;Outstation
Comms;Outstation Error;Outstation Hardware;Pager Comms;Point
Error;Point No Change;Point State;Scanner Status;Scheduled Dial
In;Server Status;SMS PagerService;SNMP Configuration Error;System
Alarm"&AlarmState="All"&Assigned="FALSE"
NOTE: To apply the default settings, you will need to adjust the values for several
clauses: the value for the categories clause needs to include every category that is
available on your system; the value for the AOI clause needs to be World (which
includes every Area of Interest); the value for the MinSeverity should be 1 and the
MaxSeverity should be 1000.
6.
Select the OK button to confirm your string and close the Edit Embedded Alarms List
String dialog box.
The default filter values are applied to the embedded Alarms List and will be applied
whenever the embedded Alarms List is displayed.
Further Information
Alarm Filter Syntax: see Alarm Filter String Syntax, on page 77 in the ClearSCADA Guide
to Alarms.
190
PD-6016 07/2012
or:
Right-click on the embedded image and select Properties from the context sensitive
menu.
PD-6016 07/2012
191
The General tab contains Name, Visible, Animations, Pick Action, ToolTip, and Dynamic
Position settings that work in the same way as on other General tabs (see General Tab, on
page 204). However, the General tab on the Image Properties window also contains
Alignment settings:
192
CenterSelect this option button to position the embedded image so that it is in the
middle of the image frame (the frame that you drew when you added the image).
StretchSelect this option button to resize the embedded image so that it fills the
image frame.
TileSelect this option button to repeat the embedded image in the image frame until
the image frame is full.
PD-6016 07/2012
or:
Right-click on the remote image and select Properties from the context sensitive menu
The Remote Image Properties window has a General tab. The General tab contains
Name, Visible, Animations, Pick Action, ToolTip, and Dynamic Position settings that work
in the same way as on other General tabs (see General Tab, on page 204). The General
tab on the Remote Image Properties window also contains these settings:
AlignmentThe Alignment settings of Center, Stretch, and Tile work in the same way
as the alignment settings for embedded images (see Editing an Embedded Image, on
page 191), except that they apply to the remote image.
SourceUse to define the location of the image. This can be the complete path name
of an image file that is available on your network or the address of an image file on the
Internet (or your Intranet). For example, to insert the Earth image from the
www.pdimages.com website, you would enter:
http://www.pdimages.com/BX0097.JPG
PD-6016 07/2012
193
194
RefreshUse to set your client PC to request the image at a defined interval. The
Refresh numbers represent seconds, so if you set the Refresh spin-box to 5, your client
PC will request the image every 5 seconds. Although the image on the Mimic will
update at the defined Refresh rate, the picture may change less frequently as the
refresh time of the web server controls how often the image changes.
PD-6016 07/2012
Editing a Button
When you have added a button to a Mimic, you can access its Button Properties window
to edit its settings.
To display the Button Properties window, either:
or:
PD-6016 07/2012
Right-click on the button and select Properties from the context sensitive menu
195
GeneralThe General tab contains some common settings for General tabs, including
Name, Visible, Animations, Pick Action, ToolTip, and the Dynamic Position settings. For
more information on these settings, see General Tab, on page 204.
The General tab on the Button Properties window also contains these settings:
StyleUse the Style combo box to define whether the button is:
LatchThe button will only appear to be pressed down when its Latched
animations property has a value that is true.
Typically, the Latch style is used with a button that is animated to perform an
action when selected. For example, a button can be configured to change the
value of a digital point to True when it is pressed. The state of the digital point
can also be associated with the button's Latched property so that when the
button is pressed, the digital point's value changes to True and the Latched
property changes to True. So, when the button is selected, there is a short
pause as the values and states are processed and changed, then the button
appears to be pressed down.
For more information, see Latched, on page 374.
Latch w/feedbackThe Latch w/feedback style works in the same way as the
Latch style except that there is no delay when the button is selectedthe
button appears to be pressed down when it is selected and when its Latched
property has a True value.
For more information, see Latched, on page 374.
196
PD-6016 07/2012
Repeat IntervalOnly available when the Repeat option is selected for the Style
setting. The Repeat Interval allows you to define how often the repeat occurs. By
default, the Repeat Interval is 1.0 seconds which means that if the button is held in
a pressed down position, the action for the button will repeat once per second (for
as long as the button is pressed down). You can change the amount of time
between each repeat as required.
TextEnter the text that will be shown on the face of the button. By default, the
Text entry is 'Button'.
The Text entry will be overridden by any animations that use the Text animation
property of the button. For more information,see Animations, on page 345.
PenUse the Pen tab to define the color and shading settings for the text that is shown
on the button. The Pen tab settings work in the same way as the settings on other Pen
tabs (see Pen Tab, on page 222).
FillUse the Fill tab to define the color and shading settings for the background of the
button. The Fill tab settings work in the same way as the settings on other Fill tabs (see
Fill Tab, on page 210).
FontUse the Font tab settings to define the style, size, and positioning of the text that
is shown on the button. The Font tab settings work in the same way as the settings on
other Font tabs (see Font Tab, on page 223).
PD-6016 07/2012
197
Double-click on the pie chart (with the Mimic displayed in Design mode)
or:
Right-click on the pie chart and select Properties from the context sensitive menu.
GeneralThe General tab contains some common settings for General tabs, including
Name, Visible, Animations, Pick Action, ToolTip, and the Dynamic Position settings. For
more information on these settings, see General Tab, on page 204.
The General tab on the Pie Chart Properties window also contains these settings:
198
Key PositionUse the Key Position setting to define the location of the key in
relation to the pie chart. Choose from:
PD-6016 07/2012
Key StyleUse the Key Style settings to define what information is shown in the
key. You can choose from:
Label OnlyThe key will only contain the label for each slice. The value and
percentage are not shown.
Value OnlyThe key will only contain the value for each slice. The label and
percentage are not shown.
Percentage OnlyThe key will only contain the percentage for each slice. The
label and value are not shown.
Label and ValueThe key will contain the label and value for each slice. The
percentage is not shown.
Label and PercentageThe key will contain the label and percentage for each
slice. The value is not shown.
Value and PercentageThe key will contain the value and percentage for each
slice. The label is not shown.
Label, Value, and PercentageThe key will contain the label, value, and
percentage for each slice.
NOTE: You will only be able to see the effects of the Key Position and Key Style settings
if there are pie chart animations in place. The pie chart needs to have animations for
one or more slices, with animations for the Value, Color, and Label properties. For more
information, see Animations, on page 345.
FontUse the Font tab settings to define the style, size, and positioning of the text that
is shown in the key for the pie chart. The Font tab settings work in the same way as the
settings on other Font tabs (see Font Tab, on page 223).
NOTE: To remove a slice from a pie chart, you should set the value of the animation for the
slice to 0 before you clear it (remove the slice). If you do not set the slice animation to 0, the
pie chart will continue to show the slice, even after you have cleared the animation for the
slice. This is because the pie chart will maintain the previous value of the slice.
PD-6016 07/2012
199
Editing a Pipe
When you have added a pipe object to a Mimic, you can access its Pipe Properties
window to edit its settings.
To display the Pipe Properties window, either:
or:
Right-click on the pipe and select Properties from the context sensitive menu.
200
GeneralThe General tab contains some common settings for General tabs, including
Name, Visible, Animations, Pick Action, ToolTip, and the Dynamic Position settings. For
more information on these settings, see General Tab, on page 204.
FillUse the Fill tab to define the color and shading settings for the background of the
pipe. The Fill tab settings work in the same way as the settings on other Fill tabs (see
Fill Tab, on page 210).
PD-6016 07/2012
Double-click on the text box (with the Mimic displayed in Design mode)
or:
Right-click on the text box and select Properties from the context sensitive menu.
GeneralThe General tab contains some common settings for General tabs, including
Name, Visible, Animations, Pick Action, ToolTip, and the Dynamic Position settings. For
more information on these settings, see General Tab, on page 204.
TextUse the Text tab to define the text that is to be shown in the text box. Simply type
the required text into the text entry area.
PenUse the Pen tab to define the color and shading settings for the text that is shown
in the text box. The Pen tab settings work in the same way as the settings on other Pen
tabs (see Pen Tab, on page 222).
FillUse the Fill tab to define the color and shading settings for the background of the
text box. The Fill tab settings work in the same way as the settings on other Fill tabs
(see Fill Tab, on page 210).
FontUse the Font tab settings to define the style, size, and positioning of the text that
is shown in the text box. The Font tab settings work in the same way as the settings on
other Font tabs (see Font Tab, on page 223).
BorderUse the Border tab settings to define the appearance of the text box border,
including its visibility, flashing effects, colors, and line width and style (see Border Tab,
on page 202).
PD-6016 07/2012
201
Border Tab
You can use the Border tab to define the appearance of the outline of a text box on a
Mimic. The Border tab is only shown on the Text Properties window (see Editing a Text
Box, on page 201).
By using the settings on the Border tab, you can define the visibility, width, color, and
flashing effects for the outline of a text box. The Arrow Heads settings are designed for
lines and so are unsuitable for use with borders (as the border is a rectangle, with no
start and end).
The settings are:
202
TypeChoose from None (the border will be invisible) or Solid (the border will be shown
as a constant line, forming a rectangle). If you choose None, the other Border tab
settings are made unavailable.
FlashUse to enable or disable flashing on the border. You can also define the type of
flashing effect to be used and the interval between flashes. The Flash settings work in a
similar way to the Flash settings on the Line Tab (see page 219) of a Mimic shape. The
only difference is that these settings apply to the border of the text box.
ColorsUse to define the color scheme used for the text box border. The Colors
settings work in a similar way to the Colors settings on the Line Tab (see page 219) of a
Mimic shape. The only difference is that here, they only apply to the border of the text
box.
LineUse to define the width and style of the text boxs outline. The Line settings work
in a similar way to the Line settings on the Line Tab (see page 219) of a Mimic shape.
The only difference is that the Border tab settings apply to the border line of the text
box.
PD-6016 07/2012
Double-clicking on the group of objects (with the Mimic displayed in Design mode)
or:
Right-clicking on the group of objects and selecting Properties from the context
sensitive menu.
The tabs on the Group Properties window vary according to the types of objects in the
group. For information on each of the tabs, please refer to the section that describes the
relevant type of Mimic object. For example, if you have a group that contains a pie chart,
the Group Properties window will have a Pie Chart Font tabfor information on the
settings on the Pie Chart Font tab, refer to the Font tab in the Editing a Pie Chart (see
page 198) section.
PD-6016 07/2012
203
General Tab
Each Mimic object has a General tab on its Properties window.
The General tab contains some settings that are object specific - for example, the General
tab for a button contains a Button section - and several common settings including:
204
NameThe Name field shows the name of the currently selected Mimic object. The
name is a reference, such as P_21, that is used internally by ClearSCADA. To change
the name, select the browse button next to the name field to display a pop-up window,
then enter the new name in the New field.
VisibleUse the Visible check box to define whether the selected Mimic object can be
seen on the Mimic. If you select the check box, the Mimic object can be seen; if you
clear the Mimic check box, the Mimic object will not be shown on the Mimic.
AnimationsUse the Animations button to access the Animations window. You need to
use the Animations window to associate values in the database with properties of
Mimic objects. For information on the Animations feature, see Animations, on page 345.
Pick ActionUse the Pick Action button to access the Pick Action Wizard. You can use
the Pick Action Wizard to associate the selected Mimic object with a pick action menu
or individual pick action. For more information on the Pick Action Wizard, see
Associating Mimic Objects with Pick Actions, on page 247.
PD-6016 07/2012
Use the ToolTip field to define the text that is shown on the ToolTip for the selected
Mimic object. Simply enter the required text in the ToolTip field.
PolylineUse the following settings to define the pick action settings for polylines:
Use Line ExtentsUse this setting to control when a pick action menu is displayed
for the object:
If you select the Use Line Extents check box, any pick action menu that you
associate with the object will only be displayed when a user selects the outline
of the object. The pick action menu will not be displayed when a user selects
another part of the object, such as the inside of a rectangle.
If you clear the Use Line Extents check box, the pick action menu will be
displayed when a user selects the outline or the inner part of the object.
The Use Line Extents feature is particularly useful with pipes and shapes that have
no fill.
PD-6016 07/2012
205
RotationYou can use the Rotation settings to define the pivot point of the object
and the angle of rotation. This is useful for testing the rotation of an object before
setting up a rotation animation. For example, if you are unsure about the exact
angle which the object needs to be rotated by, you can experiment with the
Rotation settings before making a decision. Once you know the correct angle, you
can define it in an Animation (see Animations, on page 345).
You can use these settings to examine the effects of a rotation:
PivotUse the Pivot combo box to choose the anchor point for the rotation.
The object will rotate from the selected side, corner, or center.
AngleUse the Angle field to enter the angle of rotation. You can enter positive
or negative values.
NOTE: When you have set the Pivot and Angle, close the Properties window and
then switch the Mimic from Design mode into Run mode. The rotation only takes
effect when the Mimic is displayed in Run mode.
206
PD-6016 07/2012
Dynamic SizingYou can use the Dynamic Sizing settings to define the type of
resizing that will be applied to an object and the minimum size, maximum size, and
current size of an object. This is useful for experimenting with sizes before using
Animations to associate the size of an object with values in the database (see
Animations, on page 345).
You can use these settings to view the effects of a size alteration:
MinUse the Min field to define the value that corresponds to the object's
smallest size. Simply enter the required amount.
MaxUse the Max field to define the value that corresponds to the object's
largest size. Enter the required amount.
ValueUse the Value field to define the object's current value. This sets the
object to be a specific size in relation to the Min and Max limits you have
defined. For example, if you enter a Value of 50 and the Min is 0 and the Max is
100, the object will be half of its maximum size (50 is midway in the range
0-100).
Enter the required amount.
PD-6016 07/2012
207
Dynamic PositionYou can use the Dynamic Position settings to define the
positioning of an object. This is useful for experimenting with positioning before
using Animations to associate the position of an object with values in the database
(see Animations, on page 345).
Positioning animations set an object to move along a defined path. The position of
the object on the path varies according to values in the database. For example, a
Mimic object could move between the top corners of a Mimic depending on the
value of a point.
To see the effect of dynamic positioning, you need to define these settings:
AnchorThe Anchor setting allows you to specify which part of the Mimic
object will be anchored to the path line. The 'anchored' part of the object stays
in contact with the path line. For example, if the Anchor is set to Top, the object
will move along the path linethe top of the object will remain on the pathline
with the rest of the object being positioned underneath.
Path line
208
MinUse the Min field to define the value that corresponds to the start of the
path line. Simply enter the required amount.
MaxUse the Max field to define the value that corresponds to the end of the
path line. Enter the required amount.
PD-6016 07/2012
ValueUse the Value field to define the object's current value. This sets the
object to be at a specific location on the path line. The current position of the
object is defined by its Value and is in relation to the Min and Max limits you
have defined. For example, if you enter a Value of 50 and the Min is 0 and the
Max is 100, the object will be half way along the path line (50 is midway in the
range 0-100).
Enter the required amount.
Min value defines the start of the path
line.
PD-6016 07/2012
209
Fill Tab
The Fill tab contains the settings for fill colors. These are the colors that are shown within
an object's boundaries. For example, the following shape has its fill color settings set to
be a solid red:
If you look closely, you will see that the outline of the shape is black. This is because the
outline color is defined on the Line tabthe Fill tab settings only apply to the inner part of
an object.
NOTE: For text boxes and buttons, the Fill tab settings apply to the background of the text
box or button, not the text itself. The color of the text is defined on the Pen tab.
The Fill tab settings that are available vary according to the type of Mimic object you are
editing. The possible Fill tab settings include:
WidthUse the Width spin-box to define the thickness of a line. This setting applies to
pipe objects. When you increase the spin-box amount, the pipe becomes thicker; when
you decrease the amount in the spin-box, the pipe becomes thinner.
TypeUse to choose the type of shading to be applied. There are several shading
options, and the type of shading you choose will affect which settings are available in
the Colors and Fill sections.
The types include:
210
NoneNo fill color is applied. This means that the object will appear to have a
transparent fill. For example, a text box with its Type set to None will only have its
outline and text visible.
HatchThe fill color is a hatch pattern. The pattern consists of two colors that you
can select in the Colors section. You can also change the style of hatch pattern by
using the Pattern combo box in the Fill section.
PD-6016 07/2012
You can define the two colors by using the Start and End buttons in the Colors section
(see Using the Color Window, on page 226).
You can change the position of the two colors by altering the Angle setting in the Fill
section (see Fill Tab, on page 210).
Pipe GradientThe Pipe Gradient option applies a 3D shading effect that makes
the fill appear cylindrical. This feature was specifically designed to be used as the
shading effect on pipe drawings and is the shading effect you can see on any pipes
that you draw using the Add Pipe tool.
An ellipse and a pipe with Pipe
Gradient shading.
As with the Linear Gradient option, the Pipe Gradient feature has two colors.
The Line color is the color of the highlight bar that is inside the fill. This bar acts as
the reflection of the light source. You can move the position of the line by dragging it
in the preview panel at the top-right of the Properties window.
You can also define its position by changing the Position setting, and change its
direction by using the Direction setting. Both settings are in the Fill section (see Fill
Tab, on page 210).
The Bounds color is the color of the fill. You can change the Bounds and Line colors
by using the color buttons in the Colors section (see Using the Color Window, on
page 226).
Radial GradientThe Radial Gradient option applies an 'spherical' shading effect.
Like the other Gradient types of shading, the Radial Gradient uses two colorsa
Point color and a Bounds color.
This ellipse has a green Bounds color and a white Point color.
The Point color can be positioned anywhere within the shape
and creates a spherical shading effect.
The Point color is the color of the highlight within the fill and it acts as the reflection
of a light source. You can move the position of the point by selecting it and then
dragging it in the preview panel at the top right of the Properties window. You can
also define its position by changing the X Position and Y Position settings in the Fill
section (see Fill Tab, on page 210).
PD-6016 07/2012
211
The Bounds color is the color of the fill. You can change the Bounds and Point
colors by using the color buttons in the Colors section (see Using the Color
Window, on page 226).
FlashYou can use the Flash section to apply a flashing effect to the Fill color.
ModeUse the Mode setting to define the speed of the flash effect and how many
flash colors are used. The available modes are:
On/Off (Normal)The fill color flashes on and off (visible then invisible) at the
normal rate which is 1 second on, 1 second off.
On/Off (Fast)The fill color flashes on and off at a faster than normal rate (half
a second on, half a second off).
On/Off (Briefly On)The fill color flashes on for half a second and off for 1 and
a half seconds.
On/Off (Briefly Off)The fill color flashes on for 1 and a half seconds and off for
half a second.
Two Color (Normal)The fill color flashes from one color to another color every
second. You can select the two Flash colors by using the Flash buttons in the
Colors section (see Using the Color Window, on page 226).
Two Color (Fast)The fill color flashes from one color to another color every
half-second. You can select the two Flash colors by using the Flash buttons in
the Colors section (see Using the Color Window, on page 226).
Four ColorThe fill flashes from one color to the next color (in a four-color
sequence) every half second. This feature is useful for creating the illusion of
movement. For example, if you choose a Linear Gradient type of shading and
select four shades of blue as the Start, End, and Flash (x2) colors, you can
create a flash effect that looks like flowing water.
The Start color flashes between the selected start color and the shades
between it and the selected start Flash color. Similarly, the End color, flashes
between the selected End color and the shades between the selected end
Flash color.
212
PD-6016 07/2012
For example, if the Start color is red and the Flash color is white, the fill will
flash:
1. Red
2. Red-White
3. White-Red
4. White
You can define the Flash colors by using the Flash buttons in the Colors section
(see Using the Color Window, on page 226).
OffsetThe flash Offset defines the sequence for color flashing effects.
Each set of flashing colors has a sequence. The sequence begins with the Start
color and ends with the Flash color, with any other colors occurring in between. For
example, for four color flashing, the sequence is:
1. Start color
2. Start color with some end color
3. Flash color with some start color
4. Flash color
Start Color is
first (when
Offset is 0)
Flash Color is
last (when
Offset is 0)
So, if the Start color is red and the Flash color is white, the sequence for a
four-color flash is:
1. Red
2. Red with some white
3. White with some red
4. Red
PD-6016 07/2012
213
By using the Offset setting, you can define where the Start color comes in the
flashing sequence.
Select 0 to set the Start color to be the first color in a flashing sequence.
Select 1 to set the Start color to be the second color in a flashing sequence.
Select 2 to set the Start color to be the third color in a flashing sequence.
Select 3 to set the Start color to be the fourth color in a flashing sequence.
NOTE: For single color flashing effects, the Offset setting defines whether the flashing
sequence begins with the Start color in view (on) or invisible (off).
ColorsYou can use the Colors section to define the colors and shading:
FillThe Fill color button is only available when you choose a Solid or Hatch type of
shading. It defines the background color of the object, so if you have selected Solid
the object will be the Fill color and if you selected Hatch, the object will have a
pattern over the top of the Fill color.
To change the Fill color, you need to select the Fill color button. To do this, simply
select the color shown next to the Fill field name.
When you select the color button, a color palette is displayed. You can set the color
button to any of the colors on the palette, or you can select the ... option to create a
custom color on the Color window (see Using the Color Window, on page 226).
HatchUse the Hatch color button to define the color of the hatch pattern. This
option is only available when you select a Hatch type of shading. You will also need
to use the Fill color button to define the background color for the hatch pattern.
Fill color is yellow
(the background color)
As with the Fill color button (see above), when you select the Hatch color button
you can choose a color from the palette or use the ... option to create a custom
color (see Using the Color Window, on page 226).
214
PD-6016 07/2012
Start and EndThe Start and End color buttons are only available when you
choose a Linear Gradient type of shading.
The Start color is the color at one side of the object and the End color is the color at
the opposite side of the object. The colors blend into each other in the middle of the
object.
Start color is red
As with the Fill color button (see above), when you select the Start or End color
buttons, you can choose a color from the palette or use the ... option to create a
custom color (see Using the Color Window, on page 226).
Line and BoundsThe Line and Bounds settings are available when you set the
shading type to Pipe Gradient.
Use the Line color button to define the color for the highlight that is shown
within the fill area of the object.
Use the Bounds color button to define the color of the background of the fill
area of the object.
This rectangle has a Line color of yellow and a Bounds color
of black.
As with the other color buttons, when you select the Line or Bounds color buttons,
you can choose a color from the palette or use the ... option to create a custom
color (see Using the Color Window, on page 226).
Point and BoundsThe Point and Bounds color settings are available when you
select the Radial Gradient type of shading.
Use the Point color button to define the color for the highlight that is shown
within the fill area of the object.
Use the Bounds color button to define the color of the background of the fill
area of the object.
This rectangle has a Point color of white and a Bounds
color of green.
PD-6016 07/2012
215
FlashUse the Flash color button(s) to define the alternate color when the flash
effect is enabled (see the Flash settings, earlier in this section).
For single color effects, there is one Flash color button. The color will flash between
the Fill color and the Flash color you select (the flash sequence may include shades
between the two colors, depending on the type of flash you have set).
For multiple color effects, such as Linear Gradient shading, there is a Flash color
button for each color in the effect. So for Linear Gradient shading, there is a Flash
color for the Start color and a Flash color for the End color. One side of the object
will alternate between the Start color and its Flash color and the other side of the
object will alternate between the End color and its Flash color.
As with the other color buttons, when you select the Flash color button(s), you can
choose a color from the palette or use the ... option to create a custom color (see
Using the Color Window, on page 226).
Center and EdgeThe Center and Edge color buttons are only available for Pipe
objects. They work in exactly the same way as the Line and Bounds color buttons
for Pipe Gradient shading (described earlier in this section). Center works in the
same way as Line and Edge works in the same way as Bounds.
PatternUse the Pattern combo box to choose the style of hatch for the object (the
Pattern setting is only available if you have selected the Hatch type of shading).
There are over 50 different styles available.
When you make a selection, you can see a preview of the style in the preview panel
at the top right of the Properties window.
AngleThe Angle spin-box is only available when you select the Linear Gradient
style of shading. You can use it to alter the position of the Start and End colors. For
example, if you set the Angle to 45, the Start color begins at the top left-hand side
of the object and the End color is at the bottom-right hand corner of the object.
216
PD-6016 07/2012
Direction, Position, and IndentThese settings are only available when you set the
style of shading to Pipe Gradient.
Use the Direction combo box to choose the direction of the pipe shading. There are
several directions available, including the standard Horizontal and Vertical as well
as shading for corners.
The flange shading styles allow you to create cylindrical shading effects that are
wide at one end and narrow at the other.
An ellipse with Flange Down shading.
You can use the Position spin box to alter the location of the Line color. Simply
increase or decrease the percentage as required. For vertical shading, the left hand
side of the object begins at 0% and the right-hand side is 100%. For horizontal
shading, the top of the object is 0% and the bottom is 100%
Alternatively, you can select the Line color in the preview panel and drag it to the
required position.
When you select a Flange direction, an additional spin-box is displayedIndent.
Use the Indent spin-box to define the position of the bottom points of the flange
shading. Decreasing the percentage will make the bottom of the flange shading
wider (and so it will fill up more of the shape), whereas increasing the percentage
will cause the bottom of the flanges to become smaller and more pointed.
When you make a selection, you can see a preview of the style in the preview panel
at the top right of the Properties window.
PD-6016 07/2012
217
The Y Position represents the vertical position. It begins at 0% at the top side
and ends at 100% at the bottom side.
The X Position sets the horizontal position of the Line or Point
and the Y Position sets the vertical position.
Simply increase or decrease the percentages to change the position of the Line or
Point color as required. Alternatively, you can select the Line or Point in the preview
panel and drag it to the required location (the X and Y Positions will be altered
automatically).
When you make a selection, you can see a preview of the style in the preview panel
at the top right of the Properties window.
218
PD-6016 07/2012
Line Tab
The Line tab contains the settings you need to define the appearance of lines and outlines
(the lines around shapes).
SolidThe outline of selected object on the Mimic is a visible line of a single color.
FlashThe Flash section contains a Blink check box, a Mode combo box, and an
Offset combo box. These settings work in exactly the same way as the Flash settings
on the Fill tab (see Fill Tab, on page 210), except that they apply to the outline of an
object rather than its fill.
ColorsUse the Colors section to define the color of the outline or line.
PD-6016 07/2012
LineUse the Line color button to define the color of the line or outline. As with
other color buttons, when you select the color button, a color palette is displayed.
You can choose a color from the palette, or you can select the ... option to create a
custom color (see Using the Color Window, on page 226).
219
LineUse the settings in the Line section to define the appearance of the line:
WidthUse the Width spin-box to increase or decrease the thickness of the line or
outline. The width is measured in points (the same measurement is used for font
sizes when adding text).
StyleUse the three Style combo boxes to choose the type of line or outline. The
left-hand combo box allows you to choose from a variety of single and double line
styles, and the middle combo box allows you to choose continuous or dashed style
lines. If you select a dashed line, you can use the third combo box to choose the
types of dashes (squared, rounded, or mitred).
JoinsUse the Joins combo box to define the appearance of corners (joins) on the
outline. You can choose from:
Mitre LimitUse to define the limit for mitred joins. The limit is measured in points.
Acute angled Mitred joins can extend beyond the normal boundaries of a line or
shape. This can make certain shapes and lines seem inappropriately sized,
especially when the line width is set to be thick. By defining a mitre limit, you can
restrict the mitred joins so that they can only extend so far. At the position where the
mitred join reaches the limit, ClearSCADA will set the join to be bevelled.
220
PD-6016 07/2012
StartThe Start of the line is the left-hand end or top end of the line. Choose the
required style of arrowhead from the Start combo box list, and the size of
arrowhead from the combo box that is shown to the right of the Start combo box.
EndThe End of the line is the right-hand end or bottom end of the line. Choose
the required style of arrowhead from the End combo box list, and the size of
arrowhead from the combo box that is shown to the right of the End combo box.
Define the style of
arrowhead for the start
of the line with this
combo box.
Define the size of the arrowhead for the start of the line with
this combo box.
PD-6016 07/2012
221
Pen Tab
The Pen tab is available on Properties windows that relate to objects with text, such as
text boxes and buttons. It contains the settings that allow you to define the shading and
colors of the text.
None
Solid
Hatch
Linear Gradient
Pipe Gradient
Radial Gradient
These shading types work in exactly the same way as the shading types for the Fill (see
Fill Tab, on page 210) except that they apply to the text.
222
FlashThe Flash section contains a Blink check box, a Mode combo box, and an
Offset combo box. These settings work in exactly the same way as the Flash settings
on the Fill tab (see Fill Tab, on page 210), except that they apply to the text in a text box
or on a button rather than the fill.
ColorsUse the color buttons in the Colors section to define the colors that are to be
used for the shading. The color buttons work in the same way as the color buttons on
the Fill tab (see Fill Tab, on page 210), except that they apply to the shading for the text
rather than the fill.
PD-6016 07/2012
Font Tab
The Font tab is available for Mimic objects that have text settings, including text boxes
and embedded Trends (there are four Font tabs on embedded TrendsMain Font, Title
Font, Label Font and Key Font).
You can use the Font tab settings to define the appearance of text.
Each Font tab contains these settings:
FamilyUse the Family combo box to choose the style of font. There are many font
styles available. To preview your choice of font, use the Family combo box to select the
required font, then move the Properties window so that you can see the text on the
Mimic. The text will be shown in the font you have chosen.
HeightUse the Height spin-box to set the size of the text. Simply increase the number
to make the text bigger or decrease the number to reduce the text size. The text size is
measured in points.
OrientationThis field is only available for text boxes and it allows you to change the
direction of the text. You can set the text to be:
Left to RightThe text will start at the left-hand side of the text box and will flow to
the right-hand side.
Top to BottomThe text will start at the top of the text box and will flow downwards
to the bottom.
Bottom to TopThe text will start at the bottom of the text box and will flow
upwards to the top.
PD-6016 07/2012
Top to Bottom
orientation
Bottom to Top
orientation
223
FormatAllows you to define the format for the text. This is especially useful for
controlling the display of dates, times, values etc.
When you select the Format button, the Text Format window is displayed.
You can use the Text Format window to define the format for the following categories of
text:
NumberAllows you to define the number of decimal places, trailing zeros, etc.
CustomUse to define a custom format i.e. a format that is different to any of the
default categories.
To alter the settings for a category, select a category in the left-hand field, then use the
settings that are shown on the right-hand side of the window to define the required
format. For detailed information on defining Text Formats, see see Defining the Format
of Displayed Values, on page 239 in the ClearSCADA Core Configuration Guide.
StyleUse to define whether any special characteristics are applied to the text.
Typically, the characteristics are used to create emphasis.
You can choose from:
224
BoldSelect the check box to embolden the text (make it darker and slightly larger)
or clear it to use normal text.
ItalicSelect the check box to italicize the text (make the text thinner and lean to
one side) or clear it to use normal text.
UnderlineSelect the check box to apply a line under the text or clear it to use
normal text.
StrikeoutSelect the check box to apply a line through the middle of the text or
clear it to use normal text.
PD-6016 07/2012
AlignmentUse the option buttons to define the location of the text within the text box
(this section only applies to text boxes). You can choose from:
Left Center RightThe option buttons on this row apply to the vertical position of
the text. If you select Left, the text is positioned on the left of the text box. Selecting
Center places the text in the middle, and selecting Right places the text on the
right-hand side of the text box.
Top Center BottomThe option buttons on this row apply to the horizontal position
of the text. If you select Top, the text is positioned near the top edge of the text box.
Selecting Center places the text in the middle, and selecting Bottom places the text
near the bottom edge of the text box.
PD-6016 07/2012
225
Custom Colors
Color Panel
Color Preview
Shade Bar
Select a blank check box in the Custom Colors section (bottom left-hand side of the
window). If there are no blank check boxes, you will have to overwrite an existing
custom colorselect the check box for the color you want to replace.
2.
In the Basic Colors section, select the color that is closest to the color that you want to
create. For example, if you want to create a light shade of brown, select a basic brown
color.
When you select a basic color, its values are shown in the Hue, Sat, Lum, Red, Green,
and Blue fields. The cursor on the color panel is positioned on the selected color
automatically, and the shade bar shows different shades of the selected color.
3.
Entering new values in the Hue, Sat, and Lum fields or the Red, Green, and Blue
fields. These fields define the hue, saturation, luminescence, and the amount of red,
green, and blue in the color respectively.
Moving the arrow next to the Shade Bar to select a lighter or darker shade of the
selected color.
You can see the color you have created in the Color Preview box.
226
PD-6016 07/2012
4.
When you have created the required color, select the Add to Custom Colors button. The
Select the check box for the custom color that you want to use.
6.
Select the OK button to confirm you selection and close the Color window. The custom
color will now be used as the color for the relevant color button.
PD-6016 07/2012
227
228
PD-6016 07/2012
Chapter 13 - Views
13 Views
Views are specific areas of a Mimic that are shown at a defined level of magnification.
They are used to provide easy access to specific parts of a Mimic. For example, you can
create a View that shows a magnified top left-hand corner of a Mimic.
The main advantage of using Views is that operators and engineers can gain fast access
to specific parts of a Mimic by selecting a View from a list. Hyperlinks can also be
associated with a specific View so that ' chained' Mimics can link to specific areas on
other Mimics. For example, a Mimic containing an overview of a site could contain a
hyperlink to a View of a particular part of plant on another Mimic.
For information on accessing different Views, see Switching Between Views on a Mimic,
on page 45.
PD-6016 07/2012
229
Chapter 13 - Views
Creating a View
To create a View:
1.
Display the Mimic that contains the area to be included in the View. You need to display
the Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
Use the magnification tools to zoom in on the area that is to be shown in the View (see
Magnifying a Mimic (Zooming), on page 36).
3.
4.
5.
Select the Add button to add a new View to the list. The View is selected automatically,
ready for you to define its name. The View already has the X, Y, W, and H settings (X and
Y co-ordinates for the section of the Mimic and width and height settings for the size of
the View) for the area of the Mimic that you magnified in step 2.
6.
Enter a suitable name for the View, then press the Enter key or select another part of the
interface to confirm the selection.
7.
8.
You can change the View settings by using the Edit feature (see Editing a View, on page
231).
NOTE: Only users with the Configure permission can create Views.
230
PD-6016 07/2012
Chapter 13 - Views
Editing a View
To change the positioning or magnification of an existing View:
1.
Display the Mimic that contains the View you want to edit. You need to display the
Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
3.
4.
Select the View you want to edit from the Views list, then select the Properties button.
5.
6.
Change the Position of the View by altering the co-ordinates in the X and Y fields. X is
the positioning from left to right and Y is the positioning from top to bottom.
7.
Change the level of magnification (Size) by altering the W and H settings. W is the width
setting and H is the Height setting. Increasing the numbers reduces the level of
magnification; reducing the numbers increases the level of magnification.
8.
Select the OK button to confirm the settings and close the Edit View window.
Alternatively, you may find it easier to create a new View with the required settings then
remove the existing View (see Removing a View, on page 231).
NOTE: Only users with the Configure permission can edit Views.
Removing a View
To remove a View that is no longer required:
1.
Display the Mimic that contains View that you want to remove. You need to display the
Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
3.
4.
Select the View you want to edit from the Views list, then select the Remove button.
NOTE: Only users with the Configure permission can remove Views.
PD-6016 07/2012
231
Chapter 13 - Views
Display the Mimic that contains the View you want to set as the default View. You need
to display the Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
3.
4.
In the list on the Views window, select the View that is to be the default View.
5.
Display the Mimic that contains the View you want to cancel as the default View. You
need to display the Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
3.
4.
In the list on the Views window, select the View that is the current default View.
5.
The Mimic is reset to have no default View. You can leave the Mimic without a default
View or use the Set Default button to apply the default View status to another View as
required.
Further Information
Creating a Hyperlink to a Mimic Shown at a Specific Level of Magnification: See page
312.
232
PD-6016 07/2012
Chapter 14 - Layers
14 Layers
You can divide a Mimic into several layers, with each layer containing different objects.
This is useful when you need to hide or show groups of Mimic objects at specific levels of
magnification.
The layers feature is often used on Mimics that represent maps, where the default layer
shows little geographical detail, but further Layers show place names and location details,
such as sites and equipment. By using layers, you can control the visibility (and
availability) of objects on the Mimic.
You can set each layer to be visible or hidden when the Mimic is displayed at a specified
level of magnification (or within a specified range of magnification). For example, an
overview Mimic could show the basic overview of a site at the default level of
magnification, but layers containing additional information about specific plant could be
made visible when a user 'Zooms In' on the Mimic.
The visibility of layers can also be controlled by animation expressions. This means that
you can animate a layer so that it is only visible when a value in the registry changes.
This section explains how to configure layers for your Mimics. It explains how to:
For information on navigating between the layers in Run mode, see Operating a Mimic, on
page 35.
PD-6016 07/2012
233
Chapter 14 - Layers
2.
Either:
Or:
Or:
Access the Mimic Properties window, then select the Layers button on the Mimic
tab.
The Layers window contains a list of the layers that are already set up for the Mimic (if
any). Information about the layers is shown in the following categories:
EnabledIndicates whether the layer is active or inactive. Only active layers are visible
on a Mimic. (Yes means active; No means inactive).
FixedIndicates whether the layer can be magnified. The Fixed feature is designed for
use with layers that contain objects that need to be visible at the defined level of
magnification, for example, a menu banner or a company logo.
When the Fixed feature is enabled (indicated by Yes), the layer cannot be magnified,
although other layers may be magnified. When the Fixed feature is disabled (indicated
by No), the layer can be magnified as required.
234
VisibilityShows the range of magnification in which the layer is visible. For example, if
a layer has Visibility of 120%-200% it will only be visible when the Mimic is magnified
between 120% and 200%. When the Mimic is shown at less than 120% or more than
200%, the layer will not be shown.
PD-6016 07/2012
Chapter 14 - Layers
Set DefaultUse to set the selected layer to be the layer that is shown when the Mimic
is first displayed.
Add a Layer
To create a Layer:
1.
Display the Layers window (see Display the Layers Window, on page 234).
2.
A new layer is added to the list. It is selected automatically, ready for you to define its
name.
3.
Type a suitable name for the layer, then press the enter key or select another part of the
interface to confirm the entry.
The new layer has the default layer settings. You can change these settings as required
(see Edit the Layer Settings, on page 236).
PD-6016 07/2012
235
Chapter 14 - Layers
Display the Layers window (see Display the Layers Window, on page 234).
2.
Select the layer that you want to edit by clicking on it in the list of layers.
3.
4.
Use the Name field to alter or overwrite the existing name. Select the field and type
in the required alterations.
Use the Enabled check box to define whether the layer is active (visible on the
Mimic) or inactive (invisible on the Mimic). Select the check box to activate the layer
or clear the check box to deactivate it.
Use the Operator Controlled check box to define whether the layer can be turned
on or off by operators.
If you select this check box, operators will be able to access a context sensitive
menu on the Mimic that allows them to turn the layer on and off.
If you clear the check box, operators will not be able to control whether the layer is
displayed.
Use the Fixed Layer check box to define whether the layer can be magnified. The
Fixed Layer feature is designed for use with layers that contain objects that need to
be visible at the defined level of magnification, for example, a menu banner or a
company logo.
When the Fixed Layer check box is selected, the layer cannot be magnified. When
the Fixed Layer check box is clear, the layer can be magnified as required.
236
PD-6016 07/2012
Chapter 14 - Layers
Use the Visibility settings to define the range of magnification at which the layer is
visible. You can also use the Expression setting to associate the layer's visibility
with a value in the database or registry.
Between %Use the 2 spin boxes to set the range of magnification in which
the layer can be seen. For example, if you set the left-hand side spin-box to
50% and the right-hand side spin-box to 90% the layer will only be shown
when the Mimic is displayed at 50% magnification or above up to 90%
magnification.
The layer visibility settings are particularly useful on Mimics that use layers to
contain different levels of detail. For example, a Mimic could be set up to have
layers that show a geographical location and detailed information about a site.
At the lowest level of magnification, the layer with the least amount of
information is shown, such as an overview of an area. As the user zooms in on
the area, less of the area is shown but more details are revealed such as
buildings etc.
ExpressionYou can use the Expression field to enter a ViewX expression that
associates the visibility of the layer with a value. For example, you can set a
layer to be visible only when a selected point is in a defined state.
Type in an expression or use the browse button to select a Tag.
The Expression feature is normally used when setting up Local Variables
(Registry Key Settings) (see page 239).
5.
Select the OK button to confirm the settings and close the Layer Properties window.
Remove a Layer
To delete any unwanted or unused layers:
1.
Display the Layers window (see Display the Layers Window, on page 234).
2.
Select the layer that you want to remove by clicking on it in the list of layers.
3.
PD-6016 07/2012
237
Chapter 14 - Layers
Layer at the
bottom of
the list is
placed
below the
other layers.
NOTE: Pick action menus are selectable between layers. For example, if a layer named Map
has a text box with a pick action menu, and another layer is positioned over the Map layer,
operators will still be able to access the pick action menu by selecting the area that covers
the text box. However, the pick action menu on the Map layer is unavailable if the area that
covers the text box has its own pick action menu.
To change the order of layers on a Mimic:
238
1.
Display the Layers window (see Display the Layers Window, on page 234).
2.
Select the layer that you want to move in the layers order.
3.
Move UpTo move the layer up one position in the layer order.
Move DownTo move the layer down one position in the layer order.
PD-6016 07/2012
Local Variables are registry settings that allow Mimic display features to be altered without
affecting the display on other PCs. For example, an operator can choose to hide a
specific part of a Mimicthe Mimic object is only hidden on that operator's PC. Other
PCs that are displaying the same Mimic are not affected by the operator's action.
In this section, we explain two common uses for local variables and registry settings:
To allow operators to display different layers at the click of a button (see Using Registry
Settings to Control the Visibility of Layers on a Mimic, on page 240)
To allow operators to apply different filters to an embedded list at the click of a button
(see Using Registry Settings to Apply different Filters to an Embedded List, on page
244).
These are just two possible uses for registry settings. Users with in-depth experience and
knowledge of ViewX expressions will be able to use registry settings for many other
purposes.
For more information, see Welcome to the Guide to Expressions, on page 11 in the
ClearSCADA Guide to Expressions.
PD-6016 07/2012
239
Selecting the 'Show Rivers' object writes a value to a registry key. If the value
in the registry key is 0, the layer containing the rivers is visible; if the value in
the registry key is 1, the layer containing the rivers is invisible.
Another use of registry settings is to switch between filter settings for an embedded list,
so when the registry setting is true one set of filters is applied, and when the registry
setting is false another set of filters are applied (the filters need to be defined in
animations for the embedded list, and the animations also need to use an IF statement to
reference the registry settings).
Usually, the format for the registry expression is:
REGISTRY ('<registry setting name>', 0) = 1
Where <registry setting name> is the name you allocate to the registry setting (do not
enter the angle brackets < >). This means that the registry setting is true when it has a
value of 0 and false when it has a value of 1. You can reference the registry setting name
in your expressions, for example, you can set a layer to be visible when the registry
setting is 0 and invisible when the registry setting is 1.
240
PD-6016 07/2012
To set up a local variable that allows a layer's visibility to be toggled on and off at the click
of a button:
1.
Display the Layer Properties window (see Edit the Layer Settings, on page 236) for the
layer that you want to set up to use the local variable.
2.
In the Expression field, enter the expression that defines the behavior that you require.
The expression should take the format:
REGISTRY ('<registry key name>', 0) = 1
For example:
REGISTRY ('ShowLayer', 0) = 1
3.
4.
Add a Mimic object that will act as a display button. When selected, the object will
toggle the layer's visibility on and off. You can use any type of shape, line, or button for
the object. The object you create needs to be visible on each of the layerswe
recommend that you create a separate layer for the object and set that layer to be the
top layer.
5.
Edit the object so that it has a suitable appearance. For more information, see the
section on editing the object, for example, see Editing a Button, on page 195.
6.
On the General tab of the object's Properties window, select the Animations button.
If you are using a latched button to set the registry value, proceed to step 17.
If you are using an unlatched button or another type of object such as a line or shape to
set the registry value, proceed to step 7.
7.
PD-6016 07/2012
Double-click on the PickParam property to display the Expression window. The Pick
Param property associates an animation with the pick action feature of an object.
241
8.
9.
10. On the Animations window, double-click on the PickType property to display its
Expression window.
11. Enter the number 8 as the expression. This informs the system that the object's pick
action feature is to be used as a registry pick action (8 represents the registry type of
pick action. For more information, see Pick Action Animations for Mimic Objects, on
page 423).
12. Select the OK button to confirm the expression. Proceed to step 29.
NOTE: As an alternative to steps 10 to 12 inclusive, you can select the Pick Action
button on the General tab of the object's Properties window. This displays the Pick
Action Configuration Wizardyou will need to select the Registry option on the Pick
Action Configuration Wizard then proceed through the various stages of the pick action
configuration. You only need to set the object to have a Registry pick action as the other
settings are provided as part of the expression for the PickParam animation.
13. Double-click on the Latched property to display the Expression window. The Latched
property represents the button when it is pressed down.
14. Enter the following expression:
REGISTRY ('<registry key name>', 0) = 1
Where <registry key name> is the name you are using for the registry to which a value
will be written. Do not enter the angle brackets. This expression is identical to the
expression that you used for the layer.
15. Select the OK button to confirm the expression.
16. Close the Animations window.
17. Access the Button Properties window for the latched button (see Editing a Button, on
page 195).
18. On the General tab, select the Pick Action button to display the Pick Action Wizard.
19. Select the Registry option button to set the button to write a value to the registry when
selected.
242
PD-6016 07/2012
20. Select the Next button to proceed to the next step (Registry Configuration Button
Down).
21. In the top field, enter the name of the registry key to which a value is written when the
button is pressed down. The registry key name has to match the name of the registry
key that you defined in the expressions for the layer and the Latched animation
property.
22. Set the Key Type combo box to Number if the value that is written is a number, or set it
to String if the value contains letters.
23. In the Value field, enter the value that is written to the registry when the button is
pressed down.
24. Select the Next button to proceed to the next step (Registry Configuration Button Up.
25. Repeat steps 21-23 inclusive, only this time the settings that you define will apply to the
button when it is up i.e. not pressed down.
26. Select the Next button to proceed to the next step.
27. Enter a Pick Action Comment if required, then select the Next button.
28. Select the Finish button to end the pick action configuration.
29. View the Mimic in Run Mode and select the Mimic object (button, line, shape etc.) to
switch the relevant layer's visibility on and off. If the layer does not toggle between
being visible and invisible, trace your steps through this section and check that you
have followed each step correctly.
PD-6016 07/2012
243
To set up a local variable that allows different filters to be applied to an embedded list at
the click of a button:
1.
Embed a List on the Mimic (see Embed a Queries List on a Mimic, on page 121).
2.
Display the Embedded List Properties window (see Editing an Embedded Query
List, on page 174).
244
PD-6016 07/2012
vi. Enter an expression that defines the query that will be applied and define the
registry name and value. The format is:
'SELECT Id, <field>, <field> FROM' + REGISTRY('<registry key name>', '<database
class>')
Where SELECT defines the start of the query, <field> is the name of a field that is to
be included in the query (and returned by the list). Each field has to be separated by
a comma. FROM instructs the query to retrieve the defined fields from a specific
part of the database. + REGISTRY instructs the system to apply the query to the
database class that is named in the registry (the value in the registry will be the
name of a database class). <registry key name> is the name you allocate to the
registry key that will contain the value that is used to identify the database class and
<database class> is the name of the database class that is used if there is no value
in the registry key. In each case, do not enter the angle brackets < >.
For example:
'SELECT Id, FullName FROM ' + REGISTRY( 'outstation',
'CGenericModbusOS' )
Where 'SELECT Id, FullName FROM' defines the types of values that are being
requested in the query ) Id and FullName. + REGISTRY ('outstation',
'CGenericModbusOS') instructs the embedded list to use the value in the
'outstation' registry key to identify the database class to which the query is applied.
If there is no value in the registry key, it will use the default registry key setting of
'CGenericModbusOS'.
3.
Select the OK button to confirm the expression entry and close the Expression window.
4.
5.
Add a Mimic object that will act as a display button. When the object is selected, a
different filter will be applied to the embedded list. You can use any type of shape, line,
or button.
6.
Edit the object so that it has a suitable appearance. For more information, refer to the
Edit section for the relevant type of object, for example, if you are editing a button refer
to Editing a Button (see page 195).
7.
On the General tab of the object's Properties window, select the Pick Action button.
This displays the Pick Action Configuration Wizard.
8.
On the first 'page' of the Wizard, select the Registry option button. This instructs the
system that the object's pick action menu is to write a value to the registry.
9.
Select the Next button to proceed to the next 'page' of the Pick Action Configuration
Wizard.
10. In the top field, enter the name of the registry key to which a value is written when the
object is selected. The registry key name has to match the name of the registry key that
you defined in the expression for the embedded list's Sql animation.
11. Set the Key Type combo box to String. The String setting is required as the value that is
written to the registry key when the Mimic object is selected contains text (the value
defines a class in the database).
PD-6016 07/2012
245
12. In the Value field, enter the value that is written to the registry when the mimic object is
selected. The value needs to be the name of a database classthe name that you enter
is the class to which the SQL query for the embedded list will be applied. The name has
to be identical to the class name. You can see the available classes by using the
ClearSCADA Database Schema (see Welcome to the Guide to the Database, on page 9
in the ClearSCADA Database Guide).
13. Select the Next button to proceed to the next step.
14. Enter a Pick Action Comment if required, then select the Next button.
15. Select the Finish button to end the pick action configuration.
16. View the Mimic in Run Mode and select the Mimic object (button, line, shape etc.). You
will see that when you select the button, a different filter is applied to the embedded list.
You can use the principles you have used in this procedure to create more selectable
objects that apply different filters to the embedded list as required.
246
PD-6016 07/2012
You can associate any object on a Mimic with a pick action menu (a context sensitive
menu that provides access to specific options).
Object MenuAssociate a Mimic object with the pick action menu of an object in the
database, for example, associate a button with the pick action menu of a database
point. (see Creating an Object Menu Pick Action, on page 251).
HyperlinkAssociate a Mimic object with another display. When the Mimic object is
selected, another display is shown. For more information, see Hyperlinks, on page 291.
MethodAssociate a Mimic object with a specific pick action. When the Mimic object
is selected, a specific method is performed. For example, if you associate a shape with
the Override action, the Override method will be applied when a user selects the shape.
You can choose to set the method to apply a specific value, or you can leave the choice
of value up to the user. (see Creating a Method Pick Action, on page 253).
ScriptAssociate a Mimic object with a script. When the Mimic object is selected, a
script is executed (see Associate a Mimic Script with a Script Pick Action, on page 24 in
the ClearSCADA Guide to Scripting).
RegistryAssociate a Mimic object with a registry setting. When the Mimic object is
selected, a value is written to the registry. The value in the registry can be used as a
condition for other settings, for example, the visibility of a layer can be dependent on
the value in the registry (see Creating a Registry Pick Action, on page 258).
PD-6016 07/2012
247
MenuAssociate a Mimic object with a custom pick action menu. When the Mimic
object is selected, a custom pick action menu is displayed. You can name and
configure the menus and menu options as required. (see Creating a Menu Pick Action,
on page 264).
You can set up any of these pick action menus. ClearSCADA includes a Pick Action
Configuration Wizard which you can use to configure pick actions. The Pick Action
Configuration Wizard is a special display that contains a series of pages, each with
specific settings. It is specially designed to guide you through each step of the pick action
configuration process.
To learn how to display the Pick Action Configuration Wizard, see Accessing the Pick
Action Configuration Wizard, on page 249.
To remove a pick action association that has already been configured, see Removing or
Disabling a Pick Action Association, on page 279.
NOTE: You can also use the Animations window to set up pick action menus (see Using the
Animations Window to Set Up Pick Actions, on page 278).
Further Information
Example Configuration: Pick Actions (see page 280).
248
PD-6016 07/2012
Right-click on the object for which you want to set up a pick action, and select the Pick
Action Wizard option from the context sensitive menu.
Or:
Double-click on an object to display its Properties window, then select the Pick Action
button on the General tab.
PD-6016 07/2012
249
Associating a Script with a Pick Action (see Associate a Mimic Script with a Script Pick
Action, on page 24 in the ClearSCADA Guide to Scripting)
You can also use the Pick Action Configuration Wizard to create Custom Pick Action
Menus (see page 265)
250
PD-6016 07/2012
Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard, on
page 249).
2.
3.
Use the Disabled check box to define whether the pick action you are setting up is
enabled or disabled.
If you select the check box, the pick action will be disabledit will not be available to
users. This setting is designed for use with animations. By animating the PickDisabled
property of an object, you can make the availability of a pick action menu dependent on
a condition. For example, you could set the pick action to disabled on the Pick Action
Wizard and then use an animation to associate the Mimic object's PickDisabled
property with a digital point. The state of the digital point will affect whether the pick
action menu is enabled or disabled.
If you clear the check box, the pick action menu is available for selection. This is the
default setting.
4.
5.
Use the browse button feature of the text entry field to associate the Mimic object with
the pick action menu of a database item.
Alternatively, you can enter the location of the database item.
6.
Use the Relative check box to define whether the Mimic object uses an absolute or a
relative reference to the database item.
Select the Relative check box to use a relative reference; clear it to use an absolute
reference.
PD-6016 07/2012
251
7.
In the Options section, select the check boxes for those menu options that you want to
be displayed on the Mimic object's pick action menu. Clear the check boxes of those
options that you want to exclude from the pick action menu.
8.
9.
Enter a comment in the Pick Action Comment field (if required). The comment is shown
in the status bar when a user positions the cursor over the Mimic object. If you do not
enter a comment, a default comment is shown in the status bar instead.
252
PD-6016 07/2012
NOTE: For information on associating Button objects with method pick actions, see Pick
Action Animations for Mimic Objects, on page 423.
PD-6016 07/2012
253
Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard, on
page 249).
2.
3.
Use the Disabled check box to define whether the pick action you are setting up is
enabled or disabled.
If you select the check box, the pick action will be disabledit will not be available to
users. This setting is designed for use with animations. By animating the PickDisabled
property of an object, you can make the availability of a pick action dependent on a
condition. For example, you could set the pick action to disabled on the Pick Action
Wizard and then use an animation to associate the Mimic object's PickDisabled
property with a digital point. The state of the digital point will affect whether the
hyperlink is enabled or disabled.
If you clear the check box, the hyperlink pick action is available for selection. This is the
default setting.
4.
5.
Use the browse button for the top field to select the database item that provides the
method that you want to be associated with the pick action. For example, if you want
the pick action to write an Override value to a point, use the browse button to select the
point.
6.
Use the Relative check box to define whether the Mimic object uses an absolute or a
relative reference to the database item.
Select the Relative check box to use a relative reference; clear it to use an absolute
reference.
254
PD-6016 07/2012
7.
Use the Aggregate combo box to select the aggregate that provides the required
method. If the method is not provided by an aggregate, select the (None) option.
Each database item is stored in a class in the database. The class includes the fields,
methods etc., that are available for items in that class. Some classes have aggregates
extensions to the class. Each aggregate has its own name, fields and methods that
are used to store data. If the item you selected in step 5 is stored in a class that has an
aggregate, you can use any of the methods for the class or the methods for the
aggregate. If you are configuring a pick action to use an aggregate method, select the
relevant aggregate from the Aggregate combo box.
Some aggregates also have their own alarm conditions which you can select (if
required) in the Alarm combo box.
For more information on aggregates and to learn how to view them in the database
schema, (see Working with the Database Schema, on page 19 in the ClearSCADA
Guide to the Database).
8.
Use the Alarm combo box to select the alarm condition for the method. This is useful as
it allows you to configure pick actions for methods that are only available for specific
alarm conditions (alarm conditions are similar to aggregates in the database as they
also provide additional fields and methods).
The alarm conditions are either specific alarm conditions for the database item you
selected in step 5 or are alarm conditions for the aggregate you selected in step 7.
NOTE: If the method is not provided by a specific alarm condition, select the (None)
option.
For more information on the alarm conditions that are available for the database item or
an aggregate, please refer to the Database Schema (see Working with the Database
Schema, on page 19 in the ClearSCADA Guide to the Database).
9.
Use the Method combo box to select the method that will be performed when the pick
action is selected. The list of methods that is available is dependent on your selection in
the Alarm and Aggregate combo boxes. The available methods are either:
PD-6016 07/2012
255
11. Use the Arguments 'page' to configure the expressions for the arguments:
The Arguments 'page' lists the available arguments. The name of the argument is
shown in the Name column, the required data type is shown in the Type column, and
the expression for the argument is shown in the Value column.
i.
iii. Use the Expressions window to create an expression that defines the argument
value. For more information, see Using the Expression Editors, on page 33 in the
ClearSCADA Guide to Expressions.
iv. Select the OK button to confirm the expression and close the Expression window.
v.
Repeat steps i-v for each argument as required. When you have defined the
required arguments, proceed to step 12.
NOTE: To remove the expression for an argument, right-click on the argument in the
list on the Arguments 'page' then select the Clear option.
256
PD-6016 07/2012
PD-6016 07/2012
257
Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard, on
page 249).
2.
3.
Use the Disabled check box to define whether the pick action you are setting up is
enabled or disabled.
If you select the check box, the pick action will be disabledit will not be available to
users. This setting is designed for use with animations. By animating the PickDisabled
property of an object, you can make the availability of a pick action dependent on a
condition. For example, you could set the pick action to disabled on the Pick Action
Wizard and then use an animation to associate the Mimic object's PickDisabled
property with a digital point. The state of the digital point will affect whether the
hyperlink is enabled or disabled.
If you clear the check box, the hyperlink pick action is available for selection. This is the
default setting.
4.
258
PD-6016 07/2012
5.
Enter the name of the registry in the Name field. If this registry does not already exist,
the selection of the pick action will cause the system to create the registry. The registry
will have the value that you define in step 7 as its default value.
NOTE: You cannot include brackets ( ) in the Name.
Typically, engineers configure the animations for a registry pick action before they setup
the pick action. If the name of the registry and the default value has already been
specified in the animations, the settings on the pick action wizard will not be used to
create a new registry (unless they specify a different registry name).
6.
7.
Use the Type combo box to define the type of value that will be written by the pick
action. The value can be:
In the Value field, enter the Value that is written to the registry when the pick action is
selected. This is the value that will be used as the default value for the registry if the
registry does not already exist.
The value will be overridden by any values that are specified as part of a registry
animation (see Local Variables (Registry Key Settings), on page 239).
8.
9.
Enter a comment in the Pick Action Comment field (if required). The comment is shown
in the status bar when a user positions the cursor over the Mimic object. If you do not
enter a comment, a default comment is shown in the status bar instead.
PD-6016 07/2012
259
Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard, on
page 249).
2.
3.
Use the Disabled check box to define whether the pick action you are setting up is
enabled or disabled.
If you select the check box, the pick action will be disabledit will not be available to
users. This setting is designed for use with animations. By animating the PickDisabled
property of an object, you can make the availability of a pick action dependent on a
condition. For example, you could set the pick action to disabled on the Pick Action
Wizard and then use an animation to associate the Mimic object's PickDisabled
property with a digital point. The state of the digital point will affect whether the
hyperlink is enabled or disabled.
If you clear the check box, the hyperlink pick action is available for selection. This is the
default setting.
260
4.
5.
Select the required command from the Command combo box. The commands
correspond to options in the menus and buttons on the various toolbars. For example,
if you select the Zoom In command, the pick action will provide the same functionality
as the Zoom In button on the Navigate toolbar.
6.
PD-6016 07/2012
7.
Enter a comment in the Pick Action Comment field (if required). The comment is shown
in the status bar when a user positions the cursor over the Mimic object. If you do not
enter a comment, a default comment is shown in the status bar instead.
8.
9.
The Mimic object is now associated with a ViewX command pick action. You can test the
ViewX command pick action by displaying the Mimic in Run mode and selecting the
object that is associated with the ViewX command pick action (pick actions are only
available in Run mode). When the pick action is selected, the relevant command is
performed. For example, if you set the command to Print, selecting the pick action will
display the Print window (you can use the Print window to define the print settings and
start the printing process).
PD-6016 07/2012
261
Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard, on
page 249).
2.
3.
Use the Disabled check box to define whether the pick action you are setting up is
enabled or disabled.
If you select the check box, the pick action will be disabledit will not be available to
users. This setting is designed for use with animations. By animating the PickDisabled
property of an object, you can make the availability of a pick action dependent on a
condition. For example, you could set the pick action to disabled on the Pick Action
Wizard and then use an animation to associate the Mimic object's PickDisabled
property with a digital point. The state of the digital point will affect whether the
hyperlink is enabled or disabled.
If you clear the check box, the hyperlink pick action is available for selection.
262
4.
5.
Enter the command line in the Command field. The command line entry should use the
same syntax as a command line in Windows.
6.
Use the Permission combo box to select the permission that is associated with the
system command pick action. Only users that have the specified permission for the
host Mimic (the Mimic that contains the pick action) will be able to select the pick
action. For more information on permissions, see Allocating Security Permissions, on
page 139 in the ClearSCADA Guide to Security.
7.
PD-6016 07/2012
8.
Enter a comment in the Pick Action Comment field (if required). The comment is shown
in the status bar when a user positions the cursor over the Mimic object. If you do not
enter a comment, a default comment is shown in the status bar instead.
9.
PD-6016 07/2012
263
Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard, on
page 249).
2.
3.
Use the Disabled check box to define whether the pick action you are setting up is
enabled or disabled.
If you select the check box, the pick action will be disabledit will not be available to
users. This setting is designed for use with animations. By animating the PickDisabled
property of an object, you can make the availability of a pick action dependent on a
condition. For example, you could set the pick action to disabled on the Pick Action
Wizard and then use an animation to associate the Mimic object's PickDisabled
property with a digital point. The state of the digital point will affect whether the
hyperlink is enabled or disabled.
If you clear the check box, the hyperlink pick action is available for selection. This is the
default setting.
4.
NOTE: Alternatively, you can access the Pick Menu window by right-clicking on the
relevant Mimic item and then selecting the Advanced Pick Menu option from the
context sensitive list.
264
PD-6016 07/2012
5.
Use the Pick Menu window to create new pick action menu options and sub-options
(see Using the Pick Menu Window, on page 266)
6.
Use the Test button to see how the custom pick action menu will be displayed when
selected on the Mimic.(see Test Custom Pick Action Menus, on page 275)
7.
Select the OK button to confirm your custom menu settings and close the Pick Menu
window.
Further Information
Associating a Custom Menu Pick Action with a Mimic Parameter (see page 276).
Example Configuration: Pick Actions (see page 280).
Using Custom Menu Options on a Symbol to Write Values to a Point (see page 286).
PD-6016 07/2012
265
266
Remove a Custom Pick Action or Custom Pick Action Menu (see page 272)
Change the Order of Custom Pick Actions, Menus, and Separator Lines (see page 273)
Add Comments for Custom Pick Actions and Menus (see page 274)
Enable and Disable a Custom Pick Action Menu (see page 274)
PD-6016 07/2012
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
A new menu is added to the pick action menu tree structure. It is selected
automatically, ready for you to define its name.
3.
Enter a suitable name, then press the Enter key or select another part of the interface to
confirm the name entry.
When you have added a menu, you can add pick actions to the menu (see Add a Custom
Pick Action, on page 268) and move the menu in the pick action menu tree structure (see
Change the Order of Custom Pick Actions, Menus, and Separator Lines, on page 273).
PD-6016 07/2012
267
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
In the pick action menu tree structure, select the custom menu to which you want to
add a custom pick action.
3.
The Pick Action Configuration window has an extra setting when displayed for custom
menu pick actionsthe Animate Parameter check box. For more information on this
setting, see Associating a Custom Menu Pick Action with a Mimic Parameter, on page
276.
4.
268
Use the first page of the Pick Action Configuration window to choose the type of pick
action that you want to add. The types are:
Object MenuThe custom pick action provides access to the pick action options
for an object in the database. If you have selected this option and have not enabled
the Animate Parameter check box, proceed to step 5.
MethodThe custom pick action instigates a method action when selected. If you
have selected this option and have not enabled the Animate Parameter check box,
proceed to step 7.
ScriptThe custom pick action executes a script when selected. If you have
selected this option and have not enabled the Animate Parameter check box,
proceed to step 8.
RegistryThe custom pick action writes a value to the registry when selected. If
you have selected this option and have not enabled the Animate Parameter check
box, proceed to step 9.
PD-6016 07/2012
NOTE: If you select the Animate Parameter check box, you allow the custom action to
be associated with a Mimic parameter instead of a specific database object. If you want
to associate a custom action with a Mimic parameter, see Associating a Custom Menu
Pick Action with a Mimic Parameter, on page 276. If you do not intend to associate the
custom action with a Mimic parameter, clear the Animate Parameter check box.
5.
Use the browse button feature of the Object field to choose a database item. The
database item that you choose is the database item that provides the pick action
menu that is associated with the custom pick action.
Use the Options section to choose the options that are to be included (select to
include; clear to exclude).
Use the Relative check box to define whether the custom pick action uses an
absolute or relative reference to link to the selected database item. If the check box
is selected, the custom pick action uses a relative reference.
Use the URL field's browse button to select the target display.
Use the Mode combo box to define where the target display is shown
Use the spin boxes to define the positioning and sizing of the target display (where
appropriate).
Use the Relative check box to define whether the custom pick action uses an
absolute or relative reference to link to the selected display. If the check box is
selected, the custom pick action uses a relative reference.
These settings work in the same way as the corresponding settings on the Pick Action
Configuration Wizard for hyperlinks (see Using the Pick Action Wizard to Create a
Hyperlink, on page 303).
Proceed to step 12.
PD-6016 07/2012
269
7.
Use the Object field's browse button to select the database item that provides the
method that you want to be associated with the pick action. For example, if you
want the pick action to write an Override value to a point, use the browse button to
select the point.
ii. Use the Method combo box to choose the type of method that is performed when
the custom pick action is selected.
iii. Use the Relative check box to define whether the custom pick action uses an
absolute or relative reference to link to the selected method. If the check box is
selected, the custom pick action uses a relative reference.
iv. Select the Next button to display the next page of the Pick Action Wizard.
v.
Use the Script field's browse button feature to select a preconfigured function or enter
any valid script in the field. The selected function or defined script will be executed
when the custom pick action is selected. For more information, see Associate a Mimic
Script with a Script Pick Action, on page 24 in the ClearSCADA Guide to Scripting.
Proceed to step 12.
9.
Use the Name field to enter the name of the registry key.
Use the Type combo box to choose the type of registry value.
Use the Value field to define the value that is written to the registry.
These settings work in the same way as the corresponding settings on the Pick Action
Configuration Wizard for registry key pick actions (see Creating a Registry Pick Action,
on page 258).
Proceed to step 12.
10. Use the Command combo box to select the type of ViewX command that will be
performed when the custom pick action is selected. Each command corresponds to a
toolbar option or menu option. For more information, see Creating a ViewX Command
Pick Action, on page 260.
Proceed to step 12.
270
PD-6016 07/2012
Use the Command browse button to select an application to run when the custom
pick action is selected. Alternatively, enter a system command in the field.
Use the Permission combo box to choose the permission that controls whether a
user can use the pick action to perform a system command. Only users that have
the selected permission for the host Mimic (the Mimic that provides access to the
custom pick action) can select the custom pick action.
For more information, see Creating a System Command Pick Action, on page 262.
Proceed to step 12.
12. Enter an expression to define the availability of the pick action in the expression field, or
leave the field empty to set the pick action to be available. If you choose to enter an
expression, the value of the expression has to be convertible to a Boolean value (as the
action will be available when the expression is true and unavailable when it is false). If a
custom action is unavailable, it does not appear on the custom menu.
For more information on the syntax for expressions, see Understanding the Basics of
Expressions, on page 12 in the ClearSCADA Guide to Expressions.
13. Select the Next button to confirm.
14. Select the Finish button to confirm your choices and close the Pick Action
Configuration window.
The custom pick action is added to the custom pick action menu structure.
You can change its position if requiredsee Change the Order of Custom Pick Actions,
Menus, and Separator Lines, on page 273.
Further Information
Associating a Custom Menu Pick Action with a Mimic Parameter (see page 276).
Example Configuration: Pick Actions (see page 280).
Using Custom Menu Options on a Symbol to Write Values to a Point (see page 286).
PD-6016 07/2012
271
Add a Separator
You can use the Add Separator feature of the Pick Menu window to add a separator line
to your custom pick action menu. By using separators, you can divide your custom pick
action menus into sections, for example:
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
In the pick action menu tree structure, select the custom pick action that will be
positioned above the separator line.
3.
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
Double-click on the pick action that you want to edit. Alternatively, select the pick
action and then select the Edit button.
Use the Pick Action Configuration window to alter the configuration of the custom pick
action (see Add a Custom Pick Action, on page 268).
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
Select the pick action or pick action menu that you want to remove, then select the
Remove button.
272
PD-6016 07/2012
Change the Order of Custom Pick Actions, Menus, and Separator Lines
You can change the order of pick actions, pick action menus, and separator lines. To do
this, you need to use the Move Up and Move Down buttons on the Pick Menu window.
To change the order of custom pick actions, custom pick action menus, and separator
lines:
1.
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
Select the pick action, menu, or separator line that you want to move.
3.
Either:
4.
PD-6016 07/2012
Select the Move Up button to move the action, menu, or line towards the top of the
hierarchy.
Select the Move Down button to move the action, menu, or line towards the bottom
of the hierarchy.
273
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
3.
4.
The Comment field works in the same way as the PickComment field on the Pick Action
Configuration Wizard. For more information, see the relevant Pick Action Configuration
Wizard section, for example, refer to Hyperlinks (see page 291) for information on the pick
comment for a hyperlink pick action.
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
Either:
3.
274
Select the Disabled check box to make the custom pick action menu unavailable.
Clear the Disabled check box to enable the pick action menu so that users can
access its options.
PD-6016 07/2012
Display the Pick Menu window (see Using the Pick Menu Window, on page 266).
2.
Create the custom pick action menu by adding pick action menus, pick actions, and
separator lines as required.
3.
The pick action menu is displayed. It shows the various branches that you have created
as part of the menu's hierarchy.
PD-6016 07/2012
275
Create a parameter for the Mimic that contains (or is to contain) the custom pick action
menu (see Adding a Mimic Parameter, on page 466).
2.
Display the Pick Menu window (see Using the Pick Menu Window, on page 266)
3.
Either create a new action or edit an existing action (see Add a Custom Pick Action, on
page 268 or see Edit a Pick Action Menu Option, on page 272).
On the first page of the Pick Action Wizard, select the button for the type of action you
want to create and then select the Animate Parameter check box. The options for the
types of action are the same as those that are available when creating a custom action
that is associated with a specific database item (see Add a Custom Pick Action, on
page 268).
5.
6.
On the expression entry page, define the expression for the custom action. The
expression has to be valid for the type of custom action you have selected and if it
references a parameter, the parameter has to be available on the Mimic.
For more information on the syntax for expressions, see Understanding the Basics of
Expressions, on page 12 in the ClearSCADA Guide to Expressions.
7.
276
PD-6016 07/2012
8.
On the second expression entry page, enter an expression to define the availability of
the pick action. If you leave the field empty, the pick action is made available by default.
If you choose to enter an expression, the value of the expression has to be convertible
to a Boolean value (as the action will be available when the expression is true and
unavailable when it is false). If a custom action is unavailable, it does not appear on the
custom menu.
For more information on the syntax for expressions, see Understanding the Basics of
Expressions, on page 12 in the ClearSCADA Guide to Expressions.
9.
10. Select the Finish button to complete the custom action configuration.
11. Repeat as required for other custom actions.
Further Information
Example Configuration: Pick Actions (see page 280)
Custom Pick Action Menus (see page 265)
Mimic Parameters (see page 461)
Understanding the Basics of Expressions: See page 12 in the ClearSCADA Guide to
Expressions.
PD-6016 07/2012
277
PickTypeUse to set the type of pick action menu (ClearSCADA Object, Hyperlink,
Registry, etc.).
For more information on setting up the pick action animations, see Animations, on page
345.
278
PD-6016 07/2012
You can remove the pick action association completely, so that the configuration for the
pick action is removed and the Mimic object is not associated with the pick action in
any way.
You can disable the pick action association so that the pick action configuration
remains intact, but is disabled. This means that the Mimic object will not 'trigger' the
pick action when selected. However, if the pick action is disabled, it can later be
restored by clearing the Disabled check boxthe pick action will not need to be
reconfigured.
Display the Pick Action Wizard for the Mimic object that you wish to disassociate from
the pick action (see Accessing the Pick Action Configuration Wizard, on page 249).
2.
Select the None option to remove the pick action configuration. You should select
this option if you want to cancel the pick action association permanently.
Or:
Select the Disabled check box to leave the pick action configuration in place, but
set it to be disabled so that selecting the Mimic object has no effect. You should use
this option if you only need to temporarily cancel the pick action association.
3.
Select the Next button to proceed to the next 'page' of the Pick Action Wizard.
4.
Repeat step 3 as required until you reach the final 'page' of the Pick Action Wizard.
5.
Select the Finish button to confirm your selections and close the Pick Action Wizard.
PD-6016 07/2012
279
Associating a Mimic Object with a Points Pick Action Menu (see page 280)
Associating a Mimic Object with the Alarms On Sytstem Command (see page 282)
Using Custom Menu Options on a Symbol to Write Values to a Point (see page 286).
By default, each of the pick action menus options are shown. The engineer decides that
only a small selection of the options should be available for this Mimic, and so the Mimic is
displayed in Design Mode again. The engineer right-clicks on the valve object and selects
the Pick Action Wizard option from the menu. This displays the Pick Action Wizard.
280
PD-6016 07/2012
The engineer selects the Next button to proceed to the second page of the wizard. There,
the options list shows the pick actions that can be included on the pick action menu.
The engineer clears the check boxes for those options that should not be included in the
pick action menu, then selects the Next buttons to proceed through the pages of the wizard.
Finally, the engineer selects the Finish button to confirm the changes and close the wizard.
The engineer displays the Mimic in Run Mode and selects the valve object. The pick action
menu for the point is displayed again, only this time, it only contains those options that were
chosen by the engineer (the options that remained selected).
PD-6016 07/2012
281
The engineer right-clicks on the text box to display a context sensitive menu, then selects
the Pick Action Wizard option. On the Pick Action Wizard, the engineer selects ViewX
Command as the type of pick action, then selects Next. On the second page of the
wizard, the engineer selects Alarms on System as the ViewX command that will be
executed when the text box is selected, then selects Next followed by Finish to complete
the configuration.
The Mimic is displayed in Run Mode and the engineer selects the Display System Alarms
text boxthe Alarms List is displayed and it has no filters, so shows all system alarms (to
which the logged on user has access).
Further Information
Creating a ViewX Command Pick Action (see page 260)
282
PD-6016 07/2012
Example:
A Mimic contains a graphical representation of a weir that is used in the water industry. The
weir is animated so that it is raised or lowered, depending on the value of an analog point
(named MDN River Level).
The Mimic also contains 2 buttons, both of which are set to Repeat mode. One button is
named Raise Weir and the other is named Lower Weir.
When the Lower Weir button is held down, 10 is deducted from the current value of the
MDN River Level points current value every second. This change in value is reflected in the
position of the weir in the graphic.
PD-6016 07/2012
283
When the Raise Weir button is held down, 10 is added to the current value of the MDN
River Level points current value every second. This change in value is also reflected in the
position of the weir in the graphic.
The configuration for the various Mimic objects and animations is as follows:
Weir Mimic object:
The Weir Mimic object has a Dynamic Path animation that sets the moving part to move
along a straight, downwards line:
284
PD-6016 07/2012
Pos Anchor: 0. This sets the anchor point of the moving part to be the center.
PosMax: 100. This sets the last position on the path to correspond to a value of 100.
PosMin: 0. This sets the first position on the path to correspond to a value of 0.
PosVal: ".MDN River Level.CurrentValue". This associates the position of the moving
part with the current value of the MDN River Level point.
Type: Method
These settings mean that when the Raise Weir button is held down, the value of the MDN
River Level point will decrease by 10 (every second by default). This will cause the moving
part of the weir object to move upwards as it has a dynamic path animation that is
associated with the current value of the MDN River Level point.
Lower Weir button:
The Lower Weir button has the same configuration as the Raise Weir button except that it
uses the following argument:
This means that when the Lower Weir button is pressed, the value of the MDN River Level
point increases by 10 (every second by default). This will cause the moving part of the weir
object to move downwards.
Further Information
Pick Action Animations for Mimic Objects (see page 423)
Associating Mimic Objects with Pick Actions (see page 247).
Editing a Button (see page 195)
PD-6016 07/2012
285
The pump graphic is configured to have a custom menu. The user right-clicks on the
pump graphic and selects the Advanced Pick Menu option. Then, on the Pick Menu
window, the user selects Add Menu and names the new menu Pump Power. Within this
menu, the user creates 4 new actions named Increase Power 10, Max Power, Decrease
Power 10 and Minimum Power. The pick actions for these actions are configured as
follows:
Increase Power 10:
Type: Method
Object: SCX:////CPointAlgManual/.Pump Controls
Method: Hand Control
Expression: ".Pump Controls" +10
Max Power:
Type: Method
Object: SCX:////CPointAlgManual/.Pump Controls
Method: Hand Control
Expression: ".Pump Controls" 90
286
PD-6016 07/2012
Min Power:
Type: Method
Object: SCX:////CPointAlgManual/.Pump Controls
Method: Hand Control
Expression: ".Pump Controls" 5
For the 4 custom menu options, the Animate Parameter setting is cleared
This means that each custom action can only be associated with the properties of a specific
database item (in this case, the Pump Controls point). As the Pump Mimic is designed to
be used as a symbol Mimic (a generic representation of a pump that can be embedded on
many Mimics), only being able to link the Mimic with one specific point means it has limited
use. So the Pump Mimic is reconfigured so that it can be associated with any database
point.
PD-6016 07/2012
287
An engineer uses the Parameters window (accessed via the Edit menus Parameters option)
to add the following Mimic parameters:
Name: Point
Group: Yes (selected)
Name: CurrentValue
Parent: Point
Name: FullScale
Parent: Point
Name: ObjectLink
Parent: Point
Name: ZeroScale
Parent: Point
These parameters will allow the Pump Mimic to be associated with the CurrentValue,
FullScale, and ZeroScale properties of a point (the ObjectLink is required to link the pick
action menu of any point to the Pump Mimic). The parameters require the same name as
the database item properties with which they will be used.
The engineer then reconfigures the 4 custom menu options so that they have the Animate
Parameter setting selected (enabled). This allows each custom menu to use a parameter as
an animation property.
When the Animate Parameter setting is enabled and the Next button is selected, the
engineer is prompted to enter an expression. The engineer enters the following expressions
for the custom menu options:
Increase Power 10:
"Parameter:Point.ObjectLink"+'?CurrentValue&value="'
+STR("Parameter:Point.CurrentValue"+10) +'"'
The expression links the custom menu with the ObjectLink and CurrentValue parameters and
is set to convert the current value of a point to a string. It then adds 10 to the value before
writing it back to the parameter source (which will be a point).
288
PD-6016 07/2012
Min Power:
"Parameter:Point.ObjectLink"+'?CurrentValue&value="' +STR("Parameter:Point.ZeroScale")
+'"'
The expression links the custom menu with the ObjectLink and CurrentValue parameters and
is set to convert the current value of a point to a string. It then sets the value to the same
value as the ZeroScale of the parameter source (which will be a point).
The engineer saves the Pump Mimic and creates a new, blank Mimic. Next, the engineer
adds an embedded version of the Pump Mimic to the new Mimic. The embedded Pump
Mimic has the custom menu options of Increase Power 10, Decrease Power 10, Max Power
and Min Power, but they are not associated with any database item.
To associate the custom menus with a point, the engineer selects the embedded Pump
Mimic so that it is highlighted. They then drag the required point from the Database Bar onto
the Pump Mimic, and a context sensitive menu is displayed.The engineer selects the Point
option (which corresponds to the name of the parent group of parameters) and then selects
the Configure All option. This associates the custom menu options on the embedded
Pump Mimic with the points FullScale, ZeroScale, CurrentValue and ObjectLink properties.
When a user selects the options on the custom menu, they will increase or decrease the
points value accordingly.
The engineer embeds the Pump Mimic on other Mimics and associates the custom menus
with a variety of other points. The embedded Pump Mimics can be associated with any
points as the custom menu pick actions have the Animate Parameter setting enabled.
Further Information
Pick Action Animations for Mimic Objects (see page 423)
Associating Mimic Objects with Pick Actions (see page 247)
Custom Pick Action Menus (see page 265)
PD-6016 07/2012
289
290
PD-6016 07/2012
Chapter 17 - Hyperlinks
17 Hyperlinks
Hyperlinks are special parts of a display that, when selected, cause another display to be
shown. For example, a shape on a Mimic can be configured to act as a hyperlink to
another Mimic. The Mimic that is to be displayed when the hyperlink is selected is referred
to as the 'target'. When the shape is selected, the 'target' Mimic is displayed (either in
place of the Mimic, or in a new window depending on the configuration of the hyperlink).
In the following sections, we explain the concept of hyperlinks and 'chained' displays and
describe how to create and use your own hyperlinks:
Using the Pick Action Wizard to Create a Hyperlink (see page 303)
PD-6016 07/2012
291
Chapter 17 - Hyperlinks
292
Creating a Hyperlink to a ViewX Document on Another ViewX Head (see page 331)
Hyperlinks that Define Values for Mimic Parameters on a Target Mimic (see page 337)
PD-6016 07/2012
Chapter 17 - Hyperlinks
When you select a hyperlink, the 'target' display is shown in place of the 'source' Mimic.
The 'target' display is the display that is shown when the hyperlink is selected, and the
'source' Mimic is the Mimic that contains the hyperlink object. The 'target' display for a
hyperlink is defined in the hyperlink configuration.
NOTE: If you are working on a WebX client, you can select hyperlinks to Mimics on other
systems. However, the target Mimic will only be displayed if the appropriate server
configuration for the system is in place (defined in the Server Configuration Tools WebX
settings). The WebX settings allow ClearSCADA to determine which system contains the
Mimic that is the target for the hyperlink. For more information, see Cross Database
Hyperlinks for WebX Clients (see page 334).
The 'target' display can be shown in:
PD-6016 07/2012
the same window as the 'source' Mimic (it replaces the 'source' Mimic). This can be
resized as required.
293
Chapter 17 - Hyperlinks
NOTE: The new window will replace the current window if the User configuration is set
to only support Single Document Interface only. The Single Document Interface setting
is defined on the User Form (see User Accounts, on page 75).
a new window with user defined proportions and a user defined anchor position. This
type of window is referred to as an inset window and its proportions and position are
defined in the hyperlink configuration.
Inset windows are 'children' of the 'parent' Mimic (the Mimic that contains the hyperlink
that opens the inset window). They are displayed on top of the 'parent' Mimic and are
closed if the 'parent' Mimic is closed.
When 'target' displays are set to be displayed in the same window as the 'source' Mimic,
a navigation 'chain' can be formed. A 'chain' is a sequence of displays and can contain an
unlimited number of displays.
As the window can only show one of the displays in the chain at once, you can use the
navigation tools to move through the sequence of 'chained' displays. The Back and
Forward tools allow you to move to the previous display and next display in a sequence
respectively.
294
PD-6016 07/2012
Chapter 17 - Hyperlinks
Example:
A Mimic named 'Pipe Line Overview' is displayed. It contains a hyperlink to a 'Water Tank'
Mimic. When the user selects the hyperlink, the first link in the 'chain' is formed:
'Pipe Line Overview' - chained to - 'Water Tank'.
In this sequence, the 'Pipe Line Overview' Mimic is the first display that is viewed, and the
'Water Tank' Mimic is the second display that is viewed. When the 'Water Tank' Mimic is
displayed via the hyperlink, the Back button becomes available. The user selects the Back
button, and the window shows the previous display in the 'chain' (the 'Pipeline Overview'
Mimic) in place of the current display (the 'Water Tank' Mimic).
When the 'Pipe Line Overview' Mimic is re-displayed, the Forward button becomes
available. The user selects the Forward button and the window shows the next display in the
'chain' (the 'Water Tank' Mimic).
PD-6016 07/2012
295
Chapter 17 - Hyperlinks
The 'Water Tank' Mimic contains a hyperlink to a point's configuration Form. The user
selects the hyperlink to the Form, and the Form is displayed in place of the 'Water Tank'
Mimic. This creates a second link in the 'chain':
'Pipe Line Overview' - chained to - 'Water Tank' - chained to - 'Point Form'.
The user selects the Back button to return to the 'Water Tank' Mimic, then selects the Back
button again to return to the 'Pipeline Overview' Mimic.
NOTE: The Back and Forward tools are available from the Operate toolbar.
Further Information
Configuring a Hyperlink on a Mimic (see page 297).
296
PD-6016 07/2012
Chapter 17 - Hyperlinks
Using the Pick Action Wizard to Create a Hyperlink (see page 303)
No matter which method you choose, when you configure the hyperlink, you will need to
specify:
The location of the display that is to be shown when the hyperlink is selected (the
'target' display). The 'target' display can be another Mimic, a configuration Form, a List,
a Trend, an X-Y Plot, or any other type of ClearSCADA display. The 'target' display can
also be a Third Party Application display, such as a Microsoft Word document or could
even be a web page.
How the 'target' display will be shown. You can set the 'target' display to be shown in
place of the Mimic that contains the hyperlink (the 'source' Mimic) or in a new window.
You can also define a comment for the hyperlink. The comment can provide a brief
description of the hyperlink so that users can understand its purpose. Typically, the
comment provides an indication of what is shown when the hyperlink is selected.
PD-6016 07/2012
297
Chapter 17 - Hyperlinks
298
Hyperlinks that Define Values for Mimic Parameters on a Target Mimic (see page 337).
PD-6016 07/2012
Chapter 17 - Hyperlinks
Use Drag and Drop to Create a New Text Box Hyperlink (see page 299)
Use Drag and Drop to Create a Hyperlink for an Existing Mimic Object (see page 301).
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Either:
i.
In ViewX, use the Database Bar to locate the item that is the 'target' of the
hyperlink. The 'target' display will be:
The graphical display for any item that is configured graphically, such as
Pre-Configured Trends, X-Y Plots, Schedules, Mimics, Function Block
Diagrams etc.
The configuration Form for any database item that is not configured graphically,
for example, database points, channels, outstations etc.
ii. Select the item and keep the left-hand mouse button pressed down. Proceed to
step 3.
Or:
i.
Use Windows Explorer to locate the file that is the 'target' display.
ii. Size the Windows Explorer window and the ViewX window so that you can drag the
file icon from the Windows Explorer window onto the Mimic.
iii. Select the icon for the file. Keep the left-hand mouse button pressed down.
Proceed to step 3.
Or:
i.
Use a web browser such as Internet Explorer to display the web page that is to be
the 'target' display.
ii. Size the browser window and the ViewX window so that you can drag the file icon
from the Address field on the browser onto the Mimic.
iii. Select the icon for the web page (in the browser's Address field). Keep the left-hand
mouse button pressed down. Proceed to step 3.
PD-6016 07/2012
299
Chapter 17 - Hyperlinks
3.
Drag the item onto the Mimic's design area, then release the left-hand mouse button.
A new text box is added to the Mimic. It is automatically configured to act as a hyperlink
to the display you selected in step 2.
You can alter the text in the text box and change its appearance in the same way as you
would edit any other text box (see Editing a Text Box, on page 201). You can also edit the
animations that are in place for the hyperlink (see Text Box Animations, on page 356). If
you want to change the ToolTip for the hyperlink or set the 'target' display to be shown in
a new window, use the Pick Action Configuration Wizard (see Using the Pick Action
Wizard to Create a Hyperlink, on page 303).
When the Mimic is displayed in Run mode, users will be able to select the hyperlink text
boxwhen it is selected, the relevant 'target' display will be shown.
300
PD-6016 07/2012
Chapter 17 - Hyperlinks
Use Drag and Drop to Create a Hyperlink for an Existing Mimic Object
To use drag and drop functionality to create a hyperlink for an object on a Mimic:
1.
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Select the Mimic object that is to act as the 'trigger' object for the hyperlink.
3.
Either:
i.
In ViewX, use the Database Bar to locate the item that is the 'target' of the
hyperlink. The 'target' display will be:
The graphical display for any item that is configured graphically, such as
Pre-Configured Trends, X-Y Plots, Schedules, Mimics, Function Block
Diagrams etc.
The configuration Form for any database item that is not configured graphically,
for example, database points, channels, outstations etc.
ii. Select the item and keep the left-hand mouse button pressed down. Proceed to
step 3.
Or:
i.
Use Windows Explorer to locate the file that is the 'target' display.
ii. Size the Windows Explorer window and the ViewX window so that you can drag the
file icon from the Windows Explorer window onto the Mimic.
iii. Select the icon for the file. Keep the left-hand mouse button pressed down.
Proceed to step 3.
Or:
i.
Use a web browser such as Internet Explorer to display the web page that is to be
the 'target' display.
ii. Size the browser window and the ViewX window so that you can drag the file icon
from the Address field on the browser onto the Mimic.
iii. Select the icon for the web page (in the browser's Address field). Keep the left-hand
mouse button pressed down. Proceed to step 3.
PD-6016 07/2012
301
Chapter 17 - Hyperlinks
4.
Drag the item onto the Mimic's design area, then release the left-hand mouse button.
The selected Mimic object is configured to have a hyperlink to the display for the item
you selected in step 3.
You can alter the settings for the object as required (see Editing Objects on a Mimic, on
page 149). You can also edit the animations that are in place for the hyperlink (see
Animations, on page 345). If you want to change the comment for the hyperlink or set the
'target' display to be shown in a new window, use the Pick Action Configuration Wizard
(see Using the Pick Action Wizard to Create a Hyperlink, on page 303).
When the Mimic is displayed in Run mode, users will be able to select the hyperlink text
boxwhen it is selected, the relevant 'target' display will be shown.
302
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Right-click on the Mimic object that is to act as the 'trigger' for the hyperlink. If the
Mimic does not yet contain the object that you want to use as the 'trigger', you will
need to create the object (see Adding Objects to a Mimic, on page 111) and then
right-click on it.
Select the Pick Action Wizard option to run the Pick Action Wizard.
4.
On the first 'page' of the Wizard, select the Hyperlink option, then select the Next
button to proceed to the second 'page'.
PD-6016 07/2012
303
Chapter 17 - Hyperlinks
5.
On the second 'page' use the URL field to specify the 'target' display (the display that
will be shown when the 'trigger' Mimic object is selected in Run mode.
To link to a web page:
i.
Enter the address of the web page manually in the URL field. You need to enter the
full address, including http://
ii. Use the Open in ViewX check box to define whether the web page is shown in an
external web browser or is shown in ViewX.
Clear the check box if you want the web page to be displayed in an external
web browser.
Enter the address of the target item in the URL field manually.
Or:
Select the URL fields browse button and choose Link to Object. Next, use the
browse window to select the target item. The address of the item is added to the
URL field automatically.
If you select a database item that has a graphical display, the hyperlink will display
the graphical interface; if you select a database item that does not have a graphical
display, the hyperlink will display the Form for the item.
To link to the Form of an item that has a graphical display, choose the item and then
adjust its URL entry. You will need to remove the class component of the URL entry.
For example, a hyperlink to the graphical display of a Mimic named Change
Password could be:
SCX:////CMimic/..Change Password
To change the hyperlink so that the Mimic's Form is the target, you need to remove
the CMimic part of the entry:
SCX://///..Change Password
The class name is usually C<type of database item>, for example, CGraph, CMimic,
CXYPlot, etc. If required, you can use the Database Schema to determine the class
of a database item (see Working with the Database Schema, on page 19 in the
ClearSCADA Guide to the Database).
If you select the Link to Object option, the Relative check box becomes available.
Proceed to step 6.
Enter the address of the target file in the URL field manually.
Or:
304
Select the URL fields browse button and choose Link to File. Next, use the browse
window to locate the target file and then select Open. to confirm your choice. The
address of the file is added to the URL field automatically. Proceed to step 7.
PD-6016 07/2012
Chapter 17 - Hyperlinks
6.
Use the Relative check box to define whether the hyperlink uses a relative or absolute
reference. If you select the check box, the hyperlink uses a relative reference. This
means that as long as the hierarchy between the Mimic that contains the 'trigger' object
and the 'target' database item remains the same, the hyperlink will work. This means
that the Mimic and the 'target' database item can be movedas long as the hierarchy
between the Mimic and the 'target' database item remain the same, the hyperlink will
work.
If you clear the Relative check box, the hyperlink will use an absolute reference. This
means that the hyperlink will only work if the Mimic that contains the 'trigger' object and
the 'target' database item remain in exactly the same location. If the Mimic is moved or
the 'target' database item is moved, the hyperlink will be broken.
NOTE: The Relative option is only applicable to links to items in the ClearSCADA
database.
7.
Use the Mode combo box and Inset Position settings to define the type, size and
location of the 'target' display:
NavigateThe 'target' display will be shown in place of the 'source' Mimic (the
Mimic that contains the 'trigger' object). The display window will remain at its
current size. Proceed to step 8.
Navigate & ResizeThe 'target' display will be shown in place of the 'source'
Mimic (the Mimic that contains the 'trigger' object). The display window will be
resized according to the dimensions you specify in the width and height
spin-boxes.
Use the Height spin-box to define the vertical dimensions of the resized display
window, and then use the Width spin-box to define the horizontal dimensions.
When you have defined the dimensions, proceed to step 8.
Open in New WindowThe 'target' display will be shown in a new window that
overlays the window that contains the 'source' Mimic. The new window is sized
automatically by the operating system. Proceed to step 8.
PD-6016 07/2012
305
Chapter 17 - Hyperlinks
NOTE: Setting the Width or Height to 0% instructs the inset window to use the
maintain the aspect ratio of the 'source' Mimic. For example, if you set the Height to
0% and the Width to 50%, the 'target' Mimic will retain the proportions of the
'source' Mimic (the 'target' Mimic will be half as wide and the height will be
calculated so that the 'target' Mimic maintains the same proportions as the 'source'
Mimic).
8.
Select the Next button to proceed to the third 'page' of the Pick Action Configuration
Wizard.
9.
In the Pick Action Comment field, enter the text that will be displayed in the comment
for the 'trigger' object. When a user positions the cursor over the 'trigger' object, a
comment will be displayed in the status bar showing the text that you enter. For this
reason, we recommend that you enter a brief description of the 'target' display or some
indication as to which display the hyperlink targets.
NOTE: You can leave the description field blank if you wish. If you do not enter a
description, a default description will be used instead.
10. Select the Next button to proceed to the final 'page' of the Pick Action Configuration
Wizard.
11. If you are satisfied with the hyperlink configuration settings you have defined, select the
Finish button to close the Pick Action Wizard and put the hyperlink configuration into
effect.
306
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Right-click on the Mimic object that you want to animate (the object that is to act as the
'trigger'). If the Mimic does not yet contain the object that you want to use as the
'trigger', you will need to create the object (see Adding Objects to a Mimic, on page
111) and then right-click on it.
Select the Animations option to display the Animations window. You can also display
the Animations window by double-clicking on an object and then selecting the
Animations button on the General tab.
4.
Select the PickParam property (this is the Mimic object property that determines which
display the hyperlink 'targets').
PD-6016 07/2012
307
Chapter 17 - Hyperlinks
5.
6.
In the Expression field, enter the expression that will be used to access the target
display.
For ViewX displays on the same system, you need to use the format:
'SCX:////<Class>/<Path>'
For example, 'SCX:////CMimic/Overview Mimic'. Do not enter the angle brackets <
>.
NOTE: If the Relative check box is selected, you can use relative links to the 'target'
display (see Relative References, on page 45 in the ClearSCADA Guide to
Expressions).
For ViewX displays on a different system, you need to use the format:
'SCX:///<System Name>/<Class>/<Path>'
For example, 'SCX:///Main/CMimic/Overview Mimic'. Do not enter the angle
brackets < >, and take care to use an absolute reference as links between systems
can only use absolute references (see Absolute References, on page 44 in the
ClearSCADA Guide to Expressions).
NOTE: If you want to link to the Form of an item that has a graphical display, such as a
Mimic, you have to edit the PickParam value.You will need to remove the class part of
the address is removed. For more information on classes, see Class Information, on
page 23 in the ClearSCADA Guide to the Database.
7.
308
Select the OK button to confirm the expression and close the Expression window.
PD-6016 07/2012
Chapter 17 - Hyperlinks
8.
Select the PickType property on the Animations window. The PickType property defines
the type of pick action that is to be associated with the selected object. As you are
creating a hyperlink, you need to set this property to a specific type of Hyperlink.
9.
10. Enter the number that corresponds to the type of hyperlink you want to use:
3The target display is shown in the Mimic window in place of the Mimic.
4The target display is shown in a new inset window. The inset window will use the
default size and position settings. You cannot use Animations to change the
position and size of the window (to do this, you need to use the Pick Action Wizard).
NOTE: If the target display is a web page, the web page will be displayed in a browser,
such as Internet Explorer. It is possible to configure a hyperlink that opens a web page
in a ViewX document window, but this can only be achieved by using the Pick Action
Wizard (see Using the Pick Action Wizard to Create a Hyperlink, on page 303).
11. Select the OK button to close the Expression window and confirm your selection.
12. Select the PickComment animation property. This property represents the information
that is shown in the Status bar when the cursor is positioned over the 'trigger' object.
13. Select the Edit button to display the Expression window.
14. In the Expression field, enter the required text for the Status bar description. The text
has to be enclosed in single quotes as it is a string value.
15. Select the OK button to close the Expression window and confirm your entry.
16. Close the Animations window.
17. Save the Mimic.
When you display the Mimic in Run Mode, positioning the cursor over the 'trigger'
object will cause the defined text to be displayed in the Status bar and the ToolTip
description in the ToolTip comment. When you select the 'trigger' object, the 'target'
display will be shown (in a new window, inset window, or in place of the Mimic,
depending on which number you entered as the expression for the PickType property).
NOTE: Steps 9-17 inclusive are optional.
PD-6016 07/2012
309
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
In the Database Bar, select the 'target' Mimic's icon, then drag it onto the Mimic
display.
When you release the mouse button, a context sensitive menu is displayed.
ii. Select the Hyperlink option to add a text box to the Mimic.
Right-click on the Mimic object that is to act as the 'trigger' for the hyperlink. If the
Mimic does not yet contain the object that is to act as the 'trigger', you should add
the object then right-click on it (see Adding Objects to a Mimic, on page 111).
When you right-click on the Mimic object, a context sensitive menu is displayed.
ii.
310
Select the Pick Action Wizard option to run the Pick Action Wizard.
PD-6016 07/2012
Chapter 17 - Hyperlinks
iii. Use the various 'pages' of the Pick Action Wizard to set the type of pick action to
Hyperlink, define the URL of the 'target' Mimic, define where the 'target' Mimic will
be displayed, and define a ToolTip for the 'trigger' object.
For more information, see Using the Pick Action Wizard to Create a Hyperlink, on page
303.
Animations:
i.
Right-click on the Mimic object that is to act as the 'trigger' for the hyperlink. If the
Mimic does not yet contain the object that is to act as the 'trigger', you should add
the object then right-click on it (see Adding Objects to a Mimic, on page 111). When
PickCommentEnter a string that will be shown in the Status Bar when the
cursor is positioned over the 'trigger' object. This is optional.
ToolTipEnter a string that will be shown in the ToolTip comment when the
cursor is positioned over the 'trigger' object. This is optional.
iv. Select the OK button to confirm the animations and close the Animations window.
For more information, see Using Animations to Create a Hyperlink, on page 307.
3.
The hyperlink will be available when the Mimic is displayed in Run Mode. When the
'trigger' object is selected, the 'target' Mimic will be shown in the relevant window
(defined by the type of hyperlink).
The procedure above explains how to create a hyperlink that displays the 'target' Mimic at
its default size. You can link to a Mimic shown at its default size or to any of the Mimic's
configured views. For more information, refer to Creating a Hyperlink to a Mimic Shown at
a Specific Level of Magnification (see page 312).
Further Information
To create a hyperlink to the configuration Form for a Mimic, see Creating a Hyperlink to a
Form, on page 315.
To create a hyperlink to a Mimic that is displayed in another ViewX session (i.e. on another
head), see Creating a Hyperlink to a ViewX Document on Another ViewX Head, on page
331.
PD-6016 07/2012
311
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
In the Database Bar, select the 'target' Mimic's icon, then drag it onto the Mimic
display.
When you release the mouse button, a context sensitive menu is displayed.
ii. Select the Hyperlink option to add a text box to the Mimic.
On the Animations window, select the PickParam property, then select the Edit
button to display the Expression window.
312
PD-6016 07/2012
Chapter 17 - Hyperlinks
Right-click on the Mimic object that is to act as the 'trigger' for the hyperlink. If the
Mimic does not yet contain the object that is to act as the 'trigger', you should add
the object then right-click on it (see Adding Objects to a Mimic, on page 111).
When you right-click on the Mimic object, a context sensitive menu is displayed.
ii.
Select the Pick Action Wizard option to run the Pick Action Wizard.
iii. Use the first 'page' of the Pick Action Wizard to set the type of pick action to
Hyperlink, then select the Next button.
iv. Define the URL of the 'target' Mimic (for more information, see Using the Pick
Action Wizard to Create a Hyperlink, on page 303).
v.
When you have defined the URL, add the following to the end of the URL address:
#View="<ViewName>"
Where <ViewName> is the name of the Mimic View to which you want to link. Do
not enter the angle brackets < >.
For example, if you want to link to the 'Pump62' View on a Mimic named 'PipeLine
Overview' you would change the URL from:
SCX:////CMimic/.Pipeline Overview
to:
SCX:////CMimic/.Pipeline Overview#View="Pump62"
vi. Define the Mode and Inset Position as required (for more information, see Using the
Pick Action Wizard to Create a Hyperlink, on page 303).
vii. Select the Next button.
viii. Define the ToolTip comment as required (for more information, see Using the Pick
Action Wizard to Create a Hyperlink, on page 303).
ix. Select the Next button.
x. Select the Finish button to confirm the configuration and close the Pick Action
Wizard. Proceed to step 3.
PD-6016 07/2012
313
Chapter 17 - Hyperlinks
Animations:
i.
Right-click on the Mimic object that is to act as the 'trigger' for the hyperlink. If the
Mimic does not yet contain the object that is to act as the 'trigger', you should add
the object then right-click on it (see Adding Objects to a Mimic, on page 111). When
Select the OK button to confirm your entry and close the Expression window.
vi. Select the Close button to confirm your alterations and close the Animations
window. Proceed to step 3.
3.
The hyperlink will be available when the Mimic is displayed in Run Mode. When the
'trigger' object is selected, the 'target' Mimic View will be shown in the relevant window
(defined by the type of hyperlink).
314
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Either:
Use the drag and drop functionality to drag the 'target' database item from the
Database Bar onto the Mimic. This will create a text box that is automatically
configured to hyperlink to the database item's Form (unless the item has a graphical
display, in which case you will need to use the Pick Action Wizard or Animations
feature to alter the 'target' address - see the Note below).
For more information, see Using Drag and Drop to Create a Hyperlink, on page 299.
Use the Pick Action Wizard to create a Hyperlink pick action that has its URL set to
the database item associated with the Form.
For more information, see Using the Pick Action Wizard to Create a Hyperlink, on
page 303.
Use the Animations feature to set the value of the PickParam to the address of the
database item associated with the Form.
For more information, see Using Animations to Create a Hyperlink, on page 307.
NOTE: To hyperlink to the Form of an item that has a graphical display, such as a Mimic
or Trend, you have to remove the class part of the address from the URL on the Pick
Action Wizard or the PickParam value on the Animations window.
3.
PD-6016 07/2012
315
Chapter 17 - Hyperlinks
Use the Queries Bar to display the List to which you want to link (for more information,
see the ClearSCADA Guide to Lists).
2.
Apply any filtering and sorting that is required (for more information, see the
ClearSCADA Guide to Lists)
3.
Select the Edit menu, then select the Copy Shortcut option. This copes a shortcut to
the List to your PC's clipboard storage area.
4.
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
5.
Right-click on the Mimic and select the Paste option from the context sensitive menu.
Alternatively, select the Edit menu and then select the Paste option.
Right-click on the text box and select the Pick Action Wizard option from the
context sensitive menu.
316
PD-6016 07/2012
Chapter 17 - Hyperlinks
iii. Highlight the entry in the URL field. You need to highlight the entire entry. (The URL
entry contains a link to the List in the correct format and also includes the SQL
Query that defines the criteria for the information that is shown on the List).
The entry in the URL field uses the following syntax:
SCX:///<system>/List/Title="<title>"&InitialSQL="<SQL>"
Where:
<system> is the name of your system (the angle brackets are not included). It
can be omitted when relative links are being used.
<title> is the title of the List (the angle brackets are not included). The title is
optional., but we recommend that you define a suitable title otherwise the
default title of 'Query' will be used.
If the SQL contains quotes ("), you need to insert additional quotes so that the
sequence uses two quotes (""), for example, InitialSQL="SELECT ""FullName""
FROM CDBObject".
iv. Right-click to display a context sensitive menu, then select the Copy option. This
copies the URL to your computer's clipboard storage area.
v.
vi. Right-click on the Mimic object that is to act as the 'trigger' for the hyperlink. If the
Mimic does not yet contain the object that is to act as the 'trigger', you should add
the object then right-click on it (see Adding Objects to a Mimic, on page 111). When
The address for the List that you displayed in step 2 is added to the URL field. It
contains the SQL Query that specifies what information is displayed on the List.
x. Define the Mode and Inset Position as required (for more information, see Using the
Pick Action Wizard to Create a Hyperlink, on page 303).
xi. Select the Next button.
xii. Define the ToolTip comment as required (for more information, see Using the Pick
Action Wizard to Create a Hyperlink, on page 303).
xiii. Select the Next button.
xiv. Select the Finish button to confirm the configuration and close the Pick Action
Wizard. Proceed to step 6.
6.
PD-6016 07/2012
317
Chapter 17 - Hyperlinks
When the Mimic is displayed in Run mode, the text box or other type of Mimic object that
you configured will act as a 'trigger' for the hyperlinkwhen it is selected, the List is
displayed.
...hyperlink to a List.
NOTE: Alternatively, you can use the Animations window to configure a hyperlink to a List. To
do this, you would need to paste the URL from the text box that was created in step 5 into
the expression for the PickParam animation property. You would also need to edit the
expression so that it formed a string of the correct format. Using the Pick Action Wizard is
the recommended method for creating hyperlinks to Lists as it is quicker and easier to
configure.
318
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Right-click on the Mimic object that you want to animate (the object that is to act as the
'trigger'). If the Mimic does not yet contain the object that you wish to use as the
'trigger', you will need to create the object (see Adding Objects to a Mimic, on page
111) and then right-click on it.
Either:
Select the Pick Action Wizard option to run the Pick Action Wizard.
Or:
4.
Use the Pick Action Wizard or Animations window to configure the hyperlink to the
Alarms List:
Pick Action Wizard:
Set the pick action to work as a Hyperlink, then on the second 'page' enter the syntax
for the Alarms List in the URL field. When you have entered the URL, proceed through
the steps of the Pick Action Wizard in the same way as for other types of hyperlink (see
Using the Pick Action Wizard to Create a Hyperlink, on page 303).
The syntax you need to use is:
SCX:///<system>/AlarmList/
<filter1>="<value1>"&<filter2>="<value2>"
Where:
<system> is the name of your system. This can be omitted for relative links as
required. Do not enter the angle brackets <>. If you want to include multiple
systems, use the * character instead of the system name.
If you use the * character to include multiple systems, you have to qualify each
option with the system name as each system has its own filter. For example,
System1.Area="Group 1"&System2.Area="Group 2".
PD-6016 07/2012
<filter1> is the name of the first filter condition that you want to apply. You can use
any of the following filter conditions: AlarmState, AOI, Assigned, Categories,
MaxSeverity, MinSeverity, and Source. For more information on these conditions,
see Alarm Filter String Syntax, on page 77 in the ClearSCADA Guide to Alarms.
<value1>Represents the criteria that has to be met for the first filter condition.
The value has to be enclosed in double quotation marks " ". Do not enter the angle
brackets < >.
<filter2>Represents the second filter. Do not enter the angle brackets < >.
319
Chapter 17 - Hyperlinks
<value2>Represents the value for the second filter. The value has to be enclosed
in double quotation marks " ". Do not enter the angle brackets < >.
NOTE: You can add extra filters and values by using the ampersand character &. For
example, <filter 3>="<value3>"&<filter4>="<value4>" and so on.
Example:
The following entry filters the Alarms List so that it only shows alarms for a point named
'AI1' that is stored in a Group named 'Main Site' on a System named 'CentralPipeline'.
The Alarms List only includes alarms that are within the severity range 200-800 (the
meaning of these values is defined in the server configuration - see Alarm and Event
Severities, on page 305 in the ClearSCADA Guide to Server Administration).
SCX:///CentralPipeline/AlarmList/Area="Main
Site"&Source="AI1"&MinSeverity="200"&MaxSeverity="800"
Animations:
i.
On the Animations window, select the PickType property, then select the Edit button
to display the Expression window.
ii. Enter the number for the required type of hyperlink (3, 4, 10, or 11). For more
information, see Using Animations to Create a Hyperlink, on page 307.
iii. Select the OK button to confirm your entry and close the Expression window.
iv. On the Animations window, select the PickParam property, then select the Edit
button to display the Expression window.
v.
On the Expression window, define the filter for the Alarms List using the following
syntax:
'SCX:///<system>/AlarmList/
<filter1>="<value1>"&<filter2>="<value2>"'
The syntax for the PickParam animation is exactly the same as the syntax required
when using the Pick Action Wizard (see the description earlier in this section),
except that the entry has to be enclosed in single quotation marks ' ' as it is an
expression.
vi. Select the OK button to confirm your entry and close the Expression window.
vii. Close the Animations window.
5.
When the Mimic is displayed in Run mode, selecting the 'trigger' object will activate the
hyperlink and display the Alarms List. The Alarms List will use the filter conditions that are
defined in the URL field (on the Pick Action Wizard) or PickParam animation for the
'trigger' object.
Further Information
Default Alarm Filters: see Specify a Default Alarm Filter, on page 75 in the ClearSCADA
Guide to Alarms.
320
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Either:
Use the drag and drop functionality to drag a Pre-Configured Trend or X-Y Plot from
the Database bar onto the Mimic, then select the Hyperlink option (see Using Drag
and Drop to Create a Hyperlink, on page 299).
Or:
Use the Pick Action Wizard to create a hyperlink to a Pre-Configured Trend or X-Y
Plot (set the pick action to Hyperlink and use the Link to Object option to select the
required Trend or X-Y Plot). For more information, see Using the Pick Action Wizard
to Create a Hyperlink, on page 303.
Or:
3.
PD-6016 07/2012
Use the Animations feature to create a hyperlink (set the PickParam value to the
address of a Pre-Configured Trend or X-Y Plot and set the PickType to 3, 4, 10, or
11 depending on the type of hyperlink you require). For more information, see Using
Animations to Create a Hyperlink, on page 307.
321
Chapter 17 - Hyperlinks
Use the point or master station accumulators Display Current Trend or Display Historic
Trend pick action to display the required ad hoc Trend (see Display an Ad Hoc Trend in
Run Mode, on page 103 in the ClearSCADA Guide to Trends).
2.
3.
4.
Display the Mimic that is to contain the hyperlink to the ad hoc Trend. You need to
display the Mimic in Design mode (see Displaying a Mimic, on page 17).
5.
Either:
6.
Use the Pick Action Wizard to create a hyperlink to the ad hoc Trend (set the pick
action to Hyperlink and paste the contents of the clipboard into the URL field). For
more information, see Using the Pick Action Wizard to Create a Hyperlink, on page
303.
With a custom ad hoc Trend, you produce the Trends definition using ClearSCADAs
proprietary specification language, TrendSpec (see Using TrendSpec to Produce Ad Hoc
Trends, on page 143 in the ClearSCADA Guide to Trends).
Display the Mimic that is to contain the hyperlink to the ad hoc Trend. You need to
display the Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
Either:
i.
Use the Pick Action Wizard to create a hyperlink to the ad hoc Trend (set the pick
action to Hyperlink and paste the TrendSpec definition into the URL field). You need
to include the SCX:////Trend/ prefix before the start of the definition in the URL field.
For an example that demonstrates the type of content that might be included in an
URL field, see Use TrendSpec to Define an Ad Hoc Trends Colors, on page 186 in
the ClearSCADA Guide to Trends.
or:
i.
Include the TrendSpec definition as a script subroutine on a Mimic that has the
Script feature enabled.
ii. Use the Pick Action Wizard to create a hyperlink to run the script (set the pick action
to Script and specify the name of the Script subroutine in the Function field).
For information on writing Mimic scripts, see Mimic Scripts, on page 17 in the
ClearSCADA Guide to Scripting. For examples of TrendSpec definitions, including
definitions used in Mimic scripts, see Example Configuration, on page 185 in the
ClearSCADA Guide to Trends.
3.
322
PD-6016 07/2012
Chapter 17 - Hyperlinks
When the Mimic is displayed in Run Mode, selecting the 'trigger' object will cause the
'target' Trend or X-Y Plot to be displayed in a new window or in place of the currently
displayed Mimic (depending on the type of hyperlink you have configured).
NOTE: If you want to link to the Form of a Pre-Configured Trend or X-Y Plot instead of the
graphical display, see Creating a Hyperlink to a Form, on page 315.
PD-6016 07/2012
323
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Either:
Use the drag and drop functionality to drag the Logic program from the Database
bar onto the Mimic, then select the Hyperlink option (see Using Drag and Drop to
Create a Hyperlink, on page 299).
Or:
Use the Pick Action Wizard to create a hyperlink to the Logic program (set the pick
action to Hyperlink and use the Link to Object option to select the required Logic
program). For more information, see Using the Pick Action Wizard to Create a
Hyperlink, on page 303.
Or:
3.
Use the Animations feature to create a hyperlink (set the PickParam value to the
address of the Logic program and set the PickType to 3, 4, 10, or 11 depending on
the type of hyperlink you require). For more information, see Using Animations to
Create a Hyperlink, on page 307.
When the Mimic is displayed in Run Mode, selecting the 'trigger' object will cause the
'target' Logic program to be displayed in a new window or in place of the currently
displayed Mimic (depending on the type of hyperlink you have configured).
NOTE: If you want to link to the Form of a Logic program instead of the graphical display, see
Creating a Hyperlink to a Form, on page 315.
324
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Either:
Use the drag and drop functionality to drag the Schedule item from the Database
bar onto the Mimic, then select the Hyperlink option (see Using Drag and Drop to
Create a Hyperlink, on page 299).
Or:
Use the Pick Action Wizard to create a hyperlink to the Schedule (set the pick action
to Hyperlink and use the Link to Object option to select the required Schedule). For
more information, see Using the Pick Action Wizard to Create a Hyperlink, on page
303.
Or:
3.
Use the Animations feature to create a hyperlink (set the PickParam value to the
address of the Schedule and set the PickType to 3, 4, 10, or 11 depending on the
type of hyperlink you require). For more information, see Using Animations to Create
a Hyperlink, on page 307.
When the Mimic is displayed in Run Mode, selecting the 'trigger' object will cause the
'target' Schedule to be displayed in a new window or in place of the currently displayed
Mimic (depending on the type of hyperlink you have configured).
...hyperlink to a schedule.
NOTE: If you want to link to the Form of a Schedule instead of the graphical display, see
Creating a Hyperlink to a Form, on page 315.
PD-6016 07/2012
325
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Use the Pick Action Wizard to create a hyperlink to the file (set the pick action to
Hyperlink and use the Link to File option to select the required file). For more
information, see Using the Pick Action Wizard to Create a Hyperlink, on page 303.
3.
When the Mimic is displayed in Run Mode, selecting the 'trigger' object will cause the
'target' file to be displayed. The 'target' file will run in a new window (the application
associated with the file will run, for example, for a Word document, Microsoft Word will
run and display the 'target' file).
326
PD-6016 07/2012
Chapter 17 - Hyperlinks
Using the Pick Action Wizard to create a hyperlink to a web page (see Link to a Web
Page by using the Pick Action Wizard, on page 327).
Dragging the address icon in a web browser onto a Mimic (see Using Drag and Drop to
Create a Hyperlink, on page 299).
For information on how to use animations to configure a hyperlink to a web page, see
Using Animations to Create a Hyperlink, on page 307.
URLThe full address of the web page that is to be the target display
Open in ViewXChoose whether the web page will be displayed in a ViewX window or
in an external web browser (if the check box is selected, the web page is displayed in
ViewX).
ModeUse to define the window settings (only applies if the web page is to be
displayed in ViewX).
For more information, see Using the Pick Action Wizard to Create a Hyperlink, on page
303.
Further Information
Link to a Web Page using Drag and Drop (see page 328).
Using Animations to Create a Hyperlink (see page 307).
PD-6016 07/2012
327
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
In a web browser application, such as Microsoft Internet Explorer, display the web page
that will be the target of the hyperlink.
3.
Drag the icon next to the Address of the web page from the browser window onto the
Mimic. This creates a text box that is configured to act as a hyperlink to the web page.
You can edit the text box as required (see Editing a Text Box, on page 201).
4.
When you display the Mimic in Run Mode, selecting the text box will cause the 'target'
web page to be displayed. The 'target' web page will run in a new browser window by
default (although you can animate the text box so that it opens in place of the Mimic (see
Using the Pick Action Wizard to Create a Hyperlink, on page 303)).
Further Information
Link to a Web Page by using the Pick Action Wizard (see page 327).
Using Animations to Create a Hyperlink (see page 307).
328
PD-6016 07/2012
Chapter 17 - Hyperlinks
Display the Mimic that is to contain the new hyperlink. You need to display the Mimic in
Design mode (see Displaying a Mimic, on page 17).
2.
Use the Pick Action Wizard to create a hyperlink to the Crystal Report:
i.
Set the pick action to Hyperlink then select the Next button.
ii. In the URL field, select the browse button then select the Link to Object option.
iii. Use the browser window to select the required Crystal Report item.
iv. Adjust the entry in the URL field as follows:
For the latest report, add the following to the end of the URL entry:
?latest
For a report generated on a specific date, add the following to the end of the URL
entry:
?file=<date> <time>
Where:
<date> is the date on which the report was generated and has to use the following
format:
dd/MM/yyyy
<time> is the time at which the report was generated. The <time> has to be in
Coordinated Universal Time (UTC) and has to use the following syntax:
HH/mm/ss.SSS
Do not enter the angle brackets < >. You need to use the forward slash character
instead of the colon character when separating the time elements.
NOTE: The time and date hyperlink can only be used if the Crystal Report has
Historic enabled in its configuration. If Historic is not enabled, the Mimic can only
contain a hyperlink to the latest report.
PD-6016 07/2012
329
Chapter 17 - Hyperlinks
Example:
If the Crystal Report item was named 'Electricity Usage' and the latest report was
required, the URL would be set to:
SCX:////CCrystalReport/Electricity Usage?latest
This would create a hyperlink to the most recently generated report for the
'Electricity Usage' Crystal Report.
If the user required a report that was generated at 10:16:35 on November 1st 2006,
the URL would be set to:
SCX:////CCrystalReport/Electricity Usage?file=01/11/2006 10/16/35
v.
3.
Proceed through the remaining steps of the Pick Action Wizard (see Using the Pick
Action Wizard to Create a Hyperlink, on page 303).
NOTE: You can also configure a hyperlink to a Crystal Report by using the animations feature
(see Using Animations to Create a Hyperlink, on page 307). To do this, simply enter the URL
as described in step iv as the value for the 'trigger' object's PickParam property and set the
PickType to 3, 4, 10, or 11 as required.
Further Information
Time Zone Settings: see Time Zone Support in ClearSCADA, on page 189 in the
ClearSCADA Guide to Core Configuration.
330
PD-6016 07/2012
Chapter 17 - Hyperlinks
You can use a hyperlink to display any of the following ViewX displays on another head:
Mimics
Lists
Forms
Alarms Lists
Trends
X-Y Plots
Logic Programs
Schedules
Reports
Time Profiles
Script Libraries
Calendars
Value Maps
Data Grids
Data Tables
Crystal Reports.
NOTE: Some Drivers also have driver-specific documents that can be used as target
displays for hyperlinks.
PD-6016 07/2012
331
Chapter 17 - Hyperlinks
To create a hyperlink that causes a display to be shown on another head, you need to
configure a Script pick action that uses Execute Code Fragment mode. As part of the
configuration for the pick action, you will need to define code that instructs ViewX to
display a specified display on a specified head. The following procedure explains how to
create such a hyperlink:
1.
Log on to ViewX via a User account that has the Configure permission for the Mimic
that is to contain the hyperlink. We will refer to this Mimic as the Source Mimic.
NOTE: You can use a single head client to create a hyperlink to a display on another
head, but to test your hyperlink works as expected, you will need to use a multi-head
client.
2.
Display the Mimic in Design Mode (see Displaying a Mimic, on page 17)
3.
Either add a new Mimic object and select it or select an existing Mimic object. The
object you select will contain the hyperlink (when you select it in Run Mode, it will cause
the target display to appear on another head).
4.
Right-click on the selected Mimic object, then select the Pick Action Wizard option to
display the Pick Action Wizard.
5.
On the first page of the Pick Action Wizard, select Script, then select Next.
6.
On the second page of the Pick Action Wizard, set the Mode to Execute Code
Fragment, then enter the following code in the Code field:
App.OpenWindowOnHead n,"<Absolute reference to target display>"
Where:
n is the number of the head (monitor) on which you want the target display to be
shown.
For more information on finding out the absolute reference for a display, Locating the
Absolute Address of a Display (see page 342).
7.
Use the Permission setting to define the security permission required to select the pick
action that you are configuring.
8.
9.
10. Select the Next button, then select the Finish button.
332
PD-6016 07/2012
Chapter 17 - Hyperlinks
When you display the Mimic in Run Mode, you will be able to select the Mimic object to
trigger the pick action. If configured correctly, this will cause the target display to be
shown in another instance of ViewX on the specified head. If the specified head is not
already displaying an instance of ViewX, a new instance of ViewX will run automatically.
NOTE: The client heads are displayed in the last known position of the heads, for example, if
head 2 was last displayed shown at 50% size in the top right of a second monitor, that is
where any target displays for head 2 will be shown. If ViewX has not been displayed on the
heads before, ViewX will attempt to calculate the position of the ViewX instances by using
the head information in the operating system. If the positioning is incorrect, you can correct
it by moving the displays to the required position and then closing them. The next time they
are displayed, they will be shown in the position you selected.
Example:
A ViewX client is set up to have 2 heads, each running a ViewX session. In Windows, the
heads are recognized as Head 1 and Head 2 (for this example, we will assume Head 1 is the
left-hand side monitor).
A user logs on and displays a Mimic named ControlA1 on Head 1. The user configures the
ControlA1 Mimic so that is has a hyperlink that, when selected in Run Mode, will cause a
Mimic named Sector8C to be displayed on Head 2. The Sector8C Mimic is stored on a
system called MAIN and in a Group named Power Switches.
To configure the hyperlink, the user selects a suitable object on the ControlA1 Mimic and
displays the Pick Action Wizard for that object. They then configure a Script pick action that
is set to Execute Partial Code. They define the code as:
App.OpenWindowOnHead 2,"SCX:///MAIN/CMimic/Power
Switches.Sector8C"
PD-6016 07/2012
333
Chapter 17 - Hyperlinks
334
PD-6016 07/2012
Chapter 17 - Hyperlinks
<Parameter Name> matches the name of a parameter that you have created for the
Mimic. The value of the named parameter defines the location of the 'target' display.
Configure a group parameter (select the Edit menu, then Parameters, then Add, then
define the name of the parameter and select the Group check box). The name of the
group parameter will be an option that you can use to select the required expression so
it is better to define a suitable name.
2.
3.
Double click on the symbol object to display its Polyline Properties window.
4.
On the General tab, select the Animations button to display the Animations window.
5.
6.
7.
8.
Select the option that is named the same as the group parameter you created in step 1.
10. Select the OK button to confirm the expression and close the Expression window.
11. Select the PickType property.
12. Select the Edit button to display the Expression window.
13. Enter the number for the required PickType. For a hyperlink, the number is 3, 4, 10, or
11 depending on the type of hyperlink you require. The types of hyperlink are explained
in Using Animations to Create a Hyperlink (see page 307).
PD-6016 07/2012
335
Chapter 17 - Hyperlinks
14. Select the OK button to confirm the expression and close the Expression window.
15. Close the Animations window.
The symbol object is now configured to act as a hyperlink. It will link to any display that is
associated with the named parameter (see Animating Mimic Parameters on an Embedded
Mimic, on page 469).
336
PD-6016 07/2012
Chapter 17 - Hyperlinks
Where:
<System> is the name of the system that contains the target Mimic. The system part of
the entry can be left blank if the target Mimic is on the same system as the Mimic that
contains the hyperlink.
<Class> is the database class that stores the target Mimic. Mimics are stored in the
CMimic class, so the class will be CMimic for hyperlinks to other Mimics.
<Location of Target Mimic> is the location of the target Mimic in the database structure.
This is the full address of the Mimic and includes Groups etc. However, you can also set
the location to use a relative reference by altering the location manually: replace each
level of Group with a period. For more information, see Relative References in the
ClearSCADA Guide to Expressions.
# indicates that the remainder of the hypertext string defines parameter settings. The part
of the string that defines the parameter settings is called a fragment and is sometimes
referred to as the location. To avoid confusion with the location of the target Mimic, we will
refer to the second part of the string as the fragment.
<Mimic Parameter Name> is the name of the parameter on the Target Mimic that is to
have a value defined for it by the hyperlink. When the hyperlink is selected, the target
Mimic will be displayed and a specific value will be defined for the selected parameter on
the target Mimic. The name of the Mimic parameter you define in the link has to match the
name of the required parameter on the target Mimic exactly.
= indicates that the remainder of the hypertext string defines the value for the parameter
setting.
PD-6016 07/2012
337
Chapter 17 - Hyperlinks
"<Mimic Parameter Value>" defines the value that is to be used as the value for the
selected Mimic parameter. The value has to be enclosed in double quotes as the value is
a string. If more than one parameter is required, use an ampersand & after each
parameter, with each parameter in double quotation marks. For example, #Group=
"PLCs" & PointName= "Analog Point 1" would set a value of PLCs for the Group
parameter and a value of Analog Point 1 for the PointName parameter.
Do not include the angle brackets < > for any part of the hyperlink definition.
Example:
In this example, we have 2 Mimics that are both stored in a Group named 'Outstations'. One
of the Mimics is named 'Overview' and the other Mimic is named 'Outstation Alarms'.
The 'Outstations' Group also contains 2 sub-Groups, one named 'Outstation 1 Points' and
the other named 'Outstation 2 Points'. Both of these sub-Groups contain 2 points. Each
point has one uncleared unacknowledged alarm raised.
338
PD-6016 07/2012
Chapter 17 - Hyperlinks
The 'Outstation Alarms' Mimic is configured to have a title text box and an embedded
Alarms List:
The Following Parameters are configured for the 'Outstation Alarms' Mimic (via the
Edit>Parameters menu option):
Parent: None
Hint: None
Parent: None
Hint: None
The Title parameter is associated with the title text box on the Mimic by dragging the Title
parameter from the Parameters window onto the text box, then selecting the Text option.
This automatically sets the text box to use any value that is defined for the Title parameter as
the text to be shown in the text box.
The Group parameter is associated with the embedded Alarms List by configuring an
animation for the Alarms List's Filter property. The Filter property is animated with the
following expression:
'Source="' + "Parameter:Group" + '.*"'
The + is preceded by a double quote and then a single quote. The * is also followed by a
double quote and then a single quote. The * is a wildcard character that represents any
characters (1 or more).
PD-6016 07/2012
339
Chapter 17 - Hyperlinks
This Filter animation sets the Filter property of the Alarms List to use any value that is defined
for the Group parameter as the source for the filter. So, if the Group parameter had a value of
'SiteA', the Alarms List would be filtered to only show those alarms that are for database
items with a Source of 'SiteA' i.e. alarms for items within the 'SiteA' Group.
On the 'Overview' Mimic, the Show Alarms button is configured to have the following pick
action settings (via the Pick Action Wizard):
Type: Hyperlink
This sets the Outstation Alarms Mimic to be displayed when the Show Alarms button is
selected in Design mode.
The Show OS 1 Alarms button has the following pick action configuration:
Type: Hyperlink
The URL entry sets the button to hyperlink to the Outstation Alarms Mimic and sets two
values: Outstation 1 Points is the value that is set for the Group parameter and Outstation 1
Alarms is the value that is set for the Title parameter. So, when a user selects the Show OS 1
Alarms button, the Outstation Alarms Mimic will be displayed in an inset window. It will
display 'Outstation 1 Alarms' in its text box (as that is the value defined for the Title
parameter which is used to animate the Text value of the text box) and its embedded Alarms
List will only display those alarms for points in the Outstation 1 Points Group (as Outstation 1
Points is the value defined for the Group parameter which is used to animate the Filter
property of the embedded Alarms List).
340
PD-6016 07/2012
Chapter 17 - Hyperlinks
The Show OS 2 Alarms button works in a similar way to the Show OS 1 Alarms button and
has similar configuration. The only difference is that the Show OS 2 Alarms button's
hyperlink sets the inset Outstation Alarms Mimic to display Outstation 2 Alarms in the text
box and to only show the alarms for points in the Outstation 2 Points Group in the
embedded Alarms List. To achieve this, the following configuration is defined for the Show
OS 2 Alarms button's hyperlink pick action:
Type: Hyperlink
So, when the Outstation Alarms Mimic is displayed as a Mimic in its own right, it displays an
embedded Alarms List that contains the alarms for points within the Outstations Group. Its
text box displays the Default Parameter value for the Title parameter, which is Outstation
Alarms. When the Outstation Alarms Mimic is displayed as a result of selecting the Show OS
1 Alarms button or Show OS 2 Alarms button, the Outstation Alarms Mimic is shown as an
inset and is filtered to only show the alarms for points in the Outstation 1 Points or Outstation
2 Points Group respectively. Its text box is also configured to show Outstation 1 Alarms or
Outstation 2 Alarms.
PD-6016 07/2012
341
Chapter 17 - Hyperlinks
Drag the document item from the Database Bar onto a Mimic (displayed in Design
Mode).
2.
When the context sensitive menu appears, select Hyperlink to create a hyperlink to the
document item.
3.
Right-click on the hyperlink and select the Pick Action Wizard option to display the Pick
Action Wizard.
4.
Select Next to proceed to the second page of the Wizard. There you will see the
absolute reference to the document (although it may not contain the System name) in
the URL field.
5.
Copy the URL entry to the clipboard, then paste it into the Code field when you are
configuring your pick action.
NOTE: If the system name is not included in the URL, you will need to add the system name
before the last / after the ClearSCADA: part of the link. For example, if the URL is SCX:////
CProfile/New Double and your system is called MAIN, you would need to change the entry
to: SCX:///Main/CProfile/NewDouble.
With Lists and Alarms Lists, you need to use a different technique to obtain the absolute
address:
1.
In ViewX, display the List to which you want to link, applying any filters as required (see
Display and Use Lists, on page 17 in the ClearSCADA Guide to Lists).
2.
With the List on display, select the Edit menu, then select the Copy Shortcut option.
3.
Run a text editor program such as Notepad and paste the entry into a new document. If
you do not have a text editor program, you can paste the absolute link into the Notes
for the List item (see Notes, on page 96 in the ClearSCADA Guide to ViewX and WebX
Clients).
4.
Look at the absolute reference and check that it complies with the following syntaxes:
For Queries Lists:
SCX:///<System>/List/Title="<Name of List>"&InitialSQL="<SQL for
List> FROM <Database Class>".
342
PD-6016 07/2012
Chapter 17 - Hyperlinks
Where:
<Name of List> is the name of the List in ViewX, for example, Objects. The angle
brackets should not be included.
<SQL for List> is the SQL filter applied to the list and consists of SELECT followed
by the defined filter criteria.
<Database Class> is the table in the database that stores the information for the
List, for example, for the Objects List, the database class is CDBOBJECT.
SCX:///<System>/AlarmList/<Filter1>="<Value1>"&<Filter2>"<Value2>"
Where:
<System> is the name of the system on which the alarms have been raised. If you
want the Alarms List to show the alarms on all of your systems, use the asterisk *
character instead of <System>. Do not include the angle brackets for <System> or
*.
<Filter1> is the name of the first filter condition that you want to apply. Do not
include the angle brackets < >.
<Value1> is the criteria that has to be met for <Filter1>. Do not include the angle
brackets < >.
<Filter2> is the name of the first second condition that you want to apply. Do not
include the angle brackets < >.
<Value2> is the criteria that has to be met for <Filter2>. Do not include the angle
brackets < >.
There can be additional filters and values (<Filter3>, <Filter4> etc.) as required. For
more information on the filter conditions that can be used, see Creating a Hyperlink to
an Alarms List, on page 319.
5.
PD-6016 07/2012
Copy the reference to the clipboard, then paste it into the Code field when you are
configuring your pick action.
343
Chapter 17 - Hyperlinks
344
PD-6016 07/2012
Chapter 18 - Animations
18 Animations
Each Mimic object has properties that you can associate with values in the database. For
example, you can associate the size of a Mimic object with the value of an analog point so
that the Mimic object is larger when the point has a high value.
Associating the property of a Mimic object with the property of an item in the database is
referred to as animating an object.
The properties of an
object on a Mimic...
...are animated so that they
are associated with the
values of objects in the
database.
You can also use an animation to associate a Mimic object property with a specific value.
For example, you can associate the FillColour property of a text box with an RGB value so
that the FillColour is set to a specific color.
By configuring animations, you can allow Mimics to:
Change in appearance according to values in the database. You can set Mimic objects
to change size and color, rotate, become invisible, and move to a new location
according to the values of objects in the database.
By using the animations feature, you can create Mimics that provide the information and
interactivity required by operators.
PD-6016 07/2012
345
Chapter 18 - Animations
346
PD-6016 07/2012
Chapter 18 - Animations
Display the Mimic object's Properties window by double-clicking on the Mimic object
(with the Mimic in Design mode).
2.
3.
Alternatively, right-click on the Mimic object and select the Animations option from the
context sensitive menu.
For information on the Animations window settings, see Using the Animations Window, on
page 348.
PD-6016 07/2012
347
Chapter 18 - Animations
The animation properties are listed in the main display. They are listed in a tree-structure,
with sets of related animation properties being grouped in branches. You can expand any
branch by selecting the + icon.
The following information is provided (where applicable):
348
ExpressionShows the ViewX expression (if any) that is in place. The ViewX expression
defines the relationship or value for the animation property.
HoverIndicates whether the Hover feature is enabled for the expression for the
animation property. For more information on the Hover feature, see Working with the
Expression Window, on page 36 in the ClearSCADA Guide to Expressions.
Fast UpdatesIndicates whether the expression for the animation property is set to be
updated using the Fast update rate or the slower, Normal update rate. For more
information on Fast Updates and Normal Updates, see Define the Update Rates for a
Mimic, on page 82.
StatusShows the status of the animation. The status indicates whether the animation
is working correctly. If the animation is correctly configured, the Status will show OK. If
the animation is incorrect, the status indicates that there is an error. For example, if you
have entered an incorrect expression, the status entry is Invalid.
PD-6016 07/2012
Chapter 18 - Animations
EditUse to access the Expression window. You need to use the Expression window
to enter ViewX expressions and associate an animation property with a database item
property (see Using the Expression Window, on page 351).
FlowchartUse to access the Flowchart window. You can use the Flowchart window to
create complex IIF statementsthe Flowchart window allows you to create a condition
tree that is easier to understand than an expression containing multiple IIF statements
(see Using the Flowchart Window, on page 353).
RefreshUse to update the Animations window so that it shows the latest status
settings etc.
For information on the animation properties, see Understanding the Animation Properties,
on page 350.
PD-6016 07/2012
349
Chapter 18 - Animations
For information on the various features of the Animations window, see Using the
Animations Window, on page 348.
350
PD-6016 07/2012
Chapter 18 - Animations
The Expression window has 3 check boxes, and an expression text entry field that has a
browse button feature:
RelativeUse this check box to define whether the expression uses relative or absolute
references. Select the Relative check box to use relative references or clear it to use
absolute references.
HoverUse the Hover check box to define whether the Mimic object needs to be
selected or highlighted to instigate the animation:
PD-6016 07/2012
If you select the Hover check box, the animation will occur when the cursor is
positioned over the Mimic object in Run mode.
If you clear the Hover check box, the animation will occur when the Mimic object is
selected in Run mode.
351
Chapter 18 - Animations
Fast UpdatesUse this check box to determine whether the expression is included in
the client PC's fast updates group. The fast updates group is a set of values for which
the client requests more frequent updates. The server sends updates for the fast
update group values more frequently that it sends updates for other values.
The frequency of requests is defined via the Options window (see Configuring the
Mimic Properties, on page 77).
If you select the check box, the animation is included in the fast updates group.
If you clear the check box, the animation is included in the normal update group.
NOTE: Fast updates can place extra demand on the system's resources and should be
used sparingly.
Enter the ViewX expression that defines the value or relationship for the animation.
The expression has to be a valid ViewX expression.
Use the browse button feature to associate the animation property with:
OPC TagAssociate the animation property with a specific property tag for an
object in the database. For example, you can associate the Value animation
property with the CurrentValue tag of a database point.
OPC Historic TagAssociate the animation property with a historic tag. For
more information on historic animations, see Animations for Historic Data, on
page 457.
ColorAssociate the animation property with a color from the palette or create
a custom color (see Using the Color Window, on page 226). The color setting is
only appropriate for animation properties that require a color definition such as
FillColour.
Select the OK button to confirm your selections and close the Expression window.
Further Information
Expressions: see Understanding the Basics of Expressions, on page 12 in the
ClearSCADA Guide to Expressions.
352
PD-6016 07/2012
Chapter 18 - Animations
Branch
Leaves
The branch IIF expression defines that the value of a digital point's alarm state has to be 4
(the point has to have an unacknowledged uncleared alarm).
The True leaf sets the color to be red and the False leaf sets the color to be green. This
means that if the digital point has an uncleared alarm, the FillColour animation will have
RGB (0,255, 0) as its value (Green) and if the digital point does not have an uncleared
alarm, the FillColour animation will have RGB(255, 0, 0) as its value (red).
PD-6016 07/2012
353
Chapter 18 - Animations
When you display a new Flowchart window, the flowchart contains a single condition,
referred to as a branch.
Branch
You can edit the branch so that it contains an IIF expression. Once the branch has an
expression, it is provided with 2 'leaves'. One leaf is the result if the branch IIF expression
is True and the other is the result if the expression is False.
Condition branches can be chained together to form a complex series of conditions and
results.
To create a flowchart, right-click on a branch or leaf to display a context sensitive menu.
You can then use the options on the context-sensitive menu to create the flowchart:
Swap BranchesSwaps the True and False leaves of a condition branch. The
expressions for the True leaf become the expressions for the False leaf and vice versa.
EditDisplays the Expression window for a branch or leaf. Use the Expression window
to define the IIF expression for a branch or the value for a leaf. For more information on
the Expression window, see Using the Expression Window, on page 351.
NOTE: There are also the standard Cut, Copy, Paste, and Delete options.
When you have created a suitable flowchart, you can choose to add it to the Fast Updates
group by selecting the Fast Updates check box. The Fast Updates check box works in
the same way as the Fast Updates check box that is shown on the Expression window
(see Using the Expression Window, on page 351).
To confirm your selections and close the Flowchart window, select the OK button.
354
PD-6016 07/2012
Chapter 18 - Animations
Shape Animations
Each shape (rectangle, polygon, and ellipse) has the following properties which you can
animate as required:
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a shape on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a shape on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a shape on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a shape on a Symbol Mimic.
PD-6016 07/2012
355
Chapter 18 - Animations
356
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a shape on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a shape on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a text box on a 'normal' Mimic, and see Pick Action Animations for
Symbols, on page 439 if you are configuring a text on a Symbol Mimic.
Valuesee Value, on page 357 and see Animating Textboxes to show Values, on page
358.
PD-6016 07/2012
Chapter 18 - Animations
Format
The Format property represents the formatting settings for values that are shown in the
text box. You can animate the Format property by associating it with the Format property
of a database item or by entering a string that specifies the format rules (see Defining the
Format of Displayed Values, on page 239 in the ClearSCADA Guide to Core
Configuration).
The Format animations only have an effect on the text box when its Value property is
animated to show a numerical value. For more information, see Animating Textboxes to
show Values, on page 358.
Text
The Text property represents a string or value that is not affected by the Format
animations or settings. By animating the Text property, you can set the text box to display
a defined string or value, or you can associate it with the value of any property in the
database, for example, the CurrentStateDesc of a point.
For more information, see Animating Textboxes to show Values, on page 358.
Value
The Value property represents a string or value that is affected by the Format animations
or settings. By animating the Value property, you can set the text box to display a defined
string or value, or you can associate it with the value of any property in the database, for
example, the CurrentStateDesc of a point.
For more information, see Animating Textboxes to show Values, on page 358.
PD-6016 07/2012
357
Chapter 18 - Animations
FormatThe Format property represents the type of formatting that is applied to any
value that is shown in the text box. This only has an effect when the text box's Value
property is animated.
The Format property is not usually animated (the format is set on the Text Properties
window instead). Typically, if the Format property is animated, it is associated with the
Format property of a point so that the text box uses the same formatting as has been
defined in the point's configuration. To do this, you would use the browse feature of the
Expression window to associate the Format property of the text box with the Format
property of the point.
You can also enter a string to animate the Format property. The string has to include the
format rules and use the relevant syntax. For example, for the Format to be animated to
show a numeric value to 3 decimal places, the string has to include:
#.000
For information about the syntax for format definitions see FORMATVAL, on page 120 in
the ClearSCADA Guide to Expressions.
TextThe Text property represents a string. By animating this property, you can set the
text box to display a defined string or value, or you can associate it with the value of
any property in the database, for example, the CurrentStateDesc of a point.
If you enter a text string in the expression for the Text property, the text string has to be
enclosed in single quotes. For example, if you enter 'State Display' as the expression,
the text box will display:
State Display
If you enter a number, there is no need to enclose it in single quotes ' '.
If you use the Expression window to associate the Text property with the property of a
database item, the value that is shown in the text box will not use any formatting
settings. Typically, you would associate the Text property with a text value such as a
point's CurrentStateDesc so the formatting would not be irrelevant (text does not use
formatting). However, for numerical values, you may need formatting such as a specific
number of decimal places. If formatting is required, you should you should animate the
Value property instead of the Text property.
358
PD-6016 07/2012
Chapter 18 - Animations
ValueThe Value property represents a numerical value or a text string that uses
formatting settings. By animating this property, you can set the text box to display a
defined string of characters or the value of any property in the database. The
Formatting settings are defined for the value in the Point configuration or are set as an
animation (see Format, on page 357).
If you enter a string in the expression for the Value property, the text string has to be
enclosed in single quotes. This works in the same way as strings that are used when
animating for the Text property.
If you enter a numerical value, the number does not have to be enclosed by single
quotes.
If you use the Expression window to associate the Value property with the property of a
database item, the text box will display the text string or numerical value for the
selected property and will apply any formatting settings, for example, a specific number
of decimal places. If there are no formatting settings specified, the default settings are
applied (2 decimal places, no leading zeros etc.).
NOTE: If a text box is used to present a value from the database, such as the value of a
point, you need to size the text box appropriately. The text box needs to be large enough to
display the entire value, including any prefixes or postfixes. If the text box is too small, parts
of the value may not be visible.
To see how the Format, Text, and Value animations work:
1.
2.
3.
4.
Animate the Text property so that it is associated with the CurrentValue property of an
internal analog point.
5.
Close the animations window and display the Mimic in Run Mode.
6.
In the Database Bar, right-click on the analog point that is used to animate the Text
property, then select the Hand Control option.
8.
9.
PD-6016 07/2012
359
Chapter 18 - Animations
13. Close the Animations window and display the Mimic in Run Mode.
The text box displays 5.659 as the 3 decimal places formatting that is defined by the
Format animation is applied to the Value animation.
The text box has its Text
property animated, so the
Format animation has no
effect.
360
PD-6016 07/2012
Chapter 18 - Animations
Line Animations
Line animations can be used on line objects and on the outline of shapes. Each line/
outline has the following properties which you can animate as required:
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a line on a 'normal' Mimic, and see Pick Action Animations for Symbols, on
page 439 if you are configuring a line on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a line on a 'normal' Mimic, and see Pick Action Animations for Symbols, on
page 439 if you are configuring a line on a Symbol Mimic.
PD-6016 07/2012
361
Chapter 18 - Animations
Alpha
The Alpha property represents the amount of transparency that is applied to the line/
outline.
The Alpha property works in the same way as the FillAlpha property except that it
animates the line/outline rather than the fill color. For more information, refer to the Fill
Animations section (see FillAlpha, on page 404).
Blink
The Blink property is used to define whether the flash feature is on or off for the line/
outline.
The Blink property for lines works in exactly the same way as the Blink property in the Fill
group except that it applies to the line/outline. For more information, refer to the Fill
Animations section (see Blink, on page 403).
Colour
The Colour property is used to define the color of the line/outline.
You can animate the Colour property in the same way as the FillColour propertythe only
difference is that the Colour property applies to the outline instead of the fill. For more
information, refer to the Fill Animations section (see FillColour, on page 405).
362
PD-6016 07/2012
Chapter 18 - Animations
DashCap
The DashCap property defines the appearance of the dashes when the line/outline is
dashed (broken lines).
Typically, you would set the DashCap by defining the appearance of the dashes on the
Line tab of the Polyline Properties window or the Text Properties window. However, you
could use an expression to define the DashCap or to animate the DashCap according to
the value or state of a database item. For example, you could animate the Dashcap so
that when a digital point is in state 0 the dashes have round ends and when the point is in
state 1 the dashes have pointed ends. The expression for this is:
IIF("<path and name of point>.CurrentState" = 0, 2, 3)
Where <path and name of point> is the location and name of the database point (do not
enter the angle brackets < > ). CurrentState is the point property that affects the dashes.
0, 2, 3 means that when the point is in state 0 the end of the dashes use style 2, and when
the point is in any other state the end of the dashes use style 3.
Dash Style
Flat
Rounded
Pointed
NOTE: The end dash style is only visible when the Width of the line is set to 3 pt or above
(either set on the Line tab or animated via the Width property).
PD-6016 07/2012
363
Chapter 18 - Animations
DashStyle
The DashStyle property defines the type of dashed lines that are used for a dashed line/
outline.
Typically, you would set the DashStyle by defining the appearance of the dashes on the
Line tab of the Polyline Properties window or the Text Properties window. However, you
could use an expression to define the DashStyle or to animate the DashStyle according to
the value or state of a database item.
Each DashStyle has a number that you can enter in an expression:
Style
Solid line
Dashed line
Dotted line
Dash-Dot line
Dash-Dot-Dot line
For example, you could animate the DashStyle so that it changes when a point has an
unacknowledged uncleared alarm. The expression for this is:
LOOKUP( "<Path and name of point>.AlarmState" + 1, 0, 0, 0, 0, 4)
Where <path and name of point> is the location and name of the database point (do not
enter the angle brackets < > ). AlarmState is the point property that affects the dashes
and the numerical values are:
364
+1 is needed as LOOKUP is 1 based (starts from 1) whereas the point's alarm states are
0 based (start from 0).
The first 0 is the DashStyle that will be applied when the point is in has no alarms (is in a
normal state). DashStyle 0 is a Solid line.
The second 0 is the Type that will be applied when the point has its alarms disabled.
DashStyle 0 is a Solid line.
The third 0 is the Type that will be applied when the point has an Acknowledged
Uncleared alarm. DashStyle 0 is a Solid line.
The fourth 0 is the DashStyle that will be applied when the point has an
Unacknowledged Cleared alarm. DashStyle 0 is a Solid line.
The 4 is the DashStyle that will be applied when the point has an Unacknowledged
Uncleared alarm. DashStyle 4 is Dash-Dot-Dot.
PD-6016 07/2012
Chapter 18 - Animations
This means that the outline will be a solid line unless the point has an unacknowledged
uncleared alarm.
PD-6016 07/2012
365
Chapter 18 - Animations
EndCap
The EndCap property defines the appearance of the end of a line. As with properties such
as the DashCap and DashStyle, you would typically set the value for the EndCap on the
Polyline Properties window or the Text Properties window. However, you can animate the
property to use a specific style (by entering the relevant number as the expression) or to
use a different style depending on the value or state of an item in the database.
The numbers for the expression are as follows:
Expression Number
Style
None
Flat Arrow
Open Arrow
Pointed Arrow
Diamond
Circle
You could use these to animate a line so that one of its ends changes style according to
the value or state of a database item. For example, you could animate the EndCap and
Colour properties to change a line from a green circle ended line to a red arrow ended line
according to the alarm state of a 1 bit digital point. This could be useful for changing the
appearance of a 'callout' line when an alarm is raised for a point.
Line changes arrow style
and color when an alarm
is raised for the relevant
point.
To achieve the effect shown above, the following expressions are used:
For the Colour property:
IIF( "<.1 Bit Digital>.AlarmState" = 4, RGB( 255, 0, 0 ), RGB( 0,
255, 0 ) )
Where <.1 Bit Digital> is the path and name of a 1 bit digital point (do not enter the angle
brackets < > ). AlarmState is the point property that affects the color for the line. The
remaining part of the expression defines that when the point is in alarm state 4 (has an
unacknowledged uncleared alarm), the line is red and when the point has an alarm state
other than 4, the line is green.
366
PD-6016 07/2012
Chapter 18 - Animations
PD-6016 07/2012
367
Chapter 18 - Animations
EndCapSize
The EndCapSize property defines the size of the end tip of a line (the EndCap). As with the
EndCap property, typically you would set the EndCapSize on the Polyline Properties
window or the Text Properties window and would not animate it. However, you can
animate the EndCapSize if required. You can animate it so that it is a certain size by
entering the relevant number for its expression or you can animate it so that the end tip
changes size according to the value or state of an item in the database.
The numbers for the available sizes are:
Small x Small
Medium x Small
Large x Small
Small x Medium
Medium x Medium
Large x Medium
Small x Large
Medium x Large
Large x Large
For example, you could animate a line with an arrow tip so that the arrow tip increases in
size when an alarm is raised for a point. To do this, you would enter the following
expression for the EndCapSize property:
LOOKUP( "<DigitalPoint 2>.AlarmState" + 1, 0, 0, 3, 5, 8)
Where <DigitalPoint 2> is the location and name of the 2 bit digital point (do not enter the
angle brackets < > ), the AlarmState is the point property that animates the EndCapSize
property of the Mimic object and the numerical values are:
368
+1 is needed as LOOKUP is 1 based (starts from 1) whereas the point's alarm states are
0 based (start from 0).
The first 0 is the EndCapSize that is applied when the point has an alarm state of 0 (no
alarms raised). The 0 EndCapSize is small x small.
The second 0 is the EndCapSize that is applied when the point has an alarm state of 1
(alarms disabled). The 0 EndCapSize is small x small.
The 3 is the EndCapSize that is applied when the point has an alarm state of 2
(acknowledged uncleared alarm). The 3 EndCapSize is small x medium.
The 5 is the EndCapSize that is applied when the point has an alarm state of 3
(unacknowledged cleared alarm). The 5 EndCapSize is large x medium.
The 8 is the EndCapSize that is applied when the point has an alarm state of 4
(unacknowledged uncleared alarm). The 8 EndCapSize is large x large.
PD-6016 07/2012
Chapter 18 - Animations
FlashAlpha
The FlashAlpha property defines the amount of transparency for the flash color that is
used in a flash effect for the outline or line. This works in exactly the same way as the
FlashFillAlpha property in the Fill group of properties except that it applies to the line
instead. For more information, refer to FlashFillAlpha (see page 407).
FlashColour
The FlashColour property defines the alternative color for the line when the flash effect is
in use. The FlashColour works in exactly the same way as the FlashFillColour (see page
407) except that it applies to the line/outline instead of the fill color.
FlashMode
The FlashMode property defines the type of flash effect that is applied to the outline. The
FlashMode property in the Line group works in exactly the same way as the Flash Mode
(see page 408) property in the Fill group except that it applies to the line/outline instead of
the fill color.
FlashOffset
The FlashOffset works in exactly the same way as the FlashOffset property in the Fill
group except that it applies to the flash sequence for the line/outline rather than the fill.
Typically, you would set the flash offset on the Polyline Properties window (it is not
designed to be used as an animation).
PD-6016 07/2012
369
Chapter 18 - Animations
JoinStyle
The JoinStyle property defines the appearance of corners on a shape. As with the other
Line properties, you would usually set the JoinStyle on the Line tab of the Polyline
Properties window or Text Properties window but you can also animate it if required.
You can animate the JoinStyle so that it is a specific type or so that it changes according
to the value or state of an item in the database. The numbers you need for the
expressions are:
Style
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 1, 3 )
This means that when the point named '1 Bit Digital' has an alarm state of 4 (an
unacknowledged alarm), the join style is Bevel. When the point has any other alarm state,
the join style is round.
370
PD-6016 07/2012
Chapter 18 - Animations
MitreLimit
The MitreLimit property defines the maximum limit for the mitre tip of a line that has its
Joins set to Mitred. If the mitred join exceeds the defined limit, the join is bevelled at the
limit.
Typically you would set the MitreLimit on the Polyline Properties window and would not
animate it. However, you can animate the MitreLimit if required. You can animate the limit
so that it is a certain number by entering the relevant number for its expression.
Alternatively, you can animate it so that the limit changes size according to the value or
state of an item in the database.
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 13.50, 10.00 )
This means that when the point named '1 Bit Digital' has an alarm state of 4 (an
unacknowledged alarm), the Mitre Limit is 13.50 pt. When the point has any other alarm
state, the Mitre Limit is 10.00 pt.
LineStyle
The LineStyle property defines the type of line that is used as the outline of a shape or a
line. As with the other Line properties, you would usually set the LineStyle on the Line tab
of the Polyline Properties window, but you can also animate it if required.
You can animate the LineStyle so that it is a specific type or animate it so that it changes
according to the value or state of an item in the database. The numbers you need for the
expressions are:
Style
Solid
Thin/Thin
Thin/Thick
Thin/Thick
Thin/Thick/Thin
For example:
IIF( ".1 Bit Digital.CurrentState" = 1, 4, 1 )
This expression means that when the point named '1 Bit Digital' is in state 1, the line style
is Thin/Thick/Thin (LineStyle 4) and when the point is in any other state the line style is
Thin/Thin (LineStyle 1).
StartCap
The StartCap property is exactly the same as the EndCap (see page 366) property except
that it applies to the opposite end of the line (the 'start' of the line).
PD-6016 07/2012
371
Chapter 18 - Animations
StartCapSize
The StartCapSize property is exactly the same as the EndCapSize (see page 368)
property except that it applies to the opposite end of the line (the 'start' of the line).
Type
The Type property defines whether the line/outline is visible. Typically, you would set the
Type on the Polyline Properties window and would not animate it. However, you can
animate the Type property if required.
You can animate the Type so that it is a specific type or so that it changes according to
the value or state of an item in the database. There are only two types of outline, so the
numbers you need for the expressions are:
Style
None
Solid
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 1, 0 )
This expression means that if the point named '1 Bit Digital' has an alarm state of 4 (i.e.
has an unacknowledged uncleared alarm), the type of line is solid (Type 1). If the point has
any other alarm state, the line is not shown (the Type is 0 - None).
Width
The Width property defines the thickness of the line/outline. As with the other Line
properties, you would usually set the Width on the Line tab of the Polyline Properties
window but you can also animate it if required.
You can enter an expression to animate the Width so that it defines a specific thickness or
so that it changes thickness according to the value or state of an item in the database.
For the expression, you should enter the size of the line you require (the number you enter
is recognized as being a point size). For example:
IIF( ".1 Bit Digital.CurrentState" = 1, 10, 5 )
This expression means that when the point named '1 Bit Digital' has a current state of 1,
the line is 10 pt thick, and when the point is in state 0 the line is 5 pt thick.
372
PD-6016 07/2012
Chapter 18 - Animations
Button Animations
Each button object has the following properties that you can animate as required:
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a button on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a button on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a button on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a button on a Symbol Mimic.
PD-6016 07/2012
373
Chapter 18 - Animations
Latched
You can animate the Latched property to define whether a latched button appears to be
pressed. The Latched property only has an effect when the button is set to be a latched
button (either by having the Style set to Latch on the Button Properties window or by
having the Style property animated to be 1).
The expression for the Latched property needs to equal TRUE for the button to appear to
be pressed down, and it has to equal FALSE for it to be raised.
You can enter True or False as the expression, or you can use a more complex expression
that returns a True or False answer. For example, if a button is to appear pressed down
only when a specific 1 bit digital point is in state 1, you would need to enter the following
as the expression for the Latched property of the Mimic object:
"<path and name of point>.CurrentState" = 1
Where <path and name of point> is the location and name of the point in the database.
Do not enter the angle brackets < >.
CurrentState is the name of the point property that is used to animate the Mimic object's
Latched property.
The final part of the expression defines that if the CurrentState value of the point is 1, then
the result of the expression is TRUE and so the button appears to be pressed down. If the
CurrentState is not 1, the result of the expression is FALSE and the button appears to be
raised.
374
PD-6016 07/2012
Chapter 18 - Animations
PickParamAlt
The PickParamAlt animation property can only be used when the button style is Latched.
It allows a pick action menu (or specific pick action) to be associated with the button
when it appears to be pressed down. The PickParam property allows a pick action menu
to be associated with a the button when it appears to be raised.
The PickParamAlt property can be animated in exactly the same way as the PickParam
propertythe only difference is that the action or menu that you associate with the
PickParamAlt property will only be applied or made available when the button appears to
be pressed down. The action or menu that is used to animate the PickParam property, if
any, will apply when the button appears to be raised.
Example:
A latched button is used to Hand Control a digital point named 'Button States'. When the
button is pressed, the point is hand controlled to be in State 1 and when the button is
selected again (raised), the point is hand controlled to be in State 0. To achieve this, the
following animations are setup:
The Latched property is animated by the CurrentState of the digital point so that it appears
pressed down or raised according to the current state of the point. The following expression
is used:
".Button States.CurrentState"
The PickParam property is animated so that when the button is raised (not pressed down),
the digital point is hand controlled to State 0. The expression for the PickParam property is:
".Button States.ObjectLink" + '?CurrentState&Value="1"'
The ".Button States.ObjectLink" part of the expression associates the raised button with the
pick action menu for the 'Button States' digital point, and the '?CurrentState&Value="1"'
part of the expression associates the raised button with the Hand Control action
(CurrentState) which sets the value of the digital point to State 1.
The PickParamAlt property is animated so that when the button is pressed down, the digital
point is hand controlled to State 1. The expression for the PickParamAlt property is:
".Button States.ObjectLink" + '?CurrentState&Value="0"'
The ".Button States.ObjectLink" part of the expression associates the pressed down button
with the pick action menu for the 'Button States' digital point, and the
'?CurrentState&Value="1"' part of the expression associates the pressed down button with
the Hand Control action (CurrentState) which sets the value of the digital point to State 0.
The Text property has the following expression:
".Button States.CurrentStateDesc"
PD-6016 07/2012
375
Chapter 18 - Animations
This associates the current state description of the 'Button States' point with the text that is
shown on the button. This means that when the button is pressed down, the text will show
'State 1' and the 'Button States' digital point is hand controlled to be in State 1. When the
button is reselected so that it becomes raised, the button text changes to 'State 0' and the
'Button States' digital point is hand controlled to be in State 0.
The effect of the PickParam and PickParamAlt animations can also be achieved by using the
Pick Action Wizard for the button.
After selecting Method as the type of pick action, you can use the next two 'pages' of the
Wizard to setup the action that is performed and the value that is set when the button is up
(raised) or down (pressed down).
376
PD-6016 07/2012
Chapter 18 - Animations
Style
The Style property defines whether the button is a normal button (only appears to be
pressed when it is selected, and then returns to its raised position) or is a latched button
(appears pressed in when selected and does not return to its raised position
automatically). Typically, you would set the Style on the Button Properties window and
would not animate it. However, you can animate the Style property if required.
You can animate the Style so that it is a specific type or so that it changes according to
the value or state of an item in the database. There are only two types of style, so the
numbers you need for the expressions are:
Style
Normal button
Latched button
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 1, 0 )
This expression means that if the point named '1 Bit Digital' has an alarm state of 4 (i.e.
has an unacknowledged uncleared alarm), the style is latched (Style 1). If the point has
any other alarm state, the style is normal (the Style is 0 - Normal).
Text
The Text property represents a string or value that is shown on the button. By animating
the Text property, you can set the button to display a defined string or value, or you can
associate it with the value of any property in the database, for example, the
CurrentStateDesc of a point.
Animating the Text property on a button is similar to animating the Text property on a text
box. For more information, see Animating Textboxes to show Values, on page 358.
PD-6016 07/2012
377
Chapter 18 - Animations
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded Mimic on a 'normal' Mimic, and see Pick Action Animations
for Symbols, on page 439 if you are configuring an embedded Mimic on a Symbol
Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded Mimic on a 'normal' Mimic, and see Pick Action Animations
for Symbols, on page 439 if you are configuring an embedded Mimic on a Symbol
Mimic.
MaintainAspectRatio
The MaintainAspectRatio property represents a True/False setting that determines
whether the embedded Mimic maintains its aspect ratio when it is resized. This property is
not designed for use as an animation.
378
PD-6016 07/2012
Chapter 18 - Animations
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded List on a 'normal' Mimic, and see Pick Action Animations for
Symbols, on page 439 if you are configuring an embedded List on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded List on a 'normal' Mimic, and see Pick Action Animations for
Symbols, on page 439 if you are configuring an embedded List on a Symbol Mimic.
PD-6016 07/2012
379
Chapter 18 - Animations
BackColour
The BackColour defines the background color of the embedded List. You can animate
this so that it uses a color that is associated with a database item (such as the alarm
color), refers to a custom color, or is set to a specific color (an RGB value).
This property works in a similar way to the FillColour (see page 405) except that it applies
to the background of an embedded List instead of the fill of an object. However, this
animation can be overridden by the Background column in an SQL query.
GridColour
The GridColour defines the color of the grid lines on an embedded List. You can animate
this so that it uses a color that is associated with a database item (such as the alarm
color), refers to a custom color, or is set to a specific color (an RGB value).
This property works in a similar way to the FillColour (see page 405) except that it applies
to the grid lines of an embedded List instead of the fill of an object.
GridSize
Allows you to animate the size of the grid on an embedded List. You can animate the
GridSize so that it is a specific size or you can animate it so that the size changes
according to the value or state of an item in the database.
The expression for the GridSize property has to define a number which is the size of the
grid (measured in points). This property works in a similar way to the Height (see page
419) property for text, except that it applies to the size of the grid.
HeaderDkShadowColour
The HeaderDkShadowColour defines the shadow color of the columns on an embedded
List. You can animate this so that it uses a color that is associated with a database item
(such as the alarm color), refers to a custom color, or is set to a specific color (an RGB
value).
This property works in a similar way to the FillColour (see page 405) except that it applies
to the shadow of the column headings instead of the fill of an object.
380
PD-6016 07/2012
Chapter 18 - Animations
HeaderFaceColour
The HeaderFaceColour property defines the fill color of the column headings on an
embedded List. You can animate this so that it uses a color that is associated with a
database item (such as the alarm color), refers to a custom color, or is set to a specific
color (an RGB value).
This property works in a similar way to the FillColour (see page 405) except that it applies
to the fill of the column headings instead of the fill of an object.
HeaderFont
The HeaderFont properties for the embedded List are identical to the font properties for
text boxes except that they apply to the header text on the embedded List (see Font
Animations, on page 417).
HeaderHighlightColour
The HeaderHighlightColour property defines the highlight color of the column headings
on an embedded List. You can animate this so that it uses a color that is associated with
a database item (such as the alarm color), refers to a custom color, or is set to a specific
color (an RGB value).
HeaderShadowColour
The HeaderShadowColour property defines the shadow color of the column headings on
an embedded List. You can animate this so that it uses a color that is associated with a
database item (such as the alarm color), refers to a custom color, or is set to a specific
color (an RGB value).
PD-6016 07/2012
381
Chapter 18 - Animations
HeaderTextColour
The HeaderTextColour property defines the color of the text in the column headings on an
embedded List. You can animate this so that it uses a color that is associated with a
database item (such as the alarm color), refers to a custom color, or is set to a specific
color (an RGB value).
HeaderTextColour is
animated so that it is red.
This property is similar to the FillColour property in the Pen group (see Pen Animations, on
page 416).
Sql
The Sql property represents the SQL query that defines what is shown in the embedded
List. Typically, you would only animate this property if you were configuring an embedded
List for use in a Group Template and Group Instances or if you were configuring an
embedded List that was to be filtered by an animation.
When using an Sql animation, the string has to use the correct syntax. The easiest way to
check that the SQL Query part of the animation string is correct is to display the Query tab
on the Properties window of the embedded List, then right-click and select the Generate
Animation option. This copies the SQL Query used for the embedded List and converts
the copy into the correct syntax for the Sql animation property (the converted SQL Query
is added to the Sql animation automatically, ready for you to edit it as required).
You can configure a button or another selectable Mimic object to apply different filters to
an embedded list. To do this, you will need to animate the Sql property and set up a
registry key pick action. For more information, see Using Registry Settings to Apply
different Filters to an Embedded List, on page 244.
System
The System property represents the ClearSCADA system name and it is not designed to
be used with animations.
382
PD-6016 07/2012
Chapter 18 - Animations
TextColour
The TextColour property defines the default color of the text in the cells on the embedded
List. You can animate this so that it uses a color that is associated with a database item
(such as the alarm color), refers to a custom color, or is set to a specific color (an RGB
value).
PD-6016 07/2012
383
Chapter 18 - Animations
Embedded Alarms Lists have a Filter property (see Filter, on page 384)
Embedded Alarms Lists have no Sql property as they are not Query lists.
For information on the other Embedded Alarms List animation properties, please refer to
Embedded Query List Animations (see page 379).
Filter
You can animate the Filter property of an embedded Alarms List so that a filter is applied
to the Alarms List. This creates a criteria for the Alarms List so that it can only display
those alarms that are a specific category, state, or belong to specific items or are in a
defined severity range (see Filter an Embedded Alarms List, on page 181).
To animate the Filter property of an embedded Alarms List, you need to use the following
syntax:
<filter1>="<value1>"&<filter2>="<value2>"
Where:
<filter1> is the name of the first filter condition that you want to apply. Do not include
the angle brackets < >. You can use any of the following filter conditions:
AreaRepresents a database Group. You can define multiple Areas (separate with
ampersands, for example, Area="AreaName1" & Area="AreaName2").
AOIRepresents an Area of Interest. You can define multiple AOIs (separate with
ampersands, for example, AOI="AreaofInterest1" & AOI="AreaofInterest2").
384
PD-6016 07/2012
Chapter 18 - Animations
<value1>Represents the criteria that has to be met for the first filter condition. The
value has to be enclosed in double quotation marks " ". Do not enter the angle brackets
< >.
<filter2>Represents the second filter. Do not enter the angle brackets < >.
<value2>Represents the value for the second filter. The value has to be enclosed in
double quotation marks " ". Do not enter the angle brackets < >.
NOTE: Additional filters and values can be included by using the &. For example, <filter
3>="<value3>"&<filter4>="<value4>" and so on.
As long as the source of the Filter animation is a string value and uses the appropriate
syntax, the Alarms List animation will be valid. So you can use registry settings to store
different filters for an Alarms List, then use buttons to toggle the filters that are applied.
Further Information
Alarm Filter Syntax: see Alarm Filter String Syntax, on page 77 in the ClearSCADA Guide
to Alarms.
Examples:
Example 1 - Filter by Point, Group, and Severity
The following entry filters the embedded Alarms List so that it only shows alarms for a point
named 'AI1' that is stored in a Group named 'Main Site'. The Alarms List only includes
alarms that are within the severity range 200-800 (the meaning of these values is defined in
the server configuration - see Alarm and Event Severities, on page 305 in the ClearSCADA
Guide to Server Administration).
'Area="Main
Site"&Source="AI1"&MinSeverity="200"&MaxSeverity="800"'
PD-6016 07/2012
385
Chapter 18 - Animations
All Alarm StatesConfigured to have a registry pick action with these settings:
Name=Severity, Type=String, Value=MinSeverity="1"&MaxSeverity="1000".
When the Mimic is displayed in Run Mode, the Alarms List will respond to the buttons. When
the Critical Severity button is selected, the Severity registry value has the following value
written to it: MinSeverity="1000"&MaxSeverity="1000". As the source of the Filter animation
for the Alarms List is the Severity registry value, the Alarms List is filtered to show only
critical alarms.
Similarly, when the High Severity button is selected, the value
MinSeverity="667"&MaxSeverity="999" is written to the Severity registry and so the Alarms
List only shows High severity alarms.
When the All Alarm States button is selected, the value
MinSeverity="1"&MaxSeverity="1000" is written to the Severity registry and the Alarms List
shows alarms of every state.
386
PD-6016 07/2012
Chapter 18 - Animations
MainFontRepresents the text properties of the values shown on the axes of the
embedded Trend. These properties work in the same way as Font Animations (see page
417).
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded Trend on a 'normal' Mimic, and see Pick Action Animations
for Symbols, on page 439 if you are configuring an embedded Trend on a Symbol
Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded Trend on a 'normal' Mimic, and see Pick Action Animations
for Symbols, on page 439 if you are configuring an embedded Trend on a Symbol
Mimic.
TitleFontRepresents the text properties of the title text. These properties work in the
same way as Font Animations (see page 417).
BackAlpha
The BackAlpha property works in a similar way to FillAlpha (see page 404) property,
except that instead of representing the amount of transparency for the fill, it represents
the amount of transparency that is applied to the background of an embedded Trend.
PD-6016 07/2012
387
Chapter 18 - Animations
BackColour
The BackColour property represents the background color of the embedded Trend. You
can animate this so that it uses a color that is associated with a database item (such as
the alarm color), refers to a custom color, or is set to a specific color (an RGB value).
This property works in a similar way to the FillColour (see page 405) except that it applies
to the background of an embedded Trend instead of the fill of an object.
388
PD-6016 07/2012
Chapter 18 - Animations
LabelFontRepresents the text properties of the embedded X-Y Plot's label. These
properties work in the same way as Font Animations (see page 417).
MainFontRepresents the text properties of the values shown on the axes of the
embedded X-Y Plot. These properties work in the same way as Font Animations (see
page 417).
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded X-Y Plot on a 'normal' Mimic, and see Pick Action
Animations for Symbols, on page 439 if you are configuring an embedded X-Y Plot on a
Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an embedded X-Y Plot on a 'normal' Mimic, and see Pick Action
Animations for Symbols, on page 439 if you are configuring an embedded X-Y Plot on a
Symbol Mimic.
TitleFontRepresents the text properties of the title text. These properties work in the
same way as Font Animations (see page 417).
BackAlpha
The BackAlpha property works in a similar way to FillAlpha (see page 404) property,
except that instead of representing the amount of transparency for the fill, it represents
the amount of transparency that is applied to the background of an embedded Trend.
PD-6016 07/2012
389
Chapter 18 - Animations
BackColour
The BackColour property represents the background color of the embedded Trend. You
can animate this so that it uses a color that is associated with a database item (such as
the alarm color), refers to a custom color, or is set to a specific color (an RGB value).
This property works in a similar way to the FillColour (see page 405) except that it applies
to the background of an embedded Trend instead of the fill of an object.
390
PD-6016 07/2012
Chapter 18 - Animations
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an image on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring an image on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring an image on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring an image on a Symbol Mimic.
PD-6016 07/2012
391
Chapter 18 - Animations
Alignment
The Alignment property is exclusive to images and remote images and it represents the
positioning of the image within the image box that you draw when you add the image to a
Mimic.
When you enter an expression to animate the Alignment property, the expression needs to
define one of the following numbers:
Number for
Expression
Alignment
Tile (the image is repeated in the image box until the available
space is used).
For example, you could use the following expression to change the alignment of an image
according to the alarm state of a point in the database:
IIF( ""<path and name of point>.AlarmState" = 4, 0, 2 )
Where <path and name of point> are the location and name of a point. Do not enter the
angle brackets < >.
This means that when the point has an AlarmState of 4 (Unacknowledged Uncleared), the
Alignment is 0 (Stretch). When the point has any other AlarmState, the Alignment is 2
(Center).
392
PD-6016 07/2012
Chapter 18 - Animations
UrlThe Url defines the location of the remote image and is animated with this
expression:
'http://'+""<location and name of string point>"+'<address of
image>'
Where <location and name of string point> is the location and name of the string point.
This represents the CurrentValue of the string point. As in other examples, do not enter
the angle brackets < >. This expression sets the Url to include the server address as
defined by the current value of the string point.
The <address of image> is the location and name of the image. For example,
'.Webcam/Image.jpg'.
PD-6016 07/2012
393
Chapter 18 - Animations
The Mimic also has three buttons (Area 1, Area 2, and Area 3). Each button is configured
to work as a Method type of pick action so that when it is selected it hand controls the
value of the string point. Each button hand controls the point so that its value is the IP
address of the relevant server:
When the Area 1 button is selected, the value of the string point is hand controlled to
10.0.10.1 (the IP address of server 1). This animates the Url property of the remote
image so that the Mimic shows the image from server 1 (webcam 1).
When the 'Area 2' button is selected, the value of the string point changes to 10.0.10.2
(the IP address of server 2). This animates the Url property of the remote image so that
the Mimic shows the image from server 2 (webcam 2).
When the 'Area 3' button is selected, the value of the string point changes to 10.0.10.3
(the IP address of server 3). This animates the Url property of the remote image so that
the Mimic shows the image from server 3 (webcam 3).
The area that is monitored by webcam 2 is of greater importance than the areas covered
by webcam 1 and webcam 3, and so it needs to be updated more frequently. To achieve
this, the remote image also has an animation for its RefreshRate property.
The RefereshRate property defines how often the image is updated. To set the image from
webcam 2 so that it is updated at faster rate than the other webcams, the following
expression is used:
IIF (""<Path and Name of String Point>.CurrentValue"= 10.0.10.2, 1,
5)
Where <Path and name of String Point> is the location and name of the string point that
has its value set to correspond with the address of one of the servers. The angle brackets
are not included in the expression.
394
PD-6016 07/2012
Chapter 18 - Animations
The expression defines that if the current value of the string point is 10.0.10.2 (the address
of Server 2), then the remote image is updated every second (defined by the 1). If the
current value of the string point is not 10.0.10.2 (i.e is 10.0.10.1 or 10.0.10.3), then the
remote image is updated every 5 seconds.
PD-6016 07/2012
395
Chapter 18 - Animations
396
FontRepresents the text properties of the labels, values, and percentages shown in
the key for the pie chart. These properties work in the same way as Font Animations
(see page 417).
Key PosUse to animate the position of the pie chart's key (see Key Pos, on page
397).
Key StyleUse to animate the type of key that is shown for the pie chart (see Key Style,
on page 398)
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a pie chart on a 'normal' Mimic, and see Pick Action Animations for
Symbols, on page 439 if you are configuring a pie chart on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a pie chart on a 'normal' Mimic, and see Pick Action Animations for
Symbols, on page 439 if you are configuring a pie chart on a Symbol Mimic.
Slice01 - Slice10Use to associate each slice of the pie chart with a value (see Slice
Animations, on page 399).
PD-6016 07/2012
Chapter 18 - Animations
Key Pos
A pie chart can have a key that indicates what each slice of the represents (as a value,
percentage, label, or a combination of the three). You can use the Key Pos property to
animate the key so that it is:
Not shown
Typically, you would set the Key Pos on the Pie Chart Properties window and would not
animate it. However, you can animate the Key Pos property if required.
You can animate the Key Pos so that the key is in a specific position or so that it changes
according to the value or state of an object in the database. There are only three key
positions, so the numbers you need for the expressions are:
Number for
Expression
Key Position
None
Left
Right
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 0, 1 )
This expression means that if the point named '1 Bit Digital' has an alarm state of 4 (i.e.
has an unacknowledged uncleared alarm), the key is not visible (Key Pos is 0 - None). If
the point has any other alarm state, the key is positioned to the left of the pie chart (the
Key Pos is 1 - Left).
PD-6016 07/2012
397
Chapter 18 - Animations
Key Style
A pie chart can have a key that indicates what each slice of the represents (as a value,
percentage, label, or a combination of the three). The type of information that is displayed
on the key is defined via the Key Style setting. Typically, you would set the Key Style on
the Pie Chart Properties window. However, you can animate the Key Style is required.
You can animate the Key Style so that the key is in a specific style or so that it changes
according to the value or state of an object in the database. There are several key styles
and the numbers you need for the expressions are:
Number for
Expression
Key Style
Label Only
Value Only
Percentage Only
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 6, 0 )
This expression means that if the point named '1 Bit Digital' has an alarm state of 4 (i.e.
has an unacknowledged uncleared alarm), the key shows the label, value, and percentage
(Key Style is 6). If the point has any other alarm state, the key only shows the label (the
Key Style is 0).
398
PD-6016 07/2012
Chapter 18 - Animations
Slice Animations
You need to animate the slices of your pie charts so that they represent values in the
database. Each pie chart can contain up to 10 slices.
Each slice has a group of animations:
AlphaThe Alpha property represents the amount of transparency that is applied to the
slice.
The Alpha property works in the same way as the FillAlpha property for lines and
shapes except that it animates fill of the slice. For more information, refer to the Fill
Animations section (see FillAlpha, on page 404).
ColourThe Colour property represents the fill color of the slice. This property works in
the same way as the FillColour (see page 405) property for lines and shapes except that
it applies to the fill of the slice.
LabelThe Label property represents the label that can be shown on a slice. It is a
string value. By animating this property, you can set the slice to display a defined string
or you can associate it with a string value of any property in the database, for example,
the CurrentStateDesc of a point.
If you enter a text string in the expression for the Label property, the text string has to
be enclosed in single quotes. For example, if you enter 'State Display' as the
expression, the slice will display:
State Display
If you enter a number, there is no need to enclose it in single quotes ' '.
If you use the Expression window to associate the Label property with a string value for
an object in the database, the value that is shown in the slice will not use any formatting
settings.
ValueUse the Value property to associate the slice with the value of an object in the
database. Alternatively, you can enter a specific value. The value animation is used to
calculate the size of the slicethe value for the Value property is compared to the
values for the other slices and the size of the slice is altered accordingly. For example, if
there are 2 slices and one has a value of 50 and the other has a value of 150, one slice
will take up a quarter of the pie chart (50 out of a total 200 is 25%) and the other slice
will take up three quarters of the pie chart (150 out of a total 200 is 75%).
Typically, you will associate the Value property with the CurrentValue property of a
database point. You should use the browse button feature of the Expression window to
associate the Value property with the required OPC Tag (CurrentValue for example).
PD-6016 07/2012
399
Chapter 18 - Animations
Example:
The following pie chart has these animations in place:
KeyStyle4. The Key shows the label and percentage for each slice.
Slice01:
Label'Pipeline Alarms'. The label for the slice shows 'Pipeline Alarms'.
Value"Monitor Point 1.CurrentValue". The size of the slice is based on the current
value of the Monitor Point 1 database point.
Slice02:
ColourRGB( 200, 200, 150 ). The slice is set to a pale shade of yellow/brown but it
is not visible as the Alpha setting is 0.
Label'Pump Alarms'. The label for the slice shows 'Pump Alarms'.
Value"Monitor Point 2.CurrentValue". The size of the slice is based on the current
value of the Monitor Point 2 database point.
NOTE: If you want to remove a slice from a pie chart, you should set the value of the
animation for the slice to 0 before you clear it (remove the slice). If the slice animation is not
set to 0, the pie chart will continue to show the slice, even after you have cleared the
animation for the slice. This is because the pie chart will maintain the previous value of the
slice.
400
PD-6016 07/2012
Chapter 18 - Animations
Pipe Animations
You can animate the following properties for pipe objects:
PickParamsee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a shape on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a shape on a Symbol Mimic.
PickTypesee Pick Action Animations for Mimic Objects, on page 423 if you are
configuring a shape on a 'normal' Mimic, and see Pick Action Animations for Symbols,
on page 439 if you are configuring a shape on a Symbol Mimic.
Width
The setting for the Width animation property defines the thickness of the pipe. Typically,
you would not animate the Width propertyyou would set the width on the Pipe
Properties window. However, you can animate the property if required.
The Width property requires a floating number, so you can enter any number for the width
(the higher the number, the greater the thickness). Alternatively, you can use the
Expression window's browse feature to associate the Width property with the value of a
database item.
PD-6016 07/2012
401
Chapter 18 - Animations
Fill Animations
You can use the properties in the Fill group (on the Animations window) to animate the fill
area of the Mimic object. The fill area is the inner part of a shape, text box, etc.
You can animate the following Fill properties:
FillColour (see page 405)The color that fills the area of the object.
FlashFillColour (see page 407)The alternate FillColour used with a flash effect.
FlashGradColour (see page 408)The second alternate color used with a 3 color flash
effect.
Flash Mode (see page 408)Defines the type of flash that is being used.
GradColour (see page 411)The color of the gradient shading (on objects that have
gradient shading).
Hatch (see page 412)Defines the type of hatch shading that is used when the Type is
set to Hatch.
Type (see page 415)Defines the type of fill that is applied to the Mimic object.
If you are animating the flash colors, the animations will only take effect if the Mimic
object has the Blink property animated (or the Blink feature enabled on the object's
Properties window, for example on a rectangle's Polyline Properties window).
402
PD-6016 07/2012
Chapter 18 - Animations
Blink
The Blink property is used to define whether the flash feature is on or off for the selected
Mimic object.
The expression for the Blink property needs to equal TRUE for the flash feature to be on,
and it has to equal FALSE for it to be off.
You can enter True or False as the expression, or you can use a more complex expression
that returns a True or False answer. For example, if a Mimic object is to flash only when a
specific 1 bit digital point is in state 1, you would need to enter the following as the
expression for the Blink property of the Mimic object:
""<path and name of point>.CurrentState" = 1
Where <path and name of point> is the location and name of the point in the database.
Do not enter the angle brackets < >.
CurrentState is the name of the point property that is used to animate the Mimic object's
Blink property.
The final part of the expression defines that if the CurrentState value of the point is 1, then
the result of the expression is TRUE and so the Blink is on. If the CurrentState is not 1, the
result of the expression is FALSE and the Blink is off.
PD-6016 07/2012
403
Chapter 18 - Animations
FillAlpha
The FillAlpha property of a Mimic object defines the amount of transparency that is
applied to the FillColour (see page 405).
Typically, you would animate the FillAlpha property so that it is set to a specific level. You
could do this by entering a number between 0 and 255 for the FillAlpha property's
expression (where 0 is completely transparent and 255 is opaque).
You can also use a property of a database item to animate the FillAlpha property. For
example, you could animate a square so that it was only transparent when a specific
analog point has a value less than 50. To achieve this, you could edit the expression for
the FillAlpha property:
IIF (""<Path and Name of Point>.CurrentValue"<50, 135, 255)
Where <Path and Name of Point> are the location and name of the analog point (do not
enter the angle brackets < >).
CurrentValue is the point property that is associated with the FillAlpha property.
You need to enter the angle bracket for the <50 part of the expression, as this defines the
point value that is required for the transparency to be set to 135 or 255.
When the point's CurrentValue is less than 50 the FillColour of the square will have a
transparency of 135 so it will be visible, but translucent. When the point's CurrentValue is
not less than 50, the FillColour of the square will be 255 (opaque).
404
PD-6016 07/2012
Chapter 18 - Animations
FillColour
The FillColour property of a Mimic object defines the color that is used to fill the area of
the object. The fill area is the inner part of the object (every part of the object except for
the outline).
The expression for the FillColour property needs to:
Result in an RGB value. With a defined RGB value, the color is fixed as the specified
color.
or
Associate the FillColour with an OPC color tag for a database item.
Is a Specific Color Depending on the Value of Another ObjectYou can animate the
FillColour according to the value for another database item property.
You can set the FillColour so that when an object has a specific value, the FillColour is
one color, and when the object has a different value, the FillColour is a different color.
For example, If you had a Mimic object that you wanted to be colored red when a digital
point was in state 1, and blue when it was in any other state, you would use the
CurrentState point property to animate the FillColour of the Mimic object:
IIF (""<Point Name and Path>.CurrentState" = 1, RGB (255, 0, 0),
RGB (0, 0, 255))
Where <Point Name and Path> are the location and name of the point that you want to
use to determine the color of the Mimic object. Do not enter the angle brackets < >.
The CurrentState is the point property that defines the state of the point. So, when the
CurrentState is 1 (i.e. the point is in state 1), the FillColour will be RGB 255, 0, 0 which
corresponds to Red 255, Green 0, Blue 0 (i.e. red). If the point is not in state 1, the
FillColour will be RGB 0, 0, 255 which corresponds to Red 0, Green 0, Blue 255 (blue).
PD-6016 07/2012
405
Chapter 18 - Animations
Display the Expression window for the FillColour property (see Using the Expression
Window, on page 351)
ii. Position the cursor at the location in the expression where the color is to be
inserted. If you highlight part of the expression, the color will replace the highlighted
code.
iii. Select the browse button to display a context-sensitive menu.
iv. Select the OPC Tag option to display the Select Tag dialog box.
v.
Browse to the database item that has the color property you want to reference.
406
PD-6016 07/2012
Chapter 18 - Animations
vii. Select the Color Palette property that you want to reference, and then select the OK
button. A reference to the chosen color tag is inserted in your expression. The color
represented by the tag will change whenever a user changes that color property on
the color palette. For example, if you select the Future Data>Colour tag for a point,
the FillColour property is associated with the Future Data setting on that points
Color Palette. If a change is made to the points Future Data color setting (on the
color palette), the Mimic animation updates with the new color automatically. This is
because the expression references the OPC color tag, not the color itself.
FlashFillAlpha
The FlashFillAlpha property defines the amount of transparency that is applied to the
FlashFillColour (see page 407). This works in exactly the same way as the FillAlpha (see
page 404) property, except that it applies to the alternate color that is used in the flash
effect.
FlashFillColour
The FlashFillColour property defines the alternate FillColour that is used with a flash
effect. When animated to use the flash feature, the object will alternate between the
FillColour and the FlashFillColour.
The FlashFillColour works in exactly the same way as the FillColour (see page 405) except
that it corresponds to the alternate color for flash effects.
FlashGradAlpha
The FlashGradAlpha property defines the amount of transparency that is applied to the
FlashGradColour (see page 408). This works in the same way as the FillAlpha (see page
404) property except that it applies to the second alternate color used with 3 color flash
effects.
PD-6016 07/2012
407
Chapter 18 - Animations
FlashGradColour
The FlashGradColour property defines the second alternate color that is used with a 3
color flash effect. When animated to use the flash feature, the object will alternate
between the FillColour, the FlashFillColour, and the FlashGradColour.
The FlashGradColour works in exactly the same way as the FillColour (see page 405)
except that it corresponds to the second alternate color for flash effects.
Flash Mode
The Flash Mode property defines the type of flash effect. Each flash effect corresponds to
a number, as follows:
Effect
So, for a Mimic object to use a 2 color flashing effect, its Flash Mode property has to have
an expression set to 4.
You can also use more complicated expressions to determine which flashing effect is
used. For example, you can animate a Mimic object so that it uses a faster flashing effect
when a point has unacknowledged uncleared alarms raised. To do this, you would
animate the Flash Mode property so that it had the following expression:
IIF ("<path and name of point>.AlarmState" = 4, 1, 0)
Where <path and name of point> are the location and name of the point with which you
want to associate the Mimic object.
The point's AlarmState property animates the Flash Modewhen the Alarm State is 4
(which corresponds to Unacknowledged Uncleared), the Flash Mode is 1 (which
corresponds to On/Off Fast Flashing). When the point's AlarmState is any other value, the
Flash Mode is 0 (Normal flashing).
408
PD-6016 07/2012
Chapter 18 - Animations
As the Flash Mode is 0 when the point's AlarmState is 0 (Normal), you would also need to
animate the Blink property so that the flash effect was only on when the point's
AlarmState was any value except 0 (you only want the Mimic object to flash when the
point has an alarm). To do this, you would animate the Blink property so that its
expression is:
"<path and name of point>.AlarmState"<>0
For this expression, you do not enter the angle brackets around the path and name of
point (as elsewhere, they are used to indicate that this is a database location and name),
but you do need to enter the angle brackets before the 0 as these are used to indicate any
value smaller or greater than 0.
The Blink expression works like this:
If the point's AlarmState is less than or greater than 0 (i.e. an alarm is raised), the result of
the expression is TRUE and so the Blink is set to 1 (on). If the point's AlarmState is 0
(normal i.e. no alarms are raised) then the result of the expression is FALSE and the Blink
is set to 0 (off).
PD-6016 07/2012
409
Chapter 18 - Animations
FlashOffset
The FlashOffset defines the sequence for 4 color flashing effects. The different parts of
the sequence are numbered 1-4, but it is very unlikely that you would want to animate this
property as it is usually set on the Polyline Properties window or Text Properties window
and is not designed for use as an animation.
GradAlpha
The GradAlpha property defines the amount of transparency that is applied to the
GradColour (see page 411). This works in exactly the same way as the FillAlpha (see page
404) property, except that it applies to the secondary color that is used in the Linear
Gradient, Pipe Gradient, or Radial Gradient shading.
GradAngle
The GradAngle defines the angle of the secondary color shading when the type of Fill is
set to Linear Gradient and Pipe Gradient. The GradAngle value for an object with pipe
shading defines the angle of the pipe shading. The default measurements are:
0 = Horizontal
90 = Vertical
45 = Top-right corner
It is unusual for the GradAngle to be animated, as the angle of the gradient shading is not
usually changed after it has been defined on the Polyline Properties window or Text
Properties window. However, if you wanted to animate the GradAngle, the expression for
the GradAngle would need to result in a value between 0 and 360 (the value corresponds
to degrees).
410
PD-6016 07/2012
Chapter 18 - Animations
GradColour
The GradColour property defines the secondary color that is used with objects that have
Linear Gradient, Pipe Gradient, or Radial Gradient shading. It works in exactly the same
way as the FillColour (see page 405) except that it applies to the secondary color of the
shading effect.
GradXPos
The GradXPos defines the horizontal position of the secondary color shading when the
type of Fill is set to Radial Gradient.
It is unusual for the GradXPos to be animated, as the position of the gradient shading is
not usually changed after it has been defined on the Polyline Properties window or Text
Properties window. However, if you wanted to animate the GradXPos, the expression for
the GradXPos would need to result in a value between 0 and 100 (0 is at the far left and
100 is far right).
GradYPos
The GradYPos defines the vertical position of the secondary color shading when the type
of Fill is set to Radial Gradient.
It is unusual for the GradYPos to be animated, as the position of the gradient shading is
not usually changed after it has been defined on the Polyline Properties window or Text
Properties window. However, if you wanted to animate the GradYPos, the expression for
the GradYPos would need to result in a value between 0 and 100 (0 is at the bottom and
100 is at the top).
PD-6016 07/2012
411
Chapter 18 - Animations
Hatch
You can animate the hatch pattern on an object that has hatch shading, for example, you
can animate it so that it changes pattern when a point changes state.
Each type of hatch pattern corresponds to a number, as follows:
412
Number for
Expression
Hatch
Horizontal
Vertical
Forward diagonal
Backward diagonal
Cross
Diagonal cross
5 percent
10 percent
20 percent
25 percent
10
30 percent
11
40 percent
12
50 percent
13
60 percent
14
70 percent
15
75 percent
16
80 percent
17
90 percent
18
19
20
21
22
23
24
Light vertical
25
Light horizontal
26
Narrow vertical
27
Narrow horizontal
28
Dark vertical
PD-6016 07/2012
Chapter 18 - Animations
Number for
Expression
Hatch
29
Dark horizontal
30
31
32
Dashed horizontal
33
Dashed vertical
34
Small confetti
35
Large confetti
36
Zigzag
37
Wave
38
Diagonal brick
39
Horizontal brick
40
Weave
41
Plaid
42
Divot
43
Dotted grid
44
Dotted diamond
45
Shingle
46
Trellis
47
Sphere
48
Small grid
49
50
51
Outlined diamond
52
Solid diamond
NOTE: The names for the hatches in ViewX match those used in Microsoft Windows.
PD-6016 07/2012
413
Chapter 18 - Animations
Animating the Hatch property only has a visible effect on the Mimic object if the Type
property is set to Hatch in the Mimic object's configuration or is animated to be 2 (2
corresponds to Hatch).
You can either edit the expression for the Hatch property so that it is one of the numbers
for the hatch patterns, or you can use an expression to change the hatch pattern
according to the value or state of a database item. For example, you could use the
following expression to change the type of hatch according to the current state of a 2 bit
digital point:
LOOKUP( ".DigitalPoint 2.CurrentState" + 1, 40, 47, 48, 50)
This expression animates the Hatch property according to the CurrentState value of a 2
bit digital point named 'DigitalPoint2'. When the 'DigitalPoint2' point is in state 0 the hatch
pattern is weave (pattern number 40), when it is in state 1 the hatch pattern is sphere (47),
for state 2 the hatch pattern is small grid (48), and when it is in state 3 the hatch pattern is
large checker board (50).
414
PD-6016 07/2012
Chapter 18 - Animations
Type
You can animate the Type property so that the type of fill shading that is applied to the
Mimic object varies according to the value or state of an item in the database. For
example, you can animate an object so that it uses solid shading when a point is in a
normal state but uses hatch shading when the point is in an alarm state.
Each Type corresponds to a number:
Type
None
Solid
Hatch
Linear Gradient
Pipe Gradient
Radial Gradient
For example, if you wanted a Mimic object to use a hatch fill when a 2 bit digital point is in
state 0 and 1 and a solid fill when the point is in state 2 and 3, you could use this
expression:
LOOKUP( "DigitalPoint 2.CurrentState" + 1, 2, 2, 1, 1)
Where <DigitalPoint 2> is the location and name of the 2 bit digital point (do not enter the
angle brackets < > ), the CurrentState is the point property that animates the Type
property of the Mimic object and the numerical values are:
+1 is needed as LOOKUP is 1 based (starts from 1) whereas the point's states are 0
based (start from 0).
The first 2 is the Type that will be applied when the point is in State 0. Type 2 is Hatch.
The second 2 is the Type that will be applied when the point is in State 1. Type 2 is
Hatch.
The second 1 is the Type that will be applied when the point is in State 2. Type 1 is
Solid.
The third 1 is the Type that will be applied when the point is in State 3. Type 1 is Solid.
PD-6016 07/2012
415
Chapter 18 - Animations
FillMode Animations
The FillMode property represents the Fill Mode setting for a line or shape. This can be
either Even-Odd or Non-Zero and determines how Windows fills the areas within the
polylines. Typically, you would define the Fill Mode for an object on its Properties window,
but you can animate the property if required. For example, you can animate the FillMode
property so that it changes according to the value of a point.
When animating the FillMode property, you will need to use the relevant number in the
expression:
Mode
Even-Odd
Non-Zero
Further Information
Creating a New Shape by Combining Mimic Objects: See page 70.
Pen Animations
The Pen properties are identical to the Fill properties except that they apply to the text in a
text box rather than the fill (see Fill Animations, on page 402). For example, the FillColour
property for the Pen group defines the color of the text whereas the FillColour for the Fill
group defines the color of the area of a shape or text box.
Pen animations apply to the text in the text
box
416
PD-6016 07/2012
Chapter 18 - Animations
Font Animations
The Font properties of a Mimic object define the appearance of the text in a text box, and
on embedded Lists and Trends. The Font properties that you can animate include:
Style (see page 421)the appearance of the text (Bold, Italic etc.)
PD-6016 07/2012
417
Chapter 18 - Animations
Family
The Family property defines the type of font that is used. As with many font properties,
you would usually set the Family on the Text Properties window and would not animate it.
However, you can animate the Family so that it is set to a certain size by entering the
relevant number for its expression. Alternatively, you can animate it so that the font
changes according to the value or state of an item in the database.
For the Family property, you need to enter the name of the required font in single quotes
like this: 'Courier New'.
For example, you could use the following expression to make the text change font
according to the alarm state of a 1 bit digital point:
IIF( "<.1 Bit Digital>.AlarmState" = 4, 'Impact', 'Arial' )
Where <.1 Bit Digital> is the path and name of the 1 bit digital point and AlarmState is the
point property that animates the Family property of the text box. The remaining part of the
expression defines that when the point has an alarm state of 4 (unnaccpeted uncleared),
the text box will use the Impact font and when the point has any other alarm state, the
text box will use the Arial font.
418
PD-6016 07/2012
Chapter 18 - Animations
Height
The Height property defines the size of the text in the text box. Typically, you would set
the size of the font on the Text Properties window and would not animate this property,
but you can animate it if required.
You can animate the Height so that the text is fixed at a specific size or you can animate it
so that the size changes according to the value or state of an item in the database. The
result of the expression has to define a number which is the height of the text (measured
in points).
For example, you could use the following expression to change the size of text according
to the state of a point:
LOOKUP( "<DigitalPoint 2>.AlarmState" + 1, 10, 10, 15, 20, 8)
Where <DigitalPoint 2> is the location and name of the 2 bit digital point (do not enter the
angle brackets < >), the AlarmState is the point property that animates the Height
property of the text box and the numerical values are:
+1 is needed as LOOKUP is 1 based (starts from 1) whereas the point's alarm states are
0 based (start from 0).
The first 10 is the size in points of the Height that is applied when the point has an alarm
state of 0 (no alarms raised).
The second 10 is the size in points of the Height that is applied when the point has an
alarm state of 1 (alarms disabled).
The 15 is the size in points of the Height that is applied when the point has an alarm
state of 2 (acknowledged uncleared alarm).
The 20 is the size in points of the Height that is applied when the point has an alarm
state of 3 (unacknowledged cleared alarm).
The 25 is the size in points of the Height that is applied when the point has an alarm
state of 4 (unacknowledged uncleared alarm).
So for this example, the text would be 10 pt when the digital point had a normal alarm
state or had its alarms disabled. When the point has an acknowledged uncleared alarm,
the text is in 15 pt, if there is an unacknowledged cleared alarm the text is in 20 pt, and if
there is an unacknowledged uncleared alarm the text is in 25 pt. This type of animation
could be useful when you need to attract an operator's attention to an alarm and do not
want to use changing or flashing colors to indicate an alarm has been raised.
PD-6016 07/2012
419
Chapter 18 - Animations
HorzAlignment
The HorzAlignment property defines the horizontal position of the text within the text box.
Typically, you would define the positioning on the Text Properties window, but you can
animate the property if you wish. For example, you can animate the HorzAlignment so
that it changes according to the value of a point.
When animating the HorzAlignment property, you will need to use the relevant number in
the expression:
Alignment Style
Left
Center
Right
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 1, 0 )
In this expression, when the point named '1 Bit Digital' has an alarm state of 4
(unacknowledged uncleared alarm), the text is centered horizontally (HorzAlignment 1).
When the point has any other alarm state, the text is left aligned horizontally
(HorzAlignment 0).
NOTE: For text to be positioned in the center of a text box, both the VertAlignment and
HorzAlignment need to be set on the Text Properties window or animated.
Orientation
The Orientation property defines the direction of the text within the text box. Typically, you
would define the orientation on the Text Properties window, but you can animate the
property if required. For example, you can animate the Orientation so that it changes
according to the value of a point.
When animating the Orientation property, you will need to use the relevant number in the
expression:
Direction
Left to Right
Top to Bottom
Bottom to Top
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 1, 0 )
In this expression, when the point named '1 Bit Digital' has an alarm state of 4
(unacknowledged uncleared alarm), the text is centered (HorzAlignment 1). When the
point has any other alarm state, the text is left aligned (HorzAlignment 0).
420
PD-6016 07/2012
Chapter 18 - Animations
Style
The Style property defines the appearance of the text within the text box. Typically, you
would define the orientation on the Text Properties window, but you can animate the
property if required. For example, you can animate the Style so that it changes according
to the value of a point.
When animating the Style property, you will need to use the relevant number in the
expression:
Direction
Regular
Bold
Italic
Underline
Strikeout
PD-6016 07/2012
421
Chapter 18 - Animations
VertAlignment
The VertAlignment property defines the vertical position of the text within the text box.
Typically, you would define the positioning on the Text Properties window, but you can
animate the property if you wish. For example, you can animate the VertAlignment so that
it changes according to the value of a point.
When animating the VertAlignment property, you will need to use the relevant number in
the expression:
Alignment Style
Top
Center
Bottom
For example:
IIF( ".1 Bit Digital.AlarmState" = 4, 1, 0 )
In this expression, when the point named '1 Bit Digital' has an alarm state of 4
(unacknowledged uncleared alarm), the text is centered vertically (VertAlignment 1). When
the point has any other alarm state, the text is left aligned vertically (VertAlignment 0).
NOTE: For text to be positioned in the center of a text box, the VertAlignment and
HorzAlignment need to be set on the Text Properties window or animated.
422
PD-6016 07/2012
Chapter 18 - Animations
A pick action menu for an item in the database is displayed (Object Menu pick action).
To animate the PickType and PickParam properties, you need to use a number code and a
parameter that has a specific format (the format varies according to the type of pick
action). In the following sections, we provide details of the number codes and parameters,
and also explain how to use PickType and PickParam animations to achieve a variety of
goals:
Animating an Object to Provide Access to a Pick Action Menu (see page 426)
Animating an Object to Provide Access to Selected Actions Only (see page 428)
NOTE: The sections listed above explain how to animate the PicKType and PickParam
properties for normal Mimic objects such as shapes and buttons. For Mimic symbols, see
Pick Action Animations for Symbols, on page 439.
Further Information
Associating Mimic Objects with Pick Actions (see page 247).
PD-6016 07/2012
423
Chapter 18 - Animations
PickTyperepresents the type of pick action that is provided by the Mimic object. You
need to define a number for the type of pick action you want to use (the numbers are
included in the table below).
PickParamrepresents what happens when you select the object for which the pick
action is being configured. For example, if you are creating a hyperlink pick action, then
the PickParam represents the target display that is shown when the hyperlink is
selected. The syntax of the expression for the PickParam property varies according to
the type of pick action (see the table below).
NOTE: For latched buttons, you can apply separate pick actions for when the button is
pressed down and raised. The PickParam property applies to the raised button and the
PickParamAlt button applies to the button when it appears to be pressed down (see
PickParamAlt, on page 375).
When you are creating expressions for the PickType and PickParam, you will need to use
the following numbers and parameter formats:
Number for
PickType
Expression
PickParam
None
424
Custom Menu. For internal use only. Do not use in your animations.
10
PD-6016 07/2012
Chapter 18 - Animations
Number for
PickType
Expression
PickParam
11
14
15
16
17
18
19
20
NOTE: If you use a PickParam animation with a custom menu, the animation will apply to the
first menu option in the menu.
Further Information
Animating an Object to Provide Access to a Pick Action Menu (see page 426)
Animating an Object to Provide Access to Selected Actions Only (see page 428)
Animating an Object to act as a Hyperlink (see page 431)
Animating an Object to Perform a Specific Action (see page 431)
Animating an Object to Write a Value to the Registry (see page 433)
Button Animations (see page 373)
PickComment Animations (see page 450).
PD-6016 07/2012
425
Chapter 18 - Animations
To animate a Mimic object so that it provides access to the pick action menu of an item in
the database:
1.
The Polyline Properties window is displayed (the Text Properties window is displayed if
you are working with a text box instead of a shape).
2.
On the General tab, select the Animations button to display the Animations window.
3.
Select the PickParam property (this is the Mimic object property that determines
whether the Mimic object provides access to a pick action menu, hyperlink, etc.).
4.
426
PD-6016 07/2012
Chapter 18 - Animations
5.
Select the browse button to access a browse window. You may also need to select an
OPC Tag option from a context sensitive menu if there are parameters defined on your
Mimic.
6.
Use the browse window to select the Value tag for the database item that has the pick
action menu that you want to associate with the Mimic object.
7.
Select the OK button to close the browse window and confirm your selection.
The Expression window shows an expression that defines the path of the selected
database item.
8.
9.
When you display the Mimic in Run mode and select the Mimic object, a pick action menu
is displayed.
PD-6016 07/2012
427
Chapter 18 - Animations
The Polyline Properties window is displayed (the Text Properties window is displayed if
you are working with a text box instead of a shape).
2.
On the General tab, select the Animations button to display the Animations window.
3.
Select the PickParam property (this is the Mimic object property that determines
whether the Mimic object provides access to a pick action menu, hyperlink, etc.).
4.
Select the browse button to access a browse window. You may also need to select an
OPC Tag option from a context sensitive menu if there are parameters defined on your
Mimic.
6.
Use the browse window to select the Value tag for the item that has the pick action
menu that you want to associate with the Mimic object.
7.
Select the OK button to close the browse window and confirm your selection.
The Expression window shows an expression that defines the path of the selected
database item.
428
PD-6016 07/2012
Chapter 18 - Animations
8.
Pick Action
PD-6016 07/2012
View Status
NoView
NoAlarmView
NoHelpView
NoDefaultView
Notes
NoNotes
Display Events
NoEvents
Display Alarms
NoAlarms
Display
NoDisplay
NoQueries
NoTrends
NoMethods
User Methods
(as defined in User Methods on the
Form of a database item)
NoUserMethods
NoAlarmMethods
Display Errors
NoErrors
429
Chapter 18 - Animations
Pick Action
9.
Display References
NoRefs
Properties
NoProperties
Edit
NoEdit
Links
NoLinks
NoNavSync
NoLocateOPCNavigator
NoNavSyncTempl
Select the OK button to confirm the expression and close the Expression window.
10. Select the PickType property on the Animations window. You have to define the type of
pick action as well as the parameters for the pick action, otherwise the pick action
menu will be unavailable.
11. Select the Edit button to display the Expressions window.
12. Enter 1 which is the number that corresponds to an Object Menu (i.e. pick action
menu).
13. Select the OK button to confirm the expression and close the Expression window.
14. Close the Animations window.
15. Save the Mimic.
The Mimic object is now animated so that when you select the object in Run Mode, the
pick action menu for the relevant pick action menu is displayed. The pick action menu will
only contain the options that have not been included in the expression for the PickParam
property.
430
PD-6016 07/2012
Chapter 18 - Animations
This feature is only possible for method actions (controls). For other types of action, you
would need to animate the Mimic object so that it only provides access to the required
action (the action would be the only option available from the pick action menu). For more
information on removing options from a pick action menu, see Animating an Object to
Provide Access to Selected Actions Only, on page 428.
1.
The Polyline Properties window is displayed (the Text Properties window is displayed if
you are working with a text box instead of a shape).
2.
On the General tab, select the Animations button to display the Animations window.
3.
Select the PickParam property (this is the Mimic object property that determines
whether the Mimic object provides access to a pick action menu, hyperlink, etc.).
4.
PD-6016 07/2012
431
Chapter 18 - Animations
5.
<path and name of database item> is the location and name of the database item
you selected in the browse window in step 6. Do not include the angle brackets < >.
ObjectLink indicates that the object menu (pick action menu) of the database item
is to be associated with the Mimic object.
<name of method action> is the name of the method that will be performed when
the Mimic object is selected. The name has to be identical to the name of the
method in the database. Do not include the angle brackets < >.
<name of aggregate> is the name of the aggregate in the database that provides
the database item with access to the method. Do not include the angle brackets <>.
Database aggregates are special extensions to a database class that have their
own names, fields, methods and alarm conditions. So, if a database item is part of a
class that has an aggregate, the database item has access to the methods for its
own class and the methods for the aggregate.
<name of alarm condition> is the name of the alarm condition in the database that
provides the database item with access to the method. Do not include the angle
brackets < >.
Alarm conditions are similar to database aggregates in that they provide access to
additional fields and methods (specific to alarms). So, a database item can have
access to the methods of its own class and the methods for the alarm conditions.
As the aggregates can also have alarm conditions, it is possible for a database item
to have methods for its own class, methods for its alarm conditions, methods for its
aggregate, and methods for the alarm conditions of its aggregate.
You should use the Database Schema to determine whether the method you require is
stored for the database item, an aggregate, an alarm condition, or an alarm condition
for the aggregate and then use the appropriate syntax. For more information, see
Working with the Database Schema, on page 19 in the ClearSCADA Guide to the
Database.
432
PD-6016 07/2012
Chapter 18 - Animations
Select the OK button to confirm the expression and close the Expression window.
6.
7.
8.
Enter 5 as the PickType expression. The number 5 corresponds to the method type of
pick action.
9.
Select the OK button to confirm the expression and close the Expression window.
PD-6016 07/2012
433
Chapter 18 - Animations
(Although both of these can also be set up by using the Pick Action Wizard, see Creating
a System Command Pick Action, on page 262).
When animating an object to trigger a system command, you need to set the PickType to
16 (for System command). You also need to define the system command (or the location
of a System Command database item) in the PickParam expression.
Example:
A Mimic object that is configured to run Internet Explorer when selected could have these
animations:
PickType16
The same functionality could be provided by configuring a System Command item to have
the Command: 'C:\Program Files\Internet Explorer\iexplore.exe'. Next, you would configure
a Mimic object to use the following animations:
PickType16
Where <location of System Command item> is a reference to the System Command item.
The PickParam has to reference the System Command items cmd property.
434
PD-6016 07/2012
Chapter 18 - Animations
Back
Next
Home
Zoom In
Zoom Out
Full Screen
Log On
Log Off
Close
Change Password
Alarms on System
Events on System
Add to Favorites
Help
Exit.
Example:
A Mimic object that is configured to act as a Back button (display the previously viewed
document), uses the animations:
PickType14
PickParamWM_COMMAND(Back)
PD-6016 07/2012
435
Chapter 18 - Animations
Call Specific FunctionWhen the Mimic object is selected, a function in the Mimic
script is executed. This type of animation can only be used if the required function has
no arguments. If arguments are needed, you need to use an Execute Code Fragment
animation.
Execute Code FragmentWhen the Mimic object is selected, VB script that is defined
in the animation runs. The animation can contain a complete VB script or can call
functions in the Mimic script, including functions that require arguments.
Execute Code Fragment on Top Level MimicDesigned for use on embedded Mimics,
this type of animation allows you to call a function in the script for the top-level Mimic. It
can be used even if scripting is disabled on the embedded Mimic.
However, you can also create these script animations manually, by creating animations for
the PickType and PickParam properties.
For a Call Specific Function animation, you need to configure the animations as:
PickType19
Example:
PickType17
This animation sets a Mimic object so that, when selected, a message box is displayed. The
message box contains the message : Close Valve if Value > 50.
NOTE: If you need the animation to call a function that has arguments, you need to use
PickType 17 (see below).
436
PD-6016 07/2012
Chapter 18 - Animations
For an Execute Code Fragment animation, you need to configure the animations as:
PickType17
Example:
A simple Mimic script is created to provide access to the Print settings. It is:
Public Function PrintMimic
Mimic.Print
End Function
A rectangle is added to the Mimic and animated so that, when selected, it calls the
PrintMimic function. The animations to add this functionality to the rectangle are:
PickType19
PickParam'PrintMimic'
For an Execute Code Fragment on Top Level Mimic animation, you need to configure the
animations as:
PickType20
PickParamVB script that calls a function in the script of the top-level Mimic, entered
as a string value. If you have several embedded Mimics that call the same function,
using an Execute Code Fragment on Top Level Mimic animation has performance
benefits. This is because it is more efficient to run a single script for a top level Mimic
than it is to run individual scripts for each embedded Mimic.
Example:
A top-level Mimic contains a script that has a VerifyControl function which requires 1
argument (the name of a point).
A Mimic is created to be a faceplate symbol for a device. It contains a graphic for the
device and a text box which will show the name of a point. The point name will change,
depending on which point is associated with the symbol, and so a parameter named
PointName is created to allow for this.
The following animations are created for the text box:
PickType20
PD-6016 07/2012
437
Chapter 18 - Animations
When the text box is selected on any of the embedded Mimics, the VerifyControl function in
the top-level Mimic script is called. The arguments for the function, in this case, the point
name, are taken from the VB script in the embedded Mimics PickParam values (the
Parameter part of the animation value).
The embedded Mimics are able to call a function in the top level Mimic, even though they
have scripting disabled. This is because scripting only needs to be enabled on the Mimic on
which the script runs. There are also performance benefits to calling functions in this way, as
ClearSCADA only needs to run one script instead of five (one for the top-level Mimic and one
for each embedded Mimic).
438
PD-6016 07/2012
Chapter 18 - Animations
Animating a Symbol Object to Provide Access to a Pick Action Menu (see page 439).
2.
Animating a Symbol Object to Provide Access to Selected Pick Actions Only (see page
441).
3.
4.
5.
Configure a group parameter (select the Edit menu, then Parameters, then Add, then
define the name of the parameter and select the Group check box). The name of the
group parameter will be an option that you can use to select the required expression, so
it is better to define a suitable name. For example, if the symbol is designed for use with
points, name the group parameter Point.
2.
3.
Double click on the parameter object on the Mimic to display its Polyline Properties
window.
4.
On the General tab, select the Animations button to display the Animations window.
5.
6.
7.
8.
Select the option that is named the same as the parameter you created in step 1.
The correct expression is shown in the Expression field. It has the format:
"Parameter:<name of group parameter>.ObjectLink"
10. Select the OK button to confirm the expression and close the Expression window.
PD-6016 07/2012
439
Chapter 18 - Animations
The parameter object is now animated to provide access to the pick action menu of any
item that is associated with the symbol.
440
PD-6016 07/2012
Chapter 18 - Animations
Configure a group parameter (select the Edit menu, then Parameters, then Add, then
define the name of the parameter and select the Group check box). The name of the
group parameter will be an option that you can use to select the required expression so
it is better to define a suitable name.
2.
3.
Double click on the symbol object to display its Polyline Properties window.
4.
On the General tab, select the Animations button to display the Animations window.
5.
6.
7.
8.
Select the option that is named the same as the group parameter you created in step 1.
The correct expression is shown in the Expression field. It has the format:
"Parameter:<name of group parameter>.ObjectLink
This links the Mimic object with the pick action menu of any item that is associated with
the symbol.
10. Add the extra expression data for the specific actions that you want to exclude from the
pick action menu. The extra expression data should be in the following format:
+'?<name of action>'"
Repeat the + '?<name of action>' part for each action that you want to be excluded.
For the <?name of action> part of the expression requires a specific entry. The entries
are the same as those used for a 'normal' Mimic (see Animating an Object to Provide
Access to Selected Actions Only, on page 428).
11. Select the OK button to confirm the expression and close the Expression window.
12. Select the PickType property.
13. Select the Edit button to display the Expression window.
PD-6016 07/2012
441
Chapter 18 - Animations
14. Enter the number for the required PickType. For an Object Menu, the number is 1. (The
PickType numbers are the same as those used for pick actions on 'normal' Mimics).
15. Select the OK button to confirm the expression and close the Expression window.
16. Close the Animations window.
The object on the symbol is now animated to provide access to a pick action menu for
any item that is associated with the symbol. The pick action menu will only include
those options that have not been excluded in the expression for the PickParam
property.
442
PD-6016 07/2012
Chapter 18 - Animations
For a method on the alarm condition for the aggregate of a database item:
"Parameter:<name of group parameter>.ObjectLink"+'?<name of
aggregate>.<name of alarm condition>.<name of method action>'
Where:
<name of group parameter> is the name of a group parameter that you configure for the
Mimic.
ObjectLink is the name of another parameter that you have configured as a child of the
group parameter.
<name of method action> is the name of the method that will be performed when the
Mimic object is selected. The name has to be identical to the name of the method in the
database. Do not include the angle brackets < >.
<name of aggregate> is the name of the aggregate in the database that provides the
database item with access to the method. Do not include the angle brackets < >.
Database aggregates are special extensions to a database class that have their own
names, fields, methods and alarm conditions. So, if a database item is part of a class
that has an aggregate, the database item has access to the methods for its own class
and the methods for the aggregate.
PD-6016 07/2012
443
Chapter 18 - Animations
<name of alarm condition> is the name of the alarm condition in the database that
provides the database item with access to the method. Do not include the angle
brackets < >.
Alarm conditions are similar to database aggregates in that they provide access to
additional fields and methods (specific to alarms). So, a database item can have access
to the methods of its own class and the methods for the alarm conditions. As the
aggregates can also have alarm conditions, it is possible for a database item to have
methods for its own class, methods for its alarm conditions, methods for its aggregate,
and methods for the alarm conditions of its aggregate.
You should use the Database Schema to determine whether the method you require is
stored for the database item, an aggregate, an alarm condition, or an alarm condition
for the aggregate and then use the appropriate syntax. For more information, see
Working with the Database Schema, on page 19 in the ClearSCADA Guide to the
Database.
The parameter format we have described is suitable for actions that have no arguments
('options' or 'parameters'), such as Enable Alarms. For this specific example, the
expression would be:
"Parameter:<name of group parameter>.ObjectLink"+'?Enable'
Where <name of group parameter> is the name of a group parameter that you have
configured for the Mimic.
For actions that do have arguments, you need to add extra information. The format for the
extra information is:
&<name of argument>="<value of argument>"'
Again, you do not enter the angle brackets < >. This additional information allows you to
specify a value that is set when the Mimic object is selected. For example, if you wanted
the Mimic object to Override the value of a point to 8 when the Mimic object was
selected, you would define the expression as:
"Parameter:<name of group
parameter>.ObjectLink"+'?Override&Value="8"'
For actions where you want to set multiple arguments, you simply repeat the extra
information, using this format:
&<name of argument1>="<value of argument1>"&<name of
argument2>="<value of argument2>"&<name of argument3>="<value of
argument3>"'
Where argument 2 is the second set of extra information, argument 3 is the third set and
so on. In all cases, you do not enter the angle brackets < > or the numbers.
444
PD-6016 07/2012
Chapter 18 - Animations
To configure a parameter object so that it performs a specific action when selected, you
need to:
1.
Configure a group parameter (select the Edit menu, then Parameters, then Add, then
define the name of the parameter and select the Group check box). The name of the
group parameter will be an option that you can use to select the required expression so
it is better to define a suitable name. For example, if the symbol is designed for use with
the Acknowledge Alarms action, we suggest you name the group parameter
Acknowledge Alarm. If the symbol is to be used with the Override action, name the
group parameter Override and so on.
2.
3.
Double click on the parameter object to display its Polyline Properties window.
4.
On the General tab, select the Animations button to display the Animations window.
5.
6.
7.
8.
Select the option that is named the same as the group parameter you created in step 1.
The correct expression is shown in the Expression field. This links the Mimic object with
the pick action menu of any item that is associated with the symbol.
10. Add the extra expression data for the specific action and any arguments. The extra
expression data should be in the following format:
+'?<name of action>' &'<name of argument>="<value of argument>"
This format is explained at the start of this section. It defines the specific action that is
to be performed when the object is selected on a Mimic, and also the specific argument
(value, state, etc.) that will be set (if applicable).
11. Select the OK button to confirm the expression and close the Expression window.
12. Select the PickType property.
13. Select the Edit button to display the Expression window.
14. Enter the number for the required PickType. The numbers are the same as those used
for the PickParam (for a list of the PickParam numbers, see PickComment Animations,
on page 450)for a Method, the number is 5.
15. Select the OK button to confirm the expression and close the Expression window.
16. Close the Animations window.
The parameter object is now animated to perform a specific action on any item that is
associated with the symbol. The action will only be performed if it is suitable for the
type of item that is associated with the symbol. For example, if the action was to
acknowledge alarms for the item, and the item cannot have alarms, the action would
not be performed.
PD-6016 07/2012
445
Chapter 18 - Animations
Create a new Mimic and enter a suitable name for it. This Mimic is going to be the
'button' symbol.
2.
3.
Draw a rectangle on the Mimic. Use the shading and color effects to alter the
appearance of the button as required.
4.
Add a text box to the Mimic. Size the text box so that it is the same size as the
rectangle and position it over the rectangle.
5.
6.
Define a suitable color for the Pen and use the Font tab to define suitable settings for
the text.
7.
Select the Edit menu, then the Parameters option to display the Parameters window.
8.
BoxText
Registry
RegistryKey
The BoxText parameter represents the text that will be shown in the text box, the
Registry parameter represents the value that is written to the registry, and the
RegistryKey represents the type of value.
You can leave the default settings for the Hint and Default Value of each parameter.
9.
446
PD-6016 07/2012
Chapter 18 - Animations
PickType8
These animations mean that when an embedded version of the Symbol is selected, the
value defined in the embedded Symbol's Registry property will be written to the
registry. Similarly, the value that is defined in the embedded Symbol's Text property will
be shown in the text box.
11. Close the Animations window.
12. Save the Mimic.
13. Create a new Mimic. Again, enter a suitable name for the Mimic. This Mimic is going to
contain an embedded List and two versions of the 'button' Symbol that will apply
different filters to the embedded List.
14. Embed two versions of the symbol on the Mimic. Size and position them so that the
Mimic looks like this:
15. Embed the Points List below the two symbols like this:
PD-6016 07/2012
447
Chapter 18 - Animations
16. Display the Animations window for the embedded List and define this animation:
This defines the columns that are included in the List, the location of the data that is to
be shown in the List (the CDBPoint table), and it also defines the filter as being the
SourceName equals the Registry value. The Registry value will be saved as 'OS Filter'.
17. Close the Animations window.
18. Display the Animations window for the embedded symbol on the left-hand side.
19. Define these animations:
RegistryEnter the following string as the value that is written to the registry:
'OS reg.Modbus Outstation 1'
RegistryKeyEnter the name of the Registry value (this has to match the registry
setting in the SQL of the embedded List):
'OS Filter'
RegistryEnter the following string as the value that is written to the registry:
'OS reg.Modbus Outstation 2'
RegistryKeyEnter the name of the Registry value (this has to match the registry
setting in the SQL of the embedded List):
'OS Filter'
448
PD-6016 07/2012
Chapter 18 - Animations
The embedded List is filtered so that it only shows the points on 'Outstation 2'. When
you select the button, a value is written to the registry and this value causes the
specified filter to be applied to the List.
27. Select the 'Outstation 1' button.
The embedded List is filtered so that it only shows the points on 'Outstation 1'.
PD-6016 07/2012
449
Chapter 18 - Animations
PickComment Animations
You can animate the PickComment for an object so that when you place the cursor over
the Mimic object, a specific string is shown in the status bar. The string can be a set of
characters that you define, or it could be any string from the database. The string has to
be enclosed by single quotes, for example, 'Pump Controls'.
To animate the PickComment, either define the required string in the Expression window
for the PickComment property, or use the Expression window's browse button to
associate the PickComment with the string value of a database item. For example, you
can associate the PickComment with the FullName property of a point.
The pick comment is shown in the status bar (below the Alarm Bell
Button if it is displayed) when the cursor is positioned over the object
that works as a type of pick action menu (Object Menu, Hyperlink,
Registry etc.).
NOTE: You can only animate the PickComment property if the Mimic object has been
configured to work as a pick action on the Pick Action Wizard (for example, to work as a
method pick action or an Object Menu pick action) or if it is animated to work as a pick
action (PickParam and PickType properties are animated).
450
PD-6016 07/2012
Chapter 18 - Animations
PickDisabled Animations
You can animate the PickDisabled property of an object to control when a pick action
menu is available for the object.
The expression for the PickDisabled property needs to equal TRUE for the pick action
menu to be available, and it has to equal FALSE for the pick action menu to be
unavailable.
You can enter True or False as the expression, or you can use a more complex expression
that returns a True or False answer. For example, if a Mimic object is to provide access to
a pick action menu only when a specific 1 bit digital point is in state 0, you would need to
enter the following as the expression for the PickDisabled property of the Mimic object:
"<path and name of point>.CurrentState" = 0
Where <path and name of point> is the location and name of the point in the database.
Do not enter the angle brackets < >.
CurrentState is the name of the point property that is used to animate the Mimic object's
PickDisabled property.
The final part of the expression defines that if the CurrentState value of the point is 0, then
the result of the expression is TRUE and so the pick action menu is available. If the
CurrentState is not 0, the result of the expression is FALSE and the pick action menu is
unavailable.
PD-6016 07/2012
451
Chapter 18 - Animations
Rotation Animations
You can use animations to rotate a Mimic object according to the value or state of an item
in the database. To do this, you need to animate 2 Mimic object properties:
PivotTypedefines the anchor position of the object when it is rotated, for example, if
the value is 4 for the animation, the Mimic object will rotate from the right-hand side (the
right-hand side will not move).
You need to define the PivotType as a number in your expressions. The numbers and
corresponding pivot types are:
Rotation Position
Center
Top Left
Top
Top Right
Right
Bottom Right
Bottom
Bottom Left
Left
Rotationdefines the angle of rotation for an object. Typically, you animate the
Rotation property in conjunction with the PivotType property to rotate an object from a
specific position, such as its bottom left corner.
The Rotation property is often used in animations that show analog read-outs such as
dials, where the following expression is used to associate the angle for the rotation with
the value of the point:
( "<.Point>.CurrentValue" / ".Pressure.FullScale" ) * 360
Where <.Point> is the path and name of the point (do not enter the angle brackets < > ).
The CurrentValue property is the point' s current value and the FullScale is the highest
possible point value. 360 is the maximum angle.
The point' s value is divided by the point' s maximum value. The result of this is
multiplied by the maximum angle (360) which results in the angle that is used for the
Rotation animation.
452
PD-6016 07/2012
Chapter 18 - Animations
Position Animations
There are four position properties that can be animated to make use of the movement
feature. This allows a Mimic object to move along a defined path according to the value of
an item in the database.
When creating a position animation (also referred to as a movement animation), you need
to:
1.
2.
4.
Draw the path line for the Mimic object in the same way as you would draw a line. The
path line defines the route that the Mimic object will take as it moves.
5.
Double-click to end the path definition. The path is shown as a red line.
6.
7.
Animate the position animation properties so that the Mimic object's position is
associated with values in the database.
PosAnchor
PosMax
PosMin
PosVal
The PosAnchor property defines the anchor position of the object when it is moving
along a path. The PosAnchor values are the same as those for the PivotType (see
Rotation Animations, on page 452). For example, if the expression for the animation is
3, the top right part of the object will be on the defined path route.
The PosMax, PosMin, and PosVal properties are used to scale the possible positions
and place the Mimic object at the correct position according to a value in the database.
Typically, you would associate the PosMax property with the FullScale value of an
analog point, the PosMin property with the ZeroScale of the point, and the PosVal
property with the CurrentValue of the point.
PD-6016 07/2012
453
Chapter 18 - Animations
Size Animations
There are 4 size properties that you can animate so that an object increases or decreases
in size according to the value of an item in the database. This is useful for adding bar
graphs to Mimics.
The size properties are:
454
SizeDirThis property defines the direction of the size change. The directions and the
numbers that represent them in the expressions are:
Size Direction
None
Vertical down
Vertical center
Vertical up
Horizontal center
10
11
12
13
14
15
SizeMaxThis property defines the maximum size of the Mimic object. Typically, this is
associated with the FullScale property of an analog point.
SizeMinThis property defines the minimum size of the Mimic item. Typically, this is
associated with the ZeroScale property of an analog point.
SizeValThis property defines the current size of the Mimic object and needs to be
associated with a value or state for an item in the database, for example, the
CurrentValue of a point.
PD-6016 07/2012
Chapter 18 - Animations
ToolTipText Animations
You can use the TooltipText property to animate the ToolTip for an object. The ToolTip is
displayed when you position the cursor over the Mimic object in Run mode.
Common animations for the TooltipText property include:
Showing instructionsyou can enter any text as the expression for the TooltipText
property, so you can provide extra information if required.
PD-6016 07/2012
455
Chapter 18 - Animations
Visibility Animations
You can animate the Visible property of a Mimic object to define when the Mimic object
can be seen. For example, you can animate the Visible property so that a Mimic object is
only visible when a specific point has an alarm raised.
The expression for the Visible property needs to include a True/False definitionthe
Visible property can only be 0 which is False (invisible) or 1 which is True (visible). For
example, you could use the following expression to control the visibility of a text box
according to the alarm state of a point:
IIF( "<Point path and name>.AlarmState" = 0, 0, 1 )
Where <Point path and name> is the path and name of a point (do not enter the angle
brackets < > ) and .AlarmState is the point property that animates the Visible property.
The remaining part of the expression defines that when the point has an AlarmState of 0
(normal), the text box has a Visibility setting of 0 (invisible), and when the point has any
other AlarmState, the Visibility is 1 (visible). This means that when an alarm is raised for
the point, the text box is shown on the Mimic.
XAxisVisibleThe value for this animation property defines whether the X-Axis is visible
on the Embedded Trend.
YAxesVisibleThe value for this animation property defines whether the Y-Axes are
visible on the Embedded Trend.
As with the Visibility property, the values for the XAxisVisible and YAxesVisible properties
need to be expressions that include a True/False definitionthe Visible property can only
be 0 which is False (invisible) or 1 which is True (visible).
456
PD-6016 07/2012
Chapter 18 - Animations
PD-6016 07/2012
Number for
Expression
Algorithm
Meaning
Interpolated
Total
Average
Count
StdDev
Min
MinTime
Max
MaxTime
457
Chapter 18 - Animations
458
Number for
Expression
Algorithm
Meaning
10
Start
11
End
12
Delta
13
Variance
14
Range
15
DurGood
16
DurBad
17
PerGood
18
PerBad
19
Sum
20
24hAverage
21
8hAverage
22
1hAverage
23
Stepped
24
MinLast
25
MaxLast
PD-6016 07/2012
Chapter 18 - Animations
PD-6016 07/2012
Number for
Expression
Algorithm
Meaning
26
AverageLast
27
MinInterpolated
28
MaxInterpolated
29
AverageInterpolated
30
EndLast
459
Chapter 18 - Animations
460
Alarm State
Normal
Disabled
Acknowledged Uncleared
Unacknowledged Cleared
Unacknowledged Uncleared
PD-6016 07/2012
19 Mimic Parameters
Mimic parameters are special properties that you can create for symbol Mimics (generic
Mimics that are designed to be embedded on other Mimics). The properties can then be
animated in the same way as other properties.
Mimic parameters are normally used with faceplate symbolsMimics that contain
specific information that are designed to be embedded on other Mimics. Although the
faceplate symbols are configured to contain specific information, they are not designed to
contain information for specific objects in the databasethey are usually designed to be
generic, so that they can show the same set of information for various objects.
NOTE: Mimic parameters should not be confused with parameter database items. Mimic
parameters are designed for use with symbols, whereas parameter database items are used
to store values which can be used as the source value for a variety of features, including
Mimics and Logic programs.
Example:
The following faceplate symbol is created to act as a generic display for Pumps. It is to
contain the name of a pump, its state, alarm state description, and state description.
PD-6016 07/2012
Pump image
461
The following parameters are created for the pump faceplate symbol:
462
PD-6016 07/2012
The AutoConfigure feature is made available by selecting the embedded Mimic and then
dragging the required database item from the Database Bar onto the embedded Mimic. The
Auto Configure Animations option sets the embedded Mimic's parameters to be associated
with the corresponding fields for the selected database item. However, the Auto Configure
Animations feature can only set up those animations where the parameter name matches a
field name of the database item.
So, when the Pump symbol is associated with a database point, the Auto Configure
Animations feature will associate the point's values with the parameters as follows:
Point Property
CurrentState
CurrentState
AlarmStateDesc
AlarmStateDesc
CurrentStateDesc
CurrentStateDesc
The PumpID parameter is not configured automatically. This is because the database point
does not have a property named PumpID. The PumpID parameter has to be associated with
an expression manually.
In the Parameters section, you will find the following information:
PD-6016 07/2012
463
2.
3.
The Parameters window lists Mimic parameters (if any have been configured) under these
headings:
464
HintThe Hint indicates the type of ViewX field that can be used to animate the
parameter. The hints are:
PD-6016 07/2012
Default ValueThe value that is used for the parameter if a value is not provided by a
database item or defined as part of a ViewX expression.
There is also a Test Value field that you can use to check that the parameter is working as
you expected. Simply enter a suitable value to see how the parameter will use the value.
For example, if you have set up a parameter that uses a color value, when enter a number
(0-255) in the Test Value field the Mimic item that is associated with the parameter should
change to the appropriate color. The settings you enter in the Test Value field are purely
for test purposesthey are not stored.
PD-6016 07/2012
465
Display the Parameters window (see Displaying the Parameters Window, on page 464).
2.
3.
NameEnter a suitable name for the parameter. Parameter names cannot be the
same as any of the animation properties that are available for embedded Mimics.
Each parameter name has to be unique within a set of parameters.
We recommend that, where possible, you enter parameter names that match the
names of the OPC tags they are designed to represent. For example, if you are
creating a parameter that is to show the current value of an item, we recommend
that you name the parameter CurrentValue. Parameters that share the same names
as corresponding OPC tags can be set up more quickly on a Mimic via the
Configure All feature.
ParentUse this combo box to choose the parent group parameter for a
parameter. Parameters can be grouped so that they can be animated as one set of
parameters rather than individually.
You can only select a parent group parameter if a group parameter has been
created.
HintYou can use the Hint combo box to choose the type of ViewX value that can
be represented by the parameter. We recommend that you leave the Hint combo
box set to the default setting of None, as ViewX will usually detect the appropriate
type of ViewX value automatically.
Default ValueEnter the value that will be used for the parameter if no other value is
provided by an expression.
When you have created the parameters you require, you need to associate them with
items on a Mimic (see Associating a Mimic Parameter with a Mimic Item, on page 467).
466
PD-6016 07/2012
Display the Parameters window (see Displaying the Parameters Window, on page 464).
2.
Position the Parameters window so that you can select the Mimic item and a parameter
(you will need to drag the parameter onto the Mimic item).
3.
4.
Select the required parameter and drag it onto the Mimic item.
A context sensitive menu is displayed.
5.
Select the option for the Mimic item animation property that you want to associate with
the parameter. For example, if you want the value of a parameter to be shown in a text
box, associate the parameter with the text box's Text property.
6.
Repeat steps 2-5 inclusive for other parameters and Mimic items as required, then save
the Mimic.
When you have associated parameters with Mimic items, you need to embed the Mimic
and then animate its parameters (see Animating Mimic Parameters on an Embedded
Mimic, on page 469).
PD-6016 07/2012
467
Display the Parameters window (see Displaying the Parameters Window, on page 464).
2.
3.
4.
Alter the settings on the Edit Parameter window as required, then select the OK button
to confirm. The settings on the Edit Parameter window work in the same way as the
corresponding settings on the Add Parameter window.
Display the Parameters window (see Displaying the Parameters Window, on page 464).
2.
3.
NOTE: If you remove a 'parent' group parameter, the 'child' parameters in the group are also
removed.
468
PD-6016 07/2012
2.
Using the default association method. This method associates the selected parameter
with the corresponding OPC tag or the default value for the database item.
We recommend that you only use the default association method if the embedded
Mimic parameters have names that match the appropriate OPC tags for the required
database item.
i.
Drag and drop the required database item from the Database Bar onto the
embedded Mimic.
Select the parameter that you want to associate with the selected database
item.
If the parameter has the same name as the corresponding OPC tag for the
database item, the animation is set up automaticallythe object's value for the
OPC tag is used as the value for the parameter.
If the parameter has a different name to the corresponding OPC tag, the
parameter is associated with the default value for the database item. You may
need to change the animation expression by using the Animations window (see
Step 1).
NOTE: Instead of selecting a specific parameter, you can select the Configure All
option. The Configure All option automatically associates the parameters in the
group with the corresponding OPC tags or default tags of the selected database
item.
PD-6016 07/2012
469
3.
Drag and drop the required database item from the Database Bar onto the
embedded Mimic.
ClearSCADA automatically
detects those properties that
can be used to animate the
selected parameter. Simply
choose the required property.
iii. Use the Yes, animate the property check box to define whether the property is to be
associated with a value in the database. Select the check box if the property is to
be animated otherwise leave it clear.
iv. Choose the database item property that is to be associated with the parameter from
the list. ClearSCADA automatically detects those database item properties that can
be used to animate the parameter.
v.
vi. Repeat steps iii to v inclusive for each parameter, then select the OK button to
complete the parameter animations.
NOTE: You can configure a hyperlink to define the parameter values for a target Mimic (that
uses Mimic parameters). For more information, see Hyperlinks that Define Values for Mimic
Parameters on a Target Mimic, on page 337.
470
PD-6016 07/2012
20 Troubleshooting - Mimics
Using the Mimic Navigator to Locate Invalid Animations and Pick Actions (see page
473)
The Mimic Details window provides diagnostic information for the Mimic that is on
display. If the Mimic is running too slowly, you may need to use the diagnostic information
when attempting to improve performance.
PD-6016 07/2012
471
2.
The Mimic Details window is displayed. It contains information about the quantity of
each type of Mimic item and segment on the Mimic.
472
PD-6016 07/2012
Display the Mimic that you want to check for incorrect expressions. You need to display
the Mimic in Design mode (see Displaying a Mimic, on page 17).
2.
Select the View menu, then select the Mimic Navigator option.
If any of the Layer group names are shown in red, there is an incorrect animation or pick
action for a Mimic object in that Layer. If the Layer group names are shown in black, it
means the objects have valid configuration.
PD-6016 07/2012
473
474
3.
Expand the Layer group(s) to locate the Mimic object (or group of objects) that has
incorrect configuration. The Mimic object that has invalid configuration has its name
displayed in red. There may be one or more Mimic objects with incorrect configuration,
and each object may have multiple configuration errors.
4.
Double-click on the name of the required Mimic Object to select it on the Mimic and to
display its Properties display.
5.
Use the Properties display to correct the configuration of the invalid animation or pick
action, then Save the changes you have made.
6.
On the Mimic Navigator window, select the Validate button. The Mimic Navigator will
refresh its data. If the changes you have made have corrected the configuration, the
Mimic object will no longer be shown in red (though the name of the Layer that contains
the Mimic Object will remain red). If you introduced a new configuration error, the Mimic
object will continue to have its name displayed in red, as will the Layer that contains the
object.
PD-6016 07/2012
Upgrading your hardware or alter the network settings (see Changing Hardware and
Network Settings to Improve Mimic Performance, on page 475).
Altering the Mimic so that it places less demand on the processor (see Simplifying
Mimics to Reduce the Demand on the Processor, on page 477).
Slow server-client network speedYou can use Windows commands to investigate the
speed of your server-client connections. In particular, PING allows you to check the
speed of communications between the client and server.
You can also use the Windows trace route command (tracert -d) to investigate the path
of the data as it is transferred through a network. This is useful for locating the network
link that is causing the slow transfer speed.
If you locate a slow connection, the first step you should take is to enable Compression
for the Node Cost on the ClearSCADA Client Configuration window (access the
ClearSCADA Client Configuration window by double-clicking on the ClearSCADA Client
icon in the Windows Control Panel). This should speed up the data transfers between
your client PC and the ClearSCADA server.
ATTENTION: If your PC is connected to the server via a Local Area Network, enabling
the Compression feature may worsen data transfer speed.
If the server-client network connection is still too slow, you will need to check the
network hardware and infrastructure. You should check the latency and available
bandwidth. Another factor to consider is that the switches, routers, etc. are working
correctly and are suitable for the network requirements.
If the server-client connection speed is adequate, you may need to replace the graphics
card or processor in your PC (see below).
Slow graphics cardReplace the graphics card with an up-to-date 3D AGP or PCIe
graphics card.
Non-3D graphics cardReplace the graphics card with an up-to-date 3D AGP or PCIe
graphics card.
PCI graphics card instead of AGP graphics cardReplace the graphics card with an
up-to-date 3D AGP or PCIe graphics card.
Insufficient processing powerYou can use Windows Task Manager to examine your
CPU usage. On the Processes tab, examine the CPU entry for the ViewX.exe process. If
it is around 98, the Mimic is placing a high demand on the processor.
You will need to upgrade your PC's processor.
PD-6016 07/2012
475
Server is busyIf there is a high demand on the server's processor, the server may be
unable to process data requests from your client PC efficiently. You will need to use the
Windows Task Manager to investigate the performance of the server.
The server's processor may need to be upgraded.
476
Client disk is fragmentedIf the cache on your client PC is fragmented, it can cause
slow Mimic performance as the Mimic is stored in the cache. We recommend you use
Windows to defragment the client's hard disk.
PD-6016 07/2012
High Number of Items with Gradient ShadingItems that have fill gradient, pipe
gradient, or radial gradient shading cause a higher processing demand than solid color
items. This is because gradient shading is more complex and requires extra processing.
You can examine the number of items with gradient shading by displaying the Mimic
Details window and checking the various gradient fill entries (see Displaying Mimic
Diagnostics, on page 472).
If your Mimic is slow, we suggest you investigate each of the possible causes. If a high
number of gradient fills appears to be causing slow performance, we suggest that you
replace some of the gradient shading with solid shading.
High Number of PolylinesMimics with a high number of polylines can cause extra
demand on the processor. You may be able to reduce the number of polylines by using
fewer lines with more segments. For example, Mimics that contain imported DXF files
often contain excessive numbers of polylines as the lines on DXF files often consist of
many separate linesmany of these lines are redundant.
PD-6016 07/2012
477
478
PD-6016 07/2012
www.scheider-electric.com